From 7439959e0ba83178fcc36d6a1c1384281d03b5a9 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 30 Dec 2007 00:34:38 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249387 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/tidy/functions/ob-tidyhandler.xml | 66 +++---- .../tidy/functions/tidy-access-count.xml | 78 ++++---- .../tidy/functions/tidy-clean-repair.xml | 78 ++++---- .../tidy/functions/tidy-config-count.xml | 54 +++-- reference/tidy/functions/tidy-construct.xml | 82 ++++---- reference/tidy/functions/tidy-diagnose.xml | 84 ++++---- reference/tidy/functions/tidy-error-count.xml | 66 +++---- reference/tidy/functions/tidy-get-body.xml | 80 ++++---- reference/tidy/functions/tidy-get-config.xml | 186 +++++++++--------- .../tidy/functions/tidy-get-error-buffer.xml | 80 ++++---- reference/tidy/functions/tidy-get-head.xml | 80 ++++---- .../tidy/functions/tidy-get-html-ver.xml | 62 +++--- reference/tidy/functions/tidy-get-html.xml | 80 ++++---- reference/tidy/functions/tidy-get-output.xml | 58 +++--- reference/tidy/functions/tidy-get-release.xml | 48 +++-- reference/tidy/functions/tidy-get-root.xml | 70 ++++--- reference/tidy/functions/tidy-get-status.xml | 66 +++---- reference/tidy/functions/tidy-getopt.xml | 80 ++++---- reference/tidy/functions/tidy-is-xhtml.xml | 62 +++--- reference/tidy/functions/tidy-is-xml.xml | 64 +++--- reference/tidy/functions/tidy-load-config.xml | 42 ++-- .../tidy/functions/tidy-node-get-attr.xml | 32 ++- .../tidy/functions/tidy-node-get-nodes.xml | 32 ++- reference/tidy/functions/tidy-node-next.xml | 32 ++- reference/tidy/functions/tidy-node-prev.xml | 32 ++- reference/tidy/functions/tidy-parse-file.xml | 90 +++++---- .../tidy/functions/tidy-parse-string.xml | 92 +++++---- reference/tidy/functions/tidy-repair-file.xml | 70 ++++--- .../tidy/functions/tidy-repair-string.xml | 74 ++++--- .../tidy/functions/tidy-reset-config.xml | 38 ++-- reference/tidy/functions/tidy-save-config.xml | 52 +++-- .../tidy/functions/tidy-set-encoding.xml | 44 ++--- reference/tidy/functions/tidy-setopt.xml | 72 ++++--- .../tidy/functions/tidy-warning-count.xml | 60 +++--- .../tidy/functions/tidyNode-hasChildren.xml | 6 +- .../tidy/functions/tidyNode-hasSiblings.xml | 6 +- reference/tidy/functions/tidyNode-isAsp.xml | 50 +++-- .../tidy/functions/tidyNode-isComment.xml | 6 +- reference/tidy/functions/tidyNode-isHtml.xml | 6 +- reference/tidy/functions/tidyNode-isJste.xml | 6 +- reference/tidy/functions/tidyNode-isPhp.xml | 68 ++++--- reference/tidy/functions/tidyNode-isText.xml | 6 +- 42 files changed, 1178 insertions(+), 1262 deletions(-) diff --git a/reference/tidy/functions/ob-tidyhandler.xml b/reference/tidy/functions/ob-tidyhandler.xml index 1de532f653..ae9aeae1bb 100755 --- a/reference/tidy/functions/ob-tidyhandler.xml +++ b/reference/tidy/functions/ob-tidyhandler.xml @@ -1,27 +1,25 @@ - - - - ob_tidyhandler - - ob_start callback function to repair the buffer - - - - Description - - stringob_tidyhandler - stringinput - intmode - - - ob_tidyhandler is intended to be used as a - callback function for ob_start to repair the buffer. - - - - <function>ob_tidyhandler</function> example - + + + + ob_tidyhandler + ob_start callback function to repair the buffer + + + Description + + stringob_tidyhandler + stringinput + intmode + + + ob_tidyhandler is intended to be used as a + callback function for ob_start to repair the buffer. + + + + <function>ob_tidyhandler</function> example + test'; ?> ]]> - - &example.outputs; - + + &example.outputs; + @@ -43,14 +41,14 @@ echo '

