cvs: phpdoc /en/reference/recode reference.xml

betz Wed Aug 7 06:04:00 2002 EDT Modified files: /phpdoc/en/reference/recode reference.xml Log: new structure applied Index: phpdoc/en/reference/recode/reference.xml diff -u phpdoc/en/reference/recode/reference.xml:1.3 phpdoc/en/reference/recode/reference.xml:1.4 --- phpdoc/en/reference/recode/reference.xml:1.3 Sun Jun 9 18:28:04 2002 +++ phpdoc/en/reference/recode/reference.xml Wed Aug 7 06:04:00 2002 @@ -1,38 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <reference id="ref.recode"> <title>GNU Recode functions</title> <titleabbrev>Recode</titleabbrev> <partintro> - <para> - This module contains an interface to the GNU Recode library, - version 3.5. To be able to use the functions defined in this - module you must compile you PHP interpreter using the --with-recode - option. In order to do so, you must have GNU Recode 3.5 or higher - installed on your system. - </para> - <para> - The GNU Recode library converts files between various coded - character sets and surface encodings. When this cannot be - achieved exactly, it may get rid of the offending characters or - fall back on approximations. The library recognises or produces - nearly 150 different character sets and is able to convert files - between almost any pair. Most RFC 1345 character sets are supported. - </para> - <warning> + <section id="recode.intro"> + &reftitle.intro; <para> - Crashes and startup problems of <literal>PHP</literal> may be encountered - when loading the recode as extension <emphasis - role="strong">after</emphasis> loading any extension of <link - linkend="ref.mysql">mysql</link> or <link - linkend="ref.imap">imap</link>. Loading the recode before those - extension has proven to fix the problem. This is due a technical problem - that both the c-client library used by imap and recode have their own - <literal>hash_lookup()</literal> function and both mysql and recode have - their own <literal>hash_insert</literal> function. + This module contains an interface to the GNU Recode library, + version 3.5. The GNU Recode library converts files between various coded + character sets and surface encodings. When this cannot be + achieved exactly, it may get rid of the offending characters or + fall back on approximations. The library recognises or produces + nearly 150 different character sets and is able to convert files + between almost any pair. + Most <ulink url="&url.rfc;rfc1345.html">RFC 1345</ulink> character sets + are supported. </para> - </warning> + </section> + + <section id="recode.requirenments"> + &reftitle.required; + <para> + You must have GNU Recode 3.5 or higher installed on your system. + You can download the package from <ulink url="&url.recode;">here</ulink>. + </para> + </section> + + <section id="recode.installation"> + &reftitle.install; + <para> + To be able to use the functions defined in this + module you must compile your PHP interpreter using the + <option role="configure">--with-recode[=DIR]</option> + option. + </para> + <warning> + <para> + Crashes and startup problems of <literal>PHP</literal> may be encountered + when loading the recode as extension <emphasis + role="strong">after</emphasis> loading any extension of <link + linkend="ref.mysql">mysql</link> or <link + linkend="ref.imap">imap</link>. Loading the recode before those + extension has proven to fix the problem. This is due a technical problem + that both the c-client library used by imap and recode have their own + <literal>hash_lookup()</literal> function and both mysql and recode have + their own <literal>hash_insert</literal> function. + </para> + </warning> + </section> + + <section id="recode.configuration"> + &reftitle.runtime; + &no.config; + </section> + + <section id="recode.resources"> + &reftitle.resources; + &no.resource; + </section> + + <section id="recode.constants"> + &reftitle.constants; + &no.constants; + </section> </partintro> &reference.recode.functions;