philip Sat Feb 3 07:48:56 2007 UTC
Modified files:
/phpdoc/en/reference/recode/functions recode-file.xml
recode-string.xml
Log:
ref.recode: switch to new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/recode/functions/recode-file.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/recode/functions/recode-file.xml
diff -u phpdoc/en/reference/recode/functions/recode-file.xml:1.5
phpdoc/en/reference/recode/functions/recode-file.xml:1.6
--- phpdoc/en/reference/recode/functions/recode-file.xml:1.5 Mon Jan 15
17:42:13 2007
+++ phpdoc/en/reference/recode/functions/recode-file.xml Sat Feb 3
07:48:56 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/recode.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.recode-file">
<refnamediv>
<refname>recode_file</refname>
<refpurpose>Recode from file to file according to recode request</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>recode_file</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
@@ -18,15 +18,55 @@
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>. Returns &false;, if unable to
- comply, &true; otherwise.
+ <parameter>request</parameter>.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- This function does not currently process filehandles referencing
- remote files (URLs). Both filehandles must refer to local files.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>request</parameter></term>
+ <listitem>
+ <para>
+ The desired recode request type
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>input</parameter></term>
+ <listitem>
+ <para>
+ A local file handle <type>resource</type> for
+ the <parameter>input</parameter>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>output</parameter></term>
+ <listitem>
+ <para>
+ A local file handle <type>resource</type> for
+ the <parameter>output</parameter>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <example>
+ Returns &false;, if unable to comply, &true; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
<title>Basic <function>recode_file</function> example</title>
<programlisting role="php">
<![CDATA[
@@ -40,6 +80,24 @@
</example>
</para>
</refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <para>
+ This function does not currently process file handles referencing
+ remote files (URLs). Both file handles must refer to local files.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>fopen</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/recode/functions/recode-string.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/recode/functions/recode-string.xml
diff -u phpdoc/en/reference/recode/functions/recode-string.xml:1.5
phpdoc/en/reference/recode/functions/recode-string.xml:1.6
--- phpdoc/en/reference/recode/functions/recode-string.xml:1.5 Mon Jan 15
17:42:13 2007
+++ phpdoc/en/reference/recode/functions/recode-string.xml Sat Feb 3
07:48:56 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/recode.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.recode-string">
<refnamediv>
<refname>recode_string</refname>
<refpurpose>Recode a string according to a recode request</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>recode_string</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
@@ -15,25 +15,78 @@
</methodsynopsis>
<para>
Recode the string <parameter>string</parameter> according to
- the recode request <parameter>request</parameter>. Returns the
- recoded string or &false;, if unable to perform the recode request.
+ the recode request <parameter>request</parameter>.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>request</parameter></term>
+ <listitem>
+ <para>
+ The desired recode request type
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>string</parameter></term>
+ <listitem>
+ <para>
+ The <type>string</type> to be recoded
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the recoded <type>string</type> or &false;, if unable to
+ perform the recode request.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
- A simple recode request may be "lat1..iso646-de".
- See also the GNU Recode documentation of your installation
- for detailed instructions about recode requests.
- <example>
- <title>Basic <function>recode_string</function> example:</title>
+ <example>
+ <title>Basic <function>recode_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo recode_string("us..flat", "The following character has a diacritical
mark: á");
?>
+
]]>
</programlisting>
</example>
</para>
</refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <para>
+ A simple recode request may be "lat1..iso646-de".
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member>
+ The GNU Recode documentation of your installation for detailed
+ instructions about recode requests.
+ </member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
