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

Touch up option descriptions, particularly the encoding options in order to better describe their interaction.

Browse source
This commit is contained in:
Jim Derry 2017-10-26 14:25:02 -04:00
parent aec686b1a9
commit 056bd85d3d
1 changed files with 79 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

123
src/language_en.h
View file

@ -197,29 +197,26 @@ static languageDefinition language_en = { whichPluralForm_en, {
- The strings "Tidy" and "HTML Tidy" are the program name and must not - The strings "Tidy" and "HTML Tidy" are the program name and must not
be translated. */ be translated. */
TidyCharEncoding, 0, TidyCharEncoding, 0,
"This option specifies the character encoding Tidy uses for both the input " "This option specifies the character encoding Tidy uses for input, and "
"and output. " "when set, automatically chooses an appropriate character encoding to "
"be used for output. The output encoding Tidy chooses may be different "
"from the input encoding. "
"<br/>" "<br/>"
"For <var>ascii</var> Tidy will accept Latin-1 (ISO-8859-1) character " "For <var>ascii</var>, <var>latin0</var>, <var>ibm858</var>, "
"values, but will use entities for all characters whose value &gt;127. " "<var>mac</var>, and <var>win1252</var> input encodings, the "
"<code>output-encoding</code> option will automatically be set to "
"<var>ascii</var>. You can set <code>output-encoding</code> manually "
"to override this. "
"<br/>" "<br/>"
"For <var>raw</var>, Tidy will output values above 127 without " "For other input encodings, the <code>output-encoding</code> option "
"translating them into entities. " "will automatically be set to the the same value. "
"<br/>" "<br/>"
"For <var>latin1</var>, characters above 255 will be written as entities. " "Regardless of the preset value, you can set "
"<code>output-encoding</code> manually to override this. "
"<br/>" "<br/>"
"For <var>utf8</var>, Tidy assumes that both input and output are encoded " "Tidy is not an encoding converter. Although the Latin and UTF "
"as UTF-8. " "encodings can be mixed freely, it is not possible to convert Asian "
"<br/>" "encodings to Latin encodings with Tidy. "
"You can use <var>iso2022</var> for files encoded using the ISO-2022 "
"family of encodings e.g. ISO-2022-JP. "
"<br/>"
"For <var>mac</var> and <var>win1252</var>, Tidy will accept vendor "
"specific character values, but will use entities for all characters whose "
"value &gt;127. "
"<br/>"
"For unsupported encodings, use an external utility to convert to and from "
"UTF-8. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@ -559,8 +556,25 @@ static languageDefinition language_en = { whichPluralForm_en, {
- The strings "Tidy" and "HTML Tidy" are the program name and must not - The strings "Tidy" and "HTML Tidy" are the program name and must not
be translated. */ be translated. */
TidyInCharEncoding, 0, TidyInCharEncoding, 0,
"This option specifies the character encoding Tidy uses for the input. See " "This option specifies the character encoding Tidy uses for input. "
"<code>char-encoding</code> for more info. " "Tidy makes certain assumptions about some of the input encodings. "
"<br/>"
"For <var>ascii</var>, Tidy will accept Latin-1 (ISO-8859-1) character "
"values and convert them to entities as necessary. "
"<br/>"
"For <var>raw</var>, Tidy will make no assumptions about the character "
"values and will pass them unchanged to output. "
"<br/>"
"For <var>mac</var> and <var>win1252</var>, vendor specific characters "
"values will be accepted and converted to entities as necessary. "
"<br/>"
"Asian encodings such as <var>iso2022</var> will be handled "
"appropriately assuming the corresponding <code>output-encoding</code> "
"is also specified. "
"<br/>"
"Tidy is not an encoding converter. Although the Latin and UTF "
"encodings can be mixed freely, it is not possible to convert Asian "
"encodings to Latin encodings with Tidy. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@ -759,9 +773,9 @@ static languageDefinition language_en = { whichPluralForm_en, {
TidyMakeClean, 0, TidyMakeClean, 0,
"This option specifies if Tidy should perform cleaning of some legacy " "This option specifies if Tidy should perform cleaning of some legacy "
"presentational tags (currently <code>&lt;i&gt;</code>, " "presentational tags (currently <code>&lt;i&gt;</code>, "
"<code>&lt;b&gt;</code>, <code>&lt;center&gt;</code> when enclosed within " "<code>&lt;b&gt;</code>, <code>&lt;center&gt;</code> when enclosed "
"appropriate inline tags, and <code>&lt;font&gt;</code>). If set to " "within appropriate inline tags, and <code>&lt;font&gt;</code>). If "
"<var>yes</var> then legacy tags will be replaced with CSS " "set to <var>yes</var>, then the legacy tags will be replaced with CSS "
"<code>&lt;style&gt;</code> tags and structural markup as appropriate. " "<code>&lt;style&gt;</code> tags and structural markup as appropriate. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
@ -857,8 +871,9 @@ static languageDefinition language_en = { whichPluralForm_en, {
TidyNewline, 0, TidyNewline, 0,
"The default is appropriate to the current platform. " "The default is appropriate to the current platform. "
"<br/>" "<br/>"
"Genrally CRLF on PC-DOS, Windows and OS/2; CR on Classic Mac OS; and LF " "Genrally <var>CRLF</var> on PC-DOS, Windows and OS/2; <var>CR</var> "
"everywhere else (Linux, Mac OS X, and Unix). " "on Classic Mac OS; and <var>LF</var> everywhere else (Linux, macOS, "
"and Unix). "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@ -910,14 +925,32 @@ static languageDefinition language_en = { whichPluralForm_en, {
- The strings "Tidy" and "HTML Tidy" are the program name and must not - The strings "Tidy" and "HTML Tidy" are the program name and must not
be translated. */ be translated. */
TidyOutCharEncoding, 0, TidyOutCharEncoding, 0,
"This option specifies the character encoding Tidy uses for the output. " "This option specifies the character encoding Tidy uses for "
"output. Some of the output encodings affect whether or not "
"some characters are translated to entities, although in all "
"cases, some entities will be written according to other Tidy "
"configuration options. "
"<br/>" "<br/>"
"Note that this may only be different from <code>input-encoding</code> for " "For <var>ascii</var>, <var>mac</var>, and <var>win1252</var> "
"Latin encodings (<var>ascii</var>, <var>latin0</var>, " "output encodings, entities will be used for all characters "
"<var>latin1</var>, <var>mac</var>, <var>win1252</var>, " "with values over 127. "
"<var>ibm858</var>)."
"<br/>" "<br/>"
"See <code>char-encoding</code> for more information" "For <var>raw</var> output, Tidy will write values above 127 "
"without translating them to entities. "
"<br/>"
"Output using <var>latin1</var> will cause Tidy to write "
"character values higher than 255 as entities. "
"<br/>"
"The UTF family such as <var>utf8</var> will write output "
"in the respective UTF encoding. "
"<br/>"
"Asian output encodings such as <var>iso2022</var> will write "
"output in the specified encoding, assuming a corresponding "
"<code>input-encoding</code> was specified. "
"<br/>"
"Tidy is not an encoding converter. Although the Latin and UTF "
"encodings can be mixed freely, it is not possible to convert Asian "
"encodings to Latin encodings with Tidy. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@ -1017,8 +1050,8 @@ static languageDefinition language_en = { whichPluralForm_en, {
TidyPriorityAttributes, 0, TidyPriorityAttributes, 0,
"This option allows prioritizing the writing of attributes in tidied " "This option allows prioritizing the writing of attributes in tidied "
"documents, allowing them to written before the other attributes of an " "documents, allowing them to written before the other attributes of an "
"element. For example, you might specify that <var>id</var> and " "element. For example, you might specify that <strong>id</strong> and "
"<var>name</var> are written before every other attribute. " "<strong>name</strong> are written before every other attribute. "
"<br/>" "<br/>"
"This option takes a space or comma separated list of attribute names. " "This option takes a space or comma separated list of attribute names. "
}, },
@ -1186,7 +1219,7 @@ static languageDefinition language_en = { whichPluralForm_en, {
be translated. */ be translated. */
TidyMuteReports, 0, TidyMuteReports, 0,
"Use this option to prevent Tidy from displaying certain types of " "Use this option to prevent Tidy from displaying certain types of "
"report output,for example, for conditions that you wish to ignore." "report output, for example, for conditions that you wish to ignore. "
"<br/>" "<br/>"
"This option takes a list of one or more keys indicating the message " "This option takes a list of one or more keys indicating the message "
"type to mute. You can discover these message keys by using the " "type to mute. You can discover these message keys by using the "
@ -1283,10 +1316,11 @@ static languageDefinition language_en = { whichPluralForm_en, {
be translated. */ be translated. */
TidyUseCustomTags, 0, TidyUseCustomTags, 0,
"This option enables the use of tags for autonomous custom elements, " "This option enables the use of tags for autonomous custom elements, "
"e.g. &lt;flag-icon&gt; with Tidy. Custom tags are disabled if this " "e.g. <code>&lt;flag-icon&gt;</code> with Tidy. Custom tags are "
"value is <var>no</var>. Other settings - <var>blocklevel</var>, " "disabled if this value is <var>no</var>. Other settings - "
"<var>empty</var>, <var>inline</var>, and <var>pre</var> will treat " "<var>blocklevel</var>, <var>empty</var>, <var>inline</var>, and "
"<em>all</em> detected custom tags accordingly. " "<var>pre</var> will treat <em>all</em> detected custom tags "
"accordingly. "
"<br/>" "<br/>"
"The use of <code>new-blocklevel-tags</code>, " "The use of <code>new-blocklevel-tags</code>, "
"<code>new-empty-tags</code>, <code>new-inline-tags</code>, or " "<code>new-empty-tags</code>, <code>new-inline-tags</code>, or "
@ -1335,11 +1369,12 @@ static languageDefinition language_en = { whichPluralForm_en, {
- The strings "Tidy" and "HTML Tidy" are the program name and must not - The strings "Tidy" and "HTML Tidy" are the program name and must not
be translated. */ be translated. */
TidyWord2000, 0, TidyWord2000, 0,
"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 "
"the surplus stuff Microsoft Word 2000 inserts when you save Word " "all the surplus stuff Microsoft Word 2000 inserts when you save Word "
"documents as \"Web pages\". It doesn't handle embedded images or VML. " "documents as \"Web pages\". It doesn't handle embedded images or VML. "
"<br/>" "<br/>"
"You should consider using Word's \"Save As: Web Page, Filtered\". " "You should consider saving using Word's <strong>Save As...</strong>, "
"and choosing <strong>Web Page, Filtered</strong>. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@ -1402,8 +1437,8 @@ static languageDefinition language_en = { whichPluralForm_en, {
"<br/>" "<br/>"
"Tidy tries to wrap lines so that they do not exceed this length. " "Tidy tries to wrap lines so that they do not exceed this length. "
"<br/>" "<br/>"
"Set <code>wrap</code> to <var>0</var>(zero) if you want to disable line " "Set <code>wrap</code> to <var>0</var> (zero) if you want to disable "
"wrapping. " "line wrapping. "
}, },
{/* Important notes for translators: {/* Important notes for translators:
- Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and