nlopess Wed Feb 25 06:07:43 2004 EDT
Modified files:
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/tidy/functions tidy-diagnose.xml
tidy-parse-file.xml
tidy-parse-string.xml
tidy-repair-file.xml
tidy-repair-string.xml
Log:
more tidy docs and examples
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.77&r2=1.78&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.77 phpdoc/en/language-snippets.ent:1.78
--- phpdoc/en/language-snippets.ent:1.77 Thu Feb 19 11:06:55 2004
+++ phpdoc/en/language-snippets.ent Wed Feb 25 06:07:42 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.77 $ -->
+<!-- $Revision: 1.78 $ -->
<!ENTITY warn.experimental '<warning><simpara>This extension is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension --
@@ -291,3 +291,10 @@
<!ENTITY note.tidy.2only '<note><simpara>The optional parameters
<literal>config</literal> and <literal>encoding</literal> were
added in Tidy 2.0.</simpara></note>'>
+
+<!ENTITY tidy.conf-enc '<para>The <parameter>config</parameter> parameter can be
passed either as an array
+or as a string. If you pass it as a string, it means the name of the configuration
file, otherwise
+it is interpreted as the options themselves. Check <ulink
url="&url.tidy.conf;">&url.tidy.conf;</ulink>
+for an explanation about each option.</para><para>The <parameter>encoding</parameter>
parameter sets the
+encoding for input/output documents. The possible values for
<parameter>encoding</parameter> are:
+ascii, latin0, latin1, raw, utf8, iso202, utf16le, utf16be, utf16, mac, win1252,
ibm858, big5 and shiftjis.</para>'>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-diagnose.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-diagnose.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.3
phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.3 Sun Feb 15 12:21:04
2004
+++ phpdoc/en/reference/tidy/functions/tidy-diagnose.xml Wed Feb 25 06:07:43
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.tidy-diagnose">
<refnamediv>
<refname>tidy_diagnose</refname>
@@ -17,6 +17,9 @@
<function>tidy_diagnose</function> runs diagnostic tests on the given
resource.
</para>
+ <para>
+ &return.success;
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-file.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-parse-file.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.4
phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.5
--- phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.4 Sun Feb 22 07:23:25
2004
+++ phpdoc/en/reference/tidy/functions/tidy-parse-file.xml Wed Feb 25 06:07:43
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.tidy-parse-file">
<refnamediv>
<refname>tidy_parse_file</refname>
@@ -19,7 +19,27 @@
<para>
This function parses the given file.
</para>
- ¬e.tidy.2only;
+ &tidy.conf-enc;
+ <para>
+ <example>
+ <title><function>tidy_parse_file</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$tidy = tidy_parse_file('file.html');
+
+$tidy->cleanRepair();
+
+if(!empty($tidy->error_buf)) {
+ echo "The following errors or warnings occured:\n";
+ echo $tidy->error_buf;
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ ¬e.tidy.2only;
<para>
See also <function>tidy_parse_string</function>,
<function>tidy_parse_string</function> and
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-string.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-parse-string.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.3
phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.3 Sun Feb 22
07:23:25 2004
+++ phpdoc/en/reference/tidy/functions/tidy-parse-string.xml Wed Feb 25 06:07:43
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.tidy-parse-string">
<refnamediv>
<refname>tidy_parse_string</refname>
@@ -19,6 +19,7 @@
<function>tidy_parse_string</function> parses a document stored in a
string.
</para>
+ &tidy.conf-enc;
<para>
<example>
<title><function>tidy_parse_string</function> example</title>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-repair-file.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-repair-file.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.4
phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.5
--- phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.4 Tue Feb 17 12:40:06
2004
+++ phpdoc/en/reference/tidy/functions/tidy-repair-file.xml Wed Feb 25 06:07:43
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.tidy-repair-file">
<refnamediv>
<refname>tidy_repair_file</refname>
@@ -19,6 +19,7 @@
<para>
This function repairs the given file and returns it as a string.
</para>
+ &tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_file</function> example</title>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-repair-string.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-repair-string.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.5
phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.6
--- phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.5 Tue Feb 17
12:40:06 2004
+++ phpdoc/en/reference/tidy/functions/tidy-repair-string.xml Wed Feb 25 06:07:43
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.tidy-repair-string">
<refnamediv>
<refname>tidy_repair_string</refname>
@@ -18,6 +18,7 @@
<para>
This function repairs the given string.
</para>
+ &tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_string</function> example</title>
