Annotation of html5/spec/interactive-elements.html, revision 1.870
1.866 mike 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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; }
1.834 mike 47: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
1.1 mike 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:
1.866 mike 240: </style><style type="text/css">
1.834 mike 241: .domintro:before { display: table; margin: -1em -0.5em -0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
242: </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%0Ahtml%20%7B%20border:%20solid%20yellow;%20%7D%20.domintro:before%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 243: function getCookie(name) {
244: var params = location.search.substr(1).split("&");
245: for (var index = 0; index < params.length; index++) {
246: if (params[index] == name)
247: return "1";
248: var data = params[index].split("=");
249: if (data[0] == name)
250: return unescape(data[1]);
251: }
252: var cookies = document.cookie.split("; ");
253: for (var index = 0; index < cookies.length; index++) {
254: var data = cookies[index].split("=");
255: if (data[0] == name)
256: return unescape(data[1]);
257: }
258: return null;
259: }
260: function load(script) {
261: var e = document.createElement('script');
262: e.setAttribute('src', 'http://www.whatwg.org/specs/web-apps/current-work/' + script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
263: document.body.appendChild(e);
264: }
265: function init() {
266: if (location.search == '?slow-browser')
267: return;
268: var configUI = document.createElement('div');
269: configUI.id = 'configUI';
270: document.body.appendChild(configUI);
271: // load('reviewer.js'); // would need cross-site XHR
272: if (document.getElementById('head'))
273: load('toc.js');
274: load('styler.js');
275: // load('updater.js'); // would need cross-site XHR
1.718 mike 276: load('dfn.js'); // doesn't support split-out specs, but, oh well.
1.665 mike 277: // load('status.js'); // would need cross-site XHR
278: if (getCookie('profile') == '1')
279: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
280: fixBrokenLink();
281: }
1.802 mike 282: </script><link href="http://www.w3.org/StyleSheets/TR/W3C-WD" rel="stylesheet" type="text/css">
1.867 mike 283: <script src="link-fixup.js" type="text/javascript"></script>
1.2 mike 284: <link href="forms.html" title="4.10 Forms" rel="prev">
285: <link href="spec.html#contents" title="Table of contents" rel="index">
1.749 mike 286: <link href="browsers.html" title="5 Loading Web pages" rel="next">
1.665 mike 287: </head><body onload="fixBrokenLink(); init()"><div class="head" id="head">
1.1 mike 288: <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 289: <h1>HTML5</h1>
1.1 mike 290: <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.868 mike 291: </div><div>
1.1 mike 292: <a href="forms.html">← 4.10 Forms</a> –
1.2 mike 293: <a href="spec.html#contents">Table of contents</a> –
1.749 mike 294: <a href="browsers.html">5 Loading Web pages →</a>
1.868 mike 295: </div>
1.1 mike 296:
1.765 mike 297: <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 298: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
1.518 mike 299: <dd><a href="semantics.html#sectioning-root">Sectioning root</a>.</dd>
1.153 mike 300: <dd><a href="embedded-content-0.html#interactive-content">Interactive content</a>.</dd>
1.1 mike 301: <dt>Contexts in which this element may be used:</dt>
1.153 mike 302: <dd>Where <a href="dom.html#flow-content">flow content</a> is expected.</dd>
1.1 mike 303: <dt>Content model:</dt>
1.729 mike 304: <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 305: <dt>Content attributes:</dt>
306: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
307: <dd><code title="attr-details-open"><a href="#attr-details-open">open</a></code></dd>
308: <dt>DOM interface:</dt>
309: <dd>
310: <pre class="idl">interface <dfn id="htmldetailselement">HTMLDetailsElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
311: attribute boolean <a href="#dom-details-open" title="dom-details-open">open</a>;
312: };</pre>
313: </dd>
1.307 mike 314: </dl><p>The <code><a href="#the-details-element">details</a></code> element <a href="the-xhtml-syntax.html#represents">represents</a> a
315: disclosure widget from which the user can obtain additional
316: information or controls.</p><p class="note">The <code><a href="#the-details-element">details</a></code> element is not appropriate
1.299 mike 317: for footnotes. Please see <a href="#footnotes">the section on
1.729 mike 318: 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
319: child of the element, if any, <a href="the-xhtml-syntax.html#represents">represents</a> the summary or
320: legend of the details. <span class="impl">If there is no child
321: <code><a href="#the-summary-element">summary</a></code> element, the user agent should provide its own
322: legend (e.g. "Details").</span></p><p>The <dfn id="attr-details-open" title="attr-details-open"><code>open</code></dfn>
1.1 mike 323: content attribute is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a>. If present,
324: it indicates that the details are to be shown to the user. If the
1.117 mike 325: attribute is absent, the details are not to be shown.</p><div class="impl">
1.1 mike 326:
327: <p>If the attribute is removed, then the details should be
328: hidden. If the attribute is added, the details should be shown.</p>
329:
330: <p>The user agent should allow the user to request that the details
331: be shown or hidden. To honor a request for the details to be shown,
332: the user agent must set the <code title="attr-details-open"><a href="#attr-details-open">open</a></code> attribute on the element to
333: the value <code title="">open</code>. To honor a request for the
334: 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
335: element.</p>
336:
337: <p>The <dfn id="dom-details-open" title="dom-details-open"><code>open</code></dfn>
338: 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>
339:
1.271 mike 340: </div><div class="example">
341:
342: <p>The following example shows the <code><a href="#the-details-element">details</a></code> element
343: being used to hide technical details in a progress report.</p>
344:
345: <pre><section class="progress window">
346: <h1>Copying "Really Achieving Your Childhood Dreams"</h1>
347: <details>
1.729 mike 348: <summary>Copying... <progress max="375505392" value="97543282"></progress> 25%</summary>
349: <dl>
350: <dt>Transfer rate:</dt> <dd>452KB/s</dd>
351: <dt>Local filename:</dt> <dd>/home/rpausch/raycd.m4v</dd>
352: <dt>Remote filename:</dt> <dd>/var/www/lectures/raycd.m4v</dd>
353: <dt>Duration:</dt> <dd>01:16:27</dd>
354: <dt>Color profile:</dt> <dd>SD (6-1-6)</dd>
355: <dt>Dimensions:</dt> <dd>320×240</dd>
356: </dl>
1.271 mike 357: </details>
358: </section></pre>
359:
1.718 mike 360: </div><div class="example">
361:
362: <p>The following shows how a <code><a href="#the-details-element">details</a></code> element can be
363: used to hide some controls by default:</p>
364:
365: <pre><details>
1.729 mike 366: <summary>Name & Extension:</summary>
367: <p><input type=text name=fn value="Pillar Magazine.pdf">
368: <p><label><input type=checkbox name=ext checked> Hide extension</label>
1.718 mike 369: </details></pre>
370:
371: <p>One could use this in conjuction with other <code><a href="#the-details-element">details</a></code>
372: in a list to allow the user to collapse a set of fields down to a
373: small set of headings, with the ability to open each one.</p>
374:
375: <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>
376:
1.729 mike 377: <p>In these examples, the summary really just summarises what the
378: controls can change, and not the actual values, which is less than
379: ideal.</p>
380:
381: </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>
382: <dd>None.</dd>
383: <dt>Contexts in which this element may be used:</dt>
384: <dd>As the first child of a <code><a href="#the-details-element">details</a></code> element.</dd>
385: <dt>Content model:</dt>
386: <dd><a href="dom.html#phrasing-content">Phrasing content</a>.</dd>
387: <dt>Content attributes:</dt>
388: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
389: <dt>DOM interface:</dt>
390: <dd>Uses <code><a href="dom.html#htmlelement">HTMLElement</a></code>.</dd>
391: </dl><p>The <code><a href="#the-summary-element">summary</a></code> element <a href="the-xhtml-syntax.html#represents">represents</a> a
392: summary, caption, or legend for the rest of the contents of the
393: <code><a href="#the-summary-element">summary</a></code> element's parent <code><a href="#the-details-element">details</a></code>
394: element<span class="impl">, if any</span>.</p><!-- v2DATAGRID
1.80 mike 395: <h4 id="datagrid">The <dfn><code>datagrid</code></dfn> element</h4>
396:
397: <dl class="element">
398: <dt>Categories</dt>
399: <dd><span>Flow content</span>.</dd>
400: <dd><span>Interactive content</span>.</dd>
401: <dd><span>Sectioning root</span>.</dd>
1.1 mike 402: <dt>Contexts in which this element may be used:</dt>
1.80 mike 403: <dd>Where <span>flow content</span> is expected.</dd>
1.1 mike 404: <dt>Content model:</dt>
1.80 mike 405: <dd><span>Flow content</span>.</dd>
1.1 mike 406: <dt>Content attributes:</dt>
1.80 mike 407: <dd><span>Global attributes</span></dd>
408: <!- -v2DGS:
1.1 mike 409: <dd><code title="attr-datagrid-multiple">multiple</code></dd>
1.80 mike 410: - ->
411: <dd><code title="attr-datagrid-disabled">disabled</code></dd>
1.1 mike 412: <dt>DOM interface:</dt>
413: <dd>
1.80 mike 414: <pre class="idl">interface <dfn>HTMLDataGridElement</dfn> : <span>HTMLElement</span> {
415: <!- -v2DGS:
1.1 mike 416: attribute boolean <span title="dom-datagrid-multiple">multiple</span>;
1.80 mike 417: - -> attribute boolean <span title="dom-datagrid-disabled">disabled</span>;
418: attribute <span>DataGridListener</span> <span title="dom-datagrid-listener">listener</span>;
419: <!- - v2DGS:
1.1 mike 420: readonly attribute <span>DataGridSelection</span> <span title="dom-datagrid-selection">selection</span>;
1.80 mike 421: - ->
1.1 mike 422: // columns
1.395 mike 423: 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 424: attribute DOMString <span title="dom-datagrid-sortColumn">sortColumn</span>;
425: attribute boolean <span title="dom-datagrid-sortAscending">sortAscending</span>;
426: void <span title="dom-datagrid-clearColumns">clearColumns</span>();
1.1 mike 427:
428: // rows
1.80 mike 429: void <span title="dom-datagrid-renotify">renotify</span>();
430: void <span title="dom-datagrid-setRowCount">setRowCount</span>(in long childCount, in long rowCount);
431: void <span title="dom-datagrid-setRows">setRows</span>(in <span>RowList</span> rows);
432: void <span title="dom-datagrid-insertRows">insertRows</span>(in <span>RowList</span> rows);
433: void <span title="dom-datagrid-deleteRows">deleteRows</span>(in <span>RowIDList</span> rows);
434: void <span title="dom-datagrid-repaint">repaint</span>(in <span>RowID</span> row, in DOMString column);
435: void <span title="dom-datagrid-clearRows">clearRows</span>();
436: <!- -
1.1 mike 437: v2: opening and closing a row
438: moving a row's actual ID
439: - 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
440: - though actually that should probably just be done using display sorting
1.80 mike 441: - ->
1.1 mike 442: };
443:
1.80 mike 444: typedef DOMString <dfn>Column</dfn>;
445: typedef sequence<<span>Column</span>> <dfn>ColumnList</dfn>;
1.81 mike 446: typedef sequence<any> <dfn>Cell</dfn>; // <span>Column</span>, any... (exact types expected depend on the column type)
1.80 mike 447: typedef sequence<<span>Cell</span>> <dfn>CellList</dfn>;
1.81 mike 448: typedef sequence<any> <dfn>Row</dfn>; // <span>RowID</span>, long, long, <span>CellList</span>, optional boolean, optional long
1.80 mike 449: typedef sequence<<span>Row</span>> <dfn>RowList</dfn>;
450: typedef sequence<unsigned long> <dfn>RowID</dfn>;
451: typedef sequence<<span>RowID</span>> <dfn>RowIDList</dfn>;
1.1 mike 452:
453: [Callback=FunctionOnly, NoInterfaceObject]
1.80 mike 454: interface <dfn>RenderingContext2DCallback</dfn> {
455: DOMString <span title="dom-Rendering2DContextCallback-handleEvent">handleEvent</span>(in <span>CanvasRenderingContext2D</span> context, in unsigned long width, in unsigned long height);
1.1 mike 456: };</pre>
457: </dd>
1.80 mike 458: </dl>
459:
460: <!- - v2:
461: * datagrid: cells that are links (<a href=""></a>)
462: - ->
463:
464: <p>The <code>datagrid</code> element <span>represents</span> an
465: interactive representation of tree, list, or tabular data.</p>
466:
467: <p>The data being presented is provided by script using the methods
468: described in the following sections.</p>
469:
470: <!- -v2DGS:
1.1 mike 471: <p>The <dfn
472: title="attr-datagrid-multiple"><code>multiple</code></dfn> attribute
473: is a <span>boolean attribute</span>. When set, it indicates that the
474: user can select more than one row at a time.</p>
1.80 mike 475: - ->
476:
477: <p>The <dfn
478: title="attr-datagrid-disabled"><code>disabled</code></dfn> attribute
479: is a <span>boolean attribute</span> used to disable the
1.1 mike 480: control. <span class="impl">When the attribute is set, the user
1.80 mike 481: agent must disable the <code>datagrid</code>, preventing the user
482: from interacting with it. The <code>datagrid</code> element should
1.1 mike 483: still continue to update itself when the underlying data changes,
484: though, as described in the next few sections. However, conformance
1.80 mike 485: requirements stating that <code>datagrid</code> elements must react
1.1 mike 486: to users in particular ways do not apply when the
1.80 mike 487: <code>datagrid</code> is disabled.</span></p>
488:
489: <div class="impl">
1.1 mike 490:
1.80 mike 491: <!- -vsDGS: multiple - ->
1.1 mike 492:
1.80 mike 493: <p>The <dfn
1.186 mike 494: title="dom-datagrid-disabled"><code>disabled</code></dfn> IDL
1.80 mike 495: attribute must <span>reflect</span> the content attribute of the
1.1 mike 496: same name.</p>
497:
1.80 mike 498: </div>
499:
500: <!- - v2DGPA: One possible thing to be added is a way to detect when a
1.1 mike 501: row/selection has been deleted, activated, etc, by the user (delete
1.80 mike 502: key, enter key, etc). (v2DGPA = <datagrid> Perform Action) - ->
503:
504:
505: <h5>Introduction</h5>
506:
507: <p><i>This section is non-normative.</i></p>
508:
509: <p>In the <code>datagrid</code> data model, data is structured as a
1.1 mike 510: set of rows representing a tree, each row being split into a number
511: of columns. The columns are always present in the data model,
1.80 mike 512: although individual columns might be hidden in the presentation.</p>
513:
514: <hr>
515:
516: <p>Each row can have child rows. Child rows may be hidden or
517: shown, by closing or opening (respectively) the parent row.</p>
518:
519: <p>Rows are referred to by the path along the tree that one would
1.1 mike 520: take to reach the row, using zero-based indices. Thus, the first row
521: of a list is row "0", the second row is row "1"; the first child row
522: of the first row is row "0,0", the second child row of the first row
523: is row "0,1"; the fourth child of the seventh child of the third
1.80 mike 524: child of the tenth row is "9,2,6,3", etc.</p>
525:
526: <p>The chains of numbers that give a row's path, or identifier, are
1.1 mike 527: represented by arrays of positions, represented in IDL by the
1.80 mike 528: <span>RowID</span> interface.</p>
529:
530: <p>The root of the tree is represented by an empty array.</p>
531:
532: <hr>
533:
534: <p>Each column has a string that is used to identify it in the API,
1.1 mike 535: a label that is shown to users interacting with the column, a type,
1.80 mike 536: and optionally an icon.</p>
537:
538: <p>The possible types are as follows:</p>
539:
540: <table>
541: <thead>
542: <tr>
543: <td>Keyword
544: <td>Description
545: <tbody>
546: <tr>
547: <td><code title="datagrid-type-text">text</code>
548: <td>Simple text.
549: <tr>
550: <td><code title="datagrid-type-editable">editable</code>
551: <td>Editable text.
552: <tr>
553: <td><code title="datagrid-type-checkable">checkable</code>
554: <td>Text with a check box.
555: <tr>
556: <td><code title="datagrid-type-list">list</code>
557: <td>A list of values that the user can switch between.
558: <tr>
559: <td><code title="datagrid-type-progress">progress</code>
560: <td>A progress bar.
561: <tr>
562: <td><code title="datagrid-type-meter">meter</code>
563: <td>A gauge.
564: <tr>
565: <td><code title="datagrid-type-custom">custom</code>
566: <td>A canvas onto which arbitrary content can be drawn.
567: </table>
568:
569: <p>Each column can be flagged as sortable, in which case the user
570: will be able to sort the view using that column.</p>
571:
572: <p>Columns are not necessarily visible. A column can be created
1.1 mike 573: invisible by default. The user can select which columns are to be
1.80 mike 574: shown.</p>
575:
576: <p>When no columns have been added to the <code>datagrid</code>, a
1.1 mike 577: column with no name, whose identifier is the empty string, whose
1.80 mike 578: type is <code title="datagrid-type-text">text</code>, and which is
1.1 mike 579: not sortable, is implied. This column is removed if any explicit
1.80 mike 580: columns are declared.</p>
581:
582: <p>Each cell uses the type given for its column, so all cells in a
583: column present the same type of information.</p>
584:
585: <!- -v2DGS:
1.1 mike 586: <p>Selection of data in a <code>datagrid</code> operates at the row
587: level. If the <code title="attr-datagrid-multiple">multiple</code>
588: attribute is present, multiple rows can be selected at once,
589: otherwise the user can only select one row at a time.</p>
1.80 mike 590: - ->
591:
592: <!- - v2DGDND: selection should draggable to and from datagrids - ->
593:
594:
595: <h6>Example: a <code>datagrid</code> backed by a static <code>table</code> element</h6>
596:
597: ...
598:
599:
600: <h6>Example: a <code>datagrid</code> backed by nested <code>ol</code> elements</h6>
601:
602: ...
603:
604:
605: <h6>Example: a <code>datagrid</code> backed by a server</h6>
606:
607: ...
608:
609:
610: <h5>Populating the <code>datagrid</code></h5>
611:
612: <dl class="domintro">
613:
614: <dt><var title="">datagrid</var> . <code title="dom-datagrid-listener">listener</code> [ = <var title="">value</var> ]</dt>
1.1 mike 615: <dd>
616:
617: <p>Return the current object that is configured as the
1.80 mike 618: <code>datagrid</code> listener, if any. Returns null if there is
1.1 mike 619: none.</p>
620:
621: <p>The listener is an object provided by the script author that
1.80 mike 622: receives notifications when the <code>datagrid</code> needs row
1.1 mike 623: data to render itself, when the user opens and closes rows with
624: children, when the user edits a cell, and when the user invokes a
1.80 mike 625: row's context menu. (The <code>DataGridListener</code> interface
1.1 mike 626: used for this purpose is described in the next section.)</p>
627:
628: <p>Can be set, to change the current listener.</p>
629:
630: </dd>
631:
632:
1.80 mike 633: <dt><var title="">datagrid</var> . <code title="dom-datagrid-renotify">renotify</code>()</dt>
1.1 mike 634: <dd>
635:
1.80 mike 636: <p>Causes the <code>datagrid</code> to resend notifications to the
1.1 mike 637: listener (if any) for any rows or cells that the
1.80 mike 638: <code>datagrid</code> does not yet have information for.</p>
1.1 mike 639:
1.80 mike 640: <!- - useful, e.g., if there is a server error and the script loses
641: track of what rows it's supposed to be reporting. - ->
1.1 mike 642:
643: </dd>
644:
645:
1.80 mike 646: <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 647: <dd>
648:
1.80 mike 649: <p>Adds a column to the <code>datagrid</code>.</p>
1.1 mike 650:
651: <p>If a column with the given identifier has already been added,
652: it just replaces the information for that column.</p>
653:
654: <p>The possible types are enumerated in the previous section.</p>
655:
656: </dd>
657:
658:
1.80 mike 659: <dt><var title="">datagrid</var> . <code title="dom-datagrid-sortColumn">sortColumn</code> [ = <var title="">value</var> ]</dt>
1.1 mike 660: <dd>
661:
662: <p>Returns the identifier of the column by which the data is to be
663: sorted.</p>
664:
665: <p>Can be set, to indicate that the sort order has changed. This
1.80 mike 666: will cause the <code>datagrid</code> to clear its position
667: information for rows, so <code
668: title="dom-datagrid-setRows">setRows()</code> will have to be
1.1 mike 669: called again with the new sort order.</p>
670:
671: <p>The columns are not actually sorted by the
1.80 mike 672: <code>datagrid</code>; the data has to be sorted by the script
673: that adds the rows to the <code>datagrid</code>.</p>
1.1 mike 674:
675: </dd>
676:
677:
1.80 mike 678: <dt><var title="">datagrid</var> . <code title="dom-datagrid-sortAscending">sortAscending</code> [ = <var title="">value</var> ]</dt>
1.1 mike 679: <dd>
680:
681: <p>Returns true if the data is to be sorted with smaller values
682: first; otherwise, returns false, indicating that bigger values are
683: to be put first.</p>
684:
685: <p>Can be set, to indicate that the order is about to change.</p>
686:
687: </dd>
688:
689:
1.80 mike 690: <dt><var title="">datagrid</var> . <code title="dom-datagrid-clearColumns">clearColumns</code>()</dt>
1.1 mike 691: <dd>
692:
1.80 mike 693: <p>Removes all the columns in the <code>datagrid</code>,
1.1 mike 694: reinstating the implied column.</p>
695:
696: </dd>
697:
698:
1.80 mike 699: <dt><var title="">datagrid</var> . <code title="dom-datagrid-setRowCount">setRowCount</code>(<var title="">childCount</var>, <var title="">rowCount</var>)</dt>
1.1 mike 700: <dd>
701:
1.80 mike 702: <p>Sets the numbers of rows in the <code>datagrid</code>,
1.1 mike 703: excluding rows that are descendants of rows that are closed.</p>
704:
1.80 mike 705: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 706: arguments contradict each other or previously declared information
1.80 mike 707: (e.g. declaring that the <code>datagrid</code> has three rows when
1.1 mike 708: the 12th row has been declared).</p>
709:
710: </dd>
711:
712:
1.80 mike 713: <dt><var title="">datagrid</var> . <code title="dom-datagrid-setRows">setRows</code>(<var title="">rows</var>)</dt>
1.1 mike 714: <dd>
715:
1.80 mike 716: <p>Updates data for rows in the <code>datagrid</code>, or fills in
717: data for rows previously implied by a call to <code
718: title="dom-datagrid-setRowCount">setRowCount()</code> but not
1.1 mike 719: previously declared.</p>
720:
721: <p>The <var title="">rows</var> argument is an array of rows, each
722: represented by a further array consisting of:</p>
723:
1.80 mike 724: <ol class="brief">
725:
726: <li>A <code>RowID</code> object identifying the row.</li>
1.1 mike 727:
728: <li>An integer giving the position of the row in its parent,
1.80 mike 729: given the current sort order, or −1 to set other row data
1.1 mike 730: without setting a position or changing a previously declared
731: position.</li>
732:
733: <li>An integer giving the number of children of the row, or 0 if
1.80 mike 734: the row has no children, or −1 if the row has children but
1.1 mike 735: the count is currently unknown. If the number of children has
736: already been set to 0 or a positive integer, then passing
1.80 mike 737: −1 leaves the previous count unchanged.</li>
1.1 mike 738:
739: <li>An array giving the data for zero or more cells in the row,
740: as described below.</li>
741:
742: <li>A boolean declaring whether the row is open or not. This
743: entry, if omitted, is assumed to be false (closed), unless the
744: row has already been declared as open.</li>
745:
746: <li>An integer giving the number of rows that are descendants of
747: this row, excluding those that are descendants of descendants of
748: this row that are closed. This entry can be omitted if the row is
749: closed or if it has already been declared.</li>
750:
1.80 mike 751: </ol>
752:
753: <p>The array giving the data for the cells in the row consists of
1.1 mike 754: a further set of arrays, one per cell. The first item of each of
755: these arrays is the column's identifier; the subsequent values
756: vary based on the type of the column, as follows:</p>
757:
1.80 mike 758: <dl>
759:
760: <dt><code title="datagrid-type-text">text</code></dt>
1.1 mike 761: <dd>
1.80 mike 762: <ol class="brief">
763: <li>A string giving the cell's value.
764: <li>Optionally, an <code>img</code> element giving an icon for the cell.
765: </ol>
766: </dd>
1.1 mike 767:
1.80 mike 768: <dt><code title="datagrid-type-editable">editable</code></dt>
1.1 mike 769: <dd>
1.80 mike 770: <ol class="brief">
771: <li>A string giving the cell's value.
772: <li>Optionally, a <code>datalist</code> element giving a set of predefined options.
773: <li>Optionally, an <code>img</code> element giving an icon for the cell.
774: </ol>
775: </dd>
1.1 mike 776:
1.80 mike 777: <dt><code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 778: <dd>
1.80 mike 779: <ol class="brief">
780: <li>A string giving the cell's value.
781: <li>A boolean, indicating whether the cell is checked (true) or not (false).
782: <li>Optionally, a boolean indicating whether the value of the cell is obscured as indeterminate (true), or not (false).
783: <li>Optionally, an <code>img</code> element giving an icon for the cell.
784: </ol>
785: </dd>
1.1 mike 786:
1.80 mike 787: <dt><code title="datagrid-type-list">list</code></dt>
1.1 mike 788: <dd>
1.80 mike 789: <ol class="brief">
790: <li>A string giving the cell's current value.
791: <li>A <code>select</code> element giving the <span title="concept-select-option-list">list of options</span>.
792: <li>Optionally, an <code>img</code> element giving an icon for the cell.
793: </ol>
794: </dd>
1.1 mike 795:
1.80 mike 796: <dt><code title="datagrid-type-progress">progress</code></dt>
1.1 mike 797: <dd>
1.80 mike 798: <ol class="brief">
799: <li>A value in the range 0.0 (no progress) to 1.0 (task complete).
800: </ol>
801: </dd>
1.1 mike 802:
1.80 mike 803: <dt><code title="datagrid-type-meter">meter</code></dt>
1.1 mike 804: <dd>
1.80 mike 805: <ol class="brief">
806: <li>A number giving the cell's value.
807: <li>Optionally, a number giving the maximum value, if it's not 1.
808: <li>Optionally, a number giving the minimum value, if it's not 0.
809: <li>Optionally, a number giving the highest value that is considered "low".
810: <li>Optionally, a number giving the lowest value that is considered "high".
811: <li>Optionally, a number giving the value that is considered optimal.
812: </ol>
813: </dd>
1.1 mike 814:
1.80 mike 815: <dt><code title="datagrid-type-custom">custom</code></dt>
1.1 mike 816: <dd>
1.80 mike 817: <ol class="brief">
818: <li>A number giving the minimum width of the cell, in CSS pixels, that is desired.
819: <li>A number giving the minimum height of the cell, in CSS pixels, that is desired.
820: <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.
821: </ol>
822: </dd>
823:
824: </dl>
1.1 mike 825:
1.80 mike 826: <p>While the rows in a single call to the <code
827: title="dom-datagrid-setRows">setRows()</code> method can be in any
1.1 mike 828: order, for each row, it is important that all its ancestor rows
829: and all its open previous siblings are also declared, either in
830: the same call or in an earlier one.</p>
831:
1.80 mike 832: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 833: arguments contradict each other or previously declared information
834: (e.g. saying that a row's position is 5 when the parent row only
835: has 3 children, or naming a column that doesn't exist, or
836: declaring a row without declaring its parent, or changing the
837: number of children that a row has while that row and its ancestors
838: are all open).</p>
839:
840: </dd>
841:
842:
1.80 mike 843: <dt><var title="">datagrid</var> . <code title="dom-datagrid-insertRows">insertRows</code>(<var title="">rows</var>)</dt>
1.1 mike 844: <dd>
845:
1.80 mike 846: <p>Inserts the given rows into the <code>datagrid</code>,
847: increasing the numbers of rows that the <code>datagrid</code>
1.1 mike 848: assumes are present.</p>
849:
850: <p>The <var title="">rows</var> argument is an array of rows in
1.80 mike 851: the same structure as the argument to the <code
852: title="dom-datagrid-setRows">setRows()</code> method described
1.1 mike 853: above, with the same expectations of consistency (a given row's
854: ancestors and earlier open siblings being listed either earlier or
1.80 mike 855: in the same call as a given row). However, unlike with the <code
856: title="dom-datagrid-setRows">setRows()</code> method, if a row is
1.1 mike 857: inserted along with its child, the child is not included in the
1.80 mike 858: child and row counts of the parent row; every row in the <var
859: title="">rows</var> argument will increase its parent's counts
1.1 mike 860: automatically.</p>
861:
1.80 mike 862: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the
1.1 mike 863: arguments contradict each other or previously declared
864: information.</p>
865:
866: </dd>
867:
868:
1.80 mike 869: <dt><var title="">datagrid</var> . <code title="dom-datagrid-deleteRows">deleteRows</code>(<var title="">rows</var>)</dt>
1.1 mike 870: <dd>
871:
1.80 mike 872: <p>Removes the given rows from the <code>datagrid</code>, and
1.1 mike 873: updates the number of rows known to be in the
1.80 mike 874: <code>datagrid</code> accordingly. The argument is an array of
875: <code>RowID</code> objects identifying the rows to remove.</p>
1.1 mike 876:
1.80 mike 877: <p>Throws a <code>DATAGRID_MODEL_ERR</code> exception if the argument
878: includes a row the <code>datagrid</code> doesn't know about.</p>
879: <!- - since otherwise behaviour might depend on where the user
880: scrolled! - ->
1.1 mike 881:
882: </dd>
883:
884:
1.80 mike 885: <dt><var title="">datagrid</var> . <code title="dom-datagrid-repaint">repaint</code>(<var title="">row</var>, <var title="">column</var>)</dt>
1.1 mike 886: <dd>
887:
1.80 mike 888: <p>If the given column's type is <code
889: title="datagrid-type-custom">custom</code>, then causes the
890: <code>datagrid</code> to reinvoke the function that obtains the
1.1 mike 891: desired rendering.</p>
892:
893: </dd>
894:
895:
1.80 mike 896: <dt><var title="">datagrid</var> . <code title="dom-datagrid-clearRows">clearRows</code>()</dt>
1.1 mike 897: <dd>
898:
1.80 mike 899: <p>Clears the <code>datagrid</code> of all row data, resetting it
900: to empty<!- - v2DGS:, and clears the selection- ->.</p>
1.1 mike 901:
902: </dd>
903:
1.80 mike 904: </dl>
905:
906:
907: <div class="impl">
1.1 mike 908:
1.80 mike 909: <h6>The listener</h6>
1.1 mike 910:
1.80 mike 911: <p>The <dfn
1.186 mike 912: title="dom-datagrid-listener"><code>listener</code></dfn> IDL
1.1 mike 913: attribute allows authors to specify an object that will receive all
1.80 mike 914: the notifications from the <code>datagrid</code>. Initially, its
1.1 mike 915: value must be null. On getting, it must return its value. On
916: setting, its value must be set to the new value, and then the user
1.80 mike 917: agent must <span>queue a task</span> to call the <code
918: title="dom-listener-initialize">initialize()</code> method with the
919: <code>datagrid</code> element as its only argument.</p>
1.1 mike 920:
921:
1.80 mike 922: <h6>The columns</h6>
1.1 mike 923:
1.80 mike 924: <p>The columns are represented by the <dfn>column list</dfn>, an
1.1 mike 925: ordered list of entries for columns, each of which consists of:</p>
926:
1.80 mike 927: <dl>
928:
929: <dt>An identifier</dt>
1.1 mike 930:
931: <dd>A string used to identify the column in the API.</dd>
932:
933: <dt>A label</dt>
934:
935: <dd>A string used in the user interface.</dd>
936:
937: <dt>A type</dt>
938:
939: <dd>One of the types described below.</dd>
940:
941: <dt>An icon</dt>
942:
1.80 mike 943: <dd>An image, copied from an <code>img</code> element when the
1.1 mike 944: column was declared.</dd>
945:
946: <dt>Whether the column is sortable</dt>
947:
948: <dd>A boolean indicating whether the user can request that the data
949: be sorted by this column (true), or not (false).</dd>
950:
951: <dt>Whether the column is visible</dt>
952:
953: <dd>A boolean indicating whether the column is part of the
1.80 mike 954: <code>datagrid</code>'s rendering.</dd>
1.1 mike 955:
1.80 mike 956: </dl>
957:
958: <p>Initially, the <span>column list</span> must have a single
959: column, the <dfn>default column</dfn>, whose identifier is the empty
960: string, whose label is the empty string, whose type is <code
961: title="datagrid-type-text">text</code>, with no icon, which is not
1.1 mike 962: sortable, and which <em>is</em> visible.</p>
963:
1.80 mike 964: <hr>
965:
966: <p>The <dfn title="dom-datagrid-addColumn"><code>addColumn(<var
967: title="">id</var>, <var title="">label</var>, <var
968: title="">type</var>, <var title="">icon</var>, <var
969: title="">sortable</var>, <var title="">hidden</var>)</code></dfn>
1.1 mike 970: method must run the following steps:</p>
971:
1.80 mike 972: <ol>
973:
974: <li><p>If there is already an entry in <span>column list</span>,
975: other than the <span>default column</span>, whose identifier is
976: <var title="">id</var>, throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 977: exception and abort these steps.</p></li>
978:
979: <li>
980:
981: <p>If <var title="">type</var> is not a string equal to one of the
1.80 mike 982: <span>allowed <code>datagrid</code> column types</span>, then
983: throw a <code>DATAGRID_MODEL_ERR</code> exception and abort these
1.1 mike 984: steps.</p>
985:
986: </li>
987:
988: <li><p>If the <var title="">icon</var> argument is present and not
1.80 mike 989: null, but the given <code>img</code> element's <code
990: title="dom-img-complete">complete</code> attribute is false, then
1.1 mike 991: let <var title="">icon</var> be null.</p></li>
992:
993: <li><p>If the <var title="">icon</var> argument is present and not
1.80 mike 994: null, then copy the image data from that <code>img</code> element,
1.1 mike 995: and let <var title="">image</var> be the copy of that image
996: data. Otherwise, let <var title="">image</var> be nothing.</p></li>
997:
1.80 mike 998: <li><p>Append a new entry to the <span>column list</span>, with
1.1 mike 999: <var title="">id</var> as its identifier, <var title="">label</var>
1.80 mike 1000: as its label, <var title="">type</var> as its type, and <var
1001: title="">image</var> as its icon. Let the column be sortable if the
1.1 mike 1002: <var title="">sortable</var> argument is present and true, and make
1003: it visible unless the <var title="">hidden</var> argument is
1004: present and true.</p></li>
1005:
1.80 mike 1006: <li><p>If the <span>column list</span> contains the <span>default
1007: column</span>, then remove the <span>default column</span> from the
1008: <span>column list</span>, discard any data for cells in that column
1009: in any rows in the <code>datagrid</code>, set <code
1010: title="dom-datagrid-sortColumn">sortColumn</code> to <var
1011: title="">id</var>, set <code
1012: title="dom-datagrid-sortAscending">sortAscending</code> to true,
1013: and run the <span><code>datagrid</code> resort
1014: steps</span>.</p></li>
1015:
1016: </ol>
1017:
1018: <hr>
1.1 mike 1019:
1.80 mike 1020: <p>The <dfn
1.186 mike 1021: title="dom-datagrid-sortColumn"><code>sortColumn</code></dfn> IDL
1.1 mike 1022: attribute gives the current column used for sorting. Initially, its
1023: value must be the empty string. On getting, it must return its
1024: current value. On setting, if the new value doesn't match the
1.80 mike 1025: identifier of one of the columns in the <span>column list</span>,
1026: then the user agent must throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 1027: exception. Otherwise, if the new value is not the same as its
1028: current value, then the user agent must set the attribute to the new
1.80 mike 1029: value, and then run the <span><code>datagrid</code> resort
1030: steps</span>.</p>
1.1 mike 1031:
1.80 mike 1032: <p>The <dfn
1033: title="dom-datagrid-sortAscending"><code>sortAscending</code></dfn>
1.186 mike 1034: IDL attribute specifies the direction that the tree is sorted in,
1.1 mike 1035: ascending (true) or descending (false). Initially, its value must be
1036: true (ascending). On getting, it must return its current value. On
1037: setting, if the new value is not the same as its current value, then
1038: the user agent must set the attribute to the new value, and then run
1.80 mike 1039: the <span><code>datagrid</code> resort steps</span>.</p>
1.1 mike 1040:
1041: <p>When a column is marked as being sortable, the user agent should
1042: allow the user to select that column to be the column used for
1043: sorting, and should allow the user to chose whether the sort order
1044: is ascending or descending.</p>
1045:
1046: <p>When the user changes the sort order in this manner, the user
1.80 mike 1047: agent must update the <code
1048: title="dom-datagrid-sortColumn">sortColumn</code> and <code
1049: title="dom-datagrid-sortAscending">sortAscending</code> attributes
1050: appropriately, and then run the <span><code>datagrid</code> resort
1051: steps</span>.</p>
1.1 mike 1052:
1.80 mike 1053: <p class="note">The <span><code>datagrid</code> resort steps</span>
1.1 mike 1054: are described in the next section.</p>
1055:
1.80 mike 1056: <hr>
1.1 mike 1057:
1.80 mike 1058: <p>The <dfn
1059: title="dom-datagrid-clearColumns"><code>clearColumns()</code></dfn>
1060: method, if the <span>column list</span> doesn't contain the
1061: <span>default column</span>, must empty the <span>column
1062: list</span>, append the <span>default column</span> to the now empty
1063: <span>column list</span>, discard any data for cells in all rows in
1064: the <code>datagrid</code>, set <code
1065: title="dom-datagrid-sortColumn">sortColumn</code> to the empty
1066: string, set <code
1067: title="dom-datagrid-sortAscending">sortAscending</code> to true, and
1068: run the <span><code>datagrid</code> resort steps</span>. (If the
1069: <span>column list</span> is already just the <span>default
1070: column</span>, then the method does nothing.)</p>
1.1 mike 1071:
1072:
1.80 mike 1073: <h6>The rows</h6>
1074:
1075: <p>A <code>datagrid</code> element is intended to show a
1.1 mike 1076: representation of a tree, where typically the user only sees a
1077: small part of the tree at a time.</p>
1078:
1.80 mike 1079: <p>To make this efficient, the <code>datagrid</code> element
1.1 mike 1080: <em>actually</em> shows a small part of a <em>sparse</em> tree, so
1081: that only relevant parts of the data structure need be loaded at any
1082: time. Specifically, the model requires only that all the ancestor
1083: rows of the displayed rows be loaded, as well as any open earlier
1084: siblings (in the displayed sort order) of the displayed rows.</p>
1085:
1.80 mike 1086: <p>Conceptually, therefore, a <code>datagrid</code> has a number of
1.1 mike 1087: related sparse data structures backing it.</p>
1088:
1.80 mike 1089: <p>The first is the <dfn>natural order sparse data tree</dfn>. This
1.1 mike 1090: is the structure in which rows are entered as they are declared, in
1091: their natural order. This can differ from the order actually
1092: displayed to the user. It consists of nested sparse lists of
1.80 mike 1093: rows. In the <span>natural order sparse data tree</span>, a row will
1.1 mike 1094: always have all its parents already declared. Once a row is added to
1.80 mike 1095: this structure, it can only be removed by the <code
1096: title="dom-datagrid-deleteRows">deleteRows()</code> and <code
1097: title="dom-datagrid-clearRows">clearRows()</code> methods. The order of
1.1 mike 1098: nodes in this tree never changes; to move a node in this tree, it
1099: has to be removed and then another row (with the same data)
1100: reinserted elsewhere.</p>
1101:
1.80 mike 1102: <p>The second structure is the <dfn>display order sparse data
1.1 mike 1103: tree</dfn>. This is a similar structure that contains a subset of
1.80 mike 1104: the rows in the <span>natural order sparse data tree</span>, ordered
1105: in the order given by the <code
1106: title="dom-datagrid-sortAscending">sortAscending</code> and <code
1107: title="dom-datagrid-sortColumn">sortColumn</code> attributes, and
1.1 mike 1108: excluding rows with one or more ancestors that are closed. This tree
1.80 mike 1109: is cleared whenever the <code
1110: title="dom-datagrid-sortAscending">sortAscending</code> and <code
1111: title="dom-datagrid-sortColumn">sortColumn</code> attributes
1.1 mike 1112: change.</p>
1113:
1.80 mike 1114: <p>The third structure is the <dfn>display order sparse data
1.1 mike 1115: list</dfn>. This structure is a flattened representation of the
1.80 mike 1116: <span>display order sparse data tree</span>.</p>
1.1 mike 1117:
1.80 mike 1118: <p>At any time, a number of consecutive rows in the <span>display
1119: order sparse data list</span> are physically visible to the
1120: user. The <code>datagrid</code> fires notifications to a <span
1121: title="dom-datagrid-listener">listener</span> (provided by script),
1.1 mike 1122: and the listener, or other some script, is expected to feed the
1.80 mike 1123: <code>datagrid</code> with the information needed to render the
1.1 mike 1124: control.</p>
1125:
1.80 mike 1126: <p>A <code>datagrid</code> has a <dfn>pending <code>datagrid</code>
1127: rows list</dfn>, which is a list of rows in the <span>display order
1128: sparse data list</span> for which the <code>datagrid</code> has sent
1.1 mike 1129: notifications requesting information but not yet received
1130: information about.</p>
1131:
1.80 mike 1132: <p>A <code>datagrid</code> also has a <dfn>pending
1.1 mike 1133: <code>datagrid</code> <em>cells</em> list</dfn>, which is a list of
1.80 mike 1134: row/column pairs (cells) for which the <code>datagrid</code> has
1.1 mike 1135: sent notifications requesting information but not yet received
1136: information about.</p>
1137:
1138: <p>User agents may discard information about rows that are not
1139: displayed and that are not ancestors or open earlier siblings of
1140: rows or ancestors of rows that are displayed.</p>
1141:
1.80 mike 1142: <hr>
1143:
1144: <p>These structures are different views of the collection of rows
1145: that form the <code>datagrid</code>. Each row has the following
1.1 mike 1146: information associated with it:</p>
1147:
1.80 mike 1148: <dl>
1149:
1150: <dt>A parent</dt>
1.1 mike 1151:
1.80 mike 1152: <dd><p>Either another row, or the <code>datagrid</code> itself. This
1153: is the parent of the row in the <span>natural order sparse data
1154: tree</span> and the <span>display order sparse data tree</span>
1155: for the <code>datagrid</code>.</p></dd>
1.1 mike 1156:
1157: <dt>A natural order position relative to the other rows with the
1158: same parent</dt>
1159:
1160: <dd>
1161:
1162: <p>This is the number of rows that precede this row under the same
1.80 mike 1163: parent in the <span>natural order sparse data tree</span>. This
1.1 mike 1164: number can't be changed relative to other rows in the same parent;
1165: to change the relative natural order of data in the
1.80 mike 1166: <code>datagrid</code>, the original rows have to be removed and
1.1 mike 1167: new rows (with the same data but different natural positions)
1168: inserted in their place. (The exact number of a row can change, as
1169: new rows can be inserted above it.)</p>
1170:
1.80 mike 1171: <p>A row can be identified by a <code>RowID</code> object. This is
1.1 mike 1172: an array of numbers, consisting of the natural order positions of
1173: each ancestor row and the row itself, starting from the furthest
1174: ancestor. Thus, for instance, the fourth child row of the first
1.80 mike 1175: child row of the second row in a <code>datagrid</code> would be
1176: identified by a <code>RowID</code> object whose value is <code
1177: title="">[1, 0, 3]</code>. A row's identifier changes if rows are
1178: <span title="dom-datagrid-insertRows">inserted before it</span> in
1179: the <code>datagrid</code>.</p>
1.1 mike 1180:
1181: </dd>
1182:
1183: <dt>A display order position relative to the other rows with
1184: the same parent</dt>
1185:
1186: <dd><p>This is the number of rows that precede this row under the
1.80 mike 1187: same parent in the <span>display order sparse data
1188: tree</span>. This number can be unknown. If the sort order
1189: changes, then this information is lost (as the <span>display order
1190: sparse data tree</span> is cleared).</p></dd>
1.1 mike 1191:
1192: <dt>A child count</dt>
1193:
1194: <dd><p>The number of rows that have this row as a parent. If this is
1.80 mike 1195: zero, the row cannot be opened. If this is −1, then the
1.1 mike 1196: child count is unknown but the row can be opened. This value can be
1.80 mike 1197: changed by the <code title="dom-datagrid-setRows">setRows()</code>
1198: method only if the current value is −1 or if the row or one
1.1 mike 1199: of its ancestors is closed. Otherwise, it can only be changed
1.80 mike 1200: indirectly using the <code
1201: title="dom-datagrid-insertRows">insertRows()</code> and <code
1202: title="dom-datagrid-deleteRows">deleteRows()</code> methods.</p></dd>
1.1 mike 1203:
1204: <dt>An open flag</dt>
1205:
1206: <dd><p>A boolean indicating whether the row is open (true) or
1207: closed (false). Once set, the flag can only be changed by the user
1208: or while one of the row's ancestors is itself closed. A row can
1209: also be in a third state, "opening", which is treated as closed for
1210: all purposes except that the user agent may indicate that the row
1211: is in this special state, and except that when the row is updated
1212: to have a row count, the row will switch to being open.</p></dd>
1213:
1214: <dt>A row count</dt>
1215:
1216: <dd><p>The number of rows that have this row as a parent or
1217: ancestor, and that do not have an ancestor that is a descendant of
1.80 mike 1218: this row that is itself closed. If this is −1, then the row
1219: count is unknown. This value can be changed by the <code
1220: title="dom-datagrid-setRows">setRows()</code> method only if the
1.1 mike 1221: row or one of its ancestors is closed (or opening, but not
1.80 mike 1222: open). Otherwise, it can only be changed indirectly using the <code
1223: title="dom-datagrid-insertRows">insertRows()</code> and <code
1224: title="dom-datagrid-deleteRows">deleteRows()</code>
1.1 mike 1225: methods.</p></dd>
1226:
1227: <dt>Cells</dt>
1228:
1229: <dd><p>The data that applies to this row. Cell data is discussed in
1230: more detail below.</p></dd>
1231:
1.80 mike 1232: </dl>
1233:
1234: <p>The <code>datagrid</code> itself also has a <dfn title="datagrid
1235: child count">child count</dfn> and a <dfn title="datagrid row
1.1 mike 1236: count">row count</dfn>, which are analogous to the child counts and
1237: row counts for rows. Initially, these must be zero.</p>
1238:
1.80 mike 1239: <hr>
1240:
1241: <p>The <dfn><code>datagrid</code> resort steps</dfn>, which are
1.1 mike 1242: invoked when the sort order changes as described in the previous
1243: section, are as follows:</p>
1244:
1.80 mike 1245: <ol>
1.1 mike 1246:
1.80 mike 1247: <li>
1248:
1249: <p>Clear the <span>display order sparse data tree</span>
1.1 mike 1250: (i.e. mark the display order position of all the rows in the
1.80 mike 1251: <code>datagrid</code> as unknown).</p>
1.1 mike 1252:
1253: <p>User agents may cache the position information of rows for
1.80 mike 1254: various values of <code
1255: title="dom-datagrid-sortColumn">sortColumn</code> and <code
1256: title="dom-datagrid-sortAscending">sortAscending</code>, instead
1.1 mike 1257: of discarding the information altogether. If the user agent caches
1258: this information, and has information that applies to the current
1.80 mike 1259: values of <code title="dom-datagrid-sortColumn">sortColumn</code>
1260: and <code title="dom-datagrid-sortAscending">sortAscending</code>,
1261: then the user agent may repopulate the <span>display order sparse
1262: data tree</span> from this information.</p>
1.1 mike 1263:
1264: </li>
1265:
1266: <li>
1267:
1.80 mike 1268: <p>Clear the <span>pending <code>datagrid</code> rows list</span>
1269: and the <span>pending <code>datagrid</code> cells list</span>.</p>
1.1 mike 1270:
1271: </li>
1272:
1273: <li>
1274:
1.80 mike 1275: <p>Invoke the <span><code>datagrid</code> update display
1276: algorithm</span>.</p>
1.1 mike 1277:
1278: </li>
1279:
1.80 mike 1280: <!- - v2: queue a task to fire an event, or tell the listener the
1281: sort order changed, or something - ->
1282:
1283: </ol>
1.1 mike 1284:
1.80 mike 1285: <hr>
1.1 mike 1286:
1.80 mike 1287: <p>The <dfn
1288: title="dom-datagrid-renotify"><code>renotify()</code></dfn> method
1289: must empty the <span>pending <code>datagrid</code> rows list</span>
1290: and the <span>pending <code>datagrid</code> cells list</span>, and
1291: invoke the <span><code>datagrid</code> update display
1292: algorithm</span>.</p>
1293:
1294: <hr>
1295:
1296: <p>The <dfn title="dom-datagrid-setRowCount"><code>setRowCount(<var
1297: title="">childCount</var>, <var
1298: title="">rowCount</var>)</code></dfn> method must run the following
1.1 mike 1299: steps:</p>
1300:
1.80 mike 1301: <ol>
1.1 mike 1302:
1.80 mike 1303: <li>
1304:
1305: <p>Set the <span><code>datagrid</code> child count</span> to <var
1306: title="">childCount</var>, the <span><code>datagrid</code> row
1307: count</span> to <var title="">rowCount</var>.</p>
1.1 mike 1308:
1309: </li>
1310:
1311: <li>
1312:
1.80 mike 1313: <p><span>Audit the <code>datagrid</code></span>. If this fails,
1.1 mike 1314: then revert the changes made in the previous step, throw a
1.80 mike 1315: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1316: steps.</p>
1317:
1318: </li>
1319:
1320: <li>
1321:
1.80 mike 1322: <p>Invoke the <span><code>datagrid</code> update display
1323: algorithm</span>.</p>
1.1 mike 1324:
1325: </li>
1326:
1.80 mike 1327: </ol>
1328:
1329: <hr>
1330:
1331: <p>The <dfn title="dom-datagrid-setRows"><code>setRows(<var
1332: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1333: steps:</p>
1334:
1.80 mike 1335: <ol>
1.1 mike 1336:
1.80 mike 1337: <li>
1338:
1339: <p><span title="type-check a RowList object">Type-check the <var
1340: title="">rows</var> argument</span>. If this fails, throw a
1.1 mike 1341: <code>TypeError</code> exception, and abort these steps.</p>
1342:
1343: </li>
1344:
1345: <li>
1346:
1.80 mike 1347: <p><span title="partially sort a RowList object">Partially sort
1348: the <var title="">rows</var> argument</span>.</p>
1.1 mike 1349:
1350: </li>
1351:
1352: <li>
1353:
1.80 mike 1354: <p>For each <code>Row</code> object in the <var
1355: title="">rows</var> argument, in order, perform the appropriate
1.1 mike 1356: steps from the list below.</p>
1357:
1.80 mike 1358: <p class="note">The changes made to the <code>datagrid</code>'s
1.1 mike 1359: data structures in this step get reverted (as required below) if
1360: any consistency errors are detected either in this step or the
1361: next.</p>
1362:
1.80 mike 1363: <dl>
1364:
1365: <dt>If there already exists a row in the <code>datagrid</code>'s
1366: <span>natural order sparse data tree</span> with the same
1367: identifier as given by the <code>Row</code> object's
1368: <code>RowID</code> object, and that row and all its ancestors are
1.1 mike 1369: open</dt>
1370:
1371: <dd>
1372:
1373: <p>If one of the following conditions is true, then revert all
1374: the changes done in this step, throw a
1.80 mike 1375: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1376: steps:</p>
1377:
1.80 mike 1378: <ul>
1379:
1380: <li>The value of the <code>Row</code> object's second entry is
1381: neither −1 nor equal to the child count of the
1.1 mike 1382: preexisting row.</li>
1383:
1.80 mike 1384: <li>The <code>Row</code> object has fewer than four
1.1 mike 1385: entries or more than six entries.</li>
1386:
1.80 mike 1387: <li>The <code>Row</code> object has five or more entries, and
1.1 mike 1388: its fifth entry is false.</li>
1389:
1.80 mike 1390: <li>The <code>Row</code> object has six entries, and its sixth
1.1 mike 1391: entry is not equal to the row count of the preexisting
1392: row.</li>
1393:
1.80 mike 1394: </ul>
1395:
1396: </dd>
1.1 mike 1397:
1.80 mike 1398: <dt>If there already exists a row in the <code>datagrid</code>'s
1399: <span>natural order sparse data tree</span> with the same
1400: identifier as given by the <code>Row</code> object's
1401: <code>RowID</code> object, but either that row or one of its
1.1 mike 1402: ancestors is closed</dt>
1403:
1404: <dd>
1405:
1406: <p>Set the preexisting row's child count to the value of the
1.80 mike 1407: <code>Row</code> object's second entry.</p>
1.1 mike 1408:
1.80 mike 1409: <p>If the <code>Row</code> object has five or more entries, and
1.1 mike 1410: either its fifth entry is true and the preexisting row is closed
1411: but not opening, or its fifth entry is false and the preexisting
1412: row is open, then: if the preexisting row has no ancestor row
1413: that is closed, then revert all the changes done in this step,
1.80 mike 1414: throw a <code>DATAGRID_MODEL_ERR</code> exception, and abort
1.1 mike 1415: these steps; otherwise, if the fifth entry is false, then close
1416: the row; otherwise, open the row.</p>
1417:
1.80 mike 1418: <p>If the <code>Row</code> object has six entries, set the
1419: preexisting row's row count to the value of the <code>Row</code>
1.1 mike 1420: object's sixth entry.</p>
1421:
1422: <p>If the preexisting row is opening, then: increase the
1.80 mike 1423: <span><code>datagrid</code> row count</span> and the row counts
1.1 mike 1424: of any ancestor rows by the number of rows that the preexisting
1.80 mike 1425: row now has in its row count, then open the row.</p> <!- - we
1.1 mike 1426: should also "update the <span>pending <code>datagrid</code> rows
1427: list</span> and the <span>pending <code>datagrid</code> cells
1.80 mike 1428: list</span> accordingly" - ->
1.1 mike 1429:
1430:
1431: </dd>
1432:
1.80 mike 1433: <dt>There does not exist a row in the <code>datagrid</code>'s
1434: <span>natural order sparse data tree</span> with the same
1435: identifier as given by the <code>Row</code> object's
1436: <code>RowID</code> object</dt>
1.1 mike 1437:
1438: <dd>
1439:
1.80 mike 1440: <p>If the <code>RowID</code> object has a length greater than 1,
1.1 mike 1441: then verify that there is a row identified by the
1.80 mike 1442: <code>RowID</code> consisting of all but the last number in the
1443: <code>Row</code> object's <code>RowID</code>. If there is no
1444: such row present in the <span>natural order sparse data
1445: tree</span>, then revert all the changes done in this step,
1446: throw a <code>DATAGRID_MODEL_ERR</code> exception, and abort
1.1 mike 1447: these steps.</p>
1448:
1.80 mike 1449: <p>Create a row and insert it into the <span>natural order
1450: sparse data tree</span>, such that its parent is the row
1451: identified by the <code>RowID</code> consisting of all but the
1452: last number in the <code>Row</code> object's <code>RowID</code>,
1453: or the <code>datagrid</code> if the length of the
1454: <code>Row</code> object's <code>RowID</code> is 1; with its
1.1 mike 1455: natural order position being the last number of the
1.80 mike 1456: <code>Row</code> object's <code>RowID</code>; with the child
1457: count being the value of the third entry of the <code>Row</code>
1.1 mike 1458: object; with the row being marked closed unless the
1.80 mike 1459: <code>Row</code> object has five or more entries and its fifth
1.1 mike 1460: entry is true, in which case the row is open; and with its row
1.80 mike 1461: count being −1 unless the <code>Row</code> object has six
1.1 mike 1462: entries, in which case the row count is equal to the value of
1.80 mike 1463: the <code>Row</code> object's sixth entry.</p>
1.1 mike 1464:
1465: </dd>
1466:
1.80 mike 1467: </dl>
1468:
1469: </li>
1.1 mike 1470:
1471: <li>
1472:
1.80 mike 1473: <p><span>Audit the <code>datagrid</code></span>. If this fails,
1.1 mike 1474: then revert the changes made in the previous step, throw a
1.80 mike 1475: <code>DATAGRID_MODEL_ERR</code> exception, and abort these
1.1 mike 1476: steps.</p>
1477:
1478: </li>
1479:
1480: <li>
1481:
1.80 mike 1482: <p>For each <code>Row</code> object in the <var
1483: title="">rows</var> argument, in order, <span title="apply a Row
1484: object">apply the <code>Row</code> object</span>.</p>
1.1 mike 1485:
1486: </li>
1487:
1488: <li>
1489:
1.80 mike 1490: <p>Invoke the <span><code>datagrid</code> update display
1491: algorithm</span>.</p>
1.1 mike 1492:
1493: </li>
1494:
1.80 mike 1495: </ol>
1496:
1497: <hr>
1498:
1499: <p>The <dfn title="dom-datagrid-insertRows"><code>insertRows(<var
1500: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1501: steps:</p>
1502:
1.80 mike 1503: <ol>
1504:
1505: <li>
1.1 mike 1506:
1.80 mike 1507: <p><span title="type-check a RowList object">Type-check the <var
1508: title="">rows</var> argument</span>. If this fails, throw a
1.1 mike 1509: <code>TypeError</code> exception, and abort these steps.</p>
1510:
1511: </li>
1512:
1513: <li>
1514:
1.80 mike 1515: <p><span title="partially sort a RowList object">Partially sort
1516: the <var title="">rows</var> argument</span>.</p>
1.1 mike 1517:
1518: </li>
1519:
1520: <li>
1521:
1.80 mike 1522: <p>For each <code>Row</code> object in the <var
1523: title="">rows</var> argument, in order, run the following
1.1 mike 1524: steps:</p>
1525:
1.80 mike 1526: <p class="note">The changes made to the <code>datagrid</code>'s
1.1 mike 1527: data structures in this step get reverted (as required below) if
1528: any consistency errors are detected either in this step or the
1529: next.</p>
1530:
1.80 mike 1531: <ol>
1532:
1533: <li>
1.1 mike 1534:
1535: <p>Let <var title="">parent</var> be the row identified by the
1.80 mike 1536: <code>RowID</code> consisting of all but the last number in the
1537: <code>Row</code> object's <code>RowID</code>, or the
1538: <code>datagrid</code> itself if the <code>Row</code> object's
1539: <code>RowID</code> has length 0.</p>
1540:
1541: <p>If there is no such row present in the <span>natural order
1542: sparse data tree</span>, then revert all the changes done in
1543: this algorithm, throw a <code>DATAGRID_MODEL_ERR</code>
1.1 mike 1544: exception, and abort these steps.</p>
1545:
1546: </li>
1547:
1548: <li>
1549:
1550: <p>Increment by one the natural order position of all rows whose
1551: parent is <var title="">parent</var> and whose natural order
1552: position is equal to or greater than the last number of the
1.80 mike 1553: <code>Row</code> object's <code>RowID</code>.</p>
1.1 mike 1554:
1555: </li>
1556:
1557: <li>
1558:
1.80 mike 1559: <p>If the value of the <code>Row</code> object's second entry is
1560: not −1, then increment by one the display order position
1.1 mike 1561: of all rows whose parent is <var title="">parent</var> and whose
1562: display order position is equal to or greater than the value of
1.80 mike 1563: the <code>Row</code> object's second entry.</p>
1.1 mike 1564:
1.80 mike 1565: <!- -(Not sure how to really say this.)
1.1 mike 1566: <p>Update the <span>pending <code>datagrid</code> rows
1567: list</span> and the <span>pending <code>datagrid</code> cells
1568: list</span> accordingly.</p>
1.80 mike 1569: - ->
1.1 mike 1570:
1571: </li>
1572:
1573: <li>
1574:
1.80 mike 1575: <p>Create a row and insert it into the <span>natural order
1576: sparse data tree</span>, such that its parent is <var
1577: title="">parent</var>; with its natural order position being the
1578: last number of the <code>Row</code> object's <code>RowID</code>;
1.1 mike 1579: with the child count being the value of the third entry of the
1.80 mike 1580: <code>Row</code> object; with the row being marked closed unless
1581: the <code>Row</code> object has five or more entries and its
1.1 mike 1582: fifth entry is true, in which case the row is open; and with its
1.80 mike 1583: row count being −1 unless the <code>Row</code> object has
1.1 mike 1584: six entries, in which case the row count is equal to the value
1.80 mike 1585: of the <code>Row</code> object's sixth entry.</p>
1.1 mike 1586:
1587: </li>
1588:
1.80 mike 1589: </ol>
1590:
1591: </li>
1.1 mike 1592:
1593: <li>
1594:
1.80 mike 1595: <p>For each <code>Row</code> object in the <var
1596: title="">rows</var> argument, in order, <span title="apply a Row
1597: object">apply the <code>Row</code> object</span>.</p>
1.1 mike 1598:
1599: </li>
1600:
1601: <li>
1602:
1.80 mike 1603: <p>Invoke the <span><code>datagrid</code> update display
1604: algorithm</span>.</p>
1.1 mike 1605:
1606: </li>
1607:
1.80 mike 1608: </ol>
1609:
1610: <hr>
1611:
1612: <p>When an algorithm requires the user agent to <dfn>type-check a
1.1 mike 1613: <code>RowList</code> object</dfn> (an array), each entry in the
1614: object must be checked against the following requirements. If any
1615: are false, then the type-check fails, otherwise it passes.</p>
1616:
1.80 mike 1617: <ul>
1618:
1619: <li><p>The entry is a <code>Row</code> object (an
1.1 mike 1620: array).</p></li>
1621:
1.80 mike 1622: <li><p>The first value in the <code>Row</code> is a
1623: <code>RowID</code> object (also an array), whose length is at least
1.1 mike 1624: 1, and whose values are all integers greater than or equal to
1625: zero.</p></li>
1626:
1.80 mike 1627: <li><p>The numbers in the <code>RowID</code> object do not exactly
1628: match any of the other entries in the <code>RowList</code> object
1629: (i.e. no two <code>Row</code> objects have the same
1.1 mike 1630: identifier).</p></li>
1631:
1.80 mike 1632: <li><p>The second value in the <code>Row</code> is an integer that
1633: is either −1, zero, or a positive integer.</p></li>
1.1 mike 1634:
1.80 mike 1635: <li><p>The third value in the <code>Row</code> is an integer that
1636: is either −1, zero, or a positive integer.</p></li>
1.1 mike 1637:
1.80 mike 1638: <li><p>The fourth value in the <code>Row</code> is a
1639: <code>CellList</code> object (yet another array).</p></li>
1.1 mike 1640:
1.80 mike 1641: <li><p>Each entry in the <span>CellList</span> object is a
1642: <code>Cell</code> object (again, an array).</p></li>
1.1 mike 1643:
1.80 mike 1644: <li><p>Each <code>Cell</code> object in the <span>CellList</span>
1645: object has as its first value a <code>Column</code> object (a
1.1 mike 1646: string), and its value is the identifier of one of the columns in
1.80 mike 1647: the <span>column list</span>.</p></li>
1.1 mike 1648:
1649: <li>
1650:
1.80 mike 1651: <p>Each <code>Cell</code> object in the <span>CellList</span>
1.1 mike 1652: object has as its second and subsequent entries values that match
1653: the following requirements, as determined by the type of the
1654: column identified by the first entry:</p>
1655:
1.80 mike 1656: <dl>
1657:
1658: <dt>If the column's type is <code title="datagrid-type-text">text</code></dt>
1.1 mike 1659: <dd>
1660:
1661: <p>The second entry's value is a string, and either there are
1662: only two entries, or there are three, and the third entry is
1.80 mike 1663: an <code>img</code> element.</p>
1.1 mike 1664:
1.80 mike 1665: <p>If there is an <code>img</code> element specified, its <code
1666: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1667:
1668: </dd>
1669:
1.80 mike 1670: <dt>If the column's type is <code title="datagrid-type-editable">editable</code></dt>
1.1 mike 1671: <dd>
1672:
1673: <p>The second entry's value is a string, and either there are
1674: only two entries, or the third entry is a
1.80 mike 1675: <code>datalist</code> element, and either there are only three
1.1 mike 1676: entries, or there are four, and the fourth entry is an
1.80 mike 1677: <code>img</code> element.</p>
1.1 mike 1678:
1.80 mike 1679: <p>If there is an <code>img</code> element specified, its <code
1680: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1681:
1682: </dd>
1683:
1.80 mike 1684: <dt>If the column's type is <code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 1685: <dd>
1686:
1687: <p>The second entry's value is a string, the third entry is a
1688: boolean, and either there are only three entries, or the
1689: fourth entry is also a boolean, and either there are only four
1690: entries, or there are five, and the fifth entry is an
1.80 mike 1691: <code>img</code> element.</p>
1.1 mike 1692:
1.80 mike 1693: <p>If there is an <code>img</code> element specified, its <code
1694: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1695:
1696: </dd>
1697:
1.80 mike 1698: <dt>If the column's type is <code title="datagrid-type-list">list</code></dt>
1.1 mike 1699: <dd>
1700:
1701: <p>The second entry's value is a string, the third entry is a
1.80 mike 1702: <code>select</code> element, and either there are only three
1.1 mike 1703: entries, or there are four, and the fourth entry is an
1.80 mike 1704: <code>img</code> element.</p>
1.1 mike 1705:
1.80 mike 1706: <p>If there is an <code>img</code> element specified, its <code
1707: title="dom-img-complete">complete</code> attribute is true.</p>
1.1 mike 1708:
1709: </dd>
1710:
1.80 mike 1711: <dt>If the column's type is <code title="datagrid-type-progress">progress</code></dt>
1.1 mike 1712: <dd>
1713:
1714: <p>There are only two entries, the second entry's value is a
1715: number, and the number's value is between 0.0 and 1.0
1716: inclusive.</p>
1717:
1718: </dd>
1719:
1.80 mike 1720: <dt>If the column's type is <code title="datagrid-type-meter">meter</code></dt>
1.1 mike 1721: <dd>
1722:
1723: <p>There are at least two, but possibly up to seven, entries,
1724: all entries but the first one are numbers, and the following
1725: relationships hold:</p>
1726:
1.80 mike 1727: <ul class="brief">
1728:
1729: <li>The second entry is less than the third, or less than 1.0
1.1 mike 1730: if the third is absent.</li>
1731:
1732: <li>The second entry is greater than the fourth, or greater
1733: than 0.0 if the fourth is absent.</li>
1734:
1735: <li>If there are at least three entries, the third entry is
1736: greater than the fourth, or greater than zero if the fourth
1737: is absent.</li>
1738:
1739: <li>If there are at least five entries, the fifth is not
1740: greater than the third and not less than the fourth.</li>
1741:
1742: <li>If there are at least six entries, the sixth is not
1743: greater than the third and not less than the fifth.</li>
1744:
1745: <li>If there are at least seven entries, the fifth is not
1746: greater than the third and not less than the fourth.</li>
1747:
1.80 mike 1748: </ul>
1.1 mike 1749:
1.80 mike 1750: </dd>
1751:
1752: <dt>If the column's type is <code title="datagrid-type-custom">custom</code></dt>
1.1 mike 1753: <dd>
1754:
1755: <p>There are four entries, the second and third are numbers
1756: that are integers greater than zero, and the fourth is a
1757: <code>Rendering2DContextCallback</code> object (a
1758: function).</p>
1759:
1760: </dd>
1761:
1.80 mike 1762: </dl>
1763:
1764: </li>
1.1 mike 1765:
1.80 mike 1766: <li><p>Either there are only four values in the <code>Row</code>,
1767: or the fifth value in the <code>Row</code> is a boolean.</p></li>
1.1 mike 1768:
1769: <li><p>Either there are only four or five values in the
1.80 mike 1770: <code>Row</code>, or there are six, and the sixth value in the
1771: <code>Row</code> an integer that is greater than or equal to
1.1 mike 1772: zero.</p></li>
1773:
1.80 mike 1774: </ul>
1775:
1776: <p>Where the above requirements say that a value is to be a string,
1.718 mike 1777: the user agent must apply the ToString() abstract operation to the
1.1 mike 1778: value, assume that the value was indeed a string, and use the result
1779: in the rest of the algorithm as if it had that had been the value
1.98 mike 1780: passed to the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1781:
1782: <p>Where the above requirements say that a value is to be a number,
1.718 mike 1783: the user agent must first apply the ToNumber() abstract operation
1.60 mike 1784: to the value, and then verify that the result is neither an Infinity
1785: value nor a Not-a-Number (NaN) value. If this result is indeed
1786: acceptable (i.e. finite), the user agent must use the result in the
1787: rest of the algorithm as if it had that had been the value passed to
1.98 mike 1788: the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1789:
1790: <p>Where the above requirements say that a value is to be an
1.718 mike 1791: integer, the user agent must first apply the ToNumber() abstract
1792: operation to the value, and then verify that the result is a finite
1.1 mike 1793: integer. If so, the user agent must use the result in the rest of
1794: the algorithm as if it had that had been the value passed to the
1.98 mike 1795: method. <a href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1796:
1797: <p>Where the above requirements say that a value is to be a boolean,
1.718 mike 1798: the user agent must apply the ToBoolean() abstract operation to the
1.1 mike 1799: value, assume that the value was indeed a boolean, and use the
1800: result in the rest of the algorithm as if it had that had been the
1.98 mike 1801: value passed to the method. <a href="#refsECMA262">[ECMA262]</a></p>
1.80 mike 1802:
1803: <hr>
1.1 mike 1804:
1.80 mike 1805: <p>When an algorithm requires the user agent to <dfn>audit the
1806: <code>datagrid</code></dfn>, the <code>datagrid</code> must be
1.1 mike 1807: checked against the following requirements. If any are false, then
1808: the audit fails, otherwise it passes.</p>
1809:
1.80 mike 1810: <ul>
1811:
1812: <li>There is no row whose natural order position is greater than or
1813: equal to the child count of its parent row in the <span>natural
1814: order sparse data tree</span>.</li>
1.1 mike 1815:
1816: <li>There is no row whose display order position is greater than or
1.80 mike 1817: equal to the child count of its parent row in the <span>display
1818: order sparse data tree</span>.</li>
1.1 mike 1819:
1820: <li>There is no row such that the sum of that row's child count and
1821: the row counts all the open rows that are direct children of that
1.80 mike 1822: row in the <span>natural order sparse data tree</span> is less than
1.1 mike 1823: that row's row count.</li>
1824:
1825: <li>Of the rows whose child count is equal to the number of rows
1.80 mike 1826: that are direct children of that row in the <span>natural order
1827: sparse data tree</span>, there is none such that the sum of that
1.1 mike 1828: row's child count and the row counts of all the open rows that are
1.80 mike 1829: direct children of that row in the <span>natural order sparse data
1830: tree</span> is greater than that row's row count.</li>
1831:
1832: </ul>
1.1 mike 1833:
1.80 mike 1834: <p>For the purposes of this audit, the <code>datagrid</code> must be
1.1 mike 1835: treated as the parent row of all the rows that are direct children
1.80 mike 1836: of the <code>datagrid</code> in the <span>natural order sparse data
1837: tree</span> and the <span>display order sparse data tree</span>. The
1838: child count of this implied row is the <span><code>datagrid</code>
1839: child count</span>, and the row count of this implied row is the
1840: <span><code>datagrid</code> row count</span>.</p>
1841:
1842: <hr>
1.1 mike 1843:
1.80 mike 1844: <p>When an algorithm requires the user agent to <dfn>partially sort
1.1 mike 1845: a <code>RowList</code> object</dfn> (an array), the entries in the
1.80 mike 1846: object must be resorted such that <code>Row</code> objects are
1.1 mike 1847: listed after any of their ancestors and after any of their earlier
1.80 mike 1848: siblings. In other words, for any two <code>Row</code> objects <var
1849: title="">a</var> and <var title="">b</var> in the
1850: <code>RowList</code>, where <var title="">a</var> is before <var
1851: title="">b</var> after the sort, the following conditions must
1.1 mike 1852: hold:</p>
1853:
1.80 mike 1854: <ul>
1855:
1856: <li><p>If their <code>RowID</code> objects are the same length and
1.1 mike 1857: have values that are equal except for the last value, then the last
1.80 mike 1858: value of <var title="">a</var>'s <code>RowID</code>'s last value
1859: must be less than <var title="">b</var>'s <code>RowID</code>'s last
1.1 mike 1860: value (i.e. earlier siblings must come before their later
1861: siblings).</p></li>
1862:
1.80 mike 1863: <li><p>If their <code>RowID</code> objects are not the same length,
1.1 mike 1864: but the values in the shorter of the two are the same as the first
1865: few values in the longer one, then <var title="">a</var>'s
1.80 mike 1866: <code>RowID</code> must be the shorter one (i.e. ancestors must
1.1 mike 1867: come before their descendants).</p></li>
1868:
1.80 mike 1869: </ul>
1870:
1871: <hr>
1872:
1873: <p>The <dfn title="dom-datagrid-deleteRows"><code>deleteRows(<var
1874: title="">rows</var>)</code></dfn> method must run the following
1.1 mike 1875: steps:</p>
1876:
1.80 mike 1877: <ol>
1878:
1879: <li>
1.1 mike 1880:
1881: <p>If any of the entries in <var title="">rows</var> are not
1.80 mike 1882: <code>RowID</code> objects consisting of one or more entries whose
1.1 mike 1883: values are all integers that are greater than or equal to zero,
1884: then throw a <code>TypeError</code> exception and abort these
1885: steps.</p>
1886:
1887: <p>To check if a value is an integer, the user agent must first
1.718 mike 1888: apply the ToNumber() abstract operation to the value, and then
1.1 mike 1889: verify that the result is a finite integer. If so, the user agent
1890: must use the result in the rest of the algorithm as if it had that
1.80 mike 1891: had been the value passed to the method. <a
1.98 mike 1892: href="#refsECMA262">[ECMA262]</a></p>
1.1 mike 1893:
1894: </li>
1895:
1896: <li>
1897:
1.80 mike 1898: <p>If any of the <code>RowID</code> objects in the <var
1899: title="">rows</var> argument identify a row that isn't present in
1900: the <span>natural order sparse data tree</span>, then throw a
1901: <code>DATAGRID_MODEL_ERR</code> exception and abort these
1.1 mike 1902: steps.</p>
1903:
1904: </li>
1905:
1906: <li>
1907:
1908: <p>If any row is listed twice in the <var title="">rows</var>
1.80 mike 1909: argument, then throw a <code>DATAGRID_MODEL_ERR</code> exception
1.1 mike 1910: and abort these steps.</p>
1911:
1912: </li>
1913:
1914: <li>
1915:
1916: <p>Sort the <var title="">rows</var> argument such that the
1917: entries are given in the same order as the rows they identify
1918: would be visited in a pre-order, depth first traversal of the
1.80 mike 1919: <span>natural order sparse data tree</span>.</p>
1.1 mike 1920:
1921: </li>
1922:
1923: <li>
1924:
1925: <p>For each row identified by entries in <var title="">rows</var>,
1926: <em>in reverse order</em>, run the following steps:</p>
1927:
1.80 mike 1928: <ol>
1929:
1930: <li>
1.1 mike 1931:
1932: <p>Decrement the child count of the row's parent row, if that
1933: child count is greater than zero. If the row has no parent,
1.80 mike 1934: decrement the <span><code>datagrid</code> child
1935: count</span>.</p>
1.1 mike 1936:
1937: <p>If the row has a parent row, and its child count is now zero,
1938: then close that row.</p>
1939:
1940: </li>
1941:
1942: <li>
1943:
1944: <p>Let <var title="">delta</var> be one more than the row's row
1945: count if the row is open and its row count is greater than zero;
1946: otherwise, let <var title="">delta</var> be one.</p>
1947:
1948: </li>
1949:
1950: <li>
1951:
1952: <p>Let <var title="">ancestor</var> be the row.</p>
1953:
1954: </li>
1955:
1956: <li>
1957:
1958: <p><i>Row count loop</i>: Let <var title="">ancestor</var> be
1959: <var title="">ancestor</var>'s parent row, if any, or null if it
1960: has none.</p>
1961:
1962: </li>
1963:
1964: <li>
1965:
1966: <p>If <var title="">ancestor</var> is null, then decrement the
1.80 mike 1967: <span><code>datagrid</code> row count</span> by <var
1968: title="">delta</var>. Otherwise, if <var title="">ancestor</var>
1969: is open, then decrement its row count by <var
1970: title="">delta</var>.</p>
1.1 mike 1971:
1972: </li>
1973:
1974: <li>
1975:
1976: <p>If <var title="">ancestor</var> is not null, then jump back
1977: to the step labeled <i>row count loop</i> above.</p>
1978:
1979: </li>
1980:
1981: <li>
1982:
1983: <p>Let <var title="">parent</var> be the row's parent, or the
1.80 mike 1984: <code>datagrid</code> if the row has no parent.</p>
1.1 mike 1985:
1986: </li>
1987:
1988: <li>
1989:
1990: <p>Decrement by one the natural order position of all rows whose
1991: parent is <var title="">parent</var> and whose natural order
1992: position is equal to or greater than the row's own natural order
1993: position.</p>
1994:
1995: </li>
1996:
1997: <li>
1998:
1.80 mike 1999: <p>If the row is in the <span>display order sparse data
2000: tree</span>, then decrement by one the display order position of
1.1 mike 2001: all rows whose parent is <var title="">parent</var> and whose
2002: display order position is equal to or greater than the row's own
2003: display order position.</p>
2004:
2005: </li>
2006:
2007: <li>
2008:
2009: <p>Clear the row and its descendants from the
1.80 mike 2010: <code>Datagrid</code>.</p>
1.1 mike 2011:
2012: </li>
2013:
1.80 mike 2014: </ol>
2015:
2016: </li>
1.1 mike 2017:
2018: <li>
2019:
1.80 mike 2020: <p>Invoke the <span><code>datagrid</code> update display
2021: algorithm</span>.</p>
1.1 mike 2022:
2023: </li>
2024:
1.80 mike 2025: </ol>
1.1 mike 2026:
1.80 mike 2027: <hr>
2028:
2029: <p>The <dfn
2030: title="dom-datagrid-clearRows"><code>clearRows()</code></dfn> method
2031: must empty the <span>natural order sparse data tree</span>, reset
2032: both the <span><code>datagrid</code> child count</span> and the
2033: <span><code>datagrid</code> row count</span> to zero, and invoke the
2034: <span><code>datagrid</code> update display algorithm</span>.</p>
2035:
2036: <hr>
2037:
2038: <p>The <dfn title="dom-datagrid-repaint"><code>repaint(<var
2039: title="">row</var>, <var title="">column</var>)</code></dfn> method
1.1 mike 2040: must cause the user agent to clear its cache for the cell specified
1.80 mike 2041: by the identifier <var title="">row</var> and the column <var
2042: title="">column</var>, if that column's type is <code
2043: title="datagrid-type-custom">custom</code>. If the given column has
2044: not been declared, or its type is not <code
2045: title="datagrid-type-custom">custom</code>, then the user agent must
2046: throw a <code>DATAGRID_MODEL_ERR</code> exception. If the given row
1.1 mike 2047: is not known, then the method must do nothing. If the cell is indeed
2048: cleared, the user agent must reinvoke the previously registered
1.80 mike 2049: <code>RenderingContext2DCallback</code> callback when it needs to
1.1 mike 2050: repaint that row.</p>
2051:
1.80 mike 2052: <hr>
2053:
2054: <p>If a row has a child count that isn't zero, then the user agent
1.1 mike 2055: should offer to the user the option of opening and closing the
2056: row.</p>
2057:
2058: <p>When a row is opened, if the row's row count is greater than
2059: zero, then the user agent must increase the
1.80 mike 2060: <span><code>datagrid</code> row count</span> and the row counts of
1.1 mike 2061: any ancestor rows by the number of rows that the newly opened row
1.80 mike 2062: has in its row count<!- - we should also "update the <span>pending
1.1 mike 2063: <code>datagrid</code> rows list</span> and the <span>pending
1.80 mike 2064: <code>datagrid</code> cells list</span> accordingly" - ->, then must
2065: mark the row as open, then may fill in the <span>display order
2066: sparse data tree</span> with any information that the user agent has
1.1 mike 2067: cached about the display order positions of descendants of the newly
1.80 mike 2068: opened row, and then must invoke the <code
2069: title="dom-listener-rowOpened">rowOpened()</code> method on the
2070: current <code title="dom-datagrid-listener">listener</code> with as
2071: its first argument a <code>RowID</code> object identifying the row
1.1 mike 2072: that was opened and as its second argument the boolean false, and
1.80 mike 2073: then must invoke the <span><code>datagrid</code> update display
2074: algorithm</span>.</p>
1.1 mike 2075:
2076: <p>On the other hand, when a row is opened and the row's row count
1.80 mike 2077: is −1, then the user agent must mark the row as opening, and
2078: then must invoke the <code
2079: title="dom-listener-rowOpened">rowOpened()</code> method on the
2080: current <code title="dom-datagrid-listener">listener</code> with as
2081: its first argument a <code>RowID</code> object identifying the row
1.1 mike 2082: that was opened and as its second argument the boolean true.</p>
2083:
2084: <p>When a row is closed, the user agent must decrease the
1.80 mike 2085: <span><code>datagrid</code> row count</span> and the row counts of
1.1 mike 2086: any ancestor rows by the number of rows that the newly closed row
1.80 mike 2087: has in its row count, and then must invoke the <code
2088: title="dom-listener-rowOpened">rowOpened()</code> method on the
2089: current <code title="dom-datagrid-listener">listener</code> with as
2090: its first and only argument a <code>RowID</code> object identifying
1.1 mike 2091: the row that was opened.</p>
2092:
2093:
2094:
1.80 mike 2095: <h6>The cells</h6>
1.1 mike 2096:
2097: <p>Each row has one cell per column. Each cell has the same type as
1.80 mike 2098: its column. The <dfn>allowed <code>datagrid</code> column
1.1 mike 2099: types</dfn>, what they represent, and the requirements for when the
2100: user interacts with them, are as follows:</p>
2101:
1.80 mike 2102: <dl>
2103:
2104: <dt><dfn title="datagrid-type-text"><code>text</code></dfn></dt>
1.1 mike 2105: <dd>
2106:
2107: <p>The cell represents some text and an optional image.</p>
2108:
2109: </dd>
2110:
1.80 mike 2111: <dt><dfn title="datagrid-type-editable"><code>editable</code></dfn></dt>
1.1 mike 2112: <dd>
2113:
2114: <p>The cells represents some editable text, an optional
1.80 mike 2115: <code>datalist</code> giving autocompletion hints, and an
1.1 mike 2116: optional image.</p>
2117:
1.80 mike 2118: <p>If there is a <code>datalist</code> element, the user agent
1.1 mike 2119: should offer the suggestions represented by that element to the
1.80 mike 2120: user. The user agent may use the suggestion's <span
2121: title="concept-option-label">label</span> to identify the
1.1 mike 2122: suggestion. If the user selects a suggestion, then the editable
1.80 mike 2123: text must be set to the selected suggestion's <span
2124: title="concept-option-value">value</span>, as if the user had
1.1 mike 2125: written that value himself.</p>
2126:
2127: <p>When the user edits the value, either directly or using the
1.80 mike 2128: <code>datalist</code>, the user agent must invoke the <code
2129: title="dom-listener-cellChanged">cellChanged()</code> method on
2130: the current <code title="dom-datagrid-listener">listener</code>
2131: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2132: cell's row, as its second argument the identifier of the cell's
2133: column, as its third argument the new value, and as its fourth
2134: argument the previous value.</p>
2135:
2136: </dd>
2137:
1.80 mike 2138: <dt><dfn title="datagrid-type-checkable"><code>checkable</code></dfn></dt>
1.1 mike 2139: <dd>
2140:
2141: <p>The cell represents some text, a check box that optionally has
2142: its value obscured as indeterminate, and an optional image.</p>
2143:
2144: <p>When the user checks or unchecks the check box, the user agent
2145: must change the check box's state appropriately and stop obscuring
2146: the check box as indeterminate (if it is obscuring it), and then
1.80 mike 2147: must invoke the <code
2148: title="dom-listener-cellChanged">cellChanged()</code> method on
2149: the current <code title="dom-datagrid-listener">listener</code>
2150: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2151: cell's row, as its second argument the identifier of the cell's
2152: column, as its third argument true if the check box is now checked
2153: and false otherwise, and as its fourth argument true if the check
2154: box was previously checked and false otherwise.</p>
2155:
2156: </dd>
2157:
1.80 mike 2158: <dt><dfn title="datagrid-type-list"><code>list</code></dfn></dt>
1.1 mike 2159: <dd>
2160:
2161: <p>The cell represents some text giving the current value selected
1.80 mike 2162: from a dropdown list of options, a <code>select</code> element
1.1 mike 2163: giving the list of options, and an optional image.</p>
2164:
2165: <p>The user agent should allow the user to change the value of the
1.80 mike 2166: cell from its current value to one of the <span
2167: title="concept-option-value">values</span> given by
2168: <code>option</code> elements in the <span
2169: title="concept-select-option-list">list of options</span> (if
2170: any). The user agent may use the <code>option</code> elements'
2171: <span title="concept-option-label">labels</span> to annotate each
1.1 mike 2172: option.</p>
2173:
1.80 mike 2174: <p>When the user selects a new value from the <code>select</code>
2175: element's <span title="concept-select-option-list">list of
2176: options</span>, the user agent must invoke the <code
2177: title="dom-listener-cellChanged">cellChanged()</code> method on
2178: the current <code title="dom-datagrid-listener">listener</code>
2179: with as its first argument a <code>RowID</code> identifying the
1.1 mike 2180: cell's row, as its second argument the identifier of the cell's
2181: column, as its third argument the new value, and as its fourth
2182: argument the previous value.</p>
2183:
2184: </dd>
2185:
1.80 mike 2186: <dt><dfn title="datagrid-type-progress"><code>progress</code></dfn></dt>
1.1 mike 2187: <dd>
2188:
2189: <p>The cell represents a (determinate) progress bar whose value is
2190: between 0.0, indicating no progress, and 1.0, indicating the task
2191: is complete.</p>
2192:
2193: </dd>
2194:
1.80 mike 2195: <dt><dfn title="datagrid-type-meter"><code>meter</code></dfn></dt>
1.1 mike 2196: <dd>
2197:
2198: <p>The cell represents a gauge, described by one to six
2199: numbers.</p>
2200:
2201: <p>The gauge's actual value is given by the first number.</p>
2202:
2203: <p>If there is a second number, then that number is the maximum
2204: value. Otherwise, the maximum value is 1.0.</p>
2205:
2206: <p>If there is a third number, then that number is the minimum
2207: value. Otherwise, the minimum value is 1.0.</p>
2208:
2209: <p>If there is a fourth number, then that number is the low
2210: boundary. Otherwise, the low boundary is the minimum value.</p>
2211:
2212: <p>If there is a fifth number, then that number is the high
2213: boundary. Otherwise, the high boundary is the maximum value.</p>
2214:
2215: <p>If there is a sixth number, then the optimal point is the sixth
2216: number. Otherwise, the optimum point is the midpoint between the
2217: minimum value and the maximum value.</p>
2218:
1.80 mike 2219: <!- - next two paragraphs copied from <meter>: - ->
1.1 mike 2220:
2221: <p>If the optimum point is equal to the low boundary or the high
2222: boundary, or anywhere in between them, then the region between the
2223: low and high boundaries of the gauge must be treated as the
2224: optimum region, and the low and high parts, if any, must be
2225: treated as suboptimal. Otherwise, if the optimum point is less
2226: than the low boundary, then the region between the minimum value
2227: and the low boundary must be treated as the optimum region, the
2228: region between the low boundary and the high boundary must be
2229: treated as a suboptimal region, and the region between the high
2230: boundary and the maximum value must be treated as an even less
2231: good region. Finally, if the optimum point is higher than the high
2232: boundary, then the situation is reversed; the region between the
2233: high boundary and the maximum value must be treated as the optimum
2234: region, the region between the high boundary and the low boundary
2235: must be treated as a suboptimal region, and the remaining region
2236: between the low boundary and the minimum value must be treated as
2237: an even less good region.</p>
2238:
2239: <p>User agents should indicate the relative position of the actual
2240: value to the minimum and maximum values, and the relationship
2241: between the actual value and the three regions of the gauge.</p>
2242:
2243: </dd>
2244:
1.80 mike 2245: <dt><dfn title="datagrid-type-custom"><code>custom</code></dfn></dt>
1.1 mike 2246: <dd>
2247:
2248: <p>The cell represents a dynamically generated graphical image.</p>
2249:
2250: <p>The cell will have minimum dimensions (specified in CSS
2251: pixels), and a callback (in the form of a
1.80 mike 2252: <code>RenderingContext2DCallback</code> object) to get a rendering
1.1 mike 2253: for the cell.</p>
2254:
2255: <p>The user agent should not allow the cell to be rendered with
2256: dimensions less than the given minimum width and height.</p>
2257:
2258: <p>When the user agent needs to render the cell, the user agent
1.80 mike 2259: must <span>queue a task</span> to invoke the
2260: <span>RenderingContext2DCallback</span> callback, passing it a
2261: newly created <code>CanvasRenderingContext2D</code> object whose
1.186 mike 2262: <code title="dom-context-2d-canvas">canvas</code> IDL attribute is
1.1 mike 2263: null as the first argument, the actual cell width in CSS pixels as
2264: the second argument, and the actual cell height in CSS pixels as
2265: the third argument.</p>
2266:
2267: <p>If the user agent is able to render graphics, then it must
2268: render the graphics commands that the callback executed on the
1.80 mike 2269: provided <code>CanvasRenderingContext2D</code> object onto the
1.1 mike 2270: cell once the callback returns. The image must be clipped to the
2271: dimensions of the cell. The coordinate space of the cell must be
2272: aligned with that used by the 2D context such that the top left
2273: corner of the cell is the 0,0 origin, with the coordinate space
2274: increasing its <var title="">x</var> dimension towards the right
2275: of the cell and its <var title="">y</var> axis towards the bottom
2276: of the cell, and with the image not scaled (so that one CSS pixel
2277: on the final rendering matches one CSS pixel in the coordinate
2278: space used by the 2D context).</p>
2279:
2280: <p>The user agent must then decouple the
1.80 mike 2281: <code>CanvasRenderingContext2D</code> object and any objects that
2282: it created (such as <code>CanvasPattern</code> objects or
2283: <code>ImageData</code> objects) from any real drawing surface.</p>
1.1 mike 2284:
2285: <p>If the user agent is unable to render graphics, then it must
2286: render the text string returned by the callback instead.</p>
2287:
2288: </dd>
2289:
1.80 mike 2290: </dl>
2291:
2292: <hr>
2293:
2294: <p>When an algorithm requires the user agent to <dfn>apply a
1.1 mike 2295: <code>Row</code> object</dfn>, the user agent must run the following
2296: steps:</p>
2297:
1.80 mike 2298: <ol>
2299:
2300: <li>
2301:
2302: <p>If the value of the <code>Row</code> object's second entry is
2303: not −1, then run these substeps:</p>
1.1 mike 2304:
1.80 mike 2305: <ol>
1.1 mike 2306:
1.80 mike 2307: <li><p>If there is a row with the same parent as the row
2308: specified by the <code>Row</code> object's <code>RowID</code>
1.1 mike 2309: object, whose display order position is currently the same as the
1.80 mike 2310: value of the <code>Row</code> object's second entry, then remove
2311: that row from the <span>display order sparse data
2312: tree</span>.</p></li>
1.1 mike 2313:
2314: <li><p>Set the display order position of the row specified by the
1.80 mike 2315: <code>Row</code> object's <code>RowID</code> to the value of the
2316: <code>Row</code> object's second entry, updating its position in
2317: the <span>display order sparse data tree</span>
1.1 mike 2318: accordingly.</p></li>
2319:
1.80 mike 2320: <li><p>If the row is in the <span>pending
2321: <code>datagrid</code> rows list</span>, remove it.</p></li>
2322:
2323: </ol>
1.1 mike 2324:
1.80 mike 2325: </li>
1.1 mike 2326:
2327: <li>
2328:
1.80 mike 2329: <p>If the fourth entry in the <code>Row</code> object (a
2330: <code>CellList</code> object, an array) is not empty, then for
2331: each <code>Cell</code> object in that array update the cell that
1.1 mike 2332: corresponds to the column identified by the value of the first
1.80 mike 2333: entry of the <code>Cell</code> object, by using the appropriate
1.1 mike 2334: set of steps given below as determined by the type of the
1.80 mike 2335: column. Then, if the cell is in the <span>pending
2336: <code>datagrid</code> cells list</span>, remove it.</p>
1.1 mike 2337:
1.80 mike 2338: <dl>
2339:
2340: <dt>If the column's type is <code title="datagrid-type-text">text</code></dt>
1.1 mike 2341: <dd>
2342:
2343: <p>Update the cell's text to the value given in the
1.80 mike 2344: <code>Cell</code> object's second entry.</p>
1.1 mike 2345:
1.80 mike 2346: <p>If the <code>Cell</code> object has three entries, then copy
2347: the image data from the <code>img</code> element given in the
1.1 mike 2348: third entry, and let the cell's image be given by that image
2349: data. Otherwise, update the cell to have no image.</p>
2350:
2351: </dd>
2352:
1.80 mike 2353: <dt>If the column's type is <code title="datagrid-type-editable">editable</code></dt>
1.1 mike 2354: <dd>
2355:
2356: <p>Update the cell's text to the value given in the
1.80 mike 2357: <code>Cell</code> object's second entry.</p>
1.1 mike 2358:
1.80 mike 2359: <p>If the <code>Cell</code> object has three entries, then let
2360: the <code>datalist</code> element given in the third entry be
2361: the <code>datalist</code> element giving autocompletion
1.1 mike 2362: hints. Otherwise, update the cell to have no
1.80 mike 2363: <code>datalist</code> element.</p>
1.1 mike 2364:
1.80 mike 2365: <p>If the <code>Cell</code> object has four entries, then copy
2366: the image data from the <code>img</code> element given in the
1.1 mike 2367: fourth entry, and let the cell's image be given by that image
2368: data. Otherwise, update the cell to have no image.</p>
2369:
2370: </dd>
2371:
1.80 mike 2372: <dt>If the column's type is <code title="datagrid-type-checkable">checkable</code></dt>
1.1 mike 2373: <dd>
2374:
2375: <p>Update the cell's text to the value given in the
1.80 mike 2376: <code>Cell</code> object's second entry.</p>
1.1 mike 2377:
2378: <p>Update the cell's checked state to match the value of the
2379: third entry: checked if true, unchecked otherwise.</p>
2380:
1.80 mike 2381: <p>If the <code>Cell</code> object has four entries and the
1.1 mike 2382: fourth entry is true, then update the cell to be obscured as
2383: indeterminate. Otherwise, the cell's state is not obscured.</p>
2384:
1.80 mike 2385: <p>If the <code>Cell</code> object has five entries, then copy
2386: the image data from the <code>img</code> element given in the
1.1 mike 2387: fifth entry, and let the cell's image be given by that image
2388: data. Otherwise, update the cell to have no image.</p>
2389:
2390: </dd>
2391:
1.80 mike 2392: <dt>If the column's type is <code title="datagrid-type-list">list</code></dt>
1.1 mike 2393: <dd>
2394:
2395: <p>Update the cell's text to the value given in the
1.80 mike 2396: <code>Cell</code> object's second entry, and the
2397: <code>select</code> element to be the one given in the
2398: <code>Cell</code> object's third entry</p>
1.1 mike 2399:
1.80 mike 2400: <p>If the <code>Cell</code> object has four entries, then copy
2401: the image data from the <code>img</code> element given in the
1.1 mike 2402: fourth entry, and let the cell's image be given by that image
2403: data. Otherwise, update the cell to have no image.</p>
2404:
2405: </dd>
2406:
1.80 mike 2407: <dt>If the column's type is <code title="datagrid-type-progress">progress</code></dt>
1.1 mike 2408: <dd>
2409:
2410: <p>Update the cell to be a progress bar whose progress, on the
2411: scale of 0.0 (no progress) to 1.0 (task complete) is given by
1.80 mike 2412: the value in the <code>Cell</code> object's second entry.</p>
1.1 mike 2413:
2414: </dd>
2415:
1.80 mike 2416: <dt>If the column's type is <code title="datagrid-type-meter">meter</code></dt>
1.1 mike 2417: <dd>
2418:
2419: <p>Update the cell to be a gauge configured with the numbers
2420: given by the second and subsequent entries of the
1.80 mike 2421: <code>Cell</code> object.</p>
1.1 mike 2422:
2423: </dd>
2424:
1.80 mike 2425: <dt>If the column's type is <code title="datagrid-type-custom">custom</code></dt>
1.1 mike 2426: <dd>
2427:
2428: <p>Update the cell's minimum width to be the length in CSS
1.80 mike 2429: pixels given by the <code>Cell</code> object's second entry.</p>
1.1 mike 2430:
2431: <p>Update the cell's minimum height to be the length in CSS
1.80 mike 2432: pixels given by the <code>Cell</code> object's third entry.</p>
1.1 mike 2433:
2434: <p>Update the cell's callback to be the
1.80 mike 2435: <code>RenderingContext2DCallback</code> object given by the
2436: <code>Cell</code> object's fourth entry.</p>
1.1 mike 2437:
2438: </dd>
2439:
1.80 mike 2440: </dl>
2441:
2442: </li>
1.1 mike 2443:
1.80 mike 2444: </ol>
2445:
2446: <hr>
2447:
2448: <p>When the user agent is to run the <dfn><code>datagrid</code>
2449: update display algorithm</dfn>, the user agent must invoke the <code
2450: title="dom-listener-getRows">getRows()</code> and <code
2451: title="dom-listener-getCells">getCells()</code> methods on the
2452: current <code title="dom-datagrid-listener">listener</code> such
2453: that all the current visible rows in the <span>display order sparse
2454: data list</span>, and all the cells in the currently visible columns
1.1 mike 2455: on all the currently visible rows, have been covered.</p>
2456:
1.80 mike 2457: <p>A row is considered covered if it is present in the <span>pending
2458: <code>datagrid</code> rows list</span>, or if the <code
2459: title="dom-listener-getRows">getRows()</code> method is invoked with
1.1 mike 2460: a range that includes the row in question.</p>
2461:
2462: <p>A cell is considered covered if it is present in the
1.80 mike 2463: <span>pending <code>datagrid</code> cells list</span>, or if the
2464: <code title="dom-listener-getRows">getRows()</code> method is
1.1 mike 2465: invoked with a range that includes the row in question and a list of
1.80 mike 2466: columns that includes the cell's column, or if the <code
2467: title="dom-listener-getCells">getCells()</code> method is invoked
1.1 mike 2468: with a list of rows and columns that intersects the cell in
1.80 mike 2469: question. However, the <code
2470: title="dom-listener-getCells">getCells()</code> method can only be
2471: used if the row is already present in the <span>display order sparse
2472: data list</span>.</p>
1.1 mike 2473:
1.80 mike 2474: <p>The <code title="dom-listener-getRows">getRows()</code> method,
1.1 mike 2475: if used, must be invoked with five arguments. The first argument
1.80 mike 2476: must be the index in the <span>display order sparse data list</span>
1.1 mike 2477: to the first row that the user agent is requesting, known as the
2478: <i>anchor row</i>. The second argument must be the number of
2479: consecutive cells for which the user agent is requesting
1.80 mike 2480: information. The third argument must be the <code>RowID</code> of
2481: the row that is the nearest ancestor in the <span>display order
2482: sparse data <em>tree</em></span> of the anchor row. If this is the
2483: <code>datagrid</code>, then the <code>RowID</code> object must be an
1.1 mike 2484: empty array. The fourth argument must be the display order position
1.80 mike 2485: of the anchor row in the <span>display order sparse data
2486: tree</span>, assuming that the row identified in the third argument
1.1 mike 2487: is indeed the anchor row's parent row. The fifth and final argument
2488: must be an array of the identifiers of the columns for which the
2489: user agent is requesting information, in the order they were added
1.80 mike 2490: to the <code>datagrid</code>.</p>
1.1 mike 2491:
1.80 mike 2492: <p>As the <code title="dom-listener-getRows">getRows()</code> method
2493: is invoked, the <span>pending <code>datagrid</code> rows list</span>
1.1 mike 2494: must be updated to include the rows for which information has been
2495: requested, excluding rows for which information is already
1.80 mike 2496: available; and the <span>pending <code>datagrid</code> cells
2497: list</span> must be updated to include the cells for which
1.1 mike 2498: information has been requested on those rows.</p>
2499:
1.80 mike 2500: <p>The <code title="dom-listener-getCells">getCells()</code> method,
1.1 mike 2501: if used, must be invoked with two arguments. The first argument must
1.80 mike 2502: be an array of <code>RowID</code> objects identifying the rows for
1.1 mike 2503: which information is being requested. The second argument must be an
2504: array of the identifiers of the columns for which the user agent is
2505: requesting information, in the order they were added to the
1.80 mike 2506: <code>datagrid</code>.</p>
1.1 mike 2507:
1.80 mike 2508: <p>As the <code title="dom-listener-getCells">getCells()</code>
2509: method is invoked, the <span>pending <code>datagrid</code> cells
2510: list</span> must be updated to include the cells for which
1.1 mike 2511: information has been requested.</p>
2512:
2513: <p>Calls to these methods should be batched so that the rows and
2514: cells to be covered are handled by the fewest number of calls to
2515: these methods as possible. To this end, user agents may invoke the
1.80 mike 2516: <code title="dom-listener-getRows">getRows()</code> method for a set
1.1 mike 2517: of rows that includes some rows that are already in the
1.80 mike 2518: <span>display order sparse data list</span>, and similarly may
2519: invoke the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2520: method with row/column combinations that cover some cells for which
2521: data is already known. Generally, however, user agents should avoid
2522: invoking these methods with arguments that cause information to be
2523: requested when it has already been requested or is already
2524: known.</p>
2525:
2526: <div class="example">
2527:
2528: <p>For example, consider a case represented by the following table,
2529: where the cells marked "Yes" indicate that the data has already
2530: been obtained, the cells marked "Pending" indicate that the data
2531: has been previously requested but not yet obtained, and the cells
2532: with just a dash indicate that no information has ever been
2533: obtained, or any information that had been obtained has now been
2534: discarded.</p>
2535:
1.80 mike 2536: <table>
2537: <tr> <td> <th> Row <th> Column A <th> Column B
2538: <tr> <th> Row 1 <td> - <td> - <td> -
2539: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes
2540: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes
2541: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes
2542: <tr> <th> Row 5 <td> - <td> - <td> -
2543: <tr> <th> Row 6 <td> - <td> - <td> -
2544: <tr> <th> Row 7 <td> Yes <td> Pending <td> -
2545: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending
2546: </table>
2547:
2548: <p>Thus, rows 2, 3, 4, 7, and 8 are already covered, as are the
1.1 mike 2549: cells from those rows except for the cell in column B of row 7.</p>
2550:
2551: <p>Now consider what happens if all of these rows become visible at
2552: once. The user agent has several choices, including (but not
2553: limited to) the following:</p>
2554:
1.80 mike 2555: <ul>
2556:
2557: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2558: method for rows 1 through 8 and columns A and B all at once.</li>
2559:
1.80 mike 2560: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2561: method for row 1, then fire it again for rows 5 through 7.</li>
2562:
1.80 mike 2563: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2564: method for row 1, then fire it again for rows 5 and 6, and then
1.80 mike 2565: fire the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2566: method for row 7 column B.</li>
2567:
1.80 mike 2568: </ul>
2569:
2570: <p>All three options are allowed, but the latter two are preferable
1.1 mike 2571: to the former, as they minimise the amount of redundant information
2572: requested.</p>
2573:
2574: <p>In any case, the data model now looks like this:</p>
2575:
1.80 mike 2576: <table>
2577: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2578: <tr> <th> Row 1 <td> Pending <td> Pending <td> Pending <td> -
2579: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> -
2580: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> -
2581: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> -
2582: <tr> <th> Row 5 <td> Pending <td> Pending <td> Pending <td> -
2583: <tr> <th> Row 6 <td> Pending <td> Pending <td> Pending <td> -
2584: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> -
2585: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> -
2586: </table>
2587:
2588: <p>Now consider the case where a third column, column C, is added
1.1 mike 2589: to the data model. The user agent once again has several choices,
2590: including (but not limited to) the following:</p>
2591:
1.80 mike 2592: <ul>
2593:
2594: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2595: method for rows 1 through 8 again, this time listing just column
2596: C.</li>
2597:
1.80 mike 2598: <li>Fire the <code title="dom-listener-getRows">getRows()</code>
1.1 mike 2599: method for row 1, then fire it again for rows 5 and 6, and then
1.80 mike 2600: fire the <code title="dom-listener-getCells">getCells()</code>
1.1 mike 2601: method for the other rows (in all three cases, listing just column
2602: C).</li>
2603:
1.80 mike 2604: </ul>
2605:
2606: <p>The two options here are as bad as each other; the former
1.1 mike 2607: involves a lot of overlap, but the latter involves a lot of method
2608: calls. Unfortunately the user agent can't do the obvious thing,
1.80 mike 2609: namely just to invoke the <code
2610: title="dom-listener-getCells">getCells()</code> method for all the
1.1 mike 2611: rows listing just column C, because it doesn't have the row
2612: information for all the rows yet (rows 1, 5 and 6 are still
2613: pending).</p>
2614:
2615: <p>In any case, the data model now looks like this:</p>
2616:
1.80 mike 2617: <table>
2618: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2619: <tr> <th> Row 1 <td> Pending <td> Pending <td> Pending <td> Pending
2620: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> Pending
2621: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> Pending
2622: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> Pending
2623: <tr> <th> Row 5 <td> Pending <td> Pending <td> Pending <td> Pending
2624: <tr> <th> Row 6 <td> Pending <td> Pending <td> Pending <td> Pending
2625: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> Pending
2626: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> Pending
2627: </table>
2628:
2629: <p>If at this point the user scrolls around anywhere within this
2630: <code>datagrid</code>, the user agent won't fire the <code
2631: title="dom-listener-getRows">getRows()</code> and <code
2632: title="dom-listener-getCells">getCells()</code> methods, because
1.1 mike 2633: all of the rows and cells are covered.</p>
2634:
2635: <p>Now consider the case where the user agent receives row
2636: information, but no cell information, for rows 1, 5, and 6:</p>
2637:
1.80 mike 2638: <table>
2639: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2640: <tr> <th> Row 1 <td> Yes <td> Pending <td> Pending <td> Pending
2641: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> Pending
2642: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> Pending
2643: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> Pending
2644: <tr> <th> Row 5 <td> Yes <td> Pending <td> Pending <td> Pending
2645: <tr> <th> Row 6 <td> Yes <td> Pending <td> Pending <td> Pending
2646: <tr> <th> Row 7 <td> Yes <td> Pending <td> Pending <td> Pending
2647: <tr> <th> Row 8 <td> Yes <td> Pending <td> Pending <td> Pending
2648: </table>
2649:
2650: <p>The user agent still won't fire any methods when the user
1.1 mike 2651: scrolls, because the data is still covered. But if the script then
1.80 mike 2652: calls the <code title="dom-datagrid-renotify">renotify()</code>
1.1 mike 2653: method, the "Pending" flags would get reset, and the model would
2654: now look like this:</p>
2655:
1.80 mike 2656: <table>
2657: <tr> <td> <th> Row <th> Column A <th> Column B <th> Column C
2658: <tr> <th> Row 1 <td> Yes <td> - <td> - <td> -
2659: <tr> <th> Row 2 <td> Yes <td> Yes <td> Yes <td> -
2660: <tr> <th> Row 3 <td> Yes <td> Yes <td> Yes <td> -
2661: <tr> <th> Row 4 <td> Yes <td> Yes <td> Yes <td> -
2662: <tr> <th> Row 5 <td> Yes <td> - <td> - <td> -
2663: <tr> <th> Row 6 <td> Yes <td> - <td> - <td> -
2664: <tr> <th> Row 7 <td> Yes <td> - <td> - <td> -
2665: <tr> <th> Row 8 <td> Yes <td> - <td> - <td> -
2666: </table>
2667:
2668: <p>Now, assuming that all eight rows and all three columns are
1.1 mike 2669: still visible, the user agent has the following choices (amongst
2670: others):</p>
2671:
1.80 mike 2672: <ul>
2673:
2674: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2675: method for rows 1 through 8, listing all three columns.</li>
2676:
1.80 mike 2677: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2678: method for rows 1 and 5 through 8, listing all three columns, and
2679: then fire the method for rows 2 through 4, listing just column
2680: C.</li>
2681:
1.80 mike 2682: <li>Fire the <code title="dom-listener-getRows">getCells()</code>
1.1 mike 2683: method for rows 1 and 5 through 8, listing just columns A abd B,
2684: and then fire the method for rows 1 through 8, listing just column
2685: C.</li>
2686:
1.80 mike 2687: </ul>
2688:
2689: <p>Here the latter two are preferable because they result in less
1.1 mike 2690: overlap than the first.</p>
2691:
2692: </div>
2693:
1.80 mike 2694: <hr>
2695:
2696: <p>The <span>task source</span> for tasks queued on behalf of a
2697: <code>datagrid</code> is the <span>DOM manipulation task
2698: source</span>.</p>
2699:
2700: </div>
2701:
2702:
2703: <h5>Listening to notifications from the <code>datagrid</code></h5>
1.1 mike 2704:
1.80 mike 2705: <p><i>The conformance criteria in this section apply to any
2706: implementation of the <code>DataGridListener</code> interface,
1.1 mike 2707: including (and most commonly) the content author's
1.80 mike 2708: implementation(s).</i></p>
2709:
2710: <pre class="idl">// To be implemented by Web authors as a JS object
1.81 mike 2711: [NoInterfaceObject]
2712: interface <dfn>DataGridListener</dfn> {
1.80 mike 2713: void <span title="dom-listener-initialize">initialize</span>(in <span>HTMLDataGridElement</span> datagrid);
2714:
2715: 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);
2716: void <span title="dom-listener-getCells">getCells</span>(in <span>RowIDList</span> rows, in <span>ColumnList</span> columns);
2717: void <span title="dom-listener-rowOpened">rowOpened</span>(in <span>RowID</span> row, in boolean rowCountNeeded);
2718: void <span title="dom-listener-rowClosed">rowClosed</span>(in <span>RowID</span> row);
2719:
2720: void <span title="dom-listener-cellChanged">cellChanged</span>(in <span>RowID</span> row, in <span>Column</span> column, in any newValue, in any prevValue);
2721: <span>HTMLMenuElement</span> <span title="dom-listener-getRowMenu">getRowMenu</span>(in <span>RowID</span> row);
2722: <!- -vsDGDND
1.1 mike 2723: boolean <span title="dom-listener-canDrop">canDrop</span>(in <span>RowID</span> row, in <span>RowID</span> position, data);
2724: boolean <span title="dom-listener-dropped">dropped</span>(in <span>RowID</span> row, in <span>RowID</span> position, data);
1.80 mike 2725: - -><!- -v2DGPA
1.1 mike 2726: void <span title="dom-listener-performAction">performAction</span>(in <span>RowID</span> row, in DOMString action);
1.80 mike 2727: - ->};</pre>
2728:
2729: <p>The <code>DataGridListener</code> interface, once implemented by
2730: an object in a script and hooked up to a <code>datagrid</code> using
1.186 mike 2731: the <code title="dom-datagrid-listener">listener</code> IDL
1.80 mike 2732: attribute, receives notifications when the <code>datagrid</code>
2733: needs information (such as which rows exist) for display.</p>
2734:
2735: <p>The following methods may be usefully implemented:</p>
2736:
2737: <dl>
2738:
2739: <dt><dfn title="dom-listener-initialize"><code>initialize(<var title="">datagrid</var>)</code></dfn></dt>
1.1 mike 2740:
2741: <dd>
2742:
1.80 mike 2743: <p>Called by the <code>datagrid</code> element (the one given by
2744: the <var title="">datagrid</var> argument) when the <code
2745: title="dom-datagrid-listener">listener</code> attribute is
1.1 mike 2746: set.</p>
2747:
2748: </dd>
2749:
1.80 mike 2750: <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 2751:
2752: <dd>
2753:
1.80 mike 2754: <p>Called by the <code>datagrid</code> element when the user agent
1.1 mike 2755: finds itself needing to render rows for which it is lacking
2756: information.</p>
2757:
2758: <p>The <var title="">rowIndex</var> argument gives the flattened
2759: index of the first row for which it needs information, ignoring
1.80 mike 2760: the tree structure of the <code>datagrid</code> model, where zero
1.1 mike 2761: is the first row of the entire tree.</p>
2762:
2763: <p>The <var title="">rowCount</var> argument gives the number of
2764: rows for which the user agent would like information.</p>
2765:
2766: <p>The <var title="">parentRow</var> argument gives the
1.80 mike 2767: <code>RowID</code> object identifying the nearest ancestor of the
1.1 mike 2768: first row that the user agent is aware of. After the sort order
2769: has changed, this will typically be the root of the tree
1.80 mike 2770: (identified by a <code>RowID</code> object consisting of an empty
1.1 mike 2771: array).
2772:
1.80 mike 2773: <p>The <var title="">columns</var> argument gives the columns for
1.1 mike 2774: which the user agent is lacking information, as an array of column
1.80 mike 2775: identifiers (as passed to <code
2776: title="dom-datagrid-addColumn">addColumn()</code>).</p>
1.1 mike 2777:
2778: </dd>
2779:
1.80 mike 2780: <dt><dfn title="dom-listener-getCells"><code>getCells(<var title="">rows</var>, <var title="">columns</var>)</code></dfn></dt>
1.1 mike 2781:
2782: <dd>
2783:
1.80 mike 2784: <p>Called by the <code>datagrid</code> element when the user agent
1.1 mike 2785: finds itself needing to render cells for which it is lacking
2786: information in rows that it does know about.</p>
2787:
2788: <p>The <var title="">rows</var> argument gives an array of
1.80 mike 2789: <code>RowID</code> objects identifying the various rows for which
1.1 mike 2790: the user agent is lacking information.</p>
2791:
2792: <p>The <var title="">columns</var> argument gives the columns for
2793: which the user agent is lacking information, as an array of column
1.80 mike 2794: identifiers (as passed to <code
2795: title="dom-datagrid-addColumn">addColumn()</code>).</p>
1.1 mike 2796:
2797: </dd>
2798:
1.80 mike 2799: <dt><dfn title="dom-listener-rowOpened"><code>rowOpened(<var title="">row</var>, <var title="">rowCountNeeded</var>)</code></dfn></dt>
1.1 mike 2800:
2801: <dd>
2802:
1.80 mike 2803: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2804: opened a row.</p>
2805:
2806: <p>The <var title="">row</var> argument gives an
1.80 mike 2807: <code>RowID</code> object identifying the row that was opened.</p>
1.1 mike 2808:
2809: <p>If the user agent also knows how many children that row has,
2810: then the <var title="">rowCountNeeded</var> argument will be
2811: false. Otherwise, the argument will be true, and the row will
1.80 mike 2812: remain closed until the <code
2813: title="dom-datagrid-setRows">setRows()</code> method is called
1.1 mike 2814: with an accurate row count.</p>
2815:
2816: </dd>
2817:
1.80 mike 2818: <dt><dfn title="dom-listener-rowClosed"><code>rowClosed(<var title="">row</var>)</code></dfn></dt>
1.1 mike 2819:
2820: <dd>
2821:
1.80 mike 2822: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2823: opened a row.</p>
2824:
2825: <p>The <var title="">row</var> argument gives an
1.80 mike 2826: <code>RowID</code> object identifying the row that was closed.</p>
1.1 mike 2827:
2828: </dd>
2829:
1.80 mike 2830: <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 2831:
2832: <dd>
2833:
1.80 mike 2834: <p>Called by the <code>datagrid</code> element when the user has
1.1 mike 2835: edited a cell or checked a check box in a cell.</p>
2836:
2837: <p>The <var title="">row</var> argument gives an
1.80 mike 2838: <code>RowID</code> object identifying the row of the cell, and the
1.1 mike 2839: <var title="">column</var> argument gives the identifier of the
2840: cell's column.</p>
2841:
2842: <p>The <var title="">newValue</var> argument gives the new value,
2843: and the <var title="">prevValue</var> argument gives the previous
2844: value.</p>
2845:
2846: </dd>
2847:
1.80 mike 2848: <dt><dfn title="dom-listener-getRowMenu"><code>getRowMenu(<var title="">row</var>)</code></dfn></dt>
1.1 mike 2849:
1.80 mike 2850: <dd>Must return an <code>HTMLMenuElement</code> object that is to
1.1 mike 2851: be used as a context menu for row <var title="">row</var>, or null
2852: if there is no particular context menu. May be omitted if none of
2853: the rows have a special context menu. As this method is called
2854: immediately before showing the menu in question, no precautions
2855: need to be taken if the return value of this method changes.</dd>
2856:
1.80 mike 2857: <!- -v2DGDND, v2DFPA- ->
1.1 mike 2858:
1.80 mike 2859: </dl>
2860:
2861: <div class="impl">
1.1 mike 2862:
1.80 mike 2863: <p>Objects that implement the <code>DataGridListener</code>
1.1 mike 2864: interface may omit any or all of the methods. When a method is
2865: omitted, a user agent intending to call that method must instead
2866: skip the method call, and must assume that the method's return value
2867: is null.</p>
2868:
1.80 mike 2869: </div>
2870:
2871:
2872:
2873: <!- - v2DGS: <datagrid> selection (search for the bits marked "..." to see what needs filling in, at a minimum)
1.1 mike 2874:
2875: <h5>The selection</h5>
2876:
2877: <pre class="idl">interface <dfn>DataGridSelection</dfn> {
2878: readonly attribute unsigned long <span title="dom-DataGridSelection-length">length</span>;
1.81 mike 2879: getter <span>RowID</span> <span title="dom-DataGridSelection-item">item</span>(in unsigned long index);
1.1 mike 2880: boolean <span title="dom-DataGridSelection-isSelected">isSelected</span>(in <span>RowID</span> row);
2881: void <span title="dom-DataGridSelection-setSelected">setSelected</span>(in <span>RowID</span> row, in boolean selected);
2882: void <span title="dom-DataGridSelection-selectAll">selectAll</span>();
2883: void <span title="dom-DataGridSelection-clear">clear</span>();
2884: };</pre>
2885:
2886: <dl class="domintro">
2887:
2888: ...
2889:
2890: </dl>
2891:
2892: <div class="impl">
2893:
2894: <p>Each <code>datagrid</code> element must keep track of which rows
2895: are currently selected. Initially, no rows are selected. This can be
2896: changed using the methods described in this section.</p>
2897:
2898: <p>The selection of a <code>datagrid</code> is represented by its
1.186 mike 2899: <dfn title="dom-datagrid-selection"><code>selection</code></dfn> IDL
1.1 mike 2900: attribute, which must be a <code>DataGridSelection</code> object.</p>
2901:
2902: <p><code>DataGridSelection</code> objects represent the rows in the
2903: selection. In the selection the rows must be ordered in their
2904: natural order (and not, e.g., the display order). A row with an
2905: ancestor that is closed cannot be selected.</p>
2906:
2907: <p>The <dfn
2908: title="dom-DataGridSelection-length"><code>length</code></dfn>
2909: attribute must return the number of rows currently present in the
2910: selection. This is the <var
2911: title="dom-DataGridSelection-length">length</var>.</p>
2912:
2913: <p>The object's <span>indices of the supported indexed
2914: properties</span> are the numbers in the range zero to <span title=""><var
2915: title="dom-DataGridSelection-length">length</var>-1</span>, unless
2916: the <var title="dom-DataGridSelection-length">length</var> is zero,
2917: in which case there are no <span>supported indexed
2918: properties</span>.</p>
2919:
2920: <p>The <dfn title="dom-DataGridSelection-item"><code>item(<var
2921: title="">index</var>)</code></dfn> method must return a
2922: <code>RowID</code> object identifying the <var
2923: title="">index</var>th row in the selection. If the argument is out
2924: of range (less than zero or greater than the number of selected rows
2925: minus one), then it must raise an <code>INDEX_SIZE_ERR</code>
1.98 mike 2926: exception. <a href="#refsDOMCORE">[DOMCORE]</a></p>
1.1 mike 2927:
2928: <p>The <dfn
2929: title="dom-DataGridSelection-isSelected"><code>isSelected()</code></dfn>
2930: method must return the selected state of the row specified by its
2931: argument. If the specified row is in the <span>natural order sparse
2932: data tree</span> and is selected, the method must return true,
2933: otherwise it must return false.</p>
2934:
2935: <p>The <dfn
2936: title="dom-DataGridSelection-setSelected"><code>setSelected()</code></dfn>
2937: method takes two arguments, <var title="">row</var> and <var
2938: title="">selected</var>. When invoked, it must set the selection
2939: state of row <var title="">row</var> to selected if <var
2940: title="">selected</var> is true, and unselected if it is false. If
2941: <var title="">row</var> does not specify a row in the <span>natural
2942: order sparse data tree</span> ...
2943:
2944: <p>The <dfn
2945: title="dom-DataGridSelection-selectAll"><code>selectAll()</code></dfn>
2946: method must ...
2947:
2948: <p>The <dfn
2949: title="dom-DataGridSelection-clear"><code>clear()</code></dfn>
2950: method must mark all the rows in the <code>datagrid</code> as not
2951: selected. After a call to <code
2952: title="dom-DataGridSelection-clear">clear()</code>, the <code
2953: title="dom-DataGridSelection-length">length</code> attribute will
2954: return zero.</p>
2955:
2956: <p>If the <code>datagrid</code> element has a <code
2957: title="attr-datagrid-multiple">multiple</code> attribute, then the
2958: user agent should allow the user to select any number of rows (zero
2959: or more). If the attribute is not present, then the user agent
2960: should allow the user to select a row, and must not allow the user
2961: to select more than a single row at a time; selecting another one
2962: must unselect all the other rows.</p>
2963:
2964: <p class="note">This only applies to the user. Scripts can select
2965: multiple rows even when the <code
2966: title="attr-datagrid-multiple">multiple</code> attribute is
2967: absent.</p>
2968:
2969: ...event on selection change?...
2970:
2971: </div>
2972:
2973: <p class="note">The <code>DataGridSelection</code> interface has no
2974: relation to the <code>Selection</code> interface.</p>
2975:
1.80 mike 2976: - ->
2977:
2978:
2979: <!- -vsDGDND
1.1 mike 2980: <h5>Drag and drop in <code>datagrid</code>s</h5>
2981:
2982: <p><i>This section only applies to interactive user agents.</i></p>
2983:
2984: ...define drag and drop in datagrids; selectiondraggable...
1.80 mike 2985: - ->
2986:
1.729 mike 2987: --><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 2988: <dd><a href="dom.html#metadata-content">Metadata content</a>.</dd>
2989: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
2990: <dd><a href="dom.html#phrasing-content">Phrasing content</a>.</dd>
1.1 mike 2991: <dt>Contexts in which this element may be used:</dt>
1.153 mike 2992: <dd>Where <a href="dom.html#metadata-content">metadata content</a> is expected.</dd>
2993: <dd>Where <a href="dom.html#phrasing-content">phrasing content</a> is expected.</dd>
1.1 mike 2994: <dt>Content model:</dt>
2995: <dd>Empty.</dd>
2996: <dt>Content attributes:</dt>
2997: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
2998: <dd><code title="attr-command-type"><a href="#attr-command-type">type</a></code></dd>
2999: <dd><code title="attr-command-label"><a href="#attr-command-label">label</a></code></dd>
3000: <dd><code title="attr-command-icon"><a href="#attr-command-icon">icon</a></code></dd>
3001: <dd><code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code></dd>
3002: <dd><code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code></dd>
3003: <dd><code title="attr-command-radiogroup"><a href="#attr-command-radiogroup">radiogroup</a></code></dd>
3004: <!--<dd><code title="attr-command-default">default</code></dd>-->
3005: <dd>Also, the <code title="attr-command-title"><a href="#attr-command-title">title</a></code> attribute has special semantics on this element.</dd>
3006: <dt>DOM interface:</dt>
3007: <dd>
3008: <pre class="idl">interface <dfn id="htmlcommandelement">HTMLCommandElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
3009: attribute DOMString <a href="#dom-command-type" title="dom-command-type">type</a>;
3010: attribute DOMString <a href="#dom-command-label" title="dom-command-label">label</a>;
3011: attribute DOMString <a href="#dom-command-icon" title="dom-command-icon">icon</a>;
3012: attribute boolean <a href="#dom-command-disabled" title="dom-command-disabled">disabled</a>;
3013: attribute boolean <a href="#dom-command-checked" title="dom-command-checked">checked</a>;
3014: attribute DOMString <a href="#dom-command-radiogroup" title="dom-command-radiogroup">radiogroup</a>;<!--
3015: attribute boolean <span title="dom-command-default">default</span>;-->
3016: };</pre>
3017: </dd>
3018: </dl><p>The <code><a href="#the-command">command</a></code> element represents a command that the user
1.117 mike 3019: can invoke.</p><p>The <dfn id="attr-command-type" title="attr-command-type"><code>type</code></dfn>
1.1 mike 3020: attribute indicates the kind of command: either a normal command
3021: with an associated action, or a state or option that can be toggled,
1.117 mike 3022: 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 3023: keywords and states. The "<dfn id="attr-command-type-keyword-command" title="attr-command-type-keyword-command"><code>command</code></dfn>"
3024: keyword maps to the <a href="#attr-command-type-state-command" title="attr-command-type-state-command">Command</a> state, the
1.520 mike 3025: "<dfn id="attr-command-type-keyword-checkbox" title="attr-command-type-keyword-checkbox"><code>checkbox</code></dfn>"
1.289 mike 3026: keyword maps to the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state, and
3027: the "<dfn id="attr-command-type-keyword-radio" title="attr-command-type-keyword-radio"><code>radio</code></dfn>"
1.1 mike 3028: keyword maps to the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state. The
1.117 mike 3029: <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 3030:
3031: <dd><p>The element <a href="the-xhtml-syntax.html#represents">represents</a> a normal command with an associated action.</p></dd>
3032:
3033: <dt>The <dfn id="attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</dfn> state</dt>
3034:
3035: <dd><p>The element <a href="the-xhtml-syntax.html#represents">represents</a> a state or option that can be toggled.</p></dd>
3036:
3037: <dt>The <dfn id="attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</dfn> state</dt>
3038:
3039: <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>
3040:
3041: </dl><p>The <dfn id="attr-command-label" title="attr-command-label"><code>label</code></dfn>
1.718 mike 3042: attribute gives the name of the command, as shown to the user. The
3043: <code title="attr-command-label"><a href="#attr-command-label">label</a></code> attribute must be
3044: 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 3045: attribute gives a hint describing the command, which might be shown
1.117 mike 3046: 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 3047: attribute gives a picture that represents the command. If the
3048: attribute is specified, the attribute's value must contain a
1.870 ! mike 3049: <a href="infrastructure.html#valid-non-empty-url">valid non-empty URL</a>. <span class="impl">To obtain the
! 3050: <a href="infrastructure.html#absolute-url">absolute URL</a> of the icon when the attribute's value is
! 3051: not the empty string, the attribute's value must be <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolved</a> relative to the element. When
! 3052: the attribute is absent, or its value is the empty string, or <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> its value fails, there is no
! 3053: icon.</span></p><!-- this is affected by the base URL being
1.1 mike 3054: changed, so users of this should cache the image once they've
1.117 mike 3055: 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 3056: is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a> that, if present, indicates that
1.117 mike 3057: 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 3058: disabled if, in the same context, it could be enabled if only
3059: certain aspects of the situation were changed. A command would be
3060: marked as hidden if, in that situation, the command will never be
3061: enabled. For example, in the context menu for a water faucet, the
3062: command "open" might be disabled if the faucet is already open, but
3063: the command "eat" would be marked hidden since the faucet could
1.117 mike 3064: never be eaten.</p><p>The <dfn id="attr-command-checked" title="attr-command-checked"><code>checked</code></dfn>
1.1 mike 3065: attribute is a <a href="infrastructure.html#boolean-attribute">boolean attribute</a> that, if present,
3066: indicates that the command is selected. The attribute must be
3067: omitted unless the <code title="attr-command-type"><a href="#attr-command-type">type</a></code>
3068: attribute is in either the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state or
3069: the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a>
1.117 mike 3070: state.</p><p>The <dfn id="attr-command-radiogroup" title="attr-command-radiogroup"><code>radiogroup</code></dfn>
1.1 mike 3071: attribute gives the name of the group of commands that will be
3072: 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 3073: 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 3074: <p>If the <code>command</code> element is used when <span
3075: title="menu generation">generating</span> a <span>context
3076: menu</span>, then the <dfn
3077: title="attr-command-default"><code>default</code></dfn> attribute
3078: indicates, if present, that the command is the one that would have
3079: been invoked if the user had directly activated the menu's subject
3080: instead of using its context menu. The <code
3081: title="attr-command-default">default</code> attribute is a
3082: <span>boolean attribute</span>. The attribute must be omitted unless
3083: the <code title="attr-command-type">type</code> attribute is in the
3084: <span title="attr-command-type-state-command">Command</span>
3085: state.</p>
3086:
3087: <div class="example">
3088:
3089: ...an example that shows an element that, if double-clicked,
3090: invokes an action, but that also has a context menu, showing the
3091: various <code>command</code> attributes off, and that has a default
3092: command...
3093:
3094: </div>
1.117 mike 3095: --><div class="impl">
1.1 mike 3096:
3097: <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><!--,
3098: and <dfn title="dom-command-default"><code>default</code></dfn>-->
1.186 mike 3099: IDL attributes must <a href="infrastructure.html#reflect">reflect</a> the respective content
1.1 mike 3100: attributes of the same name.</p>
3101:
1.153 mike 3102: <p>The element's <a href="embedded-content-0.html#activation-behavior">activation behavior</a> depends on the
1.1 mike 3103: value of the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute
3104: of the element, as follows:</p>
3105:
3106: <dl class="switch"><dt>If the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is
3107: in the <a href="#attr-command-type-state-checkbox" title="attr-command-type-state-checkbox">Checkbox</a> state</dt>
3108:
3109: <dd><p>If the element has a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, the UA must
3110: 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
3111: literal value <code title="">checked</code>. The UA must then
1.788 mike 3112: <a href="webappapis.html#fire-a-click-event">fire a <code title="event-click">click</code> event</a> at the
1.1 mike 3113: element.</p></dd>
3114:
3115:
3116: <dt>If the <code title="attr-command-type"><a href="#attr-command-type">type</a></code> attribute is
3117: in the <a href="#attr-command-type-state-radio" title="attr-command-type-state-radio">Radio</a> state</dt>
3118:
3119: <dd><p>If the element has a parent, then the UA must walk the list
3120: of child nodes of that parent element, and for each node that is a
3121: <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
3122: 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
3123: they were the empty string), and has a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute, must remove
3124: that attribute.</p>
3125:
3126: <p>Then, the element's <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code> attribute attribute
3127: must be set to the literal value <code title="">checked</code> and
1.788 mike 3128: the user agent must <a href="webappapis.html#fire-a-click-event">fire a <code title="event-click">click</code>
1.1 mike 3129: event</a> at the element.</p></dd>
3130:
3131:
3132: <dt>Otherwise</dt>
3133:
1.153 mike 3134: <dd><p>The element has no <a href="embedded-content-0.html#activation-behavior">activation behavior</a>.</p></dd>
1.1 mike 3135:
3136: </dl><p class="note">Firing a synthetic <code title="event-click">click</code> event at the element does not cause
3137: any of the actions described above to happen.</p>
3138:
3139: <!-- v2COMMAND: the command="" attribute to make a <command> element
3140: reflect the state of another command, so that the script can update
3141: one place in the page and have context menus, toolbars, shortcuts,
3142: etc, automatically update. Once we add this, expose the Triggers
3143: facet again. -->
3144:
1.117 mike 3145: </div><p class="note"><code><a href="#the-command">command</a></code> elements are not rendered
1.520 mike 3146: unless they <a href="#menus" title="menu">form part of a menu</a>.</p><div class="example">
3147:
3148: <p>Here is an example of a toolbar with three buttons that let the
3149: user toggle between left, center, and right alignment. One could
3150: imagine such a toolbar as part of a text editor. The toolbar also
3151: has a separator followed by another button labeled "Publish",
3152: though that button is disabled.</p>
3153:
3154: <pre><menu type="toolbar">
3155: <command type="radio" radiogroup="alignment" checked="checked"
3156: label="Left" icon="icons/alL.png" onclick="setAlign('left')">
3157: <command type="radio" radiogroup="alignment"
3158: label="Center" icon="icons/alC.png" onclick="setAlign('center')">
3159: <command type="radio" radiogroup="alignment"
3160: label="Right" icon="icons/alR.png" onclick="setAlign('right')">
3161: <hr>
3162: <command type="command" disabled
3163: label="Publish" icon="icons/pub.png" onclick="publish()">
3164: </menu></pre>
3165:
1.729 mike 3166: </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 3167: <dd><a href="dom.html#flow-content">Flow content</a>.</dd>
1.385 mike 3168: <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 3169: <dt>Contexts in which this element may be used:</dt>
1.153 mike 3170: <dd>Where <a href="dom.html#flow-content">flow content</a> is expected.</dd>
1.1 mike 3171: <dt>Content model:</dt>
3172: <dd>Either: Zero or more <code><a href="semantics.html#the-li-element">li</a></code> elements.</dd>
1.153 mike 3173: <dd>Or: <a href="dom.html#flow-content">Flow content</a>.</dd>
1.1 mike 3174: <dt>Content attributes:</dt>
3175: <dd><a href="dom.html#global-attributes">Global attributes</a></dd>
3176: <dd><code title="attr-menu-type"><a href="#attr-menu-type">type</a></code></dd>
3177: <dd><code title="attr-menu-label"><a href="#attr-menu-label">label</a></code></dd>
3178: <dt>DOM interface:</dt>
3179: <dd>
3180: <pre class="idl">interface <dfn id="htmlmenuelement">HTMLMenuElement</dfn> : <a href="dom.html#htmlelement">HTMLElement</a> {
3181: attribute DOMString <a href="#dom-menu-type" title="dom-menu-type">type</a>;
3182: attribute DOMString <a href="#dom-menu-label" title="dom-menu-label">label</a>;
3183: };</pre>
1.117 mike 3184: </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 3185: is an <a href="infrastructure.html#enumerated-attribute">enumerated attribute</a> indicating the kind of menu
3186: being declared. The attribute has three states. The <code title="attr-menu-type-context">context</code> keyword maps to the
3187: <dfn id="context-menu-state" title="context menu state">context menu</dfn> state, in which
3188: the element is declaring a context menu. The <code title="attr-menu-type-toolbar">toolbar</code> keyword maps to the
1.385 mike 3189: <dfn id="toolbar-state" title="toolbar state">toolbar</dfn> state, in which the
3190: element is declaring a toolbar. The attribute may also be
1.1 mike 3191: omitted. The <i>missing value default</i> is the <dfn id="list-state" title="list
3192: state">list</dfn> state, which indicates that the element is merely
3193: a list of commands that is neither declaring a context menu nor
1.385 mike 3194: 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 3195: element <a href="the-xhtml-syntax.html#represents">represents</a> the commands of a context menu, and
3196: the user can only interact with the commands if that context menu is
1.385 mike 3197: 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 3198: <a href="the-xhtml-syntax.html#represents">represents</a> a list of active commands that the user can
1.117 mike 3199: 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 3200: <a href="the-xhtml-syntax.html#represents">represents</a> an unordered list of items (each represented
3201: by an <code><a href="semantics.html#the-li-element">li</a></code> element), each of which represents a command
3202: that the user can perform or activate, or, if the element has no
1.153 mike 3203: <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 3204: describing available commands.</p><p>The <dfn id="attr-menu-label" title="attr-menu-label"><code>label</code></dfn>
1.1 mike 3205: attribute gives the label of the menu. It is used by user agents to
3206: display nested menus in the UI. For example, a context menu
3207: 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 3208: menu label.</p><div class="impl">
1.1 mike 3209:
1.186 mike 3210: <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 3211: <a href="infrastructure.html#reflect">reflect</a> the respective content attributes of the same
3212: name.</p>
3213:
1.729 mike 3214: </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 3215: toolbars.</p><p>For example, the following represents a toolbar with three menu
1.148 mike 3216: buttons on it, each of which has a dropdown menu with a series of
3217: options:</p><pre><menu type="toolbar">
1.1 mike 3218: <li>
3219: <menu label="File">
3220: <button type="button" onclick="fnew()">New...</button>
3221: <button type="button" onclick="fopen()">Open...</button>
1.290 mike 3222: <button type="button" onclick="fsave()">Save</button>
1.1 mike 3223: <button type="button" onclick="fsaveas()">Save as...</button>
3224: </menu>
3225: </li>
3226: <li>
3227: <menu label="Edit">
3228: <button type="button" onclick="ecopy()">Copy</button>
3229: <button type="button" onclick="ecut()">Cut</button>
3230: <button type="button" onclick="epaste()">Paste</button>
3231: </menu>
3232: </li>
3233: <li>
3234: <menu label="Help">
3235: <li><a href="help.html">Help</a></li>
3236: <li><a href="about.html">About</a></li>
3237: </menu>
3238: </li>
1.718 mike 3239: </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 3240: with three items, the first of which has four buttons, the second of
3241: which has three, and the third of which has two nested bullet points
3242: with two items consisting of links.</p><hr><p>The following implements a similar toolbar, with a single button
3243: whose values, when selected, redirect the user to Web sites.</p><pre><form action="redirect.cgi">
3244: <menu type="toolbar">
1.1 mike 3245: <label for="goto">Go to...</label>
3246: <menu label="Go">
1.746 mike 3247: <select id="goto"<!--
1.1 mike 3248: onchange="if (this.options[this.selectedIndex].value)
1.746 mike 3249: window.location = this.options[this.selectedIndex].value"-->>
1.1 mike 3250: <option value="" selected="selected"> Select site: </option>
3251: <option value="http://www.apple.com/"> Apple </option>
3252: <option value="http://www.mozilla.org/"> Mozilla </option>
3253: <option value="http://www.opera.com/"> Opera </option>
3254: </select>
3255: <span><input type="submit" value="Go"></span>
3256: </menu>
3257: </menu>
1.148 mike 3258: </form></pre><p>The behavior in supporting user agents is similar to the example
3259: above, but here the legacy behaviour consists of a single
3260: <code><a href="forms.html#the-select-element">select</a></code> element with a submit button. The submit button
3261: doesn't appear in the toolbar, because it is not a direct child of
3262: the <code><a href="#menus">menu</a></code> element or of its <code><a href="semantics.html#the-li-element">li</a></code>
3263: children.</p><div class="impl">
1.1 mike 3264:
1.729 mike 3265: <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 3266:
1.385 mike 3267: <p>A menu (or toolbar) consists of a list of zero or more of the
1.1 mike 3268: following components:</p>
3269:
3270: <ul class="brief"><li><a href="#concept-command" title="concept-command">Commands</a>, which can be marked as default commands</li>
3271: <li>Separators</li>
3272: <li>Other menus (which allows the list to be nested)</li>
3273: </ul><p>The list corresponding to a particular <code><a href="#menus">menu</a></code> element
3274: is built by iterating over its child nodes. For each child node in
3275: <a href="infrastructure.html#tree-order">tree order</a>, the required behavior depends on what the
3276: node is, as follows:</p>
3277:
3278: <dl class="switch"><dt>An element that <a href="#concept-command" title="concept-command">defines a command</a></dt>
3279:
3280: <dd>Append the command to the menu, respecting its <a href="#concept-facet" title="concept-facet">facets</a><!-- we might need to be
3281: explicit about what this means for each facet, if testing shows
3282: this isn't well-implemented. e.g.: If there's an Icon facet for the
1.408 mike 3283: command, it should be <span title="fetch">fetched</span> (this
3284: would be http-origin privacy-sensitive), and then that image should
3285: be associated with the command, such that each command only has its
3286: image fetched once, to prevent changes to the base URL from having
3287: effects after the image has been fetched once. (no need to resolve
3288: the Icon facet, it's an absolute URL) -->. <!--If the element is a
3289: <code>command</code> element with a <code
3290: title="attr-command-default">default</code> attribute, mark the
3291: command as being a default command.--></dd>
1.1 mike 3292:
3293:
3294: <dt>An <code><a href="semantics.html#the-hr-element">hr</a></code> element</dt>
3295: <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
3296: 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 3297: <code><a href="infrastructure.html#textcontent">textContent</a></code> consists of a string of one or more
1.1 mike 3298: hyphens (U+002D HYPHEN-MINUS)</dt>
3299:
3300: <dd>Append a separator to the menu.</dd>
3301:
3302:
3303: <dt>An <code><a href="semantics.html#the-li-element">li</a></code> element</dt>
3304: <dt>A <code><a href="forms.html#the-label-element">label</a></code> element</dt>
3305:
3306: <dd>Iterate over the children of the element.</dd>
3307:
3308:
3309: <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>
3310: <dt>A <code><a href="forms.html#the-select-element">select</a></code> element</dt>
3311:
3312: <dd>Append a separator to the menu, then iterate over the children
3313: of the <code><a href="#menus">menu</a></code> or <code><a href="forms.html#the-select-element">select</a></code> element, then
3314: append another separator.</dd>
3315:
3316: <!-- v2: we might want to support <select> in <label> as giving a named submenu -->
3317:
3318:
3319: <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>
3320: <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>
3321:
3322: <dd>Append a submenu to the menu, using the value of the element's
3323: <code title="">label</code> attribute as the label of the menu. The
3324: submenu must be constructed by taking the element and creating a
3325: new menu for it using the complete process described in this
3326: section.</dd>
3327:
3328:
3329: <dt>Any other node</dt>
3330:
3331: <dd><a href="infrastructure.html#ignore">Ignore</a> the node.</dd>
3332:
3333: </dl><p>Once all the nodes have been processed as described above, the
3334: user agent must the post-process the menu as follows:</p>
3335:
1.521 mike 3336: <ol><li>Except for separators, any menu item with no label, or whose
3337: label is the empty string, must be removed.</li>
1.1 mike 3338:
1.521 mike 3339: <li>Any sequence of two or more separators in a row must be
3340: collapsed to a single separator.</li>
1.1 mike 3341:
1.521 mike 3342: <li>Any separator at the start or end of the menu must be
3343: removed.</li>
1.1 mike 3344:
1.729 mike 3345: </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 3346: attribute gives the element's <a href="#context-menus" title="context menus">context
3347: menu</a>. The value must be the ID of a <code><a href="#menus">menu</a></code> element
3348: in the DOM. <span class="impl">If the node that would be obtained by
3349: the invoking the <code>getElementById()</code> method using the
3350: attribute's value as the only argument is null or not a
3351: <code><a href="#menus">menu</a></code> element, then the element has no assigned context
3352: menu. Otherwise, the element's assigned context menu is the element
1.117 mike 3353: so identified.</span></p><div class="impl">
1.1 mike 3354:
3355: <p>When an element's context menu is requested (e.g. by the user
3356: right-clicking the element, or pressing a context menu key), the UA
1.788 mike 3357: 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 3358: cancelable at the element for which the menu was requested.</p>
3359:
3360: <p class="note">Typically, therefore, the firing of the <code title="event-contextmenu">contextmenu</code> event will be the
3361: default action of a <code title="mouseup">mouseup</code> or <code title="event-keyup">keyup</code> event. The exact sequence of events
3362: is UA-dependent, as it will vary based on platform conventions.</p>
3363:
3364: <p>The default action of the <code title="event-contextmenu">contextmenu</code> event depends on
3365: whether the element or one of its ancestors has a context menu
3366: assigned (using the <code title="attr-contextmenu"><a href="#attr-contextmenu">contextmenu</a></code> attribute) or not. If
3367: there is no context menu assigned, the default action must be for
3368: the user agent to show its default context menu, if it has one.</p>
3369:
3370: <p>If the element or one of its ancestors <em>does</em> have a
1.788 mike 3371: context menu assigned, then the user agent must <a href="webappapis.html#fire-a-simple-event">fire a simple
1.454 mike 3372: event</a> named <code title="event-show">show</code> at the
1.1 mike 3373: <code><a href="#menus">menu</a></code> element of the context menu of the nearest
3374: ancestor (including the element itself) with one assigned.</p>
3375: <!-- v2: include modifier key information -->
3376:
3377: <p>The default action of <em>this</em> event is that the user agent
1.385 mike 3378: must show a context menu <a href="#building-menus-and-toolbars" title="building menus and
3379: toolbars">built</a> from the <code><a href="#menus">menu</a></code> element.</p>
1.1 mike 3380:
3381: <p>The user agent may also provide access to its default context
3382: menu, if any, with the context menu shown. For example, it could
3383: merge the menu items from the two menus together, or provide the
3384: page's context menu as a submenu of the default menu.</p>
3385:
3386: <p>If the user dismisses the menu without making a selection,
3387: nothing in particular happens.</p>
3388:
1.402 mike 3389: <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 3390: that command's <a href="#command-facet-action" title="command-facet-Action">Action</a>.</p>
3391:
3392: <p>Context menus must not, while being shown, reflect changes in the
1.521 mike 3393: DOM; they are constructed as the default action of the <code title="event-show">show</code> event and must remain as constructed
3394: until dismissed.</p>
1.1 mike 3395:
3396: <p>User agents may provide means for bypassing the context menu
3397: processing model, ensuring that the user can always access the UA's
3398: default context menus. For example, the user agent could handle
3399: right-clicks that have the Shift key depressed in such a way that it
3400: does not fire the <code title="event-contextmenu">contextmenu</code>
3401: event and instead always shows the default context menu.</p>
3402:
3403: <p>The <dfn id="dom-contextmenu" title="dom-contextMenu"><code>contextMenu</code></dfn>
3404: attribute must <a href="infrastructure.html#reflect">reflect</a> the <code title="attr-contextmenu"><a href="#attr-contextmenu">contextmenu</a></code> content attribute.</p>
3405:
1.520 mike 3406: </div><div class="example">
3407:
3408: <p>Here is an example of a context menu for an input control:</p>
3409:
3410: <pre><form name="npc">
3411: <label>Character name: <input name=char type=text contextmenu=namemenu required></label>
3412: <menu type=context id=namemenu>
3413: <command label="Pick random name" onclick="document.forms.npc.elements.char.value = getRandomName()">
3414: <command label="Prefill other fields based on name" onclick="prefillFields(document.forms.npc.elements.char.value)">
3415: </menu>
3416: </form></pre>
3417:
3418: <p>This adds to items to the control's context menu, one called
3419: "Pick random name", and one called "Prefill other fields based on
3420: name". They invoke scripts that are not shown in the example
3421: above.</p>
3422:
1.117 mike 3423: </div><div class="impl">
1.1 mike 3424:
1.729 mike 3425: <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 3426:
1.385 mike 3427: <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
3428: must <a href="#building-menus-and-toolbars" title="building menus and toolbars">build</a> the
1.1 mike 3429: menu for that <code><a href="#menus">menu</a></code> element, and use the result in the
3430: rendering.</p>
3431:
3432: <p>The user agent must reflect changes made to the
1.385 mike 3433: <code><a href="#menus">menu</a></code>'s DOM, by immediately <a href="#building-menus-and-toolbars" title="building menus
3434: and toolbars">rebuilding</a> the menu.</p>
1.1 mike 3435:
1.729 mike 3436: </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 3437: behind menu items, buttons, and links.<!--v2COMMAND: Once a command
3438: is defined, other parts of the interface can refer to the same
3439: command, allowing many access points to a single feature to share
1.117 mike 3440: aspects such as the disabled state.--></p><p id="facets">Commands are defined to have the following
3441: <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 3442:
3443: <dd>The kind of command: "command", meaning it is a normal command;
3444: "radio", meaning that triggering the command will, amongst other
3445: things, set the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked
3446: State</a> to true (and probably uncheck some other commands); or
3447: "checkbox", meaning that triggering the command will, amongst other
3448: things, toggle the value of the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>.</dd>
3449:
3450: <dt><dfn id="command-facet-id" title="command-facet-ID">ID</dfn></dt>
3451:
3452: <dd>The name of the command, for referring to the command from the
3453: markup or from script. If a command has no ID, it is an
3454: <dfn id="anonymous-command">anonymous command</dfn>.</dd>
3455:
3456: <dt><dfn id="command-facet-label" title="command-facet-Label">Label</dfn></dt>
3457:
3458: <dd>The name of the command as seen by the user.</dd>
3459:
3460: <dt><dfn id="command-facet-hint" title="command-facet-Hint">Hint</dfn></dt>
3461:
3462: <dd>A helpful or descriptive string that can be shown to the
3463: user.</dd>
3464:
3465: <dt><dfn id="command-facet-icon" title="command-facet-Icon">Icon</dfn></dt>
3466:
3467: <dd>An <a href="infrastructure.html#absolute-url">absolute URL</a> identifying a graphical image that
3468: represents the action. A command might not have an Icon.</dd> <!--
3469: changing base URLs might change the icon -->
3470:
3471: <dt><dfn id="command-facet-accesskey" title="command-facet-AccessKey">Access Key</dfn></dt>
3472:
3473: <dd>A key combination selected by the user agent that triggers the
3474: command. A command might not have an Access Key.</dd>
3475:
3476: <dt><dfn id="command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</dfn></dt>
3477:
3478: <dd>Whether the command is hidden or not (basically, whether it
3479: should be shown in menus).</dd>
3480:
3481: <dt><dfn id="command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</dfn></dt>
3482:
3483: <dd>Whether the command is relevant and can be triggered or not.</dd>
3484:
3485: <dt><dfn id="command-facet-checkedstate" title="command-facet-CheckedState">Checked State</dfn></dt>
3486:
3487: <dd>Whether the command is checked or not.</dd>
3488:
3489: <dt><dfn id="command-facet-action" title="command-facet-Action">Action</dfn></dt>
3490:
3491: <dd>The actual effect that triggering the command will have. This
3492: could be a scripted event handler, a <a href="infrastructure.html#url">URL</a> to which to
3493: <a href="history.html#navigate">navigate</a>, or a form submission.</dd>
3494:
3495: <!-- v2COMMAND
3496: <dt><dfn title="command-facet-Triggers">Triggers</dfn></dt>
3497:
3498: <dd>The list of elements that can trigger the command. The element
3499: defining a command is always in the list of elements that can
3500: trigger the command. For anonymous commands, only the element
3501: defining the command is on the list, since other elements have no
3502: way to refer to it.</dd>
3503: -->
3504:
3505: </dl><p>These facets are exposed on elements using the <dfn id="command-api">command
1.117 mike 3506: 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 3507:
3508: <dd>
3509:
3510: <p>Exposes the <a href="#command-facet-type" title="command-facet-Type">Type</a> facet of the command.</p>
3511:
3512: </dd>
3513:
3514: <dt><var title="">element</var> . <code title="dom-id"><a href="dom.html#dom-id">id</a></code></dt>
3515:
3516: <dd>
3517:
3518: <p>Exposes the <a href="#command-facet-id" title="command-facet-ID">ID</a> facet of the command.</p>
3519:
3520: </dd>
3521:
3522: <dt><var title="">element</var> . <code title="dom-command-ro-label"><a href="#dom-command-ro-label">label</a></code></dt>
3523:
3524: <dd>
3525:
3526: <p>Exposes the <a href="#command-facet-label" title="command-facet-Label">Label</a> facet of the command.</p>
3527:
3528: </dd>
3529:
3530: <dt><var title="">element</var> . <code title="dom-title"><a href="dom.html#dom-title">title</a></code></dt>
3531:
3532: <dd>
3533:
3534: <p>Exposes the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> facet of the command.</p>
3535:
3536: </dd>
3537:
3538: <dt><var title="">element</var> . <code title="dom-command-ro-icon"><a href="#dom-command-ro-icon">icon</a></code></dt>
3539:
3540: <dd>
3541:
3542: <p>Exposes the <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> facet of the command.</p>
3543:
3544: </dd>
3545:
3546: <dt><var title="">element</var> . <code title="dom-accessKeyLabel"><a href="editing.html#dom-accesskeylabel">accessKeyLabel</a></code></dt>
3547:
3548: <dd>
3549:
3550: <p>Exposes the <a href="#command-facet-accesskey" title="command-facet-AccessKey">Access Key</a> facet of the command.</p>
3551:
3552: </dd>
3553:
3554: <dt><var title="">element</var> . <code title="dom-hidden"><a href="editing.html#dom-hidden">hidden</a></code></dt>
3555:
3556: <dd>
3557:
3558: <p>Exposes the <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a> facet of the command.</p>
3559:
3560: </dd>
3561:
3562: <dt><var title="">element</var> . <code title="dom-command-ro-disabled"><a href="#dom-command-ro-disabled">disabled</a></code></dt>
3563:
3564: <dd>
3565:
3566: <p>Exposes the <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a> facet of the command.</p>
3567:
3568: </dd>
3569:
3570: <dt><var title="">element</var> . <code title="dom-command-ro-checked"><a href="#dom-command-ro-checked">checked</a></code></dt>
3571:
3572: <dd>
3573:
3574: <p>Exposes the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a> facet of the command.</p>
3575:
3576: </dd>
3577:
3578: <dt><var title="">element</var> . <code title="dom-click"><a href="editing.html#dom-click">click</a></code>()</dt>
3579:
3580: <dd>
3581:
3582: <p>Triggers the <a href="#command-facet-action" title="command-facet-Action">Action</a> of the command.</p>
3583:
3584: </dd>
3585:
3586: <!--v2COMMAND
3587: <dt><var title="">element</var> . <code title="dom-command-ro-triggers">triggers</code></dt>
3588:
3589: <dd>
3590:
3591: <p>Exposes the <span title="command-facet-Triggers">Triggers</span> facet of the command.</p>
3592:
3593: </dd>
3594: -->
3595:
3596: </dl><div class="impl">
3597:
3598: <p>The <dfn id="dom-command-ro-commandtype" title="dom-command-ro-commandType"><code>commandType</code></dfn>
3599: 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
3600: element is "command", "radio", or "checked" respectively. If the
3601: element does not define a command, it must return null.</p>
3602:
3603: <p>The <dfn id="dom-command-ro-label" title="dom-command-ro-label"><code>label</code></dfn>
3604: attribute must return the command's <a href="#command-facet-label" title="command-facet-Label">Label</a>, or null if the element
3605: 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 3606: shadowed by the <code title="">label</code> IDL attribute on
1.1 mike 3607: <code><a href="forms.html#the-option-element">option</a></code> and <code><a href="#the-command">command</a></code> elements.</p>
3608:
3609: <p>The <dfn id="dom-command-ro-icon" title="dom-command-ro-icon"><code>icon</code></dfn>
3610: attribute must return the <a href="infrastructure.html#absolute-url">absolute URL</a> of the command's
3611: <a href="#command-facet-icon" title="command-facet-Icon">Icon</a>. If the element does
3612: not specify an icon, or if the element does not define a command,
3613: then the attribute must return null. This attribute will be shadowed
1.186 mike 3614: by the <code title="dom-command-icon"><a href="#dom-command-icon">icon</a></code> IDL attribute on
1.1 mike 3615: <code><a href="#the-command">command</a></code> elements.</p>
3616:
3617: <p>The <dfn id="dom-command-ro-disabled" title="dom-command-ro-disabled"><code>disabled</code></dfn>
3618: attribute must return true if the command's <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a> is that
3619: the command is disabled, and false if the command is not
3620: disabled. This attribute is not affected by the command's <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>. If the
3621: element does not define a command, the attribute must return
1.290 mike 3622: 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 3623: <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>
3624: elements.</p>
3625:
3626: <p>The <dfn id="dom-command-ro-checked" title="dom-command-ro-checked"><code>checked</code></dfn> attribute
3627: must return true if the command's <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a> is that the
3628: command is checked, and false if it is that the command is not
3629: checked. If the element does not define a command, the attribute
1.290 mike 3630: 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 3631: <code><a href="#the-command">command</a></code> elements.</p>
3632:
3633: <!--v2COMMAND
3634: <p>The <dfn
3635: title="dom-command-ro-triggers"><code>triggers</code></dfn>
3636: attribute must return a list containing the elements that can
3637: trigger the command (the command's <span
3638: title="command-facet-Triggers">Triggers</span>). The list must be
3639: <span>live</span>. While the element does not define a command, the
3640: list must be empty.</p>
3641: -->
3642:
3643: <p class="note">The <a href="#command-facet-id" title="command-facet-ID">ID</a> facet
1.665 mike 3644: is exposed by the <code title="dom-id"><a href="dom.html#dom-id">id</a></code> IDL attribute,
1.1 mike 3645: the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> facet is exposed by
1.186 mike 3646: 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
3647: the <code title="dom-accessKeyLabel"><a href="editing.html#dom-accesskeylabel">accessKeyLabel</a></code> IDL
1.1 mike 3648: attribute, and the <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden
1.186 mike 3649: 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 3650:
1.117 mike 3651: </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 3652: <dd>
1.153 mike 3653: <p>Returns an <code><a href="infrastructure.html#htmlcollection">HTMLCollection</a></code> of the elements in the
1.804 mike 3654: <code><a href="infrastructure.html#document">Document</a></code> that define commands and have IDs.</p>
1.1 mike 3655: </dd>
3656:
3657: </dl><div class="impl">
3658:
3659: <p>The <dfn id="dom-document-commands" title="dom-document-commands"><code>commands</code></dfn> attribute
3660: of the document's <code><a href="dom.html#htmldocument">HTMLDocument</a></code> interface must return an
1.804 mike 3661: <code><a href="infrastructure.html#htmlcollection">HTMLCollection</a></code> rooted at the <code><a href="infrastructure.html#document">Document</a></code>
1.1 mike 3662: 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>
3663:
1.117 mike 3664: </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 3665: (visible), e.g. in the user agent's menu bar. User agents are
3666: 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 3667: advertise those keys to the user.</p><div class="impl">
1.1 mike 3668:
1.729 mike 3669: <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 3670:
1.748 mike 3671: <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 3672:
3673: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3674: is "command".</p>
3675:
3676: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3677: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3678: element, if the attribute is present and not empty. Otherwise the
3679: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3680:
3681: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3682: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3683: attribute.</p>
3684:
3685: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3686: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3687: 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>
3688:
3689: <p>The <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> of the command
3690: 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 3691: 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
3692: <code><a href="text-level-semantics.html#the-img-element">img</a></code> element descendant of the element, relative to that
1.1 mike 3693: element, if there is such an element and resolving its attribute is
3694: successful. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
3695:
3696: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3697: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3698: any.</p>
3699:
3700: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3701: 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
3702: otherwise.</p>
3703:
3704: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3705: State</a> facet of the command is always false. (The command is
3706: always enabled.)</p>
3707:
3708: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3709: of the command is always false. (The command is never checked.)</p>
3710:
3711: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.788 mike 3712: 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 3713:
3714:
1.729 mike 3715: <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 3716:
3717: <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>
3718:
3719: <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
3720: determined <a href="#using-the-a-element-to-define-a-command" title="a-command">as for <code>a</code>
3721: elements</a> (see the previous section).</p>
3722:
3723: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3724: 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>
3725:
3726:
1.729 mike 3727: <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 3728:
1.39 mike 3729: <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 3730:
3731: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3732: is "radio" if the <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code>
3733: attribute is in the <code title="attr-input-type-radio"><a href="forms.html#radio-button-state">Radio
3734: 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
3735: "command" otherwise.</p>
3736:
3737: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3738: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3739: element, if the attribute is present and not empty. Otherwise the
3740: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3741:
3742: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3743: depends on the Type of the command:</p>
3744:
3745: <p>If the <a href="#command-facet-type" title="command-facet-Type">Type</a> is "command",
3746: 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
3747: UA-dependent, locale-dependent value that the UA uses to label the
3748: button itself if the attribute is absent.</p>
3749:
3750: <p>Otherwise, the <a href="#command-facet-type" title="command-facet-Type">Type</a> is
3751: "radio" or "checkbox". If the element is a <a href="forms.html#labeled-control">labeled
1.804 mike 3752: control</a>, the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first
1.1 mike 3753: <code><a href="forms.html#the-label-element">label</a></code> element in <a href="infrastructure.html#tree-order">tree order</a> whose
3754: <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
3755: string given by <code><var title="">element</var>.labels[0].textContent</code>). Otherwise,
3756: the value of the <code title="attr-input-value"><a href="forms.html#attr-input-value">value</a></code>
3757: 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>
3758:
3759: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3760: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3761: of the <code><a href="forms.html#the-input-element">input</a></code> element. If the attribute is not present, the
3762: <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> is the empty
3763: string.</p>
3764:
1.39 mike 3765: <p>If the element's <code title="attr-input-type"><a href="forms.html#attr-input-type">type</a></code>
3766: attribute is in the <a href="forms.html#image-button-state" title="attr-input-type-image">Image
1.153 mike 3767: 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 3768: value can be successfully <a href="infrastructure.html#resolve-a-url" title="resolve a
3769: 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
3770: <a href="infrastructure.html#absolute-url">absolute URL</a> obtained from resolving that attribute
3771: that way. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
1.1 mike 3772:
3773: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3774: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3775: any.</p>
3776:
3777: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3778: 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
3779: otherwise.</p>
3780:
3781: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3782: State</a> of the command mirrors the <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a> state of the
3783: control.</p>
3784:
3785: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3786: 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
3787: element is <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checked</a>
3788: attribute, and false otherwise.</p>
3789:
3790: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.153 mike 3791: command, if the element has a defined <a href="embedded-content-0.html#activation-behavior">activation
3792: behavior</a>, is to <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation
1.788 mike 3793: steps</a> on the element. Otherwise, it is just to <a href="webappapis.html#fire-a-click-event">fire a
1.1 mike 3794: <code title="event-click">click</code> event</a> at the
3795: element.</p>
3796:
3797:
1.729 mike 3798: <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 3799:
3800: <p>An <code><a href="forms.html#the-option-element">option</a></code> element with an ancestor
3801: <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
3802: empty string <a href="#concept-command" title="concept-command">defines a
3803: command</a>.</p>
3804:
3805: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3806: is "radio" if the <code><a href="forms.html#the-option-element">option</a></code>'s nearest ancestor
3807: <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
3808: "checkbox" if it does.</p>
3809:
3810: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3811: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3812: element, if the attribute is present and not empty. Otherwise the
3813: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3814:
3815: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3816: 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,
3817: or the value of the <code><a href="forms.html#the-option-element">option</a></code> element's
1.804 mike 3818: <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL attribute if there isn't.</p>
1.1 mike 3819:
3820: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3821: 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
3822: string if the attribute is absent.</p>
3823:
3824: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3825: command.</p>
3826:
3827: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3828: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3829: any.</p>
3830:
3831: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3832: 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
3833: otherwise.</p>
3834:
3835: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3836: State</a> of the command is true (disabled) if the element is
3837: <a href="forms.html#concept-option-disabled" title="concept-option-disabled">disabled</a> or if its
3838: 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
3839: otherwise.</p>
3840:
3841: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3842: 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
3843: false otherwise.</p>
3844:
3845: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
3846: 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>
3847: 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>
3848: element.</p>
3849:
3850:
1.729 mike 3851: <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 3852: a command</h5><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p>
1.1 mike 3853:
3854: <p>A <code><a href="#the-command">command</a></code> element <a href="#concept-command" title="concept-command">defines a command</a>.</p>
3855:
3856: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3857: 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
3858: "<code>radio</code>", "checkbox" if the attribute's value is
3859: "<code>checkbox</code>", and "command" otherwise.</p>
3860:
3861: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3862: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3863: element, if the attribute is present and not empty. Otherwise the
3864: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3865:
3866: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
3867: 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,
3868: or the empty string if it doesn't.</p>
3869:
3870: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3871: 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
3872: empty string if the attribute is absent.</p>
3873:
3874: <p>The <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command
3875: is the <a href="infrastructure.html#absolute-url">absolute URL</a> obtained from <a href="infrastructure.html#resolve-a-url" title="resolve
3876: 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
3877: element, if it has such an attribute and resolving it is
3878: successful. Otherwise, there is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the command.</p>
3879:
3880: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3881: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>, if
3882: any.</p>
3883:
3884: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
3885: 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
3886: otherwise.</p>
3887:
3888: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
3889: State</a> of the command is true (disabled) if the element has a
3890: <code title="attr-command-disabled"><a href="#attr-command-disabled">disabled</a></code> attribute, and
3891: false otherwise.</p>
3892:
3893: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3894: 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
3895: otherwise.</p>
3896:
3897: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.153 mike 3898: command, if the element has a defined <a href="embedded-content-0.html#activation-behavior">activation
3899: behavior</a>, is to <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation
1.788 mike 3900: steps</a> on the element. Otherwise, it is just to <a href="webappapis.html#fire-a-click-event">fire a
1.1 mike 3901: <code title="event-click">click</code> event</a> at the
3902: element.</p>
3903:
3904:
3905:
3906:
3907:
1.729 mike 3908: <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 3909:
3910: <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
3911: key</a> and a <a href="forms.html#labeled-control">labeled control</a> and whose
3912: <a href="forms.html#labeled-control">labeled control</a> <a href="#concept-command" title="concept-command">defines a
3913: command</a>, itself <a href="#concept-command" title="concept-command">defines a
3914: command</a>.</p>
3915:
3916: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3917: is "command".</p>
3918:
3919: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3920: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3921: element, if the attribute is present and not empty. Otherwise the
3922: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3923:
3924: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3925: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3926: attribute.</p>
3927:
3928: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3929: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3930: of the element.</p>
3931:
3932: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3933: command.</p>
3934:
3935: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3936: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
3937:
3938: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>,
3939: <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a>, and
3940: <a href="#command-facet-action" title="command-facet-Action">Action</a> facets of the
3941: command are the same as the respective facets of the element's
3942: <a href="forms.html#labeled-control">labeled control</a>.</p>
3943:
3944: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3945: of the command is always false. (The command is never checked.)</p>
3946:
3947:
3948:
1.729 mike 3949: <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 3950:
1.300 mike 3951: <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 3952: key</a> and is a child of a <code><a href="forms.html#the-fieldset-element">fieldset</a></code> element that
1.300 mike 3953: has a descendant that is not a descendant of the <code><a href="forms.html#the-legend-element">legend</a></code>
1.1 mike 3954: element and is neither a <code><a href="forms.html#the-label-element">label</a></code> element nor a
1.300 mike 3955: <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 3956:
3957: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
3958: is "command".</p>
3959:
3960: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
3961: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
3962: element, if the attribute is present and not empty. Otherwise the
3963: command is an <a href="#anonymous-command">anonymous command</a>.</p>
3964:
3965: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
1.804 mike 3966: is the string given by the element's <code><a href="infrastructure.html#textcontent">textContent</a></code> IDL
1.1 mike 3967: attribute.</p>
3968:
3969: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
3970: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
3971: of the element.</p>
3972:
3973: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
3974: command.</p>
3975:
3976: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
3977: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
3978:
3979: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>,
3980: <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a>, and
3981: <a href="#command-facet-action" title="command-facet-Action">Action</a> facets of the
3982: command are the same as the respective facets of the first element
3983: in <a href="infrastructure.html#tree-order">tree order</a> that is a descendant of the parent of the
1.300 mike 3984: <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
3985: descendant of the <code><a href="forms.html#the-legend-element">legend</a></code> element and is neither a
3986: <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 3987:
3988: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
3989: of the command is always false. (The command is never checked.)</p>
3990:
3991:
3992:
1.729 mike 3993: <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 3994:
1.28 mike 3995: <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>
3996:
3997: <p>If one of the other sections that define elements that <a href="#concept-command" title="concept-command">define commands</a> define that this
3998: element <a href="#concept-command" title="concept-command">defines a command</a>, then
3999: that section applies to this element, and this section does
4000: not. Otherwise, this section applies to that element.</p>
1.1 mike 4001:
4002: <p>The <a href="#command-facet-type" title="command-facet-Type">Type</a> of the command
4003: is "command".</p>
4004:
4005: <p>The <a href="#command-facet-id" title="command-facet-ID">ID</a> of the command is
4006: the value of the <code title="attr-id"><a href="dom.html#the-id-attribute">id</a></code> attribute of the
4007: element, if the attribute is present and not empty. Otherwise the
4008: command is an <a href="#anonymous-command">anonymous command</a>.</p>
4009:
4010: <p>The <a href="#command-facet-label" title="command-facet-Label">Label</a> of the command
4011: depends on the element. If the element is a <a href="forms.html#labeled-control">labeled
1.804 mike 4012: control</a>, the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first
1.1 mike 4013: <code><a href="forms.html#the-label-element">label</a></code> element in <a href="infrastructure.html#tree-order">tree order</a> whose
4014: <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
4015: string given by <code><var title="">element</var>.labels[0].textContent</code>). Otherwise, the
4016: <a href="#command-facet-label" title="command-facet-Label">Label</a> is the
1.804 mike 4017: <code><a href="infrastructure.html#textcontent">textContent</a></code> of the element itself.</p>
1.1 mike 4018:
4019: <p>The <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> of the command
4020: is the value of the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute
4021: 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>
4022:
4023: <p>There is no <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> for the
4024: command.</p>
4025:
4026: <p>The <a href="#command-facet-accesskey" title="command-facet-AccessKey">AccessKey</a> of the
4027: command is the element's <a href="editing.html#assigned-access-key">assigned access key</a>.</p>
4028:
4029: <p>The <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a>
4030: 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
4031: otherwise.</p>
4032:
4033: <p>The <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled
4034: State</a> facet of the command is always false. (The command is
4035: always enabled.)</p>
4036:
4037: <p>The <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>
4038: of the command is always false. (The command is never checked.)</p>
4039:
4040: <p>The <a href="#command-facet-action" title="command-facet-Action">Action</a> of the
1.230 mike 4041: command is to run the following steps:</p>
4042:
4043: <ol><li>If the element is <a href="editing.html#focusable">focusable</a>, run the
4044: <a href="editing.html#focusing-steps">focusing steps</a> for the element.</li>
4045:
4046: <li>If the element has a defined <a href="embedded-content-0.html#activation-behavior">activation behavior</a>,
4047: <a href="embedded-content-0.html#run-synthetic-click-activation-steps">run synthetic click activation steps</a> on the
4048: element.</li>
4049:
4050: <li>Otherwise, if the element does not have a defined
1.788 mike 4051: <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 4052:
1.748 mike 4053: </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>
4054: elements can, in certain situations described in the definitions of
4055: 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>
1.870 ! mike 4056: attribute 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> elements must have
! 4057: a value that is a <a href="infrastructure.html#valid-url">valid URL</a>. This <a href="infrastructure.html#url">URL</a> is
! 4058: the <i>destination resource</i> of the hyperlink.</p><p class="note">The <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code>
! 4059: attribute 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> elements is not
! 4060: required; when 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><p class="note">The <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code>
! 4062: attribute on the <code><a href="semantics.html#the-link-element">link</a></code> element <em>is</em> required (and
! 4063: has to be a <a href="infrastructure.html#valid-non-empty-url">valid <em>non-empty</em> URL</a>), but whether
! 4064: a <code><a href="semantics.html#the-link-element">link</a></code> element represents a hyperlink or not depends on
! 4065: the value of the <code title="attr-link-rel"><a href="semantics.html#attr-link-rel">rel</a></code> attribute of
! 4066: that element.</p><p>The <dfn id="attr-hyperlink-target" title="attr-hyperlink-target"><code>target</code></dfn>
1.748 mike 4067: attribute, if present, must be a <a href="browsers.html#valid-browsing-context-name-or-keyword">valid browsing context name
4068: or keyword</a>. It gives the name of the <a href="browsers.html#browsing-context">browsing
4069: context</a> that will be used. <span class="impl">User agents use
1.869 mike 4070: this name when <a href="#following-hyperlinks">following hyperlinks</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
1.748 mike 4071: hyperlinks, the relationship between the document containing the
4072: hyperlink and the destination resource indicated by the hyperlink is
4073: given by the value of the element's <dfn id="attr-hyperlink-rel" title="attr-hyperlink-rel"><code>rel</code></dfn> attribute, which
4074: 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
4075: below. The <code title="attr-hyperlink-rel"><a href="#attr-hyperlink-rel">rel</a></code> attribute has
4076: no default value. If the attribute is omitted or if none of the
4077: values in the attribute are recognized by the user agent, then the
4078: document has no particular relationship with the destination
4079: 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>
4080: attribute describes for which media the target document was
4081: designed. It is purely advisory. The value must be a <a href="infrastructure.html#valid-media-query">valid
4082: media query</a>. The default, if the <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code> attribute is omitted, is
4083: "<code title="">all</code>".</p><p>The <dfn id="attr-hyperlink-hreflang" title="attr-hyperlink-hreflang"><code>hreflang</code></dfn>
4084: attribute on hyperlink elements, if present, gives the language of
4085: the linked resource. It is purely advisory. The value must be a
4086: valid BCP 47 language code. <a href="references.html#refsBCP47">[BCP47]</a>
4087: <span class="impl">User agents must not consider this attribute
4088: authoritative — upon fetching the resource, user agents must
4089: use only language information associated with the resource to
4090: determine its language, not metadata included in the link to the
4091: resource.</span></p><p>The <dfn id="attr-hyperlink-type" title="attr-hyperlink-type"><code>type</code></dfn>
4092: attribute, if present, gives the <a href="infrastructure.html#mime-type">MIME type</a> of the
4093: linked resource. It is purely advisory. The value must be a
4094: <a href="infrastructure.html#valid-mime-type">valid MIME type</a>. <span class="impl">User agents must
4095: not consider the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4096: attribute authoritative — upon fetching the resource, user
4097: agents must not use metadata included in the link to the resource to
4098: determine its type.</span></p><div class="impl">
4099:
4100: <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>
4101:
4102: <p>When a user <em>follows a hyperlink</em>, the user agent must
4103: <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolve</a> the <a href="infrastructure.html#url">URL</a>
4104: given by the <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code> attribute
4105: of that hyperlink, relative to the hyperlink element, and if that is
4106: successful, must <a href="history.html#navigate">navigate</a> a <a href="browsers.html#browsing-context">browsing
4107: context</a> to the resulting <a href="infrastructure.html#absolute-url">absolute URL</a>. In the
4108: case of server-side image maps, the URL of the hyperlink must
4109: further have its <var><a href="text-level-semantics.html#hyperlink-suffix">hyperlink suffix</a></var> appended to it.</p>
4110:
4111: <p>If <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the
4112: <a href="infrastructure.html#url">URL</a> fails, the user agent may report the error to the
4113: user in a user-agent-specific manner, may navigate to an error page
4114: to report the error, or may ignore the error and do nothing.</p>
4115:
4116: <p>If the user indicated a specific <a href="browsers.html#browsing-context">browsing context</a>
4117: when following the hyperlink, or if the user agent is configured to
4118: follow hyperlinks by navigating a particular browsing context, then
4119: that must be the <a href="browsers.html#browsing-context">browsing context</a> that is
4120: navigated.</p>
4121:
4122: <p>Otherwise, if the hyperlink element is an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or
4123: <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
4124: <a href="browsers.html#browsing-context">browsing context</a> that is navigated must be chosen by
4125: 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
4126: 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
4127: browsing context name. If these rules result in the creation of a
4128: new <a href="browsers.html#browsing-context">browsing context</a>, it must be navigated with
4129: <a href="history.html#replacement-enabled">replacement enabled</a>.</p>
4130:
4131: <p>Otherwise, if the hyperlink element is a <a href="#rel-sidebar-hyperlink" title="rel-sidebar-hyperlink">sidebar hyperlink</a> and the user
4132: agent implements a feature that can be considered a secondary
4133: browsing context, such a secondary browsing context may be selected
4134: as the browsing context to be navigated.</p>
4135:
4136: <p>Otherwise, if the hyperlink element is an <code><a href="text-level-semantics.html#the-a-element">a</a></code> or
4137: <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
4138: the child nodes of <a href="dom.html#the-head-element">the <code>head</code> element</a> is a
4139: <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
4140: 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
4141: for choosing a browsing context given a browsing context name</a>,
4142: using the value of the <code title="attr-base-target"><a href="semantics.html#attr-base-target">target</a></code>
4143: attribute of the first such <code><a href="semantics.html#the-base-element">base</a></code> element as the
4144: browsing context name. If these rules result in the creation of a
4145: new <a href="browsers.html#browsing-context">browsing context</a>, it must be navigated with
4146: <a href="history.html#replacement-enabled">replacement enabled</a>.</p>
4147:
4148: <p>Otherwise, the browsing context that must be navigated is the
4149: same browsing context as the one which the hyperlink element itself
4150: is in.</p>
4151:
4152: <p>The navigation must be done with the <a href="browsers.html#browsing-context">browsing
1.804 mike 4153: context</a> that contains the <code><a href="infrastructure.html#document">Document</a></code> object with
1.748 mike 4154: which the hyperlink's element in question is associated as the
4155: <a href="history.html#source-browsing-context">source browsing context</a>.</p>
4156:
1.869 mike 4157: </div><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
1.748 mike 4158: this specification. This table is non-normative; the actual
4159: definitions for the link types are given in the next few
4160: sections.</p><p>In this section, the term <i>referenced document</i> refers to
4161: the resource identified by the element representing the link, and
4162: the term <i>current document</i> refers to the resource within
4163: which the element representing the link finds itself.</p><div class="impl">
4164:
4165: <p>To determine which link types apply to a <code><a href="semantics.html#the-link-element">link</a></code>,
4166: <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
4167: spaces">split on spaces</a>. The resulting tokens are the link
4168: types that apply to that element.</p>
4169:
4170: </div><p>Except where otherwise specified, a keyword must not be specified
4171: more than once per <code title="attr-rel-hyperlink">rel</code>
4172: attribute.</p><p>The link types that contain no U+003A COLON characters (:),
4173: including all those defined in this specification, are <a href="infrastructure.html#ascii-case-insensitive">ASCII
4174: case-insensitive</a> values<span class="impl">, and must be
4175: compared as such</span>.</p><p class="example">Thus, <code title="">rel="next"</code> is the
4176: same as <code title="">rel="NEXT"</code>.</p><table><thead><tr><th rowspan="2">Link type</th>
4177: <th colspan="2">Effect on...</th>
4178: <th rowspan="2">Brief description</th>
4179: </tr><tr><th><code><a href="semantics.html#the-link-element">link</a></code></th>
4180: <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>
4181: </tr></thead><tbody><tr><td><code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code></td> <!-- second most used <link rel> value -->
4182: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4183: <td><a href="#hyperlink">Hyperlink</a></td>
4184: <td>Gives alternate representations of the current document.</td>
4185: </tr><tr><td><code title="rel-archives"><a href="#link-type-archives">archives</a></code></td>
4186: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4187: <td><a href="#hyperlink">Hyperlink</a></td>
4188: <td>Provides a link to a collection of records, documents, or other materials of historical interest.</td>
4189: </tr><tr><td><code title="rel-author"><a href="#link-type-author">author</a></code></td>
4190: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4191: <td><a href="#hyperlink">Hyperlink</a></td>
4192: <td>Gives a link to the current document's author.</td>
4193: </tr><tr><td><code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code></td> <!-- fourth most used <a rel> value -->
4194: <td><em>not allowed</em></td>
4195: <td><a href="#hyperlink">Hyperlink</a></td>
4196: <td>Gives the permalink for the nearest ancestor section.</td>
4197: </tr><!-- (commented out on the assumption that rel=contact is really XFN)
4198: <tr>
4199: <td><code title="rel-contact">contact</code></td> <!- 8th most used <a rel> value ->
4200: <td><span title="hyperlink link">Hyperlink</span></td>
4201: <td><span>Hyperlink</span></td>
4202: <td>Gives a link to contact information for the current document.</td>
4203: </tr>
4204: --><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") -->
4205: <td><em>not allowed</em></td>
4206: <td><a href="#hyperlink">Hyperlink</a></td>
4207: <td>Indicates that the referenced document is not part of the same site as the current document.</td>
4208: </tr><tr><td><code title="rel-first"><a href="#link-type-first">first</a></code></td>
4209: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4210: <td><a href="#hyperlink">Hyperlink</a></td>
4211: <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>
4212: </tr><tr><td><code title="rel-help"><a href="#link-type-help">help</a></code></td>
4213: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4214: <td><a href="#hyperlink">Hyperlink</a></td>
4215: <td>Provides a link to context-sensitive help.</td>
4216: </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 -->
4217: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4218: <td><em>not allowed</em></td>
4219: <td>Imports an icon to represent the current document.</td>
4220: </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) -->
4221: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4222: <td><a href="#hyperlink">Hyperlink</a></td>
4223: <td>Gives a link to the document that provides a table of contents or index listing the current document.</td>
4224: </tr><tr><td><code title="rel-last"><a href="#link-type-last">last</a></code></td>
4225: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4226: <td><a href="#hyperlink">Hyperlink</a></td>
4227: <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>
4228: </tr><tr><td><code title="rel-license"><a href="#link-type-license">license</a></code></td> <!-- seventh most used <a rel> value -->
4229: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4230: <td><a href="#hyperlink">Hyperlink</a></td>
4231: <td>Indicates that the main content of the current document is covered by the copyright license described by the referenced document.</td>
4232: </tr><tr><td><code title="rel-next"><a href="#link-type-next">next</a></code></td>
4233: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4234: <td><a href="#hyperlink">Hyperlink</a></td>
4235: <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>
4236: </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") -->
4237: <td><em>not allowed</em></td>
4238: <td><a href="#hyperlink">Hyperlink</a></td>
4239: <td>Indicates that the current document's original author or publisher does not endorse the referenced document.</td>
4240: </tr><tr><td><code title="rel-noreferrer"><a href="#link-type-noreferrer">noreferrer</a></code></td>
4241: <td><em>not allowed</em></td>
4242: <td><a href="#hyperlink">Hyperlink</a></td>
4243: <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>
4244: </tr><tr><td><code title="rel-pingback"><a href="#link-type-pingback">pingback</a></code></td>
4245: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4246: <td><em>not allowed</em></td>
4247: <td>Gives the address of the pingback server that handles pingbacks to the current document.</td>
4248: </tr><tr><td><code title="rel-prefetch"><a href="#link-type-prefetch">prefetch</a></code></td>
4249: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4250: <td><em>not allowed</em></td>
4251: <td>Specifies that the target resource should be preemptively cached.</td>
4252: </tr><tr><td><code title="rel-prev"><a href="#link-type-prev">prev</a></code></td> <!-- prev is used more than previous -->
4253: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4254: <td><a href="#hyperlink">Hyperlink</a></td>
4255: <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>
4256: </tr><tr><td><code title="rel-search"><a href="#link-type-search">search</a></code></td> <!-- used quite a bit -->
4257: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4258: <td><a href="#hyperlink">Hyperlink</a></td>
4259: <td>Gives a link to a resource that can be used to search through the current document and its related pages.</td>
4260: </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... -->
4261: <td><a href="semantics.html#external-resource-link" title="external resource link">External Resource</a></td>
4262: <td><em>not allowed</em></td>
4263: <td>Imports a stylesheet.</td>
4264: </tr><tr><td><code title="rel-sidebar"><a href="#link-type-sidebar">sidebar</a></code></td> <!-- used quite a bit -->
4265: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4266: <td><a href="#hyperlink">Hyperlink</a></td>
4267: <td>Specifies that the referenced document, if retrieved, is intended to be shown in the browser's sidebar (if it has one).</td>
4268: </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"). -->
4269: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4270: <td><a href="#hyperlink">Hyperlink</a></td>
4271: <td>Gives a tag (identified by the given address) that applies to the current document.</td>
4272: </tr><tr><td><code title="rel-up"><a href="#link-type-up">up</a></code></td>
4273: <td><a href="semantics.html#hyperlink-link" title="hyperlink link">Hyperlink</a></td>
4274: <td><a href="#hyperlink">Hyperlink</a></td>
4275: <td>Provides a link to a document giving the context for the current document.</td>
4276: </tr></tbody></table><div class="impl">
4277:
4278: <p>Some of the types described below list synonyms for these
4279: values. These <!--<span class="impl">-->are to be handled as
4280: specified by user agents, but<!--</span>--> must not be used in
4281: documents.</p>
4282:
4283: </div><!-- v2 ideas:
4284: * rel="script"
4285: * rel="related" // see also
4286: * http://microformats.org/wiki/rel-enclosure
4287: --><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
4288: 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>
4289: 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
4290: keyword <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code>, it creates a
4291: <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink</a>; but if it
4292: <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
4293: meaning of the <code title="rel-stylesheet"><a href="#link-type-stylesheet">stylesheet</a></code>
4294: keyword in the way described for that keyword, and the rest of this
4295: subsection doesn't apply.</p><p>The <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword
4296: indicates that the referenced document is an alternate
4297: 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
4298: used with the <code title="attr-hyperlink-media"><a href="#attr-hyperlink-media">media</a></code>
4299: attribute, it indicates that the referenced document is intended for
4300: use with the media specified.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4301: used with the <code title="attr-hyperlink-hreflang"><a href="#attr-hyperlink-hreflang">hreflang</a></code>
4302: attribute, and that attribute's value differs from the <a href="infrastructure.html#root-element">root
4303: element</a>'s <a href="dom.html#language">language</a>, it indicates that the
4304: referenced document is a translation.</p><p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4305: used with the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4306: attribute, it indicates that the referenced document is a
4307: 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
4308: when specified with the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code>
4309: keyword.</p><div class="example">
4310:
4311: <p>For example, the following link is a French translation that
4312: uses the PDF format:</p>
4313:
4314: <pre><link rel=alternate type=application/pdf hreflang=fr href=manual-fr></pre>
4315:
4316: </div><div class="impl">
4317:
4318: <p>If the <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> keyword is
4319: used with the <code title="attr-hyperlink-type"><a href="#attr-hyperlink-type">type</a></code>
4320: attribute set to the value <code title="">application/rss+xml</code>
4321: or the value <code title="">application/atom+xml</code>, then it
4322: indicates that the referenced document is a syndication feed (though
4323: not necessarily syndicating exactly the same content as the current
4324: page).</p>
4325:
4326: <div class="impl">
4327:
4328: <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>
4329: 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
4330: <code title="">application/rss+xml</code> or the value <code title="">application/atom+xml</code> must be treated as the default
4331: syndication feed for the purposes of feed autodiscovery.</p>
4332:
4333: <div class="example">
4334: <p>The following <code><a href="semantics.html#the-link-element">link</a></code> element gives the syndication
4335: feed for the current page:</p>
4336: <pre><link rel="alternate" type="application/atom+xml" href="data.xml"></pre>
4337: <p>The following extract offers various different syndication
4338: feeds:</p>
4339: <pre><p>You can access the planets database using Atom feeds:</p>
4340: <ul>
4341: <li><a href="recently-visited-planets.xml" rel="alternate" type="application/atom+xml">Recently Visited Planets</a></li>
4342: <li><a href="known-bad-planets.xml" rel="alternate" type="application/atom+xml">Known Bad Planets</a></li>
4343: <li><a href="unexplored-planets.xml" rel="alternate" type="application/atom+xml">Unexplored Planets</a></li>
4344: </ul></pre>
4345: </div>
4346:
4347: </div>
4348:
4349:
4350:
4351:
4352: </div><p>The <code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code> link
4353: relationship is transitive — that is, if a document links to
4354: two other documents with the link type "<code title="rel-alternate"><a href="#link-type-alternate">alternate</a></code>", then, in addition to
4355: implying that those documents are alternative representations of the
4356: first document, it is also implying that those two documents are
4357: 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
4358: 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>
4359: 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
4360: that the referenced document describes a collection of records,
4361: documents, or other materials of historical interest.</p><p class="example">A blog's index page could link to an index of the
4362: blog's past posts with <code title="">rel="archives"</code>.</p><div class="impl">
4363:
4364: <p><strong>Synonyms</strong>: For historical reasons, user agents
4365: must also treat the keyword "<code title="">archive</code>" like the
4366: <code title="rel-archives"><a href="#link-type-archives">archives</a></code> keyword.</p>
4367:
4368: </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
4369: 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>
4370: 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
4371: referenced document provides further information about the author of
4372: the nearest <code><a href="semantics.html#the-article-element">article</a></code> element ancestor of the element
4373: defining the hyperlink, if there is one, or of the page as a whole,
4374: 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
4375: referenced document provides further information about the author
4376: for the page as a whole.</p><p class="note">The "referenced document" can be, and often is, a
4377: <code title="">mailto:</code> URL giving the e-mail address of the
4378: author. <a href="references.html#refsMAILTO">[MAILTO]</a></p><div class="impl">
4379:
4380: <p><strong>Synonyms</strong>: For historical reasons, user agents
4381: 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
4382: <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements that have a <code title="">rev</code>
4383: 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
4384: relationship.</p>
4385:
4386: </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
4387: 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
4388: permalink for the nearest ancestor <code><a href="semantics.html#the-article-element">article</a></code> element of
4389: the linking element in question, or of <a href="semantics.html#associatedSection">the section the linking element is most
4390: closely associated with</a>, if there are no ancestor
4391: <code><a href="semantics.html#the-article-element">article</a></code> elements.</p><div class="example">
4392: <p>The following snippet has three permalinks. A user agent could
4393: determine which permalink applies to which part of the spec by
4394: looking at where the permalinks are given.</p>
4395: <pre> ...
4396: <body>
4397: <h1>Example of permalinks</h1>
4398: <div id="a">
4399: <h2>First example</h2>
4400: <p><a href="a.html" rel="bookmark">This</a> permalink applies to
4401: only the content from the first H2 to the second H2. The DIV isn't
4402: exactly that section, but it roughly corresponds to it.</p>
4403: </div>
4404: <h2>Second example</h2>
4405: <article id="b">
4406: <p><a href="b.html" rel="bookmark">This</a> permalink applies to
4407: the outer ARTICLE element (which could be, e.g., a blog post).</p>
4408: <article id="c">
4409: <p><a href="c.html" rel="bookmark">This</a> permalink applies to
4410: the inner ARTICLE element (which could be, e.g., a blog comment).</p>
4411: </article>
4412: </article>
4413: </body>
4414: ...</pre>
4415: </div><!-- (commented out on the assumption that rel=contact is really XFN)
4416: <h5>Link type "<dfn title="rel-contact"><code>contact</code></dfn>"</h5>
4417:
4418: <p>The <code title="rel-contact">contact</code> keyword may be used
4419: with <code>link</code>, <code>a</code>, and <code>area</code>
4420: elements. For <code>link</code> elements, it creates a <span
4421: title="hyperlink link">hyperlink</span>.</p>
4422:
4423: <p>For <code>a</code> and <code>area</code> elements, the <code
4424: title="rel-contact">contact</code> keyword indicates that the
4425: referenced document provides further contact information for the
4426: author of the nearest <code>article</code> element ancestor of the
4427: element defining the hyperlink, if there is one, or of the page as a
4428: whole, otherwise.</p>
4429:
4430: <div class="impl">
4431:
4432: <p>User agents must treat any hyperlink in an <code>address</code>
4433: element as having the <code title="rel-contact">contact</code> link
4434: type specified.</p>
4435:
4436: </div>
4437:
4438: <p>For <code>link</code> elements, the <code
4439: title="rel-contact">contact</code> keyword indicates that the
4440: referenced document provides further contact information for the
4441: page as a whole.</p>
4442: --><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
4443: 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
4444: that the link is leading to a document that is not part of the site
4445: 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
4446: <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>
4447: 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
4448: document provides further help information for the parent of the
4449: element defining the hyperlink, and its children.</p><div class="example">
4450:
4451: <p>In the following example, the form control has associated
4452: context-sensitive help. The user agent could use this information,
4453: for example, displaying the referenced document if the user presses
4454: the "Help" or "F1" key.</p>
4455:
4456: <pre> <p><label> Topic: <input name=topic> <a href="help/topic.html" rel="help">(Help)</a></label></p></pre>
4457:
4458: </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
4459: 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
4460: <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">
4461:
4462: <p>The specified resource is an icon representing the page or site,
4463: and should be used by the user agent when representing the page in
4464: the user interface.</p>
4465:
4466: </div><p>Icons could be auditory icons, visual icons, or other kinds of
4467: icons. <span class="impl">If multiple icons are provided, the user
4468: 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
4469: multiple equally appropriate icons, user agents must use the last
4470: one declared in <a href="infrastructure.html#tree-order">tree order</a>. If the user agent tries to
4471: use an icon but that icon is determined, upon closer examination, to
4472: in fact be inappropriate (e.g. because it uses an unsupported
4473: format), then the user agent must try the next-most-appropriate icon
4474: as determined by the attributes.</span></p><div class="impl">
4475:
4476: <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
4477: <a href="semantics.html#concept-link-type-sniffing">determining the type of the
4478: resource</a>, user agents must expect the resource to be an image.</p>
4479:
4480: </div><p>The <dfn id="attr-link-sizes" title="attr-link-sizes"><code>sizes</code></dfn>
4481: attribute gives the sizes of icons for visual media.</p><p>If specified, the attribute must have a value that is an
4482: <a href="infrastructure.html#unordered-set-of-unique-space-separated-tokens">unordered set of unique space-separated tokens</a>. The
4483: 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
4484: two <a href="infrastructure.html#valid-non-negative-integer" title="valid non-negative integer">valid non-negative
4485: integers</a> that do not have a leading U+0030 DIGIT ZERO (0)
4486: character and that are separated by a single U+0078 LATIN SMALL
4487: LETTER X character (x).</p><p>The keywords represent icon sizes.</p><div class="impl">
4488:
4489: <p>To parse and process the attribute's value, the user agent must
4490: first <a href="infrastructure.html#split-a-string-on-spaces" title="split a string on spaces">split the attribute's
4491: value on spaces</a>, and must then parse each resulting keyword
4492: to determine what it represents.</p>
4493:
4494: </div><p>The <dfn id="attr-link-sizes-any" title="attr-link-sizes-any"><code>any</code></dfn> keyword
4495: represents that the resource contains a scalable icon, e.g. as
4496: provided by an SVG image.</p><div class="impl">
4497:
4498: <p>Other keywords must be further parsed as follows to determine
4499: what they represent:</p>
4500:
4501: <ul><li><p>If the keyword doesn't contain exactly one U+0078 LATIN
4502: SMALL LETTER X character (x), then this keyword doesn't represent
4503: anything. Abort these steps for that keyword.</p></li>
4504:
4505: <li><p>Let <var title="">width string</var> be the string before
4506: the "<code title="">x</code>".</p></li>
4507:
4508: <li><p>Let <var title="">height string</var> be the string after the
4509: "<code title="">x</code>".</p></li>
4510:
4511: <li><p>If either <var title="">width string</var> or <var title="">height string</var> start with a U+0030 DIGIT ZERO (0)
4512: character or contain any characters other than characters in the
4513: range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then this
4514: keyword doesn't represent anything. Abort these steps for that
4515: keyword.</p></li>
4516:
4517: <li><p>Apply the <a href="infrastructure.html#rules-for-parsing-non-negative-integers">rules for parsing non-negative
4518: integers</a> to <var title="">width string</var> to obtain <var title="">width</var>.</p></li>
4519:
4520: <li><p>Apply the <a href="infrastructure.html#rules-for-parsing-non-negative-integers">rules for parsing non-negative
4521: integers</a> to <var title="">height string</var> to obtain <var title="">height</var>.</p></li>
4522:
4523: <li><p>The keyword represents that the resource contains a bitmap
4524: icon with a width of <var title="">width</var> device pixels and a
4525: height of <var title="">height</var> device pixels.</p></li>
4526:
4527: </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
4528: icon sizes that are not actually available in the linked
4529: resource.</p><div class="impl">
4530:
4531: <p>If the attribute is not specified, then the user agent must
4532: assume that the given icon is appropriate, but less appropriate than
4533: an icon of a known and appropriate size.</p>
4534:
4535: </div><div class="example">
4536:
4537: <p>The following snippet shows the top part of an application with
4538: several icons.</p>
4539:
4540: <pre><!DOCTYPE HTML>
4541: <html>
4542: <head>
4543: <title>lsForums — Inbox</title>
4544: <link rel=icon href=favicon.png sizes="16x16" type="image/png">
4545: <link rel=icon href=windows.ico sizes="32x32 48x48" type="image/vnd.microsoft.icon">
4546: <link rel=icon href=mac.icns sizes="128x128 512x512 8192x8192 32768x32768">
4547: <link rel=icon href=iphone.png sizes="59x60" type="image/png">
4548: <link rel=icon href=gnome.svg sizes="any" type="image/svg+xml">
4549: <link rel=stylesheet href=lsforums.css>
4550: <script src=lsforums.js></script>
4551: <meta name=application-name content="lsForums">
4552: </head>
4553: <body>
4554: ...</pre>
4555:
4556: </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
4557: 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>
4558: 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
4559: that the referenced document provides the copyright license terms
4560: under which the main content of the current document is
4561: provided.</p><p>This specification does not specify how to distinguish between
4562: the main content of a document and content that is not deemed to be
4563: part of that main content. The distinction should be made clear to
4564: the user.</p><div class="example">
4565:
4566: <p>Consider a photo sharing site. A page on that site might
4567: describe and show a photograph, and the page might be marked up as
4568: follows:</p>
4569:
4570: <pre><!DOCTYPE HTML>
4571: <html>
4572: <head>
4573: <title>Exampl Pictures: Kissat</title>
4574: <link rel="stylesheet" href="/style/default">
4575: </head>
4576: <body>
4577: <h1>Kissat</h1>
4578: <nav>
4579: <a href="../">Return to photo index</a>
4580: </nav>
4581: <figure>
4582: <img src="/pix/39627052_fd8dcd98b5.jpg">
4583: <figcaption>Kissat</figcaption>
4584: </figure>
4585: <p>One of them has six toes!</p>
4586: <p><small><a rel="license" href="http://www.opensource.org/licenses/mit-license.php">MIT Licensed</a></small></p>
4587: <footer>
4588: <a href="/">Home</a> | <a href="../">Photo index</a>
4589: <p><small>© copyright 2009 Exampl Pictures. All Rights Reserved.</small></p>
4590: </footer>
4591: </body>
4592: </html></pre>
4593:
4594: <p>In this case the <code title="rel-license"><a href="#link-type-license">license</a></code>
4595: applies to just the photo (the main content of the document), not
4596: the whole document. In particular not the design of the page
4597: itself, which is covered by the copyright given at the bottom of
4598: the document. This could be made clearer in the styling
4599: (e.g. making the license link prominently positioned near the
4600: photograph, while having the page copyright in light small text at
4601: the foot of the page.</p>
4602:
4603: </div><div class="impl">
4604:
4605: <p><strong>Synonyms</strong>: For historical reasons, user agents
4606: must also treat the keyword "<code title="">copyright</code>" like
4607: the <code title="rel-license"><a href="#link-type-license">license</a></code> keyword.</p>
4608:
4609: </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
4610: 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
4611: that the link is not endorsed by the original author or publisher of
4612: the page, or that the link to the referenced document was included
4613: primarily because of a commercial relationship between people
4614: 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
4615: 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
4616: following the link.</p><div class="impl">
4617:
4618: <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
4619: <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
4620: must not include a <code title="http-referer">Referer</code> (sic)
4621: HTTP header (<a href="infrastructure.html#concept-http-equivalent-headers" title="concept-http-equivalent-headers">or
4622: equivalent</a> for other protocols) in the request.</p>
4623:
4624: <p>This keyword also <a href="browsers.html#noopener">causes the <code title="dom-opener">opener</code> attribute to remain null</a> if the
4625: hyperlink creates a new <a href="browsers.html#browsing-context">browsing context</a>.</p>
4626:
4627: </div><!-- v2: Would be nice to apply this to other elements too,
4628: 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
4629: 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
4630: 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
4631: 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
4632: that preemptively fetching and caching the specified resource is
4633: likely to be beneficial, as it is highly likely that the user will
4634: 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
4635: 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>
4636: 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
4637: the referenced document provides an interface specifically for
4638: searching the document and its related resources.</p><p class="note">OpenSearch description documents can be used with
4639: <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
4640: 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
4641: 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
4642: contributes to the <a href="semantics.html#styling">styling processing model</a>.</p><p>The specified resource is a resource that describes how to
4643: present the document. Exactly how the resource is to be processed
4644: 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
4645: 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
4646: 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
4647: <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">
4648:
4649: <p><strong>Quirk</strong>: If the document has been set to
4650: <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
4651: resource is not a supported style sheet type, the user agent must
4652: instead assume it to be <code title="">text/css</code>.</p>
4653:
4654: </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
4655: 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>
4656: 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
4657: that the referenced document, if retrieved, is intended to be shown
4658: in a <a href="browsers.html#secondary-browsing-context">secondary browsing context</a> (if possible), instead
4659: 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
4660: 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>
4661: 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
4662: <em>tag</em> that the referenced document represents applies to the
4663: current document.</p><p class="note">Since it indicates that the tag <em>applies to the
4664: current document</em>, it would be inappropriate to use this keyword
4665: in the markup of a <a href="#tag-cloud">tag cloud</a>, which lists
4666: 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
4667: documents.</p><p>A hierarchical structure of documents is one where each document
4668: can have various subdocuments. The document of which a document is a
4669: subdocument is said to be the document's <em>parent</em>. A document
4670: 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
4671: <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>
4672: 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
4673: the document is part of a hierarchical structure, and that the link
4674: is leading to the document that is the top of the hierarchy. It
4675: 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">
4676:
4677: <p><strong>Synonyms</strong>: For historical reasons, user agents
4678: must also treat the keywords "<code title="">top</code>", "<code title="">contents</code>", and "<code title="">toc</code>" like the
4679: <code title="rel-index"><a href="#link-type-index">index</a></code> keyword.</p>
4680:
4681: </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
4682: <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-up"><a href="#link-type-up">up</a></code> keyword indicates that the
4684: document is part of a hierarchical structure, and that the link is
4685: leading to a document that is an ancestor of the current
4686: document.</p><p>The <code title="rel-up"><a href="#link-type-up">up</a></code> keyword may be repeated within
4687: a <code title="attr-hyperlink-rel"><a href="#attr-hyperlink-rel">rel</a></code> attribute to indicate
4688: the hierarchical distance from the current document to the
4689: referenced document. If it occurs only once, then the link is
4690: leading to the current document's parent; each additional occurrence
4691: 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
4692: number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords is the depth of
4693: the current page relative to the top of the hierarchy. Only one link
4694: is created for the set of one or more <code title="rel-up"><a href="#link-type-up">up</a></code>
4695: keywords and, if present, the <code title="rel-index"><a href="#link-type-index">index</a></code>
4696: keyword.</p><p>If the page is part of multiple hierarchies, then they should be
4697: described in different <a href="embedded-content-0.html#paragraph" title="paragraph">paragraphs</a>. <span class="impl">User agents
4698: must scope any interpretation of the <code title="rel-up"><a href="#link-type-up">up</a></code>
4699: and <code title="rel-index"><a href="#link-type-index">index</a></code> keywords together
4700: indicating the depth of the hierarchy to the <a href="embedded-content-0.html#paragraph">paragraph</a>
4701: in which the link finds itself, if any, or to the document
4702: otherwise.</span></p><div class="impl">
4703:
4704: <p>When two links have both the <code title="rel-up"><a href="#link-type-up">up</a></code> and
4705: <code title="rel-index"><a href="#link-type-index">index</a></code> keywords specified together in
4706: the same scope and contradict each other by having a different
4707: number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords, the link with the
4708: greater number of <code title="rel-up"><a href="#link-type-up">up</a></code> keywords must be
4709: taken as giving the depth of the document.</p>
4710:
4711: </div><div class="example">
4712:
4713: <p>This can be used to mark up a navigation style sometimes known
4714: as bread crumbs. In the following example, the current page can be
4715: reached via two paths.</p>
4716:
4717: <pre><nav>
4718: <p>
4719: <a href="/" rel="index up up up">Main</a> >
4720: <a href="/products/" rel="up up">Products</a> >
4721: <a href="/products/dishwashers/" rel="up">Dishwashers</a> >
4722: <a>Second hand</a>
4723: </p>
4724: <p>
4725: <a href="/" rel="index up up">Main</a> >
4726: <a href="/second-hand/" rel="up">Second hand</a> >
4727: <a>Dishwashers</a>
4728: </p>
4729: </nav></pre>
4730:
4731: </div><p class="note">The <code title="dom-a-relList"><a href="text-level-semantics.html#dom-a-rellist">relList</a></code> IDL
4732: attribute (e.g. on the <code><a href="text-level-semantics.html#the-a-element">a</a></code> element) does not currently
4733: represent multiple <code title="rel-up"><a href="#link-type-up">up</a></code> keywords (the
4734: 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
4735: <em>previous sibling</em> and a <em>next sibling</em>. A document
4736: with no previous sibling is the start of its sequence, a document
4737: 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
4738: <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>
4739: 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
4740: the document is part of a sequence, and that the link is leading to
4741: the document that is the first logical document in the sequence.</p><div class="impl">
4742:
4743: <p><strong>Synonyms</strong>: For historical reasons, user agents
4744: must also treat the keywords "<code title="">begin</code>" and
4745: "<code title="">start</code>" like the <code title="rel-first"><a href="#link-type-first">first</a></code> keyword.</p>
4746:
4747: </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
4748: <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>
4749: 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
4750: document is part of a sequence, and that the link is leading to the
4751: document that is the last logical document in the sequence.</p><div class="impl">
4752:
4753: <p><strong>Synonyms</strong>: For historical reasons, user agents
4754: must also treat the keyword "<code title="">end</code>" like the
4755: <code title="rel-last"><a href="#link-type-last">last</a></code> keyword.</p>
4756:
4757: </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
4758: <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>
4759: 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
4760: document is part of a sequence, and that the link is leading to the
4761: 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
4762: <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>
4763: 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
4764: document is part of a sequence, and that the link is leading to the
4765: document that is the previous logical document in the sequence.</p><div class="impl">
4766:
4767: <p><strong>Synonyms</strong>: For historical reasons, user agents
4768: must also treat the keyword "<code title="">previous</code>" like
4769: the <code title="rel-prev"><a href="#link-type-prev">prev</a></code> keyword.</p>
4770:
4771: </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
4772: set of link types</dfn> may be registered in the <a href="http://wiki.whatwg.org/wiki/RelExtensions">WHATWG Wiki
4773: RelExtensions page</a>. <a href="references.html#refsWHATWGWIKI">[WHATWGWIKI]</a></p><p>Anyone is free to edit the WHATWG Wiki RelExtensions page at any
4774: time to add a type. Extension types must be specified with the
4775: following information:</p><dl><dt>Keyword</dt>
4776:
4777: <dd>
4778:
4779: <p>The actual value being defined. The value should not be
4780: confusingly similar to any other defined value (e.g. differing
4781: only in case).</p>
4782:
4783: <p>If the value contains a U+003A COLON character (:), it must
4784: also be an <a href="infrastructure.html#absolute-url">absolute URL</a>.</p>
4785:
4786: </dd>
4787:
4788:
4789: <dt>Effect on... <code><a href="semantics.html#the-link-element">link</a></code></dt>
4790:
4791: <dd>
4792:
4793: <p>One of the following:</p>
4794:
4795: <dl><dt>not allowed</dt>
4796:
4797: <dd>The keyword is not allowed to be specified on
4798: <code><a href="semantics.html#the-link-element">link</a></code> elements.</dd>
4799:
4800: <dt>Hyperlink</dt>
4801:
4802: <dd>The keyword may be specified on a <code><a href="semantics.html#the-link-element">link</a></code> element;
4803: it creates a <a href="semantics.html#hyperlink-link" title="hyperlink link">hyperlink
4804: link</a>.</dd>
4805:
4806: <dt>External Resource</dt>
4807:
4808: <dd>The keyword may be specified on a <code><a href="semantics.html#the-link-element">link</a></code> element;
4809: it creates a <a href="semantics.html#external-resource-link" title="external resource link">external
4810: resource link</a>.</dd>
4811:
4812: </dl></dd>
4813:
4814:
4815: <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>
4816:
4817: <dd>
4818:
4819: <p>One of the following:</p>
4820:
4821: <dl><dt>not allowed</dt>
4822:
4823: <dd>The keyword is not allowed to be specified on <code><a href="text-level-semantics.html#the-a-element">a</a></code>
4824: and <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</dd>
4825:
4826: <dt>Hyperlink</dt>
4827:
4828: <dd>The keyword may be specified on <code><a href="text-level-semantics.html#the-a-element">a</a></code> and
4829: <code><a href="the-canvas-element.html#the-area-element">area</a></code> elements.</dd>
4830:
4831: </dl></dd>
4832:
4833:
4834: <dt>Brief description</dt>
4835:
4836: <dd><p>A short non-normative description of what the keyword's
4837: meaning is.</p></dd>
4838:
4839:
4840: <dt>Specification</dt>
4841:
4842: <dd><p>A link to a more detailed description of the keyword's
4843: semantics and requirements. It could be another page on the Wiki,
4844: or a link to an external page.</p></dd>
4845:
4846:
4847: <dt>Synonyms</dt>
4848:
4849: <dd><p>A list of other keyword values that have exactly the same
4850: processing requirements. Authors should not use the values defined
4851: to be synonyms, they are only intended to allow user agents to
4852: support legacy content. Anyone may remove synonyms that are not
4853: used in practice; only names that need to be processed as synonyms
4854: for compatibility with legacy content are to be registered in this
4855: way.</p></dd>
4856:
4857:
4858: <dt>Status</dt>
4859:
4860: <dd>
4861:
4862: <p>One of the following:</p>
4863:
4864: <dl><dt>Proposed</dt>
4865:
4866: <dd>The keyword has not received wide peer review and
4867: approval. Someone has proposed it and is, or soon will be, using
4868: it.</dd>
4869:
4870: <dt>Ratified</dt>
4871:
4872: <dd>The keyword has received wide peer review and approval. It
4873: has a specification that unambiguously defines how to handle
4874: pages that use the keyword, including when they use it in
4875: incorrect ways.</dd>
4876:
4877: <dt>Discontinued</dt>
4878:
4879: <dd>The keyword has received wide peer review and it has been
4880: found wanting. Existing pages are using this keyword, but new
4881: pages should avoid it. The "brief description" and
4882: "specification" entries will give details of what authors should
4883: use instead, if anything.</dd>
4884:
4885: </dl><p>If a keyword is found to be redundant with existing values, it
4886: should be removed and listed as a synonym for the existing
4887: value.</p>
4888:
4889: <p>If a keyword is registered in the "proposed" state for a
4890: period of a month or more without being used or specified, then it
4891: may be removed from the registry.</p>
4892:
4893: <p>If a keyword is added with the "proposed" status and found to
4894: be redundant with existing values, it should be removed and listed
4895: as a synonym for the existing value. If a keyword is added with
4896: the "proposed" status and found to be harmful, then it should be
4897: changed to "discontinued" status.</p>
4898:
4899: <p>Anyone can change the status at any time, but should only do so
4900: in accordance with the definitions above.</p>
4901:
4902: </dd>
4903:
4904: </dl><div class="impl">
4905:
4906: <p>Conformance checkers must use the information given on the WHATWG
4907: Wiki RelExtensions page to establish if a value is allowed or not:
4908: values defined in this specification or marked as "proposed" or
4909: "ratified" must be accepted when used on the elements for which they
4910: apply as described in the "Effect on..." field, whereas values
4911: marked as "discontinued" or not listed in either this specification
4912: or on the aforementioned page must be rejected as invalid.
4913: Conformance checkers may cache this information (e.g. for
4914: performance reasons or to avoid the use of unreliable network
4915: connectivity).</p>
4916:
4917: <p>When an author uses a new type not defined by either this
4918: specification or the Wiki page, conformance checkers should offer to
4919: add the value to the Wiki, with the details described above, with
4920: the "proposed" status.</p>
4921:
4922: </div><p>Types defined as extensions in the <a href="http://wiki.whatwg.org/wiki/RelExtensions">WHATWG Wiki
4923: RelExtensions page</a> with the status "proposed" or "ratified" may
4924: be used with the <code title="">rel</code> attribute on
4925: <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 4926: 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 4927: specifically for marking up lists of keywords that apply to a group
4928: of pages (also known as <i>tag clouds</i>). In general, authors are
4929: encouraged to either mark up such lists using <code><a href="semantics.html#the-ul-element">ul</a></code>
4930: elements with explicit inline counts that are then hidden and turned
4931: into a presentational effect using a style sheet, or to use SVG.</p><div class="example">
4932:
4933: <p>Here, three tags are included in a short tag cloud:</p>
4934:
4935: <pre><style>
4936: @media screen, print, handheld, tv {
4937: /* should be ignored by non-visual browsers */
4938: .tag-cloud > li > span { display: none; }
4939: .tag-cloud > li { display: inline; }
4940: .tag-cloud-1 { font-size: 0.7em; }
4941: .tag-cloud-2 { font-size: 0.9em; }
4942: .tag-cloud-3 { font-size: 1.1em; }
4943: .tag-cloud-4 { font-size: 1.3em; }
4944: .tag-cloud-5 { font-size: 1.5em; }
4945: }
4946: </style>
4947: ...
4948: <ul class="tag-cloud">
4949: <li class="tag-cloud-4"><a title="28 instances" href="/t/apple">apple</a> <span>(popular)</span>
4950: <li class="tag-cloud-2"><a title="6 instances" href="/t/kiwi">kiwi</a> <span>(rare)</span>
4951: <li class="tag-cloud-5"><a title="41 instances" href="/t/pear">pear</a> <span>(very popular)</span>
4952: </ul></pre>
4953:
4954: <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
4955: provided to convert the markup into a cloud of differently-sized
4956: words, but for user agents that do not support CSS or are not
4957: visual, the markup contains annotations like "(popular)" or
4958: "(rare)" to categorize the various tags by frequency, thus enabling
4959: all users to benefit from the information.</p>
4960:
4961: <p>The <code><a href="semantics.html#the-ul-element">ul</a></code> element is used (rather than
1.749 mike 4962: <code><a href="semantics.html#the-ol-element">ol</a></code>) because the order is not particularly important:
1.299 mike 4963: while the list is in fact ordered alphabetically, it would convey
4964: the same information if ordered by, say, the length of the tag.</p>
4965:
1.748 mike 4966: <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 4967: on these <code><a href="text-level-semantics.html#the-a-element">a</a></code> elements because they do not represent tags
4968: that apply to the page itself; they are just part of an index
4969: listing the tags themselves.</p>
4970:
1.748 mike 4971: </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 4972: up conversations, meeting minutes, chat transcripts, dialogues in
4973: screenplays, instant message logs, and other situations where
4974: different players take turns in discourse.</p><p>Instead, authors are encouraged to mark up conversations using
1.303 mike 4975: <code><a href="semantics.html#the-p-element">p</a></code> elements and punctuation. Authors who need to mark
4976: the speaker for styling purposes are encouraged to use
4977: <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
4978: wrapped in the <code><a href="text-level-semantics.html#the-i-element">i</a></code> element can be used for marking up
4979: stage directions.</p><div class="example">
1.299 mike 4980:
4981: <p>This example demonstrates this using an extract from Abbot and
4982: Costello's famous sketch, <cite>Who's on first</cite>:</p>
4983:
1.303 mike 4984: <pre><p> Costello: Look, you gotta first baseman?
4985: <p> Abbott: Certainly.
4986: <p> Costello: Who's playing first?
4987: <p> Abbott: That's right.
4988: <p> Costello becomes exasperated.
4989: <p> Costello: When you pay off the first baseman every month, who gets the money?
4990: <p> Abbott: Every dollar of it.</pre>
1.299 mike 4991:
4992: </div><div class="example">
4993:
4994: <p>The following extract shows how an IM conversation log could be
4995: marked up.</p>
4996:
4997: <pre><p> <time>14:22</time> <b>egof</b> I'm not that nerdy, I've only seen 30% of the star trek episodes
4998: <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
4999: <p> <time>14:23</time> <b>egof</b> it's unarguably
1.303 mike 5000: <p> <time>14:23</time> <i>* kaj blinks</i>
1.299 mike 5001: <p> <time>14:24</time> <b>kaj</b> you are not helping your case</pre>
5002: <!-- with thanks to http://bash.org/?854262 -->
5003:
1.748 mike 5004: </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 5005: 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">
5006:
1.419 mike 5007: <p>In this example, two parts of a dialogue are annotated with
5008: footnote-like content using the <code title="attr-title"><a href="dom.html#the-title-attribute">title</a></code> attribute.</p>
1.299 mike 5009:
5010: <pre><p> <b>Customer</b>: Hello! I wish to register a complaint. Hello. Miss?
1.419 mike 5011: <p> <b>Shopkeeper</b>: <strong><span title="Colloquial pronunciation of 'What do you'"</strong>
1.299 mike 5012: >Watcha</span> mean, miss?
5013: <p> <b>Customer</b>: Uh, I'm sorry, I have a cold. I wish to make a complaint.
1.419 mike 5014: <p> <b>Shopkeeper</b>: Sorry, <span <strong>title="This is, of course, a lie."</strong>>we're
1.299 mike 5015: closing for lunch</span>.</pre>
5016:
5017: </div><hr><p>For longer annotations, the <code><a href="text-level-semantics.html#the-a-element">a</a></code> element should be
5018: used, pointing to an element later in the document. The convention
5019: is that the contents of the link be a number in square brackets.</p><div class="example">
5020:
5021: <p>In this example, a footnote in the dialogue links to a paragraph
5022: below the dialogue. The paragraph then reciprocally links back to the
5023: dialogue, allowing the user to return to the location of the
5024: footnote.</p>
5025:
1.303 mike 5026: <pre><p> Announcer: Number 16: The <i>hand</i>.
5027: <p> Interviewer: Good evening. I have with me in the studio tonight
5028: Mr Norman St John Polevaulter, who for the past few years has been
5029: contradicting people. Mr Polevaulter, why <em>do</em> you
5030: contradict people?
5031: <p> Norman: I don't. <sup><a href="#fn1" id="r1">[1]</a></sup>
5032: <p> Interviewer: You told me you did!
1.299 mike 5033: <em>...</em>
5034: <section>
5035: <p id="fn1"><a href="#r1">[1]</a> This is, naturally, a lie,
5036: but paradoxically if it were true he could not say so without
5037: contradicting the interviewer and thus making it false.</p>
5038: </section></pre>
5039:
5040: </div><hr><p>For side notes, longer annotations that apply to entire sections
5041: of the text rather than just specific words or sentences, the
5042: <code><a href="semantics.html#the-aside-element">aside</a></code> element should be used.</p><div class="example">
5043:
5044: <p>In this example, a sidebar is given after a dialogue, giving it
5045: some context.</p>
5046:
1.303 mike 5047: <pre><p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
5048: <p> <span class="speaker">Shopkeeper</span>: I'm sorry?
5049: <p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
5050: <p> <span class="speaker">Shopkeeper</span>: No no no, this's'a tobacconist's.
1.299 mike 5051: <aside>
5052: <p>In 1970, the British Empire lay in ruins, and foreign
5053: nationalists frequented the streets — many of them Hungarians
5054: (not the streets — the foreign nationals). Sadly, Alexander
5055: Yalt has been publishing incompetently-written phrase books.
5056: </aside></pre>
5057:
5058: </div><hr><p>For figures or tables, footnotes can be included in the relevant
1.756 mike 5059: <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 5060: surrounding prose.</p><div class="example">
1.299 mike 5061:
5062: <p>In this example, a <!-- round --> table has cells with footnotes
1.756 mike 5063: that are given in prose. A <code><a href="semantics.html#the-figure-element">figure</a></code> element is used to
1.299 mike 5064: give a single legend to the combination of the table and its
5065: footnotes.</p>
5066:
5067: <pre><figure>
1.729 mike 5068: <figcaption>Table 1. Alternative activities for knights.</figcaption>
5069: <table>
5070: <tr>
5071: <th> Activity
5072: <th> Location
5073: <th> Cost
5074: <tr>
5075: <td> Dance
5076: <td> Wherever possible
5077: <td> £0<sup><a href="#fn1">1</a></sup>
5078: <tr>
5079: <td> Routines, chorus scenes<sup><a href="#fn2">2</a></sup>
5080: <td> Undisclosed
5081: <td> Undisclosed
5082: <tr>
5083: <td> Dining<sup><a href="#fn3">3</a></sup>
5084: <td> Camelot
5085: <td> Cost of ham, jam, and spam<sup><a href="#fn4">4</a></sup>
5086: </table>
5087: <p id="fn1">1. Assumed.</p>
5088: <p id="fn2">2. Footwork impeccable.</p>
5089: <p id="fn3">3. Quality described as "well".</p>
5090: <p id="fn4">4. A lot.</p>
1.299 mike 5091: </figure></pre>
5092:
1.117 mike 5093: </div><div class="impl">
1.1 mike 5094:
1.748 mike 5095: <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 5096:
1.748 mike 5097: <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 5098:
5099: <p>Attribute and element <em>names</em> of <a href="infrastructure.html#html-elements">HTML
5100: elements</a> in <a href="dom.html#html-documents">HTML documents</a> must be treated as
5101: <a href="infrastructure.html#ascii-case-insensitive">ASCII case-insensitive</a>.</p>
5102:
5103: <p>Classes from the <code title="attr-class"><a href="dom.html#classes">class</a></code> attribute
5104: of <a href="infrastructure.html#html-elements">HTML elements</a> in documents that are in <a href="dom.html#quirks-mode">quirks
5105: mode</a> must be treated as <a href="infrastructure.html#ascii-case-insensitive">ASCII
5106: case-insensitive</a>.</p>
5107:
5108: <p>Attribute selectors on an <a href="infrastructure.html#html-elements" title="HTML elements">HTML
5109: element</a> in an <a href="dom.html#html-documents" title="HTML documents">HTML
5110: document</a> must treat the <em>values</em> of attributes with
5111: the following names as <a href="infrastructure.html#ascii-case-insensitive">ASCII case-insensitive</a>:</p>
5112:
5113: <!-- based on Mozilla's list, which was itself based on HTML4 -->
5114: <!-- WebKit's was identical at the time of writing except as noted below -->
5115: <ul class="brief"><li><code title="">accept</code>
5116: </li><li><code title="">accept-charset</code>
5117: </li><li><code title="">align</code>
5118: </li><li><code title="">alink</code>
5119: </li><li><code title="">axis</code>
5120: </li><li><code title="">bgcolor</code>
5121: </li><li><code title="">charset</code>
5122: </li><li><code title="">checked</code>
5123: </li><li><code title="">clear</code>
5124: </li><li><code title="">codetype</code>
5125: </li><li><code title="">color</code>
5126: </li><li><code title="">compact</code>
5127: </li><li><code title="">declare</code>
5128: </li><li><code title="">defer</code>
5129: </li><li><code title="">dir</code>
5130: </li><li><code title="">direction</code> <!-- not in webkit -->
5131: </li><li><code title="">disabled</code>
5132: </li><li><code title="">enctype</code>
5133: </li><li><code title="">face</code>
5134: </li><li><code title="">frame</code>
5135: </li><li><code title="">hreflang</code>
5136: </li><li><code title="">http-equiv</code>
5137: </li><li><code title="">lang</code>
5138: </li><li><code title="">language</code>
5139: </li><li><code title="">link</code>
5140: </li><li><code title="">media</code>
5141: </li><li><code title="">method</code>
5142: </li><li><code title="">multiple</code>
5143: </li><li><code title="">nohref</code>
5144: </li><li><code title="">noresize</code>
5145: </li><li><code title="">noshade</code>
5146: </li><li><code title="">nowrap</code>
5147: </li><li><code title="">readonly</code>
5148: </li><li><code title="">rel</code>
5149: </li><li><code title="">rev</code>
5150: </li><li><code title="">rules</code>
5151: </li><li><code title="">scope</code>
5152: </li><li><code title="">scrolling</code>
5153: </li><li><code title="">selected</code>
5154: </li><li><code title="">shape</code>
5155: </li><li><code title="">target</code>
5156: </li><li><code title="">text</code>
5157: </li><li><code title="">type</code>
5158: </li><li><code title="">valign</code>
5159: </li><li><code title="">valuetype</code>
5160: </li><li><code title="">vlink</code>
5161: </li></ul><p>All other attribute values on <a href="infrastructure.html#html-elements">HTML elements</a> must be
5162: treated as <a href="infrastructure.html#case-sensitive">case-sensitive</a>.</p>
5163:
5164:
1.748 mike 5165: <h4 id="pseudo-classes"><span class="secno">4.14.2 </span>Pseudo-classes</h4>
1.718 mike 5166:
1.1 mike 5167: <p>There are a number of dynamic selectors that can be used with
5168: HTML. This section defines when these selectors match HTML
5169: elements.</p>
5170:
5171: <dl><dt><dfn id="selector-link" title="selector-link"><code>:link</code></dfn></dt>
5172: <dt><dfn id="selector-visited" title="selector-visited"><code>:visited</code></dfn></dt>
5173:
5174: <dd>
5175:
1.748 mike 5176: <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
5177: <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 5178: <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
5179: <code title="selector-link"><a href="#selector-link">:link</a></code> and <code title="selector-visited"><a href="#selector-visited">:visited</a></code>.</p>
5180:
5181: </dd>
5182:
5183:
5184: <dt><dfn id="selector-active" title="selector-active"><code>:active</code></dfn></dt>
5185:
5186: <dd>
5187:
5188: <p>The <code title="selector-active"><a href="#selector-active">:active</a></code> pseudo-class
5189: must match the following elements between the time the user begins
1.95 mike 5190: to activate the element and the time the user stops activating
1.1 mike 5191: the element:</p>
5192:
1.748 mike 5193: <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 5194:
1.748 mike 5195: <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 5196:
5197: <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>
5198:
5199: <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>
5200:
5201: <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>
5202:
5203: <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>
5204:
5205: <li>any other element, if it is <a href="editing.html#specially-focusable">specially
5206: focusable</a></li>
5207:
5208: </ul><p class="example">For example, if the user is using a keyboard to
5209: push a <code><a href="forms.html#the-button-element">button</a></code> element by pressing the space bar, the
5210: element would match this pseudo-class in between the time that the
5211: element received the <code title="event-keydown">keydown</code>
5212: event and the time the element received the <code title="event-keyup">keyup</code> event.</p>
5213:
5214: </dd>
5215:
5216:
5217: <dt><dfn id="selector-enabled" title="selector-enabled"><code>:enabled</code></dfn></dt>
5218:
5219: <dd>
5220:
5221: <p>The <code title="selector-enabled"><a href="#selector-enabled">:enabled</a></code> pseudo-class
5222: must match the following elements:</p>
5223:
1.748 mike 5224: <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 5225:
1.748 mike 5226: <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 5227:
5228: <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>
5229:
5230: <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>
5231:
5232: <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
5233: <a href="forms.html#hidden-state" title="attr-input-type-hidden">Hidden</a> state and that
5234: are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5235:
5236: <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>
5237:
5238: <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>
5239:
5240: <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>
5241:
5242: <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>
5243:
5244: <li><code><a href="semantics.html#the-li-element">li</a></code> elements that are children of
5245: <code><a href="#menus">menu</a></code> elements, and that have a child element that
5246: defines a <a href="#concept-command" title="concept-command">command</a>, if the
5247: first such element's <a href="#command-facet-disabledstate" title="command-facet-disabledstate">Disabled State</a> facet
5248: is false (not disabled)</li>
5249:
5250: </ul></dd>
5251:
5252:
5253: <dt><dfn id="selector-disabled" title="selector-disabled"><code>:disabled</code></dfn></dt>
5254:
5255: <dd>
5256:
5257: <p>The <code title="selector-disabled"><a href="#selector-disabled">:disabled</a></code>
5258: pseudo-class must match the following elements:</p>
5259:
1.131 mike 5260: <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 5261:
5262: <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
5263: <a href="forms.html#hidden-state" title="attr-input-type-hidden">Hidden</a> state and that
5264: are <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5265:
5266: <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>
5267:
5268: <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>
5269:
5270: <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>
5271:
5272: <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>
5273:
5274: <li><code><a href="semantics.html#the-li-element">li</a></code> elements that are children of
5275: <code><a href="#menus">menu</a></code> elements, and that have a child element that
5276: defines a <a href="#concept-command" title="concept-command">command</a>, if the
5277: first such element's <a href="#command-facet-disabledstate" title="command-facet-disabledstate">Disabled State</a> facet
5278: is true (disabled)</li>
5279:
5280: </ul></dd>
5281:
5282:
5283: <dt><dfn id="selector-checked" title="selector-checked"><code>:checked</code></dfn></dt>
5284:
5285: <dd>
5286:
5287: <p>The <code title="selector-checked"><a href="#selector-checked">:checked</a></code> pseudo-class
5288: must match the following elements:</p>
5289:
5290: <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
5291: <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> state is
5292: true</li>
5293:
5294: <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
5295: <a href="forms.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> state is
5296: true</li>
5297:
5298: <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
5299: and that have a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code>
5300: attribute</li>
5301:
5302: <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
5303: have a <code title="attr-command-checked"><a href="#attr-command-checked">checked</a></code>
5304: attribute</li>
5305:
5306: </ul></dd>
5307:
5308:
5309: <dt><dfn id="selector-indeterminate" title="selector-indeterminate"><code>:indeterminate</code></dfn></dt>
5310:
5311: <dd>
5312:
5313: <p>The <code title="selector-indeterminate"><a href="#selector-indeterminate">:indeterminate</a></code>
5314: 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 5315: <code title="dom-input-indeterminate"><a href="forms.html#dom-input-indeterminate">indeterminate</a></code> IDL
1.1 mike 5316: attribute is set to true.</p>
5317:
5318: </dd>
5319:
5320:
5321: <dt><dfn id="selector-default" title="selector-default"><code>:default</code></dfn></dt>
5322:
5323: <dd>
5324:
5325: <p>The <code title="selector-default"><a href="#selector-default">:default</a></code> pseudo-class
5326: must match the following elements:</p>
5327:
5328: <ul><li><code><a href="forms.html#the-button-element">button</a></code> elements that are their form's
5329: <a href="forms.html#default-button">default button</a></li>
5330:
5331: <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
5332: are their form's <a href="forms.html#default-button">default button</a></li>
5333: <!--
5334: <li><code>command</code> elements that have a <code
5335: title="attr-command-default">default</code> attribute</li>
5336: -->
5337: </ul></dd>
5338:
5339:
5340: <dt><dfn id="selector-valid" title="selector-valid"><code>:valid</code></dfn></dt>
5341:
5342: <dd>
5343:
5344: <p>The <code title="selector-valid"><a href="#selector-valid">:valid</a></code> pseudo-class
5345: must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for
5346: constraint validation">candidates for constraint validation</a>
5347: and that <a href="forms.html#concept-fv-valid" title="concept-fv-valid">satisfy their
5348: constraints</a>.</p>
5349:
5350: </dd>
5351:
5352:
5353: <dt><dfn id="selector-invalid" title="selector-invalid"><code>:invalid</code></dfn></dt>
5354:
5355: <dd>
5356:
5357: <p>The <code title="selector-invalid"><a href="#selector-invalid">:invalid</a></code> pseudo-class
5358: must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for
5359: constraint validation">candidates for constraint validation</a>
5360: but that do not <a href="forms.html#concept-fv-valid" title="concept-fv-valid">satisfy their
5361: constraints</a>.</p>
5362:
5363: </dd>
5364:
5365:
5366: <dt><dfn id="selector-in-range" title="selector-in-range"><code>:in-range</code></dfn></dt>
5367:
5368: <dd>
5369:
5370: <p>The <code title="selector-in-range"><a href="#selector-in-range">:in-range</a></code>
5371: pseudo-class must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for constraint validation">candidates for
5372: constraint validation</a> and that are neither <a href="forms.html#suffering-from-an-underflow">suffering
5373: from an underflow</a> nor <a href="forms.html#suffering-from-an-overflow">suffering from an
5374: overflow</a>.</p>
5375:
5376: </dd>
5377:
5378:
5379: <dt><dfn id="selector-out-of-range" title="selector-out-of-range"><code>:out-of-range</code></dfn></dt>
5380:
5381: <dd>
5382:
5383: <p>The <code title="selector-out-of-range"><a href="#selector-out-of-range">:out-of-range</a></code>
5384: pseudo-class must match all elements that are <a href="forms.html#candidate-for-constraint-validation" title="candidate for constraint validation">candidates for
5385: constraint validation</a> and that are <a href="forms.html#suffering-from-an-underflow">suffering from an
5386: underflow</a> or <a href="forms.html#suffering-from-an-overflow">suffering from an overflow</a>.</p>
5387:
5388: </dd>
5389:
5390:
5391: <dt><dfn id="selector-required" title="selector-required"><code>:required</code></dfn></dt>
5392:
5393: <dd>
5394:
5395: <p>The <code title="selector-required"><a href="#selector-required">:required</a></code>
5396: pseudo-class must match the following elements:</p>
5397:
5398: <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>
5399:
5400: <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>
5401: attribute</li>
5402:
5403: </ul></dd>
5404:
5405:
5406: <dt><dfn id="selector-optional" title="selector-optional"><code>:optional</code></dfn></dt>
5407:
5408: <dd>
5409:
5410: <p>The <code title="selector-optional"><a href="#selector-optional">:optional</a></code>
5411: pseudo-class must match the following elements:</p>
5412:
5413: <ul><li><code><a href="forms.html#the-button-element">button</a></code> elements</li>
5414:
5415: <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>
5416:
5417: <li><code><a href="forms.html#the-select-element">select</a></code> elements</li>
5418:
5419: <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>
5420: attribute</li>
5421:
5422: </ul></dd>
5423:
5424:
5425: <dt><dfn id="selector-read-only" title="selector-read-only"><code>:read-only</code></dfn></dt>
5426: <dt><dfn id="selector-read-write" title="selector-read-write"><code>:read-write</code></dfn></dt>
5427:
5428: <dd>
5429:
5430: <p>The <code title="selector-read-write"><a href="#selector-read-write">:read-write</a></code>
5431: pseudo-class must match the following elements:</p>
5432:
5433: <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,
5434: but that are not <i title="concept-input-immutable"><a href="forms.html#concept-input-immutable">immutable</a></i>
5435: (i.e. that do not have the <code title="attr-input-readonly"><a href="forms.html#attr-input-readonly">readonly</a></code> attribute specified
5436: and that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a>)</li>
5437:
5438: <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
5439: that are not <a href="forms.html#concept-fe-disabled" title="concept-fe-disabled">disabled</a></li>
5440:
5441: <li>any element that is <a href="editing.html#editable">editable</a></li>
5442:
5443: </ul><p>The <code title="selector-read-only"><a href="#selector-read-only">:read-only</a></code>
5444: pseudo-class must match all other <a href="infrastructure.html#html-elements">HTML elements</a>.</p>
5445:
5446: </dd>
5447:
5448: </dl><p class="note">Another section of this specification defines the
5449: <i><a href="history.html#target-element">target element</a></i> used with the <code title="selector-target">:target</code> pseudo-class.</p>
5450:
5451: <p class="note">This specification does not define when an element
5452: 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
5453: those are all defined in sufficient detail in a language-agnostic
1.98 mike 5454: fashion in the Selectors specification. <a href="references.html#refsSELECTORS">[SELECTORS]</a></p>
1.1 mike 5455:
1.718 mike 5456: </div><div class="impl">
5457:
1.748 mike 5458: <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 5459:
5460:
1.720 mike 5461:
5462:
1.807 mike 5463: <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 5464:
1.804 mike 5465: <p>Given a <code><a href="infrastructure.html#document">Document</a></code> <var title="">source</var>, a user
1.718 mike 5466: agent may run the following algorithm to <dfn id="extracting-atom" title="extracting
5467: Atom">extract an Atom feed</dfn>. This is not the only algorithm
5468: that can be used for this purpose; for instance, a user agent might
5469: instead use the hAtom algorithm. <a href="references.html#refsHATOM">[HATOM]</a></p>
5470:
1.804 mike 5471: <ol><li><p>If the <code><a href="infrastructure.html#document">Document</a></code> <var title="">source</var> does
1.718 mike 5472: not contain any <code><a href="semantics.html#the-article-element">article</a></code> elements, then return nothing
5473: and abort these steps. This algorithm can only be used with
5474: documents that contain distinct articles.</p>
5475:
5476: </li><li><p>Let <var title="">R</var> be an empty <a href="dom.html#xml-documents" title="XML
1.804 mike 5477: 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 5478: defined.</p></li>
5479:
5480: <li><p>Append a <code title="">feed</code> element in the
5481: <a href="#atom-namespace">Atom namespace</a> to <var title="">R</var>.</p></li>
5482:
5483: <li>
5484:
5485: <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>
5486:
5487: <ol><li><p>Append an <code title="">author</code> element in the
5488: <a href="#atom-namespace">Atom namespace</a> to the root element of <var title="">R</var>.</p></li>
5489:
5490: <li><p>Append a <code title="">name</code> element in the
5491: <a href="#atom-namespace">Atom namespace</a> to the element created in the
5492: previous step.</p>
5493:
5494: </li><li><p>Append a text node whose data is the value of the
5495: <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
5496: created in the previous step.</p></li>
5497:
5498: </ol><!-- could use vCards instead, and get <atom:email> and <atom:uri>
5499: elements out of this instead of just <atom:name> --></li>
5500:
5501: <li>
5502:
5503: <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 5504: keyword <code title="rel-icon"><a href="#rel-icon">icon</a></code>, and that element also
1.718 mike 5505: has an <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute whose
5506: value successfully <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolves</a>
5507: 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
5508: the root element of <var title="">R</var> whose contents is a text
5509: node with its data set to the <a href="infrastructure.html#absolute-url">absolute URL</a> resulting
5510: from <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the value of the
5511: <code title="attr-link-href"><a href="semantics.html#attr-link-href">href</a></code> attribute.</p>
5512:
5513: <!-- could check ratio, could check type... -->
5514:
5515: </li>
5516:
5517: <li>
5518:
5519: <p>Append an <code title="">id</code> element in the <a href="#atom-namespace">Atom
5520: namespace</a> to the root element of <var title="">R</var>
5521: whose contents is a text node with its data set to <a href="dom.html#the-document-s-current-address">the
5522: document's current address</a>.</p>
5523:
5524: </li>
5525:
5526: <li>
5527:
5528: <p>Optionally: Let <var title="">x</var> be a <code title="">link</code> element in the <a href="#atom-namespace">Atom
5529: namespace</a>. Add a <code title="">rel</code> attribute whose
5530: value is the string "<code title="">self</code>" to <var title="">x</var>. Append a text node with its data set to the
5531: (user-agent-defined) <a href="dom.html#the-document-s-address" title="the document's
5532: address">address</a> of <var title="">R</var> to <var title="">x</var>. Append <var title="">x</var> to the root element
5533: of <var title="">R</var>.</p>
5534:
5535: <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
5536: address">address</a>. The presence of the <code title="">rel="self"</code> link is a "should"-level requirement in
5537: the Atom specification.</p>
5538:
5539: </li>
5540:
5541: <li>
5542:
5543: <p>Let <var title="">x</var> be a <code title="">link</code>
5544: 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
5545: document being converted is an <a href="dom.html#html-documents" title="HTML documents">HTML
5546: document</a>, add a <code title="">type</code> attribute whose
5547: 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
5548: <a href="dom.html#xml-documents" title="XML documents">XML document</a>; add a <code title="">type</code> attribute whose value is the string
5549: "<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
5550: <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
5551: of <var title="">R</var>.</p>
5552:
5553: </li>
5554:
5555: <li><p>Let <var title="">subheading text</var> be the empty
5556: string.</p></li>
5557:
5558: <li><p>Let <var title="">heading</var> be the first element of
5559: <a href="dom.html#heading-content">heading content</a> whose nearest ancestor of
5560: <a href="dom.html#sectioning-content">sectioning content</a> is <a href="dom.html#the-body-element">the body
5561: element</a>, if any, or null if there is none.</p></li>
5562:
5563: <li>
5564:
5565: <p>Take the appropriate action from the following list, as
5566: determined by the type of the <var title="">heading</var>
5567: element:</p>
5568:
5569: <dl><dt>If <var title="">heading</var> is null</dt>
5570:
5571: <dd>
5572:
5573: <p>Let <var title="">heading text</var> be the
1.804 mike 5574: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <a href="dom.html#the-title-element">the <code>title</code>
1.718 mike 5575: element</a>, if there is one, or the empty string
5576: otherwise.</p>
5577:
5578: </dd>
5579:
5580: <dt>If <var title="">heading</var> is a <code><a href="semantics.html#the-hgroup-element">hgroup</a></code> element</dt>
5581:
5582: <dd>
5583:
5584: <p>If <var title="">heading</var> contains no child
5585: <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>
5586:
5587: <p>Otherwise, let <var title="">headings list</var> be a list of
5588: 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
5589: of <var title="">heading</var>, sorted first by descending
5590: <a href="semantics.html#rank">rank</a> and then in <a href="infrastructure.html#tree-order">tree order</a> (so
5591: <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 5592: 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 5593: the first entry in <var title="">headings list</var>, and if
5594: there are multiple entries, let <var title="">subheading
1.804 mike 5595: text</var> be the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the second entry
1.718 mike 5596: in <var title="">headings list</var>.</p>
5597:
5598: </dd>
5599:
5600: <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>
5601:
5602: <dd>
5603:
5604: <p>Let <var title="">heading text</var> be the
1.804 mike 5605: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <var title="">heading</var>.</p>
1.718 mike 5606:
5607: </dd>
5608:
5609: </dl></li>
5610:
5611: <li>
5612:
5613: <p>Append a <code title="">title</code> element in the <a href="#atom-namespace">Atom
5614: namespace</a> to the root element of <var title="">R</var>
5615: whose contents is a text node with its data set to <var title="">heading text</var>.</p>
5616:
5617: </li>
5618:
5619: <li>
5620:
5621: <p>If <var title="">subheading text</var> is not the empty string,
5622: append a <code title="">subtitle</code> element in the <a href="#atom-namespace">Atom
5623: namespace</a> to the root element of <var title="">R</var>
5624: whose contents is a text node with its data set to <var title="">subheading text</var>.</p>
5625:
5626: </li>
5627:
5628: <li><p>Let <var title="">global update date</var> have no
5629: value.</p></li>
5630:
5631: <li>
5632:
5633: <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
5634: <code><a href="semantics.html#the-article-element">article</a></code> element, run the following steps:</p>
5635:
5636: <ol><li><p>Let <var title="">E</var> be an <code title="">entry</code> element in the <a href="#atom-namespace">Atom namespace</a>,
5637: and append <var title="">E</var> to the root element of <var title="">R</var>.</p></li>
5638:
5639: <li><p>Let <var title="">heading</var> be the first element of
5640: <a href="dom.html#heading-content">heading content</a> whose nearest ancestor of
5641: <a href="dom.html#sectioning-content">sectioning content</a> is <var title="">article</var>,
5642: if any, or null if there is none.</p></li>
5643:
5644: <li>
5645:
5646: <p>Take the appropriate action from the following list, as
5647: determined by the type of the <var title="">heading</var>
5648: element:</p>
5649:
5650: <dl><dt>If <var title="">heading</var> is null</dt>
5651:
5652: <dd>
5653:
5654: <p>Let <var title="">heading text</var> be the empty
5655: string.</p>
5656:
5657: </dd>
5658:
5659: <dt>If <var title="">heading</var> is a <code><a href="semantics.html#the-hgroup-element">hgroup</a></code> element</dt>
5660:
5661: <dd>
5662:
5663: <p>If <var title="">heading</var> contains no child
5664: <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>
5665:
5666: <p>Otherwise, let <var title="">headings list</var> be a list
5667: 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
5668: children of <var title="">heading</var>, sorted first by
5669: descending <a href="semantics.html#rank">rank</a> and then in <a href="infrastructure.html#tree-order">tree
5670: order</a> (so <code><a href="semantics.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a></code>s first, then
5671: <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
5672: appear in the document). Then, let <var title="">heading
1.804 mike 5673: text</var> be the <code><a href="infrastructure.html#textcontent">textContent</a></code> of the first entry
1.718 mike 5674: in <var title="">headings list</var>.</p>
5675:
5676: </dd>
5677:
5678: <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>
5679:
5680: <dd>
5681:
5682: <p>Let <var title="">heading text</var> be the
1.804 mike 5683: <code><a href="infrastructure.html#textcontent">textContent</a></code> of <var title="">heading</var>.</p>
1.718 mike 5684:
5685: </dd>
5686:
5687: </dl></li>
5688:
5689: <li>
5690:
5691: <p>Append a <code title="">title</code> element in the
5692: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
5693: contents is a text node with its data set to <var title="">heading text</var>.</p>
5694:
5695: </li>
5696:
5697: <!-- <atom:author> is required either at the feed level (above)
5698: or the entry level (here) but we don't provide it -->
5699:
5700: <li>
5701:
5702: <p>Clone <var title="">article</var> and its descendants into an
1.788 mike 5703: environment that has <a href="webappapis.html#concept-bc-noscript" title="concept-bc-noscript">scripting
1.718 mike 5704: disabled</a>, has no <a href="infrastructure.html#plugin" title="plugin">plugins</a>, and
5705: fails any attempt to <a href="infrastructure.html#fetch" title="fetch">fetch</a> any
5706: resources. Let <var title="">cloned article</var> be the
5707: resulting clone <code><a href="semantics.html#the-article-element">article</a></code> element.</p>
5708:
5709: </li>
5710:
5711: <li>
5712:
5713: <p>Remove from the subtree rooted at <var title="">cloned
5714: article</var> any <code><a href="semantics.html#the-article-element">article</a></code> elements other than the
5715: <var title="">cloned article</var> itself, any
5716: <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>
5717: elements whose nearest ancestor of <a href="dom.html#sectioning-content">sectioning
5718: content</a> is the <var title="">cloned article</var>, and
5719: the first element of <a href="dom.html#heading-content">heading content</a> whose nearest
5720: ancestor of <a href="dom.html#sectioning-content">sectioning content</a> is the <var title="">cloned article</var>, if any.</p>
5721:
5722: </li>
5723:
5724: <li>
5725:
5726: <p>If <var title="">cloned article</var> contains any
5727: <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
5728: values <a href="infrastructure.html#parse-a-global-date-and-time-string" title="parse a global date and time string">parse
5729: as global date and time strings</a> without errors, then let
5730: <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
5731: to the newest <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and
5732: time</a>.</p>
5733:
5734: <p>Otherwise, let <var title="">update date</var> have no
5735: value.</p>
5736:
5737: <p class="note">This value is used below; it is calculated here
5738: because in certain cases the next step mutates the <var title="">cloned article</var>.</p>
5739:
5740: </li>
5741:
5742: <li>
5743:
5744: <p>If the document being converted is an <a href="dom.html#html-documents" title="HTML
5745: documents">HTML document</a>, then: Let <var title="">x</var>
5746: be a <code title="">content</code> element in the <a href="#atom-namespace">Atom
5747: namespace</a>. Add a <code title="">type</code> attribute
5748: whose value is the string "<code title="">html</code>" to <var title="">x</var>. Append a text node with its data set to the
5749: result of running the <a href="syntax.html#html-fragment-serialization-algorithm">HTML fragment serialization
5750: algorithm</a> on <var title="">cloned article</var> to <var title="">x</var>. Append <var title="">x</var> to <var title="">E</var>.</p>
5751:
5752: <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
5753: 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
5754: <code><a href="semantics.html#the-div-element">div</a></code> element to <var title="">x</var>. Move all the
5755: child nodes of the <var title="">cloned article</var> node to
5756: that <code><a href="semantics.html#the-div-element">div</a></code> element, preserving their relative
5757: order. Append <var title="">x</var> to <var title="">E</var>.</p>
5758:
5759: </li>
5760:
5761: <li>
5762:
5763: <p>Establish the value of <var title="">id</var> and <var title="">has-alternate</var> from the first of the following to
5764: apply:</p>
5765:
5766: <dl><dt>If the <var title="">article</var> node has a descendant
1.748 mike 5767: <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 5768: successfully <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolves</a>
5769: relative to that descendant and a <code title="attr-a-rel">rel</code> attribute whose value includes
1.748 mike 5770: the <code title="rel-bookmark"><a href="#link-type-bookmark">bookmark</a></code> keyword</dt>
1.718 mike 5771:
5772: <dd>Let <var title="">id</var> be the <a href="infrastructure.html#absolute-url">absolute URL</a>
5773: resulting from <a href="infrastructure.html#resolve-a-url" title="resolve a url">resolving</a> the
1.748 mike 5774: value of the <code title="attr-hyperlink-href"><a href="#attr-hyperlink-href">href</a></code>
1.718 mike 5775: 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>
5776: element, relative to the element. Let <var title="">has-alternate</var> be true.</dd>
5777:
5778: <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>
5779:
5780: <dd>Let <var title="">id</var> be <a href="dom.html#the-document-s-current-address">the document's current
5781: address</a>, with the fragment identifier (if any) removed,
5782: and with a new fragment identifier specified, consisting of the
5783: 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>
5784:
5785: <dt>Otherwise</dt>
5786:
5787: <dd>Let <var title="">id</var> be a user-agent-defined
5788: undereferenceable yet globally unique <a href="infrastructure.html#valid-url" title="valid
5789: URL">valid</a> <a href="infrastructure.html#absolute-url">absolute URL</a>. The same
5790: <a href="infrastructure.html#absolute-url">absolute URL</a> should be generated for each run of
5791: this algorithm when given the same input. Let <var title="">has-alternate</var> be false.</dd>
5792:
5793: </dl></li>
5794:
5795: <li>
5796:
5797: <p>Append an <code title="">id</code> element in the <a href="#atom-namespace">Atom
5798: namespace</a> to <var title="">E</var> whose contents is a
5799: text node with its data set to <var title="">id</var>.</p>
5800:
5801: </li>
5802:
5803: <li>
5804:
5805: <p>If <var title="">has-alternate</var> is true: Let <var title="">x</var> be a <code title="">link</code> element in the
5806: <a href="#atom-namespace">Atom namespace</a>. Add a <code title="">rel</code>
5807: attribute whose value is the string "<code title="">alternate</code>" to <var title="">x</var>. Append a
5808: 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>
5809:
5810: </li>
5811:
5812: <li>
5813:
5814: <p>If <var title="">article</var> has a <code><a href="text-level-semantics.html#the-time-element">time</a></code>
5815: 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
5816: 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
5817: the following substeps, with <var title="">e</var> being the
5818: first such element:</p>
5819:
5820: <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
5821: component is the <a href="text-level-semantics.html#concept-time-date" title="concept-time-date">date</a> of
5822: <var title="">e</var>.</p></li>
5823:
5824: <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
5825: unknown, then let <var title="">datetime</var>'s time and
5826: 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
5827: respectively ("<code title="">00:00Z</code>").</p></li>
5828:
5829: <li><p>Let <var title="">publication date</var> be the
5830: <a href="infrastructure.html#best-representation-of-the-global-date-and-time-string">best representation of the global date and time
5831: string</a> <var title="">datetime</var>.</p></li>
5832:
5833: </ol><p>Otherwise, let <var title="">publication date</var> have no
5834: value.</p>
5835:
5836: </li>
5837:
5838: <li>
5839:
5840: <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>
5841:
5842: <p>Otherwise, if <var title="">publication date</var> has no
5843: 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>
5844:
5845: </li>
5846:
5847: <li>
5848:
5849: <p>If <var title="">update date</var> has a value, and <var title="">global update date</var> has no value or is less recent
5850: than <var title="">update date</var>, then let <var title="">global update date</var> have the value of <var title="">update date</var>.</p>
5851:
5852: </li>
5853:
5854: <li>
5855:
5856: <p>If <var title="">publication date</var> and <var title="">update date</var> both still have no value, then let
5857: them both value a value that is a <a href="infrastructure.html#valid-global-date-and-time-string">valid global date and
5858: time string</a> representing the <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and time</a> of the
5859: moment that this algorithm was invoked.</p>
5860:
5861: </li>
5862:
5863: <li>
5864:
5865: <p>Append an <code title="">published</code> element in the
5866: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
5867: contents is a text node with its data set to <var title="">publication date</var>.</p>
5868:
5869: </li>
5870:
5871: <li>
5872:
5873: <p>Append an <code title="">updated</code> element in the
5874: <a href="#atom-namespace">Atom namespace</a> to <var title="">E</var> whose
5875: contents is a text node with its data set to <var title="">update date</var>.</p>
5876:
5877: </li>
5878:
5879: </ol></li>
5880:
5881: <li>
5882:
5883: <p>If <var title="">global update date</var> has no value, then
5884: let it have a value that is a <a href="infrastructure.html#valid-global-date-and-time-string">valid global date and time
5885: string</a> representing the <a href="infrastructure.html#concept-datetime" title="concept-datetime">global date and time</a> of the date
1.804 mike 5886: and time of the <code><a href="infrastructure.html#document">Document</a></code>'s source file's last
1.718 mike 5887: modification, if it is known, or else of the moment that this
5888: algorithm was invoked.</p>
5889:
5890: </li>
5891:
5892: <li>
5893:
5894: <p>Insert an <code title="">updated</code> element in the
5895: <a href="#atom-namespace">Atom namespace</a> into the root element of <var title="">R</var> before the first <code title="">entry</code> in
5896: the <a href="#atom-namespace">Atom namespace</a> whose contents is a text node with
5897: its data set to <var title="">global update date</var>.</p>
5898:
5899: </li>
5900:
5901: <li><p>Return the Atom document <var title="">R</var>.</p></li>
5902:
5903: </ol><p class="note">The above algorithm does not guarantee that the
5904: output will be a conforming Atom feed. In particular, if
5905: insufficient information is provided in the document (e.g. if the
5906: document does not have any <code title=""><meta name="author"
5907: content="..."></code> elements), then the output will not be
5908: conforming.</p>
5909:
5910: <p>The <dfn id="atom-namespace">Atom namespace</dfn> is: <code>http://www.w3.org/2005/Atom</code></p>
5911:
5912:
5913:
1.117 mike 5914: </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