Annotation of html5/spec-author-view/commands.html, revision 1.13
1.1 mike 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2: <!DOCTYPE html>
1.13 ! mike 3: <!-- when publishing, change bits marked ZZZ --><html lang="en-US-x-Hixie" class="split chapter"><head><title>4.11.5 Commands — HTML5 (Author Edition)</title><script src="link-fixup.js"></script><link href="whatwg.css" rel="stylesheet"><style type="text/css">
1.1 mike 4: pre { margin-left: 2em; white-space: pre-wrap; }
5: h2 { margin: 3em 0 1em 0; }
6: h3 { margin: 2.5em 0 1em 0; }
7: h4 { margin: 2.5em 0 0.75em 0; }
8: h5, h6 { margin: 2.5em 0 1em; }
9: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
10: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
11: p { margin: 1em 0; }
12: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
13: dl, dd { margin-top: 0; margin-bottom: 0; }
14: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
15: dt + dt { margin-top: 0; }
16: dd dt { margin-top: 0.25em; margin-bottom: 0; }
17: dd p { margin-top: 0; }
18: dd dl + p { margin-top: 1em; }
19: dd table + p { margin-top: 1em; }
20: p + * > li, dd li { margin: 1em 0; }
21: dt, dfn { font-weight: bold; font-style: normal; }
22: dt dfn { font-style: italic; }
23: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
24: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
25: pre em { font-weight: bolder; font-style: normal; }
26: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
27: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
28: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
29: table thead { border-bottom: solid; }
30: table tbody th:first-child { border-left: solid; }
31: table tbody th { text-align: left; }
32: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
33: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
34:
35: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
36: .matrix, .matrix td { border: none; text-align: right; }
37: .matrix { margin-left: 2em; }
38: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
39: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
40: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
41:
42: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
43: img.extra { float: right; }
44: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; }
45: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
46: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
47: pre.css:first-line { color: #AAAA50; }
48: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #EEFFEE; }
49: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
50: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
51: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
52: dl.domintro dd p { margin: 0.5em 0; }
53: dl.switch { padding-left: 2em; }
54: dl.switch > dt { text-indent: -1.5em; }
55: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
56: dl.triple { padding: 0 0 0 1em; }
57: dl.triple dt, dl.triple dd { margin: 0; display: inline }
58: dl.triple dt:after { content: ':'; }
59: dl.triple dd:after { content: '\A'; white-space: pre; }
60: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
61: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
62: a .diff-new { border-bottom: 1px blue solid; }
63:
64: h2 { page-break-before: always; }
65: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
66: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
67:
68: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]), li > span:not([title=""]):not([class="XXX"]):not([class="impl"]) { border-bottom: solid #9999CC; }
69:
70: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
71: div.head p { margin: 0; }
72: div.head h1 { margin: 0; }
73: div.head .logo { float: right; margin: 0 1em; }
74: div.head .logo img { border: none } /* remove border from top image */
75: div.head dl { margin: 1em 0; }
76: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
77:
78: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
79: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
80: body > .toc > li > * { margin-bottom: 0.5em; }
81: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
82: .toc, .toc li { list-style: none; }
83:
84: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
85: .brief li { margin: 0; padding: 0; }
86: .brief li p { margin: 0; padding: 0; }
87:
88: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
89: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
90: .category-list li { display: inline; }
91: .category-list li:not(:last-child)::after { content: ', '; }
92: .category-list li > span, .category-list li > a { text-transform: lowercase; }
93: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
94:
95: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
96: .XXX > :first-child { margin-top: 0; }
97: p .XXX { line-height: 3em; }
98: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
99: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
100: .annotation :link, .annotation :visited { color: inherit; }
101: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
102: .annotation span { border: none ! important; }
103: .note { color: green; background: transparent; font-family: sans-serif; }
104: .warning { color: red; background: transparent; }
105: .note, .warning { font-weight: bolder; font-style: italic; }
106: p.note, div.note { padding: 0.5em 2em; }
107: span.note { padding: 0 2em; }
108: .note p:first-child, .warning p:first-child { margin-top: 0; }
109: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
110: .warning:before { font-style: normal; }
111: p.note:before { content: 'Note: '; }
112: p.warning:before { content: '\26A0 Warning! '; }
113:
114: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
115: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
116: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
117:
118: h4 { position: relative; z-index: 3; }
119: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
120: .element {
121: background: #EEEEFF;
122: color: black;
123: margin: 0 0 1em 0.15em;
124: padding: 0 1em 0.25em 0.75em;
125: border-left: solid #9999FF 0.25em;
126: position: relative;
127: z-index: 1;
128: }
129: .element:before {
130: position: absolute;
131: z-index: 2;
132: top: 0;
133: left: -1.15em;
134: height: 2em;
135: width: 0.9em;
136: background: #EEEEFF;
137: content: ' ';
138: border-style: none none solid solid;
139: border-color: #9999FF;
140: border-width: 0.25em;
141: }
142:
143: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
144: td > .example:only-child { margin: 0 0 0 0.1em; }
145:
146: .tall-and-narrow {
147: font-size: 0.6em;
148: column-width: 25em;
149: column-gap: 1em;
150: -moz-column-width: 25em;
151: -moz-column-gap: 1em;
152: -webkit-column-width: 25em;
153: -webkit-column-gap: 1em;
154: }
155:
156: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
157: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
158: ul.domTree li li { list-style: none; }
159: 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; }
160: 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; }
161: ul.domTree span { font-style: italic; font-family: serif; }
162: ul.domTree .t1 code { color: purple; font-weight: bold; }
163: ul.domTree .t2 { font-style: normal; font-family: monospace; }
164: ul.domTree .t2 .name { color: black; font-weight: bold; }
165: ul.domTree .t2 .value { color: blue; font-weight: normal; }
166: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
167: ul.domTree .t7 code, .domTree .t8 code { color: green; }
168: ul.domTree .t10 code { color: teal; }
169:
170: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
171: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
172: #configUI p label { display: block; }
173: #configUI #updateUI, #configUI .loginUI { text-align: center; }
174: #configUI input[type=button] { display: block; margin: auto; }
175: </style><style type="text/css">
176:
177: .applies thead th > * { display: block; }
178: .applies thead code { display: block; }
179: .applies tbody th { whitespace: nowrap; }
180: .applies td { text-align: center; }
181: .applies .yes { background: yellow; }
182:
183: .matrix, .matrix td { border: none; text-align: right; }
184: .matrix { margin-left: 2em; }
185:
186: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
187: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
188: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
189:
190: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
191: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
192: #table-example-1 caption { padding-bottom: 0.5em; }
193: #table-example-1 thead, #table-example-1 tbody { border: none; }
194: #table-example-1 th, #table-example-1 td { border: solid thin; }
195: #table-example-1 th { font-weight: normal; }
196: #table-example-1 td { border-style: none solid; vertical-align: top; }
197: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
198: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
199: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
200: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
201: #table-example-1 tbody td:first-child::after { content: leader(". "); }
202: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
203: #table-example-1 tbody td:first-child + td { width: 10em; }
204: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
205: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
206:
207: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
208: .apple-table-examples * { font-family: "Times", serif; }
209: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
210: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
211: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
212: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
213: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
214: .apple-table-examples td { text-align: right; vertical-align: top; }
215: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
1.9 mike 216: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
217: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
218: .apple-table-examples sup { line-height: 0; }
219:
1.12 mike 220: .details-example img { vertical-align: top; }
221:
222: </style><link href="data:text/css," id="complete" rel="stylesheet" title="Complete specification"><link href="data:text/css,.impl%20%7B%20display:%20none;%20%7D" id="author" rel="alternate stylesheet" title="Author documentation only"><link href="data:text/css,.impl%20%7B%20background:%20%23FFEEEE;%20%7D" id="highlight" rel="alternate stylesheet" title="Highlight implementation requirements"><script type="text/javascript">
1.9 mike 223: function getCookie(name) {
224: var params = location.search.substr(1).split("&");
225: for (var index = 0; index < params.length; index++) {
226: if (params[index] == name)
227: return "1";
228: var data = params[index].split("=");
229: if (data[0] == name)
230: return unescape(data[1]);
231: }
232: var cookies = document.cookie.split("; ");
233: for (var index = 0; index < cookies.length; index++) {
234: var data = cookies[index].split("=");
235: if (data[0] == name)
236: return unescape(data[1]);
237: }
238: return null;
239: }
240: function load(script) {
241: var e = document.createElement('script');
242: e.setAttribute('src', 'http://www.whatwg.org/specs/web-apps/current-work/' + script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
243: document.body.appendChild(e);
244: }
245: function init() {
246: if (location.search == '?slow-browser')
247: return;
248: var configUI = document.createElement('div');
249: configUI.id = 'configUI';
250: document.body.appendChild(configUI);
251: // load('reviewer.js'); // would need cross-site XHR
252: if (document.getElementById('head'))
253: load('toc.js');
254:
255: // load('updater.js'); // would need cross-site XHR
1.12 mike 256: load('dfn.js'); // doesn't support split-out specs, but, oh well.
1.9 mike 257: // load('status.js'); // would need cross-site XHR
258: if (getCookie('profile') == '1')
259: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
260: fixBrokenLink();
261: }
262: </script><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><link href="interactive-elements.html" title="4.11 Interactive elements" rel="prev">
263: <link href="Overview.html#contents" title="Table of contents" rel="index">
1.12 mike 264: <link href="browsers.html" title="5 Web browsers" rel="next">
1.9 mike 265: </head><body onload="fixBrokenLink(); init()"><div class="head" id="head">
266: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
267: <h1>HTML5 (Author Edition)</h1>
268: </div><div>
269: <a href="interactive-elements.html">← 4.11 Interactive elements</a> –
270: <a href="Overview.html#contents">Table of contents</a> –
1.12 mike 271: <a href="browsers.html">5 Web browsers →</a>
1.13 ! mike 272: <ol class="toc"><li><ol><li><ol><li><a href="commands.html#commands"><span class="secno">4.11.5 </span>Commands</a></li></ol></li><li><a href="commands.html#common-idioms-without-dedicated-elements"><span class="secno">4.12 </span>Common idioms without dedicated elements</a>
1.9 mike 273: <ol><li><a href="commands.html#tag-clouds"><span class="secno">4.12.1 </span>Tag clouds</a></li><li><a href="commands.html#conversations"><span class="secno">4.12.2 </span>Conversations</a></li><li><a href="commands.html#footnotes"><span class="secno">4.12.3 </span>Footnotes</a></li></ol></li></ol></li></ol></div>
274:
1.13 ! mike 275: <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.9 mike 276: behind menu items, buttons, and links.<!--v2COMMAND: Once a command
277: is defined, other parts of the interface can refer to the same
278: command, allowing many access points to a single feature to share
279: aspects such as the disabled state.--></p><p id="facets">Commands are defined to have the following
280: <dfn id="concept-facet" title="concept-facet">facets</dfn>:</p><dl><dt><dfn id="command-facet-type" title="command-facet-Type">Type</dfn></dt>
281:
282: <dd>The kind of command: "command", meaning it is a normal command;
283: "radio", meaning that triggering the command will, amongst other
284: things, set the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked
285: State</a> to true (and probably uncheck some other commands); or
286: "checkbox", meaning that triggering the command will, amongst other
287: things, toggle the value of the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a>.</dd>
288:
289: <dt><dfn id="command-facet-id" title="command-facet-ID">ID</dfn></dt>
290:
291: <dd>The name of the command, for referring to the command from the
292: markup or from script. If a command has no ID, it is an
293: <dfn id="anonymous-command">anonymous command</dfn>.</dd>
294:
295: <dt><dfn id="command-facet-label" title="command-facet-Label">Label</dfn></dt>
296:
297: <dd>The name of the command as seen by the user.</dd>
298:
299: <dt><dfn id="command-facet-hint" title="command-facet-Hint">Hint</dfn></dt>
300:
301: <dd>A helpful or descriptive string that can be shown to the
302: user.</dd>
303:
304: <dt><dfn id="command-facet-icon" title="command-facet-Icon">Icon</dfn></dt>
305:
306: <dd>An <a href="urls.html#absolute-url">absolute URL</a> identifying a graphical image that
307: represents the action. A command might not have an Icon.</dd> <!--
308: changing base URLs might change the icon -->
309:
310: <dt><dfn id="command-facet-accesskey" title="command-facet-AccessKey">Access Key</dfn></dt>
311:
312: <dd>A key combination selected by the user agent that triggers the
313: command. A command might not have an Access Key.</dd>
314:
315: <dt><dfn id="command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</dfn></dt>
316:
317: <dd>Whether the command is hidden or not (basically, whether it
318: should be shown in menus).</dd>
319:
320: <dt><dfn id="command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</dfn></dt>
321:
322: <dd>Whether the command is relevant and can be triggered or not.</dd>
323:
324: <dt><dfn id="command-facet-checkedstate" title="command-facet-CheckedState">Checked State</dfn></dt>
325:
326: <dd>Whether the command is checked or not.</dd>
327:
328: <dt><dfn id="command-facet-action" title="command-facet-Action">Action</dfn></dt>
329:
330: <dd>The actual effect that triggering the command will have. This
331: could be a scripted event handler, a <a href="urls.html#url">URL</a> to which to
332: <a href="#navigate">navigate</a>, or a form submission.</dd>
333:
334: <!-- v2COMMAND
335: <dt><dfn title="command-facet-Triggers">Triggers</dfn></dt>
336:
337: <dd>The list of elements that can trigger the command. The element
338: defining a command is always in the list of elements that can
339: trigger the command. For anonymous commands, only the element
340: defining the command is on the list, since other elements have no
341: way to refer to it.</dd>
342: -->
343:
344: </dl><p>These facets are exposed on elements using the <dfn id="command-api">command
345: 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>
346:
347: <dd>
348:
349: <p>Exposes the <a href="#command-facet-type" title="command-facet-Type">Type</a> facet of the command.</p>
350:
351: </dd>
352:
353: <dt><var title="">element</var> . <code title="dom-id"><a href="#dom-id">id</a></code></dt>
354:
355: <dd>
356:
357: <p>Exposes the <a href="#command-facet-id" title="command-facet-ID">ID</a> facet of the command.</p>
358:
359: </dd>
360:
361: <dt><var title="">element</var> . <code title="dom-command-ro-label"><a href="#dom-command-ro-label">label</a></code></dt>
362:
363: <dd>
364:
365: <p>Exposes the <a href="#command-facet-label" title="command-facet-Label">Label</a> facet of the command.</p>
366:
367: </dd>
368:
1.11 mike 369: <dt><var title="">element</var> . <code title="dom-title"><a href="#dom-title">title</a></code></dt>
370:
371: <dd>
372:
373: <p>Exposes the <a href="#command-facet-hint" title="command-facet-Hint">Hint</a> facet of the command.</p>
374:
375: </dd>
376:
377: <dt><var title="">element</var> . <code title="dom-command-ro-icon"><a href="#dom-command-ro-icon">icon</a></code></dt>
378:
379: <dd>
380:
381: <p>Exposes the <a href="#command-facet-icon" title="command-facet-Icon">Icon</a> facet of the command.</p>
382:
383: </dd>
384:
385: <dt><var title="">element</var> . <code title="dom-accessKeyLabel"><a href="#dom-accesskeylabel">accessKeyLabel</a></code></dt>
386:
387: <dd>
388:
389: <p>Exposes the <a href="#command-facet-accesskey" title="command-facet-AccessKey">Access Key</a> facet of the command.</p>
390:
391: </dd>
392:
393: <dt><var title="">element</var> . <code title="dom-hidden"><a href="#dom-hidden">hidden</a></code></dt>
394:
395: <dd>
396:
397: <p>Exposes the <a href="#command-facet-hiddenstate" title="command-facet-HiddenState">Hidden State</a> facet of the command.</p>
398:
399: </dd>
400:
401: <dt><var title="">element</var> . <code title="dom-command-ro-disabled"><a href="#dom-command-ro-disabled">disabled</a></code></dt>
402:
403: <dd>
404:
405: <p>Exposes the <a href="#command-facet-disabledstate" title="command-facet-DisabledState">Disabled State</a> facet of the command.</p>
406:
407: </dd>
408:
409: <dt><var title="">element</var> . <code title="dom-command-ro-checked"><a href="#dom-command-ro-checked">checked</a></code></dt>
410:
411: <dd>
412:
413: <p>Exposes the <a href="#command-facet-checkedstate" title="command-facet-CheckedState">Checked State</a> facet of the command.</p>
414:
415: </dd>
416:
417: <dt><var title="">element</var> . <code title="dom-click"><a href="#dom-click">click</a></code>()</dt>
418:
419: <dd>
420:
421: <p>Triggers the <a href="#command-facet-action" title="command-facet-Action">Action</a> of the command.</p>
422:
423: </dd>
424:
425: <!--v2COMMAND
426: <dt><var title="">element</var> . <code title="dom-command-ro-triggers">triggers</code></dt>
427:
428: <dd>
429:
430: <p>Exposes the <span title="command-facet-Triggers">Triggers</span> facet of the command.</p>
431:
432: </dd>
433: -->
434:
435: </dl><hr><dl class="domintro"><dt><var title="">document</var> . <code title="dom-document-commands"><a href="#dom-document-commands">commands</a></code></dt>
436: <dd>
437: <p>Returns an <code><a href="urls.html#htmlcollection">HTMLCollection</a></code> of the elements in the
438: <code>Document</code> that define commands and have IDs.</p>
439: </dd>
440:
441: </dl><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
442: (visible), e.g. in the user agent's menu bar. User agents are
443: 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
444: advertise those keys to the user.</p><h3 id="common-idioms-without-dedicated-elements"><span class="secno">4.12 </span>Common idioms without dedicated elements</h3><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i></p><h4 id="tag-clouds"><span class="secno">4.12.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
445: specifically for marking up lists of keywords that apply to a group
446: of pages (also known as <i>tag clouds</i>). In general, authors are
447: encouraged to either mark up such lists using <code><a href="grouping-content.html#the-ul-element">ul</a></code>
448: elements with explicit inline counts that are then hidden and turned
449: into a presentational effect using a style sheet, or to use SVG.</p><div class="example">
450:
451: <p>Here, three tags are included in a short tag cloud:</p>
452:
453: <pre><style>
454: @media screen, print, handheld, tv {
455: /* should be ignored by non-visual browsers */
456: .tag-cloud > li > span { display: none; }
457: .tag-cloud > li { display: inline; }
458: .tag-cloud-1 { font-size: 0.7em; }
459: .tag-cloud-2 { font-size: 0.9em; }
460: .tag-cloud-3 { font-size: 1.1em; }
461: .tag-cloud-4 { font-size: 1.3em; }
462: .tag-cloud-5 { font-size: 1.5em; }
463: }
464: </style>
465: ...
466: <ul class="tag-cloud">
467: <li class="tag-cloud-4"><a title="28 instances" href="/t/apple">apple</a> <span>(popular)</span>
468: <li class="tag-cloud-2"><a title="6 instances" href="/t/kiwi">kiwi</a> <span>(rare)</span>
469: <li class="tag-cloud-5"><a title="41 instances" href="/t/pear">pear</a> <span>(very popular)</span>
470: </ul></pre>
471:
472: <p>The actual frequency of each tag is given using the <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute. A CSS style sheet is
473: provided to convert the markup into a cloud of differently-sized
474: words, but for user agents that do not support CSS or are not
475: visual, the markup contains annotations like "(popular)" or
476: "(rare)" to categorize the various tags by frequency, thus enabling
477: all users to benefit from the information.</p>
478:
479: <p>The <code><a href="grouping-content.html#the-ul-element">ul</a></code> element is used (rather than
480: <code><a href="grouping-content.html#the-ol-element">ol</a></code>) because the order is not particular important:
481: while the list is in fact ordered alphabetically, it would convey
482: the same information if ordered by, say, the length of the tag.</p>
483:
484: <p>The <code title="rel-tag"><a href="links.html#link-type-tag">tag</a></code> <code title="attr-hyperlink-rel"><a href="links.html#attr-hyperlink-rel">rel</a></code>-keyword is <em>not</em> used
485: on these <code><a href="text-level-semantics.html#the-a-element">a</a></code> elements because they do not represent tags
486: that apply to the page itself; they are just part of an index
487: listing the tags themselves.</p>
488:
489: </div><h4 id="conversations"><span class="secno">4.12.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
490: up conversations, meeting minutes, chat transcripts, dialogues in
491: screenplays, instant message logs, and other situations where
492: different players take turns in discourse.</p><p>Instead, authors are encouraged to mark up conversations using
493: <code><a href="grouping-content.html#the-p-element">p</a></code> elements and punctuation. Authors who need to mark
494: the speaker for styling purposes are encouraged to use
495: <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
496: wrapped in the <code><a href="text-level-semantics.html#the-i-element">i</a></code> element can be used for marking up
497: stage directions.</p><div class="example">
498:
499: <p>This example demonstrates this using an extract from Abbot and
500: Costello's famous sketch, <cite>Who's on first</cite>:</p>
501:
502: <pre><p> Costello: Look, you gotta first baseman?
503: <p> Abbott: Certainly.
504: <p> Costello: Who's playing first?
505: <p> Abbott: That's right.
506: <p> Costello becomes exasperated.
507: <p> Costello: When you pay off the first baseman every month, who gets the money?
508: <p> Abbott: Every dollar of it.</pre>
509:
510: </div><div class="example">
511:
512: <p>The following extract shows how an IM conversation log could be
513: marked up.</p>
514:
515: <pre><p> <time>14:22</time> <b>egof</b> I'm not that nerdy, I've only seen 30% of the star trek episodes
516: <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
517: <p> <time>14:23</time> <b>egof</b> it's unarguably
518: <p> <time>14:23</time> <i>* kaj blinks</i>
519: <p> <time>14:24</time> <b>kaj</b> you are not helping your case</pre>
520: <!-- with thanks to http://bash.org/?854262 -->
521:
522: </div><h4 id="footnotes"><span class="secno">4.12.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
523: footnotes. Here are the recommended alternatives.</p><hr><p>For short inline annotations, the <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute should be used.</p><div class="example">
524:
525: <p>In this example, two parts of a dialogue are annotated with
526: footnote-like content using the <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute.</p>
527:
528: <pre><p> <b>Customer</b>: Hello! I wish to register a complaint. Hello. Miss?
529: <p> <b>Shopkeeper</b>: <strong><span title="Colloquial pronunciation of 'What do you'"</strong>
530: >Watcha</span> mean, miss?
531: <p> <b>Customer</b>: Uh, I'm sorry, I have a cold. I wish to make a complaint.
532: <p> <b>Shopkeeper</b>: Sorry, <span <strong>title="This is, of course, a lie."</strong>>we're
533: closing for lunch</span>.</pre>
534:
535: </div><hr><p>For longer annotations, the <code><a href="text-level-semantics.html#the-a-element">a</a></code> element should be
536: used, pointing to an element later in the document. The convention
537: is that the contents of the link be a number in square brackets.</p><div class="example">
538:
539: <p>In this example, a footnote in the dialogue links to a paragraph
540: below the dialogue. The paragraph then reciprocally links back to the
541: dialogue, allowing the user to return to the location of the
542: footnote.</p>
543:
544: <pre><p> Announcer: Number 16: The <i>hand</i>.
545: <p> Interviewer: Good evening. I have with me in the studio tonight
546: Mr Norman St John Polevaulter, who for the past few years has been
547: contradicting people. Mr Polevaulter, why <em>do</em> you
548: contradict people?
549: <p> Norman: I don't. <sup><a href="#fn1" id="r1">[1]</a></sup>
550: <p> Interviewer: You told me you did!
551: <em>...</em>
552: <section>
553: <p id="fn1"><a href="#r1">[1]</a> This is, naturally, a lie,
554: but paradoxically if it were true he could not say so without
555: contradicting the interviewer and thus making it false.</p>
556: </section></pre>
557:
558: </div><hr><p>For side notes, longer annotations that apply to entire sections
559: of the text rather than just specific words or sentences, the
560: <code><a href="sections.html#the-aside-element">aside</a></code> element should be used.</p><div class="example">
561:
562: <p>In this example, a sidebar is given after a dialogue, giving it
563: some context.</p>
564:
565: <pre><p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
566: <p> <span class="speaker">Shopkeeper</span>: I'm sorry?
567: <p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched.
568: <p> <span class="speaker">Shopkeeper</span>: No no no, this's'a tobacconist's.
569: <aside>
570: <p>In 1970, the British Empire lay in ruins, and foreign
571: nationalists frequented the streets — many of them Hungarians
572: (not the streets — the foreign nationals). Sadly, Alexander
573: Yalt has been publishing incompetently-written phrase books.
574: </aside></pre>
575:
576: </div><hr><p>For figures or tables, footnotes can be included in the relevant
1.13 ! mike 577: <code><a href="embedded-content-1.html#the-figcaption-element">figcaption</a></code> or <code><a href="tabular-data.html#the-caption-element">caption</a></code> element, or in
! 578: surrounding prose.</p><div class="example">
1.11 mike 579:
580: <p>In this example, a <!-- round --> table has cells with footnotes
581: that are given in prose. A <code><a href="embedded-content-1.html#the-figure-element">figure</a></code> element is used to
582: give a single legend to the combination of the table and its
583: footnotes.</p>
584:
585: <pre><figure>
1.13 ! mike 586: <figcaption>Table 1. Alternative activities for knights.</figcaption>
! 587: <table>
! 588: <tr>
! 589: <th> Activity
! 590: <th> Location
! 591: <th> Cost
! 592: <tr>
! 593: <td> Dance
! 594: <td> Wherever possible
! 595: <td> £0<sup><a href="#fn1">1</a></sup>
! 596: <tr>
! 597: <td> Routines, chorus scenes<sup><a href="#fn2">2</a></sup>
! 598: <td> Undisclosed
! 599: <td> Undisclosed
! 600: <tr>
! 601: <td> Dining<sup><a href="#fn3">3</a></sup>
! 602: <td> Camelot
! 603: <td> Cost of ham, jam, and spam<sup><a href="#fn4">4</a></sup>
! 604: </table>
! 605: <p id="fn1">1. Assumed.</p>
! 606: <p id="fn2">2. Footwork impeccable.</p>
! 607: <p id="fn3">3. Quality described as "well".</p>
! 608: <p id="fn4">4. A lot.</p>
1.11 mike 609: </figure></pre>
610:
611: </div></body></html>
Webmaster
![[BACK]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/back.gif?vpn-1){kind=icon}
Return to commands.html CVS log ![[TXT]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/text.gif?vpn-1){kind=icon}
![[DIR]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/dir.gif?vpn-1){kind=icon}
Up to [Public] / html5 / spec-author-view