W3C home > Mailing lists > Public > public-html-commits@w3.org > August 2008

html5/spec Overview.html,1.1282,1.1283

From: Ian Hickson via cvs-syncmail <cvsmail@w3.org>
Date: Sat, 23 Aug 2008 09:36:36 +0000
To: public-html-commits@w3.org
Message-Id: <E1KWpXx-0006nQ-1y@lionel-hutz.w3.org>

Update of /sources/public/html5/spec
In directory hutz:/tmp/cvs-serv26110

Modified Files:
	Overview.html 
Log Message:
Emphasise that captions are not suitable alternative text. (whatwg r2110)

Index: Overview.html
===================================================================
RCS file: /sources/public/html5/spec/Overview.html,v
retrieving revision 1.1282
retrieving revision 1.1283
diff -u -d -r1.1282 -r1.1283
--- Overview.html	23 Aug 2008 09:16:31 -0000	1.1282
+++ Overview.html	23 Aug 2008 09:36:34 -0000	1.1283
@@ -823,6 +823,9 @@
            <li><a href="#an-image0"><span class=secno>4.7.2.1.10. </span>An
             image in an e-mail or document intended for a specific person who
             is known to be able to view images</a>
+
+           <li><a href="#anti-patterns"><span class=secno>4.7.2.1.11.
+            </span>Anti-patterns</a>
           </ul>
         </ul>
 
@@ -16686,6 +16689,51 @@
 linked to the DOM, and, using document.write(), passes data to
 the Tokeniser.&lt;/p>
 <strong>&lt;p>&lt;img src="images/parsing-model-overview.png" alt="">&lt;/p></strong></pre>
+
+   <p>In these cases, it would be wrong to include alternative text that
+    consists of just a caption. If a caption is to be included, then either
+    the <code title=attr-title><a href="#title">title</a></code> attribute
+    can be used, or the <code><a href="#figure">figure</a></code> and
+    <code><a href="#legend">legend</a></code> elements can be used. In the
+    latter case, the image would in fact be a phrase or paragraph with an
+    alternative graphical representation, and would thus require alternative
+    text.</p>
+
+   <pre>&lt;!-- Using the title="" attribute -->
+&lt;p>The network passes data to the Tokeniser stage, which
+passes data to the Tree Construction stage. From there, data goes
+to both the DOM and to Script Execution. Script Execution is
+linked to the DOM, and, using document.write(), passes data to
+the Tokeniser.&lt;/p>
+<strong>&lt;p>&lt;img src="images/parsing-model-overview.png" alt=""
+        title="Flowchart representation of the parsing model."></strong>&lt;/p></pre>
+
+   <pre>&lt;!-- Using &lt;figure> and &lt;legend> -->
+&lt;p>The network passes data to the Tokeniser stage, which
+passes data to the Tree Construction stage. From there, data goes
+to both the DOM and to Script Execution. Script Execution is
+linked to the DOM, and, using document.write(), passes data to
+the Tokeniser.&lt;/p>
+&lt;figure>
+ <strong>&lt;img src="images/parsing-model-overview.png" alt="The Network leads
+ to the Tokeniser, which leads to the Tree Construction. The Tree
+ Construction leads to two items. The first is Script Execution, which
+ leads via document.write() back to the Tokeniser. The second item
+ from which Tree Construction leads is the DOM. The DOM is related to
+ the Script Execution."></strong>
+ &lt;legend>Flowchart representation of the parsing model.&lt;/legend>
+&lt;/figure></pre>
+
+   <pre
+    class=bad>&lt;!-- This is WRONG. Do not do this. Instead, do what the above examples do. -->
+&lt;p>The network passes data to the Tokeniser stage, which
+passes data to the Tree Construction stage. From there, data goes
+to both the DOM and to Script Execution. Script Execution is
+linked to the DOM, and, using document.write(), passes data to
+the Tokeniser.&lt;/p>
+&lt;p>&lt;img src="images/parsing-model-overview.png"
+        alt="Flowchart representation of the parsing model.">&lt;/p>
+&lt;!-- Never put the image's caption in the alt="" attribute! --></pre>
   </div>
 
   <div class=example>
@@ -17037,6 +17085,19 @@
    images, or should the e-mail be forwarded on to other users whose
    abilities might not include easily seeing images.
 
+  <h6 id=anti-patterns><span class=secno>4.7.2.1.11. </span>Anti-patterns</h6>
+
+  <p>The <code title=attr-img-alt><a href="#alt0">alt</a></code> attribute's
+   value should never contain text that could be considered the image's
+   <em><a href="#caption0">caption</a></em>, <em><a
+   href="#title1">title</a></em>, or <em><a href="#legend">legend</a></em>.
+   It is supposed to contain replacement text that could be used by users
+   <em>instead</em> of the image; it is not meant to supplement the image.
+   The <code title=attr-title><a href="#title">title</a></code> attribute can
+   be used for supplemental information.
+
+  <p>
+
   <h4 id=the-iframe><span class=secno>4.7.3 </span>The <dfn
    id=iframe><code>iframe</code></dfn> element</h4>
 
Received on Saturday, 23 August 2008 09:37:14 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Thursday, 9 October 2008 20:32:58 GMT