Hi, could anybody of you review the patches Christian (CC'd) sent me from a doc perspective? From the contents they seem to be fine but I have little knowledge about XML formatting rules and similar things...
thanks! johannes
Index: manual.xml.in =================================================================== RCS file: /repository/phpdoc/manual.xml.in,v retrieving revision 1.263 diff -u -r1.263 manual.xml.in --- manual.xml.in 14 Nov 2008 18:08:40 -0000 1.263 +++ manual.xml.in 5 Dec 2008 03:07:20 -0000 @@ -268,6 +268,7 @@ &reference.gettext.book; &reference.i18n.book; &reference.iconv.book; + &reference.idn.book; &reference.intl.book; &reference.mbstring.book; &reference.pspell.book; Index: en/appendices/extensions.xml =================================================================== RCS file: /repository/phpdoc/en/appendices/extensions.xml,v retrieving revision 1.42 diff -u -r1.42 extensions.xml --- en/appendices/extensions.xml 10 Nov 2008 20:28:01 -0000 1.42 +++ en/appendices/extensions.xml 5 Dec 2008 03:07:21 -0000 @@ -67,6 +67,7 @@ <listitem><simpara><xref linkend="book.ibm-db2" /></simpara></listitem> <listitem><simpara><xref linkend="book.iconv" /></simpara></listitem> <listitem><simpara><xref linkend="book.id3" /></simpara></listitem> + <listitem><simpara><xref linkend="book.idn" /></simpara></listitem> <listitem><simpara><xref linkend="book.ifx" /></simpara></listitem> <listitem><simpara><xref linkend="book.iisfunc" /></simpara></listitem> <listitem><simpara><xref linkend="book.image" /></simpara></listitem> @@ -432,6 +433,7 @@ <listitem><para><xref linkend="book.hwapi"/></para></listitem> <listitem><para><xref linkend="book.ibm-db2"/></para></listitem> <listitem><para><xref linkend="book.id3"/></para></listitem> + <listitem><para><xref linkend="book.idn"/></para></listitem> <listitem><para><xref linkend="book.iisfunc"/></para></listitem> <listitem><para><xref linkend="book.imagick"/></para></listitem> <listitem><para><xref linkend="book.ingres"/></para></listitem> Index: entities/global.ent =================================================================== RCS file: /repository/phpdoc/entities/global.ent,v retrieving revision 1.342 diff -u -r1.342 global.ent --- entities/global.ent 29 Nov 2008 15:21:21 -0000 1.342 +++ entities/global.ent 5 Dec 2008 03:07:26 -0000 @@ -167,6 +167,7 @@ <!ENTITY url.icu.userguide "http://www.icu-project.org/userguide/"> <!ENTITY url.icu.uca "http://www.unicode.org/reports/tr10/"> <!ENTITY url.icu.autoQuoteApostrophe "http://www.icu-project.org/apiref/icu4c/umsg_8h.html#9da796210146ff51d395affe4928f0b7"> +<!ENTITY url.idn "http://www.gnu.org/software/libidn/"> <!ENTITY url.iis "http://support.microsoft.com/kb/q160422/"> <!ENTITY url.iiscfg "http://www.genusa.com/iis/iiscfg.html"> <!ENTITY url.imagemagick "http://imagemagick.org/">
diff -Nur /newlycreated/book.xml en/reference/idn/book.xml --- /newlycreated/book.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/book.xml 2008-12-05 04:01:21.000000000 +0100 @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.3 $ --> +<!-- Purpose: international --> +<!-- Membership: pecl, external --> + +<book xml:id="book.idn" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>idn</title> + <titleabbrev>International Domain Names</titleabbrev> + + <preface xml:id="intro.idn"> + &reftitle.intro; + <para> +This extension gives access to the GNU Libidn which is +an implementation of the Stringprep, Punycode and IDNA specifications +defined by the IETF Internationalized Domain Names (IDN) working +group, used for internationalized domain names. + </para> + </preface> + + &reference.idn.setup; + &reference.idn.constants; + &reference.idn.reference; +</book> + +<!-- 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 +--> + diff -Nur /newlycreated/constants.xml en/reference/idn/constants.xml --- /newlycreated/constants.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/constants.xml 2008-12-04 23:57:09.000000000 +0100 @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<appendix xml:id="idn.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.constants; + &extension.constants; + <para> + <variablelist> + <varlistentry> + <term> + <constant>IDNA_STRINGPREP_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_PUNYCODE_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_CONTAINS_NON_LDH</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_CONTAINS_MINUS</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_INVALID_LENGTH</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_NO_ACE_PREFIX</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_ROUNDTRIP_VERIFY_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_CONTAINS_ACE_PREFIX</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_ICONV_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IDNA_MALLOC_ERROR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> +</appendix> + +<!-- 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 +--> + diff -Nur /newlycreated/entities.functions.xml en/reference/idn/entities.functions.xml --- /newlycreated/entities.functions.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/entities.functions.xml 2008-12-05 04:01:29.000000000 +0100 @@ -0,0 +1,3 @@ +&reference.idn.functions.idn-strerror; +&reference.idn.functions.idn-to-ascii; +&reference.idn.functions.idn-to-utf8; diff -Nur /newlycreated/functions/idn-strerror.xml en/reference/idn/functions/idn-strerror.xml --- /newlycreated/functions/idn-strerror.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/functions/idn-strerror.xml 2008-12-05 03:35:28.000000000 +0100 @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="function.idn-strerror" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>idn_strerror</refname> + <refpurpose>Returns string describing the IDNA error code</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>idn_strerror</methodname> + <methodparam><type>integer</type><parameter>errorcode</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the error message string that corresponds to the given error code. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>errorcode</parameter></term> + <listitem> + <para> + The error code as returned by idn_to_ascii() or idn_to_utf8(). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The corresponding libidn error message string is returned. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>idn_to_ascii</function></member> + <member><function>idn_to_utf8</function></member> + </simplelist> + </para> + </refsect1> + +</refentry> + +<!-- 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 +--> diff -Nur /newlycreated/functions/idn-to-ascii.xml en/reference/idn/functions/idn-to-ascii.xml --- /newlycreated/functions/idn-to-ascii.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/functions/idn-to-ascii.xml 2008-12-05 03:28:47.000000000 +0100 @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="function.idn-to-ascii" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>idn_to_ascii</refname> + <refpurpose>Convert UTF-8 encoded domain name to ASCII</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string|boolean</type><methodname>idn_to_ascii</methodname> + <methodparam><type>string</type><parameter>utf8_domain</parameter></methodparam> + <methodparam><type>integer</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + This function converts a UTF-8 encoded domain name to ASCII according to the IDNA toUnicode() specification. + If the input has non-ASCII characters, the output will be in the "xn--" ACE notation. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>utf8_domain</parameter></term> + <listitem> + <para> + The UTF-8 encoded domain name. CAVEAT: If e.g. an ISO-8859-1 (aka Western Europe latin1) encoded string is + passed it will be converted into an ACE encoded "xn--" string. It will not be the one you expected though! + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errorcode</parameter></term> + <listitem> + <para> + If a reference to a variable is passed, the variable is set to the IDNA error code. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <!-- See also &return.success; --> + <para> + The ACE encoded version of the domain name or &false; in case of an error. + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + If an error occurs &false; is returned and the optional errorcode is set. + In addition a E_WARNING message is printed. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>idn_to_ascii</function> example</title> + <para> + First a simple example and then one explaining how to catch errors. + </para> + <programlisting role="php"> +<![CDATA[ +<?php + +// ISO-8859-1 encoded string +echo idn_to_ascii(utf8_encode('täst.de'))); + +// Cannot convert a domain name to ASCII that contains non-ASCII chars but already starts with "xn--" +$ascii = @idn_to_ascii("xn--".chr(0xC3).chr(0xA4), $errorcode); +if ($ascii === false) printf("Detected error %d: %s\n", $errorcode, idn_strerror($errorcode)); + +?> +]]> + </programlisting> + <!-- &example.outputs.similar; --> + <screen> +<![CDATA[ +xn--tst-qla.de + +Detected error 8: Input already contain ACE prefix (`xn--') +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>utf8_encode</function></member> + <member><function>idn_strerror</function></member> + <member><function>itn_to_utf8</function></member> + </simplelist> + </para> + </refsect1> + +</refentry> + +<!-- 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 +--> diff -Nur /newlycreated/functions/idn-to-utf8.xml en/reference/idn/functions/idn-to-utf8.xml --- /newlycreated/functions/idn-to-utf8.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/functions/idn-to-utf8.xml 2008-12-05 03:29:12.000000000 +0100 @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="function.idn-to-utf8" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>idn_to_utf8</refname> + <refpurpose>Convert ASCII encoded domain name to UTF-8</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string|boolean</type><methodname>idn_to_utf8</methodname> + <methodparam><type>string</type><parameter>ascii_domain</parameter></methodparam> + <methodparam><type>integer</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + This function converts a ASCII encoded domain name to its original UTF-8 version. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>ascii_domain</parameter></term> + <listitem> + <para> + The ASCII encoded domain name. Looks like "xn--..." if the it originally contained non-ASCII characters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>errorcode</parameter></term> + <listitem> + <para> + If a reference to a variable is passed, the variable is set to the IDNA error code. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The UTF-8 encoded version of the domain name or &false; in case of an error. + RFC 3490 4.2 states though "ToUnicode never fails. If any step fails, then the original input + sequence is returned immediately in that step." + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + If an error occurs &false; is returned and the optional errorcode is set. + In addition a E_WARNING message is printed. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>idn_to_utf8</function> example</title> + <para> + First a simple example and then one explaining how to catch errors (which should never happen according to the RFC). + </para> + <programlisting role="php"> +<![CDATA[ +<?php + +// maybe convert the result to ISO-8859-1 using utf8_decode() +echo idn_to_utf8("xn--tst-qla.de"); + +// Should never happen but to be sure... +$utf8 = @idn_to_utf8("xn--tst-qla.de", $errorcode); +if ($utf8 === false) printf("Detected error %d: %s\n", $errorcode, idn_strerror($errorcode)); + +?> +]]> + </programlisting> + <!-- &example.outputs.similar; --> + <screen> +<![CDATA[ +täst.de +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>utf8_decode</function></member> + <member><function>idn_strerror</function></member> + <member><function>idn_to_ascii</function></member> + </simplelist> + </para> + </refsect1> + +</refentry> + +<!-- 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 +--> diff -Nur /newlycreated/reference.xml en/reference/idn/reference.xml --- /newlycreated/reference.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/reference.xml 2008-12-04 23:57:09.000000000 +0100 @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<reference xml:id="ref.idn" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>Idn &Functions;</title> + + &reference.idn.entities.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 +--> + diff -Nur /newlycreated/setup.xml en/reference/idn/setup.xml --- /newlycreated/setup.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/setup.xml 2008-12-05 04:01:13.000000000 +0100 @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<chapter xml:id="idn.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.setup; + + <!-- {{{ Requirements --> + <section xml:id="idn.requirements"> + &reftitle.required; + <para> + The GNU <link xlink:href="&url.idn;">IDN library</link> must be installed. + </para> + </section> + <!-- }}} --> + + <!-- {{{ Installation --> + <section xml:id="idn.install"> + &reftitle.install; + <para> + &pecl.moved; + </para> + <para> + &pecl.info; + <link xlink:href="&url.pecl.package;idn">&url.pecl.package;idn</link>. + </para> + </section> + <!-- }}} --> + + <!-- {{{ Configuration --> + <section xml:id="idn.configuration"> + &reftitle.runtime; + &no.config; + </section> + <!-- }}} --> + + <!-- {{{ Resources --> + <section xml:id="idn.resources"> + &reftitle.resources; + &no.resource; + </section> + <!-- }}} --> + + +</chapter> + +<!-- 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 +--> + diff -Nur /newlycreated/versions.xml en/reference/idn/versions.xml --- /newlycreated/versions.xml 1970-01-01 01:00:00.000000000 +0100 +++ en/reference/idn/versions.xml 2008-12-05 03:34:10.000000000 +0100 @@ -0,0 +1,33 @@ +<?xml version='1.0' encoding='utf-8'?> +<!-- $Revision: 1.1 $ --> +<!-- + Do NOT translate this file +--> +<versions> + <!-- Functions --> + <function name='idn_strerror' from='PHP 5 >= 5.2.0'/> + <function name='idn_to_ascii' from='PHP 5 >= 5.2.0'/> + <function name='idn_to_utf8' from='PHP 5 >= 5.2.0'/> + <!-- Methods --> +</versions> + +<!-- 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 +-->