Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[e] (0) Explain requirements
Fixing http://www.w3.org/Bugs/Public/show_bug.cgi?id=13444

git-svn-id: http://svn.whatwg.org/webapps@6479 340c8d12-0b0e-0410-8428-c7bf67bfef74
  • Loading branch information
Hixie committed Aug 17, 2011
1 parent fd09f87 commit 255e425
Show file tree
Hide file tree
Showing 3 changed files with 206 additions and 20 deletions.
76 changes: 69 additions & 7 deletions complete.html
Expand Up @@ -239,7 +239,7 @@

<header class=head id=head><p><a class=logo href=http://www.whatwg.org/><img alt=WHATWG height=101 src=/images/logo width=101></a></p>
<hgroup><h1>Web Applications 1.0</h1>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 16 August 2011</h2>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 17 August 2011</h2>
</hgroup><dl><dt>Multiple-page version:</dt>
<dd><a href=http://www.whatwg.org/specs/web-apps/current-work/complete/>http://www.whatwg.org/specs/web-apps/current-work/complete/</a></dd>
<dt>One-page version:</dt>
Expand Down Expand Up @@ -10011,13 +10011,55 @@ <h4 id=semantics-0><span class=secno>3.2.1 </span>Semantics</h4>
the <code title=attr-lang><a href=#attr-lang>lang</a></code> attribute represents the
language of the content.</p>

<p>These definitions allow HTML processors, such as Web browsers or
search engines, to present and use documents and applications in a
wide variety of contexts that the author might not have
considered.</p>

<div class=example>

<p>As a simple example, consider a Web page written by an author
who only considered desktop computer Web browsers. Because HTML
conveys <em>meaning</em>, rather than presentation, the same page
can also be used by a small browser on a mobile phone, without any
change to the page. Instead of headings being in large letters as
on the desktop, for example, the browser on the mobile phone might
use the same size text for the whole the page, but with the
headings in bold.</p>

<p>But it goes further than just differences in screen size: the
same page could equally be used by a blind user using a browser
based around speech synthesis, which instead of displaying the page
on a screen, reads the page to the user, e.g. using headphones.
Instead of large text for the headings, the speech browser might
use a different volume or a slower voice.</p>

<p>That's not all, either. Since the browsers know which parts of
the page are the headings, they can create a document outline that
the user can use to quickly navigate around the document, using
keys for "jump to next heading" or "jump to previous heading". Such
features are especially common with speech browsers, where users
would otherwise find quickly navigating a page quite difficult.</p>

<p>Even beyond browsers, software can make use of this information.
Search engines can use the headings to more effectively index a
page, or to provide quick links to subsections of the page from
their results. Tools can use the headings to create a table of
contents (that is in fact how this very specification's table of
contents is generated).</p>

<p>This example has focused on headings, but the same principle
applies to all of the semantics in HTML.</p>

</div>

<p>Authors must not use elements, attributes, or attribute values
for purposes other than their appropriate intended semantic
purpose. Authors must not use elements, attributes, or attribute
values that are not permitted by this specification or <a href=#other-applicable-specifications>other
applicable specifications</a>.</p>
for purposes other than their appropriate intended semantic purpose,
as doing so prevents software from correctly processing the
page.</p>

<div class=example>

<p>For example, the following document is non-conforming, despite
being syntactically correct:</p>

Expand All @@ -10038,8 +10080,15 @@ <h4 id=semantics-0><span class=secno>3.2.1 </span>Semantics</h4>
&lt;/html&gt;</pre>

