File: reference.xml

package info (click to toggle)
php-idn 1.2b-5.3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 328 kB
  • ctags: 92
  • sloc: ansic: 682; xml: 624; makefile: 76; sh: 38; php: 10
file content (139 lines) | stat: -rw-r--r-- 3,250 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
 <reference id="ref.idn">
  <title>IDN functions</title>
  <titleabbrev>IDN</titleabbrev>

  <partintro>
   <section id="idn.intro">
    &reftitle.intro;
    <para>
     Lots of information about IDN can be found at
    </para>
    <itemizedlist>
     <listitem>
      <para>
       <ulink url="&url.idn.verisign;">VeriSign IDN SDK</ulink>
      </para>
     </listitem>
     <listitem>
      <para>
       <ulink url="&url.idn.jpnic;">JPNIC idnkit</ulink>
      </para>
     </listitem>
     <listitem>
      <para>
       <ulink url="&url.idn.python;">Python IDNA</ulink>
      </para>
     </listitem>
     <listitem>
      <para>
       <ulink url="&url.idn.ibm.icu;">IBM ICU</ulink>
      </para>
     </listitem>
     <listitem>
      <para>
       <ulink url="&url.idn.imc.idna.pl;">IMC idna.pl</ulink>
      </para>
     </listitem>
    </itemizedlist>
   </section>

   <section id="idn.requirements">
    &reftitle.required;
    <para>
     You will need to get and compile the IDN libraries from
     either <ulink url="&url.idn.gnu;">GNU IDN Library 
     </ulink> or <ulink url="&url.idn.josefsson;">
     Simon Josefsson</ulink> to compile PHP with IDN support.
    </para>
   </section>

   &reference.idn.configure;

   &reference.idn.ini;

   <section id="idn.resources">
    &reftitle.resources;
    &no.resource;
   </section>

   <section id="idn.constants">
    &reftitle.constants;
    &no.constants;
   </section>

   <section id="idn.examples">
    &reftitle.examples;
    <para>
     Convert the string rksmrgs.josefon.org to a value that can
     be used in the DNS system.
    </para>
    <example>
     <title>IDN conversion example</title>
     <programlisting role="php">
<![CDATA[
<?php
echo idn_to_ascii('rksmrgs.josefon.org', 'ISO-8859-1');
?>
]]>
     </programlisting>
    </example>

    <para>
     Convert the string xn--rksmrgs-5wao1o.josefsson.org (that was the
     result from the example above) to a value that is UTF-8 encoded
     (ie, with international characters).
    </para>
    <example>
     <title>IDN conversion example</title>
     <programlisting role="php">
<![CDATA[
<?php
echo idn_to_utf8('xn--rksmrgs-5wao1o.josefsson.org, 'ISO-8859-1');
?>
]]>
     </programlisting>
    </example>
   </section>

   <section id="idn.using">
    <title>Using the PHP IDN calls</title>
    <para>
     Before you can use the IDN calls you will need to know ..

     <itemizedlist>
      <listitem>
       <para>
        What charset you will convert from. If not specified in the call
        to the function, this defaults to ISO-8859-1.
       </para>
      </listitem>
     </itemizedlist>
    </para>
   </section>
  </partintro>

  &reference.idn.functions;
 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->