test'; ]]> - - - - - See also ob_start. - - - + + + + + See also ob_start. + + + - - - tidy_access_count - - Returns the Number of Tidy accessibility warnings encountered for specified document - - - - Description - - inttidy_access_count - tidyobject - - - tidy_access_count returns the number of - accessibility warnings found for the specified document. - - - - Due to the design of the TidyLib, you must call - tidy_diagnose before - tidy_access_count or it will return always - 0. You must also need to enable the - accessibility-check option. - - - - - <function>tidy_access_count</function> example - + + + + tidy_access_count + Returns the Number of Tidy accessibility warnings encountered for specified document + + + Description + + inttidy_access_count + tidyobject + + + tidy_access_count returns the number of + accessibility warnings found for the specified document. + + + + Due to the design of the TidyLib, you must call + tidy_diagnose before + tidy_access_count or it will return always + 0. You must also need to enable the + accessibility-check option. + + + + + <function>tidy_access_count</function> example + ]]> - - - - - See also tidy_error_count and - tidy_warning_count. - - - + + + + + See also tidy_error_count and + tidy_warning_count. + + + - - - tidy_clean_repair - - Execute configured cleanup and repair operations on parsed markup - - - - Description - Procedural style: - - booltidy_clean_repair - tidyobject - - Object oriented style: - - booltidy->cleanRepair - - - - This function cleans and repairs the given tidy - object. - - - - <function>tidy_clean_repair</function> example - + + + + tidy_clean_repair + Execute configured cleanup and repair operations on parsed markup + + + Description + Procedural style: + + booltidy_clean_repair + tidyobject + + Object oriented style: + + booltidy->cleanRepair + + + + This function cleans and repairs the given tidy + object. + + + + <function>tidy_clean_repair</function> example + test'; @@ -37,9 +35,9 @@ tidy_clean_repair($tidy); echo $tidy; ?> ]]> - - &example.outputs; - + + &example.outputs; + @@ -51,15 +49,15 @@ echo $tidy; ]]> - - - - - See also tidy_repair_file and - tidy_repair_string. - - - + + + + + See also tidy_repair_file and + tidy_repair_string. + + + - - - tidy_config_count - - Returns the Number of Tidy configuration errors encountered for specified document - - - - Description - - inttidy_config_count - tidyobject - - - tidy_config_count returns the number of errors - encountered in the configuration of the specified tidy - object. - - - - <function>tidy_config_count</function> example - + + + + tidy_config_count + Returns the Number of Tidy configuration errors encountered for specified document + + + Description + + inttidy_config_count + tidyobject + + + tidy_config_count returns the number of errors + encountered in the configuration of the specified tidy + object. + + + + <function>tidy_config_count</function> example + test'; @@ -34,11 +32,11 @@ $tidy = tidy_parse_string($html, $config); echo tidy_config_count($tidy); ?> ]]> - - - - - + + + + + - - - tidy::__construct - - Constructs a new tidy object - - - - Description - - tidytidy::__construct - stringfilename - mixedconfig - stringencoding - booluse_include_path - - - tidy::__construct constructs a new tidy object. - - - If the filename parameter is given, this function - will also read that file and initialize the object with the file, - acting like tidy_parse_file. - - &tidy.conf-enc; - - - <function>tidy::__construct</function> example - + + + + tidy::__construct + Constructs a new tidy object + + + Description + + tidytidy::__construct + stringfilename + mixedconfig + stringencoding + booluse_include_path + + + tidy::__construct constructs a new tidy object. + + + If the filename parameter is given, this function + will also read that file and initialize the object with the file, + acting like tidy_parse_file. + + &tidy.conf-enc; + + + <function>tidy::__construct</function> example + errorBuffer) { ?> ]]> - - &example.outputs; - + + &example.outputs; + is not recognized! line 8 column 14 - Warning: discarding unexpected ]]> - - - - - See also tidy_parse_file and - tidy_parse_string. - - - + + + + + See also tidy_parse_file and + tidy_parse_string. + + + - - - tidy_diagnose - - Run configured diagnostics on parsed and repaired markup - - - - Description - Procedural style: - - booltidy_diagnose - tidyobject - - Object oriented style: - - booltidy->diagnose - - - - tidy_diagnose runs diagnostic tests on the given - tidy object, adding some more information about - the document in the error buffer. - - - &return.success; - - - - <function>tidy_diagnose</function> example - + + + + tidy_diagnose + Run configured diagnostics on parsed and repaired markup + + + Description + Procedural style: + + booltidy_diagnose + tidyobject + + Object oriented style: + + booltidy->diagnose + + + + tidy_diagnose runs diagnostic tests on the given + tidy object, adding some more information about + the document in the error buffer. + + + &return.success; + + + + <function>tidy_diagnose</function> example + ]]> - - &example.outputs; - + + &example.outputs; + isn't allowed in elements line 5 column 1 - Warning: inserting missing 'title' element @@ -65,14 +63,14 @@ Info: Doctype given is "-//W3C//DTD XHTML 1.0 Strict//EN" Info: Document content looks like XHTML 1.0 Strict 2 warnings, 0 errors were found! ]]> - - - - - See also tidy_get_error_buffer. - - - + + + + + See also tidy_get_error_buffer. + + + - - - tidy_error_count - - Returns the Number of Tidy errors encountered for specified document - - - - Description - - inttidy_error_count - tidyobject - - - tidy_error_count returns the number of Tidy errors - encountered for the specified document. - - - - <function>tidy_error_count</function> example - + + + + tidy_error_count + Returns the Number of Tidy errors encountered for specified document + + + Description + + inttidy_error_count + tidyobject + + + tidy_error_count returns the number of Tidy errors + encountered for the specified document. + + + + <function>tidy_error_count</function> example + test @@ -33,9 +31,9 @@ echo tidy_error_count($tidy) . "\n"; //1 echo $tidy->errorBuffer; ?> ]]> - - &example.outputs; - + + &example.outputs; + declaration @@ -45,15 +43,15 @@ line 2 column 1 - Warning: discarding unexpected line 2 column 16 - Warning: discarding unexpected line 1 column 1 - Warning: inserting missing 'title' element ]]> - - - - - See also tidy_access_count and - tidy_warning_count. - - - + + + + + See also tidy_access_count and + tidy_warning_count. + + + - - - tidy_get_body - - Returns a tidyNode Object starting from the <body> tag of the tidy parse tree - - - - Description - Procedural style: - - tidyNodetidy_get_body - tidyobject - - Object oriented style: - - tidyNodetidy->body - - - - This function returns a tidyNode object starting from the <body> - tag of the tidy parse tree. - - - - <function>tidy_get_body</function> example - + + + + tidy_get_body + Returns a tidyNode Object starting from the <body> tag of the tidy parse tree + + + Description + Procedural style: + + tidyNodetidy_get_body + tidyobject + + Object oriented style: + + tidyNodetidy->body + + + + This function returns a tidyNode object starting from the <body> + tag of the tidy parse tree. + + + + <function>tidy_get_body</function> example + value; ?> ]]> - - &example.outputs; - + + &example.outputs; +

