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

Updated documentation to reflect the rc files Tidy will use on Unix systems,

Browse source 
and added a new -help-env service that intelligently displays information about
$HTML_TIDY, rc files, and application order.
This commit is contained in:
Jim Derry 2017-10-01 18:58:17 -04:00
parent 3168aed365
commit 1ad3241d3c
4 changed files with 180 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
console/tidy.c
View file

@ -1011,7 +1011,45 @@ static void optionhelp( TidyDoc tdoc )
} }
/** @} end service_lang_help group */ /** @} end service_help_config group */
/* MARK: - Provide the -help-env Service */
/***************************************************************************//**
** @defgroup service_help_env Provide the -help-env Service
*******************************************************************************
** @{
*/
/** Handles the -help-env service.
** @param tdoc The Tidy document.
*/
static void helpEnv( TidyDoc tdoc )
{
tmbstr subst = "";
Bool uses_env = getenv("HTML_TIDY") != NULL;
ctmbstr env_var = uses_env ? getenv("HTML_TIDY"): tidyLocalizedString( TC_TXT_HELP_ENV_1B );
#if defined( TIDY_CONFIG_FILE ) && defined( TIDY_USER_CONFIG_FILE )
subst = stringWithFormat( tidyLocalizedString(TC_TXT_HELP_ENV_1A), TIDY_CONFIG_FILE, TIDY_USER_CONFIG_FILE );
#endif
env_var = env_var != NULL ? env_var : tidyLocalizedString( TC_TXT_HELP_ENV_1B );
printf( "\n" );
printf( tidyLocalizedString( TC_TXT_HELP_ENV_1), subst, env_var );
#if defined( TIDY_CONFIG_FILE ) && defined( TIDY_USER_CONFIG_FILE )
if ( uses_env )
printf( tidyLocalizedString( TC_TXT_HELP_ENV_1C ), TIDY_USER_CONFIG_FILE );
free( subst );
#endif
printf( "\n" );
}
/** @} end service_help_env group */
/* MARK: - Provide the -help-option Service */ /* MARK: - Provide the -help-option Service */
/***************************************************************************//** /***************************************************************************//**
** @defgroup service_help_option Provide the -help-option Service ** @defgroup service_help_option Provide the -help-option Service
@ -2124,6 +2162,12 @@ int main( int argc, char** argv )
tidyRelease( tdoc ); tidyRelease( tdoc );
return 0; /* success */ return 0; /* success */
} }
else if ( strcasecmp(arg, "help-env") == 0 )
{
helpEnv( tdoc );
tidyRelease( tdoc );
return 0; /* success */
}
else if ( strcasecmp(arg, "help-option") == 0 ) else if ( strcasecmp(arg, "help-option") == 0 )
{ {
if ( argc >= 3) if ( argc >= 3)

4
include/tidyenum.h
View file

@ -491,6 +491,10 @@ extern "C" {
FN(TC_TXT_HELP_CONFIG_NAME) \ FN(TC_TXT_HELP_CONFIG_NAME) \
FN(TC_TXT_HELP_CONFIG_TYPE) \ FN(TC_TXT_HELP_CONFIG_TYPE) \
FN(TC_TXT_HELP_CONFIG_ALLW) \ FN(TC_TXT_HELP_CONFIG_ALLW) \
FN(TC_TXT_HELP_ENV_1) \
FN(TC_TXT_HELP_ENV_1A) \
FN(TC_TXT_HELP_ENV_1B) \
FN(TC_TXT_HELP_ENV_1C) \
FN(TC_TXT_HELP_LANG_1) \ FN(TC_TXT_HELP_LANG_1) \
FN(TC_TXT_HELP_LANG_2) \ FN(TC_TXT_HELP_LANG_2) \
FN(TC_TXT_HELP_LANG_3) FN(TC_TXT_HELP_LANG_3)

115
localize/translations/tidy.pot
View file

@ -5,7 +5,7 @@ msgstr ""
"Plural-Forms: nplurals=2; plural=n != 1;\n" "Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: HTML Tidy poconvert.rb\n" "X-Generator: HTML Tidy poconvert.rb\n"
"Project-Id-Version: \n" "Project-Id-Version: \n"
"POT-Creation-Date: 2017-09-28 13:24:51\n" "POT-Creation-Date: 2017-10-01 18:57:47\n"
"Last-Translator: jderry\n" "Last-Translator: jderry\n"
"Language-Team: \n" "Language-Team: \n"
@ -3388,48 +3388,71 @@ msgstr ""
#. This console output should be limited to 78 characters per line. #. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. #. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#. - %s represents either a blank line, or TC_TXT_HELP_3A explaining environment options.
#, c-format
msgctxt "TC_TXT_HELP_3" msgctxt "TC_TXT_HELP_3"
msgid "" msgid ""
"\n" "\n"
"Tidy Configuration Options\n" "Tidy Configuration Options\n"
"==========================\n" "==========================\n"
"Use Tidy's configuration options as command line arguments in the form\n" " Use Tidy's configuration options as command line arguments in the form\n"
"of \"--some-option <value>\", for example, \"--indent-with-tabs yes\".\n" " of \"--some-option <value>\", for example, \"--indent-with-tabs yes\".\n"
"\n" "\n"
"For a list of all configuration options, use \"-help-config\" or refer\n" " You can also specify a file containing configuration options with the \n"
"to the man page (if your OS has one).\n" " -options <file> directive, or in one or more files specific to your \n"
" environment (see next section). \n"
"\n" "\n"
"If your environment has an $HTML_TIDY variable set point to a Tidy \n" " For a list of all configuration options, use \"-help-config\" or refer\n"
"configuration file then Tidy will attempt to use it.\n" " to the man page (if your OS has one).\n"
"\n" "\n"
"On some platforms Tidy will also attempt to use a configuration specified \n" "Configuration Files\n"
"in /etc/tidy.conf or ~/.tidy.conf.\n" "===================\n"
" If your environment has an $HTML_TIDY variable set to point to a Tidy \n"
" configuration file, then Tidy will attempt to use it. \n"
"%s"
" Use \"-help-env\" for more information about how you can use the environment. \n"
" to specify Tidy options. \n"
"\n" "\n"
"Other\n" "Other\n"
"=====\n" "=====\n"
"Input/Output default to stdin/stdout respectively.\n" " Input/Output default to stdin/stdout respectively.\n"
"\n" "\n"
"Single letter options apart from -f may be combined\n" " Single letter options apart from -f may be combined\n"
"as in: tidy -f errs.txt -imu foo.html\n" " as in: tidy -f errs.txt -imu foo.html\n"
"\n" "\n"
"Information\n" "Information\n"
"===========\n" "===========\n"
"For more information about HTML Tidy, see\n" " For more information about HTML Tidy, see\n"
" http://www.html-tidy.org/\n" " http://www.html-tidy.org/\n"
"\n" "\n"
"For more information on HTML, see the following:\n" " For more information on HTML, see the following:\n"
"\n" "\n"
" HTML: Edition for Web Authors (the latest HTML specification)\n" " HTML: Edition for Web Authors (the latest HTML specification)\n"
" http://dev.w3.org/html5/spec-author-view\n" " http://dev.w3.org/html5/spec-author-view\n"
"\n" "\n"
" HTML: The Markup Language (an HTML language reference)\n" " HTML: The Markup Language (an HTML language reference)\n"
" http://dev.w3.org/html5/markup/\n" " http://dev.w3.org/html5/markup/\n"
"\n" "\n"
"File bug reports at https://github.com/htacg/tidy-html5/issues/\n" " File bug reports at https://github.com/htacg/tidy-html5/issues/\n"
"or send questions and comments to public-htacg@w3.org.\n" " or send questions and comments to public-htacg@w3.org.\n"
"\n" "\n"
"Validate your HTML documents using the W3C Nu Markup Validator:\n" " Validate your HTML documents using the W3C Nu Markup Validator:\n"
" http://validator.w3.org/nu/\n" " http://validator.w3.org/nu/\n"
"\n"
msgstr ""
#. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#. - Both parameters %s reflect file paths and names.
#, c-format
msgctxt "TC_TXT_HELP_3A"
msgid ""
"\n"
" Additionally, Tidy will automatically attempt to use configuration specified \n"
" in these files, if present: \n"
"\n"
" %s \n"
" %s \n"
"\n" "\n"
msgstr "" msgstr ""
@ -3463,6 +3486,54 @@ msgctxt "TC_TXT_HELP_CONFIG_ALLW"
msgid "Allowable values" msgid "Allowable values"
msgstr "" msgstr ""
#. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#. - The first %s indicates two more list items, or an empty string.
#. - The second %s indicates a file name, or a message indicating no file name.
#, c-format
msgctxt "TC_TXT_HELP_ENV_1"
msgid ""
"\n"
"Tidy can configure its option values from multiple sources, in the \n"
"order below. Subsequent use of the same option overrides previous \n"
"option settings. \n"
"\n"
" - Tidy's built-in default values. \n"
"%s" /* rc files */
" - The file specified in the $HTML_TIDY environment variable: \n"
" %s \n"
" - Options in a file specified on the command line. \n"
" - Options set directly on the command line. \n"
msgstr ""
#. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#, c-format
msgctxt "TC_TXT_HELP_ENV_1A"
msgid ""
" - The system runtime configuration file: \n"
" %s \n"
" - The user runtime configuration file: \n"
" %s \n"
msgstr ""
#. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#. - This message indicates that a file name is not currently set.
msgctxt "TC_TXT_HELP_ENV_1B"
msgid "(not currently set)"
msgstr ""
#. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
#, c-format
msgctxt "TC_TXT_HELP_ENV_1C"
msgid ""
"\n"
"Note that because $HTML_TIDY is set, the user runtime configuration file \n"
"%s will not be used. \n"
msgstr ""
#. This console output should be limited to 78 characters per line. #. This console output should be limited to 78 characters per line.
#. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. #. - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
msgctxt "TC_TXT_HELP_LANG_1" msgctxt "TC_TXT_HELP_LANG_1"

38
src/language_en.h
View file

@ -2304,6 +2304,44 @@ static languageDefinition language_en = { whichPluralForm_en, {
{ TC_TXT_HELP_CONFIG_NAME, 0, "Name" }, { TC_TXT_HELP_CONFIG_NAME, 0, "Name" },
{ TC_TXT_HELP_CONFIG_TYPE, 0, "Type" }, { TC_TXT_HELP_CONFIG_TYPE, 0, "Type" },
{ TC_TXT_HELP_CONFIG_ALLW, 0, "Allowable values" }, { TC_TXT_HELP_CONFIG_ALLW, 0, "Allowable values" },
{/* This console output should be limited to 78 characters per line.
- The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
- The first %s indicates two more list items, or an empty string.
- The second %s indicates a file name, or a message indicating no file name. */
TC_TXT_HELP_ENV_1, 0,
"\n"
"Tidy can configure its option values from multiple sources, in the \n"
"order below. Subsequent use of the same option overrides previous \n"
"option settings. \n"
"\n"
" - Tidy's built-in default values. \n"
"%s" /* rc files */
" - The file specified in the $HTML_TIDY environment variable: \n"
" %s \n"
" - Options in a file specified on the command line. \n"
" - Options set directly on the command line. \n"
},
{/* This console output should be limited to 78 characters per line.
- The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. */
TC_TXT_HELP_ENV_1A, 0,
" - The system runtime configuration file: \n"
" %s \n"
" - The user runtime configuration file: \n"
" %s \n"
},
{/* This console output should be limited to 78 characters per line.
- The strings "Tidy" and "HTML Tidy" are the program name and must not be translated.
- This message indicates that a file name is not currently set. */
TC_TXT_HELP_ENV_1B, 0,
"(not currently set)"
},
{/* This console output should be limited to 78 characters per line.
- The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. */
TC_TXT_HELP_ENV_1C, 0,
"\n"
"Note that because $HTML_TIDY is set, the user runtime configuration file \n"
"%s will not be used. \n"
},
{/* This console output should be limited to 78 characters per line. {/* This console output should be limited to 78 characters per line.
- The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. */ - The strings "Tidy" and "HTML Tidy" are the program name and must not be translated. */
TC_TXT_HELP_LANG_1, 0, TC_TXT_HELP_LANG_1, 0,