more tidy docs and examples

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152318 c90b9560-bf6c-de11-be94-00142212c4b1

language-snippets.ent

@@ -291,3 +291,10 @@ Tidy 1.0. It became obsolete in Tidy 2.0 and thus has been removed.</simpara></n
 <!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>'>

reference/tidy/functions/tidy-diagnose.xml

@@ -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>
 

reference/tidy/functions/tidy-parse-file.xml

@@ -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>
-     &note.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>
+    &note.tidy.2only;
     <para>
      See also <function>tidy_parse_string</function>,
      <function>tidy_parse_string</function> and

reference/tidy/functions/tidy-parse-string.xml

@@ -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>

reference/tidy/functions/tidy-repair-file.xml

@@ -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>

reference/tidy/functions/tidy-repair-string.xml

@@ -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>