<p>...because the data placed in the cells is clearly not tabular
data (and the <code><a href=#the-cite-element>cite</a></code> element mis-used). A corrected
version of this document might be:</p>
data (and the <code><a href=#the-cite-element>cite</a></code> element mis-used). This would make
software that relies on these semantics fail: for example, a speech
browser that allowed a blind user to navigate tables in the
document would report the quote above as a table, confusing the
user; similarly, a tool that extracted titles of works from pages
would extract "Ernest" as the title of a work, even though it's
actually a person's name, not a title.</p>

<p>A corrected version of this document might be:</p>

<pre>&lt;!DOCTYPE HTML&gt;
&lt;html lang="en-GB"&gt;
Expand All @@ -10055,6 +10104,10 @@ <h4 id=semantics-0><span class=secno>3.2.1 </span>Semantics</h4>
&lt;/body&gt;
&lt;/html&gt;</pre>

</div>

<div class=example>

<p>This next document fragment, intended to represent the heading
of a corporate site, is similarly non-conforming because the second
line is not intended to be a heading of a subsection, but merely a
Expand All @@ -10076,6 +10129,15 @@ <h4 id=semantics-0><span class=secno>3.2.1 </span>Semantics</h4>
&lt;/hgroup&gt;
...</pre>

</div>

<p>Authors must not use elements, attributes, or attribute values
that are not permitted by this specification or <a href=#other-applicable-specifications>other
applicable specifications</a>, as doing so makes it significantly
harder for the language to be extended in the future.</p>

<div class=example>

<p>In the next example, there is a non-conforming attribute value
("carpet") and a non-conforming attribute ("texture"), which
is not permitted by this specification:</p>
Expand Down
76 changes: 69 additions & 7 deletions index
Expand Up @@ -243,7 +243,7 @@

<header class=head id=head><p><a class=logo href=http://www.whatwg.org/><img alt=WHATWG height=101 src=/images/logo width=101></a></p>
<hgroup><h1 class=allcaps>HTML</h1>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 16 August 2011</h2>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 17 August 2011</h2>
</hgroup><dl><dt><strong>Web developer edition</strong></dt>
<dd><strong><a href=http://developers.whatwg.org/>http://developers.whatwg.org/</a></strong></dd>
<dt>Multiple-page version:</dt>
Expand Down Expand Up @@ -9875,13 +9875,55 @@ interface <dfn id=xmldocumentloader>XMLDocumentLoader</dfn> {
the <code title=attr-lang><a href=#attr-lang>lang</a></code> attribute represents the
language of the content.</p>

<p>These definitions allow HTML processors, such as Web browsers or
search engines, to present and use documents and applications in a
wide variety of contexts that the author might not have
considered.</p>

<div class=example>

<p>As a simple example, consider a Web page written by an author
who only considered desktop computer Web browsers. Because HTML
conveys <em>meaning</em>, rather than presentation, the same page
can also be used by a small browser on a mobile phone, without any
change to the page. Instead of headings being in large letters as
on the desktop, for example, the browser on the mobile phone might
use the same size text for the whole the page, but with the
headings in bold.</p>

<p>But it goes further than just differences in screen size: the
same page could equally be used by a blind user using a browser
based around speech synthesis, which instead of displaying the page
on a screen, reads the page to the user, e.g. using headphones.
Instead of large text for the headings, the speech browser might
use a different volume or a slower voice.</p>

<p>That's not all, either. Since the browsers know which parts of
the page are the headings, they can create a document outline that
the user can use to quickly navigate around the document, using
keys for "jump to next heading" or "jump to previous heading". Such
features are especially common with speech browsers, where users
would otherwise find quickly navigating a page quite difficult.</p>

<p>Even beyond browsers, software can make use of this information.
Search engines can use the headings to more effectively index a
page, or to provide quick links to subsections of the page from
their results. Tools can use the headings to create a table of
contents (that is in fact how this very specification's table of
contents is generated).</p>

<p>This example has focused on headings, but the same principle
applies to all of the semantics in HTML.</p>

</div>

<p>Authors must not use elements, attributes, or attribute values
for purposes other than their appropriate intended semantic
purpose. Authors must not use elements, attributes, or attribute
values that are not permitted by this specification or <a href=#other-applicable-specifications>other
applicable specifications</a>.</p>
for purposes other than their appropriate intended semantic purpose,
as doing so prevents software from correctly processing the
page.</p>

<div class=example>

<p>For example, the following document is non-conforming, despite
being syntactically correct:</p>

Expand All @@ -9902,8 +9944,15 @@ interface <dfn id=xmldocumentloader>XMLDocumentLoader</dfn> {
&lt;/html&gt;</pre>

<p>...because the data placed in the cells is clearly not tabular
data (and the <code><a href=#the-cite-element>cite</a></code> element mis-used). A corrected
version of this document might be:</p>
data (and the <code><a href=#the-cite-element>cite</a></code> element mis-used). This would make
software that relies on these semantics fail: for example, a speech
browser that allowed a blind user to navigate tables in the
document would report the quote above as a table, confusing the
user; similarly, a tool that extracted titles of works from pages
would extract "Ernest" as the title of a work, even though it's
actually a person's name, not a title.</p>

<p>A corrected version of this document might be:</p>

<pre>&lt;!DOCTYPE HTML&gt;
&lt;html lang="en-GB"&gt;
Expand All @@ -9919,6 +9968,10 @@ interface <dfn id=xmldocumentloader>XMLDocumentLoader</dfn> {
&lt;/body&gt;
&lt;/html&gt;</pre>

</div>

<div class=example>

<p>This next document fragment, intended to represent the heading
of a corporate site, is similarly non-conforming because the second
line is not intended to be a heading of a subsection, but merely a
Expand All @@ -9940,6 +9993,15 @@ interface <dfn id=xmldocumentloader>XMLDocumentLoader</dfn> {
&lt;/hgroup&gt;
...</pre>

</div>

<p>Authors must not use elements, attributes, or attribute values
that are not permitted by this specification or <a href=#other-applicable-specifications>other
applicable specifications</a>, as doing so makes it significantly
harder for the language to be extended in the future.</p>

<div class=example>

<p>In the next example, there is a non-conforming attribute value
("carpet") and a non-conforming attribute ("texture"), which
is not permitted by this specification:</p>
Expand Down
74 changes: 68 additions & 6 deletions source
Expand Up @@ -10178,13 +10178,55 @@ interface <dfn>XMLDocumentLoader</dfn> {
the <code title="attr-lang">lang</code> attribute represents the
language of the content.</p>

<p>These definitions allow HTML processors, such as Web browsers or
search engines, to present and use documents and applications in a
wide variety of contexts that the author might not have
considered.</p>

<div class="example">

<p>As a simple example, consider a Web page written by an author
who only considered desktop computer Web browsers. Because HTML
conveys <em>meaning</em>, rather than presentation, the same page
can also be used by a small browser on a mobile phone, without any
change to the page. Instead of headings being in large letters as
on the desktop, for example, the browser on the mobile phone might
use the same size text for the whole the page, but with the
headings in bold.</p>

<p>But it goes further than just differences in screen size: the
same page could equally be used by a blind user using a browser
based around speech synthesis, which instead of displaying the page
on a screen, reads the page to the user, e.g. using headphones.
Instead of large text for the headings, the speech browser might
use a different volume or a slower voice.</p>

<p>That's not all, either. Since the browsers know which parts of
the page are the headings, they can create a document outline that
the user can use to quickly navigate around the document, using
keys for "jump to next heading" or "jump to previous heading". Such
features are especially common with speech browsers, where users
would otherwise find quickly navigating a page quite difficult.</p>

<p>Even beyond browsers, software can make use of this information.
Search engines can use the headings to more effectively index a
page, or to provide quick links to subsections of the page from
their results. Tools can use the headings to create a table of
contents (that is in fact how this very specification's table of
contents is generated).</p>

<p>This example has focused on headings, but the same principle
applies to all of the semantics in HTML.</p>

</div>

<p>Authors must not use elements, attributes, or attribute values
for purposes other than their appropriate intended semantic
purpose. Authors must not use elements, attributes, or attribute
values that are not permitted by this specification or <span>other
applicable specifications</span>.</p>
for purposes other than their appropriate intended semantic purpose,
as doing so prevents software from correctly processing the
page.</p>

<div class="example">

<p>For example, the following document is non-conforming, despite
being syntactically correct:</p>

Expand All @@ -10205,8 +10247,15 @@ interface <dfn>XMLDocumentLoader</dfn> {
&lt;/html&gt;</pre>

<p>...because the data placed in the cells is clearly not tabular
data (and the <code>cite</code> element mis-used). A corrected
version of this document might be:</p>
data (and the <code>cite</code> element mis-used). This would make
software that relies on these semantics fail: for example, a speech
browser that allowed a blind user to navigate tables in the
document would report the quote above as a table, confusing the
user; similarly, a tool that extracted titles of works from pages
would extract "Ernest" as the title of a work, even though it's
actually a person's name, not a title.</p>

<p>A corrected version of this document might be:</p>

<pre>&lt;!DOCTYPE HTML&gt;
&lt;html lang="en-GB"&gt;
Expand All @@ -10222,6 +10271,10 @@ interface <dfn>XMLDocumentLoader</dfn> {
&lt;/body&gt;
&lt;/html&gt;</pre>

</div>

<div class="example">

<p>This next document fragment, intended to represent the heading
of a corporate site, is similarly non-conforming because the second
line is not intended to be a heading of a subsection, but merely a
Expand All @@ -10243,6 +10296,15 @@ interface <dfn>XMLDocumentLoader</dfn> {
&lt;/hgroup&gt;
...</pre>

</div>

<p>Authors must not use elements, attributes, or attribute values
that are not permitted by this specification or <span>other
applicable specifications</span>, as doing so makes it significantly
harder for the language to be extended in the future.</p>

<div class="example">

<p>In the next example, there is a non-conforming attribute value
("carpet") and a non-conforming attribute ("texture"), which
is not permitted by this specification:</p>
Expand Down

0 comments on commit 255e425

Please sign in to comment.