diff --git a/reference/tidy/constants.xml b/reference/tidy/constants.xml index 19e9685f0b..1516cbf179 100644 --- a/reference/tidy/constants.xml +++ b/reference/tidy/constants.xml @@ -1,8 +1,13 @@ - +
&reftitle.constants; &extension.constants; + + Each TIDY_TAG_XXX represents a HTML tag. For example, + TIDY_TAG_A represents a <a + href="XX">link</a> tag. + The following constants are defined: @@ -11,587 +16,356 @@ constant - description TIDY_TAG_UNKNOWN - - TIDY_TAG_A - - TIDY_TAG_ABBR - - TIDY_TAG_ACRONYM - - TIDY_TAG_ALIGN - - TIDY_TAG_APPLET - - TIDY_TAG_AREA - - TIDY_TAG_B - - TIDY_TAG_BASE - - TIDY_TAG_BASEFONT - - TIDY_TAG_BDO - - TIDY_TAG_BGSOUND - - TIDY_TAG_BIG - - TIDY_TAG_BLINK - - TIDY_TAG_BLOCKQUOTE - - TIDY_TAG_BODY - - TIDY_TAG_BR - TIDY_TAG_BUTTON - - TIDY_TAG_CAPTION - - TIDY_TAG_CENTER - - TIDY_TAG_CITE - - TIDY_TAG_CODE - - TIDY_TAG_COL - - TIDY_TAG_COLGROUP - - TIDY_TAG_COMMENT - - TIDY_TAG_DD - - TIDY_TAG_DEL - - TIDY_TAG_DFN - - TIDY_TAG_DIR - TIDY_TAG_DIV - - TIDY_TAG_DL - - TIDY_TAG_DT - - TIDY_TAG_EM - - TIDY_TAG_EMBED - - TIDY_TAG_FIELDSET - - TIDY_TAG_FONT - - TIDY_TAG_FORM - - TIDY_TAG_FRAME - - TIDY_TAG_FRAMESET - - TIDY_TAG_H1 - - TIDY_TAG_H2 - - TIDY_TAG_H3 - - TIDY_TAG_H4 - - TIDY_TAG_H5 - - TIDY_TAG_6 - - TIDY_TAG_HEAD - - TIDY_TAG_HR - - TIDY_TAG_HTML - - TIDY_TAG_I - - TIDY_TAG_IFRAME - - TIDY_TAG_ILAYER - - TIDY_TAG_IMG - - TIDY_TAG_INPUT - - TIDY_TAG_INS - - TIDY_TAG_ISINDEX - - TIDY_TAG_KBD - - TIDY_TAG_KEYGEN - - TIDY_TAG_LABEL - - TIDY_TAG_LAYER - - TIDY_TAG_LEGEND - - TIDY_TAG_LI - - TIDY_TAG_LINK - - TIDY_TAG_LISTING - - TIDY_TAG_MAP - - TIDY_TAG_MARQUEE - - TIDY_TAG_MENU - - TIDY_TAG_META - - TIDY_TAG_MULTICOL - - TIDY_TAG_NOBR - - TIDY_TAG_NOEMBED - - TIDY_TAG_NOFRAMES - - TIDY_TAG_NOLAYER - - TIDY_TAG_NOSAFE - - TIDY_TAG_NOSCRIPT - - TIDY_TAG_OBJECT - - TIDY_TAG_OL - - TIDY_TAG_OPTGROUP - - TIDY_TAG_OPTION - - TIDY_TAG_P - - TIDY_TAG_PARAM - - TIDY_TAG_PLAINTEXT - - TIDY_TAG_PRE - - TIDY_TAG_Q - - TIDY_TAG_RP - - TIDY_TAG_RT - - TIDY_TAG_RTC - - TIDY_TAG_RUBY - - TIDY_TAG_S - - TIDY_TAG_SAMP - - TIDY_TAG_SCRIPT - - TIDY_TAG_SELECT - - TIDY_TAG_SERVER - - TIDY_TAG_SERVLET - - TIDY_TAG_SMALL - - TIDY_TAG_SPACER - - TIDY_TAG_SPAN - - TIDY_TAG_STRIKE - - TIDY_TAG_STRONG - - TIDY_TAG_STYLE - - TIDY_TAG_SUB - - TIDY_TAG_TABLE - - TIDY_TAG_TBODY - - TIDY_TAG_TD - - TIDY_TAG_TEXTAREA - - TIDY_TAG_TFOOT - - TIDY_TAG_TH - - TIDY_TAG_THEAD - - TIDY_TAG_TITLE - - TIDY_TAG_TR - - TIDY_TAG_TR - - TIDY_TAG_TT - - TIDY_TAG_U - - TIDY_TAG_UL - - TIDY_TAG_VAR - - TIDY_TAG_WBR - - TIDY_TAG_XMP - - diff --git a/reference/tidy/functions/tidy-is-xhtml.xml b/reference/tidy/functions/tidy-is-xhtml.xml index ab63a824e2..d52610f2fb 100644 --- a/reference/tidy/functions/tidy-is-xhtml.xml +++ b/reference/tidy/functions/tidy-is-xhtml.xml @@ -1,5 +1,5 @@ - + tidy_is_xhtml @@ -9,13 +9,26 @@ Description + Procedural style: booltidy_is_xhtml resourcetidy - - &warn.undocumented.func; - + Object oriented style: + + objecttidy->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;. + + diff --git a/reference/tidy/functions/tidy-is-xml.xml b/reference/tidy/functions/tidy-is-xml.xml index cff15fda5b..74bf108f3f 100755 --- a/reference/tidy/functions/tidy-is-xml.xml +++ b/reference/tidy/functions/tidy-is-xml.xml @@ -1,5 +1,5 @@ - + tidy_is_xml @@ -9,13 +9,26 @@ Description + Procedural style: booltidy_is_xml resourcetidy - - &warn.undocumented.func; - + Object oriented style: + + objecttidy->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;. + + diff --git a/reference/tidy/functions/tidy-load-config.xml b/reference/tidy/functions/tidy-load-config.xml index fa9d39ff8b..f20fcc6af4 100644 --- a/reference/tidy/functions/tidy-load-config.xml +++ b/reference/tidy/functions/tidy-load-config.xml @@ -1,5 +1,5 @@ - + tidy_load_config @@ -14,7 +14,10 @@ stringfilename stringencoding - &warn.undocumented.func; + + This function loads a Tidy configuration file, with the specified + encoding. + ¬e.tidy.1only; diff --git a/reference/tidy/functions/tidy-parse-file.xml b/reference/tidy/functions/tidy-parse-file.xml index 47ce0d857e..e049ee206b 100644 --- a/reference/tidy/functions/tidy-parse-file.xml +++ b/reference/tidy/functions/tidy-parse-file.xml @@ -1,5 +1,5 @@ - + tidy_parse_file @@ -9,6 +9,7 @@ Description + Procedural style: resourcetidy_parse_file stringfilename @@ -16,6 +17,14 @@ stringencoding booluse_include_path + Object oriented style: + + booltidy->parseFile + stringfilename + mixedconfig + stringencoding + booluse_include_path + This function parses the given file. @@ -30,9 +39,9 @@ $tidy = tidy_parse_file('file.html'); $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; } ?> ]]> diff --git a/reference/tidy/functions/tidy-parse-string.xml b/reference/tidy/functions/tidy-parse-string.xml index ff48fe5d7f..181f77ecd6 100644 --- a/reference/tidy/functions/tidy-parse-string.xml +++ b/reference/tidy/functions/tidy-parse-string.xml @@ -1,5 +1,5 @@ - + tidy_parse_string @@ -9,12 +9,20 @@ Description + Procedural style: resourcetidy_parse_string stringinput mixedconfig stringencoding + Object oriented style: + + booltidy->parseString + stringinput + mixedconfig + stringencoding + tidy_parse_string parses a document stored in a string. diff --git a/reference/tidy/functions/tidy-reset-config.xml b/reference/tidy/functions/tidy-reset-config.xml index 80246fa32f..faf2d1df84 100644 --- a/reference/tidy/functions/tidy-reset-config.xml +++ b/reference/tidy/functions/tidy-reset-config.xml @@ -1,5 +1,5 @@ - + tidy_reset_config @@ -13,7 +13,9 @@ booltidy_reset_config - &warn.undocumented.func; + + This function restores the Tidy configuration to the default values. + ¬e.tidy.1only;