paragraph

]]> - - - - ¬e.tidy.ze2; - - See also tidy_get_head and - tidy_get_html. - - - + + + + ¬e.tidy.ze2; + + See also tidy_get_head and + tidy_get_html. + + + - - - tidy_get_config - - Get current Tidy configuration - - - - Description - Procedural style: - - arraytidy_get_config - tidyobject - - Object oriented style: - - arraytidy->getConfig - - - - tidy_get_config returns an array with the - configuration options in use by the given tidy - object. - - - For an explanation about each option, visit &url.tidy.conf;. - - - - <function>tidy_get_config</function> example - + + + + tidy_get_config + Get current Tidy configuration + + + Description + Procedural style: + + arraytidy_get_config + tidyobject + + Object oriented style: + + arraytidy->getConfig + + + + tidy_get_config returns an array with the + configuration options in use by the given tidy + object. + + + For an explanation about each option, visit &url.tidy.conf;. + + + + <function>tidy_get_config</function> example + test

'; @@ -44,9 +42,9 @@ $tidy = tidy_parse_string($html, $config); print_r(tidy_get_config($tidy)); ?> ]]> - - &example.outputs; - + + &example.outputs; + 1 [newline] => 1 [doctype-mode] => 1 - [doctype] => + [doctype] => [repeated-attributes] => 1 - [alt-text] => - [slide-style] => - [error-file] => - [output-file] => - [write-back] => + [alt-text] => + [slide-style] => + [error-file] => + [output-file] => + [write-back] => [markup] => 1 [show-warnings] => 1 - [quiet] => + [quiet] => [indent] => 1 - [hide-endtags] => - [input-xml] => + [hide-endtags] => + [input-xml] => [output-xml] => 1 [output-xhtml] => 1 - [output-html] => - [add-xml-decl] => - [uppercase-tags] => - [uppercase-attributes] => - [bare] => - [clean] => - [logical-emphasis] => - [drop-proprietary-attributes] => - [drop-font-tags] => + [output-html] => + [add-xml-decl] => + [uppercase-tags] => + [uppercase-attributes] => + [bare] => + [clean] => + [logical-emphasis] => + [drop-proprietary-attributes] => + [drop-font-tags] => [drop-empty-paras] => 1 [fix-bad-comments] => 1 - [break-before-br] => - [split] => - [numeric-entities] => - [quote-marks] => + [break-before-br] => + [split] => + [numeric-entities] => + [quote-marks] => [quote-nbsp] => 1 [quote-ampersand] => 1 - [wrap-attributes] => - [wrap-script-literals] => + [wrap-attributes] => + [wrap-script-literals] => [wrap-sections] => 1 [wrap-asp] => 1 [wrap-jste] => 1 [wrap-php] => 1 [fix-backslash] => 1 - [indent-attributes] => - [assume-xml-procins] => - [add-xml-space] => - [enclose-text] => - [enclose-block-text] => - [keep-time] => - [word-2000] => - [tidy-mark] => - [gnu-emacs] => - [gnu-emacs-file] => - [literal-attributes] => - [show-body-only] => + [indent-attributes] => + [assume-xml-procins] => + [add-xml-space] => + [enclose-text] => + [enclose-block-text] => + [keep-time] => + [word-2000] => + [tidy-mark] => + [gnu-emacs] => + [gnu-emacs-file] => + [literal-attributes] => + [show-body-only] => [fix-uri] => 1 [lower-literals] => 1 - [hide-comments] => - [indent-cdata] => + [hide-comments] => + [indent-cdata] => [force-output] => 1 [show-errors] => 6 [ascii-chars] => 1 - [join-classes] => + [join-classes] => [join-styles] => 1 - [escape-cdata] => - [language] => + [escape-cdata] => + [language] => [ncr] => 1 [output-bom] => 2 - [replace-color] => - [css-prefix] => - [new-inline-tags] => - [new-blocklevel-tags] => - [new-empty-tags] => - [new-pre-tags] => + [replace-color] => + [css-prefix] => + [new-inline-tags] => + [new-blocklevel-tags] => + [new-empty-tags] => + [new-pre-tags] => [accessibility-check] => 0 - [vertical-space] => - [punctuation-wrap] => + [vertical-space] => + [punctuation-wrap] => [merge-divs] => 1 ) ]]> - - - - - See also tidy_reset_config and - tidy_save_config. - - - + + + + + See also tidy_reset_config and + tidy_save_config. + + + - - - tidy_get_error_buffer - - Return warnings and errors which occurred parsing the specified document - - - - Description - Procedural style: - - stringtidy_get_error_buffer - tidyobject - - Object oriented style (property): - - tidy - stringerrorBuffer - - - tidy_get_error_buffer returns warnings and errors - which occurred parsing the specified document. - - - - <function>tidy_get_error_buffer</function> example - + + + + tidy_get_error_buffer + Return warnings and errors which occurred parsing the specified document + + + Description + Procedural style: + + stringtidy_get_error_buffer + tidyobject + + Object oriented style (property): + + tidy + stringerrorBuffer + + + tidy_get_error_buffer returns warnings and errors + which occurred parsing the specified document. + + + + <function>tidy_get_error_buffer</function> example + paragraph

