[html5] r2467 - [ea] (0) Add explanatory text around <abbr> uses.

[whatwg at whatwg.org]

Author: ianh
Date: 2008-11-26 15:14:05 -0800 (Wed, 26 Nov 2008)
New Revision: 2467

Modified:
   index
   source
Log:
[ea] (0) Add explanatory text around <abbr> uses.

Modified: index
===================================================================
--- index	2008-11-26 22:48:54 UTC (rev 2466)
+++ index	2008-11-26 23:14:05 UTC (rev 2467)
@@ -12404,7 +12404,25 @@
 
   </div>
 
-  <p title=note>Providing an expansion in a <code title=attr-title><a href=#the-title-attribute>title</a></code> attribute once will not necessarily
+  <p>Abbreviations do not have to be marked up using this element. It
+  is expected to be useful in the following cases:</p>
+
+  <ul><li>Abbreviations for which the author wants to give expansions,
+   where using the <code><a href=#the-abbr-element>abbr</a></code> element with a <code title=attr-title><a href=#the-title-attribute>title</a></code> attribute is an alternative to
+   including the expansion inline (e.g. in parentheses).</li>
+
+   <li>Abbreviations that are likely to be unfamiliar to the
+   document's readers, for which authors are encouraged to either mark
+   up the abbreviation using a <code><a href=#the-abbr-element>abbr</a></code> element with a <code title=attr-title><a href=#the-title-attribute>title</a></code> attribute or include the expansion
+   inline in the text the first time the abbreviation is used.</li>
+
+   <li>Abbreviations whose presence needs to be semantically
+   annotated, e.g. so that they can be identified from a style sheet
+   and given specific styles, for which the <code><a href=#the-abbr-element>abbr</a></code> element
+   can be used without a <code title=attr-title><a href=#the-title-attribute>title</a></code>
+   attribute.</li>
+
+  </ul><p title=note>Providing an expansion in a <code title=attr-title><a href=#the-title-attribute>title</a></code> attribute once will not necessarily
   cause other <code><a href=#the-abbr-element>abbr</a></code> elements in the same document with the
   same contents but without a <code title=attr-title><a href=#the-title-attribute>title</a></code>
   attribute to behave as if they had the same expansion. Every

Modified: source
===================================================================
--- source	2008-11-26 22:48:54 UTC (rev 2466)
+++ source	2008-11-26 23:14:05 UTC (rev 2467)
@@ -13207,6 +13207,30 @@
 
   </div>
 
+  <p>Abbreviations do not have to be marked up using this element. It
+  is expected to be useful in the following cases:</p>
+
+  <ul>
+
+   <li>Abbreviations for which the author wants to give expansions,
+   where using the <code>abbr</code> element with a <code
+   title="attr-title">title</code> attribute is an alternative to
+   including the expansion inline (e.g. in parentheses).</li>
+
+   <li>Abbreviations that are likely to be unfamiliar to the
+   document's readers, for which authors are encouraged to either mark
+   up the abbreviation using a <code>abbr</code> element with a <code
+   title="attr-title">title</code> attribute or include the expansion
+   inline in the text the first time the abbreviation is used.</li>
+
+   <li>Abbreviations whose presence needs to be semantically
+   annotated, e.g. so that they can be identified from a style sheet
+   and given specific styles, for which the <code>abbr</code> element
+   can be used without a <code title="attr-title">title</code>
+   attribute.</li>
+
+  </ul>
+
   <p title="note">Providing an expansion in a <code
   title="attr-title">title</code> attribute once will not necessarily
   cause other <code>abbr</code> elements in the same document with the