From 2613f02dc5866308fffd4ca7be43d848fad27d24 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Sat, 31 Oct 2015 22:03:33 +0800 Subject: [PATCH] More documentation beautification. --- src/localize.c | 171 +++++++++++++++++++++++++++++++------------------ 1 file changed, 109 insertions(+), 62 deletions(-) diff --git a/src/localize.c b/src/localize.c index 5469c50..0f8783c 100755 --- a/src/localize.c +++ b/src/localize.c @@ -426,7 +426,7 @@ static const TidyOptionDoc option_docs[] = "presentational tags (currently <i>, " "<b>, <center> when enclosed within " "appropriate inline tags, and <font>). If set to " - "YES then legacy tags will be replaced with CSS " + "yes then legacy tags will be replaced with CSS " "<style> tags and structural markup as appropriate. " , }, @@ -453,7 +453,7 @@ static const TidyOptionDoc option_docs[] = "
" "Alternatively, you can supply a string for the formal public identifier " "(FPI)." - "
" + "
" "For example: " "
" "doctype: \"-//ACME//DTD HTML 3.14159//EN\"" @@ -491,31 +491,36 @@ static const TidyOptionDoc option_docs[] = }, {TidyDropPropAttrs, "This option specifies if Tidy should strip out proprietary attributes, " - "such as MS data binding attributes. " + "such as Microsoft data binding attributes. " }, {TidyEncloseBlockText, - "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. " + "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. This is useful when you want to " - "take existing HTML and use it with a style sheet. " + "body element within a <P> element." + "
" + "This is useful when you want to take existing HTML and use it with a " + "style sheet. " }, {TidyEscapeCdata, - "This option specifies if Tidy should convert <![CDATA[]]> " - "sections to normal text. " + "This option specifies if Tidy should convert " + "<![CDATA[]]> sections to normal text. " }, {TidyFixComments, "This option specifies if Tidy should replace unexpected hyphens with " - "\"=\" characters when it comes across adjacent hyphens. The default is " - "yes. This option is provided for users of Cold Fusion which uses the " - "comment syntax: <!--- ---> " + "= characters when it comes across adjacent hyphens. " + "
" + "The default is yes. " + "
" + "This option is provided for users of Cold Fusion which uses the " + "comment syntax: <!--- --->. " }, {TidyFixUri, "This option specifies if Tidy should check attribute values that carry " - "URIs for illegal characters and if such are found, escape them as HTML 4 " + "URIs for illegal characters and if such are found, escape them as HTML4 " "recommends. " }, {TidyHideComments, @@ -524,22 +529,34 @@ static const TidyOptionDoc option_docs[] = {TidyCoerceEndTags, "This option specifies if Tidy should coerce a start tag into an end tag " "in cases where it looks like an end tag was probably intended; " - "for example, given <span>foo <b>bar<b> baz</span>, " - "Tidy will output <span>foo <b>bar</b> baz</span>. " + "for example, given " + "
" + "<span>foo <b>bar<b> baz</span> " + "
" + "Tidy will output " + "
" + "<span>foo <b>bar</b> baz</span> " }, {TidyOmitOptionalTags, "This option specifies if Tidy should omit optional start tags and end tags " - "when generating output. Setting this option causes all tags for the " - "html, head, and body elements to be omitted from output, as well as such " - "end tags as </p>, </li>, </dt>, </dd>, " - "</option>, </tr>, </td>, and </th>. " + "when generating output. " + "
" + "Setting this option causes all tags for the <html>, " + "<head>, and <body> elements to be " + "omitted from output, as well as such end tags as </p>, " + "</li>, </dt>, " + "</dd>, </option>, " + "</tr>, </td>, and " + "</th>. " + "
" "This option is ignored for XML output. " }, {TidyHideEndTags, "This option is an alias for omit-optional-tags. " }, {TidyIndentCdata, - "This option specifies if Tidy should indent <![CDATA[]]> sections. " + "This option specifies if Tidy should indent " + "<![CDATA[]]> sections. " }, {TidyXmlTags, "This option specifies if Tidy should use the XML parser rather than the " @@ -547,47 +564,62 @@ 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 " - "new style, if multiple style values are detected on an element. " + "new style if multiple style values are detected on an element. " , TidyJoinStylesLinks }, {TidyLogicalEmphasis, - "This option specifies if Tidy should replace any occurrence of <I> " - "by <EM> and any occurrence of <B> by <STRONG>. In both " - "cases, the attributes are preserved unchanged. This option can be set " - "independently of the clean and drop-font-tags options. " + "This option specifies if Tidy should replace any occurrence of " + "<i> with <em> and any occurrence of " + "<b> with <strong>. Any attributes " + "are preserved unchanged. " + "
" + "This option can be set independently of the clean option. " }, {TidyLowerLiterals, "This option specifies if Tidy should convert the value of an attribute " - "that takes a list of predefined values to lower case. This is required " - "for XHTML documents. " + "that takes a list of predefined values to lower case. " + "
" + "This is required for XHTML documents. " }, {TidyMergeEmphasis, - "This option specifies if Tidy should merge nested <b> and <i> " - "elements; for example, for the case " - "<b class=\"rtop-2\">foo <b class=\"r2-2\">bar</b> baz</b>, " - "Tidy will output <b class=\"rtop-2\">foo bar baz</b>. " + "This option specifies if Tidy should merge nested <b> " + "and <i> elements; for example, for the case " + "
" + "<b class=\"rtop-2\">foo <b class=\"r2-2\">bar</b> baz</b>, " + "
" + "Tidy will output <b class=\"rtop-2\">foo bar baz</b>. " }, {TidyMergeDivs, - "Can be used to modify behavior of -c (--clean yes) option. " - "This option specifies if Tidy should merge nested <div> such as " - "\"<div><div>...</div></div>\". If set to " - "\"auto\", the attributes of the inner <div> are moved to the " - "outer one. As well, nested <div> with ID attributes are not " - "merged. If set to \"yes\", the attributes of the inner <div> " - "are discarded with the exception of \"class\" and \"style\". " + "This option can be used to modify the behavior of clean when " + "set to yes." + "
" + "This option specifies if Tidy should merge nested <div> " + "such as <div><div>...</div></div>. " + "
" + "If set to auto the attributes of the inner " + "<div> are moved to the outer one. Nested " + "<div> with id attributes are not " + "merged. " + "
" + "If set to yes the attributes of the inner " + "<div> are discarded with the exception of " + "class and style. " ,TidyMergeDivsLinks }, {TidyMergeSpans, - "Can be used to modify behavior of -c (--clean yes) option. " - "This option specifies if Tidy should merge nested <span> such as " - "\"<span><span>...</span></span>\". The algorithm " - "is identical to the one used by --merge-divs. " + "This option can be used to modify the behavior of clean when " + "set to yes." + "
" + "This option specifies if Tidy should merge nested <span> " + "such as <span><span>...</span></span>. " + "
" + "The algorithm is identical to the one used by merge-divs. " ,TidyMergeSpansLinks }, #if SUPPORT_ASIAN_ENCODINGS @@ -597,35 +629,50 @@ static const TidyOptionDoc option_docs[] = #endif {TidyBlockTags, "This option specifies new block-level tags. This option takes a space or " - "comma separated list of tag names. Unless you declare new tags, Tidy will " - "refuse to generate a tidied file if the input includes previously unknown " - "tags. Note you can't change the content model for elements such as " - "<TABLE>, <UL>, <OL> and <DL>. This option is " - "ignored in XML mode. " + "comma separated list of tag names. " + "
" + "Unless you declare new tags, Tidy will refuse to generate a tidied file if " + "the input includes previously unknown tags. " + "
" + "Note you can't change the content model for elements such as " + "<table>, <ul>, " + "<ol> and <dl>. " + "
" + "This option is ignored in XML mode. " ,TidyBlockTagsLinks }, {TidyEmptyTags, "This option specifies new empty inline tags. This option takes a space " - "or comma separated list of tag names. Unless you declare new tags, Tidy " - "will refuse to generate a tidied file if the input includes previously " - "unknown tags. Remember to also declare empty tags as either inline or " - "blocklevel. This option is ignored in XML mode. " + "or comma separated list of tag names. " + "
" + "Unless you declare new tags, Tidy will refuse to generate a tidied file if " + "the input includes previously unknown tags. " + "
" + "Remember to also declare empty tags as either inline or blocklevel. " + "
" + "This option is ignored in XML mode. " ,TidyEmptyTagsLinks }, {TidyInlineTags, "This option specifies new non-empty inline tags. This option takes a " - "space or comma separated list of tag names. Unless you declare new tags, " - "Tidy will refuse to generate a tidied file if the input includes " - "previously unknown tags. This option is ignored in XML mode. " + "space or comma separated list of tag names. " + "
" + "Unless you declare new tags, Tidy will refuse to generate a tidied file if " + "the input includes previously unknown tags. " + "
" + "This option is ignored in XML mode. " ,TidyInlineTagsLinks }, { TidyPreTags, - "This option specifies " - "new tags that are to be processed in exactly the same way as HTML's " - "<PRE> element. This option takes a space or comma separated list " - "of tag names. Unless you declare new tags, Tidy will refuse to generate " - "a tidied file if the input includes previously unknown tags. Note you " - "can not as yet add new CDATA elements (similar to <SCRIPT>). " + "This option specifies new tags that are to be processed in exactly the " + "same way as HTML's <pre> element. This option takes a " + "space or comma separated list of tag names. " + "
" + "Unless you declare new tags, Tidy will refuse to generate a tidied file if " + "the input includes previously unknown tags. " + "
" + "Note you can not as yet add new CDATA elements. " + "
" "This option is ignored in XML mode. " ,TidyPreTagsLinks },