[html5] r1232 - /
whatwg at whatwg.org
whatwg at whatwg.org
Sun Feb 17 15:10:38 PST 2008
Author: ianh
Date: 2008-02-17 15:10:33 -0800 (Sun, 17 Feb 2008)
New Revision: 1232
Modified:
index
source
Log:
[avgiowt] (2) Rename <m> to <mark> and dramatically increase the level of detail and number of examples regarding this element.
Modified: index
===================================================================
--- index 2008-02-16 04:49:29 UTC (rev 1231)
+++ index 2008-02-17 23:10:33 UTC (rev 1232)
@@ -24,7 +24,7 @@
<h1 id=html-5>HTML 5</h1>
- <h2 class="no-num no-toc" id=working>Working Draft — 16 February
+ <h2 class="no-num no-toc" id=working>Working Draft — 17 February
2008</h2>
<p>You can take part in this work. <a
@@ -537,8 +537,8 @@
<li><a href="#the-small"><span class=secno>3.12.6 </span>The
<code>small</code> element</a>
- <li><a href="#the-m"><span class=secno>3.12.7 </span>The
- <code>m</code> element</a>
+ <li><a href="#the-mark"><span class=secno>3.12.7 </span>The
+ <code>mark</code> element</a>
<li><a href="#the-dfn"><span class=secno>3.12.8 </span>The
<code>dfn</code> element</a>
@@ -581,6 +581,9 @@
<li><a href="#the-bdo"><span class=secno>3.12.21 </span>The
<code>bdo</code> element</a>
+
+ <li><a href="#usage"><span class=secno>3.12.22 </span>Usage
+ summary</a>
</ul>
<li><a href="#edits"><span class=secno>3.13 </span>Edits</a>
@@ -10437,8 +10440,8 @@
<pre><p><strong><small>Continued use of this service will result in a kiss.</small></strong></p></pre>
</div>
- <h4 id=the-m><span class=secno>3.12.7 </span>The <dfn
- id=m><code>m</code></dfn> element</h4>
+ <h4 id=the-mark><span class=secno>3.12.7 </span>The <dfn
+ id=mark><code>mark</code></dfn> element</h4>
<dl class=element>
<dt>Categories
@@ -10463,32 +10466,128 @@
href="#htmlelement">HTMLElement</a></code>.
</dl>
- <p class=big-issue>This section has a large number of outstanding comments
- and will likely be rewritten or removed from the spec.
+ <p>The <code><a href="#mark">mark</a></code> element represents a run of
+ text in one document marked or highlighted for reference purposes, due to
+ its relevance in another context. When used in a quotation or other block
+ of text referred to from the prose, it indicates a highlight that was not
+ originally present but which has been added to bring the reader's
+ attention to a part of the text that might not have been considered
+ important by the original author when the block was originally written,
+ but which is now under previously unexpected scrutiny. When used in the
+ main prose of a document, it indicates a part of the document that has
+ been highlighted due to its likely relevance to the user's current
+ activity.
- <p>The <code><a href="#m">m</a></code> element represents a run of text
- marked or highlighted.
+ <p class=big-issue>The rendering section will eventually suggest that user
+ agents provide a way to let users jump between <code><a
+ href="#mark">mark</a></code> elements. Suggested rendering is a neon
+ yellow background highlight, though UAs maybe should allow this to be
+ toggled.
<div class=example>
+ <p>This example shows how the <code><a href="#mark">mark</a></code>
+ example can be used to bring attention to a particular part of a
+ quotation:</p>
+
+ <pre><p lang="en-US">Consider the following quote:</p>
+<blockquote lang="en-GB">
+ <p>Look around and you will find, no-one's really
+ <mark>colour</mark> blind.</p>
+</blockquote>
+<p lang="en-US">As we can tell from the <em>spelling</em> of the word,
+the person writing this quote is clearly not American.</p></pre>
+ </div>
+
+ <div class=example>
+ <p>Another example of the <code><a href="#mark">mark</a></code> element is
+ highlighting parts of a document that are matching some search string. If
+ someone looked at a document, and the server knew that the user was
+ searching for the word "kitten", then the server might return the
+ document with one paragraph modified as follows:</p>
+
+ <pre><p>I also have some <mark>kitten</mark>s who are visiting me
+these days. They're really cute. I think they like my garden! Maybe I
+should adopt a <mark>kitten</mark>.</p></pre>
+ </div>
+
+ <div class=example>
<p>In the following snippet, a paragraph of text refers to a specific part
of a code fragment.</p>
<pre><p>The highlighted part below is where the error lies:</p>
<pre><code>var i: Integer;
begin
- i := <m>1.1</m>;
+ i := <mark>1.1</mark>;
end.</code></pre></pre>
+ </div>
- <p>Another example of the <code><a href="#m">m</a></code> element is
- highlighting parts of a document that are matching some search string. If
- someone looked at a document, and the server knew that the user was
- searching for the word "kitten", then the server might return the
- document with one paragraph modified as follows:</p>
+ <div class=example>
+ <p>This is another example showing the use of <code><a
+ href="#mark">mark</a></code> to highlight a part of quoted text that was
+ originally not emphasised. In this example, common typographic
+ conventions have led the author to explicitly style <code><a
+ href="#mark">mark</a></code> elements in quotes to render in italics.</p>
- <pre><p>I also have some <m>kitten</m>s who are visiting me
-these days. They're really cute. I think they like my garden!</p></pre>
+ <pre><article>
+ <style>
+ blockquote mark, q mark {
+ font: inherit; font-style: italic;
+ text-decoration: none;
+ background: transparent; color: inherit;
+ }
+ .bubble em {
+ font: inherit; font-size: larger;
+ text-decoration: underline;
+ }
+ </style>
+ <h1>She knew</h1>
+ <p>Did you notice the subtle joke in the joke on panel 4?</p>
+ <blockquote>
+ <p class="bubble">I didn't <em>want</em> to believe. <mark>Of course
+ on some level I realized it was a known-plaintext attack.</mark> But I
+ couldn't admit it until I saw for myself.</p>
+ </blockquote>
+ <p>(Emphasis mine.) I thought that was great. It's so pedantic, yet it
+ explains everything neatly.</p>
+</article></pre>
+
+ <p>Note, incidentally, the distinction between the <code><a
+ href="#em">em</a></code> element in this example, which is part of the
+ original text being quoted, and the <code><a href="#mark">mark</a></code>
+ element, which is highlighting a part for comment.</p>
</div>
+ <div class=example>
+ <p>The following example shows the difference between denoting the
+ <em>importance</em> of a span of text (<code><a
+ href="#strong">strong</a></code>) as opposed to denoting the
+ <em>relevance</em> of a span of text (<code><a
+ href="#mark">mark</a></code>). It is an extract from a textbook, where
+ the extract has had the parts relevant to the exam highlighted. The
+ safety warnings, important though they may be, are apparently not
+ relevant to the exam.</p>
+
+ <pre><h3>Wormhole Physics Introduction</h3>
+
+<p><mark>A wormhole in normal conditions can be held open for a
+maximum of just under 39 minutes.</mark> Conditions that can increase
+the time include a powerful energy source coupled to one or both of
+the gates connecting the wormhole, and a large gravity well (such as a
+black hole).</p>
+
+<p><mark>Momentum is preserved across the wormhole. Electromagnetic
+radiation can travel in both directions through a wormhole,
+but matter cannot.</mark></p>
+
+<p>When a wormhole is created, a vortex normally forms.
+<strong>Warning: The vortex caused by the wormhole opening will
+annihilate anything in its path.</strong> Vortexes can be avoided when
+using sufficently advanced dialing technology.</p>
+
+<p><mark>An obstruction in a gate will prevent it from accepting a
+wormhole connection.</mark></p></pre>
+ </div>
+
<h4 id=the-dfn><span class=secno>3.12.8 </span>The <dfn
id=dfn><code>dfn</code></dfn> element</h4>
@@ -11821,16 +11920,6 @@
</div>
<div class=example>
- <p>The following would be <em>incorrect</em> usage:</p>
-
- <pre><p><b>WARNING!</b> Do not frob the barbinator!</p></pre>
-
- <p>In the previous example, the correct element to use would have been
- <code><a href="#strong">strong</a></code>, not <code><a
- href="#b">b</a></code>.</p>
- </div>
-
- <div class=example>
<p>In the following example, objects in a text adventure are highlighted
as being special by use of the <code><a href="#b">b</a></code> element.</p>
@@ -11861,8 +11950,18 @@
href="#h6">h6</a></code> elements, stress emphasis should use the <code><a
href="#em">em</a></code> element, importance should be denoted with the
<code><a href="#strong">strong</a></code> element, and text marked or
- highlighted should use the <code><a href="#m">m</a></code> element.
+ highlighted should use the <code><a href="#mark">mark</a></code> element.
+ <div class=example>
+ <p>The following would be <em>incorrect</em> usage:</p>
+
+ <pre><p><b>WARNING!</b> Do not frob the barbinator!</p></pre>
+
+ <p>In the previous example, the correct element to use would have been
+ <code><a href="#strong">strong</a></code>, not <code><a
+ href="#b">b</a></code>.</p>
+ </div>
+
<p class=note>Style sheets can be used to format <code><a
href="#b">b</a></code> elements, just like any other element can be
restyled. Thus, it is not the case that content in <code><a
@@ -11925,6 +12024,13 @@
<a href="#refsCSS21">[CSS21]</a></p>
<!-- XXX need examples -->
+ <h4 id=usage><span class=secno>3.12.22 </span>Usage summary</h4>
+
+ <p class=big-issue>We need to summarise the various elements, in particular
+ to distinguish b/i/em/strong/var/q/mark/cite.</p>
+ <!-- XXX when you do this, also reorder the elements in this section
+ to bring the related ones closer together. -->
+
<h3 id=edits><span class=secno>3.13 </span>Edits</h3>
<p>The <code><a href="#ins">ins</a></code> and <code><a
Modified: source
===================================================================
--- source 2008-02-16 04:49:29 UTC (rev 1231)
+++ source 2008-02-17 23:10:33 UTC (rev 1232)
@@ -8512,7 +8512,7 @@
</div>
- <h4>The <dfn><code>m</code></dfn> element</h4>
+ <h4>The <dfn><code>mark</code></dfn> element</h4>
<dl class="element">
<dt>Categories</dt>
@@ -8527,35 +8527,135 @@
<dd>No difference from <code>HTMLElement</code>.</dd>
</dl>
- <p class="big-issue">This section has a large number of outstanding
- comments and will likely be rewritten or removed from the spec.</p>
+ <p>The <code>mark</code> element represents a run of text in one
+ document marked or highlighted for reference purposes, due to its
+ relevance in another context. When used in a quotation or other
+ block of text referred to from the prose, it indicates a highlight
+ that was not originally present but which has been added to bring
+ the reader's attention to a part of the text that might not have
+ been considered important by the original author when the block was
+ originally written, but which is now under previously unexpected
+ scrutiny. When used in the main prose of a document, it indicates a
+ part of the document that has been highlighted due to its likely
+ relevance to the user's current activity.</p>
- <p>The <code>m</code> element represents a run of text marked or
- highlighted.</p>
+ <p class="big-issue">The rendering section will eventually suggest
+ that user agents provide a way to let users jump between
+ <code>mark</code> elements. Suggested rendering is a neon yellow
+ background highlight, though UAs maybe should allow this to be
+ toggled.</p>
<div class="example">
+ <p>This example shows how the <code>mark</code> example can be used
+ to bring attention to a particular part of a quotation:</p>
+ <pre><p lang="en-US">Consider the following quote:</p>
+<blockquote lang="en-GB">
+ <p>Look around and you will find, no-one's really
+ <mark>colour</mark> blind.</p>
+</blockquote>
+<p lang="en-US">As we can tell from the <em>spelling</em> of the word,
+the person writing this quote is clearly not American.</p></pre>
+ </div>
+ <div class="example">
+
+ <p>Another example of the <code>mark</code> element is highlighting
+ parts of a document that are matching some search string. If
+ someone looked at a document, and the server knew that the user was
+ searching for the word "kitten", then the server might return the
+ document with one paragraph modified as follows:</p>
+
+ <pre><p>I also have some <mark>kitten</mark>s who are visiting me
+these days. They're really cute. I think they like my garden! Maybe I
+should adopt a <mark>kitten</mark>.</p></pre>
+
+ </div>
+
+ <div class="example">
+
<p>In the following snippet, a paragraph of text refers to a
specific part of a code fragment.</p>
<pre><p>The highlighted part below is where the error lies:</p>
<pre><code>var i: Integer;
begin
- i := <m>1.1</m>;
+ i := <mark>1.1</mark>;
end.</code></pre></pre>
- <p>Another example of the <code>m</code> element is highlighting
- parts of a document that are matching some search string. If
- someone looked at a document, and the server knew that the user was
- searching for the word "kitten", then the server might return the
- document with one paragraph modified as follows:</p>
+ </div>
- <pre><p>I also have some <m>kitten</m>s who are visiting me
-these days. They're really cute. I think they like my garden!</p></pre>
+ <div class="example">
+ <p>This is another example showing the use of <code>mark</code> to
+ highlight a part of quoted text that was originally not
+ emphasised. In this example, common typographic conventions have
+ led the author to explicitly style <code>mark</code> elements in
+ quotes to render in italics.</p>
+
+ <pre><article>
+ <style>
+ blockquote mark, q mark {
+ font: inherit; font-style: italic;
+ text-decoration: none;
+ background: transparent; color: inherit;
+ }
+ .bubble em {
+ font: inherit; font-size: larger;
+ text-decoration: underline;
+ }
+ </style>
+ <h1>She knew</h1>
+ <p>Did you notice the subtle joke in the joke on panel 4?</p>
+ <blockquote>
+ <p class="bubble">I didn't <em>want</em> to believe. <mark>Of course
+ on some level I realized it was a known-plaintext attack.</mark> But I
+ couldn't admit it until I saw for myself.</p>
+ </blockquote>
+ <p>(Emphasis mine.) I thought that was great. It's so pedantic, yet it
+ explains everything neatly.</p>
+</article></pre>
+
+ <p>Note, incidentally, the distinction between the <code>em</code>
+ element in this example, which is part of the original text being
+ quoted, and the <code>mark</code> element, which is highlighting a
+ part for comment.</p>
+
</div>
+ <div class="example">
+ <p>The following example shows the difference between denoting the
+ <em>importance</em> of a span of text (<code>strong</code>) as
+ opposed to denoting the <em>relevance</em> of a span of text
+ (<code>mark</code>). It is an extract from a textbook, where the
+ extract has had the parts relevant to the exam highlighted. The
+ safety warnings, important though they may be, are apparently not
+ relevant to the exam.</p>
+
+ <pre><h3>Wormhole Physics Introduction</h3>
+
+<p><mark>A wormhole in normal conditions can be held open for a
+maximum of just under 39 minutes.</mark> Conditions that can increase
+the time include a powerful energy source coupled to one or both of
+the gates connecting the wormhole, and a large gravity well (such as a
+black hole).</p>
+
+<p><mark>Momentum is preserved across the wormhole. Electromagnetic
+radiation can travel in both directions through a wormhole,
+but matter cannot.</mark></p>
+
+<p>When a wormhole is created, a vortex normally forms.
+<strong>Warning: The vortex caused by the wormhole opening will
+annihilate anything in its path.</strong> Vortexes can be avoided when
+using sufficently advanced dialing technology.</p>
+
+<p><mark>An obstruction in a gate will prevent it from accepting a
+wormhole connection.</mark></p></pre>
+
+ </div>
+
+
+
<h4>The <dfn><code>dfn</code></dfn> element</h4>
<dl class="element">
@@ -9747,13 +9847,6 @@
</div>
<div class="example">
- <p>The following would be <em>incorrect</em> usage:</p>
- <pre><p><b>WARNING!</b> Do not frob the barbinator!</p></pre>
- <p>In the previous example, the correct element to use would have
- been <code>strong</code>, not <code>b</code>.</p>
- </div>
-
- <div class="example">
<p>In the following example, objects in a text adventure are
highlighted as being special by use of the <code>b</code>
element.</p>
@@ -9782,8 +9875,15 @@
use the <code>h1</code> to <code>h6</code> elements, stress emphasis
should use the <code>em</code> element, importance should be denoted
with the <code>strong</code> element, and text marked or highlighted
- should use the <code>m</code> element.</p>
+ should use the <code>mark</code> element.</p>
+ <div class="example">
+ <p>The following would be <em>incorrect</em> usage:</p>
+ <pre><p><b>WARNING!</b> Do not frob the barbinator!</p></pre>
+ <p>In the previous example, the correct element to use would have
+ been <code>strong</code>, not <code>b</code>.</p>
+ </div>
+
<p class="note">Style sheets can be used to format <code>b</code>
elements, just like any other element can be restyled. Thus, it is
not the case that content in <code>b</code> elements will
@@ -9838,7 +9938,15 @@
+ <h4>Usage summary</h4>
+ <p class="big-issue">We need to summarise the various elements, in
+ particular to distinguish b/i/em/strong/var/q/mark/cite.</p>
+
+ <!-- XXX when you do this, also reorder the elements in this section
+ to bring the related ones closer together. -->
+
+
<h3>Edits</h3>
<p>The <code>ins</code> and <code>del</code> elements represent
More information about the Commit-Watchers
mailing list