Merge pull request #717 from ler762/doc-nits

Is #713 - Doc nits - PR #717

README/CONTRIBUTING.md

@@ -40,7 +40,7 @@ Concerning the “Tidy Code Style,” checkout [CODESTYLE.md](CODESTYLE.md), but
 ### Using Git appropriately
 
  1. Fork the repository to your GitHub account.
- 2. Optionally create a **topical branch**, a branch whose name is succint but explains what you're doing, such as "feature/add-new-lines".
+ 2. Optionally create a **topical branch**, a branch whose name is succinct but explains what you're doing, such as "feature/add-new-lines".
  3. Make your changes, committing at logical breaks.
  4. Push your work to your personal account.
  5. [Create a pull request](https://help.github.com/articles/using-pull-requests).

include/tidyenum.h

@@ -107,6 +107,7 @@ extern "C" {
  */
 #define FOREACH_MSG_MISC(FN) \
 /** line %d column %d */                           FN(LINE_COLUMN_STRING)          \
+/** %s: line %d column %d */                       FN(FN_LINE_COLUMN_STRING)       \
 /** discarding */                                  FN(STRING_DISCARDING)           \
 /** error and errors */                            FN(STRING_ERROR_COUNT_ERROR)    \
 /** warning and warnings */                        FN(STRING_ERROR_COUNT_WARNING)  \
@@ -636,6 +637,7 @@ typedef enum
     TidyQuoteNbsp,               /**< Output non-breaking space as entity */
     TidyReplaceColor,            /**< Replace hex color attribute values with names */
     TidyShowErrors,              /**< Number of errors to put out */
+    TidyShowFilename,            /**< If true, the input filename is displayed with the error messages */
     TidyShowInfo,                /**< If true, info-level messages are shown */
     TidyShowMarkup,              /**< If false, normal output is suppressed */
     TidyShowMetaChange,          /**< show when meta http-equiv content charset was changed - compatibility */

src/config.c

@@ -245,6 +245,7 @@ static const TidyOptionImpl option_defs[] =
     { TidyQuoteNbsp,               ME, "quote-nbsp",                  BL, yes,             ParsePickList,     &boolPicks          },
     { TidyReplaceColor,            MX, "replace-color",               BL, no,              ParsePickList,     &boolPicks          },
     { TidyShowErrors,              DD, "show-errors",                 IN, 6,               ParseInt,          NULL                },
+    { TidyShowFilename,            DD, "show-filename",               BL, no,              ParsePickList,     &boolPicks          },
     { TidyShowInfo,                DD, "show-info",                   BL, yes,             ParsePickList,     &boolPicks          },
     { TidyShowMarkup,              DD, "markup",                      BL, yes,             ParsePickList,     &boolPicks          },
     { TidyShowMetaChange,          DG, "show-meta-change",            BL, no,              ParsePickList,     &boolPicks          }, /* 20170609 - Issue #456 */

src/language_en.h

@@ -363,8 +363,15 @@ static languageDefinition language_en = { whichPluralForm_en, {
       - The strings "Tidy" and "HTML Tidy" are the program name and must not
       be translated. */
         TidyEmacs,                    0,
-        "This option specifies if Tidy should change the format for reporting "
+        "This option specifies that Tidy should change the format for reporting "
-        "errors and warnings to a format that is more easily parsed by GNU Emacs. "
+        "errors and warnings to a format that is more easily parsed by GNU Emacs "
+        "or some other program.  It changes them from the default "
+        "<br/>"
+        "  line &lt;line number&gt; column &lt;column number&gt; - (Error|Warning): &lt;message&gt; "
+        "<br/>"
+        "to a form which includes the input filename: "
+        "<br/>"
+        "  &lt;filename&gt;:&lt;line number&gt;:&lt;column number&gt;: (Error|Warning): &lt;message&gt; "
     },
     {/* Important notes for translators:
       - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
@@ -1165,6 +1172,21 @@ static languageDefinition language_en = { whichPluralForm_en, {
         "This option specifies the number Tidy uses to determine if further errors "
         "should be shown. If set to <var>0</var>, then no errors are shown. "
     },
+    {/* Important notes for translators:
+      - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
+      <br/>.
+      - Entities, tags, attributes, etc., should be enclosed in <code></code>.
+      - Option values should be enclosed in <var></var>.
+      - It's very important that <br/> be self-closing!
+      - The strings "Tidy" and "HTML Tidy" are the program name and must not
+      be translated. */
+        TidyShowFilename,             0,
+        "This option specifies if Tidy should show the filename in messages. eg: "
+        "<br/>"
+        " tidy -q -e --show-filename yes index.html<br/>"
+        " index.html: line 43 column 3 - Warning: replacing invalid UTF-8 bytes (char. code U+00A9) "
+    },
+
     {/* Important notes for translators:
       - Use only <code></code>, <var></var>, <em></em>, <strong></strong>, and
       <br/>.
@@ -1681,6 +1703,7 @@ static languageDefinition language_en = { whichPluralForm_en, {
      ** @remark enum generator FOREACH_MSG_MISC
      ********************************************/
     { LINE_COLUMN_STRING,           0,   "line %d column %d - "                                                    },
+    { FN_LINE_COLUMN_STRING,        0,   "%s: line %d column %d - "                                                },
     {/* For example, "discarding invalid UTF-16 surrogate pair" */
       STRING_DISCARDING,            0,   "discarding"
     },

src/message.c

@@ -1522,6 +1522,7 @@ static const TidyOptionId TidyAsciiCharsLinks[] =      { TidyMakeClean, TidyUnkn
 static const TidyOptionId TidyBlockTagsLinks[] =       { TidyEmptyTags, TidyInlineTags, TidyPreTags, TidyUseCustomTags, TidyUnknownOption };
 static const TidyOptionId TidyCharEncodingLinks[] =    { TidyInCharEncoding, TidyOutCharEncoding, TidyUnknownOption };
 static const TidyOptionId TidyDuplicateAttrsLinks[] =  { TidyJoinClasses, TidyJoinStyles, TidyUnknownOption };
+static const TidyOptionId TidyEmacsLinks[] =           { TidyShowFilename, TidyUnknownOption };
 static const TidyOptionId TidyEmptyTagsLinks[] =       { TidyBlockTags, TidyInlineTags, TidyPreTags, TidyUseCustomTags, TidyUnknownOption };
 static const TidyOptionId TidyErrFileLinks[] =         { TidyOutFile, TidyUnknownOption };
 static const TidyOptionId TidyInCharEncodingLinks[] =  { TidyCharEncoding, TidyUnknownOption };
@@ -1536,6 +1537,7 @@ static const TidyOptionId TidyNumEntitiesLinks[] =     { TidyDoctype, TidyPreser
 static const TidyOptionId TidyOutCharEncodingLinks[] = { TidyCharEncoding, TidyUnknownOption };
 static const TidyOptionId TidyOutFileLinks[] =         { TidyErrFile, TidyUnknownOption };
 static const TidyOptionId TidyPreTagsLinks[] =         { TidyBlockTags, TidyEmptyTags, TidyInlineTags, TidyUseCustomTags, TidyUnknownOption };
+static const TidyOptionId TidyShowFilenameLinks[] =    { TidyEmacs, TidyUnknownOption };
 static const TidyOptionId TidySortAttributesLinks[] =  { TidyPriorityAttributes, TidyUnknownOption };
 static const TidyOptionId TidyUseCustomTagsLinks[] =   { TidyBlockTags, TidyEmptyTags, TidyInlineTags, TidyPreTags, TidyUnknownOption };
 static const TidyOptionId TidyWrapAttValsLinks[] =     { TidyWrapScriptlets, TidyLiteralAttribs, TidyUnknownOption };
@@ -1552,6 +1554,7 @@ static const TidyOptionDoc docs_xrefs[] =
     { TidyBlockTags,       TidyBlockTagsLinks       },
     { TidyCharEncoding,    TidyCharEncodingLinks    },
     { TidyDuplicateAttrs,  TidyDuplicateAttrsLinks  },
+    { TidyEmacs,           TidyEmacsLinks           },
     { TidyEmptyTags,       TidyEmptyTagsLinks       },
     { TidyErrFile,         TidyErrFileLinks         },
     { TidyInCharEncoding,  TidyInCharEncodingLinks  },
@@ -1565,6 +1568,7 @@ static const TidyOptionDoc docs_xrefs[] =
     { TidyOutCharEncoding, TidyOutCharEncodingLinks },
     { TidyOutFile,         TidyOutFileLinks         },
     { TidyPreTags,         TidyPreTagsLinks         },
+    { TidyShowFilename,    TidyShowFilenameLinks    },
     { TidySortAttributes,  TidySortAttributesLinks  },
     { TidyMuteReports,     TidyMuteLinks            },
     { TidyUseCustomTags,   TidyUseCustomTagsLinks   },

src/messageobj.c

@@ -127,6 +127,14 @@ static TidyMessageImpl *tidyMessageCreateInitV( TidyDocImpl *doc,
         TY_(tmbsnprintf)(result->messagePosDefault, sizeMessageBuf, "%s:%d:%d: ", cfgStr(doc, TidyEmacsFile), line, column);
         TY_(tmbsnprintf)(result->messagePos, sizeMessageBuf, "%s:%d:%d: ", cfgStr(doc, TidyEmacsFile), line, column);
     }
+    else if ( cfgBool(doc, TidyShowFilename) && cfgStr(doc, TidyEmacsFile) )
+    {
+        /* Include filename in output */
+        TY_(tmbsnprintf)(result->messagePosDefault, sizeMessageBuf, tidyDefaultString(FN_LINE_COLUMN_STRING),
+            cfgStr(doc, TidyEmacsFile), line, column);
+        TY_(tmbsnprintf)(result->messagePos, sizeMessageBuf, tidyLocalizedString(FN_LINE_COLUMN_STRING),
+            cfgStr(doc, TidyEmacsFile), line, column);
+    }
     else
     {
         /* traditional format */