Annotation of html5/spec/interactive-elements.html, revision 1.827
1.2 mike 1: <!DOCTYPE HTML>
1.252 mike 2: <!-- when publishing, change bits marked ZZZ --><html lang="en-US-x-Hixie"><head><title>4.11 Interactive elements — HTML 5</title><style type="text/css">
1.1 mike 3: pre { margin-left: 2em; white-space: pre-wrap; }
4: h2 { margin: 3em 0 1em 0; }
5: h3 { margin: 2.5em 0 1em 0; }
6: h4 { margin: 2.5em 0 0.75em 0; }
7: h5, h6 { margin: 2.5em 0 1em; }
8: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
9: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
10: p { margin: 1em 0; }
11: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
12: dl, dd { margin-top: 0; margin-bottom: 0; }
13: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
14: dt + dt { margin-top: 0; }
15: dd dt { margin-top: 0.25em; margin-bottom: 0; }
16: dd p { margin-top: 0; }
17: dd dl + p { margin-top: 1em; }
18: dd table + p { margin-top: 1em; }
19: p + * > li, dd li { margin: 1em 0; }
20: dt, dfn { font-weight: bold; font-style: normal; }
21: dt dfn { font-style: italic; }
22: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
23: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
24: pre em { font-weight: bolder; font-style: normal; }
25: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
26: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
27: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
28: table thead { border-bottom: solid; }
29: table tbody th:first-child { border-left: solid; }
1.469 mike 30: table tbody th { text-align: left; }
1.1 mike 31: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
32: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
33:
34: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
35: .matrix, .matrix td { border: none; text-align: right; }
36: .matrix { margin-left: 2em; }
37: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
38: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
39: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
40:
41: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
42: img.extra { float: right; }
43: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; }
44: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
45: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
46: pre.css:first-line { color: #AAAA50; }
47: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #EEFFEE; }
48: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
49: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
50: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
51: dl.domintro dd p { margin: 0.5em 0; }
52: dl.switch { padding-left: 2em; }
53: dl.switch > dt { text-indent: -1.5em; }
54: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
55: dl.triple { padding: 0 0 0 1em; }
56: dl.triple dt, dl.triple dd { margin: 0; display: inline }
57: dl.triple dt:after { content: ':'; }
58: dl.triple dd:after { content: '\A'; white-space: pre; }
59: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
60: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
61: a .diff-new { border-bottom: 1px blue solid; }
62:
63: h2 { page-break-before: always; }
64: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
65: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
66:
67: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]), li > span:not([title=""]):not([class="XXX"]):not([class="impl"]) { border-bottom: solid #9999CC; }
68:
69: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
70: div.head p { margin: 0; }
71: div.head h1 { margin: 0; }
72: div.head .logo { float: right; margin: 0 1em; }
73: div.head .logo img { border: none } /* remove border from top image */
74: div.head dl { margin: 1em 0; }
1.665 mike 75: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
1.1 mike 76:
77: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
78: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
79: body > .toc > li > * { margin-bottom: 0.5em; }
80: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
81: .toc, .toc li { list-style: none; }
82:
83: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
84: .brief li { margin: 0; padding: 0; }
85: .brief li p { margin: 0; padding: 0; }
86:
87: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
88: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
89: .category-list li { display: inline; }
90: .category-list li:not(:last-child)::after { content: ', '; }
91: .category-list li > span, .category-list li > a { text-transform: lowercase; }
92: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
93:
94: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
95: .XXX > :first-child { margin-top: 0; }
96: p .XXX { line-height: 3em; }
1.153 mike 97: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
98: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
99: .annotation :link, .annotation :visited { color: inherit; }
100: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
101: .annotation span { border: none ! important; }
1.1 mike 102: .note { color: green; background: transparent; font-family: sans-serif; }
103: .warning { color: red; background: transparent; }
104: .note, .warning { font-weight: bolder; font-style: italic; }
105: p.note, div.note { padding: 0.5em 2em; }
106: span.note { padding: 0 2em; }
107: .note p:first-child, .warning p:first-child { margin-top: 0; }
108: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
109: .warning:before { font-style: normal; }
110: p.note:before { content: 'Note: '; }
111: p.warning:before { content: '\26A0 Warning! '; }
112:
113: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
114: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
115: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
116:
117: h4 { position: relative; z-index: 3; }
118: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
119: .element {
120: background: #EEEEFF;
121: color: black;
122: margin: 0 0 1em 0.15em;
123: padding: 0 1em 0.25em 0.75em;
124: border-left: solid #9999FF 0.25em;
125: position: relative;
126: z-index: 1;
127: }
128: .element:before {
129: position: absolute;
130: z-index: 2;
131: top: 0;
132: left: -1.15em;
133: height: 2em;
134: width: 0.9em;
135: background: #EEEEFF;
136: content: ' ';
137: border-style: none none solid solid;
138: border-color: #9999FF;
139: border-width: 0.25em;
140: }
141:
1.143 mike 142: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
143: td > .example:only-child { margin: 0 0 0 0.1em; }
1.1 mike 144:
145: .tall-and-narrow {
146: font-size: 0.6em;
147: column-width: 25em;
148: column-gap: 1em;
149: -moz-column-width: 25em;
150: -moz-column-gap: 1em;
151: -webkit-column-width: 25em;
152: -webkit-column-gap: 1em;
153: }
154:
155: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
156: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
157: ul.domTree li li { list-style: none; }
158: ul.domTree li:first-child::before { position: absolute; top: 0; height: 0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
159: ul.domTree li:not(:last-child)::after { position: absolute; top: 0; bottom: -0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
160: ul.domTree span { font-style: italic; font-family: serif; }
161: ul.domTree .t1 code { color: purple; font-weight: bold; }
162: ul.domTree .t2 { font-style: normal; font-family: monospace; }
163: ul.domTree .t2 .name { color: black; font-weight: bold; }
164: ul.domTree .t2 .value { color: blue; font-weight: normal; }
165: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
166: ul.domTree .t7 code, .domTree .t8 code { color: green; }
167: ul.domTree .t10 code { color: teal; }
168:
1.730 mike 169: body.dfnEnabled dfn { cursor: pointer; }
170: .dfnPanel {
171: display: inline;
172: position: absolute;
173: z-index: 10;
174: height: auto;
175: width: auto;
176: padding: 0.5em 0.75em;
177: font: small sans-serif, Droid Sans Fallback;
178: background: #DDDDDD;
179: color: black;
180: border: outset 0.2em;
181: }
182: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
183: .dfnPanel :link, .dfnPanel :visited { color: black; }
184: .dfnPanel p { font-weight: bolder; }
185: .dfnPanel * + p { margin-top: 0.25em; }
186: .dfnPanel li { list-style-position: inside; }
187:
1.665 mike 188: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
189: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
190: #configUI p label { display: block; }
191: #configUI #updateUI, #configUI .loginUI { text-align: center; }
192: #configUI input[type=button] { display: block; margin: auto; }
1.261 mike 193: </style><style type="text/css">
194:
1.286 mike 195: .applies thead th > * { display: block; }
196: .applies thead code { display: block; }
197: .applies tbody th { whitespace: nowrap; }
198: .applies td { text-align: center; }
199: .applies .yes { background: yellow; }
200:
1.261 mike 201: .matrix, .matrix td { border: none; text-align: right; }
202: .matrix { margin-left: 2em; }
203:
204: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
205: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
206: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
207:
208: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
209: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
210: #table-example-1 caption { padding-bottom: 0.5em; }
211: #table-example-1 thead, #table-example-1 tbody { border: none; }
212: #table-example-1 th, #table-example-1 td { border: solid thin; }
213: #table-example-1 th { font-weight: normal; }
214: #table-example-1 td { border-style: none solid; vertical-align: top; }
215: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
216: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
217: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
218: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
219: #table-example-1 tbody td:first-child::after { content: leader(". "); }
220: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
221: #table-example-1 tbody td:first-child + td { width: 10em; }
222: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
223: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
224:
225: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
226: .apple-table-examples * { font-family: "Times", serif; }
227: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
228: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
229: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
230: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
231: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
232: .apple-table-examples td { text-align: right; vertical-align: top; }
233: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
234: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
235: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
236: .apple-table-examples sup { line-height: 0; }
237:
1.718 mike 238: .details-example img { vertical-align: top; }
239:
240: </style><link href="data:text/css," id="complete" rel="stylesheet" title="Complete specification"><link href="data:text/css,.impl%20%7B%20display:%20none;%20%7D" id="author" rel="alternate stylesheet" title="Author documentation only"><link href="data:text/css,.impl%20%7B%20background:%20%23FFEEEE;%20%7D" id="highlight" rel="alternate stylesheet" title="Highlight implementation requirements"><script type="text/javascript">
1.665 mike 241: function getCookie(name) {
242: var params = location.search.substr(1).split("&");
243: for (var index = 0; index < params.length; index++) {
244: if (params[index] == name)
245: return "1";
246: var data = params[index].split("=");
247: if (data[0] == name)
248: return unescape(data[1]);
249: }
250: var cookies = document.cookie.split("; ");
251: for (var index = 0; index < cookies.length; index++) {
252: var data = cookies[index].split("=");
253: if (data[0] == name)
254: return unescape(data[1]);
255: }
256: return null;
257: }
258: function load(script) {
259: var e = document.createElement('script');
260: e.setAttribute('src', 'http://www.whatwg.org/specs/web-apps/current-work/' + script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
261: document.body.appendChild(e);
262: }
263: function init() {
264: if (location.search == '?slow-browser')
265: return;
266: var configUI = document.createElement('div');
267: configUI.id = 'configUI';
268: document.body.appendChild(configUI);
269: // load('reviewer.js'); // would need cross-site XHR
270: if (document.getElementById('head'))
271: load('toc.js');
272: load('styler.js');
273: // load('updater.js'); // would need cross-site XHR
1.718 mike 274: load('dfn.js'); // doesn't support split-out specs, but, oh well.
1.665 mike 275: // load('status.js'); // would need cross-site XHR
276: if (getCookie('profile') == '1')
277: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
278: fixBrokenLink();
279: }
1.802 mike 280: </script><link href="http://www.w3.org/StyleSheets/TR/W3C-WD" rel="stylesheet" type="text/css">
1.2 mike 281: <script src="link-fixup.js"></script>
282: <link href="forms.html" title="4.10 Forms" rel="prev">
283: <link href="spec.html#contents" title="Table of contents" rel="index">
1.749 mike 284: <link href="browsers.html" title="5 Loading Web pages" rel="next">
1.665 mike 285: </head><body onload="fixBrokenLink(); init()"><div class="head" id="head">
1.1 mike 286: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
1.177 mike 287: <h1>HTML5</h1>
1.1 mike 288: <h2 class="no-num no-toc" id="a-vocabulary-and-associated-apis-for-html-and-xhtml">A vocabulary and associated APIs for HTML and XHTML</h2>
1.117 mike 289: </div><nav>
1.1 mike 290: <a href="forms.html">← 4.10 Forms</a> –
1.2 mike 291: <a href="spec.html#contents">Table of contents</a> –
1.749 mike 292: <a href="browsers.html">5 Loading Web pages →</a>
1.827 ! mike 293: </nav><p>This is revision 1.3827.</p>
1.653 mike 294:
1.1 mike 295:
1.765 mike 296: <h3 id="interactive-elements"><span class="secno">4.11 </span>Interactive elements</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><h4 id="the-details-element"><span class="secno">4.11.1 </span>The <dfn><code>details</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/93">ISSUE-93</a> (details) blocks progress to Last Call</span></p><dl class="element"><dt>Categories</dt>
1.153 mike 297: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
1.518 mike 298: <dd><a href="semantics.html#sectioning-root">Sectioning root</a>.</dd>
1.153 mike 299: <dd><a href="embedded-content-0.html#interactive-content">Interactive content</a>.</dd>
1.1 mike 300: <dt>Contexts in which this element may be used:</dt>
1.153 mike 301: <dd>Where <a href="dom.html#flow-content">flow content</a> is expected.</dd>
1.1 mike 302: <dt>Content model:</dt>
1.729 mike 303: <dd>One <code><a href="#the-summary-element">summary</a></code> element followed by <a href="dom.html#flow-content">flow content</a>.</dd>
1.1 mike 304: <dt>Content attributes:</dt>
305: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
306: <dd><code title="attr-details-open"><a href="#attr-details-open">open</a></code></dd>
307: <dt>DOM interface:</dt>
308: <dd>
309: <pre class="idl">interface <dfn id="htmldetailselement">HTMLDetailsElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
310: attribute boolean <a href="#dom-details-open" title="dom-details-open">open</a>;
311: };</pre>
312: </dd>
1.307 mike 313: </dl><p>The <code><a href="#the-details-element">details</a></code> element <a href="the-xhtml-syntax.html#represents">represents</a> a
314: disclosure widget from which the user can obtain additional
315: information or controls.</p><p class="note">The <code><a href="#the-details-element">details</a></code> element is not appropriate
1.299 mike 316: for footnotes. Please see <a href="#footnotes">the section on
1.729 mike 317: footnotes</a> for details on how to mark up footnotes.</p><p>The <span class="impl">first</span> <code><a href="#the-summary-element">summary</a></code> element
318: child of the element, if any, <a href="the-xhtml-syntax.html#represents">represents</a> the summary or
319: legend of the details. <span class="impl">If there is no child
320: <code><a href="#the-summary-element">summary</a></code> element, the user agent should provide its own
321: legend (e.g. "Details").</span></p><p>The <dfn id="attr-details-open" title="attr-details-open"><code>open</code></dfn>
1.1 mike 322: content attribute is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a>. If present,
323: it indicates that the details are to be shown to the user. If the
1.117 mike 324: attribute is absent, the details are not to be shown.</p><div class="impl">
1.1 mike 325:
326: <p>If the attribute is removed, then the details should be
327: hidden. If the attribute is added, the details should be shown.</p>
328:
329: <p>The user agent should allow the user to request that the details
330: be shown or hidden. To honor a request for the details to be shown,
331: the user agent must set the <code title="attr-details-open"><a href="#attr-details-open">open</a></code> attribute on the element to
332: the value <code title="">open</code>. To honor a request for the
333: details to be hidden, the user agent must remove the <code title="attr-details-open"><a href="#attr-details-open">open</a></code> attribute from the
334: element.</p>
335:
336: <p>The <dfn id="dom-details-open" title="dom-details-open"><code>open</code></dfn>
337: attribute must <a href="infrastructure.html#reflect">reflect</a> the <code title="attr-details-open"><a href="#attr-details-open">open</a></code> content attribute.</p>
338:
1.271 mike 339: </div><div class="example">
340:
341: <p>The following example shows the <code><a href="#the-details-element">details</a></code> element
342: being used to hide technical details in a progress report.</p>
343:
344: <pre><section class="progress window">
345: <h1>Copying "Really Achieving Your Childhood Dreams"</h1>
346: <details>
1.729 mike 347: <summary>Copying... <progress max="375505392" value="97543282"></progress> 25%</summary>
348: <dl>
349: <dt>Transfer rate:</dt> <dd>452KB/s</dd>
350: <dt>Local filename:</dt> <dd>/home/rpausch/raycd.m4v</dd>
351: <dt>Remote filename:</dt> <dd>/var/www/lectures/raycd.m4v</dd>
352: <dt>Duration:</dt> <dd>01:16:27</dd>
353: <dt>Color profile:</dt> <dd>SD (6-1-6)</dd>
354: <dt>Dimensions:</dt> <dd>320×240</dd>
355: </dl>
1.271 mike 356: </details>
357: </section></pre>
358:
1.718 mike 359: </div><div class="example">
360:
361: <p>The following shows how a <code><a href="#the-details-element">details</a></code> element can be
362: used to hide some controls by default:</p>
363:
364: <pre><details>
1.729 mike 365: <summary>Name & Extension:</summary>
366: <p><input type=text name=fn value="Pillar Magazine.pdf">
367: <p><label><input type=checkbox name=ext checked> Hide extension</label>
1.718 mike 368: </details></pre>
369:
370: <p>One could use this in conjuction with other <code><a href="#the-details-element">details</a></code>
371: in a list to allow the user to collapse a set of fields down to a
372: small set of headings, with the ability to open each one.</p>
373:
374: <p class="details-example"><img alt="" src="http://dev.w3.org/html5/spec/images/sample-details-1.png"><img alt="" src="http://dev.w3.org/html5/spec/images/sample-details-2.png"></p>
375:
1.729 mike 376: <p>In these examples, the summary really just summarises what the
377: controls can change, and not the actual values, which is less than
378: ideal.</p>
379:
380: </div><h4 id="the-summary-element"><span class="secno">4.11.2 </span>The <dfn><code>summary</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
381: <dd>None.</dd>
382: <dt>Contexts in which this element may be used:</dt>
383: <dd>As the first child of a <code><a href="#the-details-element">details</a></code> element.</dd>
384: <dt>Content model:</dt>
385: <dd><a href="dom.html#phrasing-content">Phrasing content</a>.</dd>
386: <dt>Content attributes:</dt>
387: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
388: <dt>DOM interface:</dt>
389: <dd>Uses <code><a href="dom.html#htmlelement">HTMLElement</a></code>.</dd>
390: </dl><p>The <code><a href="#the-summary-element">summary</a></code> element <a href="the-xhtml-syntax.html#represents">represents</a> a
391: summary, caption, or legend for the rest of the contents of the
392: <code><a href="#the-summary-element">summary</a></code> element's parent <code><a href="#the-details-element">details</a></code>
393: element<span class="impl">, if any</span>.</p><!-- v2DATAGRID
1.80 mike 394: <h4 id="datagrid">The <dfn><code>datagrid</code></dfn> element</h4>
395:
396: <dl class="element">
397: <dt>Categories</dt>
398: <dd><span>Flow content</span>.</dd>
399: <dd><span>Interactive content</span>.</dd>
400: <dd><span>Sectioning root</span>.</dd>
1.1 mike 401: <dt>Contexts in which this element may be used:</dt>
1.80 mike 402: <dd>Where <span>flow content</span> is expected.</dd>
1.1 mike 403: <dt>Content model:</dt>
1.80 mike 404: <dd><span>Flow content</span>.</dd>
1.1 mike 405: <dt>Content attributes:</dt>
1.80 mike 406: <dd><span>Global attributes</span></dd>
407: <!- -v2DGS:
1.1 mike 408: <dd><code title="attr-datagrid-multiple">multiple</code></dd>
1.80 mike 409: - ->
410: <dd><code title="attr-datagrid-disabled">disabled</code></dd>
1.1 mike 411: <dt>DOM interface:</dt>
412: <dd>
1.80 mike 413: <pre class="idl">interface <dfn>HTMLDataGridElement</dfn> : <span>HTMLElement</span> {
414: <!- -v2DGS:
1.1 mike 415: attribute boolean <span title="dom-datagrid-multiple">multiple</span>;
1.80 mike 416: - -> attribute boolean <span title="dom-datagrid-disabled">disabled</span>;
417: attribute <span>DataGridListener</span> <span title="dom-datagrid-listener">listener</span>;
418: <!- - v2DGS:
1.1 mike 419: readonly attribute <span>DataGridSelection</span> <span title="dom-datagrid-selection">selection</span>;
1.80 mike 420: - ->
1.1 mike 421: // columns
1.395 mike 422: void <span title="dom-datagrid-addColumn">addColumn</span>(in <span>Column</span> id, in DOMString label, in DOMString type, in optional HTMLImageElement icon, in optional boolean sortable, in optional boolean hidden);
1.80 mike 423: attribute DOMString <span title="dom-datagrid-sortColumn">sortColumn</span>;
424: attribute boolean <span title="dom-datagrid-sortAscending">sortAscending</span>;
425: void <span title="dom-datagrid-clearColumns">clearColumns</span>();
1.1 mike 426:
427: // rows
1.80 mike 428: void <span title="dom-datagrid-renotify">renotify</span>();
429: void <span title="dom-datagrid-setRowCount">setRowCount</span>(in long childCount, in long rowCount);
430: void <span title="dom-datagrid-setRows">setRows</span>(in <span>RowList</span> rows);
431: void <span title="dom-datagrid-insertRows">insertRows</span>(in <span>RowList</span> rows);
432: void <span title="dom-datagrid-deleteRows">deleteRows</span>(in <span>RowIDList</span> rows);
433: void <span title="dom-datagrid-repaint">repaint</span>(in <span>RowID</span> row, in DOMString column);
434: void <span title="dom-datagrid-clearRows">clearRows</span>();
435: <!- -
1.1 mike 436: v2: opening and closing a row
437: moving a row's actual ID
438: - imagine new mail moving a thread up; you just want to add the new mail to the thread and move the thread's first mail to the top
439: - though actually that should probably just be done using display sorting
1.80 mike 440: - ->
1.1 mike 441: };
442:
1.80 mike 443: typedef DOMString <dfn>Column</dfn>;
444: typedef sequence<<span>Column</span>> <dfn>ColumnList</dfn>;
1.81 mike 445: typedef sequence<any> <dfn>Cell</dfn>; // <span>Column</span>, any... (exact types expected depend on the column type)
1.80 mike 446: typedef sequence<<span>Cell</span>> <dfn>CellList</dfn>;
1.81 mike 447: typedef sequence<any> <dfn>Row</dfn>; // <span>RowID</span>, long, long, <span>CellList</span>, optional boolean, optional long
1.80 mike 448: typedef sequence<<span>Row</span>> <dfn>RowList</dfn>;
449: typedef sequence<unsigned long> <dfn>RowID</dfn>;
450: typedef sequence<<span>RowID</span>> <dfn>RowIDList</dfn>;
1.1 mike 451:
452: [Callback=FunctionOnly, NoInterfaceObject]
1.80 mike 453: interface <dfn>RenderingContext2DCallback</dfn> {
454: DOMString <span title="dom-Rendering2DContextCallback-handleEvent">handleEvent</span>(in <span>CanvasRenderingContext2D</span> context, in unsigned long width, in unsigned long height);
1.1 mike 455: };</pre>
456: </dd>
1.80 mike 457: </dl>
458:
459: <!- - v2:
460: * datagrid: cells that are links (<a href=""></a>)
461: - ->
462:
463: <p>The <code>datagrid</code> element <span>represents</span> an
464: interactive representation of tree, list, or tabular data.</p>
465:
466: <p>The data being presented is provided by script using the methods
467: described in the following sections.</p>
468:
469: <!- -v2DGS:
1.1 mike 470: <p>The <dfn
471: title="attr-datagrid-multiple"><code>multiple</code></dfn> attribute
472: is a <span>boolean attribute</span>. When set, it indicates that the
473: user can select more than one row at a time.</p>
1.80 mike 474: - ->
475:
476: <p>The <dfn
477: title="attr-datagrid-disabled"><code>disabled</code></dfn> attribute
478: is a <span>boolean attribute</span> used to disable the
1.1 mike 479: control. <span class="impl">When the attribute is set, the user
1.80 mike 480: agent must disable the <code>datagrid</code>, preventing the user
481: from interacting with it. The <code>datagrid</code> element should
1.1 mike 482: still continue to update itself when the underlying data changes,
483: though, as described in the next few sections. However, conformance
1.80 mike 484: requirements stating that <code>datagrid</code> elements must react
1.1 mike 485: to users in particular ways do not apply when the
1.80 mike 486: <code>datagrid</code> is disabled.</span></p>
487:
488: <div class="impl">
1.1 mike 489:
1.80 mike 490: <!- -vsDGS: multiple - ->
1.1 mike 491:
1.80 mike 492: <p>The <dfn
1.186 mike 493: title="dom-datagrid-disabled"><code>disabled</code></dfn> IDL
1.80 mike 494: attribute must <span>reflect</span> the content attribute of the
1.1 mike 495: same name.</p>
496:
1.80 mike 497: </div>
498:
499: <!- - v2DGPA: One possible thing to be added is a way to detect when a
1.1 mike 500: row/selection has been deleted, activated, etc, by the user (delete
1.80 mike 501: key, enter key, etc). (v2DGPA = <datagrid> Perform Action) - ->
502:
503:
504: <h5>Introduction</h5>
505:
506: <p><i>This section is non-normative.</i></p>
507:
508: <p>In the <code>datagrid</code> data model, data is structured as a
1.1 mike 509: set of rows representing a tree, each row being split into a number
510: of columns. The columns are always present in the data model,
1.80 mike 511: although individual columns might be hidden in the presentation.</p>
512:
513: <hr>
514:
515: <p>Each row can have child rows. Child rows may be hidden or
516: shown, by closing or opening (respectively) the parent row.</p>
517:
518: <p>Rows are referred to by the path along the tree that one would
1.1 mike 519: take to reach the row, using zero-based indices. Thus, the first row
520: of a list is row "0", the second row is row "1"; the first child row
521: of the first row is row "0,0", the second child row of the first row
522: is row "0,1"; the fourth child of the seventh child of the third
1.80 mike 523: child of the tenth row is "9,2,6,3", etc.</p>
524:
525: <p>The chains of numbers that give a row's path, or identifier, are
1.1 mike 526: represented by arrays of positions, represented in IDL by the
1.80 mike 527: <span>RowID</span> interface.</p>
528:
529: <p>The root of the tree is represented by an empty array.</p>
530:
531: <hr>
532:
533: <p>Each column has a string that is used to identify it in the API,
1.1 mike 534: a label that is shown to users interacting with the column, a type,
1.80 mike 535: and optionally an icon.</p>
536:
537: <p>The possible types are as follows:</p>
538:
539: <table>
540: <thead>
541: <tr>
542: <td>Keyword
543: <td>Description
544: <tbody>
545: <tr>
546: <td><code title="datagrid-type-text">text</code>
547: <td>Simple text.
548: <tr>
549: <td><code title="datagrid-type-editable">editable</code>
550: <td>Editable text.
551: <tr>
552: <td><code title="datagrid-type-checkable">checkable</code>
553: <td>Text with a check box.
554: <tr>
555: <td><code title="datagrid-type-list">list</code>
556: <td>A list of values that the user can switch between.
557: <tr>
558: <td><code title="datagrid-type-progress">progress</code>
559: <td>A progress bar.
560: <tr>
561: <td><code title="datagrid-type-meter">meter</code>
562: <td>A gauge.
563: <tr>
564: <td><code title="datagrid-type-custom">custom</code>
565: <td>A canvas onto which arbitrary content can be drawn.
566: </table>
567:
568: <p>Each column can be flagged as sortable, in which case the user
569: will be able to sort the view using that column.</p>
570:
571: <p>Columns are not necessarily visible. A column can be created
1.1 mike 572: invisible by default. The user can select which columns are to be
1.80 mike 573: shown.</p>
574:
575: <p>When no columns have been added to the <code>datagrid</code>, a
1.1 mike 576: column with no name, whose identifier is the empty string, whose
1.80 mike 577: type is <code title="datagrid-type-text">text</code>, and which is
1.1 mike 578: not sortable, is implied. This column is removed if any explicit
1.80 mike 579: columns are declared.</p>
580:
581: <p>Each cell uses the type given for its column, so all cells in a
582: column present the same type of information.</p>
583:
584: <!- -v2DGS:
1.1 mike 585: <p>Selection of data in a <code>datagrid</code> operates at the row
586: level. If the <code title="attr-datagrid-multiple">multiple</code>
587: attribute is present, multiple rows can be selected at once,
588: otherwise the user can only select one row at a time.</p>
1.80 mike 589: - ->
590:
591: <!- - v2DGDND: selection should draggable to and from datagrids - ->
592:
593:
594: <h6>Example: a <code>datagrid</code> backed by a static <code>table</code> element</h6>
595:
596: ...
597:
598:
599: <h6>Example: a <code>datagrid</code> backed by nested <code>ol</code> elements</h6>
600:
601: ...
602:
603:
604: <h6>Example: a <code>datagrid</code> backed by a server</h6>
605:
606: ...
607:
608:
609: <h5>Populating the <code>datagrid</code></h5>
610:
611: <dl class="domintro">
612:
613: <dt><var title="">datagrid</var> . <code title="dom-datagrid-listener">listener</code> [ = <var title="">value</var> ]</dt>
1.1 mike 614: <dd>
615:
616: <p>Return the current object that is configured as the
1.80 mike 617: <code>datagrid</code> listener, if any. Returns null if there is
1.1 mike 618: none.</p>
619:
620: <p>The listener is an object provided by the script author that
1.80 mike 621: receives notifications when the <code>datagrid</code> needs row
1.1 mike 622: data to render itself, when the user opens and closes rows with
623: children, when the user edits a cell, and when the user invokes a
1.80 mike 624: row's context menu. (The <code>DataGridListener</code> interface
1.1 mike 625: used for this purpose is described in the next section.)</p>
626:
627: <p>Can be set, to change the current listener.</p>
628:
629: </dd>
630:
631:
1.80 mike 632: <dt><var title="">datagrid</var> . <code title="dom-datagrid-renotify">renotify</code>()</dt>
1.1 mike 633: <dd>
634:
1.80 mike 635: <p>Causes the <code>datagrid</code> to resend notifications to the
1.1 mike 636: listener (if any) for any rows or cells that the
1.80 mike 637: <code>datagrid</code> does not yet have information for.</p>
1.1 mike 638:
1.80 mike 639: <!- - useful, e.g., if there is a server error and the script loses
640: track of what rows it's supposed to be reporting. - ->
1.1 mike 641:
642: </dd>
643:
644:
1.80 mike 645: <dt><var title="">datagrid</var> . <code title="dom-datagrid-addColumn">addColumn</code>(<var title="">id</var>, <var title="">label</var>, <var title="">type</var> [, <var title="">icon</var> [, <var title="">sortable</var> [, <var title="">hidden</var> ] ] ] )</dt>
1.1 mike 646: <dd>
647:
1.80 mike 648: <p>Adds a column to the <code>datagrid</code>.</p>
1.1 mike 649:
650: <p>If a column with the given identifier has already been added,
651: it just replaces the information for that column.</p>
652:
653: <p>The possible types are enumerated in the previous section.</p>
654:
655: </dd>
656:
657:
1.80 mike 658: <dt><var title="">datagrid</var> . <code title="dom-datagrid-sortColumn">sortColumn</code> [ = <var title="">value</var> ]</dt>
1.1 mike 659: <dd>
660:
661: <p>Returns the identifier of the column by which the data is to be
662: sorted.</p>
663:
664: <p>Can be set, to indicate that the sort order has changed. This
1.80 mike 665: will cause the <code>datagrid</code> to clear its position
666: information for rows, so <code
667: title="dom-datagrid-setRows">setRows()</code> will have to be
1.1 mike 668: called again with the new sort order.</p>
669:
670: <p>The columns are not actually sorted by the
1.80 mike 671: <code>datagrid</code>; the data has to be sorted by the script
672: that adds the rows to the <code>datagrid</code>.</p>
1.1 mike 673:
674: </dd>
675:
676:
1.80 mike 677: <dt><var title="">datagrid</var> . <code title="dom-datagrid-sortAscending">sortAscending</code> [ = <var title="">value</var> ]</dt>
1.1 mike 678: <dd>
679:
680: <p>Returns true if the data is to be sorted with smaller values
681: first; otherwise, returns false, indicating that bigger values are
682: to be put first.</p>
683:
684: <p>Can be set, to indicate that the order is about to change.</p>
685:
686: </dd>
687:
688:
1.80 mike 689: <dt><var title="">datagrid</var> . <code title="dom-datagrid-clearColumns">clearColumns</code>()</dt>
1.1 mike 690: <dd>
691:
1.80 mike 692: <p>Removes all the columns in the <code>datagrid</code>,
1.1 mike 693: reinstating the implied column.</p>
694:
695: </dd>
696:
697:
1.80 mike 698: <dt><var title="">datagrid</var> . <code title="dom-datagrid-setRowCount">setRowCount</code>(<var title="">childCount</var>, <var title="">rowCount</var>)</dt>
1.1 mike 699: <dd>
700:
1.80 mike 701: <p>Sets the numbers of rows in the <code>datagrid</code>,
1.1 mike 702: excluding rows that are descendants of rows that are closed.</p>
703:
1.80 mike 704: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 705: arguments contradict each other or previously declared information
1.80 mike 706: (e.g. declaring that the <code>datagrid</code> has three rows when
1.1 mike 707: the 12th row has been declared).</p>
708:
709: </dd>
710:
711:
1.80 mike 712: <dt><var title="">datagrid</var> . <code title="dom-datagrid-setRows">setRows</code>(<var title="">rows</var>)</dt>
1.1 mike 713: <dd>
714:
1.80 mike 715: <p>Updates data for rows in the <code>datagrid</code>, or fills in
716: data for rows previously implied by a call to <code
717: title="dom-datagrid-setRowCount">setRowCount()</code> but not
1.1 mike 718: previously declared.</p>
719:
720: <p>The <var title="">rows</var> argument is an array of rows, each
721: represented by a further array consisting of:</p>
722:
1.80 mike 723: <ol class="brief">
724:
725: <li>A <code>RowID</code> object identifying the row.</li>
1.1 mike 726:
727: <li>An integer giving the position of the row in its parent,
1.80 mike 728: given the current sort order, or −1 to set other row data
1.1 mike 729: without setting a position or changing a previously declared
730: position.</li>
731:
732: <li>An integer giving the number of children of the row, or 0 if
1.80 mike 733: the row has no children, or −1 if the row has children but
1.1 mike 734: the count is currently unknown. If the number of children has
735: already been set to 0 or a positive integer, then passing
1.80 mike 736: −1 leaves the previous count unchanged.</li>
1.1 mike 737:
738: <li>An array giving the data for zero or more cells in the row,
739: as described below.</li>
740:
741: <li>A boolean declaring whether the row is open or not. This
742: entry, if omitted, is assumed to be false (closed), unless the
743: row has already been declared as open.</li>
744:
745: <li>An integer giving the number of rows that are descendants of
746: this row, excluding those that are descendants of descendants of
747: this row that are closed. This entry can be omitted if the row is
748: closed or if it has already been declared.</li>
749:
1.80 mike 750: </ol>
751:
752: <p>The array giving the data for the cells in the row consists of
1.1 mike 753: a further set of arrays, one per cell. The first item of each of
754: these arrays is the column's identifier; the subsequent values
755: vary based on the type of the column, as follows:</p>
756:
1.80 mike 757: <dl>
758:
759: <dt><code title="datagrid-type-text">text</code></dt>
1.1 mike 760: <dd>
1.80 mike 761: <ol class="brief">
762: <li>A string giving the cell's value.
763: <li>Optionally, an <code>img</code> element giving an icon for the cell.
764: </ol>
765: </dd>
1.1 mike 766:
1.80 mike 767: <dt><code title="datagrid-type-editable">editable</code></dt>
1.1 mike 768: <dd>
1.80 mike 769: <ol class="brief">
770: <li>A string giving the cell's value.
771: <li>Optionally, a <code>datalist</code> element giving a set of predefined options.
772: <li>Optionally, an <code>img</code> element giving an icon for the cell.
773: </ol>
774: </dd>
1.1 mike 775:
1.80 mike 776: <dt><code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 777: <dd>
1.80 mike 778: <ol class="brief">
779: <li>A string giving the cell's value.
780: <li>A boolean, indicating whether the cell is checked (true) or not (false).
781: <li>Optionally, a boolean indicating whether the value of the cell is obscured as indeterminate (true), or not (false).
782: <li>Optionally, an <code>img</code> element giving an icon for the cell.
783: </ol>
784: </dd>
1.1 mike 785:
1.80 mike 786: <dt><code title="datagrid-type-list">list</code></dt>
1.1 mike 787: <dd>
1.80 mike 788: <ol class="brief">
789: <li>A string giving the cell's current value.
790: <li>A <code>select</code> element giving the <span title="concept-select-option-list">list of options</span>.
791: <li>Optionally, an <code>img</code> element giving an icon for the cell.
792: </ol>
793: </dd>
1.1 mike 794:
1.80 mike 795: <dt><code title="datagrid-type-progress">progress</code></dt>
1.1 mike 796: <dd>
1.80 mike 797: <ol class="brief">
798: <li>A value in the range 0.0 (no progress) to 1.0 (task complete).
799: </ol>
800: </dd>
1.1 mike 801:
1.80 mike 802: <dt><code title="datagrid-type-meter">meter</code></dt>
1.1 mike 803: <dd>
1.80 mike 804: <ol class="brief">
805: <li>A number giving the cell's value.
806: <li>Optionally, a number giving the maximum value, if it's not 1.
807: <li>Optionally, a number giving the minimum value, if it's not 0.
808: <li>Optionally, a number giving the highest value that is considered "low".
809: <li>Optionally, a number giving the lowest value that is considered "high".
810: <li>Optionally, a number giving the value that is considered optimal.
811: </ol>
812: </dd>
1.1 mike 813:
1.80 mike 814: <dt><code title="datagrid-type-custom">custom</code></dt>
1.1 mike 815: <dd>
1.80 mike 816: <ol class="brief">
817: <li>A number giving the minimum width of the cell, in CSS pixels, that is desired.
818: <li>A number giving the minimum height of the cell, in CSS pixels, that is desired.
819: <li>A function that is passed a <code>CanvasRenderingContext2D</code> object, along with the width and height (in CSS pixels) of the cell that the context will draw on.
820: </ol>
821: </dd>
822:
823: </dl>
1.1 mike 824:
1.80 mike 825: <p>While the rows in a single call to the <code
826: title="dom-datagrid-setRows">setRows()</code> method can be in any
1.1 mike 827: order, for each row, it is important that all its ancestor rows
828: and all its open previous siblings are also declared, either in
829: the same call or in an earlier one.</p>
830:
1.80 mike 831: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 832: arguments contradict each other or previously declared information
833: (e.g. saying that a row's position is 5 when the parent row only
834: has 3 children, or naming a column that doesn't exist, or
835: declaring a row without declaring its parent, or changing the
836: number of children that a row has while that row and its ancestors
837: are all open).</p>
838:
839: </dd>
840:
841:
1.80 mike 842: <dt><var title="">datagrid</var> . <code title="dom-datagrid-insertRows">insertRows</code>(<var title="">rows</var>)</dt>
1.1 mike 843: <dd>
844:
1.80 mike 845: <p>Inserts the given rows into the <code>datagrid</code>,
846: increasing the numbers of rows that the <code>datagrid</code>
1.1 mike 847: assumes are present.</p>
848:
849: <p>The <var title="">rows</var> argument is an array of rows in
1.80 mike 850: the same structure as the argument to the <code
851: title="dom-datagrid-setRows">setRows()</code> method described
1.1 mike 852: above, with the same expectations of consistency (a given row's
853: ancestors and earlier open siblings being listed either earlier or
1.80 mike 854: in the same call as a given row). However, unlike with the <code
855: title="dom-datagrid-setRows">setRows()</code> method, if a row is
1.1 mike 856: inserted along with its child, the child is not included in the
1.80 mike 857: child and row counts of the parent row; every row in the <var
858: title="">rows</var> argument will increase its parent's counts
1.1 mike 859: automatically.</p>
860:
1.80 mike 861: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 862: arguments contradict each other or previously declared
863: information.</p>
864:
865: </dd>
866:
867:
1.80 mike 868: <dt><var title="">datagrid</var> . <code title="dom-datagrid-deleteRows">deleteRows</code>(<var title="">rows</var>)</dt>
1.1 mike 869: <dd>
870:
1.80 mike 871: <p>Removes the given rows from the <code>datagrid</code>, and
1.1 mike 872: updates the number of rows known to be in the
1.80 mike 873: <code>datagrid</code> accordingly. The argument is an array of
874: <code>RowID</code> objects identifying the rows to remove.</p>
1.1 mike 875:
1.80 mike 876: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the argument
877: includes a row the <code>datagrid</code> doesn't know about.</p>
878: <!- - since otherwise behaviour might depend on where the user
879: scrolled! - ->
1.1 mike 880:
881: </dd>
882:
883:
1.80 mike 884: <dt><var title="">datagrid</var> . <code title="dom-datagrid-repaint">repaint</code>(<var title="">row</var>, <var title="">column</var>)</dt>
1.1 mike 885: <dd>
886:
1.80 mike 887: <p>If the given column's type is <code
888: title="datagrid-type-custom">custom</code>, then causes the
889: <code>datagrid</code> to reinvoke the function that obtains the
1.1 mike 890: desired rendering.</p>
891:
892: </dd>
893:
894:
1.80 mike 895: <dt><var title="">datagrid</var> . <code title="dom-datagrid-clearRows">clearRows</code>()</dt>
1.1 mike 896: <dd>
897:
1.80 mike 898: <p>Clears the <code>datagrid</code> of all row data, resetting it
899: to empty<!- - v2DGS:, and clears the selection- ->.</p>
1.1 mike 900:
901: </dd>
902:
1.80 mike 903: </dl>
904:
905:
906: <div class="impl">
1.1 mike 907:
1.80 mike 908: <h6>The listener</h6>
1.1 mike 909:
1.80 mike 910: <p>The <dfn
1.186 mike 911: title="dom-datagrid-listener"><code>listener</code></dfn> IDL
1.1 mike 912: attribute allows authors to specify an object that will receive all
1.80 mike 913: the notifications from the <code>datagrid</code>. Initially, its
1.1 mike 914: value must be null. On getting, it must return its value. On
915: setting, its value must be set to the new value, and then the user
1.80 mike 916: agent must <span>queue a task</span> to call the <code
917: title="dom-listener-initialize">initialize()</code> method with the
918: <code>datagrid</code> element as its only argument.</p>
1.1 mike 919:
920:
1.80 mike 921: <h6>The columns</h6>
1.1 mike 922:
1.80 mike 923: <p>The columns are represented by the <dfn>column list</dfn>, an
1.1 mike 924: ordered list of entries for columns, each of which consists of:</p>
925:
1.80 mike 926: <dl>
927:
928: <dt>An identifier</dt>
1.1 mike 929:
930: <dd>A string used to identify the column in the API.</dd>
931:
932: <dt>A label</dt>
933:
934: <dd>A string used in the user interface.</dd>
935:
936: <dt>A type</dt>
937:
938: <dd>One of the types described below.</dd>
939:
940: <dt>An icon</dt>
941:
1.80 mike 942: <dd>An image, copied from an <code>img</code> element when the
1.1 mike 943: column was declared.</dd>
944:
945: <dt>Whether the column is sortable</dt>
946:
947: <dd>A boolean indicating whether the user can request that the data
948: be sorted by this column (true), or not (false).</dd>
949:
950: <dt>Whether the column is visible</dt>
951:
952: <dd>A boolean indicating whether the column is part of the
1.80 mike 953: <code>datagrid</code>'s rendering.</dd>
1.1 mike 954:
1.80 mike 955: </dl>
956:
957: <p>Initially, the <span>column list</span> must have a single
958: column, the <dfn>default column</dfn>, whose identifier is the empty
959: string, whose label is the empty string, whose type is <code
960: title="datagrid-type-text">text</code>, with no icon, which is not
1.1 mike 961: sortable, and which <em>is</em> visible.</p>
962:
1.80 mike 963: <hr>
964:
965: <p>The <dfn title="dom-datagrid-addColumn"><code>addColumn(<var
966: title="">id</var>, <var title="">label</var>, <var
967: title="">type</var>, <var title="">icon</var>, <var
968: title="">sortable</var>, <var title="">hidden</var>)</code></dfn>
1.1 mike 969: method must run the following steps:</p>
970:
1.80 mike 971: <ol>
972:
973: <li><p>If there is already an entry in <span>column list</span>,
974: other than the <span>default column</span>, whose identifier is
975: <var title="">id</var>, throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 976: exception and abort these steps.</p></li>
977:
978: <li>
979:
980: <p>If <var title="">type</var> is not a string equal to one of the
1.80 mike 981: <span>allowed <code>datagrid</code> column types</span>, then
982: throw a <code>DATAGRID_MODEL_ERR</code> exception and abort these
1.1 mike 983: steps.</p>
984:
985: </li>
986:
987: <li><p>If the <var title="">icon</var> argument is present and not
1.80 mike 988: null, but the given <code>img</code> element's <code
989: title="dom-img-complete">complete</code> attribute is false, then
1.1 mike 990: let <var title="">icon</var> be null.</p></li>
991:
992: <li><p>If the <var title="">icon</var> argument is present and not
1.80 mike 993: null, then copy the image data from that <code>img</code> element,
1.1 mike 994: and let <var title="">image</var> be the copy of that image
995: data. Otherwise, let <var title="">image</var> be nothing.</p></li>
996:
1.80 mike 997: <li><p>Append a new entry to the <span>column list</span>, with
1.1 mike 998: <var title="">id</var> as its identifier, <var title="">label</var>
1.80 mike 999: as its label, <var title="">type</var> as its type, and <var
1000: title="">image</var> as its icon. Let the column be sortable if the
1.1 mike 1001: <var title="">sortable</var> argument is present and true, and make
1002: it visible unless the <var title="">hidden</var> argument is
1003: present and true.</p></li>
1004:
1.80 mike 1005: <li><p>If the <span>column list</span> contains the <span>default
1006: column</span>, then remove the <span>default column</span> from the
1007: <span>column list</span>, discard any data for cells in that column
1008: in any rows in the <code>datagrid</code>, set <code
1009: title="dom-datagrid-sortColumn">sortColumn</code> to <var
1010: title="">id</var>, set <code
1011: title="dom-datagrid-sortAscending">sortAscending</code> to true,
1012: and run the <span><code>datagrid</code> resort
1013: steps</span>.</p></li>
1014:
1015: </ol>
1016:
1017: <hr>
1.1 mike 1018:
1.80 mike 1019: <p>The <dfn
1.186 mike 1020: title="dom-datagrid-sortColumn"><code>sortColumn</code></dfn> IDL
1.1 mike 1021: attribute gives the current column used for sorting. Initially, its
1022: value must be the empty string. On getting, it must return its
1023: current value. On setting, if the new value doesn't match the
1.80 mike 1024: identifier of one of the columns in the <span>column list</span>,
1025: then the user agent must throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 1026: exception. Otherwise, if the new value is not the same as its
1027: current value, then the user agent must set the attribute to the new
1.80 mike 1028: value, and then run the <span><code>datagrid</code> resort
1029: steps</span>.</p>
1.1 mike 1030:
1.80 mike 1031: <p>The <dfn
1032: title="dom-datagrid-sortAscending"><code>sortAscending</code></dfn>
1.186 mike 1033: IDL attribute specifies the direction that the tree is sorted in,
1.1 mike 1034: ascending (true) or descending (false). Initially, its value must be
1035: true (ascending). On getting, it must return its current value. On
1036: setting, if the new value is not the same as its current value, then
1037: the user agent must set the attribute to the new value, and then run
1.80 mike 1038: the <span><code>datagrid</code> resort steps</span>.</p>
1.1 mike 1039:
1040: <p>When a column is marked as being sortable, the user agent should
1041: allow the user to select that column to be the column used for
1042: sorting, and should allow the user to chose whether the sort order
1043: is ascending or descending.</p>
1044:
1045: <p>When the user changes the sort order in this manner, the user
1.80 mike 1046: agent must update the <code
1047: title="dom-datagrid-sortColumn">sortColumn</code> and <code
1048: title="dom-datagrid-sortAscending">sortAscending</code> attributes
1049: appropriately, and then run the <span><code>datagrid</code> resort
1050: steps</span>.</p>
1.1 mike 1051:
1.80 mike 1052: <p class="note">The <span><code>datagrid</code> resort steps</span>
1.1 mike 1053: are described in the next section.</p>
1054:
1.80 mike 1055: <hr>
1.1 mike 1056:
1.80 mike 1057: <p>The <dfn
1058: title="dom-datagrid-clearColumns"><code>clearColumns()</code></dfn>
1059: method, if the <span>column list</span> doesn't contain the
1060: <span>default column</span>, must empty the <span>column
1061: list</span>, append the <span>default column</span> to the now empty
1062: <span>column list</span>, discard any data for cells in all rows in
1063: the <code>datagrid</code>, set <code
1064: title="dom-datagrid-sortColumn">sortColumn</code> to the empty
1065: string, set <code
1066: title="dom-datagrid-sortAscending">sortAscending</code> to true, and
1067: run the <span><code>datagrid</code> resort steps</span>. (If the
1068: <span>column list</span> is already just the <span>default
1069: column</span>, then the method does nothing.)</p>
1.1 mike 1070:
1071:
1.80 mike 1072: <h6>The rows</h6>
1073:
1074: <p>A <code>datagrid</code> element is intended to show a
1.1 mike 1075: representation of a tree, where typically the user only sees a
1076: small part of the tree at a time.</p>
1077:
1.80 mike 1078: <p>To make this efficient, the <code>datagrid</code> element
1.1 mike 1079: <em>actually</em> shows a small part of a <em>sparse</em> tree, so
1080: that only relevant parts of the data structure need be loaded at any
1081: time. Specifically, the model requires only that all the ancestor
1082: rows of the displayed rows be loaded, as well as any open earlier
1083: siblings (in the displayed sort order) of the displayed rows.</p>
1084:
1.80 mike 1085: <p>Conceptually, therefore, a <code>datagrid</code> has a number of
1.1 mike 1086: related sparse data structures backing it.</p>
1087:
1.80 mike 1088: <p>The first is the <dfn>natural order sparse data tree</dfn>. This
1.1 mike 1089: is the structure in which rows are entered as they are declared, in
1090: their natural order. This can differ from the order actually
1091: displayed to the user. It consists of nested sparse lists of
1.80 mike 1092: rows. In the <span>natural order sparse data tree</span>, a row will
1.1 mike 1093: always have all its parents already declared. Once a row is added to
1.80 mike 1094: this structure, it can only be removed by the <code
1095: title="dom-datagrid-deleteRows">deleteRows()</code> and <code
1096: title="dom-datagrid-clearRows">clearRows()</code> methods. The order of
1.1 mike 1097: nodes in this tree never changes; to move a node in this tree, it
1098: has to be removed and then another row (with the same data)
1099: reinserted elsewhere.</p>
1100:
1.80 mike 1101: <p>The second structure is the <dfn>display order sparse data
1.1 mike 1102: tree</dfn>. This is a similar structure that contains a subset of
1.80 mike 1103: the rows in the <span>natural order sparse data tree</span>, ordered
1104: in the order given by the <code
1105: title="dom-datagrid-sortAscending">sortAscending</code> and <code
1106: title="dom-datagrid-sortColumn">sortColumn</code> attributes, and
1.1 mike 1107: excluding rows with one or more ancestors that are closed. This tree
1.80 mike 1108: is cleared whenever the <code
1109: title="dom-datagrid-sortAscending">sortAscending</code> and <code
1110: title="dom-datagrid-sortColumn">sortColumn</code> attributes
1.1 mike 1111: change.</p>
1112:
1.80 mike 1113: <p>The third structure is the <dfn>display order sparse data
1.1 mike 1114: list</dfn>. This structure is a flattened representation of the
1.80 mike 1115: <span>display order sparse data tree</span>.</p>
1.1 mike 1116:
1.80 mike 1117: <p>At any time, a number of consecutive rows in the <span>display
1118: order sparse data list</span> are physically visible to the
1119: user. The <code>datagrid</code> fires notifications to a <span
1120: title="dom-datagrid-listener">listener</span> (provided by script),
1.1 mike 1121: and the listener, or other some script, is expected to feed the
1.80 mike 1122: <code>datagrid</code> with the information needed to render the
1.1 mike 1123: control.</p>
1124:
1.80 mike 1125: <p>A <code>datagrid</code> has a <dfn>pending <code>datagrid</code>
1126: rows list</dfn>, which is a list of rows in the <span>display order
1127: sparse data list</span> for which the <code>datagrid</code> has sent
1.1 mike 1128: notifications requesting information but not yet received
1129: information about.</p>
1130:
1.80 mike 1131: <p>A <code>datagrid</code> also has a <dfn>pending
1.1 mike 1132: <code>datagrid</code> <em>cells</em> list</dfn>, which is a list of
1.80 mike 1133: row/column pairs (cells) for which the <code>datagrid</code> has
1.1 mike 1134: sent notifications requesting information but not yet received
1135: information about.</p>
1136:
1137: <p>User agents may discard information about rows that are not
1138: displayed and that are not ancestors or open earlier siblings of
1139: rows or ancestors of rows that are displayed.</p>
1140:
1.80 mike 1141: <hr>
1142:
1143: <p>These structures are different views of the collection of rows
1144: that form the <code>datagrid</code>. Each row has the following
1.1 mike 1145: information associated with it:</p>
1146:
1.80 mike 1147: <dl>
1148:
1149: <dt>A parent</dt>
1.1 mike 1150:
1.80 mike 1151: <dd><p>Either another row, or the <code>datagrid</code> itself. This
1152: is the parent of the row in the <span>natural order sparse data
1153: tree</span> and the <span>display order sparse data tree</span>
1154: for the <code>datagrid</code>.</p></dd>
1.1 mike 1155:
1156: <dt>A natural order position relative to the other rows with the
1157: same parent</dt>
1158:
1159: <dd>
1160:
1161: <p>This is the number of rows that precede this row under the same
1.80 mike 1162: parent in the <span>natural order sparse data tree</span>. This
1.1 mike 1163: number can't be changed relative to other rows in the same parent;
1164: to change the relative natural order of data in the
1.80 mike 1165: <code>datagrid</code>, the original rows have to be removed and
1.1 mike 1166: new rows (with the same data but different natural positions)
1167: inserted in their place. (The exact number of a row can change, as
1168: new rows can be inserted above it.)</p>
1169:
1.80 mike 1170: <p>A row can be identified by a <code>RowID</code> object. This is
1.1 mike 1171: an array of numbers, consisting of the natural order positions of
1172: each ancestor row and the row itself, starting from the furthest
1173: ancestor. Thus, for instance, the fourth child row of the first
1.80 mike 1174: child row of the second row in a <code>datagrid</code> would be
1175: identified by a <code>RowID</code> object whose value is <code
1176: title="">[1, 0, 3]</code>. A row's identifier changes if rows are
1177: <span title="dom-datagrid-insertRows">inserted before it</span> in
1178: the <code>datagrid</code>.</p>
1.1 mike 1179:
1180: </dd>
1181:
1182: <dt>A display order position relative to the other rows with
1183: the same parent</dt>
1184:
1185: <dd><p>This is the number of rows that precede this row under the
1.80 mike 1186: same parent in the <span>display order sparse data
1187: tree</span>. This number can be unknown. If the sort order
1188: changes, then this information is lost (as the <span>display order
1189: sparse data tree</span> is cleared).</p></dd>
1.1 mike 1190:
1191: <dt>A child count</dt>
1192:
1193: <dd><p>The number of rows that have this row as a parent. If this is
1.80 mike 1194: zero, the row cannot be opened. If this is −1, then the
1.1 mike 1195: child count is unknown but the row can be opened. This value can be
1.80 mike 1196: changed by the <code title="dom-datagrid-setRows">setRows()</code>
1197: method only if the current value is −1 or if the row or one
1.1 mike 1198: of its ancestors is closed. Otherwise, it can only be changed
1.80 mike 1199: indirectly using the <code
1200: title="dom-datagrid-insertRows">insertRows()</code> and <code
1201: title="dom-datagrid-deleteRows">deleteRows()</code> methods.</p></dd>
1.1 mike 1202:
1203: <dt>An open flag</dt>
1204:
1205: <dd><p>A boolean indicating whether the row is open (true) or
1206: closed (false). Once set, the flag can only be changed by the user
1207: or while one of the row's ancestors is itself closed. A row can
1208: also be in a third state, "opening", which is treated as closed for
1209: all purposes except that the user agent may indicate that the row
1210: is in this special state, and except that when the row is updated
1211: to have a row count, the row will switch to being open.</p></dd>
1212:
1213: <dt>A row count</dt>
1214:
1215: <dd><p>The number of rows that have this row as a parent or
1216: ancestor, and that do not have an ancestor that is a descendant of
1.80 mike 1217: this row that is itself closed. If this is −1, then the row
1218: count is unknown. This value can be changed by the <code
1219: title="dom-datagrid-setRows">setRows()</code> method only if the
1.1 mike 1220: row or one of its ancestors is closed (or opening, but not
1.80 mike 1221: open). Otherwise, it can only be changed indirectly using the <code
1222: title="dom-datagrid-insertRows">insertRows()</code> and <code
1223: title="dom-datagrid-deleteRows">deleteRows()</code>
1.1 mike 1224: methods.</p></dd>
1225:
1226: <dt>Cells</dt>
1227:
1228: <dd><p>The data that applies to this row. Cell data is discussed in
1229: more detail below.</p></dd>
1230:
1.80 mike 1231: </dl>
1232:
1233: <p>The <code>datagrid</code> itself also has a <dfn title="datagrid
1234: child count">child count</dfn> and a <dfn title="datagrid row
1.1 mike 1235: count">row count</dfn>, which are analogous to the child counts and
1236: row counts for rows. Initially, these must be zero.</p>
1237:
1.80 mike 1238: <hr>
1239:
1240: <p>The <dfn><code>datagrid</code> resort steps</dfn>, which are
1.1 mike 1241: invoked when the sort order changes as described in the previous
1242: section, are as follows:</p>
1243:
1.80 mike 1244: <ol>
1.1 mike 1245:
1.80 mike 1246: <li>
1247:
1248: <p>Clear the <span>display order sparse data tree</span>
1.1 mike 1249: (i.e. mark the display order position of all the rows in the
1.80 mike 1250: <code>datagrid</code> as unknown).</p>
1.1 mike 1251:
1252: <p>User agents may cache the position information of rows for
1.80 mike 1253: various values of <code
1254: title="dom-datagrid-sortColumn">sortColumn</code> and <code
1255: title="dom-datagrid-sortAscending">sortAscending</code>, instead
1.1 mike 1256: of discarding the information altogether. If the user agent caches
1257: this information, and has information that applies to the current
1.80 mike 1258: values of <code title="dom-datagrid-sortColumn">sortColumn</code>
1259: and <code title="dom-datagrid-sortAscending">sortAscending</code>,
1260: then the user agent may repopulate the <span>display order sparse
1261: data tree</span> from this information.</p>
1.1 mike 1262:
1263: </li>
1264:
1265: <li>
1266:
1.80 mike 1267: <p>Clear the <span>pending <code>datagrid</code> rows list</span>
1268: and the <span>pending <code>datagrid</code> cells list</span>.</p>
1.1 mike 1269:
1270: </li>
1271:
1272: <li>
1273:
1.80 mike 1274: <p>Invoke the <span><code>datagrid</code> update display
1275: algorithm</span>.</p>
1.1 mike 1276:
1277: </li>
1278:
1.80 mike 1279: <!- - v2: queue a task to fire an event, or tell the listener the
1280: sort order changed, or something - ->
1281:
1282: </ol>
1.1 mike 1283:
1.80 mike 1284: <hr>
1.1 mike 1285:
1.80 mike 1286: <p>The <dfn
1287: title="dom-datagrid-renotify"><code>renotify()</code></dfn> method
1288: must empty the <span>pending <code>datagrid</code> rows list</span>
1289: and the <span>pending <code>datagrid</code> cells list</span>, and
1290: invoke the <span><code>datagrid</code> update display
1291: algorithm</span>.</p>
1292:
1293: <hr>
1294:
1295: <p>The <dfn title="dom-datagrid-setRowCount"><code>setRowCount(<var
1296: title="">childCount</var>, <var
1297: title="">rowCount</var>)</code></dfn> method must run the following
1.1 mike 1298: steps:</p>
1299:
1.80 mike 1300: <ol>
1.1 mike 1301:
1.80 mike 1302: <li>
1303:
1304: <p>Set the <span><code>datagrid</code> child count</span> to <var
1305: title="">childCount</var>, the <span><code>datagrid</code> row
1306: count</span> to <var title="">rowCount</var>.</p>
1.1 mike 1307:
1308: </li>
1309:
1310: <li>
1311:
1.80 mike 1312: <p><span>Audit the <code>datagrid</code></span>. If this fails,
1.1 mike 1313: then revert the changes made in the previous step, throw a
1.80 mike 1314: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1315: steps.</p>
1316:
1317: </li>
1318:
1319: <li>
1320:
1.80 mike 1321: <p>Invoke the <span><code>datagrid</code> update display
1322: algorithm</span>.</p>
1.1 mike 1323:
1324: </li>
1325:
1.80 mike 1326: </ol>
1327:
1328: <hr>
1329:
1330: <p>The <dfn title="dom-datagrid-setRows"><code>setRows(<var
1331: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1332: steps:</p>
1333:
1.80 mike 1334: <ol>
1.1 mike 1335:
1.80 mike 1336: <li>
1337:
1338: <p><span title="type-check a RowList object">Type-check the <var
1339: title="">rows</var> argument</span>. If this fails, throw a
1.1 mike 1340: <code>TypeError</code> exception, and abort these steps.</p>
1341:
1342: </li>
1343:
1344: <li>
1345:
1.80 mike 1346: <p><span title="partially sort a RowList object">Partially sort
1347: the <var title="">rows</var> argument</span>.</p>
1.1 mike 1348:
1349: </li>
1350:
1351: <li>
1352:
1.80 mike 1353: <p>For each <code>Row</code> object in the <var
1354: title="">rows</var> argument, in order, perform the appropriate
1.1 mike 1355: steps from the list below.</p>
1356:
1.80 mike 1357: <p class="note">The changes made to the <code>datagrid</code>'s
1.1 mike 1358: data structures in this step get reverted (as required below) if
1359: any consistency errors are detected either in this step or the
1360: next.</p>
1361:
1.80 mike 1362: <dl>
1363:
1364: <dt>If there already exists a row in the <code>datagrid</code>'s
1365: <span>natural order sparse data tree</span> with the same
1366: identifier as given by the <code>Row</code> object's
1367: <code>RowID</code> object, and that row and all its ancestors are
1.1 mike 1368: open</dt>
1369:
1370: <dd>
1371:
1372: <p>If one of the following conditions is true, then revert all
1373: the changes done in this step, throw a
1.80 mike 1374: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1375: steps:</p>
1376:
1.80 mike 1377: <ul>
1378:
1379: <li>The value of the <code>Row</code> object's second entry is
1380: neither −1 nor equal to the child count of the
1.1 mike 1381: preexisting row.</li>
1382:
1.80 mike 1383: <li>The <code>Row</code> object has fewer than four
1.1 mike 1384: entries or more than six entries.</li>
1385:
1.80 mike 1386: <li>The <code>Row</code> object has five or more entries, and
1.1 mike 1387: its fifth entry is false.</li>
1388:
1.80 mike 1389: <li>The <code>Row</code> object has six entries, and its sixth
1.1 mike 1390: entry is not equal to the row count of the preexisting
1391: row.</li>
1392:
1.80 mike 1393: </ul>
1394:
1395: </dd>
1.1 mike 1396:
1.80 mike 1397: <dt>If there already exists a row in the <code>datagrid</code>'s
1398: <span>natural order sparse data tree</span> with the same
1399: identifier as given by the <code>Row</code> object's
1400: <code>RowID</code> object, but either that row or one of its
1.1 mike 1401: ancestors is closed</dt>
1402:
1403: <dd>
1404:
1405: <p>Set the preexisting row's child count to the value of the
1.80 mike 1406: <code>Row</code> object's second entry.</p>
1.1 mike 1407:
1.80 mike 1408: <p>If the <code>Row</code> object has five or more entries, and
1.1 mike 1409: either its fifth entry is true and the preexisting row is closed
1410: but not opening, or its fifth entry is false and the preexisting
1411: row is open, then: if the preexisting row has no ancestor row
1412: that is closed, then revert all the changes done in this step,
1.80 mike 1413: throw a <code>DATAGRID_MODEL_ERR</code> exception, and abort
1.1 mike 1414: these steps; otherwise, if the fifth entry is false, then close
1415: the row; otherwise, open the row.</p>
1416:
1.80 mike 1417: <p>If the <code>Row</code> object has six entries, set the
1418: preexisting row's row count to the value of the <code>Row</code>
1.1 mike 1419: object's sixth entry.</p>
1420:
1421: <p>If the preexisting row is opening, then: increase the
1.80 mike 1422: <span><code>datagrid</code> row count</span> and the row counts
1.1 mike 1423: of any ancestor rows by the number of rows that the preexisting
1.80 mike 1424: row now has in its row count, then open the row.</p> <!- - we
1.1 mike 1425: should also "update the <span>pending <code>datagrid</code> rows
1426: list</span> and the <span>pending <code>datagrid</code> cells
1.80 mike 1427: list</span> accordingly" - ->
1.1 mike 1428:
1429:
1430: </dd>
1431:
1.80 mike 1432: <dt>There does not exist a row in the <code>datagrid</code>'s
1433: <span>natural order sparse data tree</span> with the same
1434: identifier as given by the <code>Row</code> object's
1435: <code>RowID</code> object</dt>
1.1 mike 1436:
1437: <dd>
1438:
1.80 mike 1439: <p>If the <code>RowID</code> object has a length greater than 1,
1.1 mike 1440: then verify that there is a row identified by the
1.80 mike 1441: <code>RowID</code> consisting of all but the last number in the
1442: <code>Row</code> object's <code>RowID</code>. If there is no
1443: such row present in the <span>natural order sparse data
1444: tree</span>, then revert all the changes done in this step,
1445: throw a <code>DATAGRID_MODEL_ERR</code> exception, and abort
1.1 mike 1446: these steps.</p>
1447:
1.80 mike 1448: <p>Create a row and insert it into the <span>natural order
1449: sparse data tree</span>, such that its parent is the row
1450: identified by the <code>RowID</code> consisting of all but the
1451: last number in the <code>Row</code> object's <code>RowID</code>,
1452: or the <code>datagrid</code> if the length of the
1453: <code>Row</code> object's <code>RowID</code> is 1; with its
1.1 mike 1454: natural order position being the last number of the
1.80 mike 1455: <code>Row</code> object's <code>RowID</code>; with the child
1456: count being the value of the third entry of the <code>Row</code>
1.1 mike 1457: object; with the row being marked closed unless the
1.80 mike 1458: <code>Row</code> object has five or more entries and its fifth
1.1 mike 1459: entry is true, in which case the row is open; and with its row
1.80 mike 1460: count being −1 unless the <code>Row</code> object has six
1.1 mike 1461: entries, in which case the row count is equal to the value of
1.80 mike 1462: the <code>Row</code> object's sixth entry.</p>
1.1 mike 1463:
1464: </dd>
1465:
1.80 mike 1466: </dl>
1467:
1468: </li>
1.1 mike 1469:
1470: <li>
1471:
1.80 mike 1472: <p><span>Audit the <code>datagrid</code></span>. If this fails,
1.1 mike 1473: then revert the changes made in the previous step, throw a
1.80 mike 1474: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1475: steps.</p>
1476:
1477: </li>
1478:
1479: <li>
1480:
1.80 mike 1481: <p>For each <code>Row</code> object in the <var
1482: title="">rows</var> argument, in order, <span title="apply a Row
1483: object">apply the <code>Row</code> object</span>.</p>
1.1 mike 1484:
1485: </li>
1486:
1487: <li>
1488:
1.80 mike 1489: <p>Invoke the <span><code>datagrid</code> update display
1490: algorithm</span>.</p>
1.1 mike 1491:
1492: </li>
1493:
1.80 mike 1494: </ol>
1495:
1496: <hr>
1497:
1498: <p>The <dfn title="dom-datagrid-insertRows"><code>insertRows(<var
1499: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1500: steps:</p>
1501:
1.80 mike 1502: <ol>
1503:
1504: <li>
1.1 mike 1505:
1.80 mike 1506: <p><span title="type-check a RowList object">Type-check the <var
1507: title="">rows</var> argument</span>. If this fails, throw a
1.1 mike 1508: <code>TypeError</code> exception, and abort these steps.</p>
1509:
1510: </li>
1511:
1512: <li>
1513:
1.80 mike 1514: <p><span title="partially sort a RowList object">Partially sort
1515: the <var title="">rows</var> argument</span>.</p>
1.1 mike 1516:
1517: </li>
1518:
1519: <li>
1520:
1.80 mike 1521: <p>For each <code>Row</code> object in the <var
1522: title="">rows</var> argument, in order, run the following
1.1 mike 1523: steps:</p>
1524:
1.80 mike 1525: <p class="note">The changes made to the <code>datagrid</code>'s
1.1 mike 1526: data structures in this step get reverted (as required below) if
1527: any consistency errors are detected either in this step or the
1528: next.</p>
1529:
1.80 mike 1530: <ol>
1531:
1532: <li>
1.1 mike 1533:
1534: <p>Let <var title="">parent</var> be the row identified by the
1.80 mike 1535: <code>RowID</code> consisting of all but the last number in the
1536: <code>Row</code> object's <code>RowID</code>, or the
1537: <code>datagrid</code> itself if the <code>Row</code> object's
1538: <code>RowID</code> has length 0.</p>
1539:
1540: <p>If there is no such row present in the <span>natural order
1541: sparse data tree</span>, then revert all the changes done in
1542: this algorithm, throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 1543: exception, and abort these steps.</p>
1544:
1545: </li>
1546:
1547: <li>
1548:
1549: <p>Increment by one the natural order position of all rows whose
1550: parent is <var title="">parent</var> and whose natural order
1551: position is equal to or greater than the last number of the
1.80 mike 1552: <code>Row</code> object's <code>RowID</code>.</p>
1.1 mike 1553:
1554: </li>
1555:
1556: <li>
1557:
1.80 mike 1558: <p>If the value of the <code>Row</code> object's second entry is
1559: not −1, then increment by one the display order position
1.1 mike 1560: of all rows whose parent is <var title="">parent</var> and whose
1561: display order position is equal to or greater than the value of
1.80 mike 1562: the <code>Row</code> object's second entry.</p>
1.1 mike 1563:
1.80 mike 1564: <!- -(Not sure how to really say this.)
1.1 mike 1565: <p>Update the <span>pending <code>datagrid</code> rows
1566: list</span> and the <span>pending <code>datagrid</code> cells
1567: list</span> accordingly.</p>
1.80 mike 1568: - ->
1.1 mike 1569:
1570: </li>
1571:
1572: <li>
1573:
1.80 mike 1574: <p>Create a row and insert it into the <span>natural order
1575: sparse data tree</span>, such that its parent is <var
1576: title="">parent</var>; with its natural order position being the
1577: last number of the <code>Row</code> object's <code>RowID</code>;
1.1 mike 1578: with the child count being the value of the third entry of the
1.80 mike 1579: <code>Row</code> object; with the row being marked closed unless
1580: the <code>Row</code> object has five or more entries and its
1.1 mike 1581: fifth entry is true, in which case the row is open; and with its
1.80 mike 1582: row count being −1 unless the <code>Row</code> object has
1.1 mike 1583: six entries, in which case the row count is equal to the value
1.80 mike 1584: of the <code>Row</code> object's sixth entry.</p>
1.1 mike 1585:
1586: </li>
1587:
1.80 mike 1588: </ol>
1589:
1590: </li>
1.1 mike 1591:
1592: <li>
1593:
1.80 mike 1594: <p>For each <code>Row</code> object in the <var
1595: title="">rows</var> argument, in order, <span title="apply a Row
1596: object">apply the <code>Row</code> object</span>.</p>
1.1 mike 1597:
1598: </li>
1599:
1600: <li>
1601:
1.80 mike 1602: <p>Invoke the <span><code>datagrid</code> update display
1603: algorithm</span>.</p>
1.1 mike 1604:
1605: </li>
1606:
1.80 mike 1607: </ol>
1608:
1609: <hr>
1610:
1611: <p>When an algorithm requires the user agent to <dfn>type-check a
1.1 mike 1612: <code>RowList</code> object</dfn> (an array), each entry in the
1613: object must be checked against the following requirements. If any
1614: are false, then the type-check fails, otherwise it passes.</p>
1615:
1.80 mike 1616: <ul>
1617:
1618: <li><p>The entry is a <code>Row</code> object (an
1.1 mike 1619: array).</p></li>
1620:
1.80 mike 1621: <li><p>The first value in the <code>Row</code> is a
1622: <code>RowID</code> object (also an array), whose length is at least
1.1 mike 1623: 1, and whose values are all integers greater than or equal to
1624: zero.</p></li>
1625:
1.80 mike 1626: <li><p>The numbers in the <code>RowID</code> object do not exactly
1627: match any of the other entries in the <code>RowList</code> object
1628: (i.e. no two <code>Row</code> objects have the same
1.1 mike 1629: identifier).</p></li>
1630:
1.80 mike 1631: <li><p>The second value in the <code>Row</code> is an integer that
1632: is either −1, zero, or a positive integer.</p></li>
1.1 mike 1633:
1.80 mike 1634: <li><p>The third value in the <code>Row</code> is an integer that
1635: is either −1, zero, or a positive integer.</p></li>
1.1 mike 1636:
1.80 mike 1637: <li><p>The fourth value in the <code>Row</code> is a
1638: <code>CellList</code> object (yet another array).</p></li>
1.1 mike 1639:
1.80 mike 1640: <li><p>Each entry in the <span>CellList</span> object is a
1641: <code>Cell</code> object (again, an array).</p></li>
1.1 mike 1642:
1.80 mike 1643: <li><p>Each <code>Cell</code> object in the <span>CellList</span>
1644: object has as its first value a <code>Column</code> object (a
1.1 mike 1645: string), and its value is the identifier of one of the columns in
1.80 mike 1646: the <span>column list</span>.</p></li>
1.1 mike 1647:
1648: <li>
1649:
1.80 mike 1650: <p>Each <code>Cell</code> object in the <span>CellList</span>
1.1 mike 1651: object has as its second and subsequent entries values that match
1652: the following requirements, as determined by the type of the
1653: column identified by the first entry:</p>
1654:
1.80 mike 1655: <dl>
1656:
1657: <dt>If the column's type is <code title="datagrid-type-text">text</code></dt>
1.1 mike 1658: <dd>
1659:
1660: <p>The second entry's value is a string, and either there are
1661: only two entries, or there are three, and the third entry is
1.80 mike 1662: an <code>img</code> element.</p>
1.1 mike 1663:
1.80 mike 1664: <p>If there is an <code>img</code> element specified, its <code
1665: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1666:
1667: </dd>
1668:
1.80 mike 1669: <dt>If the column's type is <code title="datagrid-type-editable">editable</code></dt>
1.1 mike 1670: <dd>
1671:
1672: <p>The second entry's value is a string, and either there are
1673: only two entries, or the third entry is a
1.80 mike 1674: <code>datalist</code> element, and either there are only three
1.1 mike 1675: entries, or there are four, and the fourth entry is an
1.80 mike 1676: <code>img</code> element.</p>
1.1 mike 1677:
1.80 mike 1678: <p>If there is an <code>img</code> element specified, its <code
1679: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1680:
1681: </dd>
1682:
1.80 mike 1683: <dt>If the column's type is <code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 1684: <dd>
1685:
1686: <p>The second entry's value is a string, the third entry is a
1687: boolean, and either there are only three entries, or the
1688: fourth entry is also a boolean, and either there are only four
1689: entries, or there are five, and the fifth entry is an
1.80 mike 1690: <code>img</code> element.</p>
1.1 mike 1691:
1.80 mike 1692: <p>If there is an <code>img</code> element specified, its <code
1693: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1694:
1695: </dd>
1696:
1.80 mike 1697: <dt>If the column's type is <code title="datagrid-type-list">list</code></dt>
1.1 mike 1698: <dd>
1699:
1700: <p>The second entry's value is a string, the third entry is a
1.80 mike 1701: <code>select</code> element, and either there are only three
1.1 mike 1702: entries, or there are four, and the fourth entry is an
1.80 mike 1703: <code>img</code> element.</p>
1.1 mike 1704:
1.80 mike 1705: <p>If there is an <code>img</code> element specified, its <code
1706: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1707:
1708: </dd>
1709:
1.80 mike 1710: <dt>If the column's type is <code title="datagrid-type-progress">progress</code></dt>
1.1 mike 1711: <dd>
1712:
1713: <p>There are only two entries, the second entry's value is a
1714: number, and the number's value is between 0.0 and 1.0
1715: inclusive.</p>
1716:
1717: </dd>
1718:
1.80 mike 1719: <dt>If the column's type is <code title="datagrid-type-meter">meter</code></dt>
1.1 mike 1720: <dd>
1721:
1722: <p>There are at least two, but possibly up to seven, entries,
1723: all entries but the first one are numbers, and the following
1724: relationships hold:</p>
1725:
1.80 mike 1726: <ul class="brief">
1727:
1728: <li>The second entry is less than the third, or less than 1.0
1.1 mike 1729: if the third is absent.</li>
1730:
1731: <li>The second entry is greater than the fourth, or greater
1732: than 0.0 if the fourth is absent.</li>
1733:
1734: <li>If there are at least three entries, the third entry is
1735: greater than the fourth, or greater than zero if the fourth
1736: is absent.</li>
1737:
1738: <li>If there are at least five entries, the fifth is not
1739: greater than the third and not less than the fourth.</li>
1740:
1741: <li>If there are at least six entries, the sixth is not
1742: greater than the third and not less than the fifth.</li>
1743:
1744: <li>If there are at least seven entries, the fifth is not
1745: greater than the third and not less than the fourth.</li>
1746:
1.80 mike 1747: </ul>
1.1 mike 1748:
1.80 mike 1749: </dd>
1750:
1751: <dt>If the column's type is <code title="datagrid-type-custom">custom</code></dt>
1.1 mike 1752: <dd>
1753:
1754: <p>There are four entries, the second and third are numbers
1755: that are integers greater than zero, and the fourth is a
1756: <code>Rendering2DContextCallback</code> object (a
1757: function).</p>
1758:
1759: </dd>
1760:
1.80 mike 1761: </dl>
1762:
1763: </li>
1.1 mike 1764:
1.80 mike 1765: <li><p>Either there are only four values in the <code>Row</code>,
1766: or the fifth value in the <code>Row</code> is a boolean.</p></li>
1.1 mike 1767:
1768: <li><p>Either there are only four or five values in the
1.80 mike 1769: <code>Row</code>, or there are six, and the sixth value in the
1770: <code>Row</code> an integer that is greater than or equal to
1.1 mike 1771: zero.</p></li>
1772:
1.80 mike 1773: </ul>
1774:
1775: <p>Where the above requirements say that a value is to be a string,
1.718 mike 1776: the user agent must apply the ToString() abstract operation to the
1.1 mike 1777: value, assume that the value was indeed a string, and use the result
1778: in the rest of the algorithm as if it had that had been the value
1.98 mike 1779: passed to the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1780:
1781: <p>Where the above requirements say that a value is to be a number,
1.718 mike 1782: the user agent must first apply the ToNumber() abstract operation
1.60 mike 1783: to the value, and then verify that the result is neither an Infinity
1784: value nor a Not-a-Number (NaN) value. If this result is indeed
1785: acceptable (i.e. finite), the user agent must use the result in the
1786: rest of the algorithm as if it had that had been the value passed to
1.98 mike 1787: the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1788:
1789: <p>Where the above requirements say that a value is to be an
1.718 mike 1790: integer, the user agent must first apply the ToNumber() abstract
1791: operation to the value, and then verify that the result is a finite
1.1 mike 1792: integer. If so, the user agent must use the result in the rest of
1793: the algorithm as if it had that had been the value passed to the
1.98 mike 1794: method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1795:
1796: <p>Where the above requirements say that a value is to be a boolean,
1.718 mike 1797: the user agent must apply the ToBoolean() abstract operation to the
1.1 mike 1798: value, assume that the value was indeed a boolean, and use the
1799: result in the rest of the algorithm as if it had that had been the
1.98 mike 1800: value passed to the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.80 mike 1801:
1802: <hr>
1.1 mike 1803:
1.80 mike 1804: <p>When an algorithm requires the user agent to <dfn>audit the
1805: <code>datagrid</code></dfn>, the <code>datagrid</code> must be
1.1 mike 1806: checked against the following requirements. If any are false, then
1807: the audit fails, otherwise it passes.</p>
1808:
1.80 mike 1809: <ul>
1810:
1811: <li>There is no row whose natural order position is greater than or
1812: equal to the child count of its parent row in the <span>natural
1813: order sparse data tree</span>.</li>
1.1 mike 1814:
1815: <li>There is no row whose display order position is greater than or
1.80 mike 1816: equal to the child count of its parent row in the <span>display
1817: order sparse data tree</span>.</li>
1.1 mike 1818:
1819: <li>There is no row such that the sum of that row's child count and
1820: the row counts all the open rows that are direct children of that
1.80 mike 1821: row in the <span>natural order sparse data tree</span> is less than
1.1 mike 1822: that row's row count.</li>
1823:
1824: <li>Of the rows whose child count is equal to the number of rows
1.80 mike 1825: that are direct children of that row in the <span>natural order
1826: sparse data tree</span>, there is none such that the sum of that
1.1 mike 1827: row's child count and the row counts of all the open rows that are
1.80 mike 1828: direct children of that row in the <span>natural order sparse data
1829: tree</span> is greater than that row's row count.</li>
1830:
1831: </ul>
1.1 mike 1832:
1.80 mike 1833: <p>For the purposes of this audit, the <code>datagrid</code> must be
1.1 mike 1834: treated as the parent row of all the rows that are direct children
1.80 mike 1835: of the <code>datagrid</code> in the <span>natural order sparse data
1836: tree</span> and the <span>display order sparse data tree</span>. The
1837: child count of this implied row is the <span><code>datagrid</code>
1838: child count</span>, and the row count of this implied row is the
1839: <span><code>datagrid</code> row count</span>.</p>
1840:
1841: <hr>
1.1 mike 1842:
1.80 mike 1843: <p>When an algorithm requires the user agent to <dfn>partially sort
1.1 mike 1844: a <code>RowList</code> object</dfn> (an array), the entries in the
1.80 mike 1845: object must be resorted such that <code>Row</code> objects are
1.1 mike 1846: listed after any of their ancestors and after any of their earlier
1.80 mike 1847: siblings. In other words, for any two <code>Row</code> objects <var
1848: title="">a</var> and <var title="">b</var> in the
1849: <code>RowList</code>, where <var title="">a</var> is before <var
1850: title="">b</var> after the sort, the following conditions must
1.1 mike 1851: hold:</p>
1852:
1.80 mike 1853: <ul>
1854:
1855: <li><p>If their <code>RowID</code> objects are the same length and
1.1 mike 1856: have values that are equal except for the last value, then the last
1.80 mike 1857: value of <var title="">a</var>'s <code>RowID</code>'s last value
1858: must be less than <var title="">b</var>'s <code>RowID</code>'s last
1.1 mike 1859: value (i.e. earlier siblings must come before their later
1860: siblings).</p></li>
1861:
1.80 mike 1862: <li><p>If their <code>RowID</code> objects are not the same length,
1.1 mike 1863: but the values in the shorter of the two are the same as the first
1864: few values in the longer one, then <var title="">a</var>'s
1.80 mike 1865: <code>RowID</code> must be the shorter one (i.e. ancestors must
1.1 mike 1866: come before their descendants).</p></li>
1867:
1.80 mike 1868: </ul>
1869:
1870: <hr>
1871:
1872: <p>The <dfn title="dom-datagrid-deleteRows"><code>deleteRows(<var
1873: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1874: steps:</p>
1875:
1.80 mike 1876: <ol>
1877:
1878: <li>
1.1 mike 1879:
1880: <p>If any of the entries in <var title="">rows</var> are not
1.80 mike 1881: <code>RowID</code> objects consisting of one or more entries whose
1.1 mike 1882: values are all integers that are greater than or equal to zero,
1883: then throw a <code>TypeError</code> exception and abort these
1884: steps.</p>
1885:
1886: <p>To check if a value is an integer, the user agent must first
1.718 mike 1887: apply the ToNumber() abstract operation to the value, and then
1.1 mike 1888: verify that the result is a finite integer. If so, the user agent
1889: must use the result in the rest of the algorithm as if it had that
1.80 mike 1890: had been the value passed to the method. <a
1.98 mike 1891: href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1892:
1893: </li>
1894:
1895: <li>
1896:
1.80 mike 1897: <p>If any of the <code>RowID</code> objects in the <var
1898: title="">rows</var> argument identify a row that isn't present in
1899: the <span>natural order sparse data tree</span>, then throw a
1900: <code>DATAGRID_MODEL_ERR</code> exception and abort these
1.1 mike 1901: steps.</p>
1902:
1903: </li>
1904:
1905: <li>
1906:
1907: <p>If any row is listed twice in the <var title="">rows</var>
1.80 mike 1908: argument, then throw a <code>DATAGRID_MODEL_ERR</code> exception
1.1 mike 1909: and abort these steps.</p>
1910:
1911: </li>
1912:
1913: <li>
1914:
1915: <p>Sort the <var title="">rows</var> argument such that the
1916: entries are given in the same order as the rows they identify
1917: would be visited in a pre-order, depth first traversal of the
1.80 mike 1918: <span>natural order sparse data tree</span>.</p>
1.1 mike 1919:
1920: </li>
1921:
1922: <li>
1923:
1924: <p>For each row identified by entries in <var title="">rows</var>,
1925: <em>in reverse order</em>, run the following steps:</p>
1926:
1.80 mike 1927: <ol>
1928:
1929: <li>
1.1 mike 1930:
1931: <p>Decrement the child count of the row's parent row, if that
1932: child count is greater than zero. If the row has no parent,
1.80 mike 1933: decrement the <span><code>datagrid</code> child
1934: count</span>.</p>
1.1 mike 1935:
1936: <p>If the row has a parent row, and its child count is now zero,
1937: then close that row.</p>
1938:
1939: </li>
1940:
1941: <li>
1942:
1943: <p>Let <var title="">delta</var> be one more than the row's row
1944: count if the row is open and its row count is greater than zero;
1945: otherwise, let <var title="">delta</var> be one.</p>
1946:
1947: </li>
1948:
1949: <li>
1950:
1951: <p>Let <var title="">ancestor</var> be the row.</p>
1952:
1953: </li>
1954:
1955: <li>
1956:
1957: <p><i>Row count loop</i>: Let <var title="">ancestor</var> be
1958: <var title="">ancestor</var>'s parent row, if any, or null if it
1959: has none.</p>
1960:
1961: </li>
1962:
1963: <li>
1964:
1965: <p>If <var title="">ancestor</var> is null, then decrement the
1.80 mike 1966: <span><code>datagrid</code> row count</span> by <var
1967: title="">delta</var>. Otherwise, if <var title="">ancestor</var>
1968: is open, then decrement its row count by <var
1969: title="">delta</var>.</p>
1.1 mike 1970:
1971: </li>
1972:
1973: <li>
1974:
1975: <p>If <var title="">ancestor</var> is not null, then jump back
1976: to the step labeled <i>row count loop</i> above.</p>
1977:
1978: </li>
1979:
1980: <li>
1981:
1982: <p>Let <var title="">parent</var> be the row's parent, or the
1.80 mike 1983: <code>datagrid</code> if the row has no parent.</p>
1.1 mike 1984:
1985: </li>
1986:
1987: <li>
1988:
1989: <p>Decrement by one the natural order position of all rows whose
1990: parent is <var title="">parent</var> and whose natural order
1991: position is equal to or greater than the row's own natural order
1992: position.</p>
1993:
1994: </li>
1995:
1996: <li>
1997:
1.80 mike 1998: <p>If the row is in the <span>display order sparse data
1999: tree</span>, then decrement by one the display order position of
1.1 mike 2000: all rows whose parent is <var title="">parent</var> and whose
2001: display order position is equal to or greater than the row's own
2002: display order position.</p>
2003:
2004: </li>
2005:
2006: <li>
2007:
2008: <p>Clear the row and its descendants from the
1.80 mike 2009: <code>Datagrid</code>.</p>
1.1 mike 2010:
2011: </li>
2012:
1.80 mike 2013: </ol>
2014:
2015: </li>
1.1 mike 2016:
2017: <li>
2018:
1.80 mike 2019: <p>Invoke the <span><code>datagrid</code> update display
2020: algorithm</span>.</p>
1.1 mike 2021:
2022: </li>
2023:
1.80 mike 2024: </ol>
1.1 mike 2025:
1.80 mike 2026: <hr>
2027:
2028: <p>The <dfn
2029: title="dom-datagrid-clearRows"><code>clearRows()</code></dfn> method
2030: must empty the <span>natural order sparse data tree</span>, reset
2031: both the <span><code>datagrid</code> child count</span> and the
2032: <span><code>datagrid</code> row count</span> to zero, and invoke the
2033: <span><code>datagrid</code> update display algorithm</span>.</p>
2034:
2035: <hr>
2036:
2037: <p>The <dfn title="dom-datagrid-repaint"><code>repaint(<var
2038: title="">row</var>, <var title="">column</var>)</code></dfn> method
1.1 mike 2039: must cause the user agent to clear its cache for the cell specified
1.80 mike 2040: by the identifier <var title="">row</var> and the column <var
2041: title="">column</var>, if that column's type is <code
2042: title="datagrid-type-custom">custom</code>. If the given column has
2043: not been declared, or its type is not <code
2044: title="datagrid-type-custom">custom</code>, then the user agent must
2045: throw a <code>DATAGRID_MODEL_ERR</code> exception. If the given row
1.1 mike 2046: is not known, then the method must do nothing. If the cell is indeed
2047: cleared, the user agent must reinvoke the previously registered
1.80 mike 2048: <code>RenderingContext2DCallback</code> callback when it needs to
1.1 mike 2049: repaint that row.</p>
2050:
1.80 mike 2051: <hr>
2052:
2053: <p>If a row has a child count that isn't zero, then the user agent
1.1 mike 2054: should offer to the user the option of opening and closing the
2055: row.</p>
2056:
2057: <p>When a row is opened, if the row's row count is greater than
2058: zero, then the user agent must increase the
1.80 mike 2059: <span><code>datagrid</code> row count</span> and the row counts of
1.1 mike 2060: any ancestor rows by the number of rows that the newly opened row
1.80 mike 2061: has in its row count<!- - we should also "update the <span>pending
1.1 mike 2062: <code>datagrid</code> rows list</span> and the <span>pending
1.80 mike 2063: <code>datagrid</code> cells list</span> accordingly" - ->, then must
2064: mark the row as open, then may fill in the <span>display order
2065: sparse data tree</span> with any information that the user agent has
1.1 mike 2066: cached about the display order positions of descendants of the newly
1.80 mike 2067: opened row, and then must invoke the <code
2068: title="dom-listener-rowOpened">rowOpened()</code> method on the
2069: current <code title="dom-datagrid-listener">listener</code> with as
2070: its first argument a <code>RowID</code> object identifying the row
1.1 mike 2071: that was opened and as its second argument the boolean false, and
1.80 mike 2072: then must invoke the <span><code>datagrid</code> update display
2073: algorithm</span>.</p>
1.1 mike 2074:
2075: <p>On the other hand, when a row is opened and the row's row count
1.80 mike 2076: is −1, then the user agent must mark the row as opening, and
2077: then must invoke the <code
2078: title="dom-listener-rowOpened">rowOpened()</code> method on the
2079: current <code title="dom-datagrid-listener">listener</code> with as
2080: its first argument a <code>RowID</code> object identifying the row
1.1 mike 2081: that was opened and as its second argument the boolean true.</p>
2082:
2083: <p>When a row is closed, the user agent must decrease the
1.80 mike 2084: <span><code>datagrid</code> row count</span> and the row counts of
1.1 mike 2085: any ancestor rows by the number of rows that the newly closed row
1.80 mike 2086: has in its row count, and then must invoke the <code
2087: title="dom-listener-rowOpened">rowOpened()</code> method on the
2088: current <code title="dom-datagrid-listener">listener</code> with as
2089: its first and only argument a <code>RowID</code> object identifying
1.1 mike 2090: the row that was opened.</p>
2091:
2092:
2093:
1.80 mike 2094: <h6>The cells</h6>
1.1 mike 2095:
2096: <p>Each row has one cell per column. Each cell has the same type as
1.80 mike 2097: its column. The <dfn>allowed <code>datagrid</code> column
1.1 mike 2098: types</dfn>, what they represent, and the requirements for when the
2099: user interacts with them, are as follows:</p>
2100:
1.80 mike 2101: <dl>
2102:
2103: <dt><dfn title="datagrid-type-text"><code>text</code></dfn></dt>
1.1 mike 2104: <dd>
2105:
2106: <p>The cell represents some text and an optional image.</p>
2107:
2108: </dd>
2109:
1.80 mike 2110: <dt><dfn title="datagrid-type-editable"><code>editable</code></dfn></dt>
1.1 mike 2111: <dd>
2112:
2113: <p>The cells represents some editable text, an optional
1.80 mike 2114: <code>datalist</code> giving autocompletion hints, and an
1.1 mike 2115: optional image.</p>
2116:
1.80 mike 2117: <p>If there is a <code>datalist</code> element, the user agent
1.1 mike 2118: should offer the suggestions represented by that element to the
1.80 mike 2119: user. The user agent may use the suggestion's <span
2120: title="concept-option-label">label</span> to identify the
1.1 mike 2121: suggestion. If the user selects a suggestion, then the editable
1.80 mike 2122: text must be set to the selected suggestion's <span
2123: title="concept-option-value">value</span>, as if the user had
1.1 mike 2124: written that value himself.</p>
2125:
2126: <p>When the user edits the value, either directly or using the
1.80 mike 2127: <code>datalist</code>, the user agent must invoke the <code
2128: title="dom-listener-cellChanged">cellChanged()</code> method on
2129: the current <code title="dom-datagrid-listener">listener</code>
2130: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2131: cell's row, as its second argument the identifier of the cell's
2132: column, as its third argument the new value, and as its fourth
2133: argument the previous value.</p>
2134:
2135: </dd>
2136:
1.80 mike 2137: <dt><dfn title="datagrid-type-checkable"><code>checkable</code></dfn></dt>
1.1 mike 2138: <dd>
2139:
2140: <p>The cell represents some text, a check box that optionally has
2141: its value obscured as indeterminate, and an optional image.</p>
2142:
2143: <p>When the user checks or unchecks the check box, the user agent
2144: must change the check box's state appropriately and stop obscuring
2145: the check box as indeterminate (if it is obscuring it), and then
1.80 mike 2146: must invoke the <code
2147: title="dom-listener-cellChanged">cellChanged()</code> method on
2148: the current <code title="dom-datagrid-listener">listener</code>
2149: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2150: cell's row, as its second argument the identifier of the cell's
2151: column, as its third argument true if the check box is now checked
2152: and false otherwise, and as its fourth argument true if the check
2153: box was previously checked and false otherwise.</p>
2154:
2155: </dd>
2156:
1.80 mike 2157: <dt><dfn title="datagrid-type-list"><code>list</code></dfn></dt>
1.1 mike 2158: <dd>
2159:
2160: <p>The cell represents some text giving the current value selected
1.80 mike 2161: from a dropdown list of options, a <code>select</code> element
1.1 mike 2162: giving the list of options, and an optional image.</p>
2163:
2164: <p>The user agent should allow the user to change the value of the
1.80 mike 2165: cell from its current value to one of the <span
2166: title="concept-option-value">values</span> given by
2167: <code>option</code> elements in the <span
2168: title="concept-select-option-list">list of options</span> (if
2169: any). The user agent may use the <code>option</code> elements'
2170: <span title="concept-option-label">labels</span> to annotate each
1.1 mike 2171: option.</p>
2172:
1.80 mike 2173: <p>When the user selects a new value from the <code>select</code>
2174: element's <span title="concept-select-option-list">list of
2175: options</span>, the user agent must invoke the <code
2176: title="dom-listener-cellChanged">cellChanged()</code> method on
2177: the current <code title="dom-datagrid-listener">listener</code>
2178: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2179: cell's row, as its second argument the identifier of the cell's
2180: column, as its third argument the new value, and as its fourth
2181: argument the previous value.</p>
2182:
2183: </dd>
2184:
1.80 mike 2185: <dt><dfn title="datagrid-type-progress"><code>progress</code></dfn></dt>
1.1 mike 2186: <dd>
2187:
2188: <p>The cell represents a (determinate) progress bar whose value is
2189: between 0.0, indicating no progress, and 1.0, indicating the task
2190: is complete.</p>
2191:
2192: </dd>
2193:
1.80 mike 2194: <dt><dfn title="datagrid-type-meter"><code>meter</code></dfn></dt>
1.1 mike 2195: <dd>
2196:
2197: <p>The cell represents a gauge, described by one to six
2198: numbers.</p>
2199:
2200: <p>The gauge's actual value is given by the first number.</p>
2201:
2202: <p>If there is a second number, then that number is the maximum
2203: value. Otherwise, the maximum value is 1.0.</p>
2204:
2205: <p>If there is a third number, then that number is the minimum
2206: value. Otherwise, the minimum value is 1.0.</p>
2207:
2208: <p>If there is a fourth number, then that number is the low
2209: boundary. Otherwise, the low boundary is the minimum value.</p>
2210:
2211: <p>If there is a fifth number, then that number is the high
2212: boundary. Otherwise, the high boundary is the maximum value.</p>
2213:
2214: <p>If there is a sixth number, then the optimal point is the sixth
2215: number. Otherwise, the optimum point is the midpoint between the
2216: minimum value and the maximum value.</p>
2217:
1.80 mike 2218: <!- - next two paragraphs copied from <meter>: - ->
1.1 mike 2219:
2220: <p>If the optimum point is equal to the low boundary or the high
2221: boundary, or anywhere in between them, then the region between the
2222: low and high boundaries of the gauge must be treated as the
2223: optimum region, and the low and high parts, if any, must be
2224: treated as suboptimal. Otherwise, if the optimum point is less
2225: than the low boundary, then the region between the minimum value
2226: and the low boundary must be treated as the optimum region, the
2227: region between the low boundary and the high boundary must be
2228: treated as a suboptimal region, and the region between the high
2229: boundary and the maximum value must be treated as an even less
2230: good region. Finally, if the optimum point is higher than the high
2231: boundary, then the situation is reversed; the region between the
2232: high boundary and the maximum value must be treated as the optimum
2233: region, the region between the high boundary and the low boundary
2234: must be treated as a suboptimal region, and the remaining region
2235: between the low boundary and the minimum value must be treated as
2236: an even less good region.</p>
2237:
2238: <p>User agents should indicate the relative position of the actual
2239: value to the minimum and maximum values, and the relationship
2240: between the actual value and the three regions of the gauge.</p>
2241:
2242: </dd>
2243:
1.80 mike 2244: <dt><dfn title="datagrid-type-custom"><code>custom</code></dfn></dt>
1.1 mike 2245: <dd>
2246:
2247: <p>The cell represents a dynamically generated graphical image.</p>
2248:
2249: <p>The cell will have minimum dimensions (specified in CSS
2250: pixels), and a callback (in the form of a
1.80 mike 2251: <code>RenderingContext2DCallback</code> object) to get a rendering
1.1 mike 2252: for the cell.</p>
2253:
2254: <p>The user agent should not allow the cell to be rendered with
2255: dimensions less than the given minimum width and height.</p>
2256:
2257: <p>When the user agent needs to render the cell, the user agent
1.80 mike 2258: must <span>queue a task</span> to invoke the
2259: <span>RenderingContext2DCallback</span> callback, passing it a
2260: newly created <code>CanvasRenderingContext2D</code> object whose
1.186 mike 2261: <code title="dom-context-2d-canvas">canvas</code> IDL attribute is
1.1 mike 2262: null as the first argument, the actual cell width in CSS pixels as
2263: the second argument, and the actual cell height in CSS pixels as
2264: the third argument.</p>
2265:
2266: <p>If the user agent is able to render graphics, then it must
2267: render the graphics commands that the callback executed on the
1.80 mike 2268: provided <code>CanvasRenderingContext2D</code> object onto the
1.1 mike 2269: cell once the callback returns. The image must be clipped to the
2270: dimensions of the cell. The coordinate space of the cell must be
2271: aligned with that used by the 2D context such that the top left
2272: corner of the cell is the 0,0 origin, with the coordinate space
2273: increasing its <var title="">x</var> dimension towards the right
2274: of the cell and its <var title="">y</var> axis towards the bottom
2275: of the cell, and with the image not scaled (so that one CSS pixel
2276: on the final rendering matches one CSS pixel in the coordinate
2277: space used by the 2D context).</p>
2278:
2279: <p>The user agent must then decouple the
1.80 mike 2280: <code>CanvasRenderingContext2D</code> object and any objects that
2281: it created (such as <code>CanvasPattern</code> objects or
2282: <code>ImageData</code> objects) from any real drawing surface.</p>
1.1 mike 2283:
2284: <p>If the user agent is unable to render graphics, then it must
2285: render the text string returned by the callback instead.</p>
2286:
2287: </dd>
2288:
1.80 mike 2289: </dl>
2290:
2291: <hr>
2292:
2293: <p>When an algorithm requires the user agent to <dfn>apply a
1.1 mike 2294: <code>Row</code> object</dfn>, the user agent must run the following
2295: steps:</p>
2296:
1.80 mike 2297: <ol>
2298:
2299: <li>
2300:
2301: <p>If the value of the <code>Row</code> object's second entry is
2302: not −1, then run these substeps:</p>
1.1 mike 2303:
1.80 mike 2304: <ol>
1.1 mike 2305:
1.80 mike 2306: <li><p>If there is a row with the same parent as the row
2307: specified by the <code>Row</code> object's <code>RowID</code>
1.1 mike 2308: object, whose display order position is currently the same as the
1.80 mike 2309: value of the <code>Row</code> object's second entry, then remove
2310: that row from the <span>display order sparse data
2311: tree</span>.</p></li>
1.1 mike 2312:
2313: <li><p>Set the display order position of the row specified by the
1.80 mike 2314: <code>Row</code> object's <code>RowID</code> to the value of the
2315: <code>Row</code> object's second entry, updating its position in
2316: the <span>display order sparse data tree</span>
1.1 mike 2317: accordingly.</p></li>
2318:
1.80 mike 2319: <li><p>If the row is in the <span>pending
2320: <code>datagrid</code> rows list</span>, remove it.</p></li>
2321:
2322: </ol>
1.1 mike 2323:
1.80 mike 2324: </li>
1.1 mike 2325:
2326: <li>
2327:
1.80 mike 2328: <p>If the fourth entry in the <code>Row</code> object (a
2329: <code>CellList</code> object, an array) is not empty, then for
2330: each <code>Cell</code> object in that array update the cell that
1.1 mike 2331: corresponds to the column identified by the value of the first
1.80 mike 2332: entry of the <code>Cell</code> object, by using the appropriate
1.1 mike 2333: set of steps given below as determined by the type of the
1.80 mike 2334: column. Then, if the cell is in the <span>pending
2335: <code>datagrid</code> cells list</span>, remove it.</p>
1.1 mike 2336:
1.80 mike 2337: <dl>
2338:
2339: <dt>If the column's type is <code title="datagrid-type-text">text</code></dt>
1.1 mike 2340: <dd>
2341:
2342: <p>Update the cell's text to the value given in the
1.80 mike 2343: <code>Cell</code> object's second entry.</p>
1.1 mike 2344:
1.80 mike 2345: <p>If the <code>Cell</code> object has three entries, then copy
2346: the image data from the <code>img</code> element given in the
1.1 mike 2347: third entry, and let the cell's image be given by that image
2348: data. Otherwise, update the cell to have no image.</p>
2349:
2350: </dd>
2351:
1.80 mike 2352: <dt>If the column's type is <code title="datagrid-type-editable">editable</code></dt>
1.1 mike 2353: <dd>
2354:
2355: <p>Update the cell's text to the value given in the
1.80 mike 2356: <code>Cell</code> object's second entry.</p>
1.1 mike 2357:
1.80 mike 2358: <p>If the <code>Cell</code> object has three entries, then let
2359: the <code>datalist</code> element given in the third entry be
2360: the <code>datalist</code> element giving autocompletion
1.1 mike 2361: hints. Otherwise, update the cell to have no
1.80 mike 2362: <code>datalist</code> element.</p>
1.1 mike 2363:
1.80 mike 2364: <p>If the <code>Cell</code> object has four entries, then copy
2365: the image data from the <code>img</code> element given in the
1.1 mike 2366: fourth entry, and let the cell's image be given by that image
2367: data. Otherwise, update the cell to have no image.</p>
2368:
2369: </dd>
2370:
1.80 mike 2371: <dt>If the column's type is <code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 2372: <dd>
2373:
2374: <p>Update the cell's text to the value given in the
1.80 mike 2375: <code>Cell</code> object's second entry.</p>
1.1 mike 2376:
2377: <p>Update the cell's checked state to match the value of the
2378: third entry: checked if true, unchecked otherwise.</p>
2379:
1.80 mike 2380: <p>If the <code>Cell</code> object has four entries and the
1.1 mike 2381: fourth entry is true, then update the cell to be obscured as
2382: indeterminate. Otherwise, the cell's state is not obscured.</p>
2383:
1.80 mike 2384: <p>If the <code>Cell</code> object has five entries, then copy
2385: the image data from the <code>img</code> element given in the
1.1 mike 2386: fifth entry, and let the cell's image be given by that image
2387: data. Otherwise, update the cell to have no image.</p>
2388:
2389: </dd>
2390:
1.80 mike 2391: <dt>If the column's type is <code title="datagrid-type-list">list</code></dt>
1.1 mike 2392: <dd>
2393:
2394: <p>Update the cell's text to the value given in the
1.80 mike 2395: <code>Cell</code> object's second entry, and the
2396: <code>select</code> element to be the one given in the
2397: <code>Cell</code> object's third entry</p>
1.1 mike 2398:
1.80 mike 2399: <p>If the <code>Cell</code> object has four entries, then copy
2400: the image data from the <code>img</code> element given in the
1.1 mike 2401: fourth entry, and let the cell's image be given by that image
2402: data. Otherwise, update the cell to have no image.</p>
2403:
2404: </dd>
2405:
1.80 mike 2406: <dt>If the column's type is <code title="datagrid-type-progress">progress</code></dt>
1.1 mike 2407: <dd>
2408:
2409: <p>Update the cell to be a progress bar whose progress, on the
2410: scale of 0.0 (no progress) to 1.0 (task complete) is given by
1.80 mike 2411: the value in the <code>Cell</code> object's second entry.</p>
1.1 mike 2412:
2413: </dd>
2414:
1.80 mike 2415: <dt>If the column's type is <code title="datagrid-type-meter">meter</code></dt>
1.1 mike 2416: <dd>
2417:
2418: <p>Update the cell to be a gauge configured with the numbers
2419: given by the second and subsequent entries of the
1.80 mike 2420: <code>Cell</code> object.</p>
1.1 mike 2421:
2422: </dd>
2423:
1.80 mike 2424: <dt>If the column's type is <code title="datagrid-type-custom">custom</code></dt>
1.1 mike 2425: <dd>
2426:
2427: <p>Update the cell's minimum width to be the length in CSS
1.80 mike 2428: pixels given by the <code>Cell</code> object's second entry.</p>
1.1 mike 2429:
2430: <p>Update the cell's minimum height to be the length in CSS
1.80 mike 2431: pixels given by the <code>Cell</code> object's third entry.</p>
1.1 mike 2432:
2433: <p>Update the cell's callback to be the
1.80 mike 2434: <code>RenderingContext2DCallback</code> object given by the
2435: <code>Cell</code> object's fourth entry.</p>
1.1 mike 2436:
2437: </dd>
2438:
1.80 mike 2439: </dl>
2440:
2441: </li>
1.1 mike 2442:
1.80 mike 2443: </ol>
2444:
2445: <hr>
2446:
2447: <p>When the user agent is to run the <dfn><code>datagrid</code>
2448: update display algorithm</dfn>, the user agent must invoke the <code
2449: title="dom-listener-getRows">getRows()</code> and <code
2450: title="dom-listener-getCells">getCells()</code> methods on the
2451: current <code title="dom-datagrid-listener">listener</code> such
2452: that all the current visible rows in the <span>display order sparse
2453: data list</span>, and all the cells in the currently visible columns
1.1 mike 2454: on all the currently visible rows, have been covered.</p>
2455:
1.80 mike 2456: <p>A row is considered covered if it is present in the <span>pending
2457: <code>datagrid</code> rows list</span>, or if the <code
2458: title="dom-listener-getRows">getRows()</code> method is invoked with
1.1 mike 2459: a range that includes the row in question.</p>
2460:
2461: <p>A cell is considered covered if it is present in the
1.80 mike 2462: <span>pending <code>datagrid</code> cells list</span>, or if the
2463: <code title="dom-listener-getRows">getRows()</code> method is
1.1 mike 2464: invoked with a range that includes the row in question and a list of
1.80 mike 2465: columns that includes the cell's column, or if the <code
2466: title="dom-listener-getCells">getCells()</code> method is invoked
1.1 mike 2467: with a list of rows and columns that intersects the cell in
1.80 mike 2468: question. However, the <code
2469: title="dom-listener-getCells">getCells()</code> method can only be
2470: used if the row is already present in the <span>display order sparse
2471: data list</span>.</p>
1.1 mike 2472:
1.80 mike 2473: <p>The <code title="dom-listener-getRows">getRows()</code> method,
1.1 mike 2474: if used, must be invoked with five arguments. The first argument
1.80 mike 2475: must be the index in the <span>display order sparse data list</span>
1.1 mike 2476: to the first row that the user agent is requesting, known as the
2477: <i>anchor row</i>. The second argument must be the number of
2478: consecutive cells for which the user agent is requesting
1.80 mike 2479: information. The third argument must be the <code>RowID</code> of
2480: the row that is the nearest ancestor in the <span>display order
2481: sparse data <em>tree</em></span> of the anchor row. If this is the
2482: <code>datagrid</code>, then the <code>RowID</code> object must be an
1.1 mike 2483: empty array. The fourth argument must be the display order position
1.80 mike 2484: of the anchor row in the <span>display order sparse data
2485: tree</span>, assuming that the row identified in the third argument
1.1 mike 2486: is indeed the anchor row's parent row. The fifth and final argument
2487: must be an array of the identifiers of the columns for which the
2488: user agent is requesting information, in the order they were added
1.80 mike 2489: to the <code>datagrid</code>.</p>
1.1 mike 2490:
1.80 mike 2491: <p>As the <code title="dom-listener-getRows">getRows()</code> method
2492: is invoked, the <span>pending <code>datagrid</code> rows list</span>
1.1 mike 2493: must be updated to include the rows for which information has been
2494: requested, excluding rows for which information is already
1.80 mike 2495: available; and the <span>pending <code>datagrid</code> cells
2496: list</span> must be updated to include the cells for which
1.1 mike 2497: information has been requested on those rows.</p>
2498:
1.80 mike 2499: <p>The <code title="dom-listener-getCells">getCells()</code> method,
1.1 mike 2500: if used, must be invoked with two arguments. The first argument must
1.80 mike 2501: be an array of <code>RowID</code> objects identifying the rows for
1.1 mike 2502: which information is being requested. The second argument must be an
2503: array of the identifiers of the columns for which the user agent is
2504: requesting information, in the order they were added to the
1.80 mike 2505: <code>datagrid</code>.</p>
1.1 mike 2506:
1.80 mike 2507: <p>As the <code title="dom-listener-getCells">getCells()</code>
2508: method is invoked, the <span>pending <code>datagrid</code> cells
2509: list</span> must be updated to include the cells for which
1.1 mike 2510: information has been requested.</p>
2511:
2512: <p>Calls to these methods should be batched so that the rows and
2513: cells to be covered are handled by the fewest number of calls to
2514: these methods as possible. To this end, user agents may invoke the
1.80 mike 2515: <code title="dom-listener-getRows">getRows()</code> method for a set
1.1 mike 2516: of rows that includes some rows that are already in the
1.80 mike 2517: <span>display order sparse data list</span>, and similarly may
2518: invoke the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2519: method with row/column combinations that cover some cells for which
2520: data is already known. Generally, however, user agents should avoid
2521: invoking these methods with arguments that cause information to be
2522: requested when it has already been requested or is already
2523: known.</p>
2524:
2525: <div class="example">
2526:
2527: <p>For example, consider a case represented by the following table,
2528: where the cells marked "Yes" indicate that the data has already
2529: been obtained, the cells marked "Pending" indicate that the data
2530: has been previously requested but not yet obtained, and the cells
2531: with just a dash indicate that no information has ever been
2532: obtained, or any information that had been obtained has now been
2533: discarded.</p>
2534:
1.80 mike 2535: <table>
2536: <tr> <td> <th> Row <th> Column A <th> Column B
2537: <tr> <th> Row 1 <td> - <td> - <td> -
2538: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes
2539: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes
2540: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes
2541: <tr> <th> Row 5 <td> - <td> - <td> -
2542: <tr> <th> Row 6 <td> - <td> - <td> -
2543: <tr> <th> Row 7 <td> Yes <td> Pending <td> -
2544: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending
2545: </table>
2546:
2547: <p>Thus, rows 2, 3, 4, 7, and 8 are already covered, as are the
1.1 mike 2548: cells from those rows except for the cell in column B of row 7.</p>
2549:
2550: <p>Now consider what happens if all of these rows become visible at
2551: once. The user agent has several choices, including (but not
2552: limited to) the following:</p>
2553:
1.80 mike 2554: <ul>
2555:
2556: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2557: method for rows 1 through 8 and columns A and B all at once.</li>
2558:
1.80 mike 2559: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2560: method for row 1, then fire it again for rows 5 through 7.</li>
2561:
1.80 mike 2562: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2563: method for row 1, then fire it again for rows 5 and 6, and then
1.80 mike 2564: fire the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2565: method for row 7 column B.</li>
2566:
1.80 mike 2567: </ul>
2568:
2569: <p>All three options are allowed, but the latter two are preferable
1.1 mike 2570: to the former, as they minimise the amount of redundant information
2571: requested.</p>
2572:
2573: <p>In any case, the data model now looks like this:</p>
2574:
1.80 mike 2575: <table>
2576: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2577: <tr> <th> Row 1 <td> Pending <td> Pending <td> Pending <td> -
2578: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> -
2579: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> -
2580: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> -
2581: <tr> <th> Row 5 <td> Pending <td> Pending <td> Pending <td> -
2582: <tr> <th> Row 6 <td> Pending <td> Pending <td> Pending <td> -
2583: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> -
2584: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> -
2585: </table>
2586:
2587: <p>Now consider the case where a third column, column C, is added
1.1 mike 2588: to the data model. The user agent once again has several choices,
2589: including (but not limited to) the following:</p>
2590:
1.80 mike 2591: <ul>
2592:
2593: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2594: method for rows 1 through 8 again, this time listing just column
2595: C.</li>
2596:
1.80 mike 2597: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2598: method for row 1, then fire it again for rows 5 and 6, and then
1.80 mike 2599: fire the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2600: method for the other rows (in all three cases, listing just column
2601: C).</li>
2602:
1.80 mike 2603: </ul>
2604:
2605: <p>The two options here are as bad as each other; the former
1.1 mike 2606: involves a lot of overlap, but the latter involves a lot of method
2607: calls. Unfortunately the user agent can't do the obvious thing,
1.80 mike 2608: namely just to invoke the <code
2609: title="dom-listener-getCells">getCells()</code> method for all the
1.1 mike 2610: rows listing just column C, because it doesn't have the row
2611: information for all the rows yet (rows 1, 5 and 6 are still
2612: pending).</p>
2613:
2614: <p>In any case, the data model now looks like this:</p>
2615:
1.80 mike 2616: <table>
2617: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2618: <tr> <th> Row 1 <td> Pending <td> Pending <td> Pending <td> Pending
2619: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> Pending
2620: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> Pending
2621: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> Pending
2622: <tr> <th> Row 5 <td> Pending <td> Pending <td> Pending <td> Pending
2623: <tr> <th> Row 6 <td> Pending <td> Pending <td> Pending <td> Pending
2624: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> Pending
2625: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> Pending
2626: </table>
2627:
2628: <p>If at this point the user scrolls around anywhere within this
2629: <code>datagrid</code>, the user agent won't fire the <code
2630: title="dom-listener-getRows">getRows()</code> and <code
2631: title="dom-listener-getCells">getCells()</code> methods, because
1.1 mike 2632: all of the rows and cells are covered.</p>
2633:
2634: <p>Now consider the case where the user agent receives row
2635: information, but no cell information, for rows 1, 5, and 6:</p>
2636:
1.80 mike 2637: <table>
2638: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2639: <tr> <th> Row 1 <td> Yes <td> Pending <td> Pending <td> Pending
2640: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> Pending
2641: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> Pending
2642: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> Pending
2643: <tr> <th> Row 5 <td> Yes <td> Pending <td> Pending <td> Pending
2644: <tr> <th> Row 6 <td> Yes <td> Pending <td> Pending <td> Pending
2645: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> Pending
2646: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> Pending
2647: </table>
2648:
2649: <p>The user agent still won't fire any methods when the user
1.1 mike 2650: scrolls, because the data is still covered. But if the script then
1.80 mike 2651: calls the <code title="dom-datagrid-renotify">renotify()</code>
1.1 mike 2652: method, the "Pending" flags would get reset, and the model would
2653: now look like this:</p>
2654:
1.80 mike 2655: <table>
2656: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2657: <tr> <th> Row 1 <td> Yes <td> - <td> - <td> -
2658: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> -
2659: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> -
2660: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> -
2661: <tr> <th> Row 5 <td> Yes <td> - <td> - <td> -
2662: <tr> <th> Row 6 <td> Yes <td> - <td> - <td> -
2663: <tr> <th> Row 7 <td> Yes <td> - <td> - <td> -
2664: <tr> <th> Row 8 <td> Yes <td> - <td> - <td> -
2665: </table>
2666:
2667: <p>Now, assuming that all eight rows and all three columns are
1.1 mike 2668: still visible, the user agent has the following choices (amongst
2669: others):</p>
2670:
1.80 mike 2671: <ul>
2672:
2673: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2674: method for rows 1 through 8, listing all three columns.</li>
2675:
1.80 mike 2676: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2677: method for rows 1 and 5 through 8, listing all three columns, and
2678: then fire the method for rows 2 through 4, listing just column
2679: C.</li>
2680:
1.80 mike 2681: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2682: method for rows 1 and 5 through 8, listing just columns A abd B,
2683: and then fire the method for rows 1 through 8, listing just column
2684: C.</li>
2685:
1.80 mike 2686: </ul>
2687:
2688: <p>Here the latter two are preferable because they result in less
1.1 mike 2689: overlap than the first.</p>
2690:
2691: </div>
2692:
1.80 mike 2693: <hr>
2694:
2695: <p>The <span>task source</span> for tasks queued on behalf of a
2696: <code>datagrid</code> is the <span>DOM manipulation task
2697: source</span>.</p>
2698:
2699: </div>
2700:
2701:
2702: <h5>Listening to notifications from the <code>datagrid</code></h5>
1.1 mike 2703:
1.80 mike 2704: <p><i>The conformance criteria in this section apply to any
2705: implementation of the <code>DataGridListener</code> interface,
1.1 mike 2706: including (and most commonly) the content author's
1.80 mike 2707: implementation(s).</i></p>
2708:
2709: <pre class="idl">// To be implemented by Web authors as a JS object
1.81 mike 2710: [NoInterfaceObject]
2711: interface <dfn>DataGridListener</dfn> {
1.80 mike 2712: void <span title="dom-listener-initialize">initialize</span>(in <span>HTMLDataGridElement</span> datagrid);
2713:
2714: void <span title="dom-listener-getRows">getRows</span>(in unsigned long rowIndex, in unsigned long rowCount, in <span>RowID</span> parentRow, in unsigned long position, in <span>ColumnList</span> columns);
2715: void <span title="dom-listener-getCells">getCells</span>(in <span>RowIDList</span> rows, in <span>ColumnList</span> columns);
2716: void <span title="dom-listener-rowOpened">rowOpened</span>(in <span>RowID</span> row, in boolean rowCountNeeded);
2717: void <span title="dom-listener-rowClosed">rowClosed</span>(in <span>RowID</span> row);
2718:
2719: void <span title="dom-listener-cellChanged">cellChanged</span>(in <span>RowID</span> row, in <span>Column</span> column, in any newValue, in any prevValue);
2720: <span>HTMLMenuElement</span> <span title="dom-listener-getRowMenu">getRowMenu</span>(in <span>RowID</span> row);
2721: <!- -vsDGDND
1.1 mike 2722: boolean <span title="dom-listener-canDrop">canDrop</span>(in <span>RowID</span> row, in <span>RowID</span> position, data);
2723: boolean <span title="dom-listener-dropped">dropped</span>(in <span>RowID</span> row, in <span>RowID</span> position, data);
1.80 mike 2724: - -><!- -v2DGPA
1.1 mike 2725: void <span title="dom-listener-performAction">performAction</span>(in <span>RowID</span> row, in DOMString action);
1.80 mike 2726: - ->};</pre>
2727:
2728: <p>The <code>DataGridListener</code> interface, once implemented by
2729: an object in a script and hooked up to a <code>datagrid</code> using
1.186 mike 2730: the <code title="dom-datagrid-listener">listener</code> IDL
1.80 mike 2731: attribute, receives notifications when the <code>datagrid</code>
2732: needs information (such as which rows exist) for display.</p>
2733:
2734: <p>The following methods may be usefully implemented:</p>
2735:
2736: <dl>
2737:
2738: <dt><dfn title="dom-listener-initialize"><code>initialize(<var title="">datagrid</var>)</code></dfn></dt>
1.1 mike 2739:
2740: <dd>
2741:
1.80 mike 2742: <p>Called by the <code>datagrid</code> element (the one given by
2743: the <var title="">datagrid</var> argument) when the <code
2744: title="dom-datagrid-listener">listener</code> attribute is
1.1 mike 2745: set.</p>
2746:
2747: </dd>
2748:
1.80 mike 2749: <dt><dfn title="dom-listener-getRows"><code>getRows(<var title="">rowIndex</var>, <var title="">rowCount</var>, <var title="">parentRow</var>, <var title="">position</var>, <var title="">columns</var>)</code></dfn></dt>
1.1 mike 2750:
2751: <dd>
2752:
1.80 mike 2753: <p>Called by the <code>datagrid</code> element when the user agent
1.1 mike 2754: finds itself needing to render rows for which it is lacking
2755: information.</p>
2756:
2757: <p>The <var title="">rowIndex</var> argument gives the flattened
2758: index of the first row for which it needs information, ignoring
1.80 mike 2759: the tree structure of the <code>datagrid</code> model, where zero
1.1 mike 2760: is the first row of the entire tree.</p>
2761:
2762: <p>The <var title="">rowCount</var> argument gives the number of
2763: rows for which the user agent would like information.</p>
2764:
2765: <p>The <var title="">parentRow</var> argument gives the
1.80 mike 2766: <code>RowID</code> object identifying the nearest ancestor of the
1.1 mike 2767: first row that the user agent is aware of. After the sort order
2768: has changed, this will typically be the root of the tree
1.80 mike 2769: (identified by a <code>RowID</code> object consisting of an empty
1.1 mike 2770: array).
2771:
1.80 mike 2772: <p>The <var title="">columns</var> argument gives the columns for
1.1 mike 2773: which the user agent is lacking information, as an array of column
1.80 mike 2774: identifiers (as passed to <code
2775: title="dom-datagrid-addColumn">addColumn()</code>).</p>
1.1 mike 2776:
2777: </dd>
2778:
1.80 mike 2779: <dt><dfn title="dom-listener-getCells"><code>getCells(<var title="">rows</var>, <var title="">columns</var>)</code></dfn></dt>
1.1 mike 2780:
2781: <dd>
2782:
1.80 mike 2783: <p>Called by the <code>datagrid</code> element when the user agent
1.1 mike 2784: finds itself needing to render cells for which it is lacking
2785: information in rows that it does know about.</p>
2786:
2787: <p>The <var title="">rows</var> argument gives an array of
1.80 mike 2788: <code>RowID</code> objects identifying the various rows for which
1.1 mike 2789: the user agent is lacking information.</p>
2790:
2791: <p>The <var title="">columns</var> argument gives the columns for
2792: which the user agent is lacking information, as an array of column
1.80 mike 2793: identifiers (as passed to <code
2794: title="dom-datagrid-addColumn">addColumn()</code>).</p>
1.1 mike 2795:
2796: </dd>
2797:
1.80 mike 2798: <dt><dfn title="dom-listener-rowOpened"><code>rowOpened(<var title="">row</var>, <var title="">rowCountNeeded</var>)</code></dfn></dt>
1.1 mike 2799:
2800: <dd>
2801:
1.80 mike 2802: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2803: opened a row.</p>
2804:
2805: <p>The <var title="">row</var> argument gives an
1.80 mike 2806: <code>RowID</code> object identifying the row that was opened.</p>
1.1 mike 2807:
2808: <p>If the user agent also knows how many children that row has,
2809: then the <var title="">rowCountNeeded</var> argument will be
2810: false. Otherwise, the argument will be true, and the row will
1.80 mike 2811: remain closed until the <code
2812: title="dom-datagrid-setRows">setRows()</code> method is called
1.1 mike 2813: with an accurate row count.</p>
2814:
2815: </dd>
2816:
1.80 mike 2817: <dt><dfn title="dom-listener-rowClosed"><code>rowClosed(<var title="">row</var>)</code></dfn></dt>
1.1 mike 2818:
2819: <dd>
2820:
1.80 mike 2821: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2822: opened a row.</p>
2823:
2824: <p>The <var title="">row</var> argument gives an
1.80 mike 2825: <code>RowID</code> object identifying the row that was closed.</p>
1.1 mike 2826:
2827: </dd>
2828:
1.80 mike 2829: <dt><dfn title="dom-listener-cellChanged"><code>cellChanged(<var title="">row</var>, <var title="">column</var>, <var title="">newValue</var>, <var title="">prevValue</var>)</code></dfn></dt>
1.1 mike 2830:
2831: <dd>
2832:
1.80 mike 2833: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2834: edited a cell or checked a check box in a cell.</p>
2835:
2836: <p>The <var title="">row</var> argument gives an
1.80 mike 2837: <code>RowID</code> object identifying the row of the cell, and the
1.1 mike 2838: <var title="">column</var> argument gives the identifier of the
2839: cell's column.</p>
2840:
2841: <p>The <var title="">newValue</var> argument gives the new value,
2842: and the <var title="">prevValue</var> argument gives the previous
2843: value.</p>
2844:
2845: </dd>
2846:
1.80 mike 2847: <dt><dfn title="dom-listener-getRowMenu"><code>getRowMenu(<var title="">row</var>)</code></dfn></dt>
1.1 mike 2848:
1.80 mike 2849: <dd>Must return an <code>HTMLMenuElement</code> object that is to
1.1 mike 2850: be used as a context menu for row <var title="">row</var>, or null
2851: if there is no particular context menu. May be omitted if none of
2852: the rows have a special context menu. As this method is called
2853: immediately before showing the menu in question, no precautions
2854: need to be taken if the return value of this method changes.</dd>
2855:
1.80 mike 2856: <!- -v2DGDND, v2DFPA- ->
1.1 mike 2857:
1.80 mike 2858: </dl>
2859:
2860: <div class="impl">
1.1 mike 2861:
1.80 mike 2862: <p>Objects that implement the <code>DataGridListener</code>
1.1 mike 2863: interface may omit any or all of the methods. When a method is
2864: omitted, a user agent intending to call that method must instead
2865: skip the method call, and must assume that the method's return value
2866: is null.</p>
2867:
1.80 mike 2868: </div>
2869:
2870:
2871:
2872: <!- - v2DGS: <datagrid> selection (search for the bits marked "..." to see what needs filling in, at a minimum)
1.1 mike 2873:
2874: <h5>The selection</h5>
2875:
2876: <pre class="idl">interface <dfn>DataGridSelection</dfn> {
2877: readonly attribute unsigned long <span title="dom-DataGridSelection-length">length</span>;
1.81 mike 2878: getter <span>RowID</span> <span title="dom-DataGridSelection-item">item</span>(in unsigned long index);
1.1 mike 2879: boolean <span title="dom-DataGridSelection-isSelected">isSelected</span>(in <span>RowID</span> row);
2880: void <span title="dom-DataGridSelection-setSelected">setSelected</span>(in <span>RowID</span> row, in boolean selected);
2881: void <span title="dom-DataGridSelection-selectAll">selectAll</span>();
2882: void <span title="dom-DataGridSelection-clear">clear</span>();
2883: };</pre>
2884:
2885: <dl class="domintro">
2886:
2887: ...
2888:
2889: </dl>
2890:
2891: <div class="impl">
2892:
2893: <p>Each <code>datagrid</code> element must keep track of which rows
2894: are currently selected. Initially, no rows are selected. This can be
2895: changed using the methods described in this section.</p>
2896:
2897: <p>The selection of a <code>datagrid</code> is represented by its
1.186 mike 2898: <dfn title="dom-datagrid-selection"><code>selection</code></dfn> IDL
1.1 mike 2899: attribute, which must be a <code>DataGridSelection</code> object.</p>
2900:
2901: <p><code>DataGridSelection</code> objects represent the rows in the
2902: selection. In the selection the rows must be ordered in their
2903: natural order (and not, e.g., the display order). A row with an
2904: ancestor that is closed cannot be selected.</p>
2905:
2906: <p>The <dfn
2907: title="dom-DataGridSelection-length"><code>length</code></dfn>
2908: attribute must return the number of rows currently present in the
2909: selection. This is the <var
2910: title="dom-DataGridSelection-length">length</var>.</p>
2911:
2912: <p>The object's <span>indices of the supported indexed
2913: properties</span> are the numbers in the range zero to <span title=""><var
2914: title="dom-DataGridSelection-length">length</var>-1</span>, unless
2915: the <var title="dom-DataGridSelection-length">length</var> is zero,
2916: in which case there are no <span>supported indexed
2917: properties</span>.</p>
2918:
2919: <p>The <dfn title="dom-DataGridSelection-item"><code>item(<var
2920: title="">index</var>)</code></dfn> method must return a
2921: <code>RowID</code> object identifying the <var
2922: title="">index</var>th row in the selection. If the argument is out
2923: of range (less than zero or greater than the number of selected rows
2924: minus one), then it must raise an <code>INDEX_SIZE_ERR</code>
1.98 mike 2925: exception. <a href="#refsDOMCORE">[DOMCORE]</a></p>
1.1 mike 2926:
2927: <p>The <dfn
2928: title="dom-DataGridSelection-isSelected"><code>isSelected()</code></dfn>
2929: method must return the selected state of the row specified by its
2930: argument. If the specified row is in the <span>natural order sparse
2931: data tree</span> and is selected, the method must return true,
2932: otherwise it must return false.</p>
2933:
2934: <p>The <dfn
2935: title="dom-DataGridSelection-setSelected"><code>setSelected()</code></dfn>
2936: method takes two arguments, <var title="">row</var> and <var
2937: title="">selected</var>. When invoked, it must set the selection
2938: state of row <var title="">row</var> to selected if <var
2939: title="">selected</var> is true, and unselected if it is false. If
2940: <var title="">row</var> does not specify a row in the <span>natural
2941: order sparse data tree</span> ...
2942:
2943: <p>The <dfn
2944: title="dom-DataGridSelection-selectAll"><code>selectAll()</code></dfn>
2945: method must ...
2946:
2947: <p>The <dfn
2948: title="dom-DataGridSelection-clear"><code>clear()</code></dfn>
2949: method must mark all the rows in the <code>datagrid</code> as not
2950: selected. After a call to <code
2951: title="dom-DataGridSelection-clear">clear()</code>, the <code
2952: title="dom-DataGridSelection-length">length</code> attribute will
2953: return zero.</p>
2954:
2955: <p>If the <code>datagrid</code> element has a <code
2956: title="attr-datagrid-multiple">multiple</code> attribute, then the
2957: user agent should allow the user to select any number of rows (zero
2958: or more). If the attribute is not present, then the user agent
2959: should allow the user to select a row, and must not allow the user
2960: to select more than a single row at a time; selecting another one
2961: must unselect all the other rows.</p>
2962:
2963: <p class="note">This only applies to the user. Scripts can select
2964: multiple rows even when the <code
2965: title="attr-datagrid-multiple">multiple</code> attribute is
2966: absent.</p>
2967:
2968: ...event on selection change?...
2969:
2970: </div>
2971:
2972: <p class="note">The <code>DataGridSelection</code> interface has no
2973: relation to the <code>Selection</code> interface.</p>
2974:
1.80 mike 2975: - ->
2976:
2977:
2978: <!- -vsDGDND
1.1 mike 2979: <h5>Drag and drop in <code>datagrid</code>s</h5>
2980:
2981: <p><i>This section only applies to interactive user agents.</i></p>
2982:
2983: ...define drag and drop in datagrids; selectiondraggable...
1.80 mike 2984: - ->
2985:
1.729 mike 2986: --><h4 id="the-command"><span class="secno">4.11.3 </span>The <dfn><code>command</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><dl class="element"><dt>Categories</dt>
1.153 mike 2987: <dd><a href="dom.html#metadata-content">Metadata content</a>.</dd>
2988: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
2989: <dd><a href="dom.html#phrasing-content">Phrasing content</a>.</dd>
1.1 mike 2990: <dt>Contexts in which this element may be used:</dt>
1.153 mike 2991: <dd>Where <a href="dom.html#metadata-content">metadata content</a> is expected.</dd>
2992: <dd>Where <a href="dom.html#phrasing-content">phrasing content</a> is expected.</dd>
1.1 mike 2993: <dt>Content model:</dt>
2994: <dd>Empty.</dd>
2995: <dt>Content attributes:</dt>
2996: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
2997: <dd><code title="attr-command-type"><a href="#attr-command-type">type</a></code></dd>
2998: <dd><code title="attr-command-label"><a href="#attr-command-label">label</a></code></dd>
2999: <dd><code title="attr-command-icon"><a href="#attr-command-icon">icon</a></code></dd>
3000: <dd><code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code></dd>
3001: <dd><code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code></dd>
3002: <dd><code title="attr-command-radiogroup"><a href="#attr-command-radiogroup">radiogroup</a></code></dd>
3003: <!--<dd><code title="attr-command-default">default</code></dd>-->
3004: <dd>Also, the <code title="attr-command-title"><a href="#attr-command-title">title</a></code> attribute has special semantics on this element.</dd>
3005: <dt>DOM interface:</dt>
3006: <dd>
3007: <pre class="idl">interface <dfn id="htmlcommandelement">HTMLCommandElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
3008: attribute DOMString <a href="#dom-command-type" title="dom-command-type">type</a>;
3009: attribute DOMString <a href="#dom-command-label" title="dom-command-label">label</a>;
3010: attribute DOMString <a href="#dom-command-icon" title="dom-command-icon">icon</a>;
3011: attribute boolean <a href="#dom-command-disabled" title="dom-command-disabled">disabled</a>;
3012: attribute boolean <a href="#dom-command-checked" title="dom-command-checked">checked</a>;
3013: attribute DOMString <a href="#dom-command-radiogroup" title="dom-command-radiogroup">radiogroup</a>;<!--
3014: attribute boolean <span title="dom-command-default">default</span>;-->
3015: };</pre>
3016: </dd>
3017: </dl><p>The <code><a href="#the-command">command</a></code> element represents a command that the user
1.117 mike 3018: can invoke.</p><p>The <dfn id="attr-command-type" title="attr-command-type"><code>type</code></dfn>
1.1 mike 3019: attribute indicates the kind of command: either a normal command
3020: with an associated action, or a state or option that can be toggled,
1.117 mike 3021: or a selection of one item from a list of items.</p><p>The attribute is an <a href="infrastructure.html#enumerated-attribute">enumerated attribute</a> with three
1.289 mike 3022: keywords and states. The "<dfn id="attr-command-type-keyword-command" title="attr-command-type-keyword-command"><code>command</code></dfn>"
3023: keyword maps to the <a href="#attr-command-type-state-command" title="attr-command-type-state-command">Command</a> state, the
1.520 mike 3024: "<dfn id="attr-command-type-keyword-checkbox" title="attr-command-type-keyword-checkbox"><code>checkbox</code></dfn>"
1.289 mike 3025: keyword maps to the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state, and
3026: the "<dfn id="attr-command-type-keyword-radio" title="attr-command-type-keyword-radio"><code>radio</code></dfn>"
1.1 mike 3027: keyword maps to the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state. The
1.117 mike 3028: <i>missing value default</i> is the <a href="#attr-command-type-state-command" title="attr-command-type-state-command">Command</a> state.</p><dl><dt>The <dfn id="attr-command-type-state-command" title="attr-command-type-state-command">Command</dfn> state</dt>
1.1 mike 3029:
3030: <dd><p>The element <a href="the-xhtml-syntax.html#represents">represents</a> a normal command with an associated action.</p></dd>
3031:
3032: <dt>The <dfn id="attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</dfn> state</dt>
3033:
3034: <dd><p>The element <a href="the-xhtml-syntax.html#represents">represents</a> a state or option that can be toggled.</p></dd>
3035:
3036: <dt>The <dfn id="attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</dfn> state</dt>
3037:
3038: <dd><p>The element <a href="the-xhtml-syntax.html#represents">represents</a> a selection of one item from a list of items.</p></dd>
3039:
3040: </dl><p>The <dfn id="attr-command-label" title="attr-command-label"><code>label</code></dfn>
1.718 mike 3041: attribute gives the name of the command, as shown to the user. The
3042: <code title="attr-command-label"><a href="#attr-command-label">label</a></code> attribute must be
3043: specified and must have a value that is not the empty string.</p><p>The <dfn id="attr-command-title" title="attr-command-title"><code>title</code></dfn>
1.1 mike 3044: attribute gives a hint describing the command, which might be shown
1.117 mike 3045: to the user to help him.</p><p>The <dfn id="attr-command-icon" title="attr-command-icon"><code>icon</code></dfn>
1.1 mike 3046: attribute gives a picture that represents the command. If the
3047: attribute is specified, the attribute's value must contain a
3048: <a href="infrastructure.html#valid-url">valid URL</a>. <span class="impl">To obtain the
3049: <a href="infrastructure.html#absolute-url">absolute URL</a> of the icon, the attribute's value must be
3050: <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolved</a> relative to the
1.117 mike 3051: element.</span></p><!-- this is affected by the base URL being
1.1 mike 3052: changed, so users of this should cache the image once they've
1.117 mike 3053: fetched it once, at least until the relative url changes again --><p>The <dfn id="attr-command-disabled" title="attr-command-disabled"><code>disabled</code></dfn> attribute
1.1 mike 3054: is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a> that, if present, indicates that
1.117 mike 3055: the command is not available in the current state.</p><p class="note">The distinction between <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> and <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> is subtle. A command would be
1.1 mike 3056: disabled if, in the same context, it could be enabled if only
3057: certain aspects of the situation were changed. A command would be
3058: marked as hidden if, in that situation, the command will never be
3059: enabled. For example, in the context menu for a water faucet, the
3060: command "open" might be disabled if the faucet is already open, but
3061: the command "eat" would be marked hidden since the faucet could
1.117 mike 3062: never be eaten.</p><p>The <dfn id="attr-command-checked" title="attr-command-checked"><code>checked</code></dfn>
1.1 mike 3063: attribute is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a> that, if present,
3064: indicates that the command is selected. The attribute must be
3065: omitted unless the <code title="attr-command-type"><a href="#attr-command-type">type</a></code>
3066: attribute is in either the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state or
3067: the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a>
1.117 mike 3068: state.</p><p>The <dfn id="attr-command-radiogroup" title="attr-command-radiogroup"><code>radiogroup</code></dfn>
1.1 mike 3069: attribute gives the name of the group of commands that will be
3070: toggled when the command itself is toggled, for commands whose <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute has the value "<code title="">radio</code>". The scope of the name is the child list of
1.117 mike 3071: the parent element. The attribute must be omitted unless the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is in the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state.</p><!--
1.1 mike 3072: <p>If the <code>command</code> element is used when <span
3073: title="menu generation">generating</span> a <span>context
3074: menu</span>, then the <dfn
3075: title="attr-command-default"><code>default</code></dfn> attribute
3076: indicates, if present, that the command is the one that would have
3077: been invoked if the user had directly activated the menu's subject
3078: instead of using its context menu. The <code
3079: title="attr-command-default">default</code> attribute is a
3080: <span>boolean attribute</span>. The attribute must be omitted unless
3081: the <code title="attr-command-type">type</code> attribute is in the
3082: <span title="attr-command-type-state-command">Command</span>
3083: state.</p>
3084:
3085: <div class="example">
3086:
3087: ...an example that shows an element that, if double-clicked,
3088: invokes an action, but that also has a context menu, showing the
3089: various <code>command</code> attributes off, and that has a default
3090: command...
3091:
3092: </div>
1.117 mike 3093: --><div class="impl">
1.1 mike 3094:
3095: <p>The <dfn id="dom-command-type" title="dom-command-type"><code>type</code></dfn>, <dfn id="dom-command-label" title="dom-command-label"><code>label</code></dfn>, <dfn id="dom-command-icon" title="dom-command-icon"><code>icon</code></dfn>, <dfn id="dom-command-disabled" title="dom-command-disabled"><code>disabled</code></dfn>, <dfn id="dom-command-checked" title="dom-command-checked"><code>checked</code></dfn>, and <dfn id="dom-command-radiogroup" title="dom-command-radiogroup"><code>radiogroup</code></dfn><!--,
3096: and <dfn title="dom-command-default"><code>default</code></dfn>-->
1.186 mike 3097: IDL attributes must <a href="infrastructure.html#reflect">reflect</a> the respective content
1.1 mike 3098: attributes of the same name.</p>
3099:
1.153 mike 3100: <p>The element's <a href="embedded-content-0.html#activation-behavior">activation behavior</a> depends on the
1.1 mike 3101: value of the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute
3102: of the element, as follows:</p>
3103:
3104: <dl class="switch"><dt>If the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is
3105: in the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state</dt>
3106:
3107: <dd><p>If the element has a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, the UA must
3108: remove that attribute. Otherwise, the UA must add a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, with the
3109: literal value <code title="">checked</code>. The UA must then
1.788 mike 3110: <a href="webappapis.html#fire-a-click-event">fire a <code title="event-click">click</code> event</a> at the
1.1 mike 3111: element.</p></dd>
3112:
3113:
3114: <dt>If the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is
3115: in the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state</dt>
3116:
3117: <dd><p>If the element has a parent, then the UA must walk the list
3118: of child nodes of that parent element, and for each node that is a
3119: <code><a href="#the-command">command</a></code> element, if that element has a <code title="attr-command-radiogroup"><a href="#attr-command-radiogroup">radiogroup</a></code> attribute whose
3120: value exactly matches the current element's (treating missing <code title="attr-command-radiogroup"><a href="#attr-command-radiogroup">radiogroup</a></code> attributes as if
3121: they were the empty string), and has a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, must remove
3122: that attribute.</p>
3123:
3124: <p>Then, the element's <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute attribute
3125: must be set to the literal value <code title="">checked</code> and
1.788 mike 3126: the user agent must <a href="webappapis.html#fire-a-click-event">fire a <code title="event-click">click</code>
1.1 mike 3127: event</a> at the element.</p></dd>
3128:
3129:
3130: <dt>Otherwise</dt>
3131:
1.153 mike 3132: <dd><p>The element has no <a href="embedded-content-0.html#activation-behavior">activation behavior</a>.</p></dd>
1.1 mike 3133:
3134: </dl><p class="note">Firing a synthetic <code title="event-click">click</code> event at the element does not cause
3135: any of the actions described above to happen.</p>
3136:
3137: <!-- v2COMMAND: the command="" attribute to make a <command> element
3138: reflect the state of another command, so that the script can update
3139: one place in the page and have context menus, toolbars, shortcuts,
3140: etc, automatically update. Once we add this, expose the Triggers
3141: facet again. -->
3142:
1.117 mike 3143: </div><p class="note"><code><a href="#the-command">command</a></code> elements are not rendered
1.520 mike 3144: unless they <a href="#menus" title="menu">form part of a menu</a>.</p><div class="example">
3145:
3146: <p>Here is an example of a toolbar with three buttons that let the
3147: user toggle between left, center, and right alignment. One could
3148: imagine such a toolbar as part of a text editor. The toolbar also
3149: has a separator followed by another button labeled "Publish",
3150: though that button is disabled.</p>
3151:
3152: <pre><menu type="toolbar">
3153: <command type="radio" radiogroup="alignment" checked="checked"
3154: label="Left" icon="icons/alL.png" onclick="setAlign('left')">
3155: <command type="radio" radiogroup="alignment"
3156: label="Center" icon="icons/alC.png" onclick="setAlign('center')">
3157: <command type="radio" radiogroup="alignment"
3158: label="Right" icon="icons/alR.png" onclick="setAlign('right')">
3159: <hr>
3160: <command type="command" disabled
3161: label="Publish" icon="icons/pub.png" onclick="publish()">
3162: </menu></pre>
3163:
1.729 mike 3164: </div><h4 id="menus"><span class="secno">4.11.4 </span>The <dfn><code>menu</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><dl class="element"><dt>Categories</dt>
1.153 mike 3165: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
1.385 mike 3166: <dd>If the element's <code title="attr-menu-type"><a href="#attr-menu-type">type</a></code> attribute is in the <a href="#toolbar-state" title="toolbar state">toolbar</a> state: <a href="embedded-content-0.html#interactive-content">Interactive content</a>.</dd>
1.1 mike 3167: <dt>Contexts in which this element may be used:</dt>
1.153 mike 3168: <dd>Where <a href="dom.html#flow-content">flow content</a> is expected.</dd>
1.1 mike 3169: <dt>Content model:</dt>
3170: <dd>Either: Zero or more <code><a href="semantics.html#the-li-element">li</a></code> elements.</dd>
1.153 mike 3171: <dd>Or: <a href="dom.html#flow-content">Flow content</a>.</dd>
1.1 mike 3172: <dt>Content attributes:</dt>
3173: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
3174: <dd><code title="attr-menu-type"><a href="#attr-menu-type">type</a></code></dd>
3175: <dd><code title="attr-menu-label"><a href="#attr-menu-label">label</a></code></dd>
3176: <dt>DOM interface:</dt>
3177: <dd>
3178: <pre class="idl">interface <dfn id="htmlmenuelement">HTMLMenuElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
3179: attribute DOMString <a href="#dom-menu-type" title="dom-menu-type">type</a>;
3180: attribute DOMString <a href="#dom-menu-label" title="dom-menu-label">label</a>;
3181: };</pre>
1.117 mike 3182: </dd></dl><p>The <code><a href="#menus">menu</a></code> element represents a list of commands.</p><!-- v2 idea: <menu> should get an icon, like <command> --><p>The <dfn id="attr-menu-type" title="attr-menu-type"><code>type</code></dfn> attribute
1.1 mike 3183: is an <a href="infrastructure.html#enumerated-attribute">enumerated attribute</a> indicating the kind of menu
3184: being declared. The attribute has three states. The <code title="attr-menu-type-context">context</code> keyword maps to the
3185: <dfn id="context-menu-state" title="context menu state">context menu</dfn> state, in which
3186: the element is declaring a context menu. The <code title="attr-menu-type-toolbar">toolbar</code> keyword maps to the
1.385 mike 3187: <dfn id="toolbar-state" title="toolbar state">toolbar</dfn> state, in which the
3188: element is declaring a toolbar. The attribute may also be
1.1 mike 3189: omitted. The <i>missing value default</i> is the <dfn id="list-state" title="list
3190: state">list</dfn> state, which indicates that the element is merely
3191: a list of commands that is neither declaring a context menu nor
1.385 mike 3192: defining a toolbar.</p><p>If a <code><a href="#menus">menu</a></code> element's <code title="attr-menu-type"><a href="#attr-menu-type">type</a></code> attribute is in the <a href="#context-menu-state" title="context menu state">context menu</a> state, then the
1.1 mike 3193: element <a href="the-xhtml-syntax.html#represents">represents</a> the commands of a context menu, and
3194: the user can only interact with the commands if that context menu is
1.385 mike 3195: activated.</p><p>If a <code><a href="#menus">menu</a></code> element's <code title="attr-menu-type"><a href="#attr-menu-type">type</a></code> attribute is in the <a href="#toolbar-state" title="toolbar state">toolbar</a> state, then the element
1.1 mike 3196: <a href="the-xhtml-syntax.html#represents">represents</a> a list of active commands that the user can
1.117 mike 3197: immediately interact with.</p><p>If a <code><a href="#menus">menu</a></code> element's <code title="attr-menu-type"><a href="#attr-menu-type">type</a></code> attribute is in the <a href="#list-state" title="list state">list</a> state, then the element either
1.1 mike 3198: <a href="the-xhtml-syntax.html#represents">represents</a> an unordered list of items (each represented
3199: by an <code><a href="semantics.html#the-li-element">li</a></code> element), each of which represents a command
3200: that the user can perform or activate, or, if the element has no
1.153 mike 3201: <code><a href="semantics.html#the-li-element">li</a></code> element children, <a href="dom.html#flow-content">flow content</a>
1.117 mike 3202: describing available commands.</p><p>The <dfn id="attr-menu-label" title="attr-menu-label"><code>label</code></dfn>
1.1 mike 3203: attribute gives the label of the menu. It is used by user agents to
3204: display nested menus in the UI. For example, a context menu
3205: containing another menu would use the nested menu's <code title="attr-menu-label"><a href="#attr-menu-label">label</a></code> attribute for the submenu's
1.117 mike 3206: menu label.</p><div class="impl">
1.1 mike 3207:
1.186 mike 3208: <p>The <dfn id="dom-menu-type" title="dom-menu-type"><code>type</code></dfn> and <dfn id="dom-menu-label" title="dom-menu-label"><code>label</code></dfn> IDL attributes must
1.1 mike 3209: <a href="infrastructure.html#reflect">reflect</a> the respective content attributes of the same
3210: name.</p>
3211:
1.729 mike 3212: </div><h5 id="menus-intro"><span class="secno">4.11.4.1 </span>Introduction</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p><i>This section is non-normative.</i></p><p>The <code><a href="#menus">menu</a></code> element is used to define context menus and
1.385 mike 3213: toolbars.</p><p>For example, the following represents a toolbar with three menu
1.148 mike 3214: buttons on it, each of which has a dropdown menu with a series of
3215: options:</p><pre><menu type="toolbar">
1.1 mike 3216: <li>
3217: <menu label="File">
3218: <button type="button" onclick="fnew()">New...</button>
3219: <button type="button" onclick="fopen()">Open...</button>
1.290 mike 3220: <button type="button" onclick="fsave()">Save</button>
1.1 mike 3221: <button type="button" onclick="fsaveas()">Save as...</button>
3222: </menu>
3223: </li>
3224: <li>
3225: <menu label="Edit">
3226: <button type="button" onclick="ecopy()">Copy</button>
3227: <button type="button" onclick="ecut()">Cut</button>
3228: <button type="button" onclick="epaste()">Paste</button>
3229: </menu>
3230: </li>
3231: <li>
3232: <menu label="Help">
3233: <li><a href="help.html">Help</a></li>
3234: <li><a href="about.html">About</a></li>
3235: </menu>
3236: </li>
1.718 mike 3237: </menu></pre><p>In a supporting user agent, this might look like this:</p><p><img alt="A toolbar with three buttons, labeled 'File', 'Edit', and 'Help'; where if you select the 'Edit' button you get a drop-down menu with three more options, 'Copy', 'Cut', and 'Paste'." src="http://dev.w3.org/html5/spec/images/sample-toolbar-1.png"></p><p>In a legacy user agent, the above would look like a bulleted list
1.148 mike 3238: with three items, the first of which has four buttons, the second of
3239: which has three, and the third of which has two nested bullet points
3240: with two items consisting of links.</p><hr><p>The following implements a similar toolbar, with a single button
3241: whose values, when selected, redirect the user to Web sites.</p><pre><form action="redirect.cgi">
3242: <menu type="toolbar">
1.1 mike 3243: <label for="goto">Go to...</label>
3244: <menu label="Go">
1.746 mike 3245: <select id="goto"<!--
1.1 mike 3246: onchange="if (this.options[this.selectedIndex].value)
1.746 mike 3247: window.location = this.options[this.selectedIndex].value"-->>
1.1 mike 3248: <option value="" selected="selected"> Select site: </option>
3249: <option value="http://www.apple.com/"> Apple </option>
3250: <option value="http://www.mozilla.org/"> Mozilla </option>
3251: <option value="http://www.opera.com/"> Opera </option>
3252: </select>
3253: <span><input type="submit" value="Go"></span>
3254: </menu>
3255: </menu>
1.148 mike 3256: </form></pre><p>The behavior in supporting user agents is similar to the example
3257: above, but here the legacy behaviour consists of a single
3258: <code><a href="forms.html#the-select-element">select</a></code> element with a submit button. The submit button
3259: doesn't appear in the toolbar, because it is not a direct child of
3260: the <code><a href="#menus">menu</a></code> element or of its <code><a href="semantics.html#the-li-element">li</a></code>
3261: children.</p><div class="impl">
1.1 mike 3262:
1.729 mike 3263: <h5 id="building-menus-and-toolbars"><span class="secno">4.11.4.2 </span><dfn>Building menus and toolbars</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3264:
1.385 mike 3265: <p>A menu (or toolbar) consists of a list of zero or more of the
1.1 mike 3266: following components:</p>
3267:
3268: <ul class="brief"><li><a href="#concept-command" title="concept-command">Commands</a>, which can be marked as default commands</li>
3269: <li>Separators</li>
3270: <li>Other menus (which allows the list to be nested)</li>
3271: </ul><p>The list corresponding to a particular <code><a href="#menus">menu</a></code> element
3272: is built by iterating over its child nodes. For each child node in
3273: <a href="infrastructure.html#tree-order">tree order</a>, the required behavior depends on what the
3274: node is, as follows:</p>
3275:
3276: <dl class="switch"><dt>An element that <a href="#concept-command" title="concept-command">defines a command</a></dt>
3277:
3278: <dd>Append the command to the menu, respecting its <a href="#concept-facet" title="concept-facet">facets</a><!-- we might need to be
3279: explicit about what this means for each facet, if testing shows
3280: this isn't well-implemented. e.g.: If there's an Icon facet for the
1.408 mike 3281: command, it should be <span title="fetch">fetched</span> (this
3282: would be http-origin privacy-sensitive), and then that image should
3283: be associated with the command, such that each command only has its
3284: image fetched once, to prevent changes to the base URL from having
3285: effects after the image has been fetched once. (no need to resolve
3286: the Icon facet, it's an absolute URL) -->. <!--If the element is a
3287: <code>command</code> element with a <code
3288: title="attr-command-default">default</code> attribute, mark the
3289: command as being a default command.--></dd>
1.1 mike 3290:
3291:
3292: <dt>An <code><a href="semantics.html#the-hr-element">hr</a></code> element</dt>
3293: <dt>An <code><a href="forms.html#the-option-element">option</a></code> element that has a <code title="attr-option-value"><a href="forms.html#attr-option-value">value</a></code> attribute set to the empty
3294: string, and has a <code title="attr-option-disabled"><a href="forms.html#attr-option-disabled">disabled</a></code> attribute, and whose
1.804 mike 3295: <code><a href="infrastructure.html#textcontent">textContent</a></code> consists of a string of one or more
1.1 mike 3296: hyphens (U+002D HYPHEN-MINUS)</dt>
3297:
3298: <dd>Append a separator to the menu.</dd>
3299:
3300:
3301: <dt>An <code><a href="semantics.html#the-li-element">li</a></code> element</dt>
3302: <dt>A <code><a href="forms.html#the-label-element">label</a></code> element</dt>
3303:
3304: <dd>Iterate over the children of the element.</dd>
3305:
3306:
3307: <dt>A <code><a href="#menus">menu</a></code> element with no <code title="attr-menu-label"><a href="#attr-menu-label">label</a></code> attribute</dt>
3308: <dt>A <code><a href="forms.html#the-select-element">select</a></code> element</dt>
3309:
3310: <dd>Append a separator to the menu, then iterate over the children
3311: of the <code><a href="#menus">menu</a></code> or <code><a href="forms.html#the-select-element">select</a></code> element, then
3312: append another separator.</dd>
3313:
3314: <!-- v2: we might want to support <select> in <label> as giving a named submenu -->
3315:
3316:
3317: <dt>A <code><a href="#menus">menu</a></code> element with a <code title="attr-menu-label"><a href="#attr-menu-label">label</a></code> attribute</dt>
3318: <dt>An <code><a href="forms.html#the-optgroup-element">optgroup</a></code> element with a <code title="attr-menu-label"><a href="#attr-menu-label">label</a></code> attribute</dt>
3319:
3320: <dd>Append a submenu to the menu, using the value of the element's
3321: <code title="">label</code> attribute as the label of the menu. The
3322: submenu must be constructed by taking the element and creating a
3323: new menu for it using the complete process described in this
3324: section.</dd>
3325:
3326:
3327: <dt>Any other node</dt>
3328:
3329: <dd><a href="infrastructure.html#ignore">Ignore</a> the node.</dd>
3330:
3331: </dl><p>Once all the nodes have been processed as described above, the
3332: user agent must the post-process the menu as follows:</p>
3333:
1.521 mike 3334: <ol><li>Except for separators, any menu item with no label, or whose
3335: label is the empty string, must be removed.</li>
1.1 mike 3336:
1.521 mike 3337: <li>Any sequence of two or more separators in a row must be
3338: collapsed to a single separator.</li>
1.1 mike 3339:
1.521 mike 3340: <li>Any separator at the start or end of the menu must be
3341: removed.</li>
1.1 mike 3342:
1.729 mike 3343: </ol></div><h5 id="context-menus"><span class="secno">4.11.4.3 </span><dfn>Context menus</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <dfn id="attr-contextmenu" title="attr-contextmenu"><code>contextmenu</code></dfn>
1.1 mike 3344: attribute gives the element's <a href="#context-menus" title="context menus">context
3345: menu</a>. The value must be the ID of a <code><a href="#menus">menu</a></code> element
3346: in the DOM. <span class="impl">If the node that would be obtained by
3347: the invoking the <code>getElementById()</code> method using the
3348: attribute's value as the only argument is null or not a
3349: <code><a href="#menus">menu</a></code> element, then the element has no assigned context
3350: menu. Otherwise, the element's assigned context menu is the element
1.117 mike 3351: so identified.</span></p><div class="impl">
1.1 mike 3352:
3353: <p>When an element's context menu is requested (e.g. by the user
3354: right-clicking the element, or pressing a context menu key), the UA
1.788 mike 3355: must <a href="webappapis.html#fire-a-simple-event">fire a simple event</a> named <code title="event-contextmenu">contextmenu</code> that bubbles and is
1.1 mike 3356: cancelable at the element for which the menu was requested.</p>
3357:
3358: <p class="note">Typically, therefore, the firing of the <code title="event-contextmenu">contextmenu</code> event will be the
3359: default action of a <code title="mouseup">mouseup</code> or <code title="event-keyup">keyup</code> event. The exact sequence of events
3360: is UA-dependent, as it will vary based on platform conventions.</p>
3361:
3362: <p>The default action of the <code title="event-contextmenu">contextmenu</code> event depends on
3363: whether the element or one of its ancestors has a context menu
3364: assigned (using the <code title="attr-contextmenu"><a href="#attr-contextmenu">contextmenu</a></code> attribute) or not. If
3365: there is no context menu assigned, the default action must be for
3366: the user agent to show its default context menu, if it has one.</p>
3367:
3368: <p>If the element or one of its ancestors <em>does</em> have a
1.788 mike 3369: context menu assigned, then the user agent must <a href="webappapis.html#fire-a-simple-event">fire a simple
1.454 mike 3370: event</a> named <code title="event-show">show</code> at the
1.1 mike 3371: <code><a href="#menus">menu</a></code> element of the context menu of the nearest
3372: ancestor (including the element itself) with one assigned.</p>
3373: <!-- v2: include modifier key information -->
3374:
3375: <p>The default action of <em>this</em> event is that the user agent
1.385 mike 3376: must show a context menu <a href="#building-menus-and-toolbars" title="building menus and
3377: toolbars">built</a> from the <code><a href="#menus">menu</a></code> element.</p>
1.1 mike 3378:
3379: <p>The user agent may also provide access to its default context
3380: menu, if any, with the context menu shown. For example, it could
3381: merge the menu items from the two menus together, or provide the
3382: page's context menu as a submenu of the default menu.</p>
3383:
3384: <p>If the user dismisses the menu without making a selection,
3385: nothing in particular happens.</p>
3386:
1.402 mike 3387: <p>If the user selects a menu item that represents a <a href="#concept-command" title="concept-command">command</a>, then the UA must invoke
1.1 mike 3388: that command's <a href="#command-facet-action" title="command-facet-Action">Action</a>.</p>
3389:
3390: <p>Context menus must not, while being shown, reflect changes in the
1.521 mike 3391: DOM; they are constructed as the default action of the <code title="event-show">show</code> event and must remain as constructed
3392: until dismissed.</p>
1.1 mike 3393:
3394: <p>User agents may provide means for bypassing the context menu
3395: processing model, ensuring that the user can always access the UA's
3396: default context menus. For example, the user agent could handle
3397: right-clicks that have the Shift key depressed in such a way that it
3398: does not fire the <code title="event-contextmenu">contextmenu</code>
3399: event and instead always shows the default context menu.</p>
3400:
3401: <p>The <dfn id="dom-contextmenu" title="dom-contextMenu"><code>contextMenu</code></dfn>
3402: attribute must <a href="infrastructure.html#reflect">reflect</a> the <code title="attr-contextmenu"><a href="#attr-contextmenu">contextmenu</a></code> content attribute.</p>
3403:
1.520 mike 3404: </div><div class="example">
3405:
3406: <p>Here is an example of a context menu for an input control:</p>
3407:
3408: <pre><form name="npc">
3409: <label>Character name: <input name=char type=text contextmenu=namemenu required></label>
3410: <menu type=context id=namemenu>
3411: <command label="Pick random name" onclick="document.forms.npc.elements.char.value = getRandomName()">
3412: <command label="Prefill other fields based on name" onclick="prefillFields(document.forms.npc.elements.char.value)">
3413: </menu>
3414: </form></pre>
3415:
3416: <p>This adds to items to the control's context menu, one called
3417: "Pick random name", and one called "Prefill other fields based on
3418: name". They invoke scripts that are not shown in the example
3419: above.</p>
3420:
1.117 mike 3421: </div><div class="impl">
1.1 mike 3422:
1.729 mike 3423: <h5 id="toolbars"><span class="secno">4.11.4.4 </span><dfn>Toolbars</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3424:
1.385 mike 3425: <p>When a <code><a href="#menus">menu</a></code> element has a <code title="attr-menu-type"><a href="#attr-menu-type">type</a></code> attribute in the <a href="#toolbar-state" title="toolbar state">toolbar</a> state, then the user agent
3426: must <a href="#building-menus-and-toolbars" title="building menus and toolbars">build</a> the
1.1 mike 3427: menu for that <code><a href="#menus">menu</a></code> element, and use the result in the
3428: rendering.</p>
3429:
3430: <p>The user agent must reflect changes made to the
1.385 mike 3431: <code><a href="#menus">menu</a></code>'s DOM, by immediately <a href="#building-menus-and-toolbars" title="building menus
3432: and toolbars">rebuilding</a> the menu.</p>
1.1 mike 3433:
1.729 mike 3434: </div><h4 id="commands"><span class="secno">4.11.5 </span>Commands</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>A <dfn id="concept-command" title="concept-command">command</dfn> is the abstraction
1.51 mike 3435: behind menu items, buttons, and links.<!--v2COMMAND: Once a command
3436: is defined, other parts of the interface can refer to the same
3437: command, allowing many access points to a single feature to share
1.117 mike 3438: aspects such as the disabled state.--></p><p id="facets">Commands are defined to have the following
3439: <dfn id="concept-facet" title="concept-facet">facets</dfn>:</p><dl><dt><dfn id="command-facet-type" title="command-facet-Type">Type</dfn></dt>
1.1 mike 3440:
3441: <dd>The kind of command: "command", meaning it is a normal command;
3442: "radio", meaning that triggering the command will, amongst other
3443: things, set the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked
3444: State</a> to true (and probably uncheck some other commands); or
3445: "checkbox", meaning that triggering the command will, amongst other
3446: things, toggle the value of the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>.</dd>
3447:
3448: <dt><dfn id="command-facet-id" title="command-facet-ID">ID</dfn></dt>
3449:
3450: <dd>The name of the command, for referring to the command from the
3451: markup or from script. If a command has no ID, it is an
3452: <dfn id="anonymous-command">anonymous command</dfn>.</dd>
3453:
3454: <dt><dfn id="command-facet-label" title="command-facet-Label">Label</dfn></dt>
3455:
3456: <dd>The name of the command as seen by the user.</dd>
3457:
3458: <dt><dfn id="command-facet-hint" title="command-facet-Hint">Hint</dfn></dt>
3459:
3460: <dd>A helpful or descriptive string that can be shown to the
3461: user.</dd>
3462:
3463: <dt><dfn id="command-facet-icon" title="command-facet-Icon">Icon</dfn></dt>
3464:
3465: <dd>An <a href="infrastructure.html#absolute-url">absolute URL</a> identifying a graphical image that
3466: represents the action. A command might not have an Icon.</dd> <!--
3467: changing base URLs might change the icon -->
3468:
3469: <dt><dfn id="command-facet-accesskey" title="command-facet-AccessKey">Access Key</dfn></dt>
3470:
3471: <dd>A key combination selected by the user agent that triggers the
3472: command. A command might not have an Access Key.</dd>
3473:
3474: <dt><dfn id="command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</dfn></dt>
3475:
3476: <dd>Whether the command is hidden or not (basically, whether it
3477: should be shown in menus).</dd>
3478:
3479: <dt><dfn id="command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</dfn></dt>
3480:
3481: <dd>Whether the command is relevant and can be triggered or not.</dd>
3482:
3483: <dt><dfn id="command-facet-checkedstate" title="command-facet-CheckedState">Checked State</dfn></dt>
3484:
3485: <dd>Whether the command is checked or not.</dd>
3486:
3487: <dt><dfn id="command-facet-action" title="command-facet-Action">Action</dfn></dt>
3488:
3489: <dd>The actual effect that triggering the command will have. This
3490: could be a scripted event handler, a <a href="infrastructure.html#url">URL</a> to which to
3491: <a href="history.html#navigate">navigate</a>, or a form submission.</dd>
3492:
3493: <!-- v2COMMAND
3494: <dt><dfn title="command-facet-Triggers">Triggers</dfn></dt>
3495:
3496: <dd>The list of elements that can trigger the command. The element
3497: defining a command is always in the list of elements that can
3498: trigger the command. For anonymous commands, only the element
3499: defining the command is on the list, since other elements have no
3500: way to refer to it.</dd>
3501: -->
3502:
3503: </dl><p>These facets are exposed on elements using the <dfn id="command-api">command
1.117 mike 3504: API</dfn>:</p><dl class="domintro"><dt><var title="">element</var> . <code title="dom-command-ro-commandType"><a href="#dom-command-ro-commandtype">commandType</a></code></dt>
1.1 mike 3505:
3506: <dd>
3507:
3508: <p>Exposes the <a href="#command-facet-type" title="command-facet-Type">Type</a> facet of the command.</p>
3509:
3510: </dd>
3511:
3512: <dt><var title="">element</var> . <code title="dom-id"><a href="dom.html#dom-id">id</a></code></dt>
3513:
3514: <dd>
3515:
3516: <p>Exposes the <a href="#command-facet-id" title="command-facet-ID">ID</a> facet of the command.</p>
3517:
3518: </dd>
3519:
3520: <dt><var title="">element</var> . <code title="dom-command-ro-label"><a href="#dom-command-ro-label">label</a></code></dt>
3521:
3522: <dd>
3523:
3524: <p>Exposes the <a href="#command-facet-label" title="command-facet-Label">Label</a> facet of the command.</p>
3525:
3526: </dd>
3527:
3528: <dt><var title="">element</var> . <code title="dom-title"><a href="dom.html#dom-title">title</a></code></dt>
3529:
3530: <dd>
3531:
3532: <p>Exposes the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> facet of the command.</p>
3533:
3534: </dd>
3535:
3536: <dt><var title="">element</var> . <code title="dom-command-ro-icon"><a href="#dom-command-ro-icon">icon</a></code></dt>
3537:
3538: <dd>
3539:
3540: <p>Exposes the <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> facet of the command.</p>
3541:
3542: </dd>
3543:
3544: <dt><var title="">element</var> . <code title="dom-accessKeyLabel"><a href="editing.html#dom-accesskeylabel">accessKeyLabel</a></code></dt>
3545:
3546: <dd>
3547:
3548: <p>Exposes the <a href="#command-facet-accesskey" title="command-facet-AccessKey">Access Key</a> facet of the command.</p>
3549:
3550: </dd>
3551:
3552: <dt><var title="">element</var> . <code title="dom-hidden"><a href="editing.html#dom-hidden">hidden</a></code></dt>
3553:
3554: <dd>
3555:
3556: <p>Exposes the <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a> facet of the command.</p>
3557:
3558: </dd>
3559:
3560: <dt><var title="">element</var> . <code title="dom-command-ro-disabled"><a href="#dom-command-ro-disabled">disabled</a></code></dt>
3561:
3562: <dd>
3563:
3564: <p>Exposes the <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a> facet of the command.</p>
3565:
3566: </dd>
3567:
3568: <dt><var title="">element</var> . <code title="dom-command-ro-checked"><a href="#dom-command-ro-checked">checked</a></code></dt>
3569:
3570: <dd>
3571:
3572: <p>Exposes the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a> facet of the command.</p>
3573:
3574: </dd>
3575:
3576: <dt><var title="">element</var> . <code title="dom-click"><a href="editing.html#dom-click">click</a></code>()</dt>
3577:
3578: <dd>
3579:
3580: <p>Triggers the <a href="#command-facet-action" title="command-facet-Action">Action</a> of the command.</p>
3581:
3582: </dd>
3583:
3584: <!--v2COMMAND
3585: <dt><var title="">element</var> . <code title="dom-command-ro-triggers">triggers</code></dt>
3586:
3587: <dd>
3588:
3589: <p>Exposes the <span title="command-facet-Triggers">Triggers</span> facet of the command.</p>
3590:
3591: </dd>
3592: -->
3593:
3594: </dl><div class="impl">
3595:
3596: <p>The <dfn id="dom-command-ro-commandtype" title="dom-command-ro-commandType"><code>commandType</code></dfn>
3597: attribute must return a string whose value is either "<code title="">command</code>", "<code title="">radio</code>", or "<code title="">checked</code>", depending on whether the <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command defined by the
3598: element is "command", "radio", or "checked" respectively. If the
3599: element does not define a command, it must return null.</p>
3600:
3601: <p>The <dfn id="dom-command-ro-label" title="dom-command-ro-label"><code>label</code></dfn>
3602: attribute must return the command's <a href="#command-facet-label" title="command-facet-Label">Label</a>, or null if the element
3603: does not define a command or does not specify a <a href="#command-facet-label" title="command-facet-Label">Label</a>. This attribute will be
1.186 mike 3604: shadowed by the <code title="">label</code> IDL attribute on
1.1 mike 3605: <code><a href="forms.html#the-option-element">option</a></code> and <code><a href="#the-command">command</a></code> elements.</p>
3606:
3607: <p>The <dfn id="dom-command-ro-icon" title="dom-command-ro-icon"><code>icon</code></dfn>
3608: attribute must return the <a href="infrastructure.html#absolute-url">absolute URL</a> of the command's
3609: <a href="#command-facet-icon" title="command-facet-Icon">Icon</a>. If the element does
3610: not specify an icon, or if the element does not define a command,
3611: then the attribute must return null. This attribute will be shadowed
1.186 mike 3612: by the <code title="dom-command-icon"><a href="#dom-command-icon">icon</a></code> IDL attribute on
1.1 mike 3613: <code><a href="#the-command">command</a></code> elements.</p>
3614:
3615: <p>The <dfn id="dom-command-ro-disabled" title="dom-command-ro-disabled"><code>disabled</code></dfn>
3616: attribute must return true if the command's <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a> is that
3617: the command is disabled, and false if the command is not
3618: disabled. This attribute is not affected by the command's <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>. If the
3619: element does not define a command, the attribute must return
1.290 mike 3620: false. This attribute will be shadowed by the <code title="">disabled</code> IDL attribute on <code><a href="forms.html#the-button-element">button</a></code>,
1.1 mike 3621: <code><a href="forms.html#the-input-element">input</a></code>, <code><a href="forms.html#the-option-element">option</a></code>, and <code><a href="#the-command">command</a></code>
3622: elements.</p>
3623:
3624: <p>The <dfn id="dom-command-ro-checked" title="dom-command-ro-checked"><code>checked</code></dfn> attribute
3625: must return true if the command's <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a> is that the
3626: command is checked, and false if it is that the command is not
3627: checked. If the element does not define a command, the attribute
1.290 mike 3628: must return false. This attribute will be shadowed by the <code title="">checked</code> IDL attribute on <code><a href="forms.html#the-input-element">input</a></code> and
1.1 mike 3629: <code><a href="#the-command">command</a></code> elements.</p>
3630:
3631: <!--v2COMMAND
3632: <p>The <dfn
3633: title="dom-command-ro-triggers"><code>triggers</code></dfn>
3634: attribute must return a list containing the elements that can
3635: trigger the command (the command's <span
3636: title="command-facet-Triggers">Triggers</span>). The list must be
3637: <span>live</span>. While the element does not define a command, the
3638: list must be empty.</p>
3639: -->
3640:
3641: <p class="note">The <a href="#command-facet-id" title="command-facet-ID">ID</a> facet
1.665 mike 3642: is exposed by the <code title="dom-id"><a href="dom.html#dom-id">id</a></code> IDL attribute,
1.1 mike 3643: the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> facet is exposed by
1.186 mike 3644: the <code title="dom-title"><a href="dom.html#dom-title">title</a></code> IDL attribute, the <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> facet is exposed by
3645: the <code title="dom-accessKeyLabel"><a href="editing.html#dom-accesskeylabel">accessKeyLabel</a></code> IDL
1.1 mike 3646: attribute, and the <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden
1.186 mike 3647: State</a> facet is exposed by the <code title="dom-hidden"><a href="editing.html#dom-hidden">hidden</a></code> IDL attribute.</p>
1.1 mike 3648:
1.117 mike 3649: </div><hr><dl class="domintro"><dt><var title="">document</var> . <code title="dom-document-commands"><a href="#dom-document-commands">commands</a></code></dt>
1.1 mike 3650: <dd>
1.153 mike 3651: <p>Returns an <code><a href="infrastructure.html#htmlcollection">HTMLCollection</a></code> of the elements in the
1.804 mike 3652: <code><a href="infrastructure.html#document">Document</a></code> that define commands and have IDs.</p>
1.1 mike 3653: </dd>
3654:
3655: </dl><div class="impl">
3656:
3657: <p>The <dfn id="dom-document-commands" title="dom-document-commands"><code>commands</code></dfn> attribute
3658: of the document's <code><a href="dom.html#htmldocument">HTMLDocument</a></code> interface must return an
1.804 mike 3659: <code><a href="infrastructure.html#htmlcollection">HTMLCollection</a></code> rooted at the <code><a href="infrastructure.html#document">Document</a></code>
1.1 mike 3660: node, whose filter matches only elements that <a href="#concept-command" title="concept-command">define commands</a> and have <a href="#command-facet-id" title="command-facet-ID">IDs</a>.</p>
3661:
1.117 mike 3662: </div><hr><p>User agents may expose the <a href="#concept-command" title="concept-command">commands</a> whose <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a> facet is false
1.1 mike 3663: (visible), e.g. in the user agent's menu bar. User agents are
3664: encouraged to do this especially for commands that have <a href="#command-facet-accesskey" title="command-facet-AccessKey">Access Keys</a>, as a way to
1.117 mike 3665: advertise those keys to the user.</p><div class="impl">
1.1 mike 3666:
1.729 mike 3667: <h5 id="using-the-a-element-to-define-a-command"><span class="secno">4.11.5.1 </span><dfn title="a-command">Using the <code>a</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3668:
1.748 mike 3669: <p>An <code><a href="text-level-semantics.html#the-a-element">a</a></code> element with an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute <a href="#concept-command" title="concept-command">defines a command</a>.</p>
1.1 mike 3670:
3671: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3672: is "command".</p>
3673:
3674: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3675: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3676: element, if the attribute is present and not empty. Otherwise the
3677: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3678:
3679: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3680: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3681: attribute.</p>
3682:
3683: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3684: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3685: of the element. If the attribute is not present, the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> is the empty string.</p>
3686:
3687: <p>The <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> of the command
3688: is the <a href="infrastructure.html#absolute-url">absolute URL</a> obtained from <a href="infrastructure.html#resolve-a-url" title="resolve
1.153 mike 3689: a url">resolving</a> the value of the <code title="attr-img-src"><a href="text-level-semantics.html#attr-img-src">src</a></code> attribute of the first
3690: <code><a href="text-level-semantics.html#the-img-element">img</a></code> element descendant of the element, relative to that
1.1 mike 3691: element, if there is such an element and resolving its attribute is
3692: successful. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
3693:
3694: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3695: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3696: any.</p>
3697:
3698: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3699: of the command is true (hidden) if the element has a <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> attribute, and false
3700: otherwise.</p>
3701:
3702: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3703: State</a> facet of the command is always false. (The command is
3704: always enabled.)</p>
3705:
3706: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3707: of the command is always false. (The command is never checked.)</p>
3708:
3709: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.788 mike 3710: command is to <a href="webappapis.html#fire-a-click-event" title="fire a click event">fire a <code title="event-click">click</code> event</a> at the element.</p>
1.1 mike 3711:
3712:
1.729 mike 3713: <h5 id="using-the-button-element-to-define-a-command"><span class="secno">4.11.5.2 </span><dfn title="button-command">Using the <code>button</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3714:
3715: <p>A <code><a href="forms.html#the-button-element">button</a></code> element always <a href="#concept-command" title="concept-command">defines a command</a>.</p>
3716:
3717: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a>, <a href="#command-facet-id" title="command-facet-ID">ID</a>, <a href="#command-facet-label" title="command-facet-Label">Label</a>, <a href="#command-facet-hint" title="command-facet-Hint">Hint</a>, <a href="#command-facet-icon" title="command-facet-Icon">Icon</a>, <a href="#command-facet-accesskey" title="command-facet-AccessKey">Access Key</a>, <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>, <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>, and <a href="#command-facet-action" title="command-facet-Action">Action</a> facets of the command are
3718: determined <a href="#using-the-a-element-to-define-a-command" title="a-command">as for <code>a</code>
3719: elements</a> (see the previous section).</p>
3720:
3721: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3722: State</a> of the command mirrors the <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a> state of the button.</p>
3723:
3724:
1.729 mike 3725: <h5 id="using-the-input-element-to-define-a-command"><span class="secno">4.11.5.3 </span><dfn title="input-command">Using the <code>input</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3726:
1.39 mike 3727: <p>An <code><a href="forms.html#the-input-element">input</a></code> element whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in one of the <a href="forms.html#submit-button-state" title="attr-input-type-submit">Submit Button</a>, <a href="forms.html#reset-button-state" title="attr-input-type-reset">Reset Button</a>, <a href="forms.html#image-button-state" title="attr-input-type-image">Image Button</a>, <a href="forms.html#button-state" title="attr-input-type-button">Button</a>, <a href="forms.html#radio-button-state" title="attr-input-type-radio">Radio Button</a>, or <a href="forms.html#checkbox-state" title="attr-input-type-checkbox">Checkbox</a> states <a href="#concept-command" title="concept-command">defines a command</a>.</p>
1.1 mike 3728:
3729: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3730: is "radio" if the <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code>
3731: attribute is in the <code title="attr-input-type-radio"><a href="forms.html#radio-button-state">Radio
3732: Button</a></code> state, "checkbox" if the <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <code title="attr-input-type-checkbox"><a href="forms.html#checkbox-state">Checkbox</a></code> state, and
3733: "command" otherwise.</p>
3734:
3735: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3736: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3737: element, if the attribute is present and not empty. Otherwise the
3738: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3739:
3740: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3741: depends on the Type of the command:</p>
3742:
3743: <p>If the <a href="#command-facet-type" title="command-facet-Type">Type</a> is "command",
3744: then it is the string given by the <code title="attr-input-value"><a href="forms.html#attr-input-value">value</a></code> attribute, if any, and a
3745: UA-dependent, locale-dependent value that the UA uses to label the
3746: button itself if the attribute is absent.</p>
3747:
3748: <p>Otherwise, the <a href="#command-facet-type" title="command-facet-Type">Type</a> is
3749: "radio" or "checkbox". If the element is a <a href="forms.html#labeled-control">labeled
1.804 mike 3750: control</a>, the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first
1.1 mike 3751: <code><a href="forms.html#the-label-element">label</a></code> element in <a href="infrastructure.html#tree-order">tree order</a> whose
3752: <a href="forms.html#labeled-control">labeled control</a> is the element in question is the <a href="#command-facet-label" title="command-facet-Label">Label</a> (in DOM terms, this is the
3753: string given by <code><var title="">element</var>.labels[0].textContent</code>). Otherwise,
3754: the value of the <code title="attr-input-value"><a href="forms.html#attr-input-value">value</a></code>
3755: attribute, if present, is the <a href="#command-facet-label" title="command-facet-Label">Label</a>. Otherwise, the <a href="#command-facet-label" title="command-facet-Label">Label</a> is the empty string.</p>
3756:
3757: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3758: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3759: of the <code><a href="forms.html#the-input-element">input</a></code> element. If the attribute is not present, the
3760: <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> is the empty
3761: string.</p>
3762:
1.39 mike 3763: <p>If the element's <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code>
3764: attribute is in the <a href="forms.html#image-button-state" title="attr-input-type-image">Image
1.153 mike 3765: Button</a> state, and the element has a <code title="attr-img-src"><a href="text-level-semantics.html#attr-img-src">src</a></code> attribute, and that attribute's
1.39 mike 3766: value can be successfully <a href="infrastructure.html#resolve-a-url" title="resolve a
3767: url">resolved</a> relative to the element, then the <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> of the command is the
3768: <a href="infrastructure.html#absolute-url">absolute URL</a> obtained from resolving that attribute
3769: that way. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
1.1 mike 3770:
3771: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3772: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3773: any.</p>
3774:
3775: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3776: of the command is true (hidden) if the element has a <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> attribute, and false
3777: otherwise.</p>
3778:
3779: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3780: State</a> of the command mirrors the <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a> state of the
3781: control.</p>
3782:
3783: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3784: of the command is true if the command is of <a href="#command-facet-type" title="command-facet-Type">Type</a> "radio" or "checkbox" and the
3785: element is <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checked</a>
3786: attribute, and false otherwise.</p>
3787:
3788: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.153 mike 3789: command, if the element has a defined <a href="embedded-content-0.html#activation-behavior">activation
3790: behavior</a>, is to <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation
1.788 mike 3791: steps</a> on the element. Otherwise, it is just to <a href="webappapis.html#fire-a-click-event">fire a
1.1 mike 3792: <code title="event-click">click</code> event</a> at the
3793: element.</p>
3794:
3795:
1.729 mike 3796: <h5 id="using-the-option-element-to-define-a-command"><span class="secno">4.11.5.4 </span><dfn title="option-command">Using the <code>option</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3797:
3798: <p>An <code><a href="forms.html#the-option-element">option</a></code> element with an ancestor
3799: <code><a href="forms.html#the-select-element">select</a></code> element and either no <code title="attr-option-value"><a href="forms.html#attr-option-value">value</a></code> attribute or a <code title="attr-option-value"><a href="forms.html#attr-option-value">value</a></code> attribute that is not the
3800: empty string <a href="#concept-command" title="concept-command">defines a
3801: command</a>.</p>
3802:
3803: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3804: is "radio" if the <code><a href="forms.html#the-option-element">option</a></code>'s nearest ancestor
3805: <code><a href="forms.html#the-select-element">select</a></code> element has no <code title="attr-select-multiple"><a href="forms.html#attr-select-multiple">multiple</a></code> attribute, and
3806: "checkbox" if it does.</p>
3807:
3808: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3809: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3810: element, if the attribute is present and not empty. Otherwise the
3811: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3812:
3813: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3814: is the value of the <code><a href="forms.html#the-option-element">option</a></code> element's <code title="attr-option-label"><a href="forms.html#attr-option-label">label</a></code> attribute, if there is one,
3815: or the value of the <code><a href="forms.html#the-option-element">option</a></code> element's
1.804 mike 3816: <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL attribute if there isn't.</p>
1.1 mike 3817:
3818: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3819: is the string given by the element's <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute, if any, and the empty
3820: string if the attribute is absent.</p>
3821:
3822: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3823: command.</p>
3824:
3825: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3826: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3827: any.</p>
3828:
3829: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3830: of the command is true (hidden) if the element has a <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> attribute, and false
3831: otherwise.</p>
3832:
3833: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3834: State</a> of the command is true (disabled) if the element is
3835: <a href="forms.html#concept-option-disabled" title="concept-option-disabled">disabled</a> or if its
3836: nearest ancestor <code><a href="forms.html#the-select-element">select</a></code> element is <a href="forms.html#concept-option-disabled" title="concept-option-disabled">disabled</a>, and false
3837: otherwise.</p>
3838:
3839: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3840: of the command is true (checked) if the element's <a href="forms.html#concept-option-selectedness" title="concept-option-selectedness">selectedness</a> is true, and
3841: false otherwise.</p>
3842:
3843: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
3844: command depends on its <a href="#command-facet-type" title="command-facet-Type">Type</a>. If the command is of <a href="#command-facet-type" title="command-facet-Type">Type</a> "radio" then it must <a href="forms.html#concept-select-pick" title="concept-select-pick">pick</a> the <code><a href="forms.html#the-option-element">option</a></code>
3845: element. Otherwise, it must <a href="forms.html#concept-select-toggle" title="concept-select-toggle">toggle</a> the <code><a href="forms.html#the-option-element">option</a></code>
3846: element.</p>
3847:
3848:
1.729 mike 3849: <h5 id="using-the-command-element-to-define-a-command"><span class="secno">4.11.5.5 </span>Using the <dfn title="command-element"><code>command</code></dfn> element to define
1.608 mike 3850: a command</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3851:
3852: <p>A <code><a href="#the-command">command</a></code> element <a href="#concept-command" title="concept-command">defines a command</a>.</p>
3853:
3854: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3855: is "radio" if the <code><a href="#the-command">command</a></code>'s <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is
3856: "<code>radio</code>", "checkbox" if the attribute's value is
3857: "<code>checkbox</code>", and "command" otherwise.</p>
3858:
3859: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3860: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3861: element, if the attribute is present and not empty. Otherwise the
3862: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3863:
3864: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3865: is the value of the element's <code title="attr-command-label"><a href="#attr-command-label">label</a></code> attribute, if there is one,
3866: or the empty string if it doesn't.</p>
3867:
3868: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3869: is the string given by the element's <code title="attr-command-title"><a href="#attr-command-title">title</a></code> attribute, if any, and the
3870: empty string if the attribute is absent.</p>
3871:
3872: <p>The <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command
3873: is the <a href="infrastructure.html#absolute-url">absolute URL</a> obtained from <a href="infrastructure.html#resolve-a-url" title="resolve
3874: a url">resolving</a> the value of the element's <code title="attr-command-icon"><a href="#attr-command-icon">icon</a></code> attribute, relative to the
3875: element, if it has such an attribute and resolving it is
3876: successful. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
3877:
3878: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3879: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3880: any.</p>
3881:
3882: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3883: of the command is true (hidden) if the element has a <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> attribute, and false
3884: otherwise.</p>
3885:
3886: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3887: State</a> of the command is true (disabled) if the element has a
3888: <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> attribute, and
3889: false otherwise.</p>
3890:
3891: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3892: of the command is true (checked) if the element has a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, and false
3893: otherwise.</p>
3894:
3895: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.153 mike 3896: command, if the element has a defined <a href="embedded-content-0.html#activation-behavior">activation
3897: behavior</a>, is to <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation
1.788 mike 3898: steps</a> on the element. Otherwise, it is just to <a href="webappapis.html#fire-a-click-event">fire a
1.1 mike 3899: <code title="event-click">click</code> event</a> at the
3900: element.</p>
3901:
3902:
3903:
3904:
3905:
1.729 mike 3906: <h5 id="using-the-accesskey-attribute-on-a-label-element-to-define-a-command"><span class="secno">4.11.5.6 </span><dfn title="label-command">Using the <code title="attr-accesskey">accesskey</code> attribute on a <code>label</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3907:
3908: <p>A <code><a href="forms.html#the-label-element">label</a></code> element that has an <a href="editing.html#assigned-access-key">assigned access
3909: key</a> and a <a href="forms.html#labeled-control">labeled control</a> and whose
3910: <a href="forms.html#labeled-control">labeled control</a> <a href="#concept-command" title="concept-command">defines a
3911: command</a>, itself <a href="#concept-command" title="concept-command">defines a
3912: command</a>.</p>
3913:
3914: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3915: is "command".</p>
3916:
3917: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3918: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3919: element, if the attribute is present and not empty. Otherwise the
3920: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3921:
3922: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3923: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3924: attribute.</p>
3925:
3926: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3927: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3928: of the element.</p>
3929:
3930: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3931: command.</p>
3932:
3933: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3934: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
3935:
3936: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>,
3937: <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a>, and
3938: <a href="#command-facet-action" title="command-facet-Action">Action</a> facets of the
3939: command are the same as the respective facets of the element's
3940: <a href="forms.html#labeled-control">labeled control</a>.</p>
3941:
3942: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3943: of the command is always false. (The command is never checked.)</p>
3944:
3945:
3946:
1.729 mike 3947: <h5 id="using-the-accesskey-attribute-on-a-legend-element-to-define-a-command"><span class="secno">4.11.5.7 </span><dfn title="legend-command">Using the <code title="attr-accesskey">accesskey</code> attribute on a <code>legend</code> element to define a command</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3948:
1.300 mike 3949: <p>A <code><a href="forms.html#the-legend-element">legend</a></code> element that has an <a href="editing.html#assigned-access-key">assigned access
1.1 mike 3950: key</a> and is a child of a <code><a href="forms.html#the-fieldset-element">fieldset</a></code> element that
1.300 mike 3951: has a descendant that is not a descendant of the <code><a href="forms.html#the-legend-element">legend</a></code>
1.1 mike 3952: element and is neither a <code><a href="forms.html#the-label-element">label</a></code> element nor a
1.300 mike 3953: <code><a href="forms.html#the-legend-element">legend</a></code> element but that <a href="#concept-command" title="concept-command">defines a command</a>, itself <a href="#concept-command" title="concept-command">defines a command</a>.</p>
1.1 mike 3954:
3955: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3956: is "command".</p>
3957:
3958: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3959: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3960: element, if the attribute is present and not empty. Otherwise the
3961: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3962:
3963: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3964: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3965: attribute.</p>
3966:
3967: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3968: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3969: of the element.</p>
3970:
3971: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3972: command.</p>
3973:
3974: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3975: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
3976:
3977: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>,
3978: <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a>, and
3979: <a href="#command-facet-action" title="command-facet-Action">Action</a> facets of the
3980: command are the same as the respective facets of the first element
3981: in <a href="infrastructure.html#tree-order">tree order</a> that is a descendant of the parent of the
1.300 mike 3982: <code><a href="forms.html#the-legend-element">legend</a></code> element that <a href="#concept-command" title="concept-command">defines a command</a> but is not a
3983: descendant of the <code><a href="forms.html#the-legend-element">legend</a></code> element and is neither a
3984: <code><a href="forms.html#the-label-element">label</a></code> nor a <code><a href="forms.html#the-legend-element">legend</a></code> element.</p>
1.1 mike 3985:
3986: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3987: of the command is always false. (The command is never checked.)</p>
3988:
3989:
3990:
1.729 mike 3991: <h5 id="using-the-accesskey-attribute-to-define-a-command-on-other-elements"><span class="secno">4.11.5.8 </span><dfn title="accesskey-command">Using the <code title="attr-accesskey">accesskey</code> attribute to define a command on other elements</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3992:
1.28 mike 3993: <p>An element that has an <a href="editing.html#assigned-access-key">assigned access key</a> <a href="#concept-command" title="concept-command">defines a command</a>.</p>
3994:
3995: <p>If one of the other sections that define elements that <a href="#concept-command" title="concept-command">define commands</a> define that this
3996: element <a href="#concept-command" title="concept-command">defines a command</a>, then
3997: that section applies to this element, and this section does
3998: not. Otherwise, this section applies to that element.</p>
1.1 mike 3999:
4000: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
4001: is "command".</p>
4002:
4003: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
4004: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
4005: element, if the attribute is present and not empty. Otherwise the
4006: command is an <a href="#anonymous-command">anonymous command</a>.</p>
4007:
4008: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
4009: depends on the element. If the element is a <a href="forms.html#labeled-control">labeled
1.804 mike 4010: control</a>, the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first
1.1 mike 4011: <code><a href="forms.html#the-label-element">label</a></code> element in <a href="infrastructure.html#tree-order">tree order</a> whose
4012: <a href="forms.html#labeled-control">labeled control</a> is the element in question is the <a href="#command-facet-label" title="command-facet-Label">Label</a> (in DOM terms, this is the
4013: string given by <code><var title="">element</var>.labels[0].textContent</code>). Otherwise, the
4014: <a href="#command-facet-label" title="command-facet-Label">Label</a> is the
1.804 mike 4015: <code><a href="infrastructure.html#textcontent">textContent</a></code> of the element itself.</p>
1.1 mike 4016:
4017: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
4018: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
4019: of the element. If the attribute is not present, the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> is the empty string.</p>
4020:
4021: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
4022: command.</p>
4023:
4024: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
4025: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
4026:
4027: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
4028: of the command is true (hidden) if the element has a <code title="attr-hidden"><a href="editing.html#the-hidden-attribute">hidden</a></code> attribute, and false
4029: otherwise.</p>
4030:
4031: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
4032: State</a> facet of the command is always false. (The command is
4033: always enabled.)</p>
4034:
4035: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
4036: of the command is always false. (The command is never checked.)</p>
4037:
4038: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.230 mike 4039: command is to run the following steps:</p>
4040:
4041: <ol><li>If the element is <a href="editing.html#focusable">focusable</a>, run the
4042: <a href="editing.html#focusing-steps">focusing steps</a> for the element.</li>
4043:
4044: <li>If the element has a defined <a href="embedded-content-0.html#activation-behavior">activation behavior</a>,
4045: <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation steps</a> on the
4046: element.</li>
4047:
4048: <li>Otherwise, if the element does not have a defined
1.788 mike 4049: <a href="embedded-content-0.html#activation-behavior">activation behavior</a>, <a href="webappapis.html#fire-a-click-event">fire a <code title="event-click">click</code> event</a> at the element.</li>
1.1 mike 4050:
1.748 mike 4051: </ol></div><h3 id="links"><span class="secno">4.12 </span>Links</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><h4 id="hyperlink-elements"><span class="secno">4.12.1 </span>Hyperlink elements</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code><a href="text-level-semantics.html#the-a-element">a</a></code>, <code><a href="the-canvas-element.html#the-area-element">area</a></code>, and <code><a href="semantics.html#the-link-element">link</a></code>
4052: elements can, in certain situations described in the definitions of
4053: those elements, represent <dfn id="hyperlink" title="hyperlink">hyperlinks</dfn>.</p><p>The <dfn id="attr-hyperlink-href" title="attr-hyperlink-href"><code>href</code></dfn>
4054: attribute on a hyperlink element must have a value that is a
4055: <a href="infrastructure.html#valid-url">valid URL</a>. This URL is the <em>destination
4056: resource</em> of the hyperlink.</p><div class="note">
4057:
4058: <p>The <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute on
4059: <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements is not required; when
4060: those elements do not have <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attributes they do not
4061: represent hyperlinks.</p>
4062:
4063: <p>The <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute on the
4064: <code><a href="semantics.html#the-link-element">link</a></code> element <em>is</em> required, but whether a
4065: <code><a href="semantics.html#the-link-element">link</a></code> element represents a hyperlink or not depends on
4066: the value of the <code title="attr-link-rel"><a href="semantics.html#attr-link-rel">rel</a></code> attribute
4067: of that element.</p>
4068:
4069: </div><p>The <dfn id="attr-hyperlink-target" title="attr-hyperlink-target"><code>target</code></dfn>
4070: attribute, if present, must be a <a href="browsers.html#valid-browsing-context-name-or-keyword">valid browsing context name
4071: or keyword</a>. It gives the name of the <a href="browsers.html#browsing-context">browsing
4072: context</a> that will be used. <span class="impl">User agents use
4073: this name when <a href="#following-hyperlinks">following hyperlinks</a>.</span></p><p>The <dfn id="ping" title="attr-hyperlink-ping"><code>ping</code></dfn> attribute, if
4074: present, gives the URLs of the resources that are interested in
4075: being notified if the user follows the hyperlink. The value must be
4076: a <a href="infrastructure.html#set-of-space-separated-tokens">set of space-separated tokens</a>, each of which must be a
4077: <a href="infrastructure.html#valid-url" title="valid URL">valid URL</a>. <span class="impl">The
4078: value is used by the user agent for <a href="#hyperlink-auditing">hyperlink
4079: auditing</a>.</span></p><p>For <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that represent
4080: hyperlinks, the relationship between the document containing the
4081: hyperlink and the destination resource indicated by the hyperlink is
4082: given by the value of the element's <dfn id="attr-hyperlink-rel" title="attr-hyperlink-rel"><code>rel</code></dfn> attribute, which
4083: must be a <a href="infrastructure.html#set-of-space-separated-tokens">set of space-separated tokens</a>. The <a href="#linkTypes">allowed values and their meanings</a> are defined
4084: below. The <code title="attr-hyperlink-rel"><a href="#attr-hyperlink-rel">rel</a></code> attribute has
4085: no default value. If the attribute is omitted or if none of the
4086: values in the attribute are recognized by the user agent, then the
4087: document has no particular relationship with the destination
4088: resource other than there being a hyperlink between the two.</p><p>The <dfn id="attr-hyperlink-media" title="attr-hyperlink-media"><code>media</code></dfn>
4089: attribute describes for which media the target document was
4090: designed. It is purely advisory. The value must be a <a href="infrastructure.html#valid-media-query">valid
4091: media query</a>. The default, if the <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code> attribute is omitted, is
4092: "<code title="">all</code>".</p><p>The <dfn id="attr-hyperlink-hreflang" title="attr-hyperlink-hreflang"><code>hreflang</code></dfn>
4093: attribute on hyperlink elements, if present, gives the language of
4094: the linked resource. It is purely advisory. The value must be a
4095: valid BCP 47 language code. <a href="references.html#refsBCP47">[BCP47]</a>
4096: <span class="impl">User agents must not consider this attribute
4097: authoritative — upon fetching the resource, user agents must
4098: use only language information associated with the resource to
4099: determine its language, not metadata included in the link to the
4100: resource.</span></p><p>The <dfn id="attr-hyperlink-type" title="attr-hyperlink-type"><code>type</code></dfn>
4101: attribute, if present, gives the <a href="infrastructure.html#mime-type">MIME type</a> of the
4102: linked resource. It is purely advisory. The value must be a
4103: <a href="infrastructure.html#valid-mime-type">valid MIME type</a>. <span class="impl">User agents must
4104: not consider the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4105: attribute authoritative — upon fetching the resource, user
4106: agents must not use metadata included in the link to the resource to
4107: determine its type.</span></p><div class="impl">
4108:
4109: <h4 id="following-hyperlinks"><span class="secno">4.12.2 </span><dfn>Following hyperlinks</dfn></h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
4110:
4111: <p>When a user <em>follows a hyperlink</em>, the user agent must
4112: <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolve</a> the <a href="infrastructure.html#url">URL</a>
4113: given by the <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute
4114: of that hyperlink, relative to the hyperlink element, and if that is
4115: successful, must <a href="history.html#navigate">navigate</a> a <a href="browsers.html#browsing-context">browsing
4116: context</a> to the resulting <a href="infrastructure.html#absolute-url">absolute URL</a>. In the
4117: case of server-side image maps, the URL of the hyperlink must
4118: further have its <var><a href="text-level-semantics.html#hyperlink-suffix">hyperlink suffix</a></var> appended to it.</p>
4119:
4120: <p>If <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the
4121: <a href="infrastructure.html#url">URL</a> fails, the user agent may report the error to the
4122: user in a user-agent-specific manner, may navigate to an error page
4123: to report the error, or may ignore the error and do nothing.</p>
4124:
4125: <p>If the user indicated a specific <a href="browsers.html#browsing-context">browsing context</a>
4126: when following the hyperlink, or if the user agent is configured to
4127: follow hyperlinks by navigating a particular browsing context, then
4128: that must be the <a href="browsers.html#browsing-context">browsing context</a> that is
4129: navigated.</p>
4130:
4131: <p>Otherwise, if the hyperlink element is an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or
4132: <code><a href="the-canvas-element.html#the-area-element">area</a></code> element that has a <code title="attr-hyperlink-target"><a href="#attr-hyperlink-target">target</a></code> attribute, then the
4133: <a href="browsers.html#browsing-context">browsing context</a> that is navigated must be chosen by
4134: applying <a href="browsers.html#the-rules-for-choosing-a-browsing-context-given-a-browsing-context-name">the rules for choosing a browsing context given a
4135: browsing context name</a>, using the value of the <code title="attr-hyperlink-target"><a href="#attr-hyperlink-target">target</a></code> attribute as the
4136: browsing context name. If these rules result in the creation of a
4137: new <a href="browsers.html#browsing-context">browsing context</a>, it must be navigated with
4138: <a href="history.html#replacement-enabled">replacement enabled</a>.</p>
4139:
4140: <p>Otherwise, if the hyperlink element is a <a href="#rel-sidebar-hyperlink" title="rel-sidebar-hyperlink">sidebar hyperlink</a> and the user
4141: agent implements a feature that can be considered a secondary
4142: browsing context, such a secondary browsing context may be selected
4143: as the browsing context to be navigated.</p>
4144:
4145: <p>Otherwise, if the hyperlink element is an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or
4146: <code><a href="the-canvas-element.html#the-area-element">area</a></code> element with no <code title="attr-hyperlink-target"><a href="#attr-hyperlink-target">target</a></code> attribute, but one of
4147: the child nodes of <a href="dom.html#the-head-element">the <code>head</code> element</a> is a
4148: <code><a href="semantics.html#the-base-element">base</a></code> element with a <code title="attr-base-target"><a href="semantics.html#attr-base-target">target</a></code> attribute, then the browsing
4149: context that is navigated must be chosen by applying <a href="browsers.html#the-rules-for-choosing-a-browsing-context-given-a-browsing-context-name">the rules
4150: for choosing a browsing context given a browsing context name</a>,
4151: using the value of the <code title="attr-base-target"><a href="semantics.html#attr-base-target">target</a></code>
4152: attribute of the first such <code><a href="semantics.html#the-base-element">base</a></code> element as the
4153: browsing context name. If these rules result in the creation of a
4154: new <a href="browsers.html#browsing-context">browsing context</a>, it must be navigated with
4155: <a href="history.html#replacement-enabled">replacement enabled</a>.</p>
4156:
4157: <p>Otherwise, the browsing context that must be navigated is the
4158: same browsing context as the one which the hyperlink element itself
4159: is in.</p>
4160:
4161: <p>The navigation must be done with the <a href="browsers.html#browsing-context">browsing
1.804 mike 4162: context</a> that contains the <code><a href="infrastructure.html#document">Document</a></code> object with
1.748 mike 4163: which the hyperlink's element in question is associated as the
4164: <a href="history.html#source-browsing-context">source browsing context</a>.</p>
4165:
4166:
4167: <h5 id="hyperlink-auditing"><span class="secno">4.12.2.1 </span><dfn>Hyperlink auditing</dfn></h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/1">ISSUE-1</a> (PINGPOST) and <a href="http://www.w3.org/html/wg/tracker/issues/2">ISSUE-2</a> (PINGUI) block progress to Last Call</span></p>
4168:
4169: <p>If an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or <code><a href="the-canvas-element.html#the-area-element">area</a></code> hyperlink element has a
4170: <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute, and the
4171: user follows the hyperlink, and the hyperlink's <a href="infrastructure.html#url">URL</a> can
4172: be <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolved</a>, relative to the
4173: hyperlink element, without failure, then the user agent must take
4174: the <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute's value,
4175: <a href="infrastructure.html#split-a-string-on-spaces" title="split a string on spaces">split that string on
4176: spaces</a>, <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolve</a> each
4177: resulting token relative to the hyperlink element, and then should
4178: send a request (as described below) to each of the resulting <a href="infrastructure.html#absolute-url" title="absolute URL">absolute URLs</a>. (Tokens that fail to
4179: resolve are ignored.) This may be done in parallel with the primary
4180: request, and is independent of the result of that request.</p>
4181:
4182: <p>User agents should allow the user to adjust this behavior, for
4183: example in conjunction with a setting that disables the sending of
4184: HTTP <code title="http-referer">Referer</code> (sic) headers. Based
4185: on the user's preferences, UAs may either <a href="infrastructure.html#ignore">ignore</a> the
4186: <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute altogether,
4187: or selectively ignore URLs in the list (e.g. ignoring any
4188: third-party URLs).</p>
4189:
4190: <p>For URLs that are HTTP URLs, the requests must be performed by
4191: <a href="infrastructure.html#fetch" title="fetch">fetching</a> the specified URLs using the
4192: POST method, with an entity body with the <a href="infrastructure.html#mime-type">MIME type</a>
4193: <code><a href="iana.html#text-ping">text/ping</a></code> consisting of the four-character string
4194: "<code title="">PING</code>", from the <a href="browsers.html#origin">origin</a> of the
1.804 mike 4195: <code><a href="infrastructure.html#document">Document</a></code> containing the <a href="#hyperlink">hyperlink</a>. <!--
1.748 mike 4196: not http-origin privacy sensitive --> All relevant cookie and HTTP
4197: authentication headers must be included in the request. Which other
4198: headers are required depends on the URLs involved.</p>
4199:
4200: <dl class="switch"><dt>If both the <a href="dom.html#the-document-s-address" title="the document's address">address</a>
1.804 mike 4201: of the <code><a href="infrastructure.html#document">Document</a></code> object containing the hyperlink being
1.748 mike 4202: audited and the ping URL have the <a href="browsers.html#same-origin">same origin</a></dt>
4203:
4204: <dd>The request must include a <code title="http-ping-from"><a href="iana.html#ping-from">Ping-From</a></code> HTTP header with, as its
4205: value, the <a href="dom.html#the-document-s-address" title="the document's address">address</a> of
4206: the document containing the hyperlink, and a <code title="http-ping-to"><a href="iana.html#ping-to">Ping-To</a></code> HTTP header with, as its value,
4207: the address of the <a href="infrastructure.html#absolute-url">absolute URL</a> of the target of the
4208: hyperlink. The request must not include a <code title="http-referer">Referer</code> (sic) HTTP header. <!-- because
4209: otherwise it would look like a trustable same-origin POST --></dd>
4210:
4211: <dt>Otherwise, if the origins are different, but the document
4212: containing the hyperlink being audited was not retrieved over an
4213: encrypted connection</dt>
4214:
1.765 mike 4215: <dd>The request must include a <code title="http-referer">Referer</code> (sic) HTTP header with, as its
4216: value, the <a href="dom.html#the-document-s-current-address" title="the document's current address">current
4217: address</a> of the document containing the hyperlink, a <code title="http-ping-from"><a href="iana.html#ping-from">Ping-From</a></code> HTTP header with the same
4218: value, and a <code title="http-ping-to"><a href="iana.html#ping-to">Ping-To</a></code> HTTP header
4219: with, as its value, the address of the target of the
4220: hyperlink.</dd>
1.748 mike 4221:
4222: <dt>Otherwise, the origins are different and the document
4223: containing the hyperlink being audited was retrieved over an
4224: encrypted connection</dt>
4225:
4226: <dd>The request must include a <code title="http-ping-to"><a href="iana.html#ping-to">Ping-To</a></code> HTTP header with, as its value,
4227: the address of the target of the hyperlink. The request must
4228: neither include a <code title="http-referer">Referer</code> (sic)
4229: HTTP header nor include a <code title="http-ping-from"><a href="iana.html#ping-from">Ping-From</a></code> HTTP header.</dd>
4230:
4231: </dl><p class="note">To save bandwidth, implementors might also wish to
4232: consider omitting optional headers such as <code>Accept</code> from
4233: these requests.</p>
4234:
4235: <p>User agents must, unless otherwise specified by the user, honor
4236: the HTTP headers (including, in particular, redirects and HTTP
4237: cookie headers), but must ignore any entity bodies returned in the
4238: responses. User agents may close the connection prematurely once
4239: they start receiving an entity body. <a href="references.html#refsCOOKIES">[COOKIES]</a></p>
4240:
4241: <p>For URLs that are not HTTP URLs, the requests must be performed
4242: by <a href="infrastructure.html#fetch" title="fetch">fetching</a> the specified URL normally,
4243: and discarding the results.</p>
4244:
4245: <p>When the <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute is
4246: present, user agents should clearly indicate to the user that
4247: following the hyperlink will also cause secondary requests to be
4248: sent in the background, possibly including listing the actual target
4249: URLs.</p>
4250:
4251: <p class="example">For example, a visual user agent could include
4252: the hostnames of the target ping URLs along with the hyperlink's
4253: actual URL in a status bar or tooltip.</p>
4254:
4255: </div><div class="note">
4256:
4257: <p>The <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute is redundant
4258: with pre-existing technologies like HTTP redirects and JavaScript
4259: in allowing Web pages to track which off-site links are most
4260: popular or allowing advertisers to track click-through rates.</p>
4261:
4262: <p>However, the <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute
4263: provides these advantages to the user over those alternatives:</p>
4264:
4265: <ul><li>It allows the user to see the final target URL
4266: unobscured.</li>
4267:
4268: <li>It allows the UA to inform the user about the out-of-band
4269: notifications.</li>
4270:
4271: <li>It allows the user to disable the notifications without losing
4272: the underlying link functionality.</li>
4273:
4274: <li>It allows the UA to optimize the use of available network
4275: bandwidth so that the target page loads faster.</li>
4276:
4277: </ul><p>Thus, while it is possible to track users without this feature,
4278: authors are encouraged to use the <code title="attr-hyperlink-ping"><a href="#ping">ping</a></code> attribute so that the user
4279: agent can make the user experience more transparent.</p>
4280:
4281: </div><!-- resolving ping urls happens at audit time, so base URL changes
4282: affect the values of ping attributes --><h4 id="linkTypes"><span class="secno">4.12.3 </span>Link types</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The following table summarizes the link types that are defined by
4283: this specification. This table is non-normative; the actual
4284: definitions for the link types are given in the next few
4285: sections.</p><p>In this section, the term <i>referenced document</i> refers to
4286: the resource identified by the element representing the link, and
4287: the term <i>current document</i> refers to the resource within
4288: which the element representing the link finds itself.</p><div class="impl">
4289:
4290: <p>To determine which link types apply to a <code><a href="semantics.html#the-link-element">link</a></code>,
4291: <code><a href="text-level-semantics.html#the-a-element">a</a></code>, or <code><a href="the-canvas-element.html#the-area-element">area</a></code> element, the element's <code title="">rel</code> attribute must be <a href="infrastructure.html#split-a-string-on-spaces" title="split a string on
4292: spaces">split on spaces</a>. The resulting tokens are the link
4293: types that apply to that element.</p>
4294:
4295: </div><p>Except where otherwise specified, a keyword must not be specified
4296: more than once per <code title="attr-rel-hyperlink">rel</code>
4297: attribute.</p><p>The link types that contain no U+003A COLON characters (:),
4298: including all those defined in this specification, are <a href="infrastructure.html#ascii-case-insensitive">ASCII
4299: case-insensitive</a> values<span class="impl">, and must be
4300: compared as such</span>.</p><p class="example">Thus, <code title="">rel="next"</code> is the
4301: same as <code title="">rel="NEXT"</code>.</p><table><thead><tr><th rowspan="2">Link type</th>
4302: <th colspan="2">Effect on...</th>
4303: <th rowspan="2">Brief description</th>
4304: </tr><tr><th><code><a href="semantics.html#the-link-element">link</a></code></th>
4305: <th><code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code></th>
4306: </tr></thead><tbody><tr><td><code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code></td> <!-- second most used <link rel> value -->
4307: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4308: <td><a href="#hyperlink">Hyperlink</a></td>
4309: <td>Gives alternate representations of the current document.</td>
4310: </tr><tr><td><code title="rel-archives"><a href="#link-type-archives">archives</a></code></td>
4311: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4312: <td><a href="#hyperlink">Hyperlink</a></td>
4313: <td>Provides a link to a collection of records, documents, or other materials of historical interest.</td>
4314: </tr><tr><td><code title="rel-author"><a href="#link-type-author">author</a></code></td>
4315: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4316: <td><a href="#hyperlink">Hyperlink</a></td>
4317: <td>Gives a link to the current document's author.</td>
4318: </tr><tr><td><code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code></td> <!-- fourth most used <a rel> value -->
4319: <td><em>not allowed</em></td>
4320: <td><a href="#hyperlink">Hyperlink</a></td>
4321: <td>Gives the permalink for the nearest ancestor section.</td>
4322: </tr><!-- (commented out on the assumption that rel=contact is really XFN)
4323: <tr>
4324: <td><code title="rel-contact">contact</code></td> <!- 8th most used <a rel> value ->
4325: <td><span title="hyperlink link">Hyperlink</span></td>
4326: <td><span>Hyperlink</span></td>
4327: <td>Gives a link to contact information for the current document.</td>
4328: </tr>
4329: --><tr><td><code title="rel-external"><a href="#link-type-external">external</a></code></td> <!-- fifth and sixth most used <a rel> value (sixth is "external nofollow") -->
4330: <td><em>not allowed</em></td>
4331: <td><a href="#hyperlink">Hyperlink</a></td>
4332: <td>Indicates that the referenced document is not part of the same site as the current document.</td>
4333: </tr><tr><td><code title="rel-first"><a href="#link-type-first">first</a></code></td>
4334: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4335: <td><a href="#hyperlink">Hyperlink</a></td>
4336: <td>Indicates that the current document is a part of a series, and that the first document in the series is the referenced document.</td>
4337: </tr><tr><td><code title="rel-help"><a href="#link-type-help">help</a></code></td>
4338: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4339: <td><a href="#hyperlink">Hyperlink</a></td>
4340: <td>Provides a link to context-sensitive help.</td>
4341: </tr><tr><td><code title="rel-icon"><a href="#rel-icon">icon</a></code></td> <!-- link rel="shortcut icon" and its ilk are the fourth, sixth, and ninth most used values -->
4342: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4343: <td><em>not allowed</em></td>
4344: <td>Imports an icon to represent the current document.</td>
4345: </tr><tr><td><code title="rel-index"><a href="#link-type-index">index</a></code></td> <!-- used more than "top" and "contents" on <link> (though on <a>, "contents" wins) -->
4346: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4347: <td><a href="#hyperlink">Hyperlink</a></td>
4348: <td>Gives a link to the document that provides a table of contents or index listing the current document.</td>
4349: </tr><tr><td><code title="rel-last"><a href="#link-type-last">last</a></code></td>
4350: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4351: <td><a href="#hyperlink">Hyperlink</a></td>
4352: <td>Indicates that the current document is a part of a series, and that the last document in the series is the referenced document.</td>
4353: </tr><tr><td><code title="rel-license"><a href="#link-type-license">license</a></code></td> <!-- seventh most used <a rel> value -->
4354: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4355: <td><a href="#hyperlink">Hyperlink</a></td>
4356: <td>Indicates that the main content of the current document is covered by the copyright license described by the referenced document.</td>
4357: </tr><tr><td><code title="rel-next"><a href="#link-type-next">next</a></code></td>
4358: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4359: <td><a href="#hyperlink">Hyperlink</a></td>
4360: <td>Indicates that the current document is a part of a series, and that the next document in the series is the referenced document.</td>
4361: </tr><tr><td><code title="rel-nofollow"><a href="#link-type-nofollow">nofollow</a></code></td> <!-- most used <a rel> value (and sixth most used is "external nofollow") -->
4362: <td><em>not allowed</em></td>
4363: <td><a href="#hyperlink">Hyperlink</a></td>
4364: <td>Indicates that the current document's original author or publisher does not endorse the referenced document.</td>
4365: </tr><tr><td><code title="rel-noreferrer"><a href="#link-type-noreferrer">noreferrer</a></code></td>
4366: <td><em>not allowed</em></td>
4367: <td><a href="#hyperlink">Hyperlink</a></td>
4368: <td>Requires that the user agent not send an HTTP <code title="http-referer">Referer</code> (sic) header if the user follows the hyperlink.</td>
4369: </tr><tr><td><code title="rel-pingback"><a href="#link-type-pingback">pingback</a></code></td>
4370: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4371: <td><em>not allowed</em></td>
4372: <td>Gives the address of the pingback server that handles pingbacks to the current document.</td>
4373: </tr><tr><td><code title="rel-prefetch"><a href="#link-type-prefetch">prefetch</a></code></td>
4374: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4375: <td><em>not allowed</em></td>
4376: <td>Specifies that the target resource should be preemptively cached.</td>
4377: </tr><tr><td><code title="rel-prev"><a href="#link-type-prev">prev</a></code></td> <!-- prev is used more than previous -->
4378: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4379: <td><a href="#hyperlink">Hyperlink</a></td>
4380: <td>Indicates that the current document is a part of a series, and that the previous document in the series is the referenced document.</td>
4381: </tr><tr><td><code title="rel-search"><a href="#link-type-search">search</a></code></td> <!-- used quite a bit -->
4382: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4383: <td><a href="#hyperlink">Hyperlink</a></td>
4384: <td>Gives a link to a resource that can be used to search through the current document and its related pages.</td>
4385: </tr><tr><td><code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code></td> <!-- most commonly used <link rel> value, variants came in 7th, 8th, 12th, 17th... -->
4386: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4387: <td><em>not allowed</em></td>
4388: <td>Imports a stylesheet.</td>
4389: </tr><tr><td><code title="rel-sidebar"><a href="#link-type-sidebar">sidebar</a></code></td> <!-- used quite a bit -->
4390: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4391: <td><a href="#hyperlink">Hyperlink</a></td>
4392: <td>Specifies that the referenced document, if retrieved, is intended to be shown in the browser's sidebar (if it has one).</td>
4393: </tr><tr><td><code title="rel-tag"><a href="#link-type-tag">tag</a></code></td> <!-- second and third most used <a rel> value (third is technically "category tag"). -->
4394: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4395: <td><a href="#hyperlink">Hyperlink</a></td>
4396: <td>Gives a tag (identified by the given address) that applies to the current document.</td>
4397: </tr><tr><td><code title="rel-up"><a href="#link-type-up">up</a></code></td>
4398: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4399: <td><a href="#hyperlink">Hyperlink</a></td>
4400: <td>Provides a link to a document giving the context for the current document.</td>
4401: </tr></tbody></table><div class="impl">
4402:
4403: <p>Some of the types described below list synonyms for these
4404: values. These <!--<span class="impl">-->are to be handled as
4405: specified by user agents, but<!--</span>--> must not be used in
4406: documents.</p>
4407:
4408: </div><!-- v2 ideas:
4409: * rel="script"
4410: * rel="related" // see also
4411: * http://microformats.org/wiki/rel-enclosure
4412: --><h5 id="link-type-alternate"><span class="secno">4.12.3.1 </span>Link type "<dfn title="rel-alternate"><code>alternate</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword may be
4413: used with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4414: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, if the <code title="attr-link-rel"><a href="semantics.html#attr-link-rel">rel</a></code> attribute does not also contain the
4415: keyword <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code>, it creates a
4416: <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>; but if it
4417: <em>does</em> also contain the keyword <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code>, the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword instead modifies the
4418: meaning of the <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code>
4419: keyword in the way described for that keyword, and the rest of this
4420: subsection doesn't apply.</p><p>The <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword
4421: indicates that the referenced document is an alternate
4422: representation of the current document.</p><p>The nature of the referenced document is given by the <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code>, <code title="attr-hyperlink-hreflang"><a href="#attr-hyperlink-hreflang">hreflang</a></code>, and <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code> attributes.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4423: used with the <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code>
4424: attribute, it indicates that the referenced document is intended for
4425: use with the media specified.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4426: used with the <code title="attr-hyperlink-hreflang"><a href="#attr-hyperlink-hreflang">hreflang</a></code>
4427: attribute, and that attribute's value differs from the <a href="infrastructure.html#root-element">root
4428: element</a>'s <a href="dom.html#language">language</a>, it indicates that the
4429: referenced document is a translation.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4430: used with the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4431: attribute, it indicates that the referenced document is a
4432: reformulation of the current document in the specified format.</p><p>The <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code>, <code title="attr-hyperlink-hreflang"><a href="#attr-hyperlink-hreflang">hreflang</a></code>, and <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code> attributes can be combined
4433: when specified with the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code>
4434: keyword.</p><div class="example">
4435:
4436: <p>For example, the following link is a French translation that
4437: uses the PDF format:</p>
4438:
4439: <pre><link rel=alternate type=application/pdf hreflang=fr href=manual-fr></pre>
4440:
4441: </div><div class="impl">
4442:
4443: <p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4444: used with the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4445: attribute set to the value <code title="">application/rss+xml</code>
4446: or the value <code title="">application/atom+xml</code>, then it
4447: indicates that the referenced document is a syndication feed (though
4448: not necessarily syndicating exactly the same content as the current
4449: page).</p>
4450:
4451: <div class="impl">
4452:
4453: <p>The first <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, or <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4454: element in the document (in tree order) with the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword used with the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code> attribute set to the value
4455: <code title="">application/rss+xml</code> or the value <code title="">application/atom+xml</code> must be treated as the default
4456: syndication feed for the purposes of feed autodiscovery.</p>
4457:
4458: <div class="example">
4459: <p>The following <code><a href="semantics.html#the-link-element">link</a></code> element gives the syndication
4460: feed for the current page:</p>
4461: <pre><link rel="alternate" type="application/atom+xml" href="data.xml"></pre>
4462: <p>The following extract offers various different syndication
4463: feeds:</p>
4464: <pre><p>You can access the planets database using Atom feeds:</p>
4465: <ul>
4466: <li><a href="recently-visited-planets.xml" rel="alternate" type="application/atom+xml">Recently Visited Planets</a></li>
4467: <li><a href="known-bad-planets.xml" rel="alternate" type="application/atom+xml">Known Bad Planets</a></li>
4468: <li><a href="unexplored-planets.xml" rel="alternate" type="application/atom+xml">Unexplored Planets</a></li>
4469: </ul></pre>
4470: </div>
4471:
4472: </div>
4473:
4474:
4475:
4476:
4477: </div><p>The <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> link
4478: relationship is transitive — that is, if a document links to
4479: two other documents with the link type "<code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code>", then, in addition to
4480: implying that those documents are alternative representations of the
4481: first document, it is also implying that those two documents are
4482: alternative representations of each other.</p><h5 id="link-type-archives"><span class="secno">4.12.3.2 </span>Link type "<dfn title="rel-archives"><code>archives</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-archives"><a href="#link-type-archives">archives</a></code> keyword may be
4483: used with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4484: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-archives"><a href="#link-type-archives">archives</a></code> keyword indicates
4485: that the referenced document describes a collection of records,
4486: documents, or other materials of historical interest.</p><p class="example">A blog's index page could link to an index of the
4487: blog's past posts with <code title="">rel="archives"</code>.</p><div class="impl">
4488:
4489: <p><strong>Synonyms</strong>: For historical reasons, user agents
4490: must also treat the keyword "<code title="">archive</code>" like the
4491: <code title="rel-archives"><a href="#link-type-archives">archives</a></code> keyword.</p>
4492:
4493: </div><h5 id="link-type-author"><span class="secno">4.12.3.3 </span>Link type "<dfn title="rel-author"><code>author</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-author"><a href="#link-type-author">author</a></code> keyword may be
4494: used with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4495: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>For <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements, the <code title="rel-author"><a href="#link-type-author">author</a></code> keyword indicates that the
4496: referenced document provides further information about the author of
4497: the nearest <code><a href="semantics.html#the-article-element">article</a></code> element ancestor of the element
4498: defining the hyperlink, if there is one, or of the page as a whole,
4499: otherwise.</p><p>For <code><a href="semantics.html#the-link-element">link</a></code> elements, the <code title="rel-author"><a href="#link-type-author">author</a></code> keyword indicates that the
4500: referenced document provides further information about the author
4501: for the page as a whole.</p><p class="note">The "referenced document" can be, and often is, a
4502: <code title="">mailto:</code> URL giving the e-mail address of the
4503: author. <a href="references.html#refsMAILTO">[MAILTO]</a></p><div class="impl">
4504:
4505: <p><strong>Synonyms</strong>: For historical reasons, user agents
4506: must also treat <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and
4507: <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that have a <code title="">rev</code>
4508: attribute with the value "<code>made</code>" as having the <code title="rel-author"><a href="#link-type-author">author</a></code> keyword specified as a link
4509: relationship.</p>
4510:
4511: </div><h5 id="link-type-bookmark"><span class="secno">4.12.3.4 </span>Link type "<dfn title="rel-bookmark"><code>bookmark</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code> keyword may be
4512: used with <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</p><p>The <code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code> keyword gives a
4513: permalink for the nearest ancestor <code><a href="semantics.html#the-article-element">article</a></code> element of
4514: the linking element in question, or of <a href="semantics.html#associatedSection">the section the linking element is most
4515: closely associated with</a>, if there are no ancestor
4516: <code><a href="semantics.html#the-article-element">article</a></code> elements.</p><div class="example">
4517: <p>The following snippet has three permalinks. A user agent could
4518: determine which permalink applies to which part of the spec by
4519: looking at where the permalinks are given.</p>
4520: <pre> ...
4521: <body>
4522: <h1>Example of permalinks</h1>
4523: <div id="a">
4524: <h2>First example</h2>
4525: <p><a href="a.html" rel="bookmark">This</a> permalink applies to
4526: only the content from the first H2 to the second H2. The DIV isn't
4527: exactly that section, but it roughly corresponds to it.</p>
4528: </div>
4529: <h2>Second example</h2>
4530: <article id="b">
4531: <p><a href="b.html" rel="bookmark">This</a> permalink applies to
4532: the outer ARTICLE element (which could be, e.g., a blog post).</p>
4533: <article id="c">
4534: <p><a href="c.html" rel="bookmark">This</a> permalink applies to
4535: the inner ARTICLE element (which could be, e.g., a blog comment).</p>
4536: </article>
4537: </article>
4538: </body>
4539: ...</pre>
4540: </div><!-- (commented out on the assumption that rel=contact is really XFN)
4541: <h5>Link type "<dfn title="rel-contact"><code>contact</code></dfn>"</h5>
4542:
4543: <p>The <code title="rel-contact">contact</code> keyword may be used
4544: with <code>link</code>, <code>a</code>, and <code>area</code>
4545: elements. For <code>link</code> elements, it creates a <span
4546: title="hyperlink link">hyperlink</span>.</p>
4547:
4548: <p>For <code>a</code> and <code>area</code> elements, the <code
4549: title="rel-contact">contact</code> keyword indicates that the
4550: referenced document provides further contact information for the
4551: author of the nearest <code>article</code> element ancestor of the
4552: element defining the hyperlink, if there is one, or of the page as a
4553: whole, otherwise.</p>
4554:
4555: <div class="impl">
4556:
4557: <p>User agents must treat any hyperlink in an <code>address</code>
4558: element as having the <code title="rel-contact">contact</code> link
4559: type specified.</p>
4560:
4561: </div>
4562:
4563: <p>For <code>link</code> elements, the <code
4564: title="rel-contact">contact</code> keyword indicates that the
4565: referenced document provides further contact information for the
4566: page as a whole.</p>
4567: --><h5 id="link-type-external"><span class="secno">4.12.3.5 </span>Link type "<dfn title="rel-external"><code>external</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-external"><a href="#link-type-external">external</a></code> keyword may be
4568: used with <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</p><p>The <code title="rel-external"><a href="#link-type-external">external</a></code> keyword indicates
4569: that the link is leading to a document that is not part of the site
4570: that the current document forms a part of.</p><h5 id="link-type-help"><span class="secno">4.12.3.6 </span>Link type "<dfn title="rel-help"><code>help</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-help"><a href="#link-type-help">help</a></code> keyword may be used with
4571: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4572: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>For <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements, the <code title="rel-help"><a href="#link-type-help">help</a></code> keyword indicates that the referenced
4573: document provides further help information for the parent of the
4574: element defining the hyperlink, and its children.</p><div class="example">
4575:
4576: <p>In the following example, the form control has associated
4577: context-sensitive help. The user agent could use this information,
4578: for example, displaying the referenced document if the user presses
4579: the "Help" or "F1" key.</p>
4580:
4581: <pre> <p><label> Topic: <input name=topic> <a href="help/topic.html" rel="help">(Help)</a></label></p></pre>
4582:
4583: </div><p>For <code><a href="semantics.html#the-link-element">link</a></code> elements, the <code title="rel-help"><a href="#link-type-help">help</a></code> keyword indicates that the referenced
4584: document provides help for the page as a whole.</p><h5 id="rel-icon"><span class="secno">4.12.3.7 </span>Link type "<dfn title="rel-icon"><code>icon</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-icon"><a href="#rel-icon">icon</a></code> keyword may be used with
4585: <code><a href="semantics.html#the-link-element">link</a></code> elements, for which it creates an <a href="semantics.html#external-resource-link" title="external resource link">external resource link</a>.</p><div class="impl">
4586:
4587: <p>The specified resource is an icon representing the page or site,
4588: and should be used by the user agent when representing the page in
4589: the user interface.</p>
4590:
4591: </div><p>Icons could be auditory icons, visual icons, or other kinds of
4592: icons. <span class="impl">If multiple icons are provided, the user
4593: agent must select the most appropriate icon according to the <code title="attr-link-type"><a href="semantics.html#attr-link-type">type</a></code>, <code title="attr-link-media"><a href="semantics.html#attr-link-media">media</a></code>, and <code title="attr-link-sizes"><a href="#attr-link-sizes">sizes</a></code> attributes. If there are
4594: multiple equally appropriate icons, user agents must use the last
4595: one declared in <a href="infrastructure.html#tree-order">tree order</a>. If the user agent tries to
4596: use an icon but that icon is determined, upon closer examination, to
4597: in fact be inappropriate (e.g. because it uses an unsupported
4598: format), then the user agent must try the next-most-appropriate icon
4599: as determined by the attributes.</span></p><div class="impl">
4600:
4601: <p>There is no default type for resources given by the <code title="rel-icon"><a href="#rel-icon">icon</a></code> keyword. However, for the purposes of
4602: <a href="semantics.html#concept-link-type-sniffing">determining the type of the
4603: resource</a>, user agents must expect the resource to be an image.</p>
4604:
4605: </div><p>The <dfn id="attr-link-sizes" title="attr-link-sizes"><code>sizes</code></dfn>
4606: attribute gives the sizes of icons for visual media.</p><p>If specified, the attribute must have a value that is an
4607: <a href="infrastructure.html#unordered-set-of-unique-space-separated-tokens">unordered set of unique space-separated tokens</a>. The
4608: values must all be either <code title="attr-link-sizes-any"><a href="#attr-link-sizes-any">any</a></code> or a value that consists of
4609: two <a href="infrastructure.html#valid-non-negative-integer" title="valid non-negative integer">valid non-negative
4610: integers</a> that do not have a leading U+0030 DIGIT ZERO (0)
4611: character and that are separated by a single U+0078 LATIN SMALL
4612: LETTER X character (x).</p><p>The keywords represent icon sizes.</p><div class="impl">
4613:
4614: <p>To parse and process the attribute's value, the user agent must
4615: first <a href="infrastructure.html#split-a-string-on-spaces" title="split a string on spaces">split the attribute's
4616: value on spaces</a>, and must then parse each resulting keyword
4617: to determine what it represents.</p>
4618:
4619: </div><p>The <dfn id="attr-link-sizes-any" title="attr-link-sizes-any"><code>any</code></dfn> keyword
4620: represents that the resource contains a scalable icon, e.g. as
4621: provided by an SVG image.</p><div class="impl">
4622:
4623: <p>Other keywords must be further parsed as follows to determine
4624: what they represent:</p>
4625:
4626: <ul><li><p>If the keyword doesn't contain exactly one U+0078 LATIN
4627: SMALL LETTER X character (x), then this keyword doesn't represent
4628: anything. Abort these steps for that keyword.</p></li>
4629:
4630: <li><p>Let <var title="">width string</var> be the string before
4631: the "<code title="">x</code>".</p></li>
4632:
4633: <li><p>Let <var title="">height string</var> be the string after the
4634: "<code title="">x</code>".</p></li>
4635:
4636: <li><p>If either <var title="">width string</var> or <var title="">height string</var> start with a U+0030 DIGIT ZERO (0)
4637: character or contain any characters other than characters in the
4638: range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then this
4639: keyword doesn't represent anything. Abort these steps for that
4640: keyword.</p></li>
4641:
4642: <li><p>Apply the <a href="infrastructure.html#rules-for-parsing-non-negative-integers">rules for parsing non-negative
4643: integers</a> to <var title="">width string</var> to obtain <var title="">width</var>.</p></li>
4644:
4645: <li><p>Apply the <a href="infrastructure.html#rules-for-parsing-non-negative-integers">rules for parsing non-negative
4646: integers</a> to <var title="">height string</var> to obtain <var title="">height</var>.</p></li>
4647:
4648: <li><p>The keyword represents that the resource contains a bitmap
4649: icon with a width of <var title="">width</var> device pixels and a
4650: height of <var title="">height</var> device pixels.</p></li>
4651:
4652: </ul></div><p>The keywords specified on the <code title="attr-link-sizes"><a href="#attr-link-sizes">sizes</a></code> attribute must not represent
4653: icon sizes that are not actually available in the linked
4654: resource.</p><div class="impl">
4655:
4656: <p>If the attribute is not specified, then the user agent must
4657: assume that the given icon is appropriate, but less appropriate than
4658: an icon of a known and appropriate size.</p>
4659:
4660: </div><div class="example">
4661:
4662: <p>The following snippet shows the top part of an application with
4663: several icons.</p>
4664:
4665: <pre><!DOCTYPE HTML>
4666: <html>
4667: <head>
4668: <title>lsForums — Inbox</title>
4669: <link rel=icon href=favicon.png sizes="16x16" type="image/png">
4670: <link rel=icon href=windows.ico sizes="32x32 48x48" type="image/vnd.microsoft.icon">
4671: <link rel=icon href=mac.icns sizes="128x128 512x512 8192x8192 32768x32768">
4672: <link rel=icon href=iphone.png sizes="59x60" type="image/png">
4673: <link rel=icon href=gnome.svg sizes="any" type="image/svg+xml">
4674: <link rel=stylesheet href=lsforums.css>
4675: <script src=lsforums.js></script>
4676: <meta name=application-name content="lsForums">
4677: </head>
4678: <body>
4679: ...</pre>
4680:
4681: </div><h5 id="link-type-license"><span class="secno">4.12.3.8 </span>Link type "<dfn title="rel-license"><code>license</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-license"><a href="#link-type-license">license</a></code> keyword may be used
4682: with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4683: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-license"><a href="#link-type-license">license</a></code> keyword indicates
4684: that the referenced document provides the copyright license terms
4685: under which the main content of the current document is
4686: provided.</p><p>This specification does not specify how to distinguish between
4687: the main content of a document and content that is not deemed to be
4688: part of that main content. The distinction should be made clear to
4689: the user.</p><div class="example">
4690:
4691: <p>Consider a photo sharing site. A page on that site might
4692: describe and show a photograph, and the page might be marked up as
4693: follows:</p>
4694:
4695: <pre><!DOCTYPE HTML>
4696: <html>
4697: <head>
4698: <title>Exampl Pictures: Kissat</title>
4699: <link rel="stylesheet" href="/style/default">
4700: </head>
4701: <body>
4702: <h1>Kissat</h1>
4703: <nav>
4704: <a href="../">Return to photo index</a>
4705: </nav>
4706: <figure>
4707: <img src="/pix/39627052_fd8dcd98b5.jpg">
4708: <figcaption>Kissat</figcaption>
4709: </figure>
4710: <p>One of them has six toes!</p>
4711: <p><small><a rel="license" href="http://www.opensource.org/licenses/mit-license.php">MIT Licensed</a></small></p>
4712: <footer>
4713: <a href="/">Home</a> | <a href="../">Photo index</a>
4714: <p><small>© copyright 2009 Exampl Pictures. All Rights Reserved.</small></p>
4715: </footer>
4716: </body>
4717: </html></pre>
4718:
4719: <p>In this case the <code title="rel-license"><a href="#link-type-license">license</a></code>
4720: applies to just the photo (the main content of the document), not
4721: the whole document. In particular not the design of the page
4722: itself, which is covered by the copyright given at the bottom of
4723: the document. This could be made clearer in the styling
4724: (e.g. making the license link prominently positioned near the
4725: photograph, while having the page copyright in light small text at
4726: the foot of the page.</p>
4727:
4728: </div><div class="impl">
4729:
4730: <p><strong>Synonyms</strong>: For historical reasons, user agents
4731: must also treat the keyword "<code title="">copyright</code>" like
4732: the <code title="rel-license"><a href="#link-type-license">license</a></code> keyword.</p>
4733:
4734: </div><h5 id="link-type-nofollow"><span class="secno">4.12.3.9 </span>Link type "<dfn title="rel-nofollow"><code>nofollow</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-nofollow"><a href="#link-type-nofollow">nofollow</a></code> keyword may be
4735: used with <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</p><p>The <code title="rel-nofollow"><a href="#link-type-nofollow">nofollow</a></code> keyword indicates
4736: that the link is not endorsed by the original author or publisher of
4737: the page, or that the link to the referenced document was included
4738: primarily because of a commercial relationship between people
4739: affiliated with the two pages.</p><h5 id="link-type-noreferrer"><span class="secno">4.12.3.10 </span>Link type "<dfn title="rel-noreferrer"><code>noreferrer</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-noreferrer"><a href="#link-type-noreferrer">noreferrer</a></code> keyword may be
4740: used with <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</p><p>It indicates that no referrer information is to be leaked when
4741: following the link.</p><div class="impl">
4742:
4743: <p>If a user agent follows a link defined by an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or
4744: <code><a href="the-canvas-element.html#the-area-element">area</a></code> element that has the <code title="rel-noreferrer"><a href="#link-type-noreferrer">noreferrer</a></code> keyword, the user agent
4745: must not include a <code title="http-referer">Referer</code> (sic)
4746: HTTP header (<a href="infrastructure.html#concept-http-equivalent-headers" title="concept-http-equivalent-headers">or
4747: equivalent</a> for other protocols) in the request.</p>
4748:
4749: <p>This keyword also <a href="browsers.html#noopener">causes the <code title="dom-opener">opener</code> attribute to remain null</a> if the
4750: hyperlink creates a new <a href="browsers.html#browsing-context">browsing context</a>.</p>
4751:
4752: </div><!-- v2: Would be nice to apply this to other elements too,
4753: e.g. letting <img> or CSS or <video> hide the referrer --><h5 id="link-type-pingback"><span class="secno">4.12.3.11 </span>Link type "<dfn title="rel-pingback"><code>pingback</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-pingback"><a href="#link-type-pingback">pingback</a></code> keyword may be
4754: used with <code><a href="semantics.html#the-link-element">link</a></code> elements, for which it creates an <a href="semantics.html#external-resource-link" title="external resource link">external resource link</a>.</p><p>For the semantics of the <code title="rel-pingback"><a href="#link-type-pingback">pingback</a></code> keyword, see the Pingback 1.0
4755: specification. <a href="references.html#refsPINGBACK">[PINGBACK]</a></p><h5 id="link-type-prefetch"><span class="secno">4.12.3.12 </span>Link type "<dfn title="rel-prefetch"><code>prefetch</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-prefetch"><a href="#link-type-prefetch">prefetch</a></code> keyword may be
4756: used with <code><a href="semantics.html#the-link-element">link</a></code> elements, for which it creates an <a href="semantics.html#external-resource-link" title="external resource link">external resource link</a>.</p><p>The <code title="rel-prefetch"><a href="#link-type-prefetch">prefetch</a></code> keyword indicates
4757: that preemptively fetching and caching the specified resource is
4758: likely to be beneficial, as it is highly likely that the user will
4759: require this resource.</p><p>There is no default type for resources given by the <code title="rel-prefetch"><a href="#link-type-prefetch">prefetch</a></code> keyword.</p><h5 id="link-type-search"><span class="secno">4.12.3.13 </span>Link type "<dfn title="rel-search"><code>search</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-search"><a href="#link-type-search">search</a></code> keyword may be used
4760: with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4761: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-search"><a href="#link-type-search">search</a></code> keyword indicates that
4762: the referenced document provides an interface specifically for
4763: searching the document and its related resources.</p><p class="note">OpenSearch description documents can be used with
4764: <code><a href="semantics.html#the-link-element">link</a></code> elements and the <code title="rel-search"><a href="#link-type-search">search</a></code> link type to enable user agents to
4765: autodiscover search interfaces. <a href="references.html#refsOPENSEARCH">[OPENSEARCH]</a></p><h5 id="link-type-stylesheet"><span class="secno">4.12.3.14 </span>Link type "<dfn title="rel-stylesheet"><code>stylesheet</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code> keyword may be
4766: used with <code><a href="semantics.html#the-link-element">link</a></code> elements, for which it creates an <a href="semantics.html#external-resource-link" title="external resource link">external resource link</a> that
4767: contributes to the <a href="semantics.html#styling">styling processing model</a>.</p><p>The specified resource is a resource that describes how to
4768: present the document. Exactly how the resource is to be processed
4769: depends on the actual type of the resource.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4770: also specified on the <code><a href="semantics.html#the-link-element">link</a></code> element, then <dfn id="the-link-is-an-alternative-stylesheet">the link
4771: is an alternative stylesheet</dfn>; in this case, the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute must be specified on the
4772: <code><a href="semantics.html#the-link-element">link</a></code> element, with a non-empty value.</p><p>The default type for resources given by the <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code> keyword is <code title="">text/css</code>.</p><div class="impl">
4773:
4774: <p><strong>Quirk</strong>: If the document has been set to
4775: <a href="dom.html#quirks-mode">quirks mode</a> and the <a href="infrastructure.html#content-type" title="Content-Type">Content-Type metadata</a> of the external
4776: resource is not a supported style sheet type, the user agent must
4777: instead assume it to be <code title="">text/css</code>.</p>
4778:
4779: </div><h5 id="link-type-sidebar"><span class="secno">4.12.3.15 </span>Link type "<dfn title="rel-sidebar"><code>sidebar</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-sidebar"><a href="#link-type-sidebar">sidebar</a></code> keyword may be used
4780: with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4781: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-sidebar"><a href="#link-type-sidebar">sidebar</a></code> keyword indicates
4782: that the referenced document, if retrieved, is intended to be shown
4783: in a <a href="browsers.html#secondary-browsing-context">secondary browsing context</a> (if possible), instead
4784: of in the current <a href="browsers.html#browsing-context">browsing context</a>.</p><p>A <a href="#hyperlink" title="hyperlink">hyperlink element</a> with the <code title="rel-sidebar"><a href="#link-type-sidebar">sidebar</a></code> keyword specified is a <dfn id="rel-sidebar-hyperlink" title="rel-sidebar-hyperlink">sidebar hyperlink</dfn>.</p><h5 id="link-type-tag"><span class="secno">4.12.3.16 </span>Link type "<dfn title="rel-tag"><code>tag</code></dfn>"</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-tag"><a href="#link-type-tag">tag</a></code> keyword may be used
4785: with <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4786: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-tag"><a href="#link-type-tag">tag</a></code> keyword indicates that the
4787: <em>tag</em> that the referenced document represents applies to the
4788: current document.</p><p class="note">Since it indicates that the tag <em>applies to the
4789: current document</em>, it would be inappropriate to use this keyword
4790: in the markup of a <a href="#tag-cloud">tag cloud</a>, which lists
4791: the popular tag across a set of pages.</p><h5 id="hierarchical-link-types"><span class="secno">4.12.3.17 </span>Hierarchical link types</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>Some documents form part of a hierarchical structure of
4792: documents.</p><p>A hierarchical structure of documents is one where each document
4793: can have various subdocuments. The document of which a document is a
4794: subdocument is said to be the document's <em>parent</em>. A document
4795: with no parent forms the top of the hierarchy.</p><p>A document may be part of multiple hierarchies.</p><h6 id="link-type-index"><span class="secno">4.12.3.17.1 </span>Link type "<dfn title="rel-index"><code>index</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-index"><a href="#link-type-index">index</a></code> keyword may be used with
4796: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4797: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-index"><a href="#link-type-index">index</a></code> keyword indicates that
4798: the document is part of a hierarchical structure, and that the link
4799: is leading to the document that is the top of the hierarchy. It
4800: conveys more information when used with the <code title="rel-up"><a href="#link-type-up">up</a></code> keyword (q.v.).</p><div class="impl">
4801:
4802: <p><strong>Synonyms</strong>: For historical reasons, user agents
4803: must also treat the keywords "<code title="">top</code>", "<code title="">contents</code>", and "<code title="">toc</code>" like the
4804: <code title="rel-index"><a href="#link-type-index">index</a></code> keyword.</p>
4805:
4806: </div><h6 id="link-type-up"><span class="secno">4.12.3.17.2 </span>Link type "<dfn title="rel-up"><code>up</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-up"><a href="#link-type-up">up</a></code> keyword may be used with
4807: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4808: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-up"><a href="#link-type-up">up</a></code> keyword indicates that the
4809: document is part of a hierarchical structure, and that the link is
4810: leading to a document that is an ancestor of the current
4811: document.</p><p>The <code title="rel-up"><a href="#link-type-up">up</a></code> keyword may be repeated within
4812: a <code title="attr-hyperlink-rel"><a href="#attr-hyperlink-rel">rel</a></code> attribute to indicate
4813: the hierarchical distance from the current document to the
4814: referenced document. If it occurs only once, then the link is
4815: leading to the current document's parent; each additional occurrence
4816: of the keyword represents one further level. If the <code title="rel-index"><a href="#link-type-index">index</a></code> keyword is also present, then the
4817: number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords is the depth of
4818: the current page relative to the top of the hierarchy. Only one link
4819: is created for the set of one or more <code title="rel-up"><a href="#link-type-up">up</a></code>
4820: keywords and, if present, the <code title="rel-index"><a href="#link-type-index">index</a></code>
4821: keyword.</p><p>If the page is part of multiple hierarchies, then they should be
4822: described in different <a href="embedded-content-0.html#paragraph" title="paragraph">paragraphs</a>. <span class="impl">User agents
4823: must scope any interpretation of the <code title="rel-up"><a href="#link-type-up">up</a></code>
4824: and <code title="rel-index"><a href="#link-type-index">index</a></code> keywords together
4825: indicating the depth of the hierarchy to the <a href="embedded-content-0.html#paragraph">paragraph</a>
4826: in which the link finds itself, if any, or to the document
4827: otherwise.</span></p><div class="impl">
4828:
4829: <p>When two links have both the <code title="rel-up"><a href="#link-type-up">up</a></code> and
4830: <code title="rel-index"><a href="#link-type-index">index</a></code> keywords specified together in
4831: the same scope and contradict each other by having a different
4832: number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords, the link with the
4833: greater number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords must be
4834: taken as giving the depth of the document.</p>
4835:
4836: </div><div class="example">
4837:
4838: <p>This can be used to mark up a navigation style sometimes known
4839: as bread crumbs. In the following example, the current page can be
4840: reached via two paths.</p>
4841:
4842: <pre><nav>
4843: <p>
4844: <a href="/" rel="index up up up">Main</a> >
4845: <a href="/products/" rel="up up">Products</a> >
4846: <a href="/products/dishwashers/" rel="up">Dishwashers</a> >
4847: <a>Second hand</a>
4848: </p>
4849: <p>
4850: <a href="/" rel="index up up">Main</a> >
4851: <a href="/second-hand/" rel="up">Second hand</a> >
4852: <a>Dishwashers</a>
4853: </p>
4854: </nav></pre>
4855:
4856: </div><p class="note">The <code title="dom-a-relList"><a href="text-level-semantics.html#dom-a-rellist">relList</a></code> IDL
4857: attribute (e.g. on the <code><a href="text-level-semantics.html#the-a-element">a</a></code> element) does not currently
4858: represent multiple <code title="rel-up"><a href="#link-type-up">up</a></code> keywords (the
4859: interface hides duplicates).</p><h5 id="sequential-link-types"><span class="secno">4.12.3.18 </span>Sequential link types</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>Some documents form part of a sequence of documents.</p><p>A sequence of documents is one where each document can have a
4860: <em>previous sibling</em> and a <em>next sibling</em>. A document
4861: with no previous sibling is the start of its sequence, a document
4862: with no next sibling is the end of its sequence.</p><p>A document may be part of multiple sequences.</p><h6 id="link-type-first"><span class="secno">4.12.3.18.1 </span>Link type "<dfn title="rel-first"><code>first</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-first"><a href="#link-type-first">first</a></code> keyword may be used with
4863: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4864: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-first"><a href="#link-type-first">first</a></code> keyword indicates that
4865: the document is part of a sequence, and that the link is leading to
4866: the document that is the first logical document in the sequence.</p><div class="impl">
4867:
4868: <p><strong>Synonyms</strong>: For historical reasons, user agents
4869: must also treat the keywords "<code title="">begin</code>" and
4870: "<code title="">start</code>" like the <code title="rel-first"><a href="#link-type-first">first</a></code> keyword.</p>
4871:
4872: </div><h6 id="link-type-last"><span class="secno">4.12.3.18.2 </span>Link type "<dfn title="rel-last"><code>last</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-last"><a href="#link-type-last">last</a></code> keyword may be used with
4873: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4874: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-last"><a href="#link-type-last">last</a></code> keyword indicates that the
4875: document is part of a sequence, and that the link is leading to the
4876: document that is the last logical document in the sequence.</p><div class="impl">
4877:
4878: <p><strong>Synonyms</strong>: For historical reasons, user agents
4879: must also treat the keyword "<code title="">end</code>" like the
4880: <code title="rel-last"><a href="#link-type-last">last</a></code> keyword.</p>
4881:
4882: </div><h6 id="link-type-next"><span class="secno">4.12.3.18.3 </span>Link type "<dfn title="rel-next"><code>next</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-next"><a href="#link-type-next">next</a></code> keyword may be used with
4883: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4884: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-next"><a href="#link-type-next">next</a></code> keyword indicates that the
4885: document is part of a sequence, and that the link is leading to the
4886: document that is the next logical document in the sequence.</p><h6 id="link-type-prev"><span class="secno">4.12.3.18.4 </span>Link type "<dfn title="rel-prev"><code>prev</code></dfn>"</h6><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>The <code title="rel-prev"><a href="#link-type-prev">prev</a></code> keyword may be used with
4887: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code>
4888: elements. For <code><a href="semantics.html#the-link-element">link</a></code> elements, it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>.</p><p>The <code title="rel-prev"><a href="#link-type-prev">prev</a></code> keyword indicates that the
4889: document is part of a sequence, and that the link is leading to the
4890: document that is the previous logical document in the sequence.</p><div class="impl">
4891:
4892: <p><strong>Synonyms</strong>: For historical reasons, user agents
4893: must also treat the keyword "<code title="">previous</code>" like
4894: the <code title="rel-prev"><a href="#link-type-prev">prev</a></code> keyword.</p>
4895:
4896: </div><h5 id="other-link-types"><span class="secno">4.12.3.19 </span>Other link types</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p><dfn id="concept-rel-extensions" title="concept-rel-extensions">Extensions to the predefined
4897: set of link types</dfn> may be registered in the <a href="http://wiki.whatwg.org/wiki/RelExtensions">WHATWG Wiki
4898: RelExtensions page</a>. <a href="references.html#refsWHATWGWIKI">[WHATWGWIKI]</a></p><p>Anyone is free to edit the WHATWG Wiki RelExtensions page at any
4899: time to add a type. Extension types must be specified with the
4900: following information:</p><dl><dt>Keyword</dt>
4901:
4902: <dd>
4903:
4904: <p>The actual value being defined. The value should not be
4905: confusingly similar to any other defined value (e.g. differing
4906: only in case).</p>
4907:
4908: <p>If the value contains a U+003A COLON character (:), it must
4909: also be an <a href="infrastructure.html#absolute-url">absolute URL</a>.</p>
4910:
4911: </dd>
4912:
4913:
4914: <dt>Effect on... <code><a href="semantics.html#the-link-element">link</a></code></dt>
4915:
4916: <dd>
4917:
4918: <p>One of the following:</p>
4919:
4920: <dl><dt>not allowed</dt>
4921:
4922: <dd>The keyword is not allowed to be specified on
4923: <code><a href="semantics.html#the-link-element">link</a></code> elements.</dd>
4924:
4925: <dt>Hyperlink</dt>
4926:
4927: <dd>The keyword may be specified on a <code><a href="semantics.html#the-link-element">link</a></code> element;
4928: it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink
4929: link</a>.</dd>
4930:
4931: <dt>External Resource</dt>
4932:
4933: <dd>The keyword may be specified on a <code><a href="semantics.html#the-link-element">link</a></code> element;
4934: it creates a <a href="semantics.html#external-resource-link" title="external resource link">external
4935: resource link</a>.</dd>
4936:
4937: </dl></dd>
4938:
4939:
4940: <dt>Effect on... <code><a href="text-level-semantics.html#the-a-element">a</a></code> and <code><a href="the-canvas-element.html#the-area-element">area</a></code></dt>
4941:
4942: <dd>
4943:
4944: <p>One of the following:</p>
4945:
4946: <dl><dt>not allowed</dt>
4947:
4948: <dd>The keyword is not allowed to be specified on <code><a href="text-level-semantics.html#the-a-element">a</a></code>
4949: and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</dd>
4950:
4951: <dt>Hyperlink</dt>
4952:
4953: <dd>The keyword may be specified on <code><a href="text-level-semantics.html#the-a-element">a</a></code> and
4954: <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</dd>
4955:
4956: </dl></dd>
4957:
4958:
4959: <dt>Brief description</dt>
4960:
4961: <dd><p>A short non-normative description of what the keyword's
4962: meaning is.</p></dd>
4963:
4964:
4965: <dt>Specification</dt>
4966:
4967: <dd><p>A link to a more detailed description of the keyword's
4968: semantics and requirements. It could be another page on the Wiki,
4969: or a link to an external page.</p></dd>
4970:
4971:
4972: <dt>Synonyms</dt>
4973:
4974: <dd><p>A list of other keyword values that have exactly the same
4975: processing requirements. Authors should not use the values defined
4976: to be synonyms, they are only intended to allow user agents to
4977: support legacy content. Anyone may remove synonyms that are not
4978: used in practice; only names that need to be processed as synonyms
4979: for compatibility with legacy content are to be registered in this
4980: way.</p></dd>
4981:
4982:
4983: <dt>Status</dt>
4984:
4985: <dd>
4986:
4987: <p>One of the following:</p>
4988:
4989: <dl><dt>Proposed</dt>
4990:
4991: <dd>The keyword has not received wide peer review and
4992: approval. Someone has proposed it and is, or soon will be, using
4993: it.</dd>
4994:
4995: <dt>Ratified</dt>
4996:
4997: <dd>The keyword has received wide peer review and approval. It
4998: has a specification that unambiguously defines how to handle
4999: pages that use the keyword, including when they use it in
5000: incorrect ways.</dd>
5001:
5002: <dt>Discontinued</dt>
5003:
5004: <dd>The keyword has received wide peer review and it has been
5005: found wanting. Existing pages are using this keyword, but new
5006: pages should avoid it. The "brief description" and
5007: "specification" entries will give details of what authors should
5008: use instead, if anything.</dd>
5009:
5010: </dl><p>If a keyword is found to be redundant with existing values, it
5011: should be removed and listed as a synonym for the existing
5012: value.</p>
5013:
5014: <p>If a keyword is registered in the "proposed" state for a
5015: period of a month or more without being used or specified, then it
5016: may be removed from the registry.</p>
5017:
5018: <p>If a keyword is added with the "proposed" status and found to
5019: be redundant with existing values, it should be removed and listed
5020: as a synonym for the existing value. If a keyword is added with
5021: the "proposed" status and found to be harmful, then it should be
5022: changed to "discontinued" status.</p>
5023:
5024: <p>Anyone can change the status at any time, but should only do so
5025: in accordance with the definitions above.</p>
5026:
5027: </dd>
5028:
5029: </dl><div class="impl">
5030:
5031: <p>Conformance checkers must use the information given on the WHATWG
5032: Wiki RelExtensions page to establish if a value is allowed or not:
5033: values defined in this specification or marked as "proposed" or
5034: "ratified" must be accepted when used on the elements for which they
5035: apply as described in the "Effect on..." field, whereas values
5036: marked as "discontinued" or not listed in either this specification
5037: or on the aforementioned page must be rejected as invalid.
5038: Conformance checkers may cache this information (e.g. for
5039: performance reasons or to avoid the use of unreliable network
5040: connectivity).</p>
5041:
5042: <p>When an author uses a new type not defined by either this
5043: specification or the Wiki page, conformance checkers should offer to
5044: add the value to the Wiki, with the details described above, with
5045: the "proposed" status.</p>
5046:
5047: </div><p>Types defined as extensions in the <a href="http://wiki.whatwg.org/wiki/RelExtensions">WHATWG Wiki
5048: RelExtensions page</a> with the status "proposed" or "ratified" may
5049: be used with the <code title="">rel</code> attribute on
5050: <code><a href="semantics.html#the-link-element">link</a></code>, <code><a href="text-level-semantics.html#the-a-element">a</a></code>, and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements in
1.765 mike 5051: accordance to the "Effect on..." field. <a href="references.html#refsWHATWGWIKI">[WHATWGWIKI]</a></p><h3 id="common-idioms-without-dedicated-elements"><span class="secno">4.13 </span>Common idioms without dedicated elements</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/89">ISSUE-89</a> (idioms) blocks progress to Last Call</span></p><h4 id="tag-clouds"><span class="secno">4.13.1 </span>Tag clouds</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p id="tag-cloud">This specification does not define any markup
1.299 mike 5052: specifically for marking up lists of keywords that apply to a group
5053: of pages (also known as <i>tag clouds</i>). In general, authors are
5054: encouraged to either mark up such lists using <code><a href="semantics.html#the-ul-element">ul</a></code>
5055: elements with explicit inline counts that are then hidden and turned
5056: into a presentational effect using a style sheet, or to use SVG.</p><div class="example">
5057:
5058: <p>Here, three tags are included in a short tag cloud:</p>
5059:
5060: <pre><style>
5061: @media screen, print, handheld, tv {
5062: /* should be ignored by non-visual browsers */
5063: .tag-cloud > li > span { display: none; }
5064: .tag-cloud > li { display: inline; }
5065: .tag-cloud-1 { font-size: 0.7em; }
5066: .tag-cloud-2 { font-size: 0.9em; }
5067: .tag-cloud-3 { font-size: 1.1em; }
5068: .tag-cloud-4 { font-size: 1.3em; }
5069: .tag-cloud-5 { font-size: 1.5em; }
5070: }
5071: </style>
5072: ...
5073: <ul class="tag-cloud">
5074: <li class="tag-cloud-4"><a title="28 instances" href="/t/apple">apple</a> <span>(popular)</span>
5075: <li class="tag-cloud-2"><a title="6 instances" href="/t/kiwi">kiwi</a> <span>(rare)</span>
5076: <li class="tag-cloud-5"><a title="41 instances" href="/t/pear">pear</a> <span>(very popular)</span>
5077: </ul></pre>
5078:
5079: <p>The actual frequency of each tag is given using the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute. A CSS style sheet is
5080: provided to convert the markup into a cloud of differently-sized
5081: words, but for user agents that do not support CSS or are not
5082: visual, the markup contains annotations like "(popular)" or
5083: "(rare)" to categorize the various tags by frequency, thus enabling
5084: all users to benefit from the information.</p>
5085:
5086: <p>The <code><a href="semantics.html#the-ul-element">ul</a></code> element is used (rather than
1.749 mike 5087: <code><a href="semantics.html#the-ol-element">ol</a></code>) because the order is not particularly important:
1.299 mike 5088: while the list is in fact ordered alphabetically, it would convey
5089: the same information if ordered by, say, the length of the tag.</p>
5090:
1.748 mike 5091: <p>The <code title="rel-tag"><a href="#link-type-tag">tag</a></code> <code title="attr-hyperlink-rel"><a href="#attr-hyperlink-rel">rel</a></code>-keyword is <em>not</em> used
1.299 mike 5092: on these <code><a href="text-level-semantics.html#the-a-element">a</a></code> elements because they do not represent tags
5093: that apply to the page itself; they are just part of an index
5094: listing the tags themselves.</p>
5095:
1.748 mike 5096: </div><h4 id="conversations"><span class="secno">4.13.2 </span>Conversations</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><!-- http://lists.whatwg.org/htdig.cgi/whatwg-whatwg.org/2009-September/022576.html --><p>This specification does not define a specific element for marking
1.299 mike 5097: up conversations, meeting minutes, chat transcripts, dialogues in
5098: screenplays, instant message logs, and other situations where
5099: different players take turns in discourse.</p><p>Instead, authors are encouraged to mark up conversations using
1.303 mike 5100: <code><a href="semantics.html#the-p-element">p</a></code> elements and punctuation. Authors who need to mark
5101: the speaker for styling purposes are encouraged to use
5102: <code><a href="text-level-semantics.html#the-span-element">span</a></code> or <code><a href="text-level-semantics.html#the-b-element">b</a></code>. Paragraphs with their text
5103: wrapped in the <code><a href="text-level-semantics.html#the-i-element">i</a></code> element can be used for marking up
5104: stage directions.</p><div class="example">
1.299 mike 5105:
5106: <p>This example demonstrates this using an extract from Abbot and
5107: Costello's famous sketch, <cite>Who's on first</cite>:</p>
5108:
1.303 mike 5109: <pre><p> Costello: Look, you gotta first baseman?
5110: <p> Abbott: Certainly.
5111: <p> Costello: Who's playing first?
5112: <p> Abbott: That's right.
5113: <p> Costello becomes exasperated.
5114: <p> Costello: When you pay off the first baseman every month, who gets the money?
5115: <p> Abbott: Every dollar of it.</pre>
1.299 mike 5116:
5117: </div><div class="example">
5118:
5119: <p>The following extract shows how an IM conversation log could be
5120: marked up.</p>
5121:
5122: <pre><p> <time>14:22</time> <b>egof</b> I'm not that nerdy, I've only seen 30% of the star trek episodes
5123: <p> <time>14:23</time> <b>kaj</b> if you know what percentage of the star trek episodes you have seen, you are inarguably nerdy
5124: <p> <time>14:23</time> <b>egof</b> it's unarguably
1.303 mike 5125: <p> <time>14:23</time> <i>* kaj blinks</i>
1.299 mike 5126: <p> <time>14:24</time> <b>kaj</b> you are not helping your case</pre>
5127: <!-- with thanks to http://bash.org/?854262 -->
5128:
1.748 mike 5129: </div><h4 id="footnotes"><span class="secno">4.13.3 </span>Footnotes</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><p>HTML does not have a dedicated mechanism for marking up
1.299 mike 5130: footnotes. Here are the recommended alternatives.</p><hr><p>For short inline annotations, the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute should be used.</p><div class="example">
5131:
1.419 mike 5132: <p>In this example, two parts of a dialogue are annotated with
5133: footnote-like content using the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute.</p>
1.299 mike 5134:
5135: <pre><p> <b>Customer</b>: Hello! I wish to register a complaint. Hello. Miss?
1.419 mike 5136: <p> <b>Shopkeeper</b>: <strong><span title="Colloquial pronunciation of 'What do you'"</strong>
1.299 mike 5137: >Watcha</span> mean, miss?
5138: <p> <b>Customer</b>: Uh, I'm sorry, I have a cold. I wish to make a complaint.
1.419 mike 5139: <p> <b>Shopkeeper</b>: Sorry, <span <strong>title="This is, of course, a lie."</strong>>we're
1.299 mike 5140: closing for lunch</span>.</pre>
5141:
5142: </div><hr><p>For longer annotations, the <code><a href="text-level-semantics.html#the-a-element">a</a></code> element should be
5143: used, pointing to an element later in the document. The convention
5144: is that the contents of the link be a number in square brackets.</p><div class="example">
5145:
5146: <p>In this example, a footnote in the dialogue links to a paragraph
5147: below the dialogue. The paragraph then reciprocally links back to the
5148: dialogue, allowing the user to return to the location of the
5149: footnote.</p>
5150:
1.303 mike 5151: <pre><p> Announcer: Number 16: The <i>hand</i>.
5152: <p> Interviewer: Good evening. I have with me in the studio tonight
5153: Mr Norman St John Polevaulter, who for the past few years has been
5154: contradicting people. Mr Polevaulter, why <em>do</em> you
5155: contradict people?
5156: <p> Norman: I don't. <sup><a href="#fn1" id="r1">[1]</a></sup>
5157: <p> Interviewer: You told me you did!
1.299 mike 5158: <em>...</em>
5159: <section>
5160: <p id="fn1"><a href="#r1">[1]</a> This is, naturally, a lie,
5161: but paradoxically if it were true he could not say so without
5162: contradicting the interviewer and thus making it false.</p>
5163: </section></pre>
5164:
5165: </div><hr><p>For side notes, longer annotations that apply to entire sections
5166: of the text rather than just specific words or sentences, the
5167: <code><a href="semantics.html#the-aside-element">aside</a></code> element should be used.</p><div class="example">
5168:
5169: <p>In this example, a sidebar is given after a dialogue, giving it
5170: some context.</p>
5171:
1.303 mike 5172: <pre><p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
5173: <p> <span class="speaker">Shopkeeper</span>: I'm sorry?
5174: <p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
5175: <p> <span class="speaker">Shopkeeper</span>: No no no, this's'a tobacconist's.
1.299 mike 5176: <aside>
5177: <p>In 1970, the British Empire lay in ruins, and foreign
5178: nationalists frequented the streets — many of them Hungarians
5179: (not the streets — the foreign nationals). Sadly, Alexander
5180: Yalt has been publishing incompetently-written phrase books.
5181: </aside></pre>
5182:
5183: </div><hr><p>For figures or tables, footnotes can be included in the relevant
1.756 mike 5184: <code><a href="semantics.html#the-figcaption-element">figcaption</a></code> or <code><a href="tabular-data.html#the-caption-element">caption</a></code> element, or in
1.729 mike 5185: surrounding prose.</p><div class="example">
1.299 mike 5186:
5187: <p>In this example, a <!-- round --> table has cells with footnotes
1.756 mike 5188: that are given in prose. A <code><a href="semantics.html#the-figure-element">figure</a></code> element is used to
1.299 mike 5189: give a single legend to the combination of the table and its
5190: footnotes.</p>
5191:
5192: <pre><figure>
1.729 mike 5193: <figcaption>Table 1. Alternative activities for knights.</figcaption>
5194: <table>
5195: <tr>
5196: <th> Activity
5197: <th> Location
5198: <th> Cost
5199: <tr>
5200: <td> Dance
5201: <td> Wherever possible
5202: <td> £0<sup><a href="#fn1">1</a></sup>
5203: <tr>
5204: <td> Routines, chorus scenes<sup><a href="#fn2">2</a></sup>
5205: <td> Undisclosed
5206: <td> Undisclosed
5207: <tr>
5208: <td> Dining<sup><a href="#fn3">3</a></sup>
5209: <td> Camelot
5210: <td> Cost of ham, jam, and spam<sup><a href="#fn4">4</a></sup>
5211: </table>
5212: <p id="fn1">1. Assumed.</p>
5213: <p id="fn2">2. Footwork impeccable.</p>
5214: <p id="fn3">3. Quality described as "well".</p>
5215: <p id="fn4">4. A lot.</p>
1.299 mike 5216: </figure></pre>
5217:
1.117 mike 5218: </div><div class="impl">
1.1 mike 5219:
1.748 mike 5220: <h3 id="matching-html-elements-using-selectors"><span class="secno">4.14 </span>Matching HTML elements using selectors</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 5221:
1.748 mike 5222: <h4 id="selectors"><span class="secno">4.14.1 </span>Case-sensitivity</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.718 mike 5223:
5224: <p>Attribute and element <em>names</em> of <a href="infrastructure.html#html-elements">HTML
5225: elements</a> in <a href="dom.html#html-documents">HTML documents</a> must be treated as
5226: <a href="infrastructure.html#ascii-case-insensitive">ASCII case-insensitive</a>.</p>
5227:
5228: <p>Classes from the <code title="attr-class"><a href="dom.html#classes">class</a></code> attribute
5229: of <a href="infrastructure.html#html-elements">HTML elements</a> in documents that are in <a href="dom.html#quirks-mode">quirks
5230: mode</a> must be treated as <a href="infrastructure.html#ascii-case-insensitive">ASCII
5231: case-insensitive</a>.</p>
5232:
5233: <p>Attribute selectors on an <a href="infrastructure.html#html-elements" title="HTML elements">HTML
5234: element</a> in an <a href="dom.html#html-documents" title="HTML documents">HTML
5235: document</a> must treat the <em>values</em> of attributes with
5236: the following names as <a href="infrastructure.html#ascii-case-insensitive">ASCII case-insensitive</a>:</p>
5237:
5238: <!-- based on Mozilla's list, which was itself based on HTML4 -->
5239: <!-- WebKit's was identical at the time of writing except as noted below -->
5240: <ul class="brief"><li><code title="">accept</code>
5241: </li><li><code title="">accept-charset</code>
5242: </li><li><code title="">align</code>
5243: </li><li><code title="">alink</code>
5244: </li><li><code title="">axis</code>
5245: </li><li><code title="">bgcolor</code>
5246: </li><li><code title="">charset</code>
5247: </li><li><code title="">checked</code>
5248: </li><li><code title="">clear</code>
5249: </li><li><code title="">codetype</code>
5250: </li><li><code title="">color</code>
5251: </li><li><code title="">compact</code>
5252: </li><li><code title="">declare</code>
5253: </li><li><code title="">defer</code>
5254: </li><li><code title="">dir</code>
5255: </li><li><code title="">direction</code> <!-- not in webkit -->
5256: </li><li><code title="">disabled</code>
5257: </li><li><code title="">enctype</code>
5258: </li><li><code title="">face</code>
5259: </li><li><code title="">frame</code>
5260: </li><li><code title="">hreflang</code>
5261: </li><li><code title="">http-equiv</code>
5262: </li><li><code title="">lang</code>
5263: </li><li><code title="">language</code>
5264: </li><li><code title="">link</code>
5265: </li><li><code title="">media</code>
5266: </li><li><code title="">method</code>
5267: </li><li><code title="">multiple</code>
5268: </li><li><code title="">nohref</code>
5269: </li><li><code title="">noresize</code>
5270: </li><li><code title="">noshade</code>
5271: </li><li><code title="">nowrap</code>
5272: </li><li><code title="">readonly</code>
5273: </li><li><code title="">rel</code>
5274: </li><li><code title="">rev</code>
5275: </li><li><code title="">rules</code>
5276: </li><li><code title="">scope</code>
5277: </li><li><code title="">scrolling</code>
5278: </li><li><code title="">selected</code>
5279: </li><li><code title="">shape</code>
5280: </li><li><code title="">target</code>
5281: </li><li><code title="">text</code>
5282: </li><li><code title="">type</code>
5283: </li><li><code title="">valign</code>
5284: </li><li><code title="">valuetype</code>
5285: </li><li><code title="">vlink</code>
5286: </li></ul><p>All other attribute values on <a href="infrastructure.html#html-elements">HTML elements</a> must be
5287: treated as <a href="infrastructure.html#case-sensitive">case-sensitive</a>.</p>
5288:
5289:
1.748 mike 5290: <h4 id="pseudo-classes"><span class="secno">4.14.2 </span>Pseudo-classes</h4>
1.718 mike 5291:
1.1 mike 5292: <p>There are a number of dynamic selectors that can be used with
5293: HTML. This section defines when these selectors match HTML
5294: elements.</p>
5295:
5296: <dl><dt><dfn id="selector-link" title="selector-link"><code>:link</code></dfn></dt>
5297: <dt><dfn id="selector-visited" title="selector-visited"><code>:visited</code></dfn></dt>
5298:
5299: <dd>
5300:
1.748 mike 5301: <p>All <code><a href="text-level-semantics.html#the-a-element">a</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute, all
5302: <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute, and all
1.1 mike 5303: <code><a href="semantics.html#the-link-element">link</a></code> elements that have an <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute, must match one of
5304: <code title="selector-link"><a href="#selector-link">:link</a></code> and <code title="selector-visited"><a href="#selector-visited">:visited</a></code>.</p>
5305:
5306: </dd>
5307:
5308:
5309: <dt><dfn id="selector-active" title="selector-active"><code>:active</code></dfn></dt>
5310:
5311: <dd>
5312:
5313: <p>The <code title="selector-active"><a href="#selector-active">:active</a></code> pseudo-class
5314: must match the following elements between the time the user begins
1.95 mike 5315: to activate the element and the time the user stops activating
1.1 mike 5316: the element:</p>
5317:
1.748 mike 5318: <ul><li><code><a href="text-level-semantics.html#the-a-element">a</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute</li>
1.1 mike 5319:
1.748 mike 5320: <li><code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute</li>
1.1 mike 5321:
5322: <li><code><a href="semantics.html#the-link-element">link</a></code> elements that have an <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute</li>
5323:
5324: <li><code><a href="forms.html#the-button-element">button</a></code> elements that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5325:
5326: <li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <a href="forms.html#submit-button-state" title="attr-input-type-submit">Submit Button</a>, <a href="forms.html#image-button-state" title="attr-input-type-image">Image Button</a>, <a href="forms.html#reset-button-state" title="attr-input-type-reset">Reset Button</a>, or <a href="forms.html#button-state" title="attr-input-type-button">Button</a> state</li>
5327:
5328: <li><code><a href="#the-command">command</a></code> elements that do not have a <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> attribute</li>
5329:
5330: <li>any other element, if it is <a href="editing.html#specially-focusable">specially
5331: focusable</a></li>
5332:
5333: </ul><p class="example">For example, if the user is using a keyboard to
5334: push a <code><a href="forms.html#the-button-element">button</a></code> element by pressing the space bar, the
5335: element would match this pseudo-class in between the time that the
5336: element received the <code title="event-keydown">keydown</code>
5337: event and the time the element received the <code title="event-keyup">keyup</code> event.</p>
5338:
5339: </dd>
5340:
5341:
5342: <dt><dfn id="selector-enabled" title="selector-enabled"><code>:enabled</code></dfn></dt>
5343:
5344: <dd>
5345:
5346: <p>The <code title="selector-enabled"><a href="#selector-enabled">:enabled</a></code> pseudo-class
5347: must match the following elements:</p>
5348:
1.748 mike 5349: <ul><li><code><a href="text-level-semantics.html#the-a-element">a</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute</li>
1.1 mike 5350:
1.748 mike 5351: <li><code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that have an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute</li>
1.1 mike 5352:
5353: <li><code><a href="semantics.html#the-link-element">link</a></code> elements that have an <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute</li>
5354:
5355: <li><code><a href="forms.html#the-button-element">button</a></code> elements that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5356:
5357: <li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute are not in the
5358: <a href="forms.html#hidden-state" title="attr-input-type-hidden">Hidden</a> state and that
5359: are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5360:
5361: <li><code><a href="forms.html#the-select-element">select</a></code> elements that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5362:
5363: <li><code><a href="forms.html#the-textarea-element">textarea</a></code> elements that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5364:
5365: <li><code><a href="forms.html#the-option-element">option</a></code> elements that do not have a <code title="attr-option-disabled"><a href="forms.html#attr-option-disabled">disabled</a></code> attribute</li>
5366:
5367: <li><code><a href="#the-command">command</a></code> elements that do not have a <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> attribute</li>
5368:
5369: <li><code><a href="semantics.html#the-li-element">li</a></code> elements that are children of
5370: <code><a href="#menus">menu</a></code> elements, and that have a child element that
5371: defines a <a href="#concept-command" title="concept-command">command</a>, if the
5372: first such element's <a href="#command-facet-disabledstate" title="command-facet-disabledstate">Disabled State</a> facet
5373: is false (not disabled)</li>
5374:
5375: </ul></dd>
5376:
5377:
5378: <dt><dfn id="selector-disabled" title="selector-disabled"><code>:disabled</code></dfn></dt>
5379:
5380: <dd>
5381:
5382: <p>The <code title="selector-disabled"><a href="#selector-disabled">:disabled</a></code>
5383: pseudo-class must match the following elements:</p>
5384:
1.131 mike 5385: <ul><li><code><a href="forms.html#the-button-element">button</a></code> elements that are <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
1.1 mike 5386:
5387: <li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute are not in the
5388: <a href="forms.html#hidden-state" title="attr-input-type-hidden">Hidden</a> state and that
5389: are <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5390:
5391: <li><code><a href="forms.html#the-select-element">select</a></code> elements that are <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5392:
5393: <li><code><a href="forms.html#the-textarea-element">textarea</a></code> elements that are <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5394:
5395: <li><code><a href="forms.html#the-option-element">option</a></code> elements that have a <code title="attr-option-disabled"><a href="forms.html#attr-option-disabled">disabled</a></code> attribute</li>
5396:
5397: <li><code><a href="#the-command">command</a></code> elements that have a <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> attribute</li>
5398:
5399: <li><code><a href="semantics.html#the-li-element">li</a></code> elements that are children of
5400: <code><a href="#menus">menu</a></code> elements, and that have a child element that
5401: defines a <a href="#concept-command" title="concept-command">command</a>, if the
5402: first such element's <a href="#command-facet-disabledstate" title="command-facet-disabledstate">Disabled State</a> facet
5403: is true (disabled)</li>
5404:
5405: </ul></dd>
5406:
5407:
5408: <dt><dfn id="selector-checked" title="selector-checked"><code>:checked</code></dfn></dt>
5409:
5410: <dd>
5411:
5412: <p>The <code title="selector-checked"><a href="#selector-checked">:checked</a></code> pseudo-class
5413: must match the following elements:</p>
5414:
5415: <ul><li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <a href="forms.html#checkbox-state" title="attr-input-type-checkbox">Checkbox</a> state and whose
5416: <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> state is
5417: true</li>
5418:
5419: <li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <a href="forms.html#radio-button-state" title="attr-input-type-radio">Radio Button</a> state and whose
5420: <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> state is
5421: true</li>
5422:
5423: <li><code><a href="#the-command">command</a></code> elements whose <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is in the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state
5424: and that have a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code>
5425: attribute</li>
5426:
5427: <li><code><a href="#the-command">command</a></code> elements whose <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is in the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state and that
5428: have a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code>
5429: attribute</li>
5430:
5431: </ul></dd>
5432:
5433:
5434: <dt><dfn id="selector-indeterminate" title="selector-indeterminate"><code>:indeterminate</code></dfn></dt>
5435:
5436: <dd>
5437:
5438: <p>The <code title="selector-indeterminate"><a href="#selector-indeterminate">:indeterminate</a></code>
5439: pseudo-class must match <code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <a href="forms.html#checkbox-state" title="attr-input-type-checkbox">Checkbox</a> state and whose
1.186 mike 5440: <code title="dom-input-indeterminate"><a href="forms.html#dom-input-indeterminate">indeterminate</a></code> IDL
1.1 mike 5441: attribute is set to true.</p>
5442:
5443: </dd>
5444:
5445:
5446: <dt><dfn id="selector-default" title="selector-default"><code>:default</code></dfn></dt>
5447:
5448: <dd>
5449:
5450: <p>The <code title="selector-default"><a href="#selector-default">:default</a></code> pseudo-class
5451: must match the following elements:</p>
5452:
5453: <ul><li><code><a href="forms.html#the-button-element">button</a></code> elements that are their form's
5454: <a href="forms.html#default-button">default button</a></li>
5455:
5456: <li><code><a href="forms.html#the-input-element">input</a></code> elements whose <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code> attribute is in the <a href="forms.html#submit-button-state" title="attr-input-type-submit">Submit Button</a> or <a href="forms.html#image-button-state" title="attr-input-type-image">Image Button</a> state, and that
5457: are their form's <a href="forms.html#default-button">default button</a></li>
5458: <!--
5459: <li><code>command</code> elements that have a <code
5460: title="attr-command-default">default</code> attribute</li>
5461: -->
5462: </ul></dd>
5463:
5464:
5465: <dt><dfn id="selector-valid" title="selector-valid"><code>:valid</code></dfn></dt>
5466:
5467: <dd>
5468:
5469: <p>The <code title="selector-valid"><a href="#selector-valid">:valid</a></code> pseudo-class
5470: must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for
5471: constraint validation">candidates for constraint validation</a>
5472: and that <a href="forms.html#concept-fv-valid" title="concept-fv-valid">satisfy their
5473: constraints</a>.</p>
5474:
5475: </dd>
5476:
5477:
5478: <dt><dfn id="selector-invalid" title="selector-invalid"><code>:invalid</code></dfn></dt>
5479:
5480: <dd>
5481:
5482: <p>The <code title="selector-invalid"><a href="#selector-invalid">:invalid</a></code> pseudo-class
5483: must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for
5484: constraint validation">candidates for constraint validation</a>
5485: but that do not <a href="forms.html#concept-fv-valid" title="concept-fv-valid">satisfy their
5486: constraints</a>.</p>
5487:
5488: </dd>
5489:
5490:
5491: <dt><dfn id="selector-in-range" title="selector-in-range"><code>:in-range</code></dfn></dt>
5492:
5493: <dd>
5494:
5495: <p>The <code title="selector-in-range"><a href="#selector-in-range">:in-range</a></code>
5496: pseudo-class must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for constraint validation">candidates for
5497: constraint validation</a> and that are neither <a href="forms.html#suffering-from-an-underflow">suffering
5498: from an underflow</a> nor <a href="forms.html#suffering-from-an-overflow">suffering from an
5499: overflow</a>.</p>
5500:
5501: </dd>
5502:
5503:
5504: <dt><dfn id="selector-out-of-range" title="selector-out-of-range"><code>:out-of-range</code></dfn></dt>
5505:
5506: <dd>
5507:
5508: <p>The <code title="selector-out-of-range"><a href="#selector-out-of-range">:out-of-range</a></code>
5509: pseudo-class must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for constraint validation">candidates for
5510: constraint validation</a> and that are <a href="forms.html#suffering-from-an-underflow">suffering from an
5511: underflow</a> or <a href="forms.html#suffering-from-an-overflow">suffering from an overflow</a>.</p>
5512:
5513: </dd>
5514:
5515:
5516: <dt><dfn id="selector-required" title="selector-required"><code>:required</code></dfn></dt>
5517:
5518: <dd>
5519:
5520: <p>The <code title="selector-required"><a href="#selector-required">:required</a></code>
5521: pseudo-class must match the following elements:</p>
5522:
5523: <ul><li><code><a href="forms.html#the-input-element">input</a></code> elements that are <i title="concept-input-required"><a href="forms.html#concept-input-required">required</a></i></li>
5524:
5525: <li><code><a href="forms.html#the-textarea-element">textarea</a></code> elements that have a <code title="attr-textarea-required"><a href="forms.html#attr-textarea-required">required</a></code>
5526: attribute</li>
5527:
5528: </ul></dd>
5529:
5530:
5531: <dt><dfn id="selector-optional" title="selector-optional"><code>:optional</code></dfn></dt>
5532:
5533: <dd>
5534:
5535: <p>The <code title="selector-optional"><a href="#selector-optional">:optional</a></code>
5536: pseudo-class must match the following elements:</p>
5537:
5538: <ul><li><code><a href="forms.html#the-button-element">button</a></code> elements</li>
5539:
5540: <li><code><a href="forms.html#the-input-element">input</a></code> elements that are not <i title="concept-input-required"><a href="forms.html#concept-input-required">required</a></i></li>
5541:
5542: <li><code><a href="forms.html#the-select-element">select</a></code> elements</li>
5543:
5544: <li><code><a href="forms.html#the-textarea-element">textarea</a></code> elements that do not have a <code title="attr-textarea-required"><a href="forms.html#attr-textarea-required">required</a></code>
5545: attribute</li>
5546:
5547: </ul></dd>
5548:
5549:
5550: <dt><dfn id="selector-read-only" title="selector-read-only"><code>:read-only</code></dfn></dt>
5551: <dt><dfn id="selector-read-write" title="selector-read-write"><code>:read-write</code></dfn></dt>
5552:
5553: <dd>
5554:
5555: <p>The <code title="selector-read-write"><a href="#selector-read-write">:read-write</a></code>
5556: pseudo-class must match the following elements:</p>
5557:
5558: <ul><li><code><a href="forms.html#the-input-element">input</a></code> elements to which the <code title="attr-input-readonly"><a href="forms.html#attr-input-readonly">readonly</a></code> attribute applies,
5559: but that are not <i title="concept-input-immutable"><a href="forms.html#concept-input-immutable">immutable</a></i>
5560: (i.e. that do not have the <code title="attr-input-readonly"><a href="forms.html#attr-input-readonly">readonly</a></code> attribute specified
5561: and that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a>)</li>
5562:
5563: <li><code><a href="forms.html#the-textarea-element">textarea</a></code> elements that do not have a <code title="attr-textarea-readonly"><a href="forms.html#attr-textarea-readonly">readonly</a></code> attribute, and
5564: that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5565:
5566: <li>any element that is <a href="editing.html#editable">editable</a></li>
5567:
5568: </ul><p>The <code title="selector-read-only"><a href="#selector-read-only">:read-only</a></code>
5569: pseudo-class must match all other <a href="infrastructure.html#html-elements">HTML elements</a>.</p>
5570:
5571: </dd>
5572:
5573: </dl><p class="note">Another section of this specification defines the
5574: <i><a href="history.html#target-element">target element</a></i> used with the <code title="selector-target">:target</code> pseudo-class.</p>
5575:
5576: <p class="note">This specification does not define when an element
5577: matches the <code title="selector-hover">:hover</code>, <code title="selector-focus">:focus</code>, or <code title="selector-lang()">:lang()</code> dynamic pseudo-classes, as
5578: those are all defined in sufficient detail in a language-agnostic
1.98 mike 5579: fashion in the Selectors specification. <a href="references.html#refsSELECTORS">[SELECTORS]</a></p>
1.1 mike 5580:
1.718 mike 5581: </div><div class="impl">
5582:
1.748 mike 5583: <h3 id="converting-html-to-other-formats"><span class="secno">4.15 </span>Converting HTML to other formats</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.718 mike 5584:
5585:
1.720 mike 5586:
5587:
1.807 mike 5588: <h4 id="atom"><span class="secno">4.15.1 </span>Atom</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/86">ISSUE-86</a> (atom-id-stability) blocks progress to Last Call</span></p>
1.718 mike 5589:
1.804 mike 5590: <p>Given a <code><a href="infrastructure.html#document">Document</a></code> <var title="">source</var>, a user
1.718 mike 5591: agent may run the following algorithm to <dfn id="extracting-atom" title="extracting
5592: Atom">extract an Atom feed</dfn>. This is not the only algorithm
5593: that can be used for this purpose; for instance, a user agent might
5594: instead use the hAtom algorithm. <a href="references.html#refsHATOM">[HATOM]</a></p>
5595:
1.804 mike 5596: <ol><li><p>If the <code><a href="infrastructure.html#document">Document</a></code> <var title="">source</var> does
1.718 mike 5597: not contain any <code><a href="semantics.html#the-article-element">article</a></code> elements, then return nothing
5598: and abort these steps. This algorithm can only be used with
5599: documents that contain distinct articles.</p>
5600:
5601: </li><li><p>Let <var title="">R</var> be an empty <a href="dom.html#xml-documents" title="XML
1.804 mike 5602: documents">XML</a> <code><a href="infrastructure.html#document">Document</a></code> object whose <a href="dom.html#the-document-s-address" title="the document's address">address</a> is user-agent
1.718 mike 5603: defined.</p></li>
5604:
5605: <li><p>Append a <code title="">feed</code> element in the
5606: <a href="#atom-namespace">Atom namespace</a> to <var title="">R</var>.</p></li>
5607:
5608: <li>
5609:
5610: <p>For each <code><a href="semantics.html#meta">meta</a></code> element with a <code title="attr-meta-name"><a href="semantics.html#attr-meta-name">name</a></code> attribute and a <code title="attr-meta-content"><a href="semantics.html#attr-meta-content">content</a></code> attribute and whose <code title="attr-meta-name"><a href="semantics.html#attr-meta-name">name</a></code> attribute's value is <code title="meta-author"><a href="semantics.html#meta-author">author</a></code>, run the following substeps:</p>
5611:
5612: <ol><li><p>Append an <code title="">author</code> element in the
5613: <a href="#atom-namespace">Atom namespace</a> to the root element of <var title="">R</var>.</p></li>
5614:
5615: <li><p>Append a <code title="">name</code> element in the
5616: <a href="#atom-namespace">Atom namespace</a> to the element created in the
5617: previous step.</p>
5618:
5619: </li><li><p>Append a text node whose data is the value of the
5620: <code><a href="semantics.html#meta">meta</a></code> element's <code title="attr-meta-content"><a href="semantics.html#attr-meta-content">content</a></code> attribute to the element
5621: created in the previous step.</p></li>
5622:
5623: </ol><!-- could use vCards instead, and get <atom:email> and <atom:uri>
5624: elements out of this instead of just <atom:name> --></li>
5625:
5626: <li>
5627:
5628: <p>If there is a <code><a href="semantics.html#the-link-element">link</a></code> element whose <code title="attr-link-rel"><a href="semantics.html#attr-link-rel">rel</a></code> attribute's value includes the
1.748 mike 5629: keyword <code title="rel-icon"><a href="#rel-icon">icon</a></code>, and that element also
1.718 mike 5630: has an <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute whose
5631: value successfully <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolves</a>
5632: relative to the <code><a href="semantics.html#the-link-element">link</a></code> element, then append an <code title="">icon</code> element in the <a href="#atom-namespace">Atom namespace</a> to
5633: the root element of <var title="">R</var> whose contents is a text
5634: node with its data set to the <a href="infrastructure.html#absolute-url">absolute URL</a> resulting
5635: from <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the value of the
5636: <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute.</p>
5637:
5638: <!-- could check ratio, could check type... -->
5639:
5640: </li>
5641:
5642: <li>
5643:
5644: <p>Append an <code title="">id</code> element in the <a href="#atom-namespace">Atom
5645: namespace</a> to the root element of <var title="">R</var>
5646: whose contents is a text node with its data set to <a href="dom.html#the-document-s-current-address">the
5647: document's current address</a>.</p>
5648:
5649: </li>
5650:
5651: <li>
5652:
5653: <p>Optionally: Let <var title="">x</var> be a <code title="">link</code> element in the <a href="#atom-namespace">Atom
5654: namespace</a>. Add a <code title="">rel</code> attribute whose
5655: value is the string "<code title="">self</code>" to <var title="">x</var>. Append a text node with its data set to the
5656: (user-agent-defined) <a href="dom.html#the-document-s-address" title="the document's
5657: address">address</a> of <var title="">R</var> to <var title="">x</var>. Append <var title="">x</var> to the root element
5658: of <var title="">R</var>.</p>
5659:
5660: <p class="note">This step would be skipped when the document <var title="">R</var> has no convenient <a href="dom.html#the-document-s-address" title="the document's
5661: address">address</a>. The presence of the <code title="">rel="self"</code> link is a "should"-level requirement in
5662: the Atom specification.</p>
5663:
5664: </li>
5665:
5666: <li>
5667:
5668: <p>Let <var title="">x</var> be a <code title="">link</code>
5669: element in the <a href="#atom-namespace">Atom namespace</a>. Add a <code title="">rel</code> attribute whose value is the string "<code title="">alternate</code>" to <var title="">x</var>. If the
5670: document being converted is an <a href="dom.html#html-documents" title="HTML documents">HTML
5671: document</a>, add a <code title="">type</code> attribute whose
5672: value is the string "<code><a href="iana.html#text-html">text/html</a></code>" to <var title="">x</var>. Otherwise, the document being converted is an
5673: <a href="dom.html#xml-documents" title="XML documents">XML document</a>; add a <code title="">type</code> attribute whose value is the string
5674: "<code><a href="iana.html#application-xhtml-xml">application/xhtml+xml</a></code>" to <var title="">x</var>. Append a text node with its data set to
5675: <a href="dom.html#the-document-s-current-address">the document's current address</a> to <var title="">x</var>. Append <var title="">x</var> to the root element
5676: of <var title="">R</var>.</p>
5677:
5678: </li>
5679:
5680: <li><p>Let <var title="">subheading text</var> be the empty
5681: string.</p></li>
5682:
5683: <li><p>Let <var title="">heading</var> be the first element of
5684: <a href="dom.html#heading-content">heading content</a> whose nearest ancestor of
5685: <a href="dom.html#sectioning-content">sectioning content</a> is <a href="dom.html#the-body-element">the body
5686: element</a>, if any, or null if there is none.</p></li>
5687:
5688: <li>
5689:
5690: <p>Take the appropriate action from the following list, as
5691: determined by the type of the <var title="">heading</var>
5692: element:</p>
5693:
5694: <dl><dt>If <var title="">heading</var> is null</dt>
5695:
5696: <dd>
5697:
5698: <p>Let <var title="">heading text</var> be the
1.804 mike 5699: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <a href="dom.html#the-title-element">the <code>title</code>
1.718 mike 5700: element</a>, if there is one, or the empty string
5701: otherwise.</p>
5702:
5703: </dd>
5704:
5705: <dt>If <var title="">heading</var> is a <code><a href="semantics.html#the-hgroup-element">hgroup</a></code> element</dt>
5706:
5707: <dd>
5708:
5709: <p>If <var title="">heading</var> contains no child
5710: <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> elements, let <var title="">heading text</var> be the empty string.</p>
5711:
5712: <p>Otherwise, let <var title="">headings list</var> be a list of
5713: all the <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> element children
5714: of <var title="">heading</var>, sorted first by descending
5715: <a href="semantics.html#rank">rank</a> and then in <a href="infrastructure.html#tree-order">tree order</a> (so
5716: <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>s first, then <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h2</a></code>s, etc, with each
1.804 mike 5717: group in the order they appear in the document). Then, let <var title="">heading text</var> be the <code><a href="infrastructure.html#textcontent">textContent</a></code> of
1.718 mike 5718: the first entry in <var title="">headings list</var>, and if
5719: there are multiple entries, let <var title="">subheading
1.804 mike 5720: text</var> be the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the second entry
1.718 mike 5721: in <var title="">headings list</var>.</p>
5722:
5723: </dd>
5724:
5725: <dt>If <var title="">heading</var> is an <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> element</dt>
5726:
5727: <dd>
5728:
5729: <p>Let <var title="">heading text</var> be the
1.804 mike 5730: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <var title="">heading</var>.</p>
1.718 mike 5731:
5732: </dd>
5733:
5734: </dl></li>
5735:
5736: <li>
5737:
5738: <p>Append a <code title="">title</code> element in the <a href="#atom-namespace">Atom
5739: namespace</a> to the root element of <var title="">R</var>
5740: whose contents is a text node with its data set to <var title="">heading text</var>.</p>
5741:
5742: </li>
5743:
5744: <li>
5745:
5746: <p>If <var title="">subheading text</var> is not the empty string,
5747: append a <code title="">subtitle</code> element in the <a href="#atom-namespace">Atom
5748: namespace</a> to the root element of <var title="">R</var>
5749: whose contents is a text node with its data set to <var title="">subheading text</var>.</p>
5750:
5751: </li>
5752:
5753: <li><p>Let <var title="">global update date</var> have no
5754: value.</p></li>
5755:
5756: <li>
5757:
5758: <p>For each <code><a href="semantics.html#the-article-element">article</a></code> element <var title="">article</var> that does not have an ancestor
5759: <code><a href="semantics.html#the-article-element">article</a></code> element, run the following steps:</p>
5760:
5761: <ol><li><p>Let <var title="">E</var> be an <code title="">entry</code> element in the <a href="#atom-namespace">Atom namespace</a>,
5762: and append <var title="">E</var> to the root element of <var title="">R</var>.</p></li>
5763:
5764: <li><p>Let <var title="">heading</var> be the first element of
5765: <a href="dom.html#heading-content">heading content</a> whose nearest ancestor of
5766: <a href="dom.html#sectioning-content">sectioning content</a> is <var title="">article</var>,
5767: if any, or null if there is none.</p></li>
5768:
5769: <li>
5770:
5771: <p>Take the appropriate action from the following list, as
5772: determined by the type of the <var title="">heading</var>
5773: element:</p>
5774:
5775: <dl><dt>If <var title="">heading</var> is null</dt>
5776:
5777: <dd>
5778:
5779: <p>Let <var title="">heading text</var> be the empty
5780: string.</p>
5781:
5782: </dd>
5783:
5784: <dt>If <var title="">heading</var> is a <code><a href="semantics.html#the-hgroup-element">hgroup</a></code> element</dt>
5785:
5786: <dd>
5787:
5788: <p>If <var title="">heading</var> contains no child
5789: <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> elements, let <var title="">heading text</var> be the empty string.</p>
5790:
5791: <p>Otherwise, let <var title="">headings list</var> be a list
5792: of all the <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> element
5793: children of <var title="">heading</var>, sorted first by
5794: descending <a href="semantics.html#rank">rank</a> and then in <a href="infrastructure.html#tree-order">tree
5795: order</a> (so <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>s first, then
5796: <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h2</a></code>s, etc, with each group in the order they
5797: appear in the document). Then, let <var title="">heading
1.804 mike 5798: text</var> be the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first entry
1.718 mike 5799: in <var title="">headings list</var>.</p>
5800:
5801: </dd>
5802:
5803: <dt>If <var title="">heading</var> is an <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>–<code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a></code> element</dt>
5804:
5805: <dd>
5806:
5807: <p>Let <var title="">heading text</var> be the
1.804 mike 5808: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <var title="">heading</var>.</p>
1.718 mike 5809:
5810: </dd>
5811:
5812: </dl></li>
5813:
5814: <li>
5815:
5816: <p>Append a <code title="">title</code> element in the
5817: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
5818: contents is a text node with its data set to <var title="">heading text</var>.</p>
5819:
5820: </li>
5821:
5822: <!-- <atom:author> is required either at the feed level (above)
5823: or the entry level (here) but we don't provide it -->
5824:
5825: <li>
5826:
5827: <p>Clone <var title="">article</var> and its descendants into an
1.788 mike 5828: environment that has <a href="webappapis.html#concept-bc-noscript" title="concept-bc-noscript">scripting
1.718 mike 5829: disabled</a>, has no <a href="infrastructure.html#plugin" title="plugin">plugins</a>, and
5830: fails any attempt to <a href="infrastructure.html#fetch" title="fetch">fetch</a> any
5831: resources. Let <var title="">cloned article</var> be the
5832: resulting clone <code><a href="semantics.html#the-article-element">article</a></code> element.</p>
5833:
5834: </li>
5835:
5836: <li>
5837:
5838: <p>Remove from the subtree rooted at <var title="">cloned
5839: article</var> any <code><a href="semantics.html#the-article-element">article</a></code> elements other than the
5840: <var title="">cloned article</var> itself, any
5841: <code><a href="semantics.html#the-header-element">header</a></code>, <code><a href="semantics.html#the-footer-element">footer</a></code>, or <code><a href="semantics.html#the-nav-element">nav</a></code>
5842: elements whose nearest ancestor of <a href="dom.html#sectioning-content">sectioning
5843: content</a> is the <var title="">cloned article</var>, and
5844: the first element of <a href="dom.html#heading-content">heading content</a> whose nearest
5845: ancestor of <a href="dom.html#sectioning-content">sectioning content</a> is the <var title="">cloned article</var>, if any.</p>
5846:
5847: </li>
5848:
5849: <li>
5850:
5851: <p>If <var title="">cloned article</var> contains any
5852: <code><a href="text-level-semantics.html#the-ins-element">ins</a></code> or <code><a href="text-level-semantics.html#the-del-element">del</a></code> elements with <code title="attr-mod-datetime"><a href="text-level-semantics.html#attr-mod-datetime">datetime</a></code> attributes whose
5853: values <a href="infrastructure.html#parse-a-global-date-and-time-string" title="parse a global date and time string">parse
5854: as global date and time strings</a> without errors, then let
5855: <var title="">update date</var> be the value of the <code title="attr-mod-datetime"><a href="text-level-semantics.html#attr-mod-datetime">datetime</a></code> attribute that parses
5856: to the newest <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and
5857: time</a>.</p>
5858:
5859: <p>Otherwise, let <var title="">update date</var> have no
5860: value.</p>
5861:
5862: <p class="note">This value is used below; it is calculated here
5863: because in certain cases the next step mutates the <var title="">cloned article</var>.</p>
5864:
5865: </li>
5866:
5867: <li>
5868:
5869: <p>If the document being converted is an <a href="dom.html#html-documents" title="HTML
5870: documents">HTML document</a>, then: Let <var title="">x</var>
5871: be a <code title="">content</code> element in the <a href="#atom-namespace">Atom
5872: namespace</a>. Add a <code title="">type</code> attribute
5873: whose value is the string "<code title="">html</code>" to <var title="">x</var>. Append a text node with its data set to the
5874: result of running the <a href="syntax.html#html-fragment-serialization-algorithm">HTML fragment serialization
5875: algorithm</a> on <var title="">cloned article</var> to <var title="">x</var>. Append <var title="">x</var> to <var title="">E</var>.</p>
5876:
5877: <p>Otherwise, the document being converted is an <a href="dom.html#xml-documents" title="XML documents">XML document</a>: Let <var title="">x</var> be a <code title="">content</code> element in
5878: the <a href="#atom-namespace">Atom namespace</a>. Add a <code title="">type</code> attribute whose value is the string "<code title="">xml</code>" to <var title="">x</var>. Append a
5879: <code><a href="semantics.html#the-div-element">div</a></code> element to <var title="">x</var>. Move all the
5880: child nodes of the <var title="">cloned article</var> node to
5881: that <code><a href="semantics.html#the-div-element">div</a></code> element, preserving their relative
5882: order. Append <var title="">x</var> to <var title="">E</var>.</p>
5883:
5884: </li>
5885:
5886: <li>
5887:
5888: <p>Establish the value of <var title="">id</var> and <var title="">has-alternate</var> from the first of the following to
5889: apply:</p>
5890:
5891: <dl><dt>If the <var title="">article</var> node has a descendant
1.748 mike 5892: <code><a href="text-level-semantics.html#the-a-element">a</a></code> or <code><a href="the-canvas-element.html#the-area-element">area</a></code> element with an <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute that
1.718 mike 5893: successfully <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolves</a>
5894: relative to that descendant and a <code title="attr-a-rel">rel</code> attribute whose value includes
1.748 mike 5895: the <code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code> keyword</dt>
1.718 mike 5896:
5897: <dd>Let <var title="">id</var> be the <a href="infrastructure.html#absolute-url">absolute URL</a>
5898: resulting from <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the
1.748 mike 5899: value of the <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code>
1.718 mike 5900: attribute of the first such <code><a href="text-level-semantics.html#the-a-element">a</a></code> or <code><a href="the-canvas-element.html#the-area-element">area</a></code>
5901: element, relative to the element. Let <var title="">has-alternate</var> be true.</dd>
5902:
5903: <dt>If the <var title="">article</var> node has an <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute</dt>
5904:
5905: <dd>Let <var title="">id</var> be <a href="dom.html#the-document-s-current-address">the document's current
5906: address</a>, with the fragment identifier (if any) removed,
5907: and with a new fragment identifier specified, consisting of the
5908: value of the <var title="">article</var> element's <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute. Let <var title="">has-alternate</var> be false.</dd>
5909:
5910: <dt>Otherwise</dt>
5911:
5912: <dd>Let <var title="">id</var> be a user-agent-defined
5913: undereferenceable yet globally unique <a href="infrastructure.html#valid-url" title="valid
5914: URL">valid</a> <a href="infrastructure.html#absolute-url">absolute URL</a>. The same
5915: <a href="infrastructure.html#absolute-url">absolute URL</a> should be generated for each run of
5916: this algorithm when given the same input. Let <var title="">has-alternate</var> be false.</dd>
5917:
5918: </dl></li>
5919:
5920: <li>
5921:
5922: <p>Append an <code title="">id</code> element in the <a href="#atom-namespace">Atom
5923: namespace</a> to <var title="">E</var> whose contents is a
5924: text node with its data set to <var title="">id</var>.</p>
5925:
5926: </li>
5927:
5928: <li>
5929:
5930: <p>If <var title="">has-alternate</var> is true: Let <var title="">x</var> be a <code title="">link</code> element in the
5931: <a href="#atom-namespace">Atom namespace</a>. Add a <code title="">rel</code>
5932: attribute whose value is the string "<code title="">alternate</code>" to <var title="">x</var>. Append a
5933: text node with its data set to <var title="">id</var> to <var title="">x</var>. Append <var title="">x</var> to <var title="">E</var>.</p>
5934:
5935: </li>
5936:
5937: <li>
5938:
5939: <p>If <var title="">article</var> has a <code><a href="text-level-semantics.html#the-time-element">time</a></code>
5940: element descendant that has a <code title="attr-time-pubdate"><a href="text-level-semantics.html#attr-time-pubdate">pubdate</a></code> attribute and whose
5941: nearest ancestor <code><a href="semantics.html#the-article-element">article</a></code> element is <var title="">article</var>, and the first such element's <a href="text-level-semantics.html#concept-time-date" title="concept-time-date">date</a> is not unknown, then run
5942: the following substeps, with <var title="">e</var> being the
5943: first such element:</p>
5944:
5945: <ol><li><p>Let <var title="">datetime</var> be a <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and time</a> whose date
5946: component is the <a href="text-level-semantics.html#concept-time-date" title="concept-time-date">date</a> of
5947: <var title="">e</var>.</p></li>
5948:
5949: <li><p>If <var title="">e</var>'s <a href="text-level-semantics.html#concept-time-time" title="concept-time-time">time</a> and <a href="text-level-semantics.html#concept-time-timezone" title="concept-time-timezone">time-zone offset</a> are not
5950: unknown, then let <var title="">datetime</var>'s time and
5951: time-zone offset components be the <a href="text-level-semantics.html#concept-time-time" title="concept-time-time">time</a> and <a href="text-level-semantics.html#concept-time-timezone" title="concept-time-timezone">time-zone offset</a> of <var title="">e</var>. Otherwise, let them be midnight and no offset
5952: respectively ("<code title="">00:00Z</code>").</p></li>
5953:
5954: <li><p>Let <var title="">publication date</var> be the
5955: <a href="infrastructure.html#best-representation-of-the-global-date-and-time-string">best representation of the global date and time
5956: string</a> <var title="">datetime</var>.</p></li>
5957:
5958: </ol><p>Otherwise, let <var title="">publication date</var> have no
5959: value.</p>
5960:
5961: </li>
5962:
5963: <li>
5964:
5965: <p>If <var title="">update date</var> has no value but <var title="">publication date</var> does, then let <var title="">update date</var> have the value of <var title="">publication date</var>.</p>
5966:
5967: <p>Otherwise, if <var title="">publication date</var> has no
5968: value but <var title="">update date</var> does, then let <var title="">publication date</var> have the value of <var title="">update date</var>.</p>
5969:
5970: </li>
5971:
5972: <li>
5973:
5974: <p>If <var title="">update date</var> has a value, and <var title="">global update date</var> has no value or is less recent
5975: than <var title="">update date</var>, then let <var title="">global update date</var> have the value of <var title="">update date</var>.</p>
5976:
5977: </li>
5978:
5979: <li>
5980:
5981: <p>If <var title="">publication date</var> and <var title="">update date</var> both still have no value, then let
5982: them both value a value that is a <a href="infrastructure.html#valid-global-date-and-time-string">valid global date and
5983: time string</a> representing the <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and time</a> of the
5984: moment that this algorithm was invoked.</p>
5985:
5986: </li>
5987:
5988: <li>
5989:
5990: <p>Append an <code title="">published</code> element in the
5991: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
5992: contents is a text node with its data set to <var title="">publication date</var>.</p>
5993:
5994: </li>
5995:
5996: <li>
5997:
5998: <p>Append an <code title="">updated</code> element in the
5999: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
6000: contents is a text node with its data set to <var title="">update date</var>.</p>
6001:
6002: </li>
6003:
6004: </ol></li>
6005:
6006: <li>
6007:
6008: <p>If <var title="">global update date</var> has no value, then
6009: let it have a value that is a <a href="infrastructure.html#valid-global-date-and-time-string">valid global date and time
6010: string</a> representing the <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and time</a> of the date
1.804 mike 6011: and time of the <code><a href="infrastructure.html#document">Document</a></code>'s source file's last
1.718 mike 6012: modification, if it is known, or else of the moment that this
6013: algorithm was invoked.</p>
6014:
6015: </li>
6016:
6017: <li>
6018:
6019: <p>Insert an <code title="">updated</code> element in the
6020: <a href="#atom-namespace">Atom namespace</a> into the root element of <var title="">R</var> before the first <code title="">entry</code> in
6021: the <a href="#atom-namespace">Atom namespace</a> whose contents is a text node with
6022: its data set to <var title="">global update date</var>.</p>
6023:
6024: </li>
6025:
6026: <li><p>Return the Atom document <var title="">R</var>.</p></li>
6027:
6028: </ol><p class="note">The above algorithm does not guarantee that the
6029: output will be a conforming Atom feed. In particular, if
6030: insufficient information is provided in the document (e.g. if the
6031: document does not have any <code title=""><meta name="author"
6032: content="..."></code> elements), then the output will not be
6033: conforming.</p>
6034:
6035: <p>The <dfn id="atom-namespace">Atom namespace</dfn> is: <code>http://www.w3.org/2005/Atom</code></p>
6036:
6037:
6038:
1.117 mike 6039: </div></body></html>
Webmaster
![[BACK]](/https/dev.w3.org/cvsweb/icons/back.gif){kind=icon}
Return to interactive-elements.html CVS log ![[TXT]](/https/dev.w3.org/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/https/dev.w3.org/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / html5 / spec