emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Documentation beautification underway.

Browse source
This commit is contained in:
Jim Derry 2015-10-31 18:30:02 +08:00
parent e0f42bcaba
commit 565d2ec232
1 changed files with 53 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
src/localize.c
View file

@ -379,29 +379,37 @@ static const TidyOptionDoc option_docs[] =
{ {
{TidyXmlDecl, {TidyXmlDecl,
"This option specifies if Tidy should add the XML declaration when " "This option specifies if Tidy should add the XML declaration when "
"outputting XML or XHTML. Note that if the input already includes an " "outputting XML or XHTML. "
"&lt;?xml ... ?&gt; declaration then this option will be ignored. " "<br/>"
"If the encoding for the output is different from \"ascii\", one of the " "Note that if the input already includes an <code>&lt;?xml ... ?&gt;</code> "
"utf encodings or \"raw\", the declaration is always added as required by " "declaration then this option will be ignored. "
"the XML standard. " "<br/>"
"If the encoding for the output is different from <code>ascii</code>, one "
"of the utf encodings or <code>raw</code>, the declaration is always added "
"as required by the XML standard. "
, TidyXmlDeclLinks , TidyXmlDeclLinks
}, },
{TidyXmlSpace, {TidyXmlSpace,
"This option specifies if Tidy should add xml:space=\"preserve\" to " "This option specifies if Tidy should add "
"elements such as &lt;PRE&gt;, &lt;STYLE&gt; and &lt;SCRIPT&gt; when " "<code>xml:space=\"preserve\"</code> to elements such as "
"generating XML. This is needed if the whitespace in such elements is to " "<code>&lt;PRE&gt;</code>, <code>&lt;STYLE&gt;</code> and "
"<code>&lt;SCRIPT&gt;</code> when generating XML. "
"<br/>"
"This is needed if the whitespace in such elements is to "
"be parsed appropriately without having access to the DTD. " "be parsed appropriately without having access to the DTD. "
}, },
{TidyAltText, {TidyAltText,
"This option specifies the default \"alt=\" text Tidy uses for " "This option specifies the default <code>alt=</code> text Tidy uses for "
"&lt;IMG&gt; attributes. This feature is dangerous as it suppresses " "<code>&lt;IMG&gt;</code> attributes. "
"further accessibility warnings. You are responsible for making your " "<br/>"
"documents accessible to people who can not see the images! " "Use with care, as this feature suppresses further accessibility warnings. "
}, },
{TidyXmlPIs, {TidyXmlPIs,
"This option specifies if Tidy should change the parsing of processing " "This option specifies if Tidy should change the parsing of processing "
"instructions to require ?&gt; as the terminator rather than &gt;. This " "instructions to require <code>?&gt;</code> as the terminator rather than "
"option is automatically set if the input is in XML. " "<code>&gt;</code>. "
"<br/>"
"This option is automatically set if the input is in XML. "
}, },
{TidyMakeBare, {TidyMakeBare,
"This option specifies if Tidy should strip Microsoft specific HTML " "This option specifies if Tidy should strip Microsoft specific HTML "
@ -409,39 +417,47 @@ static const TidyOptionDoc option_docs[] =
"spaces where they exist in the input. " "spaces where they exist in the input. "
}, },
{TidyCSSPrefix, {TidyCSSPrefix,
"This option specifies the prefix that Tidy uses for styles rules. By " "This option specifies the prefix that Tidy uses for styles rules. "
"default, \"c\" will be used. " "<br/>"
"By default, <code>c</code> will be used. "
}, },
{TidyMakeClean, {TidyMakeClean,
"This option specifies if Tidy " "This option specifies if Tidy should perform cleaning of some legacy "
"should perform cleaning of some legacy presentational tags (currently " "presentational tags (currently <code>&lt;i&gt;</code>, "
"&lt;i&gt;, &lt;b&gt;, &lt;center&gt; when enclosed within appropriate " "<code>&lt;b&gt;</code>, <code>&lt;center&gt;</code> when enclosed within "
"inline tags, and &lt;font&gt;). If set then legacy tags will be replaced " "appropriate inline tags, and <code>&lt;font&gt;</code>). If set to "
"with CSS &lt;style&gt; tags and structural markup as appropriate. " "<code>YES</code> then legacy tags will be replaced with CSS "
"<code>&lt;style&gt;</code> tags and structural markup as appropriate. "
, ,
}, },
{TidyGDocClean, {TidyGDocClean,
"This option specifies if Tidy " "This option specifies if Tidy should enable specific behavior for "
"should enable specific behavior for cleaning up HTML exported from " "cleaning up HTML exported from Google Docs. "
"Google Docs. "
, ,
}, },
{TidyDoctype, {TidyDoctype,
"This option specifies the DOCTYPE declaration generated by Tidy.<br />" "This option specifies the DOCTYPE declaration generated by Tidy. "
"If set to \"omit\" the output won't contain a DOCTYPE declaration.<br />" "<br/>"
"If set to \"html5\" the DOCTYPE is set to \"&lt;!DOCTYPE html>\".<br />" "If set to <code>omit</code> the output won't contain a DOCTYPE declaration. "
"If set to \"auto\" (the default) Tidy will use an educated guess based " "<br/>"
"upon the contents of the document.<br />" "If set to <code>html5</code> the DOCTYPE is set to <code>&lt;!DOCTYPE html&gt;</code>."
"If set to \"strict\", Tidy will set the DOCTYPE to the HTML4 or XHTML1 " "<br/>"
"strict DTD.<br />" "If set to <code>auto</code> (the default) Tidy will use an educated guess "
"If set to \"loose\", the DOCTYPE is set to the HTML4 or XHTML1 loose " "based upon the contents of the document."
"(transitional) DTD. <br />" "<br/>"
"If set to <code>strict</code>, Tidy will set the DOCTYPE to the HTML4 or "
"XHTML1 strict DTD."
"<br/>"
"If set to <code>loose</code>, the DOCTYPE is set to the HTML4 or XHTML1 "
"loose (transitional) DTD."
"<br/>"
"Alternatively, you can supply a string for the formal public identifier " "Alternatively, you can supply a string for the formal public identifier "
"(FPI).<br />" "(FPI)."
"<br />"
"For example: <br />"
"doctype: \"-//ACME//DTD HTML 3.14159//EN\"<br />"
"<br />" "<br />"
"For example: "
"<br/>"
"<code>doctype: \"-//ACME//DTD HTML 3.14159//EN\"</code>"
"<br/>"
"If you specify the FPI for an XHTML document, Tidy will set the " "If you specify the FPI for an XHTML document, Tidy will set the "
"system identifier to an empty string. For an HTML document, Tidy adds a " "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 " "system identifier only if one was already present in order to preserve "