cvs: phpdoc /en/reference/tidy/functions tidy-get-body.xml tidy-get-head.xml tidy-get-html.xml

nlopess Sun Jan 18 07:45:56 2004 EDT Modified files: /phpdoc/en/reference/tidy/functions tidy-get-html.xml tidy-get-head.xml tidy-get-body.xml Log: added documentation and examples Index: phpdoc/en/reference/tidy/functions/tidy-get-html.xml diff -u phpdoc/en/reference/tidy/functions/tidy-get-html.xml:1.5 phpdoc/en/reference/tidy/functions/tidy-get-html.xml:1.6 --- phpdoc/en/reference/tidy/functions/tidy-get-html.xml:1.5 Sun Dec 7 17:00:56 2003 +++ phpdoc/en/reference/tidy/functions/tidy-get-html.xml Sun Jan 18 07:45:55 2004 @@ -1,22 +1,67 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.6 $ --> <refentry id="function.tidy-get-html"> <refnamediv> <refname>tidy_get_html</refname> <refpurpose> - Returns a TidyNode Object starting from the &gt;HTML&lt; tag of the tidy parse tree + Returns a TidyNode Object starting from the &lt;html&gt; tag of the tidy parse tree </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>tidy_get_html</methodname> - <void/> + <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> + <para> + This function returns a TidyNode object starting from the &lt;html&gt; + tag of the tidy parse tree. + </para> + <para> + <example> + <title><function>tidy_get_html</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = ' +<html> + <head> + <title>test</title> + </head> + <body> + <p>paragraph</p> + </body> +</html>'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$html = tidy_get_html($tidy); +echo $html->value; +?> +]]> + </programlisting> + <para> + The above example will output: + </para> + <screen> +<![CDATA[ +<html> +<head> +<title>test</title> +</head> +<body> +<p>paragraph</p> +</body> +</html> +]]> + </screen> + </example> + </para> &note.tidy.ze2; + <para> + See also <function>tidy_get_body</function> and + <function>tidy_get_head</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/tidy/functions/tidy-get-head.xml diff -u phpdoc/en/reference/tidy/functions/tidy-get-head.xml:1.4 phpdoc/en/reference/tidy/functions/tidy-get-head.xml:1.5 --- phpdoc/en/reference/tidy/functions/tidy-get-head.xml:1.4 Sun Dec 7 17:00:56 2003 +++ phpdoc/en/reference/tidy/functions/tidy-get-head.xml Sun Jan 18 07:45:56 2004 @@ -1,22 +1,62 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.5 $ --> <refentry id="function.tidy-get-head"> <refnamediv> <refname>tidy_get_head</refname> <refpurpose> - Returns a TidyNode Object starting from the &gt;HEAD&lt; tag of the tidy parse tree + Returns a TidyNode Object starting from the &lt;head&gt; tag of the tidy parse tree </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>tidy_get_head</methodname> - <void/> + <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> + <para> + This function returns a TidyNode object starting from the &lt;head&gt; + tag of the tidy parse tree. + </para> + <para> + <example> + <title><function>tidy_get_head</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = ' +<html> + <head> + <title>test</title> + </head> + <body> + <p>paragraph</p> + </body> +</html>'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$head = tidy_get_head($tidy); +echo $head->value; +?> +]]> + </programlisting> + <para> + The above example will output: + </para> + <screen> +<![CDATA[ +<head> +<title>test</title> +</head> +]]> + </screen> + </example> + </para> &note.tidy.ze2; + <para> + See also <function>tidy_get_body</function> and + <function>tidy_get_html</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/tidy/functions/tidy-get-body.xml diff -u phpdoc/en/reference/tidy/functions/tidy-get-body.xml:1.4 phpdoc/en/reference/tidy/functions/tidy-get-body.xml:1.5 --- phpdoc/en/reference/tidy/functions/tidy-get-body.xml:1.4 Sun Dec 7 17:00:56 2003 +++ phpdoc/en/reference/tidy/functions/tidy-get-body.xml Sun Jan 18 07:45:56 2004 @@ -1,11 +1,10 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.5 $ --> <refentry id="function.tidy-get-body"> <refnamediv> <refname>tidy_get_body</refname> <refpurpose> - Returns a TidyNode Object starting from the &gt;BODY&lt; tag of the tidy parse tree + Returns a TidyNode Object starting from the &lt;body&gt; tag of the tidy parse tree </refpurpose> </refnamediv> <refsect1> @@ -14,9 +13,50 @@ <type>object</type><methodname>tidy_get_body</methodname> <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> + <para> + This function returns a TidyNode object starting from the &lt;body&gt; + tag of the tidy parse tree. + </para> + <para> + <example> + <title><function>tidy_get_body</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = ' +<html> + <head> + <title>test</title> + </head> + <body> + <p>paragraph</p> + </body> +</html>'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$body = tidy_get_body($tidy); +echo $body->value; +?> +]]> + </programlisting> + <para> + The above example will output: + </para> + <screen> +<![CDATA[ +<body> +<p>paragraph</p> +</body> +]]> + </screen> + </example> + </para> &note.tidy.ze2; + <para> + See also <function>tidy_get_head</function> and + <function>tidy_get_html</function>. + </para> </refsect1> </refentry>