Documentation improvements.
This commit is contained in:
parent
678a2a20d1
commit
807fed4ff6
|
@ -678,10 +678,14 @@ static const TidyOptionDoc option_docs[] =
|
||||||
},
|
},
|
||||||
{TidyNumEntities,
|
{TidyNumEntities,
|
||||||
"This option specifies if Tidy should output entities other than the "
|
"This option specifies if Tidy should output entities other than the "
|
||||||
"built-in HTML entities (&, <, > and ") in "
|
"built-in HTML entities (<code>&amp;</code>, <code>&lt;</code>, "
|
||||||
"the numeric rather than the named entity form. Only entities compatible "
|
"<code>&gt;</code>, and <code>&quot;</code>) in the numeric rather "
|
||||||
"with the DOCTYPE declaration generated are used. Entities that can be "
|
"than the named entity form. "
|
||||||
"represented in the output encoding are translated correspondingly. "
|
"<br/>"
|
||||||
|
"Only entities compatible with the DOCTYPE declaration generated are used. "
|
||||||
|
"<br/>"
|
||||||
|
"Entities that can be represented in the output encoding are translated "
|
||||||
|
"correspondingly. "
|
||||||
,TidyNumEntitiesLinks
|
,TidyNumEntitiesLinks
|
||||||
},
|
},
|
||||||
{TidyHtmlOut,
|
{TidyHtmlOut,
|
||||||
|
@ -691,30 +695,38 @@ static const TidyOptionDoc option_docs[] =
|
||||||
{TidyXhtmlOut,
|
{TidyXhtmlOut,
|
||||||
"This option specifies if Tidy should generate pretty printed output, "
|
"This option specifies if Tidy should generate pretty printed output, "
|
||||||
"writing it as extensible HTML. "
|
"writing it as extensible HTML. "
|
||||||
|
"<br/>"
|
||||||
"This option causes Tidy to set the DOCTYPE and default namespace as "
|
"This option causes Tidy to set the DOCTYPE and default namespace as "
|
||||||
"appropriate to XHTML. If a DOCTYPE or namespace is given they will "
|
"appropriate to XHTML, and will use the corrected value in output "
|
||||||
"checked for consistency with the content of the document. In the case of "
|
"regardless of other sources. "
|
||||||
"an inconsistency, the corrected values will appear in the output. For "
|
"<br/>"
|
||||||
"XHTML, entities can be written as named or numeric entities according to "
|
"For XHTML, entities can be written as named or numeric entities according "
|
||||||
"the setting of the \"numeric-entities\" option. The original case of tags "
|
"to the setting of <code>numeric-entities</code>. "
|
||||||
"and attributes will be preserved, regardless of other options. "
|
"<br/>"
|
||||||
|
"The original case of tags and attributes will be preserved, regardless of "
|
||||||
|
"other options. "
|
||||||
},
|
},
|
||||||
{TidyXmlOut,
|
{TidyXmlOut,
|
||||||
"This option specifies if Tidy should pretty print output, writing it as "
|
"This option specifies if Tidy should pretty print output, writing it as "
|
||||||
"well-formed XML. Any entities not defined in XML 1.0 will be written as "
|
"well-formed XML. "
|
||||||
"numeric entities to allow them to be parsed by a XML parser. The original "
|
"<br/>"
|
||||||
"case of tags and attributes will be preserved, regardless of other "
|
"Any entities not defined in XML 1.0 will be written as numeric entities to "
|
||||||
"options. "
|
"allow them to be parsed by an XML parser. "
|
||||||
|
"<br/>"
|
||||||
|
"The original case of tags and attributes will be preserved, regardless of "
|
||||||
|
"other options. "
|
||||||
},
|
},
|
||||||
{TidyQuoteAmpersand,
|
{TidyQuoteAmpersand,
|
||||||
"This option specifies if Tidy should output unadorned & characters as "
|
"This option specifies if Tidy should output unadorned <code>&</code> "
|
||||||
"&amp;. "
|
"characters as <code>&amp;</code>. "
|
||||||
},
|
},
|
||||||
{TidyQuoteMarks,
|
{TidyQuoteMarks,
|
||||||
"This option specifies if Tidy should output " characters as "
|
"This option specifies if Tidy should output <code>"</code> characters "
|
||||||
"&quot; as is preferred by some editing environments. The apostrophe "
|
"as <code>&quot;</code> as is preferred by some editing environments. "
|
||||||
"character ' is written out as &#39; since many web browsers don't yet "
|
"<br/>"
|
||||||
"support &apos;. "
|
"The apostrophe character <code>'</code> is written out as "
|
||||||
|
"<code>&#39;</code> since many web browsers don't yet support "
|
||||||
|
"<code>&apos;</code>. "
|
||||||
},
|
},
|
||||||
{TidyQuoteNbsp,
|
{TidyQuoteNbsp,
|
||||||
"This option specifies if Tidy should output non-breaking space characters "
|
"This option specifies if Tidy should output non-breaking space characters "
|
||||||
|
@ -722,24 +734,29 @@ static const TidyOptionDoc option_docs[] =
|
||||||
},
|
},
|
||||||
{TidyDuplicateAttrs,
|
{TidyDuplicateAttrs,
|
||||||
"This option specifies if Tidy should keep the first or last attribute, if "
|
"This option specifies if Tidy should keep the first or last attribute, if "
|
||||||
"an attribute is repeated, e.g. has two align attributes. "
|
"an attribute is repeated, e.g. has two <code>align</code> attributes. "
|
||||||
, TidyDuplicateAttrsLinks
|
, TidyDuplicateAttrsLinks
|
||||||
},
|
},
|
||||||
{TidySortAttributes,
|
{TidySortAttributes,
|
||||||
"This option specifies that tidy should sort attributes within an element "
|
"This option specifies that tidy should sort attributes within an element "
|
||||||
"using the specified sort algorithm. If set to \"alpha\", the algorithm is "
|
"using the specified sort algorithm. If set to <code>alpha</code>, the "
|
||||||
"an ascending alphabetic sort. "
|
"algorithm is an ascending alphabetic sort. "
|
||||||
},
|
},
|
||||||
{TidyReplaceColor,
|
{TidyReplaceColor,
|
||||||
"This option specifies if Tidy should replace numeric values in color "
|
"This option specifies if Tidy should replace numeric values in color "
|
||||||
"attributes by HTML/XHTML color names where defined, e.g. replace "
|
"attributes with HTML/XHTML color names where defined, e.g. replace "
|
||||||
"\"#ffffff\" with \"white\". "
|
"<code>#ffffff</code> with <code>white</code>. "
|
||||||
},
|
},
|
||||||
{TidyBodyOnly,
|
{TidyBodyOnly,
|
||||||
"This option specifies if Tidy should print only the contents of the "
|
"This option specifies if Tidy should print only the contents of the "
|
||||||
"body tag as an HTML fragment. If set to \"auto\", this is performed only "
|
"body tag as an HTML fragment. "
|
||||||
"if the body tag has been inferred. Useful for incorporating "
|
"<br/>"
|
||||||
"existing whole pages as a portion of another page. "
|
"If set to <code>auto</code>, this is performed only if the body tag has "
|
||||||
|
"been inferred. "
|
||||||
|
"<br/>"
|
||||||
|
"Useful for incorporating existing whole pages as a portion of another "
|
||||||
|
"page. "
|
||||||
|
"<br/>"
|
||||||
"This option has no effect if XML output is requested. "
|
"This option has no effect if XML output is requested. "
|
||||||
},
|
},
|
||||||
{TidyUpperCaseAttrs,
|
{TidyUpperCaseAttrs,
|
||||||
|
|
Loading…
Reference in a new issue