nlopess Sun Feb 15 12:21:04 2004 EDT
Modified files:
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/tidy/functions tidy-diagnose.xml
tidy-parse-string.xml
tidy-repair-file.xml
tidy-repair-string.xml
Log:
some more tidy documentation
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.73&r2=1.74&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.73 phpdoc/en/language-snippets.ent:1.74
--- phpdoc/en/language-snippets.ent:1.73 Sun Feb 8 06:52:42 2004
+++ phpdoc/en/language-snippets.ent Sun Feb 15 12:21:03 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.73 $ -->
+<!-- $Revision: 1.74 $ -->
<!ENTITY warn.experimental '<warning><simpara>This extension is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension --
@@ -263,5 +263,5 @@
Tidy 1.0. It became obsolete in Tidy 2.0 and thus has been removed.</simpara></note>'>
<!ENTITY note.tidy.2only '<note><simpara>The optional parameters
-<literal>config_options</literal> and <literal>encoding</literal> were
+<literal>config</literal> and <literal>encoding</literal> were
added in Tidy 2.0.</simpara></note>'>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-diagnose.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-diagnose.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.2
phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.3
--- phpdoc/en/reference/tidy/functions/tidy-diagnose.xml:1.2 Thu Nov 6 05:15:43
2003
+++ phpdoc/en/reference/tidy/functions/tidy-diagnose.xml Sun Feb 15 12:21:04
2004
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tidy-diagnose">
<refnamediv>
<refname>tidy_diagnose</refname>
@@ -12,11 +11,12 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_diagnose</methodname>
- <void/>
+ <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
-
- &warn.undocumented.func;
-
+ <para>
+ <function>tidy_diagnose</function> runs diagnostic tests on the given
+ resource.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-string.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-parse-string.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.1
phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.2
--- phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.1 Tue Nov 4
08:26:55 2003
+++ phpdoc/en/reference/tidy/functions/tidy-parse-string.xml Sun Feb 15 12:21:04
2004
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.tidy-parse-string">
<refnamediv>
<refname>tidy_parse_string</refname>
@@ -14,9 +13,70 @@
<type>bool</type><methodname>tidy_parse_string</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
</methodsynopsis>
+ <para>
+ <function>tidy_parse_string</function> parses a document stored in a
+ string.
+ </para>
+ <para>
+ <example>
+ <title><function>tidy_parse_string</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+ob_start();
+?>
- &warn.undocumented.func;
+<html>
+ <head>
+ <title>test</title>
+ </head>
+ <body>
+ <p>error<br>another line</i>
+ </body>
+</html>
+<?php
+
+$buffer = ob_get_clean();
+$config = array('indent' => TRUE,
+ 'output-xhtml' => TRUE,
+ 'wrap', 200);
+
+$tidy = tidy_repair_string($buffer, $config, 'UTF8');
+
+echo $tidy;
+?>
+]]>
+ </programlisting>
+ <para>
+ The above example will output:
+ </para>
+ <screen>
+<![CDATA[
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+ <head>
+ <title>
+ test
+ </title>
+ </head>
+ <body>
+ <p>
+ error<br />
+ another line
+ </p>
+ </body>
+</html>
+]]>
+ </screen>
+ </example>
+ </para>
+ <para>
+ See also <function>tidy_parse_file</function>,
+ <function>tidy_repair_file</function> and
+ <function>tidy_repair_string</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-repair-file.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-repair-file.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.2
phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.3
--- phpdoc/en/reference/tidy/functions/tidy-repair-file.xml:1.2 Thu Nov 6 05:15:43
2003
+++ phpdoc/en/reference/tidy/functions/tidy-repair-file.xml Sun Feb 15 12:21:04
2004
@@ -1,11 +1,10 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tidy-repair-file">
<refnamediv>
<refname>tidy_repair_file</refname>
<refpurpose>
- Repair a file using an optionally provided configuration file
+ Repair a file and return it as a string
</refpurpose>
</refnamediv>
<refsect1>
@@ -13,12 +12,36 @@
<methodsynopsis>
<type>bool</type><methodname>tidy_repair_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>config_file</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam
choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
+ <para>
+ This function repairs the given file and returns it as a string.
+ </para>
+ <para>
+ <example>
+ <title><function>tidy_repair_file</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$file = 'file.html';
- &warn.undocumented.func;
+$repaired = tidy_repair_file($file);
+rename($file, $file . '.bak');
+file_put_contents($file, $repaired);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ ¬e.tidy.2only;
+ <para>
+ See also <function>tidy_parse_file</function>,
+ <function>tidy_parse_string</function> and
+ <function>tidy_repair_string</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-repair-string.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-repair-string.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.3
phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-repair-string.xml:1.3 Mon Jan 19
14:59:16 2004
+++ phpdoc/en/reference/tidy/functions/tidy-repair-string.xml Sun Feb 15 12:21:04
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.tidy-repair-string">
<refnamediv>
<refname>tidy_repair_string</refname>
@@ -12,7 +12,7 @@
<methodsynopsis>
<type>bool</type><methodname>tidy_repair_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>config_file</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
@@ -63,12 +63,12 @@
</screen>
</example>
</para>
+ ¬e.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_parse_string</function> and
<function>tidy_repair_file</function>.
</para>
- ¬e.tidy.2only;
</refsect1>
</refentry>
