cvs: phpdoc /en/reference/tidy constants.xml /en/reference/tidy/functions tidy-is-xhtml.xml tidy-is-xml.xml tidy-load-config.xml tidy-parse-file.xml
tidy-parse-string.xml tidy-reset-config.xml

nlopess Sun Jul 4 06:06:18 2004 EDT Modified files: /phpdoc/en/reference/tidy constants.xml /phpdoc/en/reference/tidy/functions tidy-is-xhtml.xml tidy-is-xml.xml tidy-load-config.xml tidy-parse-file.xml tidy-parse-string.xml tidy-reset-config.xml Log: tidy docs almost finished

http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/constants.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/tidy/constants.xml diff -u phpdoc/en/reference/tidy/constants.xml:1.2 phpdoc/en/reference/tidy/constants.xml:1.3 --- phpdoc/en/reference/tidy/constants.xml:1.2 Tue Mar 9 14:55:23 2004 +++ phpdoc/en/reference/tidy/constants.xml Sun Jul 4 06:06:18 2004 @@ -1,9 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="tidy.constants"> &reftitle.constants; &extension.constants; <para> + Each <constant>TIDY_TAG_XXX</constant> represents a HTML tag. For example, + <constant>TIDY_TAG_A</constant> represents a &lt;a + href="XX"&gt;link&lt;/a&gt; tag. + </para> + <para> The following constants are defined: <table> <title>tidy tag constants</title> @@ -11,587 +16,356 @@ <thead> <row> <entry>constant</entry> - <entry>description</entry> </row> </thead> <tbody> <row> <entry>TIDY_TAG_UNKNOWN</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_A</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_ABBR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_ACRONYM</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_ALIGN</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_APPLET</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_AREA</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_B</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BASE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BASEFONT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BDO</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BGSOUND</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BIG</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BLINK</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BLOCKQUOTE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BODY</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_BR</entry> - <entry></entry> </row> <row> <entry>TIDY_TAG_BUTTON</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_CAPTION</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_CENTER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_CITE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_CODE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_COL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_COLGROUP</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_COMMENT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DD</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DEL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DFN</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DIR</entry> - <entry></entry> </row> <row> <entry>TIDY_TAG_DIV</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_DT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_EM</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_EMBED</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_FIELDSET</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_FONT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_FORM</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_FRAME</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_FRAMESET</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_H1</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_H2</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_H3</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_H4</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_H5</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_6</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_HEAD</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_HR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_HTML</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_I</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_IFRAME</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_ILAYER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_IMG</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_INPUT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_INS</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_ISINDEX</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_KBD</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_KEYGEN</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LABEL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LAYER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LEGEND</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LI</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LINK</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_LISTING</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_MAP</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_MARQUEE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_MENU</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_META</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_MULTICOL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOBR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOEMBED</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOFRAMES</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOLAYER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOSAFE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_NOSCRIPT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_OBJECT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_OL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_OPTGROUP</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_OPTION</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_P</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_PARAM</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_PLAINTEXT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_PRE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_Q</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_RP</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_RT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_RTC</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_RUBY</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_S</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SAMP</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SCRIPT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SELECT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SERVER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SERVLET</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SMALL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SPACER</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SPAN</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_STRIKE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_STRONG</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_STYLE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_SUB</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TABLE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TBODY</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TD</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TEXTAREA</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TFOOT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TH</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_THEAD</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TITLE</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_TT</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_U</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_UL</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_VAR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_WBR</entry> - <entry> - </entry> </row> <row> <entry>TIDY_TAG_XMP</entry> - <entry> - </entry> </row> </tbody> </tgroup> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml diff -u phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml:1.3 phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml:1.4 --- phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml:1.3 Thu Jan 29 11:00:58 2004 +++ phpdoc/en/reference/tidy/functions/tidy-is-xhtml.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.tidy-is-xhtml"> <refnamediv> <refname>tidy_is_xhtml</refname> @@ -9,13 +9,26 @@ </refnamediv> <refsect1> <title>Description</title> + <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>tidy_is_xhtml</methodname> <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para>Object oriented style:</para> + <methodsynopsis> + <type>object</type><methodname>tidy->isXhtml</methodname> + <void /> + </methodsynopsis> + <para> + This function returns &true; if the specified <parameter>tidy</parameter> + object is a XHTML document, or &false; otherwise. + </para> + <warning> + <para> + This function is not yet implemented in the Tidylib itself, so it always + return &false;. + </para> + </warning> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-is-xml.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-is-xml.xml diff -u phpdoc/en/reference/tidy/functions/tidy-is-xml.xml:1.1 phpdoc/en/reference/tidy/functions/tidy-is-xml.xml:1.2 --- phpdoc/en/reference/tidy/functions/tidy-is-xml.xml:1.1 Thu Jan 29 11:00:58 2004 +++ phpdoc/en/reference/tidy/functions/tidy-is-xml.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.tidy-is-xml"> <refnamediv> <refname>tidy_is_xml</refname> @@ -9,13 +9,26 @@ </refnamediv> <refsect1> <title>Description</title> + <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>tidy_is_xml</methodname> <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para>Object oriented style:</para> + <methodsynopsis> + <type>object</type><methodname>tidy->isXml</methodname> + <void /> + </methodsynopsis> + <para> + This function returns &true; if the specified <parameter>tidy</parameter> + object is a generic XML document (non HTML/XHTML), or &false; otherwise. + </para> + <warning> + <para> + This function is not yet implemented in the Tidylib itself, so it always + return &false;. + </para> + </warning> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-load-config.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-load-config.xml diff -u phpdoc/en/reference/tidy/functions/tidy-load-config.xml:1.3 phpdoc/en/reference/tidy/functions/tidy-load-config.xml:1.4 --- phpdoc/en/reference/tidy/functions/tidy-load-config.xml:1.3 Sun Jan 18 10:11:07 2004 +++ phpdoc/en/reference/tidy/functions/tidy-load-config.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.tidy-load-config"> <refnamediv> <refname>tidy_load_config</refname> @@ -14,7 +14,10 @@ <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + This function loads a Tidy configuration file, with the specified + <parameter>encoding</parameter>. + </para> &note.tidy.1only; </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-file.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-parse-file.xml diff -u phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.5 phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.6 --- phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.5 Wed Feb 25 06:07:43 2004 +++ phpdoc/en/reference/tidy/functions/tidy-parse-file.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.tidy-parse-file"> <refnamediv> <refname>tidy_parse_file</refname> @@ -9,6 +9,7 @@ </refnamediv> <refsect1> <title>Description</title> + <para>Procedural style:</para> <methodsynopsis> <type>resource</type><methodname>tidy_parse_file</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -16,6 +17,14 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam> </methodsynopsis> + <para>Object oriented style:</para> + <methodsynopsis> + <type>bool</type><methodname>tidy->parseFile</methodname> + <methodparam><type>string</type><parameter>filename</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 parses the given file. </para> @@ -30,9 +39,9 @@ $tidy->cleanRepair(); -if(!empty($tidy->error_buf)) { +if(!empty($tidy->errorBuffer)) { echo "The following errors or warnings occured:\n"; - echo $tidy->error_buf; + echo $tidy->errorBuffer; } ?> ]]> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-string.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-parse-string.xml diff -u phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.4 phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.5 --- phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.4 Wed Feb 25 06:07:43 2004 +++ phpdoc/en/reference/tidy/functions/tidy-parse-string.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.tidy-parse-string"> <refnamediv> <refname>tidy_parse_string</refname> @@ -9,8 +9,16 @@ </refnamediv> <refsect1> <title>Description</title> + <para>Procedural style:</para> <methodsynopsis> <type>resource</type><methodname>tidy_parse_string</methodname> + <methodparam><type>string</type><parameter>input</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style:</para> + <methodsynopsis> + <type>bool</type><methodname>tidy->parseString</methodname> <methodparam><type>string</type><parameter>input</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-reset-config.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-reset-config.xml diff -u phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.3 phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.4 --- phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.3 Wed Mar 3 13:24:08 2004 +++ phpdoc/en/reference/tidy/functions/tidy-reset-config.xml Sun Jul 4 06:06:18 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.tidy-reset-config"> <refnamediv> <refname>tidy_reset_config</refname> @@ -13,7 +13,9 @@ <type>bool</type><methodname>tidy_reset_config</methodname> <void/> </methodsynopsis> - &warn.undocumented.func; + <para> + This function restores the Tidy configuration to the default values. + </para> &note.tidy.1only; </refsect1> </refentry>