More description beautification.

This commit is contained in:
Jim Derry 2015-11-02 12:06:37 +08:00
parent af97d6a8cd
commit d0ac990636

View file

@ -761,30 +761,37 @@ static const TidyOptionDoc option_docs[] =
}, },
{TidyUpperCaseAttrs, {TidyUpperCaseAttrs,
"This option specifies if Tidy should output attribute names in upper " "This option specifies if Tidy should output attribute names in upper "
"case. The default is no, which results in lower case attribute names, " "case. "
"except for XML input, where the original case is preserved. " "<br/>"
"The default is <code>no</code>, which results in lower case attribute "
"names, except for XML input, where the original case is preserved. "
}, },
{TidyUpperCaseTags, {TidyUpperCaseTags,
"This option specifies if Tidy should output tag names in upper case. " "This option specifies if Tidy should output tag names in upper case. "
"The default is no, which results in lower case tag names, except for XML " "<br/>"
"input, where the original case is preserved. " "The default is <code>no</code> which results in lower case tag names, "
"except for XML input where the original case is preserved. "
}, },
{TidyWord2000, {TidyWord2000,
"This option specifies if Tidy should go to great pains to strip out all " "This option specifies if Tidy should go to great pains to strip out all "
"the surplus stuff Microsoft Word 2000 inserts when you save Word " "the surplus stuff Microsoft Word 2000 inserts when you save Word "
"documents as \"Web pages\". Doesn't handle embedded images or VML. " "documents as \"Web pages\". It doesn't handle embedded images or VML. "
"<br/>"
"You should consider using Word's \"Save As: Web Page, Filtered\". " "You should consider using Word's \"Save As: Web Page, Filtered\". "
}, },
{TidyAccessibilityCheckLevel, {TidyAccessibilityCheckLevel,
"This option specifies what level of accessibility checking, if any, " "This option specifies what level of accessibility checking, if any, "
"that Tidy should do. Level 0 is equivalent to Tidy Classic's " "that Tidy should perform. "
"accessibility checking. " "<br/>"
"Level <code>0 (Tidy Classic)</code> is equivalent to Tidy Classic's accessibility "
"checking. "
"<br/>"
"For more information on Tidy's accessibility checking, visit " "For more information on Tidy's accessibility checking, visit "
"<a href=\"" ATRC_ACCESS_URL "\"> Tidy's Accessibility Page</a>. " "<a href=\"" ATRC_ACCESS_URL "\"> Tidy's Accessibility Page</a>. "
}, },
{TidyShowErrors, {TidyShowErrors,
"This option specifies the number Tidy uses to determine if further errors " "This option specifies the number Tidy uses to determine if further errors "
"should be shown. If set to 0, then no errors are shown. " "should be shown. If set to <code>0</code>, then no errors are shown. "
}, },
{TidyShowInfo, {TidyShowInfo,
"This option specifies if Tidy should display info-level messages. " "This option specifies if Tidy should display info-level messages. "
@ -795,14 +802,18 @@ static const TidyOptionDoc option_docs[] =
}, },
{TidyBreakBeforeBR, {TidyBreakBeforeBR,
"This option specifies if Tidy should output a line break before each " "This option specifies if Tidy should output a line break before each "
"&lt;BR&gt; element. " "<code>&lt;br&gt;</code> element. "
}, },
{TidyIndentContent, {TidyIndentContent,
"This option specifies if Tidy should indent block-level tags. If set to " "This option specifies if Tidy should indent block-level tags. "
"\"auto\", this option causes Tidy to decide whether or not to indent the " "<br/>"
"content of tags such as TITLE, H1-H6, LI, TD, TD, or P depending on " "If set to <code>auto</code> Tidy will decide whether or not to indent the "
"whether or not the content includes a block-level element. You are " "content of tags such as <code>&lt;title&gt;</code>, "
"advised to avoid setting indent to yes as this can expose layout bugs in " "<code>&lt;h1&gt;</code>-<code>&lt;h6&gt;</code>, <code>&lt;li&gt;</code>, "
"<code>&lt;td&gt;</code>, or <code>&lt;p&gt;</code> "
"based on the content including a block-level element. "
"<br/>"
"Setting <code>indent</code> to <code>yes</code> can expose layout bugs in "
"some browsers. " "some browsers. "
,TidyIndentContentLinks ,TidyIndentContentLinks
}, },
@ -816,18 +827,20 @@ static const TidyOptionDoc option_docs[] =
}, },
{TidyLiteralAttribs, {TidyLiteralAttribs,
"This option specifies how Tidy deals with whitespace characters within " "This option specifies how Tidy deals with whitespace characters within "
"attribute values. If the value is \"no\" (the default), Tidy \"munges\" " "attribute values. "
"or \"normalizes\" attribute values by replacing any newline or tab " "<br/>"
"character with a single space character, and further by replacing " "If the value is <code>no</code> Tidy normalizes attribute values by "
"any sequences of multiple whitespace characters with a single space. " "replacing any newline or tab with a single space, and further by replacing "
"To force tidy to preserve the original, literal values of all attributes, " "any contiguous whitespace with a single space. "
"and ensure that whitespace characters within attribute values are passed " "<br/>"
"through unchanged, set this option to \"yes\". " "To force Tidy to preserve the original, literal values of all attributes "
"and ensure that whitespace within attribute values is passed "
"through unchanged, set this option to <code>yes</code>. "
}, },
{TidyShowMarkup, {TidyShowMarkup,
"This option specifies if Tidy should generate a pretty printed version " "This option specifies if Tidy should generate a pretty printed version "
"of the markup. Note that Tidy won't generate a pretty printed version if " "of the markup. Note that Tidy won't generate a pretty printed version if "
"it finds significant errors (see force-output). " "it finds significant errors (see <code>force-output</code>). "
}, },
#if SUPPORT_ASIAN_ENCODINGS #if SUPPORT_ASIAN_ENCODINGS
{TidyPunctWrap, {TidyPunctWrap,
@ -836,40 +849,51 @@ static const TidyOptionDoc option_docs[] =
}, },
#endif #endif
{TidyBurstSlides, {TidyBurstSlides,
"Currently not used. Tidy Classic only. " "This option has no function and is deprecated. "
}, },
{TidyTabSize, {TidyTabSize,
"This option specifies the number of columns that Tidy uses between " "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 " "successive tab stops. It is used to map tabs to spaces when reading the "
"input. " "input. "
"<br/>"
"Tidy never outputs tabs."
}, },
{TidyVertSpace, /* Issue #228 - changed to tri-state */ {TidyVertSpace, /* Issue #228 - changed to tri-state */
"This option specifies if Tidy should add some extra empty lines for " "This option specifies if Tidy should add some extra empty lines for "
"readability. Default is 'no'. If set to 'auto', will eliminate nearly " "readability. "
"all newline chars." "<br/>"
"The default is <code>no</code>. "
"<br/>"
"If set to <code>auto</code>' Tidy will eliminate nearly all newline "
"characters."
}, },
{TidyWrapLen, {TidyWrapLen,
"This option specifies the right margin Tidy uses for line wrapping. Tidy " "This option specifies the right margin Tidy uses for line wrapping. "
"tries to wrap lines so that they do not exceed this length. Set wrap to " "<br/>"
"zero if you want to disable line wrapping. " "Tidy tries to wrap lines so that they do not exceed this length. "
"<br/>"
"Set <code>wrap</code> to <code>0</code>(zero) if you want to disable line "
"wrapping. "
}, },
{TidyWrapAsp, {TidyWrapAsp,
"This option specifies if Tidy should line wrap text contained within ASP " "This option specifies if Tidy should line wrap text contained within ASP "
"pseudo elements, which look like: &lt;% ... %&gt;. " "pseudo elements, which look like: <code>&lt;% ... %&gt;</code>. "
}, },
{TidyWrapAttVals, {TidyWrapAttVals,
"This option specifies if Tidy should line-wrap attribute values, for " "This option specifies if Tidy should line-wrap attribute values, meaning "
"easier editing. Line wrapping means that if the value of an attribute " "that if the value of an attribute causes a line to exceed the width "
"causes a line to exceed the width specified by the \"wrap\" option, " "specified by <code>wrap</code>, Tidy will add one or more line breaks to "
"tidy will add one or more line breaks to the value, causing it to " "the value, causing it to be wrapped into multiple lines. "
"wrapped into multiple lines. Note that this option can be set " "<br/>"
"independently of wrap-script-literals. Also note that by default, Tidy " "Note that this option can be set independently of "
"\"munges\" or \"normalizes\" attribute values by replacing any newline " "<code>wrap-script-literals</code>. "
"or tab character with a single space character, and further by replacing " "By default Tidy replaces any newline or tab with a single space and "
"any sequences of multiple whitespace characters with a single space. " "replaces any sequences of whitespace with a single space. "
"<br/>"
"To force Tidy to preserve the original, literal values of all attributes, " "To force Tidy to preserve the original, literal values of all attributes, "
"and ensure that whitespace characters within attribute values are passed " "and ensure that whitespace characters within attribute values are passed "
"through unchanged, set the literal-attributes option to \"yes\". " "through unchanged, set <code>literal-attributes</code> to "
"<code>yes</code>. "
,TidyWrapAttValsLinks ,TidyWrapAttValsLinks
}, },
{TidyWrapJste, {TidyWrapJste,