1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

recode : fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-25 15:52:34 +00:00
parent f538ce7ce8
commit 72f847e072
5 changed files with 40 additions and 50 deletions

View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- State: deprecated -->
<book xml:id="book.recode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.recode">
<?phpdoc extension-membership="pecl" ?>
<title>GNU Recode</title>
<titleabbrev>Recode</titleabbrev>
@@ -11,7 +10,7 @@
<preface xml:id="intro.recode">
&reftitle.intro;
&warn.pecl.unmaintained;
<para>
<simpara>
This module contains an interface to the GNU Recode library. The GNU
Recode library converts files between various coded character sets and
surface encodings. When this cannot be achieved exactly, it may get rid
@@ -20,7 +19,7 @@
convert files between almost any pair. Most
<link xlink:href="&url.rfc;1345">RFC 1345</link> character sets are
supported.
</para>
</simpara>
<note>
<simpara>
This extension is unbundled and moved to <link xlink:href="&url.pecl.package;recode">PECL</link>
@@ -37,7 +36,6 @@
&reference.recode.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -58,4 +56,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -1,44 +1,40 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="recode.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="recode.installation">
&reftitle.install;
<section xml:id="recode.installation.php74">
<title>PHP 7.4</title>
<para>
<simpara>
&pecl.moved-ver;7.4.0
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;recode">&url.pecl.package;recode</link>.
</para>
</simpara>
</section>
<section xml:id="recode.installation.phplt74">
<title>PHP &lt; 7.4</title>
<para>
<simpara>
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>
</simpara>
<warning>
<para>
<simpara>
Crashes and startup problems of PHP 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
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 proved 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>
</simpara>
</warning>
&warn.imaprecodeyaz;
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -14,12 +14,12 @@
<methodparam><type>resource</type><parameter>input</parameter></methodparam>
<methodparam><type>resource</type><parameter>output</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Recode the file referenced by file handle
<parameter>input</parameter> into the file referenced by file
handle <parameter>output</parameter> according to the recode
<parameter>request</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,27 +28,27 @@
<varlistentry>
<term><parameter>request</parameter></term>
<listitem>
<para>
<simpara>
The desired recode request type
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
<simpara>
A local file handle <type>resource</type> for
the <parameter>input</parameter>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output</parameter></term>
<listitem>
<para>
<simpara>
A local file handle <type>resource</type> for
the <parameter>output</parameter>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -56,9 +56,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &false;, if unable to comply, &true; otherwise.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -79,10 +79,10 @@ recode_file("us..flat", $input, $output);
<refsect1 role="notes">
&reftitle.notes;
<para>
<simpara>
This function does not currently process file handles referencing
remote files (URLs). Both file handles must refer to local files.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

View File

@@ -13,10 +13,10 @@
<methodparam><type>string</type><parameter>request</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Recode the string <parameter>string</parameter> according to
the recode request <parameter>request</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>request</parameter></term>
<listitem>
<para>
<simpara>
The desired recode request type
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
<simpara>
The <type>string</type> to be recoded
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,10 +43,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the recoded <type>string</type> or &false;, if unable to
perform the recode request.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -66,9 +66,9 @@ echo recode_string("us..flat", "The following character has a diacritical mark:
<refsect1 role="notes">
&reftitle.notes;
<para>
<simpara>
A simple recode request may be &quot;lat1..iso646-de&quot;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

View File

@@ -1,24 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="recode.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="recode.setup">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="recode.requirements">
&reftitle.required;
<para>
<simpara>
You must have GNU Recode 3.5 or higher installed on your system.
You can download the package from <link xlink:href="&url.recode;">&url.recode;</link>.
</para>
</simpara>
<warning>
<para>
<simpara>
The Recode library version 3.6 adds weird characters behind converted
strings under certain circumstances. Thus it's safer to use Recode v3.5
or one of the available alternatives like the
<link linkend="ref.iconv">iconv</link> or
<link linkend="ref.mbstring">mbstring</link> extension.
</para>
</simpara>
</warning>
</section>
<!-- }}} -->
@@ -28,7 +27,6 @@
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -49,4 +47,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->