Clarify doc for wrap-attributes option.

htacg · Apr 7, 2012 · 4408516 · 4408516
1 parent c66f165
commit 4408516
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/quickref.html b/quickref.html
@@ -8,7 +8,7 @@
   <body>
     <h1 id="top">Quick Reference</h1>
     <h2>HTML Tidy Configuration Options</h2>
-    <p>Version: <a href="https://github.com/w3c/tidy-html5/tree/1f21625">https://github.com/w3c/tidy-html5/tree/1f21625</a></p>
+    <p>Version: <a href="https://github.com/w3c/tidy-html5/tree/c66f165">https://github.com/w3c/tidy-html5/tree/c66f165</a></p>
     <p>
       <a class="h3" href="#MarkupHeader">HTML, XHTML, XML</a>
       <br />
@@ -2036,7 +2036,7 @@ <h2>HTML Tidy Configuration Options</h2>
         </td>
       </tr>
       <tr>
-        <td colspan="2">This option specifies if Tidy should line wrap attribute values, for easier editing. This option can be set independently of wrap-script-literals. </td>
+        <td colspan="2">This option specifies if Tidy should line-wrap attribute values, for easier editing. Line wrapping means that if the value of an attribute causes a line to exceed the width specified by the "wrap" option, tidy will add one or more line breaks to the value, causing it to wrapped into multiple lines. Note the this option can be set independently of wrap-script-literals. Also note that by default, tidy "munges" or "normalizes" attribute values by replacing any newline or tab character with a single space character, and further by replacing any sequences of multiple whitespace characters with a single space. To force tidy to preserve the original, literal values of all attributes, and ensure that whitespace characters within attribute values are passed through unchanged, set the value the literal-attributes option to "no". </td>
       </tr>
       <tr>
         <td>&#160;</td>

diff --git a/src/localize.c b/src/localize.c
@@ -746,9 +746,18 @@ static const TidyOptionDoc option_docs[] =
    "pseudo elements, which look like: &lt;% ... %&gt;. "
   },
   {TidyWrapAttVals,
-   "This option specifies if Tidy should line wrap attribute values, for "
-   "easier editing. This option can be set independently of "
-   "wrap-script-literals. "
+   "This option specifies if Tidy should line-wrap attribute values, for "
+   "easier editing. Line wrapping means that if the value of an attribute "
+   "causes a line to exceed the width specified by the \"wrap\" option, "
+   "tidy will add one or more line breaks to the value, causing it to "
+   "wrapped into multiple lines. Note the this option can be set "
+   "independently of wrap-script-literals. Also note that by default, tidy "
+   "\"munges\" or \"normalizes\" attribute values by replacing any newline "
+   "or tab character with a single space character, and further by replacing "
+   "any sequences of multiple whitespace characters with a single space. "
+   "To force tidy to preserve the original, literal values of all attributes, "
+   "and ensure that whitespace characters within attribute values are passed "
+   "through unchanged, set the value the literal-attributes option to \"no\". "
    ,TidyWrapAttValsLinks
   },
   {TidyWrapJste,

diff --git a/src/version.h b/src/version.h
@@ -1 +1 @@
-static const char TY_(release_date)[] = "https://github.com/w3c/tidy-html5/tree/880221e";
+static const char TY_(release_date)[] = "https://github.com/w3c/tidy-html5/tree/c66f165";