diff --git a/documentation/quickref.xsl b/documentation/quickref.xsl index 260902b..73e308a 100644 --- a/documentation/quickref.xsl +++ b/documentation/quickref.xsl @@ -31,7 +31,7 @@
xml:space=\"preserve\"
to elements such as "
- "<PRE>
, <STYLE>
and "
- "<SCRIPT>
when generating XML. "
+ "<pre>
, <style>
and "
+ "<script>
when generating XML. "
"alt=
text Tidy uses for "
- "<IMG>
attributes. "
+ "<img>
attributes. "
"omit
the output won't contain a DOCTYPE declaration. "
+ "If set to omit
the output won't contain a DOCTYPE "
+ "declaration. Note this this also implies numeric-entities
is "
+ "set to yes
"
"html5
the DOCTYPE is set to <!DOCTYPE html>
."
+ "If set to html5
the DOCTYPE is set to "
+ "<!DOCTYPE html>
."
"auto
(the default) Tidy will use an educated guess "
"based upon the contents of the document."
@@ -462,9 +465,9 @@ static const TidyOptionDoc option_docs[] =
"system identifier to an empty string. For an HTML document, Tidy adds a "
"system identifier only if one was already present in order to preserve "
"the processing mode of some browsers. Tidy leaves the DOCTYPE for "
- "generic XML documents unchanged. --doctype omit
implies "
- "--numeric-entities yes
. This option does not offer a "
- "validation of the document conformance. "
+ "generic XML documents unchanged. "
+ "<P>
"
+ "This option specifies if Tidy should insert a <p>
"
"element to enclose any text it finds in any element that allows mixed "
"content for HTML transitional but not HTML strict. "
},
{TidyEncloseBodyText,
"This option specifies if Tidy should enclose any text it finds in the "
- "body element within a <P>
element."
+ "body element within a <p>
element."
"omit-optional-tags
. "
},
{TidyIndentCdata,
"This option specifies if Tidy should indent "
@@ -564,12 +567,12 @@ static const TidyOptionDoc option_docs[] =
},
{TidyJoinClasses,
"This option specifies if Tidy should combine class names to generate "
- "a single new class name if multiple class assignments are detected on "
+ "a single, new class name if multiple class assignments are detected on "
"an element. "
, TidyJoinClassesLinks
},
{TidyJoinStyles,
- "This option specifies if Tidy should combine styles to generate a single "
+ "This option specifies if Tidy should combine styles to generate a single, "
"new style if multiple style values are detected on an element. "
, TidyJoinStylesLinks
},
@@ -671,7 +674,7 @@ static const TidyOptionDoc option_docs[] =
"Unless you declare new tags, Tidy will refuse to generate a tidied file if "
"the input includes previously unknown tags. "
"alpha
, the "
"algorithm is an ascending alphabetic sort. "
},
@@ -815,14 +818,22 @@ static const TidyOptionDoc option_docs[] =
"indent
to yes
can expose layout bugs in "
"some browsers. "
+ "indent-spaces
to control the number of spaces "
+ "or tabs output per level of indent, and indent-with-tabs
to "
+ "specify whether spaces or tabs are used. "
+
,TidyIndentContentLinks
},
{TidyIndentAttributes,
"This option specifies if Tidy should begin each attribute on a new line. "
},
{TidyIndentSpaces,
- "This option specifies the number of spaces Tidy uses to indent content, "
- "when indentation is enabled. "
+ "This option specifies the number of spaces or tabs that Tidy uses to "
+ "indent content when indent
is enabled. "
+ "indent-with-tabs
(see also). "
,TidyIndentSpacesLinks
},
{TidyLiteralAttribs,
@@ -855,8 +866,6 @@ static const TidyOptionDoc option_docs[] =
"This option specifies the number of columns that Tidy uses between "
"successive tab stops. It is used to map tabs to spaces when reading the "
"input. "
- "no
. "
"auto
' Tidy will eliminate nearly all newline "
+ "If set to auto
Tidy will eliminate nearly all newline "
"characters."
},
{TidyWrapLen,
@@ -898,89 +907,116 @@ static const TidyOptionDoc option_docs[] =
},
{TidyWrapJste,
"This option specifies if Tidy should line wrap text contained within "
- "JSTE pseudo elements, which look like: <# ... #>. "
+ "JSTE pseudo elements, which look like: <# ... #>
. "
},
{TidyWrapPhp,
"This option specifies if Tidy should line wrap text contained within PHP "
- "pseudo elements, which look like: <?php ... ?>. "
+ "pseudo elements, which look like: <?php ... ?>
. "
},
{TidyWrapScriptlets,
"This option specifies if Tidy should line wrap string literals that "
- "appear in script attributes. Tidy wraps long script string literals by "
- "inserting a backslash character before the line break. "
+ "appear in script attributes. "
+ "<![ ... ]>
section tags. "
},
{TidyAsciiChars,
- "Can be used to modify behavior of -c (--clean yes) option. If set "
- "to \"yes\" when using -c, &emdash;, ”, and other named "
- "character entities are downgraded to their closest ascii equivalents. "
+ "Can be used to modify behavior of the clean
option when set "
+ "to yes
. "
+ "yes
when clean
, "
+ "&emdash;
, ”
, and other named "
+ "character entities are downgraded to their closest ASCII equivalents. "
,TidyAsciiCharsLinks
},
{TidyCharEncoding,
"This option specifies the character encoding Tidy uses for both the input "
- "and output. For ascii, Tidy will accept Latin-1 (ISO-8859-1) character "
- "values, but will use entities for all characters whose value > 127. "
- "For raw, Tidy will output values above 127 without translating them into "
- "entities. For latin1, characters above 255 will be written as entities. "
- "For utf8, Tidy assumes that both input and output is encoded as UTF-8. "
- "You can use iso2022 for files encoded using the ISO-2022 family of "
- "encodings e.g. ISO-2022-JP. For mac and win1252, Tidy will accept vendor "
+ "and output. "
+ "ascii
Tidy will accept Latin-1 (ISO-8859-1) character "
+ "values, but will use entities for all characters whose value >127. "
+ "raw
, Tidy will output values above 127 without "
+ "translating them into entities. "
+ "latin1
, characters above 255 will be written as entities. "
+ "utf8
, Tidy assumes that both input and output are encoded "
+ "as UTF-8. "
+ "iso2022
for files encoded using the ISO-2022 "
+ "family of encodings e.g. ISO-2022-JP. "
+ "mac
and win1252
, Tidy will accept vendor "
"specific character values, but will use entities for all characters whose "
- "value > 127. "
+ "value >127. "
+ "char-encoding
for more info. "
,TidyInCharEncodingLinks
},
#if SUPPORT_ASIAN_ENCODINGS
{TidyLanguage,
- "Currently not used, but this option specifies the language Tidy uses "
- "(for instance \"en\"). "
+ "Currently not used, but this option specifies the language Tidy would use "
+ "if it were properly localized. For example: en
. "
},
#endif
#if SUPPORT_UTF16_ENCODINGS
{TidyOutputBOM,
"This option specifies if Tidy should write a Unicode Byte Order Mark "
"character (BOM; also known as Zero Width No-Break Space; has value of "
- "U+FEFF) to the beginning of the output; only for UTF-8 and UTF-16 output "
- "encodings. If set to \"auto\", this option causes Tidy to write a BOM to "
- "the output only if a BOM was present at the beginning of the input. A BOM "
- "is always written for XML/XHTML output using UTF-16 output encodings. "
+ "U+FEFF) to the beginning of the output, and only applies to UTF-8 and "
+ "UTF-16 output encodings. "
+ "auto
this option causes Tidy to write a BOM to "
+ "the output only if a BOM was present at the beginning of the input. "
+ "input-encoding
for "
+ "Latin encodings (ascii
, latin0
, "
+ "latin1
, mac
, win1252
, "
+ "ibm858
)."
+ "char-encoding
for more information"
,TidyOutCharEncodingLinks
},
{TidyNewline,
- "The default is appropriate to the current platform: CRLF on PC-DOS, "
- "MS-Windows and OS/2, CR on Classic Mac OS, and LF everywhere else "
- "(Unix and Linux). "
+ "The default is appropriate to the current platform. "
+ "stderr
. "
,TidyErrFileLinks
},
{TidyFixBackslash,
"This option specifies if Tidy should replace backslash characters "
- "\"\\
\" in URLs by forward slashes \"/
\". "
+ "\\
in URLs with forward slashes /
. "
},
{TidyForceOutput,
"This option specifies if Tidy should produce output even if errors are "
- "encountered. Use this option with care - if Tidy reports an error, this "
- "means Tidy was not able to, or is not sure how to, fix the error, so the "
+ "encountered. "
+ "yes
allows you to tidy files without "
+ "changing the file modification date, which may be useful with certain "
+ "tools that use the modification date for things such as automatic server "
+ "deployment."
+ "stdout
. "
,TidyOutFileLinks
},
{TidyQuiet,
@@ -1007,46 +1047,59 @@ static const TidyOptionDoc option_docs[] =
"of errors and warnings, or the welcome or informational messages. "
},
{TidySlideStyle,
- "Currently not used. Tidy Classic only. "
+ "This option has no function and is deprecated. "
},
{TidyMark,
- "This option specifies if Tidy should add a meta element to the document "
- "head to indicate that the document has been tidied. Tidy won't add a meta "
- "element if one is already present. "
+ "This option specifies if Tidy should add a meta
element to "
+ "the document head to indicate that the document has been tidied. "
+ "<ul>
elements with some CSS markup to avoid indentation "
+ "to the right. "
},
{TidyPreserveEntities,
- "This option specifies if Tidy should preserve the well-formed entities "
+ "This option specifies if Tidy should preserve well-formed entities "
"as found in the input. "
},
{TidyAnchorAsName,
- "This option controls the deletion or addition of the name attribute "
- "in elements where it can serve as anchor. "
- "If set to \"yes\", a name attribute, if not already existing, "
- "is added along an existing id attribute if the DTD allows it. "
- "If set to \"no\", any existing name attribute is removed "
- "if an id attribute exists or has been added. "
+ "This option controls the deletion or addition of the name
"
+ "attribute in elements where it can serve as anchor. "
+ "yes
a name
attribute, if not already "
+ "existing, is added along an existing id
attribute if the DTD "
+ "allows it. "
+ "no
any existing name attribute is removed if an"
+ "id
attribute exists or has been added. "
},
{TidyPPrintTabs,
- "Set this option \"on\" to indent using tabs instead of the default "
- "spaces. The option TidyIndentSpaces controls the number of tabs output "
- "per level of indent, which is reset to 1, when this option is set on. "
- "And of course, indent must be enabled for this to have any effect. "
- "Note TidyTabSize controls converting input tabs to spaces. Set to zero "
- "to retain input tabs. "
+ "This option specifies if Tidy should indent with tabs instead of spaces, "
+ "assuming indent
is yes
. "
+ "yes
to indent using tabs instead of the default "
+ "spaces. "
+ "indent-spaces
to control the number of tabs "
+ "output per level of indent. Note that when indent-with-tabs
"
+ "is enabled the default value of indent-spaces
is reset to "
+ "1
. "
+ "tab-size
controls converting input tabs to spaces. Set "
+ "it to zero to retain input tabs. "
},
{TidySkipQuotes,
- "This option specifies that Tidy should skip quotes, and comments "
- "when parsing script data. "
+ "This option specifies that Tidy should skip nested tags when parsing "
+ "script and style data. "
},
{N_TIDY_OPTIONS,
NULL