'; @@ -38,23 +36,23 @@ echo tidy_get_error_buffer($tidy); echo $tidy->errorBuffer; ?> ]]> - - &example.outputs; - + + &example.outputs; + declaration line 1 column 1 - Warning: inserting missing 'title' element ]]> - - - - - See also tidy_access_count, - tidy_error_count and - tidy_warning_count. - - - + + + + + See also tidy_access_count, + tidy_error_count and + tidy_warning_count. + + + - - - tidy_get_head - - Returns a tidyNode Object starting from the <head> tag of the tidy parse tree - - - - Description - Procedural style: - - tidyNodetidy_get_head - tidyobject - - Object oriented style: - - tidyNodetidy->head - - - - This function returns a tidyNode object starting from the <head> - tag of the tidy parse tree. - - - - <function>tidy_get_head</function> example - + + + + tidy_get_head + Returns a tidyNode Object starting from the <head> tag of the tidy parse tree + + + Description + Procedural style: + + tidyNodetidy_get_head + tidyobject + + Object oriented style: + + tidyNodetidy->head + + + + This function returns a tidyNode object starting from the <head> + tag of the tidy parse tree. + + + + <function>tidy_get_head</function> example + value; ?> ]]> - - &example.outputs; - + + &example.outputs; + test ]]> - - - - ¬e.tidy.ze2; - - See also tidy_get_body and - tidy_get_html. - - - + + + + ¬e.tidy.ze2; + + See also tidy_get_body and + tidy_get_html. + + + - - - tidy_get_html_ver - - Get the Detected HTML version for the specified document - - - - Description - Procedural style: - - inttidy_get_html_ver - tidyobject - - Object oriented style: - - inttidy->getHtmlVer - - - - tidy_get_html_ver returns the detected HTML version - for the specified tidy object. - - - - This function is not yet implemented in the Tidylib itself, so it always - return 0. - - - - + + + + tidy_get_html_ver + Get the Detected HTML version for the specified document + + + Description + Procedural style: + + inttidy_get_html_ver + tidyobject + + Object oriented style: + + inttidy->getHtmlVer + + + + tidy_get_html_ver returns the detected HTML version + for the specified tidy object. + + + + This function is not yet implemented in the Tidylib itself, so it always + return 0. + + + + - - - tidy_get_html - - Returns a tidyNode Object starting from the <html> tag of the tidy parse tree - - - - Description - Procedural style: - - tidyNodetidy_get_html - tidyobject - - Object oriented style: - - tidyNodetidy->html - - - - This function returns a tidyNode object starting from the <html> - tag of the tidy parse tree. - - - - <function>tidy_get_html</function> example - + + + + tidy_get_html + Returns a tidyNode Object starting from the <html> tag of the tidy parse tree + + + Description + Procedural style: + + tidyNodetidy_get_html + tidyobject + + Object oriented style: + + tidyNodetidy->html + + + + This function returns a tidyNode object starting from the <html> + tag of the tidy parse tree. + + + + <function>tidy_get_html</function> example + value; ?> ]]> - - &example.outputs; - + + &example.outputs; + @@ -58,16 +56,16 @@ echo $html->value; ]]> - - - - ¬e.tidy.ze2; - - See also tidy_get_body and - tidy_get_head. - - - + + + + ¬e.tidy.ze2; + + See also tidy_get_body and + tidy_get_head. + + + - - - tidy_get_output - - Return a string representing the parsed tidy markup - - - - Description - - stringtidy_get_output - tidyobject - - - tidy_get_output returns a string with the repaired - html. - - - - <function>tidy_get_output</function> example - + + + + tidy_get_output + Return a string representing the parsed tidy markup + + + Description + + stringtidy_get_output + tidyobject + + + tidy_get_output returns a string with the repaired + html. + + + + <function>tidy_get_output</function> example + CleanRepair(); echo tidy_get_output($tidy); ?> ]]> - - &example.outputs; - + + &example.outputs; + @@ -46,11 +44,11 @@ echo tidy_get_output($tidy); ]]> - - - - - + + + + + - - - tidy_get_release - - Get release date (version) for Tidy library - - - - Description - Procedural style: - - stringtidy_get_release - - - Object oriented style: - - stringtidy->getRelease - - - - This function returns a string with the release date of the Tidy library. - - - + + + + tidy_get_release + Get release date (version) for Tidy library + + + Description + Procedural style: + + stringtidy_get_release + + + Object oriented style: + + stringtidy->getRelease + + + + This function returns a string with the release date of the Tidy library. + + + - - - tidy_get_root - - Returns a tidyNode object representing the root of the tidy parse tree - - - - Description - Procedural style: - - tidyNodetidy_get_root - tidyobject - - Object oriented style: - - tidyNodetidy->root - - - - Returns a tidyNode object representing the root of the tidy parse tree. - - - - dump nodes - + + + + tidy_get_root + Returns a tidyNode object representing the root of the tidy parse tree + + + Description + Procedural style: + + tidyNodetidy_get_root + tidyobject + + Object oriented style: + + tidyNodetidy->root + + + + Returns a tidyNode object representing the root of the tidy parse tree. + + + + dump nodes + ]]> - - &example.outputs; - + + &example.outputs; + - - - + + + - ¬e.tidy.ze2; - - + ¬e.tidy.ze2; + + - - - tidy_get_status - - Get status of specified document - - - - Description - Procedural style: - - inttidy_get_status - tidyobject - - Object oriented style: - - inttidy->getStatus - - - - tidy_get_status returns the status for the specified - tidy object. It returns 0 if no error/warning - was raised, 1 for warnings or accessibility errors, or 2 for errors. - - - - <function>tidy_get_status</function> example - + + + + tidy_get_status + Get status of specified document + + + Description + Procedural style: + + inttidy_get_status + tidyobject + + Object oriented style: + + inttidy->getStatus + + + + tidy_get_status returns the status for the specified + tidy object. It returns 0 if no error/warning + was raised, 1 for warnings or accessibility errors, or 2 for errors. + + + + <function>tidy_get_status</function> example + paragraph'; @@ -41,11 +39,11 @@ echo tidy_get_status($tidy); //1 echo tidy_get_status($tidy2); //2 ?> ]]> - - - - - + + + + + - - - tidy_getopt - - Returns the value of the specified configuration option for the tidy document - - - - Description - Procedural style: - - mixedtidy_getopt - tidyobject - stringoption - - Object oriented style: - - mixedtidy->getOpt - stringoption - - - tidy_getopt returns the value of the specified - option for the specified tidy - object. The return type depends on the type - of the specified option. You will find a list with - each configuration option and their types at: &url.tidy.conf;. - - - - <function>tidy_getopt</function> example - + + + + tidy_getopt + Returns the value of the specified configuration option for the tidy document + + + Description + Procedural style: + + mixedtidy_getopt + tidyobject + stringoption + + Object oriented style: + + mixedtidy->getOpt + stringoption + + + tidy_getopt returns the value of the specified + option for the specified tidy + object. The return type depends on the type + of the specified option. You will find a list with + each configuration option and their types at: &url.tidy.conf;. + + + + <function>tidy_getopt</function> example + getOpt('alt-text')); //string ?> ]]> - - &example.outputs; - + + &example.outputs; + - - - - - + + + + + - - - tidy_is_xhtml - - Indicates if the document is a XHTML document - - - - Description - Procedural style: - - booltidy_is_xhtml - tidyobject - - Object oriented style: - - booltidy->isXhtml - - - - This function returns &true; if the specified tidy - object is a XHTML document, or &false; otherwise. - - - - This function is not yet implemented in the Tidylib itself, so it always - return &false;. - - - - + + + + tidy_is_xhtml + Indicates if the document is a XHTML document + + + Description + Procedural style: + + booltidy_is_xhtml + tidyobject + + Object oriented style: + + booltidy->isXhtml + + + + This function returns &true; if the specified tidy + object is a XHTML document, or &false; otherwise. + + + + This function is not yet implemented in the Tidylib itself, so it always + return &false;. + + + + - - - tidy_is_xml - - Indicates if the document is a generic (non HTML/XHTML) XML document - - - - Description - Procedural style: - - booltidy_is_xml - tidyobject - - Object oriented style: - - booltidy->isXml - - - - This function returns &true; if the specified tidy - object is a generic XML document (non HTML/XHTML), - or &false; otherwise. - - - - This function is not yet implemented in the Tidylib itself, so it always - return &false;. - - - - + + + + tidy_is_xml + Indicates if the document is a generic (non HTML/XHTML) XML document + + + Description + Procedural style: + + booltidy_is_xml + tidyobject + + Object oriented style: + + booltidy->isXml + + + + This function returns &true; if the specified tidy + object is a generic XML document (non HTML/XHTML), + or &false; otherwise. + + + + This function is not yet implemented in the Tidylib itself, so it always + return &false;. + + + + - - - tidy_load_config - - Load an ASCII Tidy configuration file with the specified encoding - - - - Description - - voidtidy_load_config - stringfilename - stringencoding - - - This function loads a Tidy configuration file, with the specified - encoding. - - ¬e.tidy.1only; - - + + + + tidy_load_config + Load an ASCII Tidy configuration file with the specified encoding + + + Description + + voidtidy_load_config + stringfilename + stringencoding + + + This function loads a Tidy configuration file, with the specified + encoding. + + ¬e.tidy.1only; + + - - - tidy_node->get_attr - - Return the attribute with the provided attribute id - - - - Description - - tidy_attrtidy_node->get_attr - intattrib_id - + + + + tidy_node->get_attr + Return the attribute with the provided attribute id + + + Description + + tidy_attrtidy_node->get_attr + intattrib_id + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - tidy_node->get_nodes - - Return an array of nodes under this node with the specified id - - - - Description - - arraytidy_node->get_nodes - intnode_id - + + + + tidy_node->get_nodes + Return an array of nodes under this node with the specified id + + + Description + + arraytidy_node->get_nodes + intnode_id + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - tidy_node->next - - Returns the next sibling to this node - - - - Description - - tidy_nodetidy_node->next - - + + + + tidy_node->next + Returns the next sibling to this node + + + Description + + tidy_nodetidy_node->next + + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - tidy_node->prev - - Returns the previous sibling to this node - - - - Description - - tidy_nodetidy_node->prev - - + + + + tidy_node->prev + Returns the previous sibling to this node + + + Description + + tidy_nodetidy_node->prev + + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - tidy_parse_file - - Parse markup in file or URI - - - - Description - Procedural style: - - tidytidy_parse_file - stringfilename - mixedconfig - stringencoding - booluse_include_path - - Object oriented style: - - booltidy->parseFile - stringfilename - mixedconfig - stringencoding - booluse_include_path - - - This function parses the given file. - - &tidy.conf-enc; - - - <function>tidy_parse_file</function> example - + + + + tidy_parse_file + Parse markup in file or URI + + + Description + Procedural style: + + tidytidy_parse_file + stringfilename + mixedconfig + stringencoding + booluse_include_path + + Object oriented style: + + booltidy->parseFile + stringfilename + mixedconfig + stringencoding + booluse_include_path + + + This function parses the given file. + + &tidy.conf-enc; + + + <function>tidy_parse_file</function> example + cleanRepair(); - + if(!empty($tidy->errorBuffer)) { echo "The following errors or warnings occured:\n"; echo $tidy->errorBuffer; } ?> ]]> - - - - ¬e.tidy.2only; - - See also tidy_parse_string, - tidy_repair_file and - tidy_repair_string. - - - + + + + ¬e.tidy.2only; + + See also tidy_parse_string, + tidy_repair_file and + tidy_repair_string. + + + - - - tidy_parse_string - - Parse a document stored in a string - - - - Description - Procedural style: - - tidytidy_parse_string - stringinput - mixedconfig - stringencoding - - Object oriented style: - - booltidy->parseString - stringinput - mixedconfig - stringencoding - - - tidy_parse_string parses a document stored in a - string. - - &tidy.conf-enc; - - - <function>tidy_parse_string</function> example - + + + + tidy_parse_string + Parse a document stored in a string + + + Description + Procedural style: + + tidytidy_parse_string + stringinput + mixedconfig + stringencoding + + Object oriented style: + + booltidy->parseString + stringinput + mixedconfig + stringencoding + + + tidy_parse_string parses a document stored in a + string. + + &tidy.conf-enc; + + + <function>tidy_parse_string</function> example + cleanRepair(); echo $tidy; ?> ]]> - - &example.outputs; - + + &example.outputs; + @@ -79,17 +77,17 @@ echo $tidy; ]]> - - - - ¬e.tidy.2only; - - See also tidy_parse_file, - tidy_repair_file and - tidy_repair_string. - - - + + + + ¬e.tidy.2only; + + See also tidy_parse_file, + tidy_repair_file and + tidy_repair_string. + + + - - - tidy_repair_file - - Repair a file and return it as a string - - - - Description - - stringtidy_repair_file - stringfilename - mixedconfig - stringencoding - booluse_include_path - - - This function repairs the given file and returns it as a string. - - &tidy.conf-enc; - - - <function>tidy_repair_file</function> example - + + + + tidy_repair_file + Repair a file and return it as a string + + + Description + + stringtidy_repair_file + stringfilename + mixedconfig + stringencoding + booluse_include_path + + + This function repairs the given file and returns it as a string. + + &tidy.conf-enc; + + + <function>tidy_repair_file</function> example + ]]> - - - - ¬e.tidy.2only; - - See also tidy_parse_file, - tidy_parse_string and - tidy_repair_string. - - - + + + + ¬e.tidy.2only; + + See also tidy_parse_file, + tidy_parse_string and + tidy_repair_string. + + + - - - tidy_repair_string - - Repair a string using an optionally provided configuration file - - - - Description - - stringtidy_repair_string - stringdata - mixedconfig - stringencoding - - - This function repairs the given string. - - &tidy.conf-enc; - - - <function>tidy_repair_string</function> example - + + + + tidy_repair_string + Repair a string using an optionally provided configuration file + + + Description + + stringtidy_repair_string + stringdata + mixedconfig + stringencoding + + + This function repairs the given string. + + &tidy.conf-enc; + + + <function>tidy_repair_string</function> example + ]]> - - &example.outputs; - + + &example.outputs; + @@ -59,17 +57,17 @@ echo $tidy; ]]> - - - - ¬e.tidy.2only; - - See also tidy_parse_file, - tidy_parse_string and - tidy_repair_file. - - - + + + + ¬e.tidy.2only; + + See also tidy_parse_file, + tidy_parse_string and + tidy_repair_file. + + + - - - tidy_reset_config - - Restore Tidy configuration to default values - - - - Description - - booltidy_reset_config - - - - This function restores the Tidy configuration to the default values. - - ¬e.tidy.1only; - - + + + + tidy_reset_config + Restore Tidy configuration to default values + + + Description + + booltidy_reset_config + + + + This function restores the Tidy configuration to the default values. + + ¬e.tidy.1only; + + - - - tidy_save_config - - Save current settings to named file - - - - Description - - booltidy_save_config - stringfilename - - - tidy_save_config saves current settings to the - specified file. Only non-default values are written. - - - See also tidy_get_config, - tidy_getopt, - tidy_reset_config and - tidy_setopt. - - ¬e.tidy.1only; - - + + + + tidy_save_config + Save current settings to named file + + + Description + + booltidy_save_config + stringfilename + + + tidy_save_config saves current settings to the + specified file. Only non-default values are written. + + + See also tidy_get_config, + tidy_getopt, + tidy_reset_config and + tidy_setopt. + + ¬e.tidy.1only; + + - - - tidy_set_encoding - - Set the input/output character encoding for parsing markup - - - - Description - - booltidy_set_encoding - stringencoding - - - Sets the encoding for input/output documents. &return.success; - Possible values for encoding are - ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16, - utf16le, utf16be, big5 and shiftjis - - ¬e.tidy.1only; - - + + + + tidy_set_encoding + Set the input/output character encoding for parsing markup + + + Description + + booltidy_set_encoding + stringencoding + + + Sets the encoding for input/output documents. &return.success; + Possible values for encoding are + ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16, + utf16le, utf16be, big5 and shiftjis + + ¬e.tidy.1only; + + - - - tidy_setopt - - Updates the configuration settings for the specified tidy document - - - - Description - - booltidy_setopt - stringoption - mixedvalue - - - tidy_setopt updates the specified - option with a new value. - You will find a list with each configuration option at: &url.tidy.conf;. - - - - <function>tidy_setopt</function> example - + + + + tidy_setopt + Updates the configuration settings for the specified tidy document + + + Description + + booltidy_setopt + stringoption + mixedvalue + + + tidy_setopt updates the specified + option with a new value. + You will find a list with each configuration option at: &url.tidy.conf;. + + + + <function>tidy_setopt</function> example + test'; @@ -33,18 +31,18 @@ $tidy = tidy_parse_string($html); tidy_setopt('indent', FALSE); ?> ]]> - - - - - See also tidy_getopt, - tidy_get_config, - tidy_reset_config and - tidy_save_config. - - ¬e.tidy.1only; - - + + + + + See also tidy_getopt, + tidy_get_config, + tidy_reset_config and + tidy_save_config. + + ¬e.tidy.1only; + + - - - tidy_warning_count - - Returns the Number of Tidy warnings encountered for specified document - - - - Description - - inttidy_warning_count - tidyobject - - - tidy_warning_count returns the number of Tidy warnings - encountered for the specified document. - - - - <function>tidy_warning_count</function> example - + + + + tidy_warning_count + Returns the Number of Tidy warnings encountered for specified document + + + Description + + inttidy_warning_count + tidyobject + + + tidy_warning_count returns the number of Tidy warnings + encountered for the specified document. + + + + <function>tidy_warning_count</function> example + test @@ -32,15 +30,15 @@ echo tidy_error_count($tidy) . "\n"; //1 echo tidy_warning_count($tidy) . "\n"; //5 ?> ]]> - - - - - See also tidy_access_count and - tidy_error_count. - - - + + + + + See also tidy_access_count and + tidy_error_count. + + + + tidyNode->hasChildren - - Returns true if this node has children - + Returns true if this node has children Description diff --git a/reference/tidy/functions/tidyNode-hasSiblings.xml b/reference/tidy/functions/tidyNode-hasSiblings.xml index 4b69bc4564..d6394c8979 100644 --- a/reference/tidy/functions/tidyNode-hasSiblings.xml +++ b/reference/tidy/functions/tidyNode-hasSiblings.xml @@ -1,11 +1,9 @@ - + tidyNode->hasSiblings - - Returns true if this node has siblings - + Returns true if this node has siblings Description diff --git a/reference/tidy/functions/tidyNode-isAsp.xml b/reference/tidy/functions/tidyNode-isAsp.xml index b66e18aab2..fae9b87513 100755 --- a/reference/tidy/functions/tidyNode-isAsp.xml +++ b/reference/tidy/functions/tidyNode-isAsp.xml @@ -1,30 +1,28 @@ - - - - tidyNode->isAsp - - Returns true if this node is ASP - - - - Description - - booltidyNode->isAsp - - - - This functions returns &true; if the current node is ASP, or &false; - otherwise. - - - - This function was named tidy_node->is_asp in - PHP 4/Tidy 1. - - - - + + + + tidyNode->isAsp + Returns true if this node is ASP + + + Description + + booltidyNode->isAsp + + + + This functions returns &true; if the current node is ASP, or &false; + otherwise. + + + + This function was named tidy_node->is_asp in + PHP 4/Tidy 1. + + + + + tidyNode->isComment - - Returns true if this node represents a comment - + Returns true if this node represents a comment Description diff --git a/reference/tidy/functions/tidyNode-isHtml.xml b/reference/tidy/functions/tidyNode-isHtml.xml index b670f715dc..204ed807c5 100644 --- a/reference/tidy/functions/tidyNode-isHtml.xml +++ b/reference/tidy/functions/tidyNode-isHtml.xml @@ -1,11 +1,9 @@ - + tidyNode->isHtml - - Returns true if this node is part of a HTML document - + Returns true if this node is part of a HTML document Description diff --git a/reference/tidy/functions/tidyNode-isJste.xml b/reference/tidy/functions/tidyNode-isJste.xml index 2d3b8733aa..427150b352 100644 --- a/reference/tidy/functions/tidyNode-isJste.xml +++ b/reference/tidy/functions/tidyNode-isJste.xml @@ -1,11 +1,9 @@ - + tidyNode->isJste - - Returns true if this node is JSTE - + Returns true if this node is JSTE Description diff --git a/reference/tidy/functions/tidyNode-isPhp.xml b/reference/tidy/functions/tidyNode-isPhp.xml index 96e46c0554..d5b48474bb 100644 --- a/reference/tidy/functions/tidyNode-isPhp.xml +++ b/reference/tidy/functions/tidyNode-isPhp.xml @@ -1,25 +1,23 @@ - - - - tidyNode->isPhp - - Returns true if this node is PHP - - - - Description - - booltidyNode->isPhp - - - - Returns &true; if the current node is PHP code, &false; otherwise. - - - - get the PHP code from a mixed HTML/PHP document - + + + + tidyNode->isPhp + Returns true if this node is PHP + + + Description + + booltidyNode->isPhp + + + + Returns &true; if the current node is PHP code, &false; otherwise. + + + + get the PHP code from a mixed HTML/PHP document + ]]> - - &example.outputs; - + + &example.outputs; + title'; ?> @@ -73,17 +71,17 @@ function get_php($node) { echo 'hello world!'; ?> ]]> - - - - - - This function was named tidy_node->is_php in - PHP 4/Tidy 1. - - - - + + + + + + This function was named tidy_node->is_php in + PHP 4/Tidy 1. + + + + + tidyNode->isText - - Returns true if this node represents text (no markup) - + Returns true if this node represents text (no markup) Description