HTML 5 Specs
HTML 5 Specs
view the open bugs: HTML bug list file bugs, use the "submit review comments" feature at the bottom of the window send feedback by e-mail: [email protected] view and vote on e-mail feedback: http://www.whatwg.org/issues/
Abstract
This specification evolves HTML and its related APIs to ease the authoring of Web-based applications. The most recent additions include a device p437 element to enable video conferencing, as well as all the features added as part of the earlier HTML5 effort.
Table of contents
1 Introduction ........................................................................................................................................... 16 1.1 Is this HTML5?..................................................................................................................... 16 1.2 Background......................................................................................................................... 16 1.3 Audience............................................................................................................................. 17 1.4 Scope.................................................................................................................................. 17 1.5 History ................................................................................................................................ 17 1.6 Design notes....................................................................................................................... 18 1.6.1 Serializability of script execution ..................................................................... 18 1.6.2 Compliance with other specifications............................................................... 18 1.7 HTML vs XHTML .................................................................................................................. 19 1.8 Structure of this specification ............................................................................................. 19 1.8.1 How to read this specification .......................................................................... 20 1.8.2 Typographic conventions ................................................................................. 20 1.9 A quick introduction to HTML .............................................................................................. 20 1.10 Conformance requirements for authors ............................................................................ 22 1.10.1 Presentational markup ................................................................................... 22 1.10.2 Syntax errors ................................................................................................. 23 1.10.3 Restrictions on content models and on attribute values ................................ 25 1.11 Recommended reading..................................................................................................... 26 2 Common infrastructure ......................................................................................................................... 28 2.1 Terminology ........................................................................................................................ 28 2.1.1 Resources ........................................................................................................ 28 2.1.2 XML .................................................................................................................. 28 2.1.3 DOM trees ........................................................................................................ 29 2.1.4 Scripting........................................................................................................... 29 2.1.5 Plugins ............................................................................................................. 29 2.1.6 Character encodings ........................................................................................ 30 2.2 Conformance requirements ................................................................................................ 30 2.2.1 Dependencies .................................................................................................. 33 2.2.2 Extensibility ..................................................................................................... 34 2.3 Case-sensitivity and string comparison .............................................................................. 36 2.4 UTF-8 .................................................................................................................................. 36 2.5 Common microsyntaxes ..................................................................................................... 37 2.5.1 Common parser idioms .................................................................................... 37 2.5.2 Boolean attributes ........................................................................................... 38 2.5.3 Keywords and enumerated attributes .............................................................. 38 2.5.4 Numbers .......................................................................................................... 39 2.5.4.1 Non-negative integers................................................................... 39 2.5.4.2 Signed integers ............................................................................. 39 2.5.4.3 Real numbers ................................................................................ 40 2.5.4.4 Percentages and lengths ............................................................... 41 2.5.4.5 Lists of integers............................................................................. 42 2.5.4.6 Lists of dimensions........................................................................ 43 2.5.5 Dates and times............................................................................................... 44 2.5.5.1 Months .......................................................................................... 44 2.5.5.2 Dates............................................................................................. 45 2.5.5.3 Times ............................................................................................ 46 2.5.5.4 Local dates and times ................................................................... 47 2.5.5.5 Global dates and times ................................................................. 47 2.5.5.6 Weeks............................................................................................ 49 2.5.5.7 Vaguer moments in time ............................................................... 50 2.5.6 Colors............................................................................................................... 51 2.5.7 Space-separated tokens................................................................................... 53 2.5.8 Comma-separated tokens ................................................................................ 54 2.5.9 References ....................................................................................................... 54 2.5.10 Media queries ................................................................................................ 55 2.6 URLs ................................................................................................................................... 55 2.6.1 Terminology ..................................................................................................... 55 2.6.2 Dynamic changes to base URLs ....................................................................... 57 2.6.3 Interfaces for URL manipulation....................................................................... 57 2.7 Fetching resources.............................................................................................................. 59 2.7.1 Protocol concepts............................................................................................. 61 2.7.2 Encrypted HTTP and related security concerns................................................ 61 2.7.3 Determining the type of a resource ................................................................. 61 2.8 Common DOM interfaces .................................................................................................... 62
2.8.1 Reflecting content attributes in IDL attributes ................................................. 62 2.8.2 Collections ....................................................................................................... 64 2.8.2.1 HTMLCollection.............................................................................. 64 2.8.2.2 HTMLAllCollection.......................................................................... 65 2.8.2.3 HTMLFormControlsCollection......................................................... 66 2.8.2.4 HTMLOptionsCollection ................................................................. 67 2.8.2.5 HTMLPropertiesCollection.............................................................. 69 2.8.3 DOMTokenList................................................................................................... 70 2.8.4 DOMSettableTokenList ..................................................................................... 72 2.8.5 Safe passing of structured data ....................................................................... 72 2.8.6 DOMStringMap ................................................................................................. 73 2.8.7 DOMElementMap ............................................................................................. 74 2.8.8 DOM feature strings ......................................................................................... 75 2.8.9 Exceptions ....................................................................................................... 75 2.8.10 Garbage collection ......................................................................................... 75 2.9 Namespaces ....................................................................................................................... 75 3 Semantics, structure, and APIs of HTML documents.............................................................................. 77 3.1 Documents ......................................................................................................................... 77 3.1.1 Documents in the DOM .................................................................................... 77 3.1.2 Security............................................................................................................ 79 3.1.3 Resource metadata management .................................................................... 79 3.1.4 DOM tree accessors ......................................................................................... 82 3.1.5 Creating documents......................................................................................... 86 3.1.6 Loading XML documents .................................................................................. 86 3.2 Elements............................................................................................................................. 87 3.2.1 Semantics ........................................................................................................ 87 3.2.2 Elements in the DOM ....................................................................................... 88 3.2.3 Global attributes .............................................................................................. 90 3.2.3.1 The id attribute ............................................................................ 92 3.2.3.2 The title attribute....................................................................... 92 3.2.3.3 The lang and xml:lang attributes ................................................ 92 3.2.3.4 The xml:base attribute (XML only) ............................................... 93 3.2.3.5 The dir attribute........................................................................... 93 3.2.3.6 The class attribute....................................................................... 95 3.2.3.7 The style attribute....................................................................... 95 3.2.3.8 Embedding custom non-visible data with the data-* attributes... 96 3.2.4 Element definitions .......................................................................................... 98 3.2.4.1 Attributes ...................................................................................... 98 3.2.5 Content models................................................................................................ 98 3.2.5.1 Kinds of content ............................................................................ 99 3.2.5.1.1 Metadata content ....................................................... 99 3.2.5.1.2 Flow content ............................................................. 100 3.2.5.1.3 Sectioning content.................................................... 100 3.2.5.1.4 Heading content ....................................................... 100 3.2.5.1.5 Phrasing content ...................................................... 100 3.2.5.1.6 Embedded content ................................................... 101 3.2.5.1.7 Interactive content ................................................... 101 3.2.5.2 Transparent content models........................................................ 102 3.2.5.3 Paragraphs .................................................................................. 102 3.2.6 Requirements relating to bidirectional-algorithm formatting characters ....... 104 3.2.7 Annotations for assistive technology products (ARIA).................................... 104 3.3 APIs in HTML documents................................................................................................... 108 3.4 Interactions with XPath and XSLT...................................................................................... 109 3.5 Dynamic markup insertion................................................................................................ 109 3.5.1 Opening the input stream .............................................................................. 109 3.5.2 Closing the input stream................................................................................ 111 3.5.3 document.write() ........................................................................................ 111 3.5.4 document.writeln() .................................................................................... 112 3.5.5 innerHTML...................................................................................................... 112 3.5.6 outerHTML...................................................................................................... 113 3.5.7 insertAdjacentHTML()................................................................................. 114 4 The elements of HTML......................................................................................................................... 116 4.1 The root element .............................................................................................................. 116 4.1.1 The html element .......................................................................................... 116 4.2 Document metadata......................................................................................................... 116 4.2.1 The head element .......................................................................................... 116 4.2.2 The title element ........................................................................................ 117 4.2.3 The base element .......................................................................................... 118
4.2.4 The link element .......................................................................................... 119 4.2.5 The meta element .......................................................................................... 122 4.2.5.1 Standard metadata names.......................................................... 123 4.2.5.2 Other metadata names ............................................................... 124 4.2.5.3 Pragma directives ....................................................................... 125 4.2.5.4 Other pragma directives ............................................................. 128 4.2.5.5 Specifying the document's character encoding .......................... 129 4.2.6 The style element ........................................................................................ 130 4.2.7 Styling............................................................................................................ 132 4.3 Scripting ........................................................................................................................... 133 4.3.1 The script element ...................................................................................... 133 4.3.1.1 Scripting languages..................................................................... 139 4.3.1.2 Restrictions for contents of script elements ............................. 139 4.3.1.3 Inline documentation for external scripts.................................... 140 4.3.2 The noscript element................................................................................... 140 4.4 Sections ............................................................................................................................ 142 4.4.1 The body element .......................................................................................... 142 4.4.2 The section element .................................................................................... 144 4.4.3 The nav element ............................................................................................ 145 4.4.4 The article element .................................................................................... 147 4.4.5 The aside element ........................................................................................ 148 4.4.6 The h1, h2, h3, h4, h5, and h6 elements ........................................................ 150 4.4.7 The hgroup element ...................................................................................... 151 4.4.8 The header element ...................................................................................... 152 4.4.9 The footer element ...................................................................................... 153 4.4.10 The address element .................................................................................. 154 4.4.11 Headings and sections ................................................................................. 155 4.4.11.1 Creating an outline.................................................................... 157 4.5 Grouping content.............................................................................................................. 160 4.5.1 The p element ................................................................................................ 160 4.5.2 The hr element .............................................................................................. 161 4.5.3 The pre element ............................................................................................ 162 4.5.4 The blockquote element............................................................................... 163 4.5.5 The ol element .............................................................................................. 164 4.5.6 The ul element .............................................................................................. 166 4.5.7 The li element .............................................................................................. 166 4.5.8 The dl element .............................................................................................. 168 4.5.9 The dt element .............................................................................................. 169 4.5.10 The dd element ............................................................................................ 170 4.5.11 The figure element .................................................................................... 170 4.5.12 The figcaption element............................................................................. 172 4.5.13 The div element .......................................................................................... 172 4.6 Text-level semantics ......................................................................................................... 173 4.6.1 The a element ................................................................................................ 173 4.6.2 The em element .............................................................................................. 175 4.6.3 The strong element ...................................................................................... 176 4.6.4 The small element ........................................................................................ 176 4.6.5 The s element ................................................................................................ 177 4.6.6 The cite element .......................................................................................... 178 4.6.7 The q element ................................................................................................ 179 4.6.8 The dfn element ............................................................................................ 180 4.6.9 The abbr element .......................................................................................... 180 4.6.10 The time element ........................................................................................ 182 4.6.11 The code element ........................................................................................ 184 4.6.12 The var element .......................................................................................... 185 4.6.13 The samp element ........................................................................................ 186 4.6.14 The kbd element .......................................................................................... 186 4.6.15 The sub and sup elements ........................................................................... 187 4.6.16 The i element .............................................................................................. 187 4.6.17 The b element .............................................................................................. 188 4.6.18 The mark element ........................................................................................ 189 4.6.19 The ruby element ........................................................................................ 191 4.6.20 The rt element ............................................................................................ 192 4.6.21 The rp element ............................................................................................ 192 4.6.22 The bdi element .......................................................................................... 193 4.6.23 The bdo element .......................................................................................... 193 4.6.24 The span element ........................................................................................ 194 4.6.25 The br element ............................................................................................ 194 4.6.26 The wbr element .......................................................................................... 195
4.6.27 Usage summary ........................................................................................... 195 4.7 Edits.................................................................................................................................. 196 4.7.1 The ins element ............................................................................................ 196 4.7.2 The del element ............................................................................................ 197 4.7.3 Attributes common to ins and del elements ................................................ 198 4.7.4 Edits and paragraphs ..................................................................................... 198 4.7.5 Edits and lists................................................................................................. 199 4.8 Embedded content ........................................................................................................... 199 4.8.1 The img element ............................................................................................ 199 4.8.1.1 Requirements for providing text to act as an alternative for images .................................................................................................... 205 4.8.1.1.1 General guidelines.................................................... 205 4.8.1.1.2 A link or button containing nothing but the image ... 205 4.8.1.1.3 A phrase or paragraph with an alternative graphical representation: charts, diagrams, graphs, maps, illustrations. 206 4.8.1.1.4 A short phrase or label with an alternative graphical representation: icons, logos .................................................... 206 4.8.1.1.5 Text that has been rendered to a graphic for typographical effect ................................................................ 208 4.8.1.1.6 A graphical representation of some of the surrounding text .......................................................................................... 208 4.8.1.1.7 A purely decorative image that doesn't add any information .............................................................................. 209 4.8.1.1.8 A group of images that form a single larger picture with no links .................................................................................... 209 4.8.1.1.9 A group of images that form a single larger picture with links ......................................................................................... 210 4.8.1.1.10 A key part of the content........................................ 210 4.8.1.1.11 An image not intended for the user........................ 212 4.8.1.1.12 An image in an e-mail or private document intended for a specific person who is known to be able to view images 212 4.8.1.1.13 Guidance for markup generators............................ 213 4.8.1.1.14 Guidance for conformance checkers ...................... 213 4.8.2 The iframe element ...................................................................................... 213 4.8.3 The embed element ........................................................................................ 220 4.8.4 The object element ...................................................................................... 222 4.8.5 The param element ........................................................................................ 227 4.8.6 The video element ........................................................................................ 228 4.8.7 The audio element ........................................................................................ 231 4.8.8 The source element ...................................................................................... 232 4.8.9 The track element ........................................................................................ 234 4.8.10 Media elements............................................................................................ 235 4.8.10.1 Error codes ................................................................................ 236 4.8.10.2 Location of the media resource ................................................. 237 4.8.10.3 MIME types ................................................................................ 237 4.8.10.4 Network states .......................................................................... 238 4.8.10.5 Loading the media resource ...................................................... 239 4.8.10.6 Offsets into the media resource ................................................ 246 4.8.10.7 The ready states ....................................................................... 248 4.8.10.8 Playing the media resource ....................................................... 249 4.8.10.9 Seeking ..................................................................................... 253 4.8.10.10 Timed text tracks .................................................................... 254 4.8.10.10.1 Text track model ................................................... 254 4.8.10.10.2 Sourcing in-band text tracks................................. 257 4.8.10.10.3 Sourcing out-of-band text tracks .......................... 257 4.8.10.10.4 Guidelines for exposing cues in various formats as text track cues......................................................................... 259 4.8.10.10.5 Text track API........................................................ 260 4.8.10.10.6 Event definitions................................................... 267 4.8.10.11 WebVTT ................................................................................... 267 4.8.10.11.1 Syntax .................................................................. 267 4.8.10.11.2 Parsing.................................................................. 271 4.8.10.11.3 WebVTT cue text parsing rules ............................. 277 4.8.10.11.4 WebVTT cue text DOM construction rules............. 281 4.8.10.12 User interface.......................................................................... 281 4.8.10.13 Time ranges ............................................................................ 283 4.8.10.14 Event summary ....................................................................... 283 4.8.10.15 Security and privacy considerations ....................................... 285 4.8.10.16 Best practices for authors using media elements ................... 285 4.8.10.17 Best practices for implementors of media elements ............... 285
4.8.11 The canvas element .................................................................................... 286 4.8.11.1 The 2D context.......................................................................... 289 4.8.11.1.1 The canvas state .................................................... 291 4.8.11.1.2 Transformations ...................................................... 291 4.8.11.1.3 Compositing ........................................................... 292 4.8.11.1.4 Colors and styles .................................................... 294 4.8.11.1.5 Line styles .............................................................. 296 4.8.11.1.6 Shadows ................................................................. 298 4.8.11.1.7 Simple shapes (rectangles) .................................... 299 4.8.11.1.8 Complex shapes (paths) ......................................... 299 4.8.11.1.9 Focus management ................................................ 302 4.8.11.1.10 Text....................................................................... 303 4.8.11.1.11 Images.................................................................. 307 4.8.11.1.12 Pixel manipulation ................................................ 308 4.8.11.1.13 Drawing model ..................................................... 311 4.8.11.1.14 Examples .............................................................. 312 4.8.11.2 Color spaces and color correction ............................................. 312 4.8.11.3 Security with canvas elements ................................................. 313 4.8.12 The map element .......................................................................................... 313 4.8.13 The area element ........................................................................................ 314 4.8.14 Image maps ................................................................................................. 317 4.8.14.1 Authoring .................................................................................. 317 4.8.14.2 Processing model ...................................................................... 317 4.8.15 MathML ........................................................................................................ 319 4.8.16 SVG .............................................................................................................. 320 4.8.17 Dimension attributes ................................................................................... 320 4.9 Tabular data ...................................................................................................................... 320 4.9.1 The table element ........................................................................................ 320 4.9.2 The caption element .................................................................................... 327 4.9.3 The colgroup element................................................................................... 328 4.9.4 The col element ............................................................................................ 328 4.9.5 The tbody element ........................................................................................ 328 4.9.6 The thead element ........................................................................................ 329 4.9.7 The tfoot element ........................................................................................ 330 4.9.8 The tr element .............................................................................................. 331 4.9.9 The td element .............................................................................................. 332 4.9.10 The th element ............................................................................................ 332 4.9.11 Attributes common to td and th elements .................................................. 334 4.9.12 Processing model ......................................................................................... 335 4.9.12.1 Forming a table ......................................................................... 335 4.9.12.2 Forming relationships between data cells and header cells ...... 338 4.9.13 Examples ..................................................................................................... 340 4.10 Forms.............................................................................................................................. 342 4.10.1 Introduction.................................................................................................. 342 4.10.1.1 Writing a form's user interface .................................................. 342 4.10.1.2 Implementing the server-side processing for a form ................. 344 4.10.1.3 Configuring a form to communicate with a server .................... 345 4.10.1.4 Client-side form validation ........................................................ 346 4.10.2 Categories.................................................................................................... 347 4.10.3 The form element ........................................................................................ 347 4.10.4 The fieldset element................................................................................. 350 4.10.5 The legend element .................................................................................... 351 4.10.6 The label element ...................................................................................... 352 4.10.7 The input element ...................................................................................... 353 4.10.7.1 States of the type attribute ...................................................... 358 4.10.7.1.1 Hidden state ........................................................... 358 4.10.7.1.2 Text state and Search state .................................... 358 4.10.7.1.3 Telephone state ...................................................... 359 4.10.7.1.4 URL state ................................................................ 359 4.10.7.1.5 E-mail state ............................................................ 360 4.10.7.1.6 Password state ....................................................... 362 4.10.7.1.7 Date and Time state ............................................... 362 4.10.7.1.8 Date state............................................................... 363 4.10.7.1.9 Month state ............................................................ 364 4.10.7.1.10 Week state............................................................ 365 4.10.7.1.11 Time state ............................................................ 366 4.10.7.1.12 Local Date and Time state .................................... 366 4.10.7.1.13 Number state ....................................................... 368 4.10.7.1.14 Range state .......................................................... 368 4.10.7.1.15 Color state ............................................................ 370
4.10.7.1.16 Checkbox state..................................................... 370 4.10.7.1.17 Radio Button state................................................ 371 4.10.7.1.18 File Upload state ................................................... 372 4.10.7.1.19 Submit Button state ............................................. 373 4.10.7.1.20 Image Button state............................................... 373 4.10.7.1.21 Reset Button state ................................................ 375 4.10.7.1.22 Button state.......................................................... 375 4.10.7.2 Common input element attributes ........................................... 376 4.10.7.2.1 The autocomplete attribute................................... 376 4.10.7.2.2 The dirname attribute ............................................ 376 4.10.7.2.3 The list attribute .................................................. 377 4.10.7.2.4 The readonly attribute .......................................... 378 4.10.7.2.5 The size attribute .................................................. 379 4.10.7.2.6 The required attribute .......................................... 379 4.10.7.2.7 The multiple attribute .......................................... 379 4.10.7.2.8 The maxlength attribute ........................................ 380 4.10.7.2.9 The pattern attribute ............................................ 380 4.10.7.2.10 The min and max attributes................................... 381 4.10.7.2.11 The step attribute ................................................ 381 4.10.7.2.12 The placeholder attribute................................... 382 4.10.7.3 Common input element APIs.................................................... 382 4.10.7.4 Common event behaviors ......................................................... 385 4.10.8 The button element .................................................................................... 385 4.10.9 The select element .................................................................................... 387 4.10.10 The datalist element............................................................................... 391 4.10.11 The optgroup element............................................................................... 392 4.10.12 The option element .................................................................................. 393 4.10.13 The textarea element............................................................................... 395 4.10.14 The keygen element .................................................................................. 398 4.10.15 The output element .................................................................................. 400 4.10.16 The progress element............................................................................... 402 4.10.17 The meter element .................................................................................... 403 4.10.18 Association of controls and forms .............................................................. 407 4.10.19 Attributes common to form controls .......................................................... 408 4.10.19.1 Naming form controls.............................................................. 408 4.10.19.2 Enabling and disabling form controls ...................................... 409 4.10.19.3 A form control's value ............................................................. 409 4.10.19.4 Autofocusing a form control .................................................... 409 4.10.19.5 Limiting user input length ....................................................... 410 4.10.19.6 Form submission ..................................................................... 410 4.10.19.7 Submitting element directionality ........................................... 411 4.10.20 APIs for the text field selections................................................................. 411 4.10.21 Constraints................................................................................................. 412 4.10.21.1 Definitions ............................................................................... 412 4.10.21.2 Constraint validation ............................................................... 413 4.10.21.3 The constraint validation API................................................... 414 4.10.21.4 Security ................................................................................... 416 4.10.22 Form submission ........................................................................................ 416 4.10.22.1 Introduction............................................................................. 416 4.10.22.2 Implicit submission.................................................................. 416 4.10.22.3 Form submission algorithm ..................................................... 417 4.10.22.4 URL-encoded form data........................................................... 420 4.10.22.5 Multipart form data ................................................................. 421 4.10.22.6 Plain text form data................................................................. 422 4.10.23 Resetting a form ........................................................................................ 422 4.10.24 Event dispatch ........................................................................................... 423 4.11 Interactive elements....................................................................................................... 423 4.11.1 The details element .................................................................................. 423 4.11.2 The summary element .................................................................................. 426 4.11.3 The command element .................................................................................. 427 4.11.4 The menu element ........................................................................................ 428 4.11.4.1 Introduction............................................................................... 429 4.11.4.2 Building menus and toolbars..................................................... 430 4.11.4.3 Context menus .......................................................................... 431 4.11.4.4 Toolbars ..................................................................................... 432 4.11.5 Commands................................................................................................... 432 4.11.5.1 Using the a element to define a command ............................... 434 4.11.5.2 Using the button element to define a command ...................... 434 4.11.5.3 Using the input element to define a command........................ 434 4.11.5.4 Using the option element to define a command ...................... 435
4.11.5.5 Using the command element to define a command .................... 435 4.11.5.6 Using the accesskey attribute on a label element to define a command ................................................................................................ 436 4.11.5.7 Using the accesskey attribute on a legend element to define a command ................................................................................................ 436 4.11.5.8 Using the accesskey attribute to define a command on other elements ................................................................................................. 436 4.11.6 The device element .................................................................................... 437 4.11.6.1 Stream API ................................................................................ 438 4.11.6.2 Peer-to-peer connections .......................................................... 438 4.12 Links ............................................................................................................................... 440 4.12.1 Introduction.................................................................................................. 440 4.12.2 Links created by a and area elements......................................................... 440 4.12.3 Following hyperlinks..................................................................................... 441 4.12.3.1 Hyperlink auditing ..................................................................... 441 4.12.4 Link types .................................................................................................... 442 4.12.4.1 Link type "alternate" .............................................................. 443 4.12.4.2 Link type "archives" ................................................................ 444 4.12.4.3 Link type "author" .................................................................... 444 4.12.4.4 Link type "bookmark" ................................................................ 444 4.12.4.5 Link type "external" ................................................................ 445 4.12.4.6 Link type "help" ........................................................................ 445 4.12.4.7 Link type "icon" ........................................................................ 445 4.12.4.8 Link type "license" .................................................................. 446 4.12.4.9 Link type "nofollow" ................................................................ 447 4.12.4.10 Link type "noreferrer"........................................................... 447 4.12.4.11 Link type "pingback" .............................................................. 447 4.12.4.12 Link type "prefetch" .............................................................. 447 4.12.4.13 Link type "search" .................................................................. 447 4.12.4.14 Link type "stylesheet"........................................................... 447 4.12.4.15 Link type "sidebar" ................................................................ 448 4.12.4.16 Link type "tag"........................................................................ 448 4.12.4.17 Hierarchical link types ............................................................. 448 4.12.4.17.1 Link type "index" ................................................. 448 4.12.4.17.2 Link type "up" ....................................................... 448 4.12.4.18 Sequential link types ............................................................... 449 4.12.4.18.1 Link type "first" ................................................. 449 4.12.4.18.2 Link type "last" ................................................... 449 4.12.4.18.3 Link type "next" ................................................... 449 4.12.4.18.4 Link type "prev" ................................................... 450 4.12.4.19 Other link types....................................................................... 450 4.13 Common idioms without dedicated elements................................................................. 451 4.13.1 The main part of the content ....................................................................... 451 4.13.2 Tag clouds .................................................................................................... 453 4.13.3 Conversations .............................................................................................. 453 4.13.4 Footnotes ..................................................................................................... 454 4.14 Matching HTML elements using selectors....................................................................... 455 4.14.1 Case-sensitivity............................................................................................ 455 4.14.2 Pseudo-classes............................................................................................. 456 5 Microdata ............................................................................................................................................ 459 5.1 Introduction ...................................................................................................................... 459 5.1.1 Overview........................................................................................................ 459 5.1.2 The basic syntax ............................................................................................ 459 5.1.3 Typed items.................................................................................................... 461 5.1.4 Global identifiers for items............................................................................. 461 5.1.5 Selecting names when defining vocabularies ................................................ 461 5.1.6 Using the microdata DOM API ........................................................................ 462 5.2 Encoding microdata .......................................................................................................... 463 5.2.1 The microdata model ..................................................................................... 463 5.2.2 Items.............................................................................................................. 464 5.2.3 Names: the itemprop attribute...................................................................... 464 5.2.4 Values ............................................................................................................ 465 5.2.5 Associating names with items........................................................................ 466 5.3 Microdata DOM API ........................................................................................................... 467 5.4 Microdata vocabularies..................................................................................................... 469 5.4.1 vCard ............................................................................................................. 469 5.4.1.1 Conversion to vCard .................................................................... 477 5.4.1.2 Examples..................................................................................... 481
5.4.2 vEvent............................................................................................................ 482 5.4.2.1 Conversion to iCalendar .............................................................. 486 5.4.2.2 Examples..................................................................................... 487 5.4.3 Licensing works.............................................................................................. 489 5.4.3.1 Conversion to RDF....................................................................... 489 5.4.3.2 Examples..................................................................................... 489 5.5 Converting HTML to other formats.................................................................................... 490 5.5.1 JSON............................................................................................................... 490 5.5.2 RDF ................................................................................................................ 490 5.5.2.1 Examples..................................................................................... 493 5.5.3 Atom .............................................................................................................. 494 6 Loading Web pages ............................................................................................................................. 499 6.1 Browsing contexts ............................................................................................................ 499 6.1.1 Nested browsing contexts.............................................................................. 499 6.1.1.1 Navigating nested browsing contexts in the DOM....................... 500 6.1.2 Auxiliary browsing contexts ........................................................................... 501 6.1.2.1 Navigating auxiliary browsing contexts in the DOM .................... 501 6.1.3 Secondary browsing contexts ........................................................................ 501 6.1.4 Security.......................................................................................................... 501 6.1.5 Groupings of browsing contexts..................................................................... 501 6.1.6 Browsing context names................................................................................ 502 6.2 The Window object ............................................................................................................ 503 6.2.1 Security.......................................................................................................... 505 6.2.2 APIs for creating and navigating browsing contexts by name........................ 506 6.2.3 Accessing other browsing contexts ................................................................ 507 6.2.4 Named access on the Window object.............................................................. 507 6.2.5 Garbage collection and browsing contexts .................................................... 508 6.2.6 Browser interface elements ........................................................................... 508 6.2.7 The WindowProxy object ................................................................................ 510 6.3 Origin................................................................................................................................ 510 6.3.1 Relaxing the same-origin restriction .............................................................. 512 6.4 Session history and navigation ......................................................................................... 513 6.4.1 The session history of browsing contexts ...................................................... 513 6.4.2 The History interface ................................................................................... 515 6.4.3 The Location interface.................................................................................. 518 6.4.3.1 Security ....................................................................................... 520 6.4.4 Implementation notes for session history ...................................................... 520 6.5 Browsing the Web ............................................................................................................. 520 6.5.1 Navigating across documents ........................................................................ 520 6.5.2 Page load processing model for HTML files .................................................... 524 6.5.3 Page load processing model for XML files ...................................................... 525 6.5.4 Page load processing model for text files....................................................... 525 6.5.5 Page load processing model for images......................................................... 526 6.5.6 Page load processing model for content that uses plugins ............................ 526 6.5.7 Page load processing model for inline content that doesn't have a DOM ...... 526 6.5.8 Navigating to a fragment identifier................................................................ 526 6.5.9 History traversal ............................................................................................ 527 6.5.9.1 Event definitions ......................................................................... 529 6.5.10 Unloading documents .................................................................................. 530 6.5.10.1 Event definition ......................................................................... 531 6.5.11 Aborting a document load............................................................................ 531 6.6 Offline Web applications ................................................................................................... 531 6.6.1 Introduction.................................................................................................... 531 6.6.1.1 Event summary ........................................................................... 532 6.6.2 Application caches ......................................................................................... 533 6.6.3 The cache manifest syntax ............................................................................ 534 6.6.3.1 Some sample manifests .............................................................. 534 6.6.3.2 Writing cache manifests .............................................................. 535 6.6.3.3 Parsing cache manifests.............................................................. 537 6.6.4 Downloading or updating an application cache ............................................. 539 6.6.5 The application cache selection algorithm..................................................... 545 6.6.6 Changes to the networking model ................................................................. 546 6.6.7 Expiring application caches ........................................................................... 546 6.6.8 Disk space...................................................................................................... 546 6.6.9 Application cache API..................................................................................... 546 6.6.10 Browser state ............................................................................................... 548 7 Web application APIs ........................................................................................................................... 550
10
7.1 Scripting ........................................................................................................................... 550 7.1.1 Introduction.................................................................................................... 550 7.1.2 Enabling and disabling scripting .................................................................... 550 7.1.3 Processing model ........................................................................................... 550 7.1.3.1 Definitions ................................................................................... 550 7.1.3.2 Calling scripts.............................................................................. 551 7.1.3.3 Creating scripts ........................................................................... 551 7.1.3.4 Killing scripts ............................................................................... 552 7.1.4 Event loops .................................................................................................... 552 7.1.4.1 Definitions ................................................................................... 552 7.1.4.2 Processing model ........................................................................ 553 7.1.4.3 Generic task sources ................................................................... 554 7.1.5 The javascript: protocol ............................................................................. 554 7.1.6 Events ............................................................................................................ 555 7.1.6.1 Event handlers ............................................................................ 555 7.1.6.2 Event handlers on elements, Document objects, and Window objects..................................................................................................... 557 7.1.6.3 Event firing.................................................................................. 559 7.1.6.4 Events and the Window object ..................................................... 559 7.1.6.5 Runtime script errors................................................................... 559 7.2 Timers............................................................................................................................... 560 7.3 User prompts .................................................................................................................... 562 7.3.1 Simple dialogs................................................................................................ 562 7.3.2 Printing .......................................................................................................... 563 7.3.3 Dialogs implemented using separate documents .......................................... 564 7.4 System state and capabilities: the Navigator object ....................................................... 565 7.4.1 Client identification ........................................................................................ 566 7.4.2 Custom scheme and content handlers........................................................... 567 7.4.2.1 Security and privacy ................................................................... 568 7.4.2.2 Sample user interface ................................................................. 569 7.4.3 Manually releasing the storage mutex ........................................................... 570 8 User interaction ................................................................................................................................... 571 8.1 The hidden attribute ........................................................................................................ 571 8.2 Activation.......................................................................................................................... 571 8.3 Focus ................................................................................................................................ 572 8.3.1 Sequential focus navigation and the tabindex attribute ............................... 572 8.3.2 Focus management........................................................................................ 573 8.3.3 Document-level focus APIs............................................................................. 574 8.3.4 Element-level focus APIs ................................................................................ 574 8.4 Assigning keyboard shortcuts ........................................................................................... 575 8.4.1 Introduction.................................................................................................... 575 8.4.2 The accesskey attribute ................................................................................ 575 8.4.3 Processing model ........................................................................................... 576 8.5 The contenteditable attribute ....................................................................................... 577 8.5.1 User editing actions ....................................................................................... 577 8.5.2 Making entire documents editable................................................................. 579 8.6 Spelling and grammar checking ....................................................................................... 579 8.7 Drag and drop................................................................................................................... 581 8.7.1 Introduction.................................................................................................... 581 8.7.2 The drag data store ....................................................................................... 583 8.7.3 The DataTransfer interface .......................................................................... 583 8.7.3.1 The DataTransferItems interface.............................................. 586 8.7.3.2 The DataTransferItem interface................................................ 588 8.7.4 The DragEvent interface................................................................................ 589 8.7.5 Drag-and-drop processing model ................................................................... 590 8.7.6 Events summary ............................................................................................ 595 8.7.7 The draggable attribute ................................................................................ 595 8.7.8 The dropzone attribute .................................................................................. 596 8.7.9 Security risks in the drag-and-drop model ..................................................... 597 8.8 Undo history ..................................................................................................................... 598 8.8.1 Definitions...................................................................................................... 598 8.8.2 The UndoManager interface ............................................................................ 598 8.8.3 Undo: moving back in the undo transaction history....................................... 599 8.8.4 Redo: moving forward in the undo transaction history .................................. 600 8.8.5 The UndoManagerEvent interface and the undo and redo events.................. 600 8.8.6 Implementation notes .................................................................................... 600 8.9 Editing APIs....................................................................................................................... 601
11
9 Communication ................................................................................................................................... 606 9.1 Event definitions ............................................................................................................... 606 9.2 Cross-document messaging.............................................................................................. 606 9.2.1 Introduction.................................................................................................... 607 9.2.2 Security.......................................................................................................... 607 9.2.2.1 Authors........................................................................................ 607 9.2.2.2 User agents ................................................................................. 607 9.2.3 Posting messages .......................................................................................... 608 9.3 Channel messaging .......................................................................................................... 609 9.3.1 Introduction.................................................................................................... 609 9.3.2 Message channels.......................................................................................... 609 9.3.3 Message ports................................................................................................ 610 9.3.3.1 Ports and garbage collection ....................................................... 611 10 The HTML syntax ............................................................................................................................... 613 10.1 Writing HTML documents................................................................................................ 613 10.1.1 The DOCTYPE ............................................................................................... 613 10.1.2 Elements ...................................................................................................... 614 10.1.2.1 Start tags .................................................................................. 615 10.1.2.2 End tags .................................................................................... 616 10.1.2.3 Attributes .................................................................................. 616 10.1.2.4 Optional tags............................................................................. 617 10.1.2.5 Restrictions on content models ................................................. 618 10.1.2.6 Restrictions on the contents of raw text and RCDATA elements ................................................................................................. 618 10.1.3 Text .............................................................................................................. 619 10.1.3.1 Newlines.................................................................................... 619 10.1.4 Character references ................................................................................... 619 10.1.5 CDATA sections ............................................................................................ 619 10.1.6 Comments.................................................................................................... 620 10.2 Parsing HTML documents................................................................................................ 620 10.2.1 Overview of the parsing model .................................................................... 620 10.2.2 The input stream.......................................................................................... 621 10.2.2.1 Determining the character encoding......................................... 622 10.2.2.2 Character encodings ................................................................. 626 10.2.2.3 Preprocessing the input stream................................................. 627 10.2.2.4 Changing the encoding while parsing ....................................... 628 10.2.3 Parse state ................................................................................................... 628 10.2.3.1 The insertion mode ................................................................... 628 10.2.3.2 The stack of open elements ...................................................... 629 10.2.3.3 The list of active formatting elements....................................... 631 10.2.3.4 The element pointers ................................................................ 632 10.2.3.5 Other parsing state flags........................................................... 632 10.2.4 Tokenization ................................................................................................. 632 10.2.4.1 Data state ................................................................................. 633 10.2.4.2 Character reference in data state ............................................. 633 10.2.4.3 RCDATA state............................................................................. 633 10.2.4.4 Character reference in RCDATA state ........................................ 633 10.2.4.5 RAWTEXT state.......................................................................... 633 10.2.4.6 Script data state........................................................................ 634 10.2.4.7 PLAINTEXT state........................................................................ 634 10.2.4.8 Tag open state........................................................................... 634 10.2.4.9 End tag open state .................................................................... 634 10.2.4.10 Tag name state........................................................................ 635 10.2.4.11 RCDATA less-than sign state.................................................... 635 10.2.4.12 RCDATA end tag open state..................................................... 635 10.2.4.13 RCDATA end tag name state.................................................... 636 10.2.4.14 RAWTEXT less-than sign state ................................................. 636 10.2.4.15 RAWTEXT end tag open state .................................................. 636 10.2.4.16 RAWTEXT end tag name state................................................. 637 10.2.4.17 Script data less-than sign state ............................................... 637 10.2.4.18 Script data end tag open state................................................ 637 10.2.4.19 Script data end tag name state............................................... 638 10.2.4.20 Script data escape start state ................................................. 638 10.2.4.21 Script data escape start dash state......................................... 638 10.2.4.22 Script data escaped state ....................................................... 638 10.2.4.23 Script data escaped dash state ............................................... 639 10.2.4.24 Script data escaped dash dash state ...................................... 639 10.2.4.25 Script data escaped less-than sign state................................. 639 10.2.4.26 Script data escaped end tag open state.................................. 639
12
10.2.4.27 Script data escaped end tag name state ................................ 640 10.2.4.28 Script data double escape start state ..................................... 640 10.2.4.29 Script data double escaped state............................................ 641 10.2.4.30 Script data double escaped dash state ................................... 641 10.2.4.31 Script data double escaped dash dash state........................... 641 10.2.4.32 Script data double escaped less-than sign state ..................... 642 10.2.4.33 Script data double escape end state ....................................... 642 10.2.4.34 Before attribute name state .................................................... 642 10.2.4.35 Attribute name state ............................................................... 643 10.2.4.36 After attribute name state....................................................... 643 10.2.4.37 Before attribute value state .................................................... 644 10.2.4.38 Attribute value (double-quoted) state ..................................... 644 10.2.4.39 Attribute value (single-quoted) state ...................................... 645 10.2.4.40 Attribute value (unquoted) state ............................................. 645 10.2.4.41 Character reference in attribute value state ........................... 645 10.2.4.42 After attribute value (quoted) state ........................................ 645 10.2.4.43 Self-closing start tag state ...................................................... 646 10.2.4.44 Bogus comment state ............................................................. 646 10.2.4.45 Markup declaration open state................................................ 646 10.2.4.46 Comment start state ............................................................... 646 10.2.4.47 Comment start dash state....................................................... 647 10.2.4.48 Comment state ....................................................................... 647 10.2.4.49 Comment end dash state ........................................................ 647 10.2.4.50 Comment end state................................................................. 647 10.2.4.51 Comment end bang state........................................................ 648 10.2.4.52 DOCTYPE state ........................................................................ 648 10.2.4.53 Before DOCTYPE name state ................................................... 648 10.2.4.54 DOCTYPE name state .............................................................. 649 10.2.4.55 After DOCTYPE name state...................................................... 649 10.2.4.56 After DOCTYPE public keyword state....................................... 650 10.2.4.57 Before DOCTYPE public identifier state ................................... 650 10.2.4.58 DOCTYPE public identifier (double-quoted) state .................... 650 10.2.4.59 DOCTYPE public identifier (single-quoted) state ..................... 651 10.2.4.60 After DOCTYPE public identifier state ...................................... 651 10.2.4.61 Between DOCTYPE public and system identifiers state........... 651 10.2.4.62 After DOCTYPE system keyword state ..................................... 652 10.2.4.63 Before DOCTYPE system identifier state ................................. 652 10.2.4.64 DOCTYPE system identifier (double-quoted) state .................. 653 10.2.4.65 DOCTYPE system identifier (single-quoted) state.................... 653 10.2.4.66 After DOCTYPE system identifier state .................................... 653 10.2.4.67 Bogus DOCTYPE state ............................................................. 654 10.2.4.68 CDATA section state ................................................................ 654 10.2.4.69 Tokenizing character references.............................................. 654 10.2.5 Tree construction ......................................................................................... 656 10.2.5.1 Creating and inserting elements ............................................... 657 10.2.5.2 Closing elements that have implied end tags ........................... 659 10.2.5.3 Foster parenting ........................................................................ 659 10.2.5.4 The "initial" insertion mode....................................................... 659 10.2.5.5 The "before html" insertion mode ............................................. 661 10.2.5.6 The "before head" insertion mode ............................................ 662 10.2.5.7 The "in head" insertion mode.................................................... 662 10.2.5.8 The "in head noscript" insertion mode ...................................... 664 10.2.5.9 The "after head" insertion mode ............................................... 664 10.2.5.10 The "in body" insertion mode.................................................. 665 10.2.5.11 The "text" insertion mode ....................................................... 674 10.2.5.12 The "in table" insertion mode.................................................. 676 10.2.5.13 The "in table text" insertion mode .......................................... 677 10.2.5.14 The "in caption" insertion mode .............................................. 677 10.2.5.15 The "in column group" insertion mode .................................... 678 10.2.5.16 The "in table body" insertion mode......................................... 678 10.2.5.17 The "in row" insertion mode .................................................... 679 10.2.5.18 The "in cell" insertion mode .................................................... 680 10.2.5.19 The "in select" insertion mode ................................................ 681 10.2.5.20 The "in select in table" insertion mode ................................... 682 10.2.5.21 The "in foreign content" insertion mode ................................. 682 10.2.5.22 The "after body" insertion mode ............................................. 684 10.2.5.23 The "in frameset" insertion mode ........................................... 685 10.2.5.24 The "after frameset" insertion mode ....................................... 686 10.2.5.25 The "after after body" insertion mode..................................... 686 10.2.5.26 The "after after frameset" insertion mode .............................. 686
13
10.2.6 The end........................................................................................................ 687 10.2.7 Coercing an HTML DOM into an infoset........................................................ 688 10.2.8 An introduction to error handling and strange cases in the parser .............. 688 10.2.8.1 Misnested tags: <b><i></b></i> ........................................... 688 10.2.8.2 Misnested tags: <b><p></b></p> ......................................... 689 10.2.8.3 Unexpected markup in tables ................................................... 690 10.2.8.4 Scripts that modify the page as it is being parsed .................... 692 10.2.8.5 Unclosed formatting elements .................................................. 693 10.3 Serializing HTML fragments ............................................................................................ 694 10.4 Parsing HTML fragments ................................................................................................. 696 10.5 Named character references .......................................................................................... 697 11 The XHTML 11.1 11.2 11.3 11.4 syntax............................................................................................................................. 705 Writing XHTML documents.............................................................................................. 705 Parsing XHTML documents ............................................................................................. 705 Serializing XHTML fragments .......................................................................................... 706 Parsing XHTML fragments............................................................................................... 707
12 Rendering .......................................................................................................................................... 708 12.1 Introduction .................................................................................................................... 708 12.2 The CSS user agent style sheet and presentational hints............................................... 708 12.2.1 Introduction.................................................................................................. 708 12.2.2 Display types ............................................................................................... 709 12.2.3 Margins and padding ................................................................................... 709 12.2.4 Alignment .................................................................................................... 711 12.2.5 Fonts and colors........................................................................................... 713 12.2.6 Punctuation and decorations ....................................................................... 715 12.2.7 Resetting rules for inherited properties ....................................................... 717 12.2.8 The hr element ............................................................................................ 717 12.2.9 The fieldset element................................................................................. 718 12.3 Replaced elements ......................................................................................................... 718 12.3.1 Embedded content....................................................................................... 718 12.3.2 Timed text tracks ......................................................................................... 719 12.3.2.1 WebVTT cue text rendering rules .............................................. 719 12.3.2.2 Applying CSS properties to WebVTT Node Objects.................... 724 12.3.2.3 CSS extensions.......................................................................... 725 12.3.2.3.1 The '::cue' pseudo-element .................................... 725 12.3.2.3.2 The ':past' and ':future' pseudo-classes ................. 726 12.3.3 Images ......................................................................................................... 726 12.3.4 Attributes for embedded content and images ............................................. 727 12.3.5 Image maps ................................................................................................. 728 12.3.6 Toolbars........................................................................................................ 728 12.4 Bindings.......................................................................................................................... 728 12.4.1 Introduction.................................................................................................. 728 12.4.2 The button element .................................................................................... 729 12.4.3 The details element .................................................................................. 729 12.4.4 The input element as a text entry widget................................................... 729 12.4.5 The input element as domain-specific widgets........................................... 729 12.4.6 The input element as a range control......................................................... 730 12.4.7 The input element as a color well............................................................... 730 12.4.8 The input element as a checkbox and radio button widgets ...................... 730 12.4.9 The input element as a file upload control ................................................. 731 12.4.10 The input element as a button ................................................................. 731 12.4.11 The marquee element ................................................................................ 731 12.4.12 The meter element .................................................................................... 732 12.4.13 The progress element............................................................................... 733 12.4.14 The select element .................................................................................. 733 12.4.15 The textarea element............................................................................... 733 12.4.16 The keygen element .................................................................................. 734 12.4.17 The time element ...................................................................................... 734 12.5 Frames and framesets .................................................................................................... 734 12.6 Interactive media............................................................................................................ 736 12.6.1 Links, forms, and navigation ........................................................................ 736 12.6.2 The title attribute...................................................................................... 737 12.6.3 Editing hosts ................................................................................................ 737 12.6.4 Text rendered in native user interfaces........................................................ 737 12.7 Print media ..................................................................................................................... 738 13 Obsolete features .............................................................................................................................. 739 13.1 Obsolete but conforming features .................................................................................. 739
14
13.1.1 Warnings for obsolete but conforming features ........................................... 739 13.2 Non-conforming features ................................................................................................ 739 13.3 Requirements for implementations................................................................................. 744 13.3.1 The applet element .................................................................................... 744 13.3.2 The marquee element .................................................................................. 745 13.3.3 Frames ......................................................................................................... 747 13.3.4 Other elements, attributes and APIs ............................................................ 748 14 IANA considerations .......................................................................................................................... 757 14.1 text/html ...................................................................................................................... 757 14.2 text/html-sandboxed ................................................................................................... 758 14.3 application/xhtml+xml................................................................................................ 759 14.4 text/cache-manifest ................................................................................................... 760 14.5 text/ping ...................................................................................................................... 761 14.6 text/vtt ........................................................................................................................ 761 14.7 application/microdata+json ...................................................................................... 762 14.8 Ping-From ...................................................................................................................... 763 14.9 Ping-To .......................................................................................................................... 764 Index ...................................................................................................................................................... 765 Elements................................................................................................................................. 765 Element content categories.................................................................................................... 770 Attributes................................................................................................................................ 771 Interfaces................................................................................................................................ 778 Events..................................................................................................................................... 780 References.............................................................................................................................................. 781 Acknowledgements ................................................................................................................................ 787
15
1 Introduction
1.1 Is this HTML5?
This section is non-normative. In short: Yes. In more length: "HTML5" has at various times been used to refer to a wide variety of technologies, some of which originated in this document, and some of which have only ever been tangentially related. This specification actually now defines the next generation of HTML after HTML5. HTML5 reached Last Call at the WHATWG in October 2009, and shortly after we started working on some experimental new features that are not as stable as the rest of the specification. The stability of sections is annotated in the margin. The W3C has also been working on HTML in conjunction with the WHATWG; at the W3C, this document has been split into several parts, and the occasional informative paragraph or example has been removed for technical or editorial reasons. For all intents and purposes, however, the W3C HTML specifications and this specification are equivalent (and they are in fact all generated from the same source document). The minor differences are: Instead of this section, the W3C version has a different paragraph explaining the difference between the W3C and WHATWG versions of HTML. The W3C version refers to the technology as HTML5, rather than just HTML. Examples that use features from HTML5 are not present in the W3C version since the W3C version is published as HTML4 due to W3C publication policies. The W3C version omits a paragraph of implementation advice because of a working group decision also from June 2010.
Features that are considered part of the next generation of HTML beyond HTML5 (and that are therefore not included in the W3C version of HTML5) currently consist of: The device p437 element. The ping p440 attribute and related hyperlink auditing p441 features. The WebVTT p267 format and some text track p254 API features. Rules for converting HTML to Atom p494 . The cssElementMap p84 feature for defining CSS element reference identifiers.
Features that are part of HTML (and this specification) but that are currently published as separate specifications as well, and are not included in the W3C HTML5 specification, consist of: Canvas 2D Graphics Context p289 Microdata p459 Microdata vocabularies p469 Cross-document messaging p606 (also known as Communications) Channel messaging p609 (also known as Communications)
The forms p342 part of this specification was previously published separately in a specification known as Web Forms 2. Features that are not currently in this document that were in the past considered part of HTML5, or that were never part of HTML5 but have been referred to as part of HTML5 in the media, include: Web Workers Web Storage WebSocket API WebSocket protocol Server-sent Events Media Type Sniffing The Web Origin Concept Geolocation API SVG MathML XMLHttpRequest Parts of CSS.
1.2 Background
This section is non-normative. The World Wide Web's markup language has always been HTML. HTML was primarily designed as a language for semantically describing scientific documents, although its general design and adaptations over the years have enabled it to be used to describe a number of other types of documents. The main area that has not been adequately addressed by HTML is a vague subject referred to as Web Applications. This specification attempts to rectify this, while at the same time updating the HTML specifications to address issues raised in the past few years.
16
1.3 Audience
This section is non-normative. This specification is intended for authors of documents and scripts that use the features defined in this specification, implementors of tools that operate on pages that use the features defined in this specification, and individuals wishing to establish the correctness of documents or implementations with respect to the requirements of this specification. This document is probably not suited to readers who do not already have at least a passing familiarity with Web technologies, as in places it sacrifices clarity for precision, and brevity for completeness. More approachable tutorials and authoring guides can provide a gentler introduction to the topic. In particular, familiarity with the basics of DOM Core and DOM Events is necessary for a complete understanding of some of the more technical parts of this specification. An understanding of Web IDL, HTTP, XML, Unicode, character encodings, JavaScript, and CSS will also be helpful in places but is not essential.
1.4 Scope
This section is non-normative. This specification is limited to providing a semantic-level markup language and associated semantic-level scripting APIs for authoring accessible pages on the Web ranging from static documents to dynamic applications. The scope of this specification does not include providing mechanisms for media-specific customization of presentation (although default rendering rules for Web browsers are included at the end of this specification, and several mechanisms for hooking into CSS are provided as part of the language). The scope of this specification is not to describe an entire operating system. In particular, hardware configuration software, image manipulation tools, and applications that users would be expected to use with high-end workstations on a daily basis are out of scope. In terms of applications, this specification is targeted specifically at applications that would be expected to be used by users on an occasional basis, or regularly but from disparate locations, with low CPU requirements. For instance online purchasing systems, searching systems, games (especially multiplayer online games), public telephone books or address books, communications software (e-mail clients, instant messaging clients, discussion software), document editing software, etc.
1.5 History
This section is non-normative. For its first five years (1990-1995), HTML went through a number of revisions and experienced a number of extensions, primarily hosted first at CERN, and then at the IETF. With the creation of the W3C, HTML's development changed venue again. A first abortive attempt at extending HTML in 1995 known as HTML 3.0 then made way to a more pragmatic approach known as HTML 3.2, which was completed in 1997. HTML4 followed, reaching completion in 1998. At this time, the W3C membership decided to stop evolving HTML and instead begin work on an XML-based equivalent, called XHTML. This effort started with a reformulation of HTML4 in XML, known as XHTML 1.0, which added no new features except the new serialization, and which was completed in 2000. After XHTML 1.0, the W3C's focus turned to making it easier for other working groups to extend XHTML, under the banner of XHTML Modularization. In parallel with this, the W3C also worked on a new language that was not compatible with the earlier HTML and XHTML languages, calling it XHTML2. Around the time that HTML's evolution was stopped in 1998, parts of the API for HTML developed by browser vendors were specified and published under the name DOM Level 1 (in 1998) and DOM Level 2 Core and DOM Level 2 HTML (starting in 2000 and culminating in 2003). These efforts then petered out, with some DOM Level 3 specifications published in 2004 but the working group being closed before all the Level 3 drafts were completed. In 2003, the publication of XForms, a technology which was positioned as the next generation of Web forms, sparked a renewed interest in evolving HTML itself, rather than finding replacements for it. This interest was borne from the realization that XML's deployment as a Web technology was limited to entirely new technologies (like RSS and later Atom), rather than as a replacement for existing deployed technologies (like HTML). A proof of concept to show that it was possible to extend HTML4's forms to provide many of the features that XForms 1.0 introduced, without requiring browsers to implement rendering engines that were incompatible with existing HTML Web pages, was the first result of this renewed interest. At this early stage, while the draft was already publicly available, and input was already being solicited from all sources, the specification was only under Opera Software's copyright.
17
The idea that HTML's evolution should be reopened was tested at a W3C workshop in 2004, where some of the principles that underlie the HTML5 work (described below), as well as the aforementioned early draft proposal covering just forms-related features, were presented to the W3C jointly by Mozilla and Opera. The proposal was rejected on the grounds that the proposal conflicted with the previously chosen direction for the Web's evolution; the W3C staff and membership voted to continue developing XML-based replacements instead. Shortly thereafter, Apple, Mozilla, and Opera jointly announced their intent to continue working on the effort under the umbrella of a new venue called the WHATWG. A public mailing list was created, and the draft was moved to the WHATWG site. The copyright was subsequently amended to be jointly owned by all three vendors, and to allow reuse of the specification. The WHATWG was based on several core principles, in particular that technologies need to be backwards compatible, that specifications and implementations need to match even if this means changing the specification rather than the implementations, and that specifications need to be detailed enough that implementations can achieve complete interoperability without reverse-engineering each other. The latter requirement in particular required that the scope of the HTML5 specification include what had previously been specified in three separate documents: HTML4, XHTML1, and DOM2 HTML. It also meant including significantly more detail than had previously been considered the norm. In 2006, the W3C indicated an interest to participate in the development of HTML5 after all, and in 2007 formed a working group chartered to work with the WHATWG on the development of the HTML5 specification. Apple, Mozilla, and Opera allowed the W3C to publish the specification under the W3C copyright, while keeping a version with the less restrictive license on the WHATWG site. Since then, both groups have been working together. A separate document has been published by the W3C HTML working group to document the differences between this specification and the language described in the HTML4 specification. [HTMLDIFF] p782
18
19
The HTML syntax p613 The XHTML syntax p705 All of these features would be for naught if they couldn't be represented in a serialized form and sent to other people, and so these sections define the syntaxes of HTML, along with rules for how to parse content using those syntaxes. There are also some appendices, defining rendering rules p708 for Web browsers and listing obsolete features p739 and IANA considerations p757 .
/* this is a CSS fragment */ The defining instance of a term is marked up like this. Uses of that term are marked up like this p20 or like this p20 . The defining instance of an element, attribute, or API is marked up like this. References to that element, attribute, or API are marked up like this p20 . Other code fragments are marked up like this. Variables are marked up like this. This is an implementation requirement.
HTML documents consist of a tree of elements and text. Each element is denoted in the source by a start tag p615 , such as "<body>", and an end tag p616 , such as "</body>". (Certain start tags and end tags can in certain cases be omitted p617 and are implied by other tags.) Tags have to be nested such that elements are all completely within each other, without overlapping: <p>This is <em>very <strong>wrong</em>!</strong></p> <p>This <em>is <strong>correct</strong>.</em></p> This specification defines a set of elements that can be used in HTML, along with rules about the ways in which the elements can be nested. Elements can have attributes, which control how the elements work. In the example below, there is a hyperlink p440 , formed using the a p173 element and its href p440 attribute: <a href="demo.html">simple</a> Attributes p616 are placed inside the start tag, and consist of a name p616 and a value p616 , separated by an "=" character. The attribute value can remain unquoted p616 if it doesn't contain spaces or any of " ' ` = < or >. Otherwise, it has to be quoted using either single or double quotes. The value, along with the "=" character, can be omitted altogether if the value is the empty string. <!-- empty attributes --> <input name=address disabled> <input name=address disabled=""> <!-- attributes with a value --> <input name=address maxlength=200> <input name=address maxlength='200'> <input name=address maxlength="200"> HTML user agents (e.g. Web browsers) then parse this markup, turning it into a DOM (Document Object Model) tree. A DOM tree is an in-memory representation of a document. DOM trees contain several kinds of nodes, in particular a DOCTYPE node, elements, text nodes, and comment nodes. The markup snippet at the top of this section p20 would be turned into the following DOM tree: DOCTYPE: html html p116 head p116 #text: ??? title p117 #text: Sample page #text: ?? #text: ?? body p142 #text: ??? h1 p150 #text: Sample page #text: ??? p p160 #text: This is a a p173 href="demo.html" #text: simple #text: sample. #text: ??? #comment: this is a comment #text: ??? The root element p29 of this tree is the html p116 element, which is the element always found at the root of HTML documents. It contains two elements, head p116 and body p142 , as well as a text node between them. There are many more text nodes in the DOM tree than one would initially expect, because the source contains a number of spaces (represented here by "") and line breaks ("") that all end up as text nodes in the DOM. However, for historical reasons not all of the spaces and line breaks in the original markup appear in the DOM. In particular, all the whitespace before head p116 start tag ends up being dropped silently, and all the whitespace after the body p142 end tag ends up placed at the end of the body p142 . The head p116 element contains a title p117 element, which itself contains a text node with the text "Sample page". Similarly, the body p142 element contains an h1 p150 element, a p p160 element, and a comment.
21
This DOM tree can be manipulated from scripts in the page. Scripts (typically in JavaScript) are small programs that can be embedded using the script p133 element or using event handler content attributes p556 . For example, here is a form with a script that sets the value of the form's output p400 element to say "Hello World": <form name="main"> Result: <output name="result"></output> <script> document.forms.main.elements.result.value = 'Hello World'; </script> </form> Each element in the DOM tree is represented by an object, and these objects have APIs so that they can be manipulated. For instance, a link (e.g. the a p173 element in the tree above) can have its "href p440 " attribute changed in several ways: var a = document.links[0]; // obtain the first link in the document a.href = 'sample.html'; // change the destination URL of the link a.protocol = 'https'; // change just the scheme part of the URL a.setAttribute('href', 'http://example.com/'); // change the content attribute directly Since DOM trees are used as the way to represent HTML documents when they are processed and presented by implementations (especially interactive implementations like Web browsers), this specification is mostly phrased in terms of DOM trees, instead of the markup described above. HTML documents represent a media-independent description of interactive content. HTML documents might be rendered to a screen, or through a speech synthesizer, or on a braille display. To influence exactly how such rendering takes place, authors can use a styling language such as CSS. In the following example, the page has been made yellow-on-blue using CSS. <!DOCTYPE html> <html> <head> <title>Sample styled page</title> <style> body { background: navy; color: yellow; } </style> </head> <body> <h1>Sample styled page</h1> <p>This page is just a demo.</p> </body> </html> For more details on how to use HTML, authors are encouraged to consult tutorials and guides. Some of the examples included in this specification might also be of use, but the novice author is cautioned that this specification, by necessity, defines the language with a level of detail that might be difficult to understand at first.
22
The use of presentational elements leads to poorer accessibility While it is possible to use presentational markup in a way that provides users of assistive technologies (ATs) with an acceptable experience (e.g. using ARIA), doing so is significantly more difficult than doing so when using semantically-appropriate markup. Furthermore, even using such techniques doesn't help make pages accessible for non-AT non-graphical users, such as users of text-mode browsers. Using media-independent markup, on the other hand, provides an easy way for documents to be authored in such a way that they work for more users (e.g. text browsers). Higher cost of maintenance It is significantly easier to maintain a site written in such a way that the markup is style-independent. For example, changing the color of a site that uses <font color=""> throughout requires changes across the entire site, whereas a similar change to a site based on CSS can be done by changing a single file. Higher document sizes Presentational markup tends to be much more redundant, and thus results in larger document sizes. For those reasons, presentational markup has been removed from HTML in this version. This change should not come as a surprise; HTML4 deprecated presentational markup many years ago and provided a mode (HTML4 Transitional) to help authors move away from presentational markup; later, XHTML 1.1 went further and obsoleted those features altogether. The only remaining presentational markup features in HTML are the style p95 attribute and the style p130 element. Use of the style p95 attribute is somewhat discouraged in production environments, but it can be useful for rapid prototyping (where its rules can be directly moved into a separate style sheet later) and for providing specific styles in unusual cases where a separate style sheet would be inconvenient. Similarly, the style p130 element can be useful in syndication or for page-specific styles, but in general an external style sheet is likely to be more convenient when the styles apply to multiple pages. It is also worth noting that some elements that were previously presentational have been redefined in this specification to be media-independent: b p188 , i p187 , hr p161 , s p177 , and small p176 .
23
<p><i>He dreamt. <p><i>He dreamt that he ate breakfast. <p><i>Then lunch. <p><i>And finally dinner. The resulting DOM for this fragment would be: p p160 i p187 #text: He dreamt. p p160 i p187 i p187 #text: He dreamt that he ate breakfast. p p160 i p187 i p187 i p187 #text: Then lunch. p p160 i p187 i p187 i p187 i p187 #text: And finally dinner. Errors involving fragile syntax constructs There are syntax constructs that, for historical reasons, are relatively fragile. To help reduce the number of users who accidentally run into such problems, they are made non-conforming. For example, the parsing of certain named character references in attributes happens even with the closing semicolon being omitted. It is safe to include an ampersand followed by letters that do not form a named character reference, but if the letters are changed to a string that does form a named character reference, they will be interpreted as that character instead. In this fragment, the attribute's value is "?bill&ted": <a href="?bill&ted">Bill and Ted</a> In the following fragment, however, the attribute's value is actually "?art", not the intended "?art©": <a href="?art©">Art and Copy</a> To avoid this problem, all named character references are required to end with a semicolon, and uses of named character references without a semicolon are flagged as errors. Thus, the correct way to express the above cases is as follows: <a href="?bill&ted">Bill and Ted</a> <!-- &ted is ok, since it's not a named character reference --> <a href="?art&copy">Art and Copy</a> <!-- the & has to be escaped, since © is a named character reference --> Errors involving known interoperability problems in legacy user agents Certain syntax constructs are known to cause especially subtle or serious problems in legacy user agents, and are therefore marked as non-conforming to help authors avoid them. For example, this is why the U+0060 GRAVE ACCENT character (`) is not allowed in unquoted attributes. In certain legacy user agents, it is sometimes treated as a quote character. Another example of this is the DOCTYPE, which is required to trigger no-quirks mode p81 , because the behavior of legacy user agents in quirks mode p81 is often largely undocumented. Errors that risk exposing authors to security attacks Certain restrictions exist purely to avoid known security problems. For example, the restriction on using UTF-7 exists purely to avoid authors falling prey to a known cross-site-scripting attack using UTF-7. Cases where the author's intent is unclear Markup where the author's intent is very unclear is often made non-conforming. Correcting these errors early makes later maintenance easier. For example, it is unclear whether the author intended the following to be an h1 p150 heading or an h2 p150 heading:
24
<h1>Contact details</h2> Cases that are likely to be typos When a user makes a simple typo, it is helpful if the error can be caught early, as this can save the author a lot of debugging time. This specification therefore usually considers it an error to use element names, attribute names, and so forth, that do not match the names defined in this specification. For example, if the author typed <capton> instead of <caption>, this would be flagged as an error and the author could correct the typo immediately. Errors that could interfere with new syntax in the future In order to allow the language syntax to be extended in the future, certain otherwise harmless features are disallowed. For example, "attributes" in end tags are ignored currently, but they are invalid, in case a future change to the language makes use of that syntax feature without conflicting with already-deployed (and valid!) content. Some authors find it helpful to be in the practice of always quoting all attributes and always including all optional tags, preferring the consistency derived from such custom over the minor benefits of terseness afforded by making use of the flexibility of the HTML syntax. To aid such authors, conformance checkers can provide modes of operation wherein such conventions are enforced.
25
Errors involving limits that have been imposed merely to simplify the language Some conformance errors simplify the language that authors need to learn. For example, the area p314 element's shape p316 attribute, despite accepting both circ p316 and circle p316 values in practice as synonyms, disallows the use of the circ p316 value, so as to simplify tutorials and other learning aids. There would be no benefit to allowing both, but it would cause extra confusion when teaching the language. Errors that involve peculiarities of the parser Certain elements are parsed in somewhat eccentric ways (typically for historical reasons), and their content model restrictions are intended to avoid exposing the author to these issues. For example, a form p347 element isn't allowed inside phrasing content p100 , because when parsed as HTML, a form p347 element's start tag will imply a p p160 element's end tag. Thus, the following markup results in two paragraphs p102 , not one: <p>Welcome. <form><label>Name:</label> <input></form> It is parsed exactly like the following: <p>Welcome. </p><form><label>Name:</label> <input></form> Errors that would likely result in scripts failing in hard-to-debug ways Some errors are intended to help prevent script problems that would be hard to debug. This is why, for instance, it is non-conforming to have two id p92 attributes with the same value. Duplicate IDs lead to the wrong element being selected, with sometimes disastrous effects whose cause is hard to determine. Errors that waste authoring time Some constructs are disallowed because historically they have been the cause of a lot of wasted authoring time, and by encouraging authors to avoid making them, authors can save time in future efforts. For example, a script p133 element's src p133 attribute causes the element's contents to be ignored. However, this isn't obvious, especially if the element's contents appear to be executable script which can lead to authors spending a lot of time trying to debug the inline script without realizing that it is not executing. To reduce this problem, this specification makes it non-conforming to have executable script in a script p133 element when the src p133 attribute is present. This means that authors who are validating their documents are less likely to waste time with this kind of mistake. Errors that involve areas that affect authors migrating to and from XHTML Some authors like to write files that can be interpreted as both XML and HTML with similar results. Though this practice is discouraged in general due to the myriad of subtle complications involved (especially when involving scripting, styling, or any kind of automated serialization), this specification has a few restrictions intended to at least somewhat mitigate the difficulties. This makes it easier for authors to use this as a transitionary step when migrating between HTML and XHTML. For example, there are somewhat complicated rules surrounding the lang p92 and xml:lang p92 attributes intended to keep the two synchronized. Another example would be the restrictions on the values of xmlns attributes in the HTML serialization, which are intended to ensure that elements in conforming documents end up in the same namespaces whether processed as HTML or XML. Errors that involve areas reserved for future expansion As with the restrictions on the syntax intended to allow for new syntax in future revisions of the language, some restrictions on the content models of elements and values of attributes are intended to allow for future expansion of the HTML vocabulary. For example, limiting the values of the target p440 attribute that start with an U+005F LOW LINE character (_) to only specific predefined values allows new predefined values to be introduced at a future time without conflicting with author-defined values. Errors that indicate a mis-use of other specifications Certain restrictions are intended to support the restrictions made by other specifications. For example, requiring that attributes that take media queries use only valid media queries reinforces the importance of following the conformance rules of that specification.
26
The following documents might be of interest to readers of this specification. Character Model for the World Wide Web 1.0: Fundamentals [CHARMOD] p781 This Architectural Specification provides authors of specifications, software developers, and content developers with a common reference for interoperable text manipulation on the World Wide Web, building on the Universal Character Set, defined jointly by the Unicode Standard and ISO/IEC 10646. Topics addressed include use of the terms 'character', 'encoding' and 'string', a reference processing model, choice and identification of character encodings, character escaping, and string indexing. Unicode Security Considerations [UTR36] p785 Because Unicode contains such a large number of characters and incorporates the varied writing systems of the world, incorrect usage can expose programs or systems to possible security attacks. This is especially important as more and more products are internationalized. This document describes some of the security considerations that programmers, system analysts, standards developers, and users should take into account, and provides specific recommendations to reduce the risk of problems. Web Content Accessibility Guidelines (WCAG) 2.0 [WCAG] p785 Web Content Accessibility Guidelines (WCAG) 2.0 covers a wide range of recommendations for making Web content more accessible. Following these guidelines will make content accessible to a wider range of people with disabilities, including blindness and low vision, deafness and hearing loss, learning disabilities, cognitive limitations, limited movement, speech disabilities, photosensitivity and combinations of these. Following these guidelines will also often make your Web content more usable to users in general. Authoring Tool Accessibility Guidelines (ATAG) 2.0 [ATAG] p781 This specification provides guidelines for designing Web content authoring tools that are more accessible for people with disabilities. An authoring tool that conforms to these guidelines will promote accessibility by providing an accessible user interface to authors with disabilities as well as by enabling, supporting, and promoting the production of accessible Web content by all authors. User Agent Accessibility Guidelines (UAAG) 2.0 [UAAG] p785 This document provides guidelines for designing user agents that lower barriers to Web accessibility for people with disabilities. User agents include browsers and other types of software that retrieve and render Web content. A user agent that conforms to these guidelines will promote accessibility through its own user interface and through other internal facilities, including its ability to communicate with other technologies (especially assistive technologies). Furthermore, all users, not just users with disabilities, should find conforming user agents to be more usable. Polyglot Markup: HTML-Compatible XHTML Documents [POLYGLOT] p783 A document that uses polyglot markup is document that is a stream of bytes that parses into identical document trees (with the exception of the xmlns attribute on the root element) when processed as HTML and when processed as XML. Polyglot markup that meets a well defined set of constraints is interpreted as compatible, regardless of whether they are processed as HTML or as XHTML, per the HTML5 specification. Polyglot markup uses a specific DOCTYPE, namespace declarations, and a specific case normally lower case but occasionally camel case for element and attribute names. Polyglot markup uses lower case for certain attribute values. Further constraints include those on empty elements, named entity references, and the use of scripts and style.
27
2 Common infrastructure
2.1 Terminology
This specification refers to both HTML and XML attributes and IDL attributes, often in the same context. When it is not clear which is being referred to, they are referred to as content attributes for HTML and XML attributes, and IDL attributes for those defined on IDL interfaces. Similarly, the term "properties" is used for both JavaScript object properties and CSS properties. When these are ambiguous they are qualified as object properties and CSS properties respectively. Generally, when the specification states that a feature applies to the HTML syntax p613 or the XHTML syntax p705 , it also includes the other. When a feature specifically only applies to one of the two languages, it is called out by explicitly stating that it does not apply to the other format, as in "for HTML, ... (this does not apply to XHTML)". This specification uses the term document to refer to any use of HTML, ranging from short static documents to long essays or reports with rich multimedia, as well as to fully-fledged interactive applications. For simplicity, terms such as shown, displayed, and visible might sometimes be used when referring to the way a document is rendered to the user. These terms are not meant to imply a visual medium; they must be considered to apply to other media in equivalent ways. When an algorithm B says to return to another algorithm A, it implies that A called B. Upon returning to A, the implementation must continue from where it left off in calling B.
2.1.1 Resources
The specification uses the term supported when referring to whether a user agent has an implementation capable of decoding the semantics of an external resource. A format or type is said to be supported if the implementation can process an external resource of that format or type without critical aspects of the resource being ignored. Whether a specific resource is supported can depend on what features of the resource's format are in use. For example, a PNG image would be considered to be in a supported format if its pixel data could be decoded and rendered, even if, unbeknownst to the implementation, the image also contained animation data. A MPEG4 video file would not be considered to be in a supported format if the compression format used was not supported, even if the implementation could determine the dimensions of the movie from the file's metadata. What some specifications, in particular the HTTP and URI specifications, refer to as a representation is referred to in this specification as a resource. [HTTP] p782 [RFC3986] p784 The term MIME type is used to refer to what is sometimes called an Internet media type in protocol literature. The term media type in this specification is used to refer to the type of media intended for presentation, as used by the CSS specifications. [RFC2046] p784 [MQ] p783 A string is a valid MIME type if it matches the media-type rule defined in section 3.7 "Media Types" of RFC 2616. In particular, a valid MIME type p28 may include MIME type parameters. [HTTP] p782 A string is a valid MIME type with no parameters if it matches the media-type rule defined in section 3.7 "Media Types" of RFC 2616, but does not contain any U+003B SEMICOLON characters (;). In other words, if it consists only of a type and subtype, with no MIME Type parameters. [HTTP] p782 The term HTML MIME type is used to refer to the MIME types p28 text/html p757 and text/html-sandboxed p758 . A resource's critical subresources are those that the resource needs to have available to be correctly processed. Which resources are considered critical or not is defined by the specification that defines the resource's format. For CSS resources, only @import rules introduce critical subresources p28 ; other resources, e.g. fonts or backgrounds, are not. The term data: URL refers to URLs p55 that use the data: scheme. [RFC2397] p784
2.1.2 XML
To ease migration from HTML to XHTML, UAs conforming to this specification will place elements in HTML in the http://www.w3.org/1999/xhtml namespace, at least for the purposes of the DOM and CSS. The term "HTML elements", when used in this specification, refers to any element in that namespace, and thus refers to both HTML and XHTML elements.
28
Except where otherwise stated, all elements defined or mentioned in this specification are in the http://www.w3.org/1999/xhtml namespace, and all attributes defined or mentioned in this specification have no namespace. Attribute names are said to be XML-compatible if they match the Name production defined in XML, they contain no U+003A COLON characters (:), and their first three characters are not an ASCII case-insensitive p36 match for the string "xml". [XML] p786 The term XML MIME type is used to refer to the MIME types p28 text/xml, application/xml, and any MIME type p28 whose subtype ends with the four characters "+xml". [RFC3023] p784
2.1.4 Scripting
The construction "a Foo object", where Foo is actually an interface, is sometimes used instead of the more accurate "an object implementing the interface Foo". An IDL attribute is said to be getting when its value is being retrieved (e.g. by author script), and is said to be setting when a new value is assigned to it. If a DOM object is said to be live, then the attributes and methods on that object must operate on the actual underlying data, not a snapshot of the data. The terms fire and dispatch are used interchangeably in the context of events, as in the DOM Events specifications. The term trusted event is used as defined by the DOM Events specification. [DOMEVENTS] p782
2.1.5 Plugins
The term plugin refers to a user-agent defined set of content handlers used by the user agent that can take part in the user agent's rendering of a Document p33 object, but that neither act as child browsing contexts p499 of the Document p33 nor introduce any Node p33 objects to the Document p33 's DOM. Typically such content handlers are provided by third parties, though a user agent can also designate built-in content handlers as plugins.
29
A user agent must not consider the types text/plain and application/octet-stream as having a registered plugin p29 . One example of a plugin would be a PDF viewer that is instantiated in a browsing context p499 when the user navigates to a PDF file. This would count as a plugin regardless of whether the party that implemented the PDF viewer component was the same as that which implemented the user agent itself. However, a PDF viewer application that launches separate from the user agent (as opposed to using the same interface) is not a plugin by this definition. Note: This specification does not define a mechanism for interacting with plugins, as it is expected to be user-agent- and platform-specific. Some UAs might opt to support a plugin mechanism such as the Netscape Plugin API; others might use remote content converters or have built-in support for certain types. Indeed, this specification doesn't require user agents to support plugins at all. [NPAPI] p783 Warning! Browsers should take extreme care when interacting with external content intended for plugins p29 . When third-party software is run with the same privileges as the user agent itself, vulnerabilities in the third-party software become as dangerous as those in the user agent.
30
A conforming XHTML processor would, upon finding an XHTML script p133 element in an XML document, execute the script contained in that element. However, if the element is found within a transformation expressed in XSLT (assuming the user agent also supports XSLT), then the processor would instead treat the script p133 element as an opaque element that forms part of the transform. Web browsers that support the HTML syntax p613 must process documents labeled with an HTML MIME type p28 as described in this specification, so that users can interact with them. User agents that support scripting must also be conforming implementations of the IDL fragments in this specification, as described in the Web IDL specification. [WEBIDL] p785 Note: Unless explicitly stated, specifications that override the semantics of HTML elements do not override the requirements on DOM objects representing those elements. For example, the script p133 element in the example above would still implement the HTMLScriptElement p133 interface. Non-interactive presentation user agents User agents that process HTML and XHTML documents purely to render non-interactive versions of them must comply to the same conformance criteria as Web browsers, except that they are exempt from requirements regarding user interaction. Note: Typical examples of non-interactive presentation user agents are printers (static UAs) and overhead displays (dynamic UAs). It is expected that most static non-interactive presentation user agents will also opt to lack scripting support p31 . A non-interactive but dynamic presentation UA would still execute scripts, allowing forms to be dynamically submitted, and so forth. However, since the concept of "focus" is irrelevant when the user cannot interact with the document, the UA would not need to support any of the focus-related DOM APIs. User agents with no scripting support Implementations that do not support scripting (or which have their scripting features disabled entirely) are exempt from supporting the events and DOM interfaces mentioned in this specification. For the parts of this specification that are defined in terms of an events model or in terms of the DOM, such user agents must still act as if events and the DOM were supported. Note: Scripting can form an integral part of an application. Web browsers that do not support scripting, or that have scripting disabled, might be unable to fully convey the author's intent. Conformance checkers Conformance checkers must verify that a document conforms to the applicable conformance criteria described in this specification. Automated conformance checkers are exempt from detecting errors that require interpretation of the author's intent (for example, while a document is non-conforming if the content of a blockquote p163 element is not a quote, conformance checkers running without the input of human judgement do not have to check that blockquote p163 elements only contain quoted material). Conformance checkers must check that the input document conforms when parsed without a browsing context p499 (meaning that no scripts are run, and that the parser's scripting flag p632 is disabled), and should also check that the input document conforms when parsed with a browsing context p499 in which scripts execute, and that the scripts never cause non-conforming states to occur other than transiently during script execution itself. (This is only a "SHOULD" and not a "MUST" requirement because it has been proven to be impossible. [COMPUTABLE] p781 ) The term "HTML validator" can be used to refer to a conformance checker that itself conforms to the applicable requirements of this specification. XML DTDs cannot express all the conformance requirements of this specification. Therefore, a validating XML processor and a DTD cannot constitute a conformance checker. Also, since neither of the two authoring formats defined in this specification are applications of SGML, a validating SGML system cannot constitute a conformance checker either. To put it another way, there are three types of conformance criteria: 1. 2. Criteria that can be expressed in a DTD. Criteria that cannot be expressed by a DTD, but can still be checked by a machine.
31
3.
A conformance checker must check for the first two. A simple DTD-based validator only checks for the first class of errors and is therefore not a conforming conformance checker according to this specification. Data mining tools Applications and tools that process HTML and XHTML documents for reasons other than to either render the documents or check them for conformance should act in accordance with the semantics of the documents that they process. A tool that generates document outlines p157 but increases the nesting level for each paragraph and does not increase the nesting level for each section would not be conforming. Authoring tools and markup generators Authoring tools and markup generators must generate conforming documents p30 . Conformance criteria that apply to authors also apply to authoring tools, where appropriate. Authoring tools are exempt from the strict requirements of using elements only for their specified purpose, but only to the extent that authoring tools are not yet able to determine author intent. However, authoring tools must not automatically misuse elements or encourage their users to do so. For example, it is not conforming to use an address p154 element for arbitrary contact information; that element can only be used for marking up contact information for the author of the document or section. However, since an authoring tool is likely unable to determine the difference, an authoring tool is exempt from that requirement. This does not mean, though, that authoring tools can use address p154 elements for any block of italics text (for instance); it just means that the authoring tool doesn't have to verify that when the user uses a tool for inserting contact information for a section, that the user really is doing that and not inserting something else instead. Note: In terms of conformance checking, an editor has to output documents that conform to the same extent that a conformance checker will verify. When an authoring tool is used to edit a non-conforming document, it may preserve the conformance errors in sections of the document that were not edited during the editing session (i.e. an editing tool is allowed to round-trip erroneous content). However, an authoring tool must not claim that the output is conformant if errors have been so preserved. Authoring tools are expected to come in two broad varieties: tools that work from structure or semantic data, and tools that work on a What-You-See-Is-What-You-Get media-specific editing basis (WYSIWYG). The former is the preferred mechanism for tools that author HTML, since the structure in the source information can be used to make informed choices regarding which HTML elements and attributes are most appropriate. However, WYSIWYG tools are legitimate. WYSIWYG tools should use elements they know are appropriate, and should not use elements that they do not know to be appropriate. This might in certain extreme cases mean limiting the use of flow elements to just a few elements, like div p172 , b p188 , i p187 , and span p194 and making liberal use of the style p95 attribute. All authoring tools, whether WYSIWYG or not, should make a best effort attempt at enabling users to create well-structured, semantically rich, media-independent content. Some conformance requirements are phrased as requirements on elements, attributes, methods or objects. Such requirements fall into two categories: those describing content model restrictions, and those describing implementation behavior. Those in the former category are requirements on documents and authoring tools. Those in the second category are requirements on user agents. Similarly, some conformance requirements are phrased as requirements on authors; such requirements are to be interpreted as conformance requirements on the documents that authors produce. (In other words, this specification does not distinguish between conformance criteria on authors and conformance criteria on documents.) Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be easy to follow, and not intended to be performant.) User agents may impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial of service attacks, to guard against running out of memory, or to work around platform-specific limitations. Note: There is no implied relationship between document conformance requirements and implementation conformance requirements. User agents are not free to handle non-
32
conformant documents as they please; the processing model described in this specification applies to implementations regardless of the conformity of the input documents. For compatibility with existing content and prior specifications, this specification describes two authoring formats: one based on XML (referred to as the XHTML syntax p705 ), and one using a custom format p613 inspired by SGML (referred to as the HTML syntax p613 ). Implementations must support at least one of these two formats, although supporting both is encouraged. The language in this specification assumes that the user agent expands all entity references, and therefore does not include entity reference nodes in the DOM. If user agents do include entity reference nodes in the DOM, then user agents must handle them as if they were fully expanded when implementing this specification. For example, if a requirement talks about an element's child text nodes, then any text nodes that are children of an entity reference that is a child of that element would be used as well. Entity references to unknown entities must be treated as if they contained just an empty text node for the purposes of the algorithms defined in this specification.
2.2.1 Dependencies
This specification relies on several other underlying specifications. XML Implementations that support the XHTML syntax p705 must support some version of XML, as well as its corresponding namespaces specification, because that syntax uses an XML serialization with namespaces. [XML] p786 [XMLNS] p786 DOM The Document Object Model (DOM) is a representation a model of a document and its content. The DOM is not just an API; the conformance criteria of HTML implementations are defined, in this specification, in terms of operations on the DOM. [DOMCORE] p782 Implementations must support some version of DOM Core and DOM Events, because this specification is defined in terms of the DOM, and some of the features are defined as extensions to the DOM Core interfaces. [DOMCORE] p782 [DOMEVENTS] p782 In particular, the following features are defined in the DOM Core specification: [DOMCORE] p782 Attr interface CDATASection interface Comment interface DOMImplementation interface Document interface DocumentFragment interface DocumentType interface DOMException interface Element interface Node interface NodeList interface ProcessingInstruction interface Text interface createDocument() method getElementById() method insertBefore() method ownerDocument attribute childNodes attribute localName attribute parentNode attribute namespaceURI attribute tagName attribute textContent attribute
The following features are defined in the DOM Events specification: [DOMEVENTS] p782 Event interface EventTarget interface UIEvent interface click event target attribute
The following features are defined in the DOM Range specification: [DOMRANGE] p782 Range interface deleteContents() method selectNodeContents() method setEnd() method setStart() method collapsed attribute endContainer attribute
33
Web IDL
The IDL fragments in this specification must be interpreted as required for conforming IDL fragments, as described in the Web IDL specification. [WEBIDL] p785 The terms supported property indices and supported property names are used as defined in the WebIDL specification. Except where otherwise specified, if an IDL attribute that is a floating point number type (double) is assigned an Infinity or Not-a-Number (NaN) value, a NOT_SUPPORTED_ERR p75 exception must be raised. Except where otherwise specified, if a method with an argument that is a floating point number type (double) is passed an Infinity or Not-a-Number (NaN) value, a NOT_SUPPORTED_ERR p75 exception must be raised. JavaScript Some parts of the language described by this specification only support JavaScript as the underlying scripting language. [ECMA262] p782 Note: The term "JavaScript" is used to refer to ECMA262, rather than the official term ECMAScript, since the term JavaScript is more widely known. Similarly, the MIME type p28 used to refer to JavaScript in this specification is text/javascript, since that is the most commonly used type, despite it being an officially obsoleted type p18 according to RFC 4329. [RFC4329] p784 Media Queries Implementations must support some version of the Media Queries language. [MQ] p783 URIs, IRIs, IDNA Implementations must support the semantics of URLs p55 defined in the URI and IRI specifications, as well as the semantics of IDNA domain names defined in the Internationalizing Domain Names in Applications (IDNA) specification. [RFC3986] p784 [RFC3987] p784 [RFC3490] p784 CSS modules While support for CSS as a whole is not required of implementations of this specification (though it is encouraged, at least for Web browsers), some features are defined in terms of specific CSS requirements. In particular, some features require that a string be parsed as a CSS <color> value. When parsing a CSS value, user agents are required by the CSS specifications to apply some error handling rules. These apply to this specification also. [CSSCOLOR] p781 [CSS] p781 For example, user agents are required to close all open constructs upon finding the end of a style sheet unexpectedly. Thus, when parsing the string "rgb(0,0,0" (with a missing close-parenthesis) for a color value, the close parenthesis is implied by this error handling rule, and a value is obtained (the color 'black'). However, the similar construct "rgb(0,0," (with both a missing parenthesis and a missing "blue" value) cannot be parsed, as it closing the open construct does not result in a viable value. This specification does not require support of any particular network protocol, style sheet language, scripting language, or any of the DOM specifications beyond those described above. However, the language described by this specification is biased towards CSS as the styling language, JavaScript as the scripting language, and HTTP as the network protocol, and several features assume that those languages and protocols are in use. Note: This specification might have certain additional requirements on character encodings, image formats, audio formats, and video formats in the respective sections.
2.2.2 Extensibility
HTML has a wide number of extensibility mechanisms that can be used for adding semantics in a safe manner: Authors can use the class p95 attribute to extend elements, effectively creating their own elements, while using the most applicable existing "real" HTML element, so that browsers and other tools that don't know of the extension can still support it somewhat well. This is the tack used by Microformats, for example. Authors can include data for inline client-side scripts or server-side site-wide scripts to process using the data-*="" p96 attributes. These are guaranteed to never be touched by browsers, and allow scripts to include data on HTML elements that scripts can then look for and process.
34
Authors can use the <meta name="" content=""> p122 mechanism to include page-wide metadata by registering extensions to the predefined set of metadata names p124 . Authors can use the rel="" p440 mechanism to annotate links with specific meanings by registering extensions to the predefined set of link types. This is also used by Microformats. Authors can embed raw data using the <script type=""> p133 mechanism with a custom type, for further handling by inline or server-side scripts. Authors can create plugins p29 and invoke them using the embed p220 element. This is how Flash works. Authors can extend APIs using the JavaScript prototyping mechanism. This is widely used by script libraries, for instance. Authors can use the microdata feature (the item="" and itemprop="" p464 attributes) to embed nested name-value pairs of data to be shared with other applications and sites.
Vendor-specific proprietary user agent extensions to this specification are strongly discouraged. Documents must not use such extensions, as doing so reduces interoperability and fragments the user base, allowing only users of specific user agents to access the content in question. If such extensions are nonetheless needed, e.g. for experimental purposes, then vendors are strongly urged to use one of the following extension mechanisms: For markup-level features that can be limited to the XML serialization and need not be supported in the HTML serialization, vendors should use the namespace mechanism to define custom namespaces in which the nonstandard elements and attributes are supported. For markup-level features that are intended for use with the HTML syntax p613 , extensions should be limited to new attributes of the form "x-vendor-feature", where vendor is a short string that identifies the vendor responsible for the extension, and feature is the name of the feature. New element names should not be created. Using attributes for such extensions exclusively allows extensions from multiple vendors to co-exist on the same element, which would not be possible with elements. Using the "x-vendor-feature" form allows extensions to be made without risk of conflicting with future additions to the specification. For instance, a browser named "FerretBrowser" could use "ferret" as a vendor prefix, while a browser named "Mellblom Browser" could use "mb". If both of these browsers invented extensions that turned elements into scratch-and-sniff areas, an author experimenting with these features could write: <p>This smells of lemons! <span x-ferret-smellovision x-ferret-smellcode="LEM01" x-mb-outputsmell x-mb-smell="lemon juice"></span></p> Attribute names beginning with the two characters "x-" are reserved for user agent use and are guaranteed to never be formally added to the HTML language. For flexibility, attributes names containing underscores (the U+005F LOW LINE character) are also reserved for experimental purposes and are guaranteed to never be formally added to the HTML language. Note: Pages that use such attributes are by definition non-conforming. For DOM extensions, e.g. new methods and IDL attributes, the new members should be prefixed by vendor-specific strings to prevent clashes with future versions of this specification. For events, experimental event names should be prefixed with vendor-specific strings. For example, if a user agent called "Pleasold" were to add an event to indicate when the user is going up in an elevator, it could use the prefix "pleasold" and thus name the event "pleasoldgoingup", possibly with an event handler attribute named "onpleasoldgoingup". All extensions must be defined so that the use of extensions neither contradicts nor causes the non-conformance of functionality defined in the specification. For example, while strongly discouraged from doing so, an implementation "Foo Browser" could add a new IDL attribute "fooTypeTime" to a control's DOM interface that returned the time it took the user to select the current value of a control (say). On the other hand, defining a new control that appears in a form's elements p349 array would be in violation of the above requirement, as it would violate the definition of elements p349 given in this specification. When adding new reflecting p62 IDL attributes corresponding to content attributes of the form "x-vendor-feature", the IDL attribute should be named "vendorFeature" (i.e. the "x" is dropped from the IDL attribute's name). When vendor-neutral extensions to this specification are needed, either this specification can be updated accordingly, or an extension specification can be written that overrides the requirements in this specification.
35
When someone applying this specification to their activities decides that they will recognize the requirements of such an extension specification, it becomes an applicable specification for the purposes of conformance requirements in this specification. Note: Someone could write a specification that defines any arbitrary byte stream as conforming, and then claim that their random junk is conforming. However, that does not mean that their random junk actually is conforming for everyone's purposes: if someone else decides that that specification does not apply to their work, then they can quite legitimately say that the aforementioned random junk is just that, junk, and not conforming at all. As far as conformance goes, what matters in a particular community is what that community agrees is applicable.
User agents must treat elements and attributes that they do not understand as semantically neutral; leaving them in the DOM (for DOM processors), and styling them according to CSS (for CSS processors), but not inferring any meaning from them. When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid in development, or for performance reasons), user agents must act as if they had no support for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted from the objects that implement that interface leaving the attribute on the object but making it return null or throw an exception is insufficient.
2.4 UTF-8
When a user agent is required to decode a byte string as UTF-8, with error handling, it means that the byte stream must be converted to a Unicode string by interpreting it as UTF-8, except that any errors must be handled as described in the following list. Bytes in the following list are represented in hexadecimal. [RFC3629] p784
36
One byte in the range C0 to C1, followed by one byte in the range 80 to BF One byte in the range F0 to F4, followed by three bytes in the range 80 to BF that represent a code point above U+10FFFF One byte in the range F5 to F7, followed by three bytes in the range 80 to BF One byte in the range F8 to FB, followed by four bytes in the range 80 to BF One byte in the range FC to FD, followed by five bytes in the range 80 to BF One byte in the range E0 to FD, followed by a byte in the range 80 to BF, not followed by a byte in the range 80 to BF One byte in the range F0 to FD, followed by two bytes in the range 80 to BF, not followed by a byte in the range 80 to BF One byte in the range F5 to FD, followed by three bytes in the range 80 to BF, not followed by a byte in the range 80 to BF One byte in the range FC to FD, followed by four bytes in the range 80 to BF, not followed by a byte in the range 80 to BF The whole sequence must be replaced by a single U+FFFD REPLACEMENT CHARACTER. One byte in the range 80 to BF not preceded by a byte in the range 80 to FD A sequence of bytes in the range 80 to BF that does not follow a byte in the range C0 to FD One byte in the range C0 to FD not followed by a byte in the range 80 to BF Each byte must be replaced with a U+FFFD REPLACEMENT CHARACTER. For the purposes of the above requirements, an overlong form in UTF-8 is a sequence that encodes a codepoint using more bytes than the minimum needed to encode that codepoint in UTF-8. For example, the byte string "41 98 BA 42 E2 98 43 E2 98 BA E2 98" would be converted to the string "ABC".
2.
37
3.
While position doesn't point past the end of input and the character at position is one of the characters, append that character to the end of result and advance position to the next character in input. Return result.
4.
The step skip whitespace means that the user agent must collect a sequence of characters p37 that are space characters p37 . The step skip White_Space characters means that the user agent must collect a sequence of characters p37 that are White_Space p37 characters. In both cases, the collected characters are not used. [UNICODE] p785 When a user agent is to strip line breaks from a string, the user agent must remove any U+000A LINE FEED (LF) and U+000D CARRIAGE RETURN (CR) characters from that string. When a user agent is to strip leading and trailing whitespace from a string, the user agent must remove all space characters p37 that are at the start or end of the string. The code-point length of a string is the number of Unicode code points in that string.
38
2.5.4 Numbers
2.5.4.1 Non-negative integers A string is a valid non-negative integer if it consists of one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A valid non-negative integer p39 represents the number that is represented in base ten by that string of digits. The rules for parsing non-negative integers are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either zero, a positive integer, or an error. 1. 2. 3. 4. 5. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Skip whitespace p38 . If position is past the end of input, return an error. If the character indicated by position is a U+002B PLUS SIGN character (+), advance position to the next character. (The "+" is ignored, but it is not conforming.) If position is past the end of input, return an error. If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and interpret the resulting sequence as a base-ten integer. Let value be that integer. Return value.
6. 7.
8.
9.
2.5.4.2 Signed integers A string is a valid integer if it consists of one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), optionally prefixed with a U+002D HYPHEN-MINUS character (-). A valid integer p39 without a U+002D HYPHEN-MINUS (-) prefix represents the number that is represented in base ten by that string of digits. A valid integer p39 with a U+002D HYPHEN-MINUS (-) prefix represents the number represented in base ten by the string of digits that follows the U+002D HYPHEN-MINUS, subtracted from zero. The rules for parsing integers are similar to the rules for non-negative integers p39 , and are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either an integer or an error. 1. 2. 3. 4. 5. 6. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Let sign have the value "positive". Skip whitespace p38 . If position is past the end of input, return an error. If the character indicated by position (the first character) is a U+002D HYPHEN-MINUS character (-): 1. 2. 3. Let sign be "negative". Advance position to the next character. If position is past the end of input, return an error.
Otherwise, if the character indicated by position (the first character) is a U+002B PLUS SIGN character (+): 1. 2. 7. Advance position to the next character. (The "+" is ignored, but it is not conforming.) If position is past the end of input, return an error.
If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and interpret the resulting sequence as a base-ten integer. Let value be that integer.
8.
39
9.
If sign is "positive", return value, otherwise return the result of subtracting value from zero.
2.5.4.3 Real numbers A string is a valid floating point number if it consists of: 1. 2. 3. Optionally, a U+002D HYPHEN-MINUS character (-). A series of one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally: 1. A single U+002E FULL STOP character (.). 2. A series of one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally: 1. Either a U+0065 LATIN SMALL LETTER E character (e) or a U+0045 LATIN CAPITAL LETTER E character (E). 2. Optionally, a U+002D HYPHEN-MINUS character (-) or U+002B PLUS SIGN character (+). 3. A series of one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
4.
A valid floating point number p40 represents the number obtained by multiplying the significand by ten raised to the power of the exponent, where the significand is the first number, interpreted as base ten (including the decimal point and the number after the decimal point, if any, and interpreting the significand as a negative number if the whole string starts with a U+002D HYPHEN-MINUS character (-) and the number is not zero), and where the exponent is the number after the E, if any (interpreted as a negative number if there is a U+002D HYPHEN-MINUS character (-) between the E and the number and the number is not zero, or else ignoring a U+002B PLUS SIGN character (+) between the E and the number if there is one). If there is no E, then the exponent is treated as zero. Note: The Infinity and Not-a-Number (NaN) values are not valid floating point numbers p40 . The best representation of the number n as a floating point number is the string obtained from applying the JavaScript operator ToString to n. The JavaScript operator ToString is not uniquely determined. When there are multiple possible strings that could be obtained from the JavaScript operator ToString for a particular value, the user agent must always return the same string for that value (though it may differ from the value used by other user agents). The rules for parsing floating point number values are as given in the following algorithm. This algorithm must be aborted at the first step that returns something. This algorithm will return either a number or an error. 1. 2. 3. 4. 5. 6. 7. 8. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Let value have the value 1. Let divisor have the value 1. Let exponent have the value 1. Skip whitespace p38 . If position is past the end of input, return an error. If the character indicated by position is a U+002D HYPHEN-MINUS character (-): 1. 2. 3. 9. Change value and divisor to 1. Advance position to the next character. If position is past the end of input, return an error.
If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and interpret the resulting sequence as a base-ten integer. Multiply value by that integer. If position is past the end of input, jump to the step labeled conversion. If the character indicated by position is a U+002E FULL STOP (.), run these substeps: 1. 2. Advance position to the next character. If position is past the end of input, or if the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled conversion. Fraction loop: Multiply divisor by ten.
10.
11. 12.
3.
40
4.
Add the value of the character indicated by position, interpreted as a base-ten digit (0..9) and divided by divisor, to value. Advance position to the next character. If position is past the end of input, then jump to the step labeled conversion. If the character indicated by position is one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), jump back to the step labeled fraction loop in these substeps.
5. 6. 7.
13.
If the character indicated by position is a U+0065 LATIN SMALL LETTER E character (e) or a U+0045 LATIN CAPITAL LETTER E character (E), run these substeps: 1. 2. 3. Advance position to the next character. If position is past the end of input, then jump to the step labeled conversion. If the character indicated by position is a U+002D HYPHEN-MINUS character (-): 1. 2. 3. Change exponent to 1. Advance position to the next character. If position is past the end of input, then jump to the step labeled conversion.
Otherwise, if the character indicated by position is a U+002B PLUS SIGN character (+): 1. 2. 4. Advance position to the next character. If position is past the end of input, then jump to the step labeled conversion.
If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled conversion. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and interpret the resulting sequence as a base-ten integer. Multiply exponent by that integer. Multiply value by ten raised to the exponentth power.
5.
6. 14.
Conversion: Let S be the set of finite IEEE 754 single-precision floating point values except 0, but with two special values added: 21024 and 21024. Let rounded-value be the number in S that is closest to value, selecting the number with an even significand if there are two equally close values. (The two special values 21024 and 21024 are considered to have even significands for this purpose.) If rounded-value is 21024 or 21024, return an error. Return rounded-value.
15.
16. 17.
2.5.4.4 Percentages and lengths The rules for parsing dimension values are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a number greater than or equal to 1.0, or an error; if a number is returned, then it is further categorized as either a percentage or a length. 1. 2. 3. 4. 5. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Skip whitespace p38 . If position is past the end of input, return an error. If the character indicated by position is a U+002B PLUS SIGN character (+), advance position to the next character. Collect a sequence of characters p37 that are U+0030 DIGIT ZERO (0) characters, and discard them. If position is past the end of input, return an error. If the character indicated by position is not one of U+0031 DIGIT ONE (1) to U+0039 DIGIT NINE (9), then return an error.
6. 7. 8.
41
9.
Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and interpret the resulting sequence as a base-ten integer. Let value be that number. If position is past the end of input, return value as a length. If the character indicated by position is a U+002E FULL STOP character (.): 1. 2. Advance position to the next character. If position is past the end of input, or if the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return value as a length. Let divisor have the value 1. Fraction loop: Multiply divisor by ten. Add the value of the character indicated by position, interpreted as a base-ten digit (0..9) and divided by divisor, to value. Advance position to the next character. If position is past the end of input, then return value as a length. If the character indicated by position is one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), return to the step labeled fraction loop in these substeps.
10. 11.
3. 4. 5.
6. 7. 8.
12. 13.
If position is past the end of input, return value as a length. If the character indicated by position is a U+0025 PERCENT SIGN character (%), return value as a percentage. Return value as a length.
14.
2.5.4.5 Lists of integers A valid list of integers is a number of valid integers p39 separated by U+002C COMMA characters, with no other characters (e.g. no space characters p37 ). In addition, there might be restrictions on the number of integers that can be given, or on the range of values allowed. The rules for parsing a list of integers are as follows: 1. 2. 3. 4. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Let numbers be an initially empty list of integers. This list will be the result of this algorithm. If there is a character in the string input at position position, and it is either a U+0020 SPACE, U+002C COMMA, or U+003B SEMICOLON character, then advance position to the next character in input, or to beyond the end of the string if there are no more characters. If position points to beyond the end of input, return numbers and abort. If the character in the string input at position position is a U+0020 SPACE, U+002C COMMA, or U+003B SEMICOLON character, then return to step 4. Let negated be false. Let value be 0. Let started be false. This variable is set to true when the parser sees a number or a U+002D HYPHENMINUS character (-). Let got number be false. This variable is set to true when the parser sees a number. Let finished be false. This variable is set to true to switch parser into a mode where it ignores characters until the next separator. Let bogus be false. Parser: If the character in the string input at position position is: A U+002D HYPHEN-MINUS character Follow these substeps: 1. If got number is true, let finished be true.
5. 6.
7. 8. 9.
10. 11.
12. 13.
42
2. 3. 4. 5.
If finished is true, skip to the next step in the overall set of steps. If started is true, let negated be false. Otherwise, if started is false and if bogus is false, let negated be true. Let started be true.
A character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) Follow these substeps: 1. 2. 3. 4. 5. If finished is true, skip to the next step in the overall set of steps. Multiply value by ten. Add the value of the digit, interpreted in base ten, to value. Let started be true. Let got number be true.
A U+0020 SPACE character A U+002C COMMA character A U+003B SEMICOLON character Follow these substeps: 1. If got number is false, return the numbers list and abort. This happens if an entry in the list has no digits, as in "1,2,x,4". If negated is true, then negate value. Append value to the numbers list. Jump to step 4 in the overall set of steps.
2. 3. 4.
A character in the range U+0001 to U+001F, U+0021 to U+002B, U+002D to U+002F, U+003A, U+003C to U+0040, U+005B to U+0060, U+007b to U+007F (i.e. any other nonalphabetic ASCII character) Follow these substeps: 1. 2. 3. If got number is true, let finished be true. If finished is true, skip to the next step in the overall set of steps. Let negated be false.
Any other character Follow these substeps: 1. 2. 3. 4. If finished is true, skip to the next step in the overall set of steps. Let negated be false. Let bogus be true. If started is true, then return the numbers list, and abort. (The value in value is not appended to the list first; it is dropped.)
14.
Advance position to the next character in input, or to beyond the end of the string if there are no more characters. If position points to a character (and not to beyond the end of input), jump to the big Parser step above. If negated is true, then negate value. If got number is true, then append value to the numbers list. Return the numbers list and abort.
2.5.4.6 Lists of dimensions The rules for parsing a list of dimensions are as follows. These rules return a list of zero or more pairs consisting of a number and a unit, the unit being one of percentage, relative, and absolute. 1. Let raw input be the string being parsed.
43
2.
If the last character in raw input is a U+002C COMMA character (,), then remove that character from raw input. Split the string raw input on commas p54 . Let raw tokens be the resulting list of tokens. Let result be an empty list of number/unit pairs. For each token in raw tokens, run the following substeps: 1. 2. 3. 4. 5. 6. Let input be the token. Let position be a pointer into input, initially pointing at the start of the string. Let value be the number 0. Let unit be absolute. If position is past the end of input, set unit to relative and jump to the last substep. If the character at position is a character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), interpret the resulting sequence as an integer in base ten, and increment value by that integer. If the character at position is a U+002E FULL STOP character (.), run these substeps: 1. Collect a sequence of characters p37 consisting of space characters p37 and characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Let s be the resulting sequence. Remove all space characters p37 in s. If s is not the empty string, run these subsubsteps: 1. Let length be the number of characters in s (after the spaces were removed). Let fraction be the result of interpreting s as a base-ten integer, and then dividing that number by 10length. Increment value by fraction.
3. 4. 5.
7.
2. 3.
2.
If the character at position is a U+0025 PERCENT SIGN character (%), then set unit to percentage. Otherwise, if the character at position is a U+002A ASTERISK character (*), then set unit to relative.
10. 6.
Add an entry to result consisting of the number given by value and the unit given by unit.
2.5.5.1 Months A month consists of a specific proleptic Gregorian date with no time-zone information and no date information beyond a year and a month. [GREGORIAN] p782
44
A string is a valid month string representing a year year and month month if it consists of the following components in the given order: 1. 2. 3. Four or more digits p44 , representing year, where year > 0 A U+002D HYPHEN-MINUS character (-) Two digits p44 , representing the month month, in the range 1 month 12
The rules to parse a month string are as follows. This will return either a year and month, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. 4. 5. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Parse a month component p45 to obtain year and month. If this returns nothing, then fail. If position is not beyond the end of input, then fail. Return year and month.
The rules to parse a month component, given an input string and a position, are as follows. This will return either a year and a month, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not at least four characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the year. If year is not a number greater than zero, then fail. If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the month. If month is not a number in the range 1 month 12, then fail. Return year and month.
2. 3.
4.
5. 6.
2.5.5.2 Dates A date consists of a specific proleptic Gregorian date with no time-zone information, consisting of a year, a month, and a day. [GREGORIAN] p782 A string is a valid date string representing a year year, month month, and day day if it consists of the following components in the given order: 1. 2. 3. A valid month string p45 , representing year and month A U+002D HYPHEN-MINUS character (-) Two digits p44 , representing day, in the range 1 day maxday where maxday is the number of days in the month month and year year p44
The rules to parse a date string are as follows. This will return either a date, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. 4. 5. 6. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Parse a date component p45 to obtain year, month, and day. If this returns nothing, then fail. If position is not beyond the end of input, then fail. Let date be the date with year year, month month, and day day. Return date.
The rules to parse a date component, given an input string and a position, are as follows. This will return either a year, a month, and a day, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
45
1. 2. 3.
Parse a month component p45 to obtain year and month. If this returns nothing, then fail. Let maxday be the number of days in month month of year year p44 . If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the day. If day is not a number in the range 1 day maxday, then fail. Return year, month, and day.
4.
5. 6.
2.5.5.3 Times A time consists of a specific time with no time-zone information, consisting of an hour, a minute, a second, and a fraction of a second. A string is a valid time string representing an hour hour, a minute minute, and a second second if it consists of the following components in the given order: 1. 2. 3. 4. Two digits p44 , representing hour, in the range 0 hour 23 A U+003A COLON character (:) Two digits p44 , representing minute, in the range 0 minute 59 Optionally (required if second is non-zero): 1. A U+003A COLON character (:) 2. Two digits p44 , representing the integer part of second, in the range 0 s 59 3. Optionally (required if second is not an integer): 1. A 002E FULL STOP character (.) 2. One or more digits p44 , representing the fractional part of second
Note: The second component cannot be 60 or 61; leap seconds cannot be represented. The rules to parse a time string are as follows. This will return either a time, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. 4. 5. 6. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Parse a time component p46 to obtain hour, minute, and second. If this returns nothing, then fail. If position is not beyond the end of input, then fail. Let time be the time with hour hour, minute minute, and second second. Return time.
The rules to parse a time component, given an input string and a position, are as follows. This will return either an hour, a minute, and a second, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the hour. If hour is not a number in the range 0 hour 23, then fail. If position is beyond the end of input or if the character at position is not a U+003A COLON character, then fail. Otherwise, move position forwards one character. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the minute. If minute is not a number in the range 0 minute 59, then fail. Let second be a string with the value "0".
2. 3.
4.
5. 6.
46
7.
If position is not beyond the end of input and the character at position is a U+003A COLON, then run these substeps: 1. 2. Advance position to the next character in input. If position is beyond the end of input, or at the last character in input, or if the next two characters in input starting at position are not two characters both in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then fail. Collect a sequence of characters p37 that are either characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) or U+002E FULL STOP characters. If the collected sequence has more than one U+002E FULL STOP characters, or if the last character in the sequence is a U+002E FULL STOP character, then fail. Otherwise, let the collected string be second instead of its previous value.
3.
8.
Interpret second as a base-ten number (possibly with a fractional part). Let second be that number instead of the string version. If second is not a number in the range 0 second < 60, then fail. Return hour, minute, and second.
9. 10.
2.5.5.4 Local dates and times A local date and time consists of a specific proleptic Gregorian date, consisting of a year, a month, and a day, and a time, consisting of an hour, a minute, a second, and a fraction of a second, but expressed without a time zone. [GREGORIAN] p782 A string is a valid local date and time string representing a date and time if it consists of the following components in the given order: 1. 2. 3. A valid date string p45 representing the date. A U+0054 LATIN CAPITAL LETTER T character (T). A valid time string p46 representing the time.
The rules to parse a local date and time string are as follows. This will return either a date and time, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. 4. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Parse a date component p45 to obtain year, month, and day. If this returns nothing, then fail. If position is beyond the end of input or if the character at position is not a U+0054 LATIN CAPITAL LETTER T character (T) then fail. Otherwise, move position forwards one character. Parse a time component p46 to obtain hour, minute, and second. If this returns nothing, then fail. If position is not beyond the end of input, then fail. Let date be the date with year year, month month, and day day. Let time be the time with hour hour, minute minute, and second second. Return date and time.
5. 6. 7. 8. 9.
2.5.5.5 Global dates and times A global date and time consists of a specific proleptic Gregorian date, consisting of a year, a month, and a day, and a time, consisting of an hour, a minute, a second, and a fraction of a second, expressed with a time-zone offset, consisting of a signed number of hours and minutes. [GREGORIAN] p782 A string is a valid global date and time string representing a date, time, and a time-zone offset if it consists of the following components in the given order: 1. 2. 3. A valid date string p45 representing the date A U+0054 LATIN CAPITAL LETTER T character (T) A valid time string p46 representing the time
47
4.
Either: A U+005A LATIN CAPITAL LETTER Z character (Z), allowed only if the time zone is UTC Or: 1. Either a U+002B PLUS SIGN character (+) or, if the time-zone offset is not zero, a U+002D HYPHEN-MINUS character (-), representing the sign of the time-zone offset 2. Two digits p44 , representing the hours component hour of the time-zone offset, in the range 0 hour 23 3. A U+003A COLON character (:) 4. Two digits p44 , representing the minutes component minute of the time-zone offset, in the range 0 minute 59
Note: This format allows for time-zone offsets from -23:59 to +23:59. In practice, however, the range of offsets of actual time zones is -12:00 to +14:00, and the minutes component of offsets of actual time zones is always either 00, 30, or 45. The following are some examples of dates written as valid global date and time strings p47 . "0037-12-13T00:00Z" Midnight UTC on the birthday of Nero (the Roman Emperor). See below for further discussion on which date this actually corresponds to. "1979-10-14T12:00:00.001-04:00" One millisecond after noon on October 14th 1979, in the time zone in use on the east coast of the USA during daylight saving time. "8592-01-01T02:09+02:09" Midnight UTC on the 1st of January, 8592. The time zone associated with that time is two hours and nine minutes ahead of UTC, which is not currently a real time zone, but is nonetheless allowed. Several things are notable about these dates: Years with fewer than four digits have to be zero-padded. The date "37-12-13" would not be a valid date. To unambiguously identify a moment in time prior to the introduction of the Gregorian calendar, the date has to be first converted to the Gregorian calendar from the calendar in use at the time (e.g. from the Julian calendar). The date of Nero's birth is the 15th of December 37, in the Julian Calendar, which is the 13th of December 37 in the proleptic Gregorian Calendar. The time and time-zone offset components are not optional. Dates before the year one can't be represented as a datetime in this version of HTML. Time-zone offsets differ based on daylight savings time.
The best representation of the global date and time string datetime is the valid global date and time string p47 representing datetime with the last character of the string not being a U+005A LATIN CAPITAL LETTER Z character (Z), even if the time zone is UTC, and with a U+002D HYPHEN-MINUS character (-) representing the sign of the time-zone offset when the time zone is UTC. The rules to parse a global date and time string are as follows. This will return either a time in UTC, with associated time-zone offset information for round tripping or display purposes, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. 4. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Parse a date component p45 to obtain year, month, and day. If this returns nothing, then fail. If position is beyond the end of input or if the character at position is not a U+0054 LATIN CAPITAL LETTER T character (T) then fail. Otherwise, move position forwards one character. Parse a time component p46 to obtain hour, minute, and second. If this returns nothing, then fail. If position is beyond the end of input, then fail. Parse a time-zone offset component p49 to obtain timezonehours and timezoneminutes. If this returns nothing, then fail. If position is not beyond the end of input, then fail.
5. 6. 7.
8.
48
9.
Let time be the moment in time at year year, month month, day day, hours hour, minute minute, second second, subtracting timezonehours hours and timezoneminutes minutes. That moment in time is a moment in the UTC time zone. Let timezone be timezonehours hours and timezoneminutes minutes from UTC. Return time and timezone.
10. 11.
The rules to parse a time-zone offset component, given an input string and a position, are as follows. This will return either time-zone hours and time-zone minutes, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. If the character at position is a U+005A LATIN CAPITAL LETTER Z character (Z), then: 1. 2. 3. Let timezonehours be 0. Let timezoneminutes be 0. Advance position to the next character in input.
Otherwise, if the character at position is either a U+002B PLUS SIGN (+) or a U+002D HYPHEN-MINUS (-), then: 1. If the character at position is a U+002B PLUS SIGN (+), let sign be "positive". Otherwise, it's a U+002D HYPHEN-MINUS (-); let sign be "negative". Advance position to the next character in input. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the timezonehours. If timezonehours is not a number in the range 0 timezonehours 23, then fail. If sign is "negative", then negate timezonehours. If position is beyond the end of input or if the character at position is not a U+003A COLON character, then fail. Otherwise, move position forwards one character. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the timezoneminutes. If timezoneminutes is not a number in the range 0 timezoneminutes 59, then fail. If sign is "negative", then negate timezoneminutes.
2. 3.
4. 5. 6.
7.
8. 9.
2.5.5.6 Weeks A week consists of a week-year number and a week number representing a seven-day period starting on a Monday. Each week-year in this calendaring system has either 52 or 53 such seven-day periods, as defined below. The seven-day period starting on the Gregorian date Monday December 29th 1969 (1969-12-29) is defined as week number 1 in week-year 1970. Consecutive weeks are numbered sequentially. The week before the number 1 week in a week-year is the last week in the previous week-year, and vice versa. [GREGORIAN] p782 A week-year with a number year has 53 weeks if it corresponds to either a year year in the proleptic Gregorian calendar that has a Thursday as its first day (January 1st), or a year year in the proleptic Gregorian calendar that has a Wednesday as its first day (January 1st) and where year is a number divisible by 400, or a number divisible by 4 but not by 100. All other week-years have 52 weeks. The week number of the last day of a week-year with 53 weeks is 53; the week number of the last day of a week-year with 52 weeks is 52. Note: The week-year number of a particular day can be different than the number of the year that contains that day in the proleptic Gregorian calendar. The first week in a week-year y is the week that contains the first Thursday of the Gregorian year y. A string is a valid week string representing a week-year year and week week if it consists of the following components in the given order:
49
1. 2. 3. 4.
Four or more digits p44 , representing year, where year > 0 A U+002D HYPHEN-MINUS character (-) A U+0057 LATIN CAPITAL LETTER W character (W) Two digits p44 , representing the week week, in the range 1 week maxweek, where maxweek is the week number of the last day p49 of week-year year
The rules to parse a week string are as follows. This will return either a week-year number and week number, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not at least four characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the year. If year is not a number greater than zero, then fail. If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character. If position is beyond the end of input or if the character at position is not a U+0057 LATIN CAPITAL LETTER W character (W), then fail. Otherwise, move position forwards one character. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the week. Let maxweek be the week number of the last day p49 of year year. If week is not a number in the range 1 week maxweek, then fail. If position is not beyond the end of input, then fail. Return the week-year number year and the week number week.
4. 5.
6.
7.
8. 9. 10. 11.
2.5.5.7 Vaguer moments in time A string is a valid date or time string if it is also one of the following: A valid date string p45 . A valid time string p46 . A valid global date and time string p47 .
A string is a valid date or time string in content if it consists of zero or more White_Space p37 characters, followed by a valid date or time string p50 , followed by zero or more further White_Space p37 characters. A string is a valid date string with optional time if it is also one of the following: A valid date string p45 . A valid global date and time string p47 .
A string is a valid date string in content with optional time if it consists of zero or more White_Space p37 characters, followed by a valid date string with optional time p50 , followed by zero or more further White_Space p37 characters. The rules to parse a date or time string are as follows. The algorithm is invoked with a flag indicating if the in attribute variant or the in content variant is to be used. The algorithm will return either a date p45 , a time p46 , a global date and time p47 , or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing. 1. 2. 3. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. For the in content variant: skip White_Space characters p38 .
50
4. 5. 6.
Set start position to the same position as position. Set the date present and time present flags to true. Parse a date component p45 to obtain year, month, and day. If this fails, then set the date present flag to false. If date present is true, and position is not beyond the end of input, and the character at position is a U+0054 LATIN CAPITAL LETTER T character (T), then advance position to the next character in input. Otherwise, if date present is true, and either position is beyond the end of input or the character at position is not a U+0054 LATIN CAPITAL LETTER T character (T), then set time present to false. Otherwise, if date present is false, set position back to the same position as start position.
7.
8.
If the time present flag is true, then parse a time component p46 to obtain hour, minute, and second. If this returns nothing, then fail. If the date present and time present flags are both true, but position is beyond the end of input, then fail. If the date present and time present flags are both true, parse a time-zone offset component p49 to obtain timezonehours and timezoneminutes. If this returns nothing, then fail. For the in content variant: skip White_Space characters p38 . If position is not beyond the end of input, then fail. If the date present flag is true and the time present flag is false, then let date be the date with year year, month month, and day day, and return date. Otherwise, if the time present flag is true and the date present flag is false, then let time be the time with hour hour, minute minute, and second second, and return time. Otherwise, let time be the moment in time at year year, month month, day day, hours hour, minute minute, second second, subtracting timezonehours hours and timezoneminutes minutes, that moment in time being a moment in the UTC time zone; let timezone be timezonehours hours and timezoneminutes minutes from UTC; and return time and timezone.
9.
10.
2.5.6 Colors
A simple color consists of three 8-bit numbers in the range 0..255, representing the red, green, and blue components of the color respectively, in the sRGB color space. [SRGB] p785 A string is a valid simple color if it is exactly seven characters long, and the first character is a U+0023 NUMBER SIGN character (#), and the remaining six characters are all in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F, U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F, with the first two digits representing the red component, the middle two digits representing the green component, and the last two digits representing the blue component, in hexadecimal. A string is a valid lowercase simple color if it is a valid simple color p51 and doesn't use any characters in the range U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F. The rules for parsing simple color values are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a simple color p51 or an error. 1. 2. 3. 4. Let input be the string being parsed. If input is not exactly seven characters long, then return an error. If the first character in input is not a U+0023 NUMBER SIGN character (#), then return an error. If the last six characters of input are not all in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F, U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F, then return an error. Let result be a simple color p51 . Interpret the second and third characters as a hexadecimal number and let the result be the red component of result. Interpret the fourth and fifth characters as a hexadecimal number and let the result be the green component of result.
5. 6.
7.
51
8.
Interpret the sixth and seventh characters as a hexadecimal number and let the result be the blue component of result. Return result.
9.
The rules for serializing simple color values given a simple color p51 are as given in the following algorithm: 1. 2. Let result be a string consisting of a single U+0023 NUMBER SIGN character (#). Convert the red, green, and blue components in turn to two-digit hexadecimal numbers using the digits U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) and U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F, zero-padding if necessary, and append these numbers to result, in the order red, green, blue. Return result, which will be a valid lowercase simple color p51 .
3.
Some obsolete legacy attributes parse colors in a more complicated manner, using the rules for parsing a legacy color value, which are given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a simple color p51 or an error. 1. 2. 3. 4. 5. 6. Let input be the string being parsed. If input is the empty string, then return an error. Let keyword be a string with the same value as input. Strip leading and trailing whitespace p38 from keyword. If keyword is an ASCII case-insensitive p36 match for the string "transparent", then return an error. If keyword is an ASCII case-insensitive p36 match for one of the keywords listed in the SVG color keywords section of the CSS3 Color specification, then return the simple color p51 corresponding to that keyword. [CSSCOLOR] p781 Note: CSS2 System Colors are not recognised. 7. If input is four characters long, and the first character in input is a U+0023 NUMBER SIGN character (#), and the last three characters of input are all in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F, and U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F, then run these substeps: 1. 2. Let result be a simple color p51 . Interpret the second character of input as a hexadecimal digit; let the red component of result be the resulting number multiplied by 17. Interpret the third character of input as a hexadecimal digit; let the green component of result be the resulting number multiplied by 17. Interpret the fourth character of input as a hexadecimal digit; let the blue component of result be the resulting number multiplied by 17. Return result.
3.
4.
5. 8.
Replace any characters in input that have a Unicode code point greater than U+FFFF (i.e. any characters that are not in the basic multilingual plane) with the two-character string "00". If input is longer than 128 characters, truncate input, leaving only the first 128 characters. If the first character in input is a U+0023 NUMBER SIGN character (#), remove it. Replace any character in input that is not in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F, and U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F with the character U+0030 DIGIT ZERO (0). While input's length is zero or not a multiple of three, append a U+0030 DIGIT ZERO (0) character to input. Split input into three strings of equal length, to obtain three components. Let length be the length of those components (one third the length of input). If length is greater than 8, then remove the leading length-8 characters in each component, and let length be 8.
9. 10. 11.
12.
13.
14.
52
15.
While length is greater than two and the first character in each component is a U+0030 DIGIT ZERO (0) character, remove that character and reduce length by one. If length is still greater than two, truncate each component, leaving only the first two characters in each. Let result be a simple color p51 . Interpret the first component as a hexadecimal number; let the red component of result be the resulting number. Interpret the second component as a hexadecimal number; let the green component of result be the resulting number. Interpret the third component as a hexadecimal number; let the blue component of result be the resulting number. Return result.
19.
20.
21.
Note: The 2D graphics context p289 has a separate color syntax that also handles opacity.
Return tokens.
When a user agent has to remove a token from a string, it must use the following algorithm: 1. 2. 3. 4. 5. 6. Let input be the string being modified. Let token be the token being removed. It will not contain any space characters p37 . Let output be the output string, initially empty. Let position be a pointer into input, initially pointing at the start of the string. Loop: If position is beyond the end of input, abort these steps. If the character at position is a space character p37 :
53
1. 2. 3. 7.
Append the character at position to the end of output. Advance position so it points at the next character in input. Return to the step labeled loop.
Otherwise, the character at position is the first character of a token. Collect a sequence of characters p37 that are not space characters p37 , and let that be s. If s is exactly equal to token (this is a case-sensitive p36 comparison), then: 1. 2. 3. Skip whitespace p38 (in input). Remove any space characters p37 currently at the end of output. If position is not past the end of input, and output is not the empty string, append a single U+0020 SPACE character at the end of output.
8.
9. 10.
Otherwise, append s to the end of output. Return to the step labeled loop.
Note: This causes any occurrences of the token to be removed from the string, and any spaces that were surrounding the token to be collapsed to a single space, except at the start and end of the string, where such spaces are removed.
6. 7. 8.
9. 10.
2.5.9 References
A valid hash-name reference to an element of type type is a string consisting of a U+0023 NUMBER SIGN character (#) followed by a string which exactly matches the value of the name attribute of an element with type type in the document. The rules for parsing a hash-name reference to an element of type type are as follows:
54
1.
If the string being parsed does not contain a U+0023 NUMBER SIGN character, or if the first such character in the string is the last character in the string, then return null and abort these steps. Let s be the string from the character immediately after the first U+0023 NUMBER SIGN character in the string being parsed up to the end of that string. Return the first element of type type that has an id p92 attribute whose value is a case-sensitive p36 match for s or a name attribute whose value is a compatibility caseless p36 match for s.
2.
3.
2.6 URLs
2.6.1 Terminology
A URL is a string used to identify a resource. A URL p55 is a valid URL if at least one of the following conditions holds: The URL p55 is a valid URI reference [RFC3986] p784 . The URL p55 is a valid IRI reference and it has no query component. [RFC3987] p784 The URL p55 is a valid IRI reference and its query component contains no unescaped non-ASCII characters. [RFC3987] p784 The URL p55 is a valid IRI reference and the character encoding p81 of the URL's Document p33 is UTF-8 or UTF-16. [RFC3987] p784
A string is a valid non-empty URL if it is a valid URL p55 but it is not the empty string. A string is a valid URL potentially surrounded by spaces if, after stripping leading and trailing whitespace p38 from it, it is a valid URL p55 . A string is a valid non-empty URL potentially surrounded by spaces if, after stripping leading and trailing whitespace p38 from it, it is a valid non-empty URL p55 . ** To parse a URL url into its component parts, the user agent must use the by the IRI specification. [RFC3987] p784 Parsing a URL can fail. If it does not, then it results in the following components, again as defined by the IRI specification: <scheme> <host> <port> <hostport> <path> <query> <fragment> <host-specific> parse an address algorithm defined
To resolve a URL to an absolute URL p56 relative to either another absolute URL p56 or an element, the user agent must use the following steps. Resolving a URL can result in an error, in which case the URL is not resolvable. 1. 2. Let url be the URL p55 being resolved. Let encoding be determined as follows: If the URL had a character encoding defined when the URL was created or defined The URL character encoding is as defined. If the URL came from a script (e.g. as an argument to a method) The URL character encoding is the script's URL character encoding p551 .
55
If the URL came from a DOM node (e.g. from an element) The node has a Document p33 , and the URL character encoding is the document's character encoding p81 . 3. 4. If encoding is a UTF-16 encoding, then change the value of encoding to UTF-8. If the algorithm was invoked with an absolute URL p56 to use as the base URL, let base be that absolute URL p56 . Otherwise, let base be the base URI of the element, as defined by the XML Base specification, with the base URI of the document entity being defined as the document base URL p56 of the Document p33 that owns the element. [XMLBASE] p786 For the purposes of the XML Base specification, user agents must act as if all Document p33 objects represented XML documents. Note: It is possible for xml:base p93 attributes to be present even in HTML fragments, as such attributes can be added dynamically using script. (Such scripts would not be conforming, however, as xml:base p93 attributes are not allowed in HTML documents p77 .) The document base URL of a Document p33 object is the absolute URL p56 obtained by running these substeps: 1. 2. Let fallback base url be the document's address p77 . If fallback base url is about:blank p60 , and the Document p33 's browsing context p499 has a creator browsing context p499 , then let fallback base url be the document base URL p56 of the creator Document p499 instead. If the Document p33 is an iframe srcdoc document p214 , then let fallback base url be the document base URL p56 of the Document p33 's browsing context p499 's browsing context container p499 's Document p33 instead. If there is no base p118 element that has an href p118 attribute, then the document base URL p56 is fallback base url. Otherwise, let url be the value of the href p118 attribute of the first such element. Resolve p55 url relative to fallback base url (thus, the base p118 href p118 attribute isn't affected by xml:base p93 attributes). The document base URL p56 is the result of the previous step if it was successful; otherwise it is fallback base url. resolve an address algorithm defined by the IRI specification to
3.
4.
5.
6.
**
5.
resolve url relative to base using encoding encoding. [RFC3987] p784 A URL p55 is an absolute URL if resolving p55 it results in the same output regardless of what it is resolved relative to, and that output is not a failure. An absolute URL p56 is a hierarchical URL if, when resolved p55 and then parsed p55 , there is a character immediately after the <scheme> p55 component and it is a U+002F SOLIDUS character (/). An absolute URL p56 is an authority-based URL if, when resolved p55 and then parsed p55 , there are two characters immediately after the <scheme> p55 component and they are both U+002F SOLIDUS characters (//). This specification defines the URL about:legacy-compat as a reserved, though unresolvable, about: URI, for use in DOCTYPE p613 s in HTML documents p77 when needed for compatibility with XML tools. [ABOUT] p781 This specification defines the URL about:srcdoc as a reserved, though unresolvable, about: URI, that is used as the document's address p77 of iframe srcdoc documents p214 . [ABOUT] p781 Note: The term "URL" in this specification is used in a manner distinct from the precise technical meaning it is given in RFC 3986. Readers familiar with that RFC will find it easier to read this specification if they pretend the term "URL" as used herein is really called something else altogether. This is a willful violation p18 of RFC 3986. [RFC3986] p784
56
If the absolute URL p56 identified by the hyperlink is being shown to the user, or if any data derived from that URL is affecting the display, then the href p440 attribute should be re-resolved p55 relative to the element and the UI updated appropriately. For example, the CSS :link p456 /:visited p456 pseudo-classes might have been affected. If the hyperlink has a ping p440 attribute and its absolute URL(s) p56 are being shown to the user, then the ping p440 attribute's tokens should be re-resolved p55 relative to the element and the UI updated appropriately.
p179 , blockquote p163 , section p144 , article p147 , ins p196 , or del p197 element with a cite If the element is a q attribute
If the absolute URL p56 identified by the cite attribute is being shown to the user, or if any data derived from that URL is affecting the display, then the URL p55 should be re-resolved p55 relative to the element and the UI updated appropriately. Otherwise The element is not directly affected. Changing the base URL doesn't affect the image displayed by img p199 elements, although subsequent accesses of the src p203 IDL attribute from script will return a new absolute URL p56 that might no longer correspond to the image being shown.
This box is non-normative. Implementation requirements are given below this box. o . protocol
p58
[ = value ]
Returns the current scheme of the underlying URL. Can be set, to change the underlying URL's scheme. o . host p58 [ = value ] Returns the current host and port (if it's not the default port) in the underlying URL. Can be set, to change the underlying URL's host and port. The host and the port are separated by a colon. The port part, if omitted, will be assumed to be the current scheme's default port. o . hostname p58 [ = value ] Returns the current host in the underlying URL. Can be set, to change the underlying URL's host.
57
o . port p58 [ = value ] Returns the current port in the underlying URL. Can be set, to change the underlying URL's port. o . pathname p59 [ = value ] Returns the current path in the underlying URL. Can be set, to change the underlying URL's path. o . search p59 [ = value ] Returns the current query component in the underlying URL. Can be set, to change the underlying URL's query component. o . hash p59 [ = value ] Returns the current fragment identifier in the underlying URL. Can be set, to change the underlying URL's fragment identifier.
The attributes defined to be URL decomposition IDL attributes p57 must act as described for the attributes with the same corresponding names in this section. In addition, an interface with a complement of URL decomposition IDL attributes p57 will define an input, which is a URL p55 that the attributes act on, and a common setter action, which is a set of steps invoked when any of the attributes' setters are invoked. The seven URL decomposition IDL attributes p57 have similar requirements. On getting, if the input p58 is an absolute URL p56 that fulfills the condition given in the "getter condition" column corresponding to the attribute in the table below, the user agent must return the part of the input p58 URL given in the "component" column, with any prefixes specified in the "prefix" column appropriately added to the start of the string and any suffixes specified in the "suffix" column appropriately added to the end of the string. Otherwise, the attribute must return the empty string. On setting, the new value must first be mutated as described by the "setter preprocessor" column, then mutated by %-escaping any characters in the new value that are not valid in the relevant component as given by the "component" column. Then, if the input p58 is an absolute URL p56 and the resulting new value fulfills the condition given in the "setter condition" column, the user agent must make a new string output by replacing the component of the URL given by the "component" column in the input p58 URL with the new value; otherwise, the user agent must let output be equal to the input p58 . Finally, the user agent must invoke the common setter action p58 with the value of output. When replacing a component in the URL, if the component is part of an optional group in the URL syntax consisting of a character followed by the component, the component (including its prefix character) must be included even if the new value is the empty string. Note: The previous paragraph applies in particular to the ":" before a <port> component, the "?" before a <query> component, and the "#" before a <fragment> component. For the purposes of the above definitions, URLs must be parsed using the URL parsing rules p55 defined in this specification.
Attribute Component Getter Condition Prefix Suffix Setter Preprocessor Setter Condition The new value is not the empty string The new value is not the empty string and input p58 is an authority-based URL p56
U+003A Remove all trailing U+003A COLON characters COLON (:) (:)
host
<hostport> p55
Remove all leading U+002F SOLIDUS characters The new value is not (/) the empty string and input p58 is an authority-based URL p56 Remove all characters in the new value from the first that is not in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), if any. Remove any leading U+0030 DIGIT ZERO input p58 is an authority-based URL p56 , and the new value, when
port
<port> p55
58
Attribute
Component
Prefix
Suffix
Setter Preprocessor characters (0) in the new value. If the resulting string is empty, set it to a single U+0030 DIGIT ZERO character (0).
Setter Condition interpreted as a base-ten integer, is less than or equal to 65535 input p58 is hierarchical input p58 is a hierarchical URL p56
input p58 is a hierarchical URL p56 input p58 is a hierarchical URL p56 , and contained a <query> p55 component (possibly an empty one)
If it has no leading U+002F SOLIDUS character (/), prepend a U+002F SOLIDUS character (/) to the new value Remove one leading U+003F QUESTION MARK character (?), if any
search
<query> p55
hash
The table below demonstrates how the getter condition for search p59 results in different results depending on the exact original syntax of the URL:
Input URL http://example.com/ http://example.com/? http://example.com/ ?test http://example.com/ ?test# search p59 value empty string ? ?test ?test Explanation No <query> p55 component in input URL. There is a <query> p55 component, but it is empty. The question mark in the resulting value is the prefix. The <query> p55 component has the value "test". The (empty) <fragment> p55 component is not part of the <query> p55 component.
The following table is similar; it provides a list of what each of the URL decomposition IDL attributes p57 returns for a given input URL.
Input http://example.com/ carrot#question%3f protocol p58 http: host p58 example.com hostname p58 example.com port p58 pathname p59 search p59 (empty /carrot string) / (empty string) ? hash p59
#question%3f
https://www.example.com:4443? https:
(empty string)
The active document p499 of the source browsing context p520 . When fetching resources for an element The element's Document p33 . When fetching resources in response to a call to an API The entry script p502 's document p551 . 2. While document is is an iframe srcdoc document p214 , let document be document's browsing context p499 's browsing context container p499 's Document p33 instead. Generate the address of the resource from which Request-URIs are obtained as required by HTTP for the Referer (sic) header from the document's current address p77 of document. [HTTP] p782 Remove any <fragment> p55 component from the generated address of the resource from which Request-URIs are obtained. If the origin p510 of the appropriate Document p33 is not a scheme/host/port tuple, then the Referer (sic) header must be omitted, regardless of its value.
3.
59
4.
If the algorithm was not invoked with the synchronous flag, perform the remaining steps asynchronously. This is the main step. If the resource is identified by an absolute URL p56 , and the resource is to be obtained using an idempotent action (such as an HTTP GET or equivalent p61 ), and it is already being downloaded for other reasons (e.g. another invocation of this algorithm), and this request would be identical to the previous one (e.g. same Accept and Origin headers), and the user agent is configured such that it is to reuse the data from the existing download instead of initiating a new one, then use the results of the existing download instead of starting a new one. Otherwise, if the resource is identified by an absolute URL p56 with a scheme that does not define a mechanism to obtain the resource (e.g. it is a mailto: URL) or that the user agent does not support, then act as if the resource was an HTTP 204 No Content response with no other metadata. Otherwise, if the resource is identified by the URL p55 about:blank, then the resource is immediately available and consists of the empty string, with no metadata. Otherwise, at a time convenient to the user and the user agent, download (or otherwise obtain) the resource, applying the semantics of the relevant specifications (e.g. performing an HTTP GET or POST operation, or reading the file from disk, dereferencing javascript: URLs p554 , etc). For the purposes of the Referer (sic) header, use the address of the resource from which Request-URIs are obtained generated in the earlier step. For the purposes of the Origin header, if the fetching algorithm p59 was explicitly initiated from an origin, then the origin that initiated the HTTP request is origin. Otherwise, this is a request from a "privacysensitive" context. [ORIGIN] p783
5.
6.
If the algorithm was not invoked with the block cookies flag, and there are cookies to be set, then the user agent must run the following substeps: 1. Wait until ownership of the storage mutex p553 can be taken by this instance of the fetching p59 algorithm. Take ownership of the storage mutex p553 . Update the cookies. [COOKIES] p781 Release the storage mutex p553 so that it is once again free.
2. 3. 4. 7.
Abort these steps and return failure from this algorithm, as if the remote host could not be contacted. If the manual redirect flag is set Continue, using the fetched resource (the redirect) as the result of the algorithm. Otherwise First, apply any relevant requirements for redirects (such as showing any appropriate prompts). Then, redo main step, but using the target of the redirect as the resource to fetch, rather than the original resource. Note: The HTTP specification requires that 301, 302, and 307 redirects, when applied to methods other than the safe methods, not be followed without user confirmation. That would be an appropriate prompt for the purposes of the requirement in the paragraph above. [HTTP] p782 8. If the algorithm was not invoked with the synchronous flag: When the resource is available, or if there is an error of some description, queue a task p553 that uses the resource as appropriate. If the resource can be processed incrementally, as, for instance, with a progressively interlaced JPEG or an HTML file, additional tasks may be queued to process the data as it is downloaded. The task source p553 for these tasks p553 is the networking task source p554 . Otherwise, return the resource or error information to the calling algorithm. If the user agent can determine the actual length of the resource being fetched p59 for an instance of this algorithm, and if that length is finite, then that length is the file's size. Otherwise, the subject of the algorithm
60
(that is, the resource being fetched) has no known size p60 . (For example, the HTTP Content-Length header might provide this information.) The user agent must also keep track of the number of bytes downloaded for each instance of this algorithm. This number must exclude any out-of-band metadata, such as HTTP headers. Note: The application cache p533 processing model introduces some changes to the networking model p546 to handle the returning of cached resources. Note: The navigation p520 processing model handles redirects itself, overriding the redirection handling that would be done by the fetching algorithm. Note: Whether the type sniffing rules p61 apply to the fetched resource depends on the algorithm that invokes the rules they are not always applicable.
61
Warning! It is imperative that the rules in the Media Type Sniffing specification be followed exactly. When a user agent uses different heuristics for content type detection than the server expects, security problems can occur. For more details, see the Media Type Sniffing specification. [MIMESNIFF] p783 The algorithm for extracting an encoding from a Content-Type, given a string s, is as follows. It either returns an encoding or nothing. 1. 2. Let position be a pointed into s, initially pointing at the start of the string. Loop: Find the first seven characters in s after position that are an ASCII case-insensitive p36 match for the word "charset". If no such match is found, return nothing and abort these steps. Skip any U+0009, U+000A, U+000C, U+000D, or U+0020 characters that immediately follow the word "charset" (there might not be any). If the next character is not a U+003D EQUALS SIGN ('='), then move position to point just before that next character, and jump back to the step labeled loop. Skip any U+0009, U+000A, U+000C, U+000D, or U+0020 characters that immediately follow the equals sign (there might not be any). Process the next character as follows: If it is a U+0022 QUOTATION MARK ('"') and there is a later U+0022 QUOTATION MARK ('"') in s If it is a U+0027 APOSTROPHE ("'") and there is a later U+0027 APOSTROPHE ("'") in s Return the encoding corresponding to the string between this character and the next earliest occurrence of this character. If it is an unmatched U+0022 QUOTATION MARK ('"') If it is an unmatched U+0027 APOSTROPHE ("'") If there is no next character Return nothing. Otherwise Return the encoding corresponding to the string from this character to the first U+0009, U+000A, U+000C, U+000D, U+0020, or U+003B character or the end of s, whichever comes first. Note: This requirement is a willful violation p18 of the HTTP specification (for example, HTTP doesn't allow the use of single quotes and requires supporting a backslash-escape mechanism that is not supported by this algorithm), motivated by the need for backwards compatibility with legacy content. [HTTP] p782
3.
4.
5.
6.
62
associated with the state the attribute is in (in its canonical case), or the empty string if the attribute is in a state that has no associated keyword value; and on setting, the content attribute must be set to the specified new value. If a reflecting IDL attribute is a DOMString but doesn't fall into any of the above categories, then the getting and setting must be done in a transparent, case-preserving manner. If a reflecting IDL attribute is a boolean attribute, then on getting the IDL attribute must return true if the content attribute is set, and false if it is absent. On setting, the content attribute must be removed if the IDL attribute is set to false, and must be set to the empty string if the IDL attribute is set to true. (This corresponds to the rules for boolean content attributes p38 .) If a reflecting IDL attribute is a signed integer type (long) then, on getting, the content attribute must be parsed according to the rules for parsing signed integers p39 , and if that is successful, and the value is in the range of the IDL attribute's type, the resulting value must be returned. If, on the other hand, it fails or returns an out of range value, or if the attribute is absent, then the default value must be returned instead, or 0 if there is no default value. On setting, the given value must be converted to the shortest possible string representing the number as a valid integer p39 and then that string must be used as the new content attribute value. If a reflecting IDL attribute is a signed integer type (long) that is limited to only non-negative numbers then, on getting, the content attribute must be parsed according to the rules for parsing non-negative integers p39 , and if that is successful, and the value is in the range of the IDL attribute's type, the resulting value must be returned. If, on the other hand, it fails or returns an out of range value, or if the attribute is absent, the default value must be returned instead, or 1 if there is no default value. On setting, if the value is negative, the user agent must fire an INDEX_SIZE_ERR p75 exception. Otherwise, the given value must be converted to the shortest possible string representing the number as a valid non-negative integer p39 and then that string must be used as the new content attribute value. If a reflecting IDL attribute is an unsigned integer type (unsigned long) then, on getting, the content attribute must be parsed according to the rules for parsing non-negative integers p39 , and if that is successful, and the value is in the range 0 to 2147483647 inclusive, the resulting value must be returned. If, on the other hand, it fails or returns an out of range value, or if the attribute is absent, the default value must be returned instead, or 0 if there is no default value. On setting, the given value must be converted to the shortest possible string representing the number as a valid non-negative integer p39 and then that string must be used as the new content attribute value. If a reflecting IDL attribute is an unsigned integer type (unsigned long) that is limited to only non-negative numbers greater than zero, then the behavior is similar to the previous case, but zero is not allowed. On getting, the content attribute must first be parsed according to the rules for parsing non-negative integers p39 , and if that is successful, and the value is in the range 1 to 2147483647 inclusive, the resulting value must be returned. If, on the other hand, it fails or returns an out of range value, or if the attribute is absent, the default value must be returned instead, or 1 if there is no default value. On setting, if the value is zero, the user agent must fire an INDEX_SIZE_ERR p75 exception. Otherwise, the given value must be converted to the shortest possible string representing the number as a valid non-negative integer p39 and then that string must be used as the new content attribute value. If a reflecting IDL attribute is a floating point number type (double), then, on getting, the content attribute must be parsed according to the rules for parsing floating point number values p40 , and if that is successful, the resulting value must be returned. If, on the other hand, it fails, or if the attribute is absent, the default value must be returned instead, or 0.0 if there is no default value. On setting, the given value must be converted to the best representation of the number as a floating point number p40 and then that string must be used as the new content attribute value. Note: The values Infinity and Not-a-Number (NaN) values throw an exception on setting, as defined earlier p34 . If a reflecting IDL attribute is of the type DOMTokenList p70 or DOMSettableTokenList p72 , then on getting it must return a DOMTokenList p70 or DOMSettableTokenList p72 object (as appropriate) whose underlying string is the element's corresponding content attribute. When the object mutates its underlying string, the content attribute must itself be immediately mutated. When the attribute is absent, then the string represented by the object is the empty string; when the object mutates this empty string, the user agent must add the corresponding content attribute, with its value set to the value it would have been set to after mutating the empty string. The same DOMTokenList p70 or DOMSettableTokenList p72 object must be returned every time for each attribute. If an element with no attributes has its element.classList.remove() p71 method invoked, the underlying string won't be changed, since the result of removing any token from the empty string is still the empty string. However, if the element.classList.add() p71 method is then invoked, a class p95 attribute will be added to the element with the value of the token to be added. If a reflecting IDL attribute has the type HTMLElement p88 , or an interface that descends from HTMLElement p88 , then, on getting, it must run the following algorithm (stopping at the first point where a value is returned): 1. If the corresponding content attribute is absent, then the IDL attribute must return null.
63
2.
Let candidate be the element that the document.getElementById() p33 method would find when called on the content attribute's document if it was passed as its argument the current value of the corresponding content attribute. If candidate is null, or if it is not type-compatible with the IDL attribute, then the IDL attribute must return null. Otherwise, it must return candidate.
3.
4.
On setting, if the given element has an id p92 attribute, then the content attribute must be set to the value of that id p92 attribute. Otherwise, the IDL attribute must be set to the empty string.
2.8.2 Collections
The HTMLCollection p64 , HTMLAllCollection p65 , HTMLFormControlsCollection p66 , HTMLOptionsCollection p67 , and HTMLPropertiesCollection p69 interfaces represent various lists of DOM nodes. Collectively, objects implementing these interfaces are called collections. When a collection p64 is created, a filter and a root are associated with the collection. For example, when the HTMLCollection p64 object for the document.images p83 attribute is created, it is associated with a filter that selects only img p199 elements, and rooted at the root of the document. The collection p64 then represents a live p29 view of the subtree rooted at the collection's root, containing only nodes that match the given filter. The view is linear. In the absence of specific requirements to the contrary, the nodes within the collection must be sorted in tree order p29 . Note: The rows p326 list is not in tree order. An attribute that returns a collection must return the same object every time it is retrieved.
2.8.2.1 HTMLCollection The HTMLCollection p64 interface represents a generic collection p64 of elements. interface HTMLCollection { readonly attribute unsigned long length; caller getter Element item(in unsigned long index); caller getter object namedItem(in DOMString name); // only returns Element }; This box is non-normative. Implementation requirements are given below this box. collection . length
p65
Returns the number of elements in the collection. element = collection . item p65 (index) collection[index] collection(index) Returns the item with index index from the collection. The items are sorted in tree order p29 . Returns null if index is out of range. element = collection . namedItem p65 (name) collection[name] collection(name) Returns the first item with ID p92 or name name from the collection. Returns null if no element with that ID p92 or name could be found. Only a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , and object p222 elements can have a name for the purpose of this method; their name is given by the value of their name attribute.
The object's supported property indices p34 are the numbers in the range zero to one less than the number of nodes represented by the collection p64 . If there are no such elements, then there are no supported property indices p34 .
64
The length attribute must return the number of nodes represented by the collection p64 . The item(index) method must return the indexth node in the collection. If there is no indexth node in the collection, then the method must return null. The supported property names p34 consist of the values of the name attributes of each a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , and object p222 element represented by the collection p64 with a name attribute, plus the list of IDs that the elements represented by the collection p64 have. The namedItem(key) method must return the first node in the collection that matches the following requirements: It is an a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , or object p222 element with a name attribute equal to key, or, It is an element with an ID p92 equal to key.
If no such elements are found, then the method must return null.
2.8.2.2 HTMLAllCollection The HTMLAllCollection p65 interface represents a generic collection p64 of elements just like HTMLCollection p64 , with the exception that its namedItem() p65 method returns an HTMLAllCollection p65 object when there are multiple matching elements. interface HTMLAllCollection : HTMLCollection { // inherits length and item() caller getter object namedItem(in DOMString name); // overrides inherited namedItem() HTMLAllCollection tags(in DOMString tagName); }; This box is non-normative. Implementation requirements are given below this box. collection . length
p65
Returns the number of elements in the collection. element = collection . item p65 (index) collection[index] collection(index) Returns the item with index index from the collection. The items are sorted in tree order p29 . Returns null if index is out of range. element = collection . namedItem p65 (name) collection = collection . namedItem p65 (name) collection[name] collection(name) Returns the item with ID p92 or name name from the collection. If there are multiple matching items, then an HTMLAllCollection p65 object containing all those elements is returned. Returns null if no element with that ID p92 or name could be found. Only a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , and object p222 elements can have a name for the purpose of this method; their name is given by the value of their name attribute. collection = collection . tags p66 (tagName) Returns a collection that is a filtered view of the current collection, containing only elements with the given tag name.
The object's supported property indices p34 and supported property names p34 are as defined for HTMLCollection p64 objects. The namedItem(key) method must act according to the following algorithm: 1. Let collection be an HTMLAllCollection p65 object rooted at the same node as the HTMLAllCollection p65 object on which the method was invoked, whose filter matches only elements that already match the filter of the HTMLAllCollection p65 object on which the method was invoked and that are either:
65
a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , or object p222 elements with a name attribute equal to key, or, elements with an ID p92 equal to key.
2.
If, at the time the method is called, there is exactly one node in collection, then return that node and stop the algorithm. Otherwise, if, at the time the method is called, collection is empty, return null and stop the algorithm. Otherwise, return collection.
3. 4.
The tags(tagName) method must return an HTMLAllCollection p65 rooted at the same node as the HTMLAllCollection p65 object on which the method was invoked, whose filter matches only HTML elements p28 whose local name is the tagName argument and that already match the filter of the HTMLAllCollection p65 object on which the method was invoked. In HTML documents p77 , the argument must first be converted to ASCII lowercase p36 .
2.8.2.3 HTMLFormControlsCollection The HTMLFormControlsCollection p66 interface represents a collection p64 of listed elements p347 in form p347 and fieldset p350 elements. interface HTMLFormControlsCollection : HTMLCollection { // inherits length and item() caller getter object namedItem(in DOMString name); // overrides inherited namedItem() }; interface RadioNodeList : NodeList { attribute DOMString value; }; This box is non-normative. Implementation requirements are given below this box. collection . length p65 Returns the number of elements in the collection. element = collection . item p65 (index) collection[index] collection(index) Returns the item with index index from the collection. The items are sorted in tree order p29 . Returns null if index is out of range. element = collection . namedItem p66 (name) radioNodeList = collection . namedItem p66 (name) collection[name] collection(name) Returns the item with ID p92 or name p408 name from the collection. If there are multiple matching items, then a RadioNodeList p66 object containing all those elements is returned. Returns null if no element with that ID p92 or name p408 could be found. radioNodeList . value [ = value ] Returns the value of the first checked radio button represented by the object. Can be set, to check the first radio button with the given value represented by the object.
The object's supported property indices p34 are as defined for HTMLCollection p64 objects. The supported property names p34 consist of the values of all the id p92 and name p408 attributes of all the elements represented by the collection p64 . The namedItem(name) method must act according to the following algorithm: 1. If, at the time the method is called, there is exactly one node in the collection that has either an id p92 attribute or a name p408 attribute equal to name, then return that node and stop the algorithm.
66
2.
Otherwise, if there are no nodes in the collection that have either an id p92 attribute or a name p408 attribute equal to name, then return null and stop the algorithm. Otherwise, create a new RadioNodeList p66 object representing a live p29 view of the HTMLFormControlsCollection p66 object, further filtered so that the only nodes in the RadioNodeList p66 object are those that have either an id p92 attribute or a name p408 attribute equal to name. The nodes in the RadioNodeList p66 object must be sorted in tree order p29 . Return that RadioNodeList p66 object.
3.
4.
Members of the RadioNodeList p66 interface inherited from the NodeList p33 interface must behave as they would on a NodeList p33 object. The value IDL attribute on the RadioNodeList p66 object, on getting, must return the value returned by running the following steps: 1. Let element be the first element in tree order p29 represented by the RadioNodeList p66 object that is an input p353 element whose type p355 attribute is in the Radio Button p371 state and whose checkedness p409 is true. Otherwise, let it be null. If element is null, or if it is an element with no value p357 attribute, return the empty string. Otherwise, return the value of element's value p357 attribute.
2. 3.
On setting, the value p67 IDL attribute must run the following steps: 1. Let element be the first element in tree order p29 represented by the RadioNodeList p66 object that is an input p353 element whose type p355 attribute is in the Radio Button p371 state and whose value p357 content attribute is present and equal to the new value, if any. Otherwise, let it be null. If element is not null, then set its checkedness p409 to true.
2.
2.8.2.4 HTMLOptionsCollection The HTMLOptionsCollection p67 interface represents a list of option p393 elements. It is always rooted on a select p387 element and has attributes and methods that manipulate that element's descendants. interface HTMLOptionsCollection : HTMLCollection { // inherits item() attribute unsigned long length; // overrides inherited length caller getter object namedItem(in DOMString name); // overrides inherited namedItem() void add(in HTMLElement element, in optional HTMLElement before); void add(in HTMLElement element, in long before); void remove(in long index); attribute long selectedIndex; }; This box is non-normative. Implementation requirements are given below this box. collection . length
p68
[ = value ]
Returns the number of elements in the collection. When set to a smaller number, truncates the number of option p393 elements in the corresponding container. When set to a greater number, adds new blank option p393 elements to that container. element = collection . item p65 (index) collection[index] collection(index) Returns the item with index index from the collection. The items are sorted in tree order p29 . Returns null if index is out of range.
67
element = collection . namedItem p68 (name) nodeList = collection . namedItem p68 (name) collection[name] collection(name) Returns the item with ID p92 or name p741 name from the collection. If there are multiple matching items, then a NodeList p33 object containing all those elements is returned. Returns null if no element with that ID p92 could be found. collection . add p68 (element [, before ] ) Inserts element before the node given by before. The before argument can be a number, in which case element is inserted before the item with that number, or an element from the collection, in which case element is inserted before that element. If before is omitted, null, or a number out of range, then element will be added at the end of the list. This method will throw a HIERARCHY_REQUEST_ERR p75 exception if element is an ancestor of the element into which it is to be inserted. If element is not an option p393 or optgroup p392 element, then the method does nothing. collection . selectedIndex p69 [ = value ] Returns the index of the first selected item, if any, or 1 if there is no selected item. Can be set, to change the selection.
The object's supported property indices p34 are as defined for HTMLCollection p64 objects. On getting, the length attribute must return the number of nodes represented by the collection p64 . On setting, the behavior depends on whether the new value is equal to, greater than, or less than the number of nodes represented by the collection p64 at that time. If the number is the same, then setting the attribute must do nothing. If the new value is greater, then n new option p393 elements with no attributes and no child nodes must be appended to the select p387 element on which the HTMLOptionsCollection p67 is rooted, where n is the difference between the two numbers (new value minus old value). Mutation events must be fired as if a DocumentFragment p33 containing the new option p393 elements had been inserted. If the new value is lower, then the last n nodes in the collection must be removed from their parent nodes, where n is the difference between the two numbers (old value minus new value). Note: Setting length p68 never removes or adds any optgroup p392 elements, and never adds new children to existing optgroup p392 elements (though it can remove children from them). The supported property names p34 consist of the values of all the id p92 and name p741 attributes of all the elements represented by the collection p64 . The namedItem(name) method must act according to the following algorithm: 1. If, at the time the method is called, there is exactly one node in the collection that has either an id p92 attribute or a name p741 attribute equal to name, then return that node and stop the algorithm. Otherwise, if there are no nodes in the collection that have either an id p92 attribute or a name p741 attribute equal to name, then return null and stop the algorithm. Otherwise, create a new NodeList p33 object representing a live p29 view of the HTMLOptionsCollection p67 object, further filtered so that the only nodes in the NodeList p33 object are those that have either an id p92 attribute or a name p741 attribute equal to name. The nodes in the NodeList p33 object must be sorted in tree order p29 . Return that NodeList p33 object.
2.
3.
4.
The add(element, before) method must act according to the following algorithm: 1. 2. If element is not an option p393 or optgroup p392 element, then return and abort these steps. If element is an ancestor of the select p387 element on which the HTMLOptionsCollection p67 is rooted, then throw a HIERARCHY_REQUEST_ERR p75 exception. If before is an element, but that element isn't a descendant of the select p387 element on which the HTMLOptionsCollection p67 is rooted, then throw a NOT_FOUND_ERR p75 exception.
3.
68
4. 5.
If element and before are the same element, then return and abort these steps. If before is a node, then let reference be that node. Otherwise, if before is an integer, and there is a beforeth node in the collection, let reference be that node. Otherwise, let reference be null. If reference is not null, let parent be the parent node of reference. Otherwise, let parent be the select p387 element on which the HTMLOptionsCollection p67 is rooted. Act as if the DOM Core insertBefore() p33 method was invoked on the parent node, with element as the first argument and reference as the second argument.
6.
7.
The remove(index) method must act according to the following algorithm: 1. 2. If the number of nodes represented by the collection p64 is zero, abort these steps. If index is not a number greater than or equal to 0 and less than the number of nodes represented by the collection p64 , let element be the first element in the collection. Otherwise, let element be the indexth element in the collection. Remove element from its parent node.
3.
The selectedIndex IDL attribute must act like the identically named attribute on the select p387 element on which the HTMLOptionsCollection p67 is rooted
2.8.2.5 HTMLPropertiesCollection The HTMLPropertiesCollection p69 interface represents a collection p64 of elements that add name-value pairs to a particular item p464 in the microdata p459 model. interface HTMLPropertiesCollection : HTMLCollection { // inherits length and item() caller getter PropertyNodeList namedItem(in DOMString name); // overrides inherited namedItem() readonly attribute DOMStringList names; }; typedef sequence<any> PropertyValueArray; interface PropertyNodeList : NodeList { readonly attribute PropertyValueArray values; }; This box is non-normative. Implementation requirements are given below this box. collection . length p65 Returns the number of elements in the collection. element = collection . item p65 (index) collection[index] collection(index) Returns the element with index index from the collection. The items are sorted in tree order p29 . Returns null if index is out of range. propertyNodeList = collection . namedItem p70 (name) collection[name] collection(name) Returns a PropertyNodeList p69 object containing any elements that add a property named name. collection . names p70 Returns a DOMStringList with the property names p465 of the elements in the collection. propertyNodeList . values p70 Returns an array of the various values that the relevant elements have.
The object's supported property indices p34 are as defined for HTMLCollection p64 objects.
69
The supported property names p34 consist of the property names p465 of all the elements represented by the collection p64 . The names attribute must return a live p29 DOMStringList object giving the property names p465 of all the elements represented by the collection p64 , listed in tree order p29 , but with duplicates removed, leaving only the first occurrence of each name. The same object must be returned each time. The namedItem(name) method must return a PropertyNodeList p69 object representing a live p29 view of the HTMLPropertiesCollection p69 object, further filtered so that the only nodes in the PropertyNodeList p69 object are those that have a property name p465 equal to name. The nodes in the PropertyNodeList p69 object must be sorted in tree order p29 , and the same object must be returned each time a particular name is queried. Members of the PropertyNodeList p69 interface inherited from the NodeList p33 interface must behave as they would on a NodeList p33 object. The values IDL attribute on the PropertyNodeList p69 object, on getting, must return a newly constructed array whose values are the values obtained from the itemValue p468 DOM property of each of the elements represented by the object, in tree order p29 .
2.8.3 DOMTokenList
The DOMTokenList p70 interface represents an interface to an underlying string that consists of a set of spaceseparated tokens p53 . Note: DOMTokenList p70 objects are always case-sensitive p36 , even when the underlying string might ordinarily be treated in a case-insensitive manner. interface DOMTokenList { readonly attribute unsigned long length; getter DOMString item(in unsigned long index); boolean contains(in DOMString token); void add(in DOMString token); void remove(in DOMString token); boolean toggle(in DOMString token); stringifier DOMString (); }; This box is non-normative. Implementation requirements are given below this box. tokenlist . length
p71
Returns the number of tokens in the string. element = tokenlist . item p71 (index) tokenlist[index] Returns the token with index index. The tokens are returned in the order they are found in the underlying string. Returns null if index is out of range. hastoken = tokenlist . contains p71 (token) Returns true if the token is present; false otherwise. Throws a SYNTAX_ERR p75 exception if token is empty. Throws an INVALID_CHARACTER_ERR p75 exception if token contains any spaces. tokenlist . add p71 (token) Adds token, unless it is already present. Throws a SYNTAX_ERR p75 exception if token is empty. Throws an INVALID_CHARACTER_ERR p75 exception if token contains any spaces. tokenlist . remove p71 (token) Removes token if it is present. Throws a SYNTAX_ERR p75 exception if token is empty. Throws an INVALID_CHARACTER_ERR p75 exception if token contains any spaces.
70
hastoken = tokenlist . toggle p71 (token) Adds token if it is not present, or removes it if it is. Returns true if token is now present (it was added); returns false if it is not (it was removed). Throws a SYNTAX_ERR p75 exception if token is empty. Throws an INVALID_CHARACTER_ERR p75 exception if token contains any spaces.
The length attribute must return the number of tokens that result from splitting the underlying string on spaces p53 . This is the length p71 . The object's supported property indices p34 are the numbers in the range zero to length p71 -1, unless the length p71 is zero, in which case there are no supported property indices p34 . The item(index) method must split the underlying string on spaces p53 , preserving the order of the tokens as found in the underlying string, and then return the indexth item in this list. If index is equal to or greater than the number of tokens, then the method must return null. For example, if the string is "a b a c" then there are four tokens: the token with index 0 is "a", the token with index 1 is "b", the token with index 2 is "a", and the token with index 3 is "c". The contains(token) method must run the following algorithm: 1. 2. If the token argument is the empty string, then raise a SYNTAX_ERR p75 exception and stop the algorithm. If the token argument contains any space characters p37 , then raise an INVALID_CHARACTER_ERR p75 exception and stop the algorithm. Otherwise, split the underlying string on spaces p53 to get the list of tokens in the object's underlying string. If the token indicated by token is a case-sensitive p36 match for one of the tokens in the object's underlying string then return true and stop this algorithm. Otherwise, return false.
3.
4.
5.
The add(token) method must run the following algorithm: 1. 2. If the token argument is the empty string, then raise a SYNTAX_ERR p75 exception and stop the algorithm. If the token argument contains any space characters p37 , then raise an INVALID_CHARACTER_ERR p75 exception and stop the algorithm. Otherwise, split the underlying string on spaces p53 to get the list of tokens in the object's underlying string. If the given token is a case-sensitive p36 match for one of the tokens in the DOMTokenList p70 object's underlying string then stop the algorithm. Otherwise, if the DOMTokenList p70 object's underlying string is not the empty string and the last character of that string is not a space character p37 , then append a U+0020 SPACE character to the end of that string. Append the value of token to the end of the DOMTokenList p70 object's underlying string.
3.
4.
5.
6.
The remove(token) method must run the following algorithm: 1. 2. If the token argument is the empty string, then raise a SYNTAX_ERR p75 exception and stop the algorithm. If the token argument contains any space characters p37 , then raise an INVALID_CHARACTER_ERR p75 exception and stop the algorithm. Otherwise, remove the given token from the underlying string p53 .
3.
The toggle(token) method must run the following algorithm: 1. 2. If the token argument is the empty string, then raise a SYNTAX_ERR p75 exception and stop the algorithm. If the token argument contains any space characters p37 , then raise an INVALID_CHARACTER_ERR p75 exception and stop the algorithm. Otherwise, split the underlying string on spaces p53 to get the list of tokens in the object's underlying string.
3.
71
4.
If the given token is a case-sensitive p36 match for one of the tokens in the DOMTokenList p70 object's underlying string then remove the given token from the underlying string p53 and stop the algorithm, returning false. Otherwise, if the DOMTokenList p70 object's underlying string is not the empty string and the last character of that string is not a space character p37 , then append a U+0020 SPACE character to the end of that string. Append the value of token to the end of the DOMTokenList p70 object's underlying string. Return true.
5.
6. 7.
Objects implementing the DOMTokenList p70 interface must stringify to the object's underlying string representation.
2.8.4 DOMSettableTokenList
The DOMSettableTokenList p72 interface is the same as the DOMTokenList p70 interface, except that it allows the underlying string to be directly changed. interface DOMSettableTokenList : DOMTokenList { attribute DOMString value; }; This box is non-normative. Implementation requirements are given below this box. tokenlist . value
p72
Returns the underlying string. Can be set, to change the underlying string.
An object implementing the DOMSettableTokenList p72 interface must act as defined for the DOMTokenList p70 interface, except for the value p72 attribute defined here. The value attribute must return the underlying string on getting, and must replace the underlying string with the new value on setting.
3.
4.
The internal structured cloning algorithm is always called with two arguments, input and memory, and its behavior is as follows: 1. If input is the source object of a pair of objects in memory, then return the destination object in that pair of objects and abort these steps. If input is a primitive value, then return that value and abort these steps. The input value is an object. Jump to the appropriate step below: If input is a Boolean object Let output be a newly constructed Boolean object with the same value as input. If input is a Number object Let output be a newly constructed Number object with the same value as input. If input is a String object Let output be a newly constructed String object with the same value as input.
2. 3.
72
If input is a Date object Let output be a newly constructed Date object with the same value as input. If input is a RegExp object Let output be a newly constructed RegExp object with the same pattern and flags as input. Note: The value of the lastIndex property is not copied.
p290 object If input is a ImageData
Let output be a newly constructed ImageData p290 object with the same width p309 and height p309 as input, and with a newly constructed CanvasPixelArray p291 for its data p309 attribute, with the same length p309 and pixel values as the input's. If input is a File object Let output be a newly constructed File object corresponding to the same underlying data. If input is a Blob object Let output be a newly constructed Blob object corresponding to the same underlying data. If input is a FileList object Let output be a newly constructed FileList object containing a list of newly constructed File objects corresponding to the same underlying data as those in input, maintaining their relative order. If input is an Array object Let output be a newly constructed empty Array object. If input is an Object object Let output be a newly constructed empty Object p222 object.
p557 ) If input is another native object type (e.g. Error, Function
If input is a host object (e.g. a DOM node) Throw a DATA_CLONE_ERR p75 exception and abort the overall structured clone p72 algorithm. 4. 5. Add a mapping from input (the source object) to output (the destination object) to memory. If input is an Array object or an Object object, then, for each enumerable property in input, add a corresponding property to output having the same name, and having a value created from invoking the internal structured cloning algorithm p72 recursively with the value of the property as the "input" argument and memory as the "memory" argument. The order of the properties in the input and output objects must be the same. Note: This does not walk the prototype chain. 6. Return output.
Note: This algorithm preserves cycles and preserves the identity of duplicate objects in graphs.
2.8.6 DOMStringMap
The DOMStringMap p73 interface represents a set of name-value pairs. It exposes these using the scripting language's native mechanisms for property access. When a DOMStringMap p73 object is instantiated, it is associated with three algorithms, one for getting the list of name-value pairs, one for setting names to certain values, and one for deleting names. interface DOMStringMap { getter DOMString (in DOMString name); setter void (in DOMString name, in DOMString value); creator void (in DOMString name, in DOMString value); deleter void (in DOMString name); }; The supported property names p34 on a DOMStringMap p73 object at any instant are the names of each pair returned from the algorithm for getting the list of name-value pairs at that instant.
73
To determine the value of a named property name in a DOMStringMap p73 , the user agent must return the value component of the name-value pair whose name component is name in the list returned by the algorithm for getting the list of name-value pairs. To set the value of a new or existing named property name to value value, the algorithm for setting names to certain values must be run, passing name as the name and the result of converting value to a DOMString as the value. To delete an existing named property name, the algorithm for deleting names must be run, passing name as the name. Note: The DOMStringMap p73 interface definition here is only intended for JavaScript environments. Other language bindings will need to define how DOMStringMap p73 is to be implemented for those languages. The dataset p96 attribute on elements exposes the data-* p96 attributes on the element. Given the following fragment and elements with similar constructions: <img class="tower" id="tower5" data-x="12" data-y="5" data-ai="robotarget" data-hp="46" data-ability="flames" src="towers/rocket.png alt="Rocket Tower"> ...one could imagine a function splashDamage() that takes some arguments, the first of which is the element to process: function splashDamage(node, x, y, damage) { if (node.classList.contains('tower') && // checking the 'class' attribute node.dataset.x == x && // reading the 'data-x' attribute node.dataset.y == y) { // reading the 'data-y' attribute var hp = parseInt(node.dataset.hp); // reading the 'data-hp' attribute hp = hp - damage; if (hp < 0) { hp = 0; node.dataset.ai = 'dead'; // setting the 'data-ai' attribute delete node.dataset.ability; // removing the 'data-ability' attribute } node.dataset.hp = hp; // setting the 'data-hp' attribute } }
2.8.7 DOMElementMap
The DOMElementMap p74 interface represents a set of name-element mappings. It exposes these using the scripting language's native mechanisms for property access. When a DOMElementMap p74 object is instantiated, it is associated with three algorithms, one for getting the list of name-element mappings, one for mapping a name to a certain element, and one for deleting mappings by name. interface DOMElementMap { getter DOMString (in DOMString name); setter void (in DOMString name, in Element value); creator void (in DOMString name, in Element value); deleter void (in DOMString name); }; The supported property names p34 on a DOMElementMap p74 object at any instant are the names for each mapping returned from the algorithm for getting the list of name-element mappings at that instant. To determine the value of a named property name in a DOMElementMap p74 , the user agent must return the element component of the name-element mapping whose name component is name in the list returned by the algorithm for getting the list of name-element mappings. To set the value of a new or existing named property name to value value, the algorithm for mapping a name to a certain element must be run, passing name as the name value as the element. To delete an existing named property name, the algorithm for deleting mappings must be run, passing name as the name component of the mapping to be deleted.
74
Note: The DOMElementMap p74 interface definition here is only intended for JavaScript environments. Other language bindings will need to define how DOMElementMap p74 is to be implemented for those languages.
2.8.9 Exceptions
The following are DOMException p33 codes. [DOMCORE] p782 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 25. INDEX_SIZE_ERR DOMSTRING_SIZE_ERR HIERARCHY_REQUEST_ERR WRONG_DOCUMENT_ERR INVALID_CHARACTER_ERR NO_DATA_ALLOWED_ERR NO_MODIFICATION_ALLOWED_ERR NOT_FOUND_ERR NOT_SUPPORTED_ERR INUSE_ATTRIBUTE_ERR INVALID_STATE_ERR SYNTAX_ERR INVALID_MODIFICATION_ERR NAMESPACE_ERR INVALID_ACCESS_ERR VALIDATION_ERR TYPE_MISMATCH_ERR SECURITY_ERR NETWORK_ERR ABORT_ERR URL_MISMATCH_ERR QUOTA_EXCEEDED_ERR TIMEOUT_ERR DATA_CLONE_ERR
[Supplemental] exception DOMException { const unsigned short URL_MISMATCH_ERR = 21; const unsigned short QUOTA_EXCEEDED_ERR = 22; const unsigned short DATA_CLONE_ERR = 25; };
2.9 Namespaces
The HTML namespace is: http://www.w3.org/1999/xhtml The MathML namespace is: http://www.w3.org/1998/Math/MathML The SVG namespace is: http://www.w3.org/2000/svg The XLink namespace is: http://www.w3.org/1999/xlink The XML namespace is: http://www.w3.org/XML/1998/namespace
75
The XMLNS namespace is: http://www.w3.org/2000/xmlns/ Data mining tools and other user agents that perform operations on content without running scripts, evaluating CSS or XPath expressions, or otherwise exposing the resulting DOM to arbitrary content, may "support namespaces" by just asserting that their DOM node analogues are in certain namespaces, without actually exposing the above strings.
76
77
readonly readonly readonly readonly readonly readonly readonly NodeList NodeList NodeList readonly
attribute HTMLElement body; attribute HTMLHeadElement head; attribute HTMLCollection images; attribute HTMLCollection embeds; attribute HTMLCollection plugins; attribute HTMLCollection links; attribute HTMLCollection forms; attribute HTMLCollection scripts; getElementsByName(in DOMString elementName); getElementsByClassName(in DOMString classNames); getItems(in optional DOMString typeNames); // microdata attribute DOMElementMap cssElementMap;
// dynamic markup insertion attribute DOMString innerHTML; HTMLDocument open(in optional DOMString type, in optional DOMString replace); WindowProxy open(in DOMString url, in DOMString name, in DOMString features, in optional boolean replace); void close(); void write(in DOMString... text); void writeln(in DOMString... text); // user interaction readonly attribute WindowProxy defaultView; readonly attribute Element activeElement; boolean hasFocus(); attribute DOMString designMode; boolean execCommand(in DOMString commandId); boolean execCommand(in DOMString commandId, in boolean showUI); boolean execCommand(in DOMString commandId, in boolean showUI, in DOMString value); boolean queryCommandEnabled(in DOMString commandId); boolean queryCommandIndeterm(in DOMString commandId); boolean queryCommandState(in DOMString commandId); boolean queryCommandSupported(in DOMString commandId); DOMString queryCommandValue(in DOMString commandId); readonly attribute HTMLCollection commands; // event handler IDL attributes attribute Function onabort; attribute Function onblur; attribute Function oncanplay; attribute Function oncanplaythrough; attribute Function onchange; attribute Function onclick; attribute Function oncontextmenu; attribute Function oncuechange; attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function ondblclick; ondrag; ondragend; ondragenter; ondragleave; ondragover; ondragstart; ondrop; ondurationchange; onemptied; onended; onerror; onfocus; onformchange; onforminput; oninput; oninvalid; onkeydown; onkeypress;
78
attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute
Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function
onkeyup; onload; onloadeddata; onloadedmetadata; onloadstart; onmousedown; onmousemove; onmouseout; onmouseover; onmouseup; onmousewheel; onpause; onplay; onplaying; onprogress; onratechange; onreadystatechange; onreset; onscroll; onseeked; onseeking; onselect; onshow; onstalled; onsubmit; onsuspend; ontimeupdate; onvolumechange; onwaiting;
}; Document implements HTMLDocument; Since the HTMLDocument p77 interface holds methods and attributes related to a number of disparate features, the members of this interface are described in various different sections.
3.1.2 Security
User agents must raise a SECURITY_ERR p75 exception whenever any of the members of an HTMLDocument p77 object are accessed by scripts whose effective script origin p510 is not the same p512 as the Document p33 's effective script origin p510 .
The URL attribute must return the document's address p77 . The referrer attribute must return either the current address p77 of the active document p499 of the source browsing context p520 at the time the navigation was started (that is, the page which navigated p520 the browsing context p499 to the current document), with any <fragment> p55 component removed; or the empty string if there is no such originating page, or if the UA has been configured not to report referrers in this case, or if the navigation was initiated for a hyperlink p440 with a noreferrer p447 keyword. Note: In the case of HTTP, the referrer p79 IDL attribute will match the Referer (sic) header that was sent when fetching p59 the current page.
79
Note: Typically user agents are configured to not report referrers in the case where the referrer uses an encrypted protocol and the current page does not (e.g. when navigating from an https: page to an http: page).
This box is non-normative. Implementation requirements are given below this box. document . cookie
p80
[ = value ]
Returns the HTTP cookies that apply to the Document p33 . If there are no cookies or cookies can't be applied to this resource, the empty string will be returned. Can be set, to add a new cookie to the element's set of HTTP cookies. If the contents are sandboxed into a unique origin p217 (in an iframe p213 with the sandbox p216 attribute) or the resource was labeled as text/html-sandboxed p758 , a SECURITY_ERR p75 exception will be thrown on getting and setting.
The cookie attribute represents the cookies of the resource from which the Document p33 was created. A Document p33 object that falls into one of the following conditions is a cookie-free Document object: A Document p33 that has no browsing context p499 . A Document p33 whose address p77 does not use a server-based naming authority.
On getting, if the document is a cookie-free Document object p80 , then the user agent must return the empty string. Otherwise, if the Document p33 's origin p510 is not a scheme/host/port tuple, the user agent must raise a SECURITY_ERR p75 exception. Otherwise, the user agent must first obtain the storage mutex p554 and then return the cookie-string for the document's address p77 for a "non-HTTP" API, decoded as UTF-8, with error handling p36 . [COOKIES] p781 On setting, if the document is a cookie-free Document object p80 , then the user agent must do nothing. Otherwise, if the Document p33 's origin p510 is not a scheme/host/port tuple, the user agent must raise a SECURITY_ERR p75 exception. Otherwise, the user agent must obtain the storage mutex p554 and then act as it would when receiving a set-cookie-string for the document's address p77 via a "non-HTTP" API, consisting of the new value encoded as UTF-8. [COOKIES] p781 [RFC3629] p784 Note: Since the cookie p80 attribute is accessible across frames, the path restrictions on cookies are only a tool to help manage which cookies are sent to which parts of the site, and are not in any way a security feature.
This box is non-normative. Implementation requirements are given below this box. document . lastModified p80 Returns the date of the last modification to the document, as reported by the server, in the form "MM/ DD/YYYY hh:mm:ss", in the user's local time zone. If the last modification date is not known, the current time is returned instead.
The lastModified attribute, on getting, must return the date and time of the Document p33 's source file's last modification, in the user's local time zone, in the following format: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. The month component of the date. A U+002F SOLIDUS character (/). The day component of the date. A U+002F SOLIDUS character (/). The year component of the date. A U+0020 SPACE character. The hours component of the time. A U+003A COLON character (:). The minutes component of the time. A U+003A COLON character (:).
80
11.
All the numeric components above, other than the year, must be given as two digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) representing the number in base ten, zero-padded if necessary. The year must be given as the shortest possible string of four or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) representing the number in base ten, zero-padded if necessary. The Document p33 's source file's last modification date and time must be derived from relevant features of the networking protocols used, e.g. from the value of the HTTP Last-Modified header of the document, or from metadata in the file system for local files. If the last modification date and time are not known, the attribute must return the current date and time in the above format. This box is non-normative. Implementation requirements are given below this box. document . compatMode p81 In a conforming document, returns the string "CSS1Compat". (In quirks mode p81 documents, returns the string "BackCompat", but a conforming document can never trigger quirks mode p81 .)
A Document p33 is always set to one of three modes: no-quirks mode, the default; quirks mode, used typically for legacy documents; and limited-quirks mode, also known as "almost standards" mode. The mode is only ever changed from the default by the HTML parser p620 , based on the presence, absence, or value of the DOCTYPE string. The compatMode IDL attribute must return the literal string "CSS1Compat" unless the document has been set to quirks mode p81 by the HTML parser p620 , in which case it must instead return the literal string "BackCompat". This box is non-normative. Implementation requirements are given below this box. document . charset
p81
[ = value ]
Returns the document's character encoding p81 . Can be set, to dynamically change the document's character encoding p81 . New values that are not IANA-registered aliases supported by the user agent are ignored. document . characterSet p81 Returns the document's character encoding p81 . document . defaultCharset p81 Returns what might be the user agent's default character encoding. (The user agent might return another character encoding altogether, e.g. to protect the user's privacy, or if the user agent doesn't use a single default encoding.)
Documents have an associated character encoding. When a Document p33 object is created, the document's character encoding p81 must be initialized to UTF-16. Various algorithms during page loading affect this value, as does the charset p81 setter. [IANACHARSET] p782 The charset IDL attribute must, on getting, return the preferred MIME name p30 of the document's character encoding p81 . On setting, if the new value is an IANA-registered alias for a character encoding supported by the user agent, the document's character encoding p81 must be set to that character encoding. (Otherwise, nothing happens.) The characterSet IDL attribute must, on getting, return the preferred MIME name p30 of the document's character encoding p81 . The defaultCharset IDL attribute must, on getting, return the preferred MIME name p30 of a character encoding, possibly the user's default encoding, or an encoding associated with the user's current geographical location, or any arbitrary encoding name. This box is non-normative. Implementation requirements are given below this box. document . readyState p82 Returns "loading" while the Document p33 is loading, "interactive" once it is finished parsing but still loading sub-resources, and "complete" once it has loaded. The readystatechange p82 event fires on the Document p33 object when this value changes.
81
Each document has a current document readiness. When a Document p33 object is created, it must have its current document readiness p82 set to the string "loading" if the document is associated with an HTML parser p620 or an XML parser p705 , or to the string "complete" otherwise. Various algorithms during page loading affect this value. When the value is set, the user agent must fire a simple event p559 named readystatechange at the Document p33 object. A Document p33 is said to have an active parser if it is associated with an HTML parser p620 or an XML parser p705 that has not yet been stopped p687 or aborted p687 . The readyState IDL attribute must, on getting, return the current document readiness p82 .
The head element of a document is the first head p116 element that is a child of the html element p82 , if there is one, or null otherwise. The head attribute, on getting, must return the head element p82 of the document (a head p116 element or null). This box is non-normative. Implementation requirements are given below this box. document . title
p82
[ = value ]
Returns the document's title, as given by the title element p82 . Can be set, to update the document's title. If there is no head element p82 , the new value is ignored. In SVG documents, the SVGDocument interface's title attribute takes precedence.
The title element of a document is the first title p117 element in the document (in tree order), if there is one, or null otherwise. The title attribute must, on getting, run the following algorithm: 1. If the root element p29 is an svg p320 element in the "http://www.w3.org/2000/svg" namespace, and the user agent supports SVG, then return the value that would have been returned by the IDL attribute of the same name on the SVGDocument interface. [SVG] p785 Otherwise, let value be a concatenation of the data of all the child text nodes p29 of the title element p82 , in tree order p29 , or the empty string if the title element p82 is null. Replace any sequence of one or more consecutive space characters p37 in value with a single U+0020 SPACE character. Remove any leading or trailing space characters p37 in value. Return value.
2.
3.
4. 5.
On setting, the following algorithm must be run. Mutation events must be fired as appropriate. 1. If the root element p29 is an svg p320 element in the "http://www.w3.org/2000/svg" namespace, and the user agent supports SVG, then the setter must defer to the setter for the IDL attribute of the same name on the SVGDocument interface (if it is readonly, then this will raise an exception). Stop the algorithm here. [SVG] p785 If the title element p82 is null and the head element p82 is null, then the attribute must do nothing. Stop the algorithm here. If the title element p82 is null, then a new title p117 element must be created and appended to the head element p82 . Let element be that element. Otherwise, let element be the title element p82 . The children of element (if any) must all be removed. A single Text p33 node whose data is the new value being assigned must be appended to element.
2.
3.
4. 5.
82
The title p82 attribute on the HTMLDocument p77 interface should shadow the attribute of the same name on the SVGDocument interface when the user agent supports both HTML and SVG. [SVG] p785 This box is non-normative. Implementation requirements are given below this box. document . body p83 [ = value ] Returns the body element p83 . Can be set, to replace the body element p83 . If the new value is not a body p142 or frameset p747 element, this will throw a HIERARCHY_REQUEST_ERR p75 exception.
The body element of a document is the first child of the html element p82 that is either a body p142 element or a frameset p747 element. If there is no such element, it is null. If the body element is null, then when the specification requires that events be fired at "the body element", they must instead be fired at the Document p33 object. The body attribute, on getting, must return the body element p83 of the document (either a body p142 element, a frameset p747 element, or null). On setting, the following algorithm must be run: 1. If the new value is not a body p142 or frameset p747 element, then raise a HIERARCHY_REQUEST_ERR p75 exception and abort these steps. Otherwise, if the new value is the same as the body element p83 , do nothing. Abort these steps. Otherwise, if the body element p83 is not null, then replace that element with the new value in the DOM, as if the root element's replaceChild() method had been called with the new value and the incumbent body element p83 as its two arguments respectively, then abort these steps. Otherwise, the body element p83 is null. Append the new value to the root element. This box is non-normative. Implementation requirements are given below this box. document . images
p83
2. 3.
4.
Returns an HTMLCollection p64 of the img p199 elements in the Document p33 . document . embeds p83 document . plugins p83 Return an HTMLCollection p64 of the embed p220 elements in the Document p33 . document . links p83 Returns an HTMLCollection p64 of the a p173 and area p314 elements in the Document p33 that have href p440 attributes. document . forms p83 Return an HTMLCollection p64 of the form p347 elements in the Document p33 . document . scripts p83 Return an HTMLCollection p64 of the script p133 elements in the Document p33 .
The images attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only img p199 elements. The embeds attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only embed p220 elements. The plugins attribute must return the same object as that returned by the embeds p83 attribute. The links attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only a p173 elements with href p440 attributes and area p314 elements with href p440 attributes. The forms attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only form p347 elements. The scripts attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only script p133 elements.
83
This box is non-normative. Implementation requirements are given below this box. collection = document . getElementsByName p84 (name) Returns a NodeList p33 of elements in the Document p33 that have a name attribute with the value name. collection = document . getElementsByClassName(classes) p84 collection = element . getElementsByClassName(classes) p84 Returns a NodeList p33 of the elements in the object on which the method was invoked (a Document p33 or an Element p33 ) that have all the classes given by classes. The classes argument is interpreted as a space-separated list of classes.
The getElementsByName(name) method takes a string name, and must return a live p29 NodeList p33 containing all the HTML elements p28 in that document that have a name attribute whose value is equal to the name argument (in a case-sensitive p36 manner), in tree order p29 . When the method is invoked on a Document p33 object again with the same argument, the user agent may return the same as the object returned by the earlier call. In other cases, a new NodeList p33 object must be returned. The getElementsByClassName(classNames) method takes a string that contains a set of space-separated tokens p53 representing classes. When called, the method must return a live p29 NodeList p33 object containing all the elements in the document, in tree order p29 , that have all the classes specified in that argument, having obtained the classes by splitting a string on spaces p53 . (Duplicates are ignored.) If there are no tokens specified in the argument, then the method must return an empty NodeList p33 . If the document is in quirks mode p81 , then the comparisons for the classes must be done in an ASCII case-insensitive p36 manner, otherwise, the comparisons must be done in a case-sensitive p36 manner. When the method is invoked on a Document p33 object again with the same argument, the user agent may return the same object as the object returned by the earlier call. In other cases, a new NodeList p33 object must be returned. The getElementsByClassName(classNames) method on the HTMLElement p88 interface must return a live p29 NodeList p33 with the nodes that the HTMLDocument p77 getElementsByClassName() p84 method would return when passed the same argument(s), excluding any elements that are not descendants of the HTMLElement p88 object on which the method was invoked. When the method is invoked on an HTMLElement p88 object again with the same argument, the user agent may return the same object as the object returned by the earlier call. In other cases, a new NodeList p33 object must be returned. HTML, SVG, and MathML elements define which classes they are in by having an attribute with no namespace with the name class containing a space-separated list of classes to which the element belongs. Other specifications may also allow elements in their namespaces to be labeled as being in specific classes. Given the following XHTML fragment: <div id="example"> <p id="p1" class="aaa bbb"/> <p id="p2" class="aaa ccc"/> <p id="p3" class="bbb ccc"/> </div> A call to document.getElementById('example').getElementsByClassName('aaa') would return a NodeList p33 with the two paragraphs p1 and p2 in it. A call to getElementsByClassName('ccc bbb') would only return one node, however, namely p3. A call to document.getElementById('example').getElementsByClassName('bbb ccc ') would return the same thing. A call to getElementsByClassName('aaa,bbb') would return no nodes; none of the elements above are in the "aaa,bbb" class. This box is non-normative. Implementation requirements are given below this box. element . cssElementMap p84 Returns a DOMElementMap p74 object for the Document p33 representing the current CSS element reference identifiers.
The cssElementMap IDL attribute allows authors to define CSS element reference identifiers, which are used in certain CSS features to override the normal ID p92 -based mapping. [CSSIMAGES] p782 When a Document p33 is created, it must be associated with an initially-empty CSS ID overrides list, which consists of a list of mappings each of which consists of a string name mapped to an Element p33 node.
84
Each entry in the CSS ID overrides list p84 , while it is in the list, defines a CSS element reference identifier mapping the given name to the given Element p33 . [CSSIMAGES] p782 On getting, the cssElementMap p84 IDL attribute must return a DOMElementMap p74 object, associated with the following algorithms, which expose the current mappings: The algorithm for getting the list of name-element mappings Return the Document p33 's CSS ID overrides list p84 , maintaining the order in which the entries were originally added to the list. The algorithm for for mapping a name to a certain element Let name be the name passed to the algorithm and element be the Element p33 passed to the algorithm. If element is null, run the algorithm for deleting mappings by name, passing it name. Otherwise, if there is an entry in the Document p33 's CSS ID overrides list p84 whose name is name, replace its current value with element. Otherwise, add a mapping to the Document p33 's CSS ID overrides list p84 whose name is name and whose element is element. The algorithm for deleting mappings by name If there is an entry in the Document p33 's CSS ID overrides list p84 whose name is the name passed to this algorithm, remove it. This also undefines the CSS element reference identifier for that name. [CSSIMAGES] p782 The same object must be returned each time. The HTMLDocument p77 interface supports named properties. The supported property names p34 at any moment consist of the values of the name content attributes of all the applet p744 , embed p220 , form p347 , iframe p213 , img p199 , and fallback-free p85 object p222 elements in the Document p33 that have name content attributes, and the values of the id p92 content attributes of all the applet p744 and fallback-free p85 object p222 elements in the Document p33 that have id p92 content attributes, and the values of the id p92 content attributes of all the img p199 elements in the Document p33 that have both name content attributes and id p92 content attributes. When the HTMLDocument object is indexed for property retrieval using a name name, then the user agent must return the value obtained using the following steps: 1. Let elements be the list of named elements p85 with the name name in the Document p33 . Note: There will be at least one such element, by definition. 2. If elements has only one element, and that element is an iframe p213 element, then return the WindowProxy p510 object of the nested browsing context p499 represented by that iframe p213 element, and abort these steps. Otherwise, if elements has only one element, return that element and abort these steps. Otherwise return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only named elements p85 with the name name.
3. 4.
Named elements with the name name, for the purposes of the above algorithm, are those that are either: applet p744 , embed p220 , form p347 , iframe p213 , img p199 , or fallback-free p85 object p222 elements that have a name content attribute whose value is name, or applet p744 or fallback-free p85 object p222 elements that have an id p92 content attribute whose value is name, or img p199 elements that have an id p92 content attribute whose value is name, and that have a name content attribute present also.
An object p222 element is said to be fallback-free if it has no object p222 or embed p220 descendants.
Note: The dir p94 attribute on the HTMLDocument p77 interface is defined along with the dir p93 content attribute.
85
The createHTMLDocument(title) method, when invoked, must run the following steps: 1. 2. 3. Let doc be a newly created Document p33 object. Mark doc as being an HTML document p77 . Create a DocumentType p33 node with the name attribute set to the string "html", and the other attributes specific to DocumentType p33 objects set to the empty string, null, and empty lists, as appropriate. Append the newly created node to doc. Create an html p116 element, and append it to doc. Create a head p116 element, and append it to the html p116 element created in the previous step. Create a title p117 element, and append it to the head p116 element created in the previous step. Create a Text p33 node, and set its data attribute to the string given by the method's argument (which could be the empty string). Append it to the title p117 element created in the previous step. Create a body p142 element, and append it to the html p116 element created in the earlier step. Return doc.
4. 5. 6. 7.
8. 9.
3.
4. 5. 6.
86
7. 8. 9.
Let result be an Document p33 object. Let success be false. Fetch p59 url from the origin p510 of document, with the synchronous flag set and the force same-origin flag set. If the fetch attempt was successful, and the resource's Content-Type metadata p61 is an XML MIME type p29 , then run these substeps: 1. 2. 3. Create a new XML parser p705 associated with the result document. Pass this parser the fetched document. If there is an XML well-formedness or XML namespace well-formedness error, then remove all child nodes from result. Otherwise let success be true.
10.
11.
Queue a task p553 to run the following steps. 1. 2. Set the current document readiness p82 of document to "complete". Replace all the children of document by the children of result (even if it has no children), firing mutation events as if a DocumentFragment p33 containing the new children had been inserted. Fire a simple event p559 named load at document.
3.
3.2 Elements
3.2.1 Semantics
Elements, attributes, and attribute values in HTML are defined (by this specification) to have certain meanings (semantics). For example, the ol p164 element represents an ordered list, and the lang p92 attribute represents the language of the content. Authors must not use elements, attributes, or attribute values for purposes other than their appropriate intended semantic purpose. Authors must not use elements, attributes, or attribute values that are not permitted by this specification or other applicable specifications p36 . For example, the following document is non-conforming, despite being syntactically correct: <!DOCTYPE HTML> <html lang="en-GB"> <head> <title> Demonstration </title> </head> <body> <table> <tr> <td> My favourite animal is the cat. </td> </tr> <tr> <td> <a href="http://example.org/~ernest/"><cite>Ernest</cite></a>, in an essay from 1992 </td> </tr> </table> </body> </html> ...because the data placed in the cells is clearly not tabular data (and the cite p178 element mis-used). A corrected version of this document might be: <!DOCTYPE HTML> <html lang="en-GB"> <head> <title> Demonstration </title> </head> <body> <blockquote> <p> My favourite animal is the cat. </p> </blockquote> <p> <a href="http://example.org/~ernest/">Ernest</a>, in an essay from 1992 </p> </body> </html>
87
This next document fragment, intended to represent the heading of a corporate site, is similarly nonconforming because the second line is not intended to be a heading of a subsection, but merely a subheading or subtitle (a subordinate heading for the same section). <body> <h1>ABC Company</h1> <h2>Leading the way in widget design since 1432</h2> ... The hgroup p151 element is intended for these kinds of situations: <body> <hgroup> <h1>ABC Company</h1> <h2>Leading the way in widget design since 1432</h2> </hgroup> ... In the next example, there is a non-conforming attribute value ("carpet") and a non-conforming attribute ("texture"), which is not permitted by this specification: <label>Carpet: <input type="carpet" name="c" texture="deep pile"></label> Here would be an alternative and correct way to mark this up: <label>Carpet: <input type="text" class="carpet" name="c" data-texture="deep pile"></label> Through scripting and using other mechanisms, the values of attributes, text, and indeed the entire structure of the document may change dynamically while a user agent is processing it. The semantics of a document at an instant in time are those represented by the state of the document at that instant in time, and the semantics of a document can therefore change over time. User agents must update their presentation of the document as this occurs. HTML has a progress p402 element that describes a progress bar. If its "value" attribute is dynamically updated by a script, the UA would update the rendering to show the progress changing.
88
attribute DOMString itemId; [PutForwards=value] readonly attribute DOMSettableTokenList itemRef; [PutForwards=value] readonly attribute DOMSettableTokenList itemProp; readonly attribute HTMLPropertiesCollection properties; attribute any itemValue; // user interaction attribute boolean hidden; void click(); attribute long tabIndex; void focus(); void blur(); attribute DOMString accessKey; readonly attribute DOMString accessKeyLabel; attribute boolean draggable; [PutForwards=value] attribute DOMSettableTokenList dropzone; attribute DOMString contentEditable; readonly attribute boolean isContentEditable; attribute HTMLMenuElement contextMenu; attribute boolean spellcheck; // command API readonly attribute readonly attribute readonly attribute readonly attribute readonly attribute
DOMString commandType; DOMString label; DOMString icon; boolean disabled; boolean checked;
// styling readonly attribute CSSStyleDeclaration style; // event handler IDL attributes attribute Function onabort; attribute Function onblur; attribute Function oncanplay; attribute Function oncanplaythrough; attribute Function onchange; attribute Function onclick; attribute Function oncontextmenu; attribute Function oncuechange; attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function ondblclick; ondrag; ondragend; ondragenter; ondragleave; ondragover; ondragstart; ondrop; ondurationchange; onemptied; onended; onerror; onfocus; onformchange; onforminput; oninput; oninvalid; onkeydown; onkeypress; onkeyup; onload; onloadeddata; onloadedmetadata; onloadstart; onmousedown;
89
attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute };
Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function
onmousemove; onmouseout; onmouseover; onmouseup; onmousewheel; onpause; onplay; onplaying; onprogress; onratechange; onreadystatechange; onreset; onscroll; onseeked; onseeking; onselect; onshow; onstalled; onsubmit; onsuspend; ontimeupdate; onvolumechange; onwaiting;
interface HTMLUnknownElement : HTMLElement { }; The HTMLElement p88 interface holds methods and attributes related to a number of disparate features, and the members of this interface are therefore described in various different sections of this specification. The HTMLUnknownElement p90 interface must be used for HTML elements p28 that are not defined by this specification (or other applicable specifications p36 ).
The following event handler content attributes p556 may be specified on any HTML element p28 : onabort p557 onblur p558 * oncanplay p557 oncanplaythrough p557 onchange p557 onclick p557 oncontextmenu p557 oncuechange p557 ondblclick p558 ondrag p558 ondragend p558
90
ondragenter p558 ondragleave p558 ondragover p558 ondragstart p558 ondrop p558 ondurationchange p558 onemptied p558 onended p558 onerror p558 * onfocus p558 * onformchange p558 onforminput p558 oninput p558 oninvalid p558 onkeydown p558 onkeypress p558 onkeyup p558 onload p558 * onloadeddata p558 onloadedmetadata p558 onloadstart p558 onmousedown p558 onmousemove p558 onmouseout p558 onmouseover p558 onmouseup p558 onmousewheel p558 onpause p558 onplay p558 onplaying p558 onprogress p558 onratechange p558 onreadystatechange p558 onreset p558 onscroll p558 * onseeked p558 onseeking p558 onselect p558 onshow p558 onstalled p558 onsubmit p558 onsuspend p558 ontimeupdate p558 onvolumechange p558 onwaiting p558
Note: The attributes marked with an asterisk have a different meaning when specified on body p142 elements as those elements expose event handlers p555 of the Window p503 object with the same names. Note: While these attributes apply to all elements, they are not useful on all elements. For example, only media elements p235 will ever receive a volumechange p285 event fired by the user agent.
Custom data attributes p96 (e.g. data-foldername or data-msgid) can be specified on any HTML element p28 , to store custom data specific to the page. In HTML documents p77 , elements in the HTML namespace p75 may have an xmlns attribute specified, if, and only if, it has the exact value "http://www.w3.org/1999/xhtml". This does not apply to XML documents p77 . Note: In HTML, the xmlns attribute has absolutely no effect. It is basically a talisman. It is allowed merely to make migration to and from XHTML mildly easier. When parsed by an HTML parser p620 , the attribute ends up in no namespace, not the "http://www.w3.org/2000/xmlns/" namespace like namespace declaration attributes in XML do. Note: In XML, an xmlns attribute is part of the namespace declaration mechanism, and an element cannot actually have an xmlns attribute in no namespace specified.
The XML specification also allows the use of the xml:space attribute in the XML namespace p75 on any element in an XML document p77 . This attribute has no effect on HTML elements p28 , as the default behavior in HTML is to preserve whitespace. [XML] p786
91
Note: There is no way to serialize the xml:space attribute on HTML elements p28 in the text/ html p757 syntax.
To enable assistive technology products to expose a more fine-grained interface than is otherwise possible with HTML elements and attributes, a set of annotations for assistive technology products p104 can be specified (the ARIA role and aria-* attributes).
3.2.3.1 The id attribute The id p92 attribute specifies its element's unique identifier (ID). The value must be unique amongst all the IDs in the element's home subtree p29 and must contain at least one character. The value must not contain any space characters p37 . Note: An element's unique identifier p92 can be used for a variety of purposes, most notably as a way to link to specific parts of a document using fragment identifiers, as a way to target an element when scripting, and as a way to style a specific element from CSS. If the value is not the empty string, user agents must associate the element with the given value (exactly, including any space characters) for the purposes of ID p92 matching within the element's home subtree p29 (e.g. for selectors in CSS or for the getElementById() p33 method in the DOM). Identifiers are opaque strings. Particular meanings should not be derived from the value of the id p92 attribute. This specification doesn't preclude an element having multiple IDs, if other mechanisms (e.g. DOM Core methods) can set an element's ID p92 in a way that doesn't conflict with the id p92 attribute. The id IDL attribute must reflect p62 the id p92 content attribute.
3.2.3.2 The title attribute The title p92 attribute represents p708 advisory information for the element, such as would be appropriate for a tooltip. On a link, this could be the title or a description of the target resource; on an image, it could be the image credit or a description of the image; on a paragraph, it could be a footnote or commentary on the text; on a citation, it could be further information about the source; and so forth. The value is text. If this attribute is omitted from an element, then it implies that the title p92 attribute of the nearest ancestor HTML element p28 with a title p92 attribute set is also relevant to this element. Setting the attribute overrides this, explicitly stating that the advisory information of any ancestors is not relevant to this element. Setting the attribute to the empty string indicates that the element has no advisory information. If the title p92 attribute's value contains U+000A LINE FEED (LF) characters, the content is split into multiple lines. Each U+000A LINE FEED (LF) character represents a line break. Caution is advised with respect to the use of newlines in title p92 attributes. For instance, the following snippet actually defines an abbreviation's expansion with a line break in it: <p>My logs show that there was some interest in <abbr title="Hypertext Transport Protocol">HTTP</abbr> today.</p> Some elements, such as link p119 , abbr p180 , and input p353 , define additional semantics for the title p92 attribute beyond the semantics described above. The title IDL attribute must reflect p62 the title p92 content attribute.
3.2.3.3 The lang p92 and xml:lang p92 attributes The lang attribute (in no namespace) specifies the primary language for the element's contents and for any of the element's attributes that contain text. Its value must be a valid BCP 47 language tag, or the empty string. Setting the attribute to the empty string indicates that the primary language is unknown. [BCP47] p781 The lang attribute in the XML namespace p75 is defined in XML. [XML] p786 If these attributes are omitted from an element, then the language of this element is the same as the language of its parent element, if any. The lang p92 attribute in no namespace may be used on any HTML element p28 .
92
The lang attribute in the XML namespace p92 may be used on HTML elements p28 in XML documents p77 , as well as elements in other namespaces if the relevant specifications allow it (in particular, MathML and SVG allow lang attributes in the XML namespace p92 to be specified on their elements). If both the lang p92 attribute in no namespace and the lang attribute in the XML namespace p92 are specified on the same element, they must have exactly the same value when compared in an ASCII case-insensitive p36 manner. Authors must not use the lang attribute in the XML namespace p92 on HTML elements p28 in HTML documents p77 . To ease migration to and from XHTML, authors may specify an attribute in no namespace with no prefix and with the literal localname "xml:lang" on HTML elements p28 in HTML documents p77 , but such attributes must only be specified if a lang p92 attribute in no namespace is also specified, and both attributes must have the same value when compared in an ASCII case-insensitive p36 manner. Note: The attribute in no namespace with no prefix and with the literal localname "xml:lang" has no effect on language processing.
To determine the language of a node, user agents must look at the nearest ancestor element (including the element itself if the node is an element) that has a lang attribute in the XML namespace p92 set or is an HTML element p28 and has a lang p92 in no namespace attribute set. That attribute specifies the language of the node (regardless of its value). If both the lang p92 attribute in no namespace and the lang attribute in the XML namespace p92 are set on an element, user agents must use the lang attribute in the XML namespace p92 , and the lang p92 attribute in no namespace must be ignored p29 for the purposes of determining the element's language. If none of the node's ancestors, including the root element p29 , have either attribute set, but there is a pragma-set default language p126 set, then that is the language of the node. If there is no pragma-set default language p126 set, then language information from a higher-level protocol (such as HTTP), if any, must be used as the final fallback language instead. In the absence of any such language information, and in cases where the higher-level protocol reports multiple languages, the language of the node is unknown, and the corresponding language tag is the empty string. If the resulting value is not a recognized language tag, then it must be treated as an unknown language having the given language tag, distinct from all other languages. For the purposes of round-tripping or communicating with other services that expect language tags, user agents should pass unknown language tags through unmodified. Thus, for instance, an element with lang="xyzzy" would be matched by the selector :lang(xyzzy) (e.g. in CSS), but it would not be matched by :lang(abcde), even though both are equally invalid. Similarly, if a Web browser and screen reader working in unison communicated about the language of the element, the browser would tell the screen reader that the language was "xyzzy", even if it knew it was invalid, just in case the screen reader actually supported a language with that tag after all. If the resulting value is the empty string, then it must be interpreted as meaning that the language of the node is explicitly unknown. User agents may use the element's language to determine proper processing or rendering (e.g. in the selection of appropriate fonts or pronunciations, or for dictionary selection). The lang IDL attribute must reflect p62 the lang p92 content attribute in no namespace.
3.2.3.4 The xml:base attribute (XML only) The xml:base p93 attribute is defined in XML Base. [XMLBASE] p786 The xml:base p93 attribute may be used on elements of XML documents p77 . Authors must not use the xml:base p93 attribute in HTML documents p77 .
3.2.3.5 The dir attribute The dir p93 attribute specifies the element's text directionality. The attribute is an enumerated attribute p38 with the following keywords and states: The ltr keyword, which maps to the ltr state Indicates that the contents of the element are explicitly directionally embedded left-to-right text. The rtl keyword, which maps to the rtl state Indicates that the contents of the element are explicitly directionally embedded right-to-left text.
93
The auto keyword, which maps to the auto state Indicates that the contents of the element are explicitly embedded text, but that the direction is to be determined programmatically using the contents of the element (as described below). Note: The heuristic used by this state is very crude (it just looks at the first character with a strong directionality, in a manner analogous to the Paragraph Level determination in the bidirectional algorithm). Authors are urged to only use this value as a last resort when the direction of the text is truly unknown and no better server-side heuristic can be applied. The attribute has no invalid value default and no missing value default. The directionality of an element is either 'ltr' or 'rtl', and is determined as per the first appropriate set of steps from the following list:
p93 attribute is in the ltr p93 state If the element's dir
Find the first character in tree order p29 that matches the following criteria: The character is from a text node p29 that is a descendant of the element whose directionality p94 is being determined. The character is of bidirectional character type L, AL, or R. [BIDI] p781 The character is not in a text node that has an ancestor element that is a descendant of the element whose directionality p94 is being determined and that is either: A bdi p193 element. A script p133 element. A style p130 element. An element with a dir p93 attribute in a defined state.
If such a character is found and it is of bidirectional character type AL or R, the directionality p94 of the element is 'rtl p94 '. Otherwise, the directionality p94 of the element is 'ltr p94 '.
p29 and the dir p93 attribute is not in a defined state (i.e. it is not If the element is a root element present or has an invalid value)
The directionality p94 of the element is the same as the element's parent element's directionality p94 . The effect of this attribute is primarily on the presentation layer. For example, the rendering section in this specification defines a mapping from this attribute to the CSS 'direction' and 'unicode-bidi' properties, and CSS defines rendering in terms of those properties. This box is non-normative. Implementation requirements are given below this box. document . dir
p94
[ = value ]
Returns the html element p82 's dir p93 attribute's value, if any. Can be set, to either "ltr", "rtl", or "auto" to replace the html element p82 's dir p93 attribute's value. If there is no html element p82 , returns the empty string and ignores new values.
The dir IDL attribute on an element must reflect p62 the dir p93 content attribute of that element, limited to only known values p62 . The dir IDL attribute on HTMLDocument p77 objects must reflect p62 the dir p93 content attribute of the html element p82 , if any, limited to only known values p62 . If there is no such element, then the attribute must return the empty string and do nothing on setting.
94
Note: Authors are strongly encouraged to use the dir p93 attribute to indicate text direction rather than using CSS, since that way their documents will continue to render correctly even in the absence of CSS (e.g. as interpreted by search engines). This markup fragment is of an IM conversation. <p dir=auto class="u1"><b><bdi>Student</bdi>:</b> in Arabic?</p> <p dir=auto class="u2"><b><bdi>Teacher</bdi>:</b> <p dir=auto class="u1"><b><bdi>Student</bdi>:</b> <p dir=auto class="u2"><b><bdi>Teacher</bdi>:</b> <p dir=auto class="u2"><b><bdi>Teacher</bdi>:</b> "Please"?</p> <p dir=auto class="u1"><b><bdi>Student</bdi>:</b> How do you write "What's your name?" /< p> Thanks.</p> That's written "/<."p> Do you know how to write " ," right?</p>
Given a suitable style sheet and the default alignment styles for the p p160 element, namely to align the text to the start edge of the paragraph, the resulting rendering could be as follows:
As noted earlier, the auto p94 value is not a panacea. The final paragraph in this example is misinterpreted as being right-to-left text, since it begins with an Arabic character, which causes the "right?" to be to the left of the Arabic text.
3.2.3.6 The class attribute Every HTML element p28 may have a class p95 attribute specified. The attribute, if specified, must have a value that is a set of space-separated tokens p53 representing the various classes that the element belongs to. The classes that an HTML element p28 has assigned to it consists of all the classes returned when the value of the class p95 attribute is split on spaces p53 . (Duplicates are ignored.) Note: Assigning classes to an element affects class matching in selectors in CSS, the getElementsByClassName() p84 method in the DOM, and other such features. There are no additional restrictions on the tokens authors can use in the class p95 attribute, but authors are encouraged to use values that describe the nature of the content, rather than values that describe the desired presentation of the content. The className and classList IDL attributes must both reflect p62 the class p95 content attribute.
3.2.3.7 The style attribute All HTML elements p28 may have the style p95 content attribute set. This is a CSS styling attribute as defined by the CSS Styling Attribute Syntax specification. [CSSATTR] p781 In user agents that support CSS, the attribute's value must be parsed when the attribute is added or has its value changed, according to the rules given for CSS styling attributes. [CSSATTR] p781 Documents that use style p95 attributes on any of their elements must still be comprehensible and usable if those attributes were removed. Note: In particular, using the style p95 attribute to hide and show content, or to convey meaning that is otherwise not included in the document, is non-conforming. (To hide and show content, use the hidden p571 attribute.)
95
This box is non-normative. Implementation requirements are given below this box. element . style
p96
The style IDL attribute must return a CSSStyleDeclaration whose value represents the declarations specified in the attribute, if present. Mutating the CSSStyleDeclaration object must create a style p95 attribute on the element (if there isn't one already) and then change its value to be a value representing the serialized form of the CSSStyleDeclaration object. The same object must be returned each time. [CSSOM] p782 In the following example, the words that refer to colors are marked up using the span p194 element and the style p95 attribute to make those words show up in the relevant colors in visual media. <p>My sweat suit is <span style="color: green; background: transparent">green</span> and my eyes are <span style="color: blue; background: transparent">blue</span>.</p>
3.2.3.8 Embedding custom non-visible data with the data-* p96 attributes A custom data attribute is an attribute in no namespace whose name starts with the string "data-", has at least one character after the hyphen, is XML-compatible p29 , and contains no characters in the range U+0041 to U+005A (LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z). Note: All attributes on HTML elements p28 in HTML documents p77 get ASCII-lowercased automatically, so the restriction on ASCII uppercase letters doesn't affect such documents. Custom data attributes p96 are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements. These attributes are not intended for use by software that is independent of the site that uses the attributes. For instance, a site about music could annotate list items representing tracks in an album with custom data attributes containing the length of each track. This information could then be used by the site itself to allow the user to sort the list by track length, or to filter the list for tracks of certain lengths. <ol> <li data-length="2m11s">Beyond The Sea</li> ... </ol> It would be inappropriate, however, for the user to use generic software not associated with that music site to search for tracks of a certain length by looking at this data. This is because these attributes are intended for use by the site's own scripts, and are not a generic extension mechanism for publicly-usable metadata. Every HTML element p28 may have any number of custom data attributes p96 specified, with any value. This box is non-normative. Implementation requirements are given below this box. element . dataset
p96
Returns a DOMStringMap p73 object for the element's data-* p96 attributes. Hyphenated names become camel-cased. For example, data-foo-bar="" becomes element.dataset.fooBar.
The dataset IDL attribute provides convenient accessors for all the data-* p96 attributes on an element. On getting, the dataset p96 IDL attribute must return a DOMStringMap p73 object, associated with the following algorithms, which expose these attributes on their element: The algorithm for getting the list of name-value pairs 1. 2. Let list be an empty list of name-value pairs. For each content attribute on the element whose first five characters are the string "data-" and whose remaining characters (if any) do not include any characters in the range U+0041 to U+005A (LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z), add a name-value pair to list whose name is the attribute's name with the first five characters removed and whose value is the attribute's value.
96
3.
For each name on the list, for each U+002D HYPHEN-MINUS character (-) in the name that is followed by a character in the range U+0061 to U+007A (U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z), remove the U+002D HYPHEN-MINUS character (-) and replace the character that followed it by the same character converted to ASCII uppercase p36 . Return list.
4.
The algorithm for setting names to certain values 1. 2. 3. Let name be the name passed to the algorithm. Let value be the value passed to the algorithm. If name contains a U+002D HYPHEN-MINUS character (-) followed by a character in the range U+0061 to U+007A (U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z), throw a SYNTAX_ERR p75 exception and abort these steps. For each character in the range U+0041 to U+005A (U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z) in name, insert a U+002D HYPHEN-MINUS character (-) before the character and replace the character with the same character converted to ASCII lowercase p36 . Insert the string data- at the front of name. Set the value of the attribute with the name name, to the value value, replacing any previous value if the attribute already existed. If setAttribute() would have raised an exception when setting an attribute with the name name, then this must raise the same exception.
4.
5. 6.
The algorithm for deleting names 1. 2. Let name be the name passed to the algorithm. For each character in the range U+0041 to U+005A (U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z) in name, insert a U+002D HYPHEN-MINUS character (-) before the character and replace the character with the same character converted to ASCII lowercase p36 . Insert the string data- at the front of name. Remove the attribute with the name name, if such an attribute exists. Do nothing otherwise.
3. 4.
The same object must be returned each time. If a Web page wanted an element to represent a space ship, e.g. as part of a game, it would have to use the class p95 attribute along with data-* p96 attributes: <div class="spaceship" data-ship-id="92432" data-weapons="laser 2" data-shields="50%" data-x="30" data-y="10" data-z="90"> <button class="fire" onclick="spaceships[this.parentNode.dataset.shipId].fire()"> Fire </button> </div> Notice how the hyphenated attribute name becomes camel-cased in the API. Authors should carefully design such extensions so that when the attributes are ignored and any associated CSS dropped, the page is still usable. User agents must not derive any implementation behavior from these attributes or values. Specifications intended for user agents must not define these attributes to have any meaningful values. JavaScript libraries may use the custom data attributes p96 , as they are considered to be part of the page on which they are used. Authors of libraries that are reused by many authors are encouraged to include their name in the attribute names, to reduce the risk of clashes. Where it makes sense, library authors are also encouraged to make the exact name used in the attribute names customizable, so that libraries whose authors unknowingly picked the same name can be used on the same page, and so that multiple versions of a particular library can be used on the same page even when those versions are not mutually compatible. For example, a library called "DoQuery" could use attribute names like data-doquery-range, and a library called "jJo" could use attributes names like data-jjo-range. The jJo library could also provide an API to set which prefix to use (e.g. J.setDataPrefix('j2'), making the attributes have names like data-j2-range).
97
3.2.4.1 Attributes Except where otherwise specified, attributes on HTML elements p28 may have any string value, including the empty string. Except where explicitly stated, there is no restriction on what text can be specified in such attributes.
98
In addition, HTML elements p28 may be orphan nodes (i.e. without a parent node). For example, creating a td p332 element and storing it in a global variable in a script is conforming, even though td p332 elements are otherwise only supposed to be used inside tr p331 elements. var data = { name: "Banana", cell: document.createElement('td'), };
3.2.5.1 Kinds of content Each element in HTML falls into zero or more categories that group elements with similar characteristics together. The following broad categories are used in this specification: Metadata content p99 Flow content p100 Sectioning content p100 Heading content p100 Phrasing content p100 Embedded content p101 Interactive content p101
Note: Some elements also fall into other categories, which are defined in other parts of this specification. These categories are related as follows:
Flow
Heading
Sectioning Metadata
In addition, certain elements are categorized as form-associated elements p347 and further subcategorized to define their role in various form-related processing models. Some elements have unique requirements and do not fit into any particular category.
3.2.5.1.1 Metadata content Metadata content is content that sets up the presentation or behavior of the rest of the content, or that sets up the relationship of the document with other documents, or that conveys other "out of band" information.
base p118 , command p427 , link p119 , meta p122 , noscript p140 , script p133 , style p130 , title p117
Elements from other namespaces whose semantics are primarily metadata-related (e.g. RDF) are also metadata content p99 . Thus, in the XML serialization, one can use RDF, like this: <html xmlns="http://www.w3.org/1999/xhtml" xmlns:r="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> <head> <title>Hedral's Home Page</title> <r:RDF> <Person xmlns="http://www.w3.org/2000/10/swap/pim/contact#" r:about="http://hedral.example.com/#"> <fullName>Cat Hedral</fullName> <mailbox r:resource="mailto:[email protected]"/> <personalTitle>Sir</personalTitle> </Person> </r:RDF> </head> <body>
99
<h1>My home page</h1> <p>I like playing with string, I guess. Sister says squirrels are fun too so sometimes I follow her to play with them.</p> </body> </html> This isn't possible in the HTML serialization, however.
3.2.5.1.2 Flow content Most elements that are used in the body of documents and applications are categorized as flow content.
a p173 , abbr p180 , address p154 , area p314 (if it is a descendant of a map p313 element), article p147 ,
aside p148 , audio p231 , b p188 , bdi p193 , bdo p193 , blockquote p163 , br p194 , button p385 , canvas p286 , cite p178 , code p184 , command p427 , datalist p391 , del p197 , details p423 , dfn p180 , div p172 , dl p168 , em p175 , embed p220 , fieldset p350 , figure p170 , footer p153 , form p347 , h1 p150 , h2 p150 , h3 p150 , h4 p150 , h5 p150 , h6 p150 , header p152 , hgroup p151 , hr p161 , i p187 , iframe p213 , img p199 , input p353 , ins p196 , kbd p186 , keygen p398 , label p352 , link p119 (if the itemprop p464 attribute is present), map p313 , mark p189 , math p319 , menu p428 , meta p122 (if the itemprop p464 attribute is present), meter p403 , nav p145 , noscript p140 , object p222 , ol p164 , output p400 , p p160 , pre p162 , progress p402 , q p179 , ruby p191 , s p177 , samp p186 , script p133 , section p144 , select p387 , small p176 , span p194 , strong p176 , style p130 (if the scoped p130 attribute is present), sub p187 , sup p187 , svg p320 , table p320 , textarea p395 , time p182 , ul p166 , var p185 , video p228 , wbr p195 , text p101 As a general rule, elements whose content model allows any flow content p100 should have either at least one descendant text node p29 that is not inter-element whitespace p98 , or at least one descendant element node that is embedded content p101 . For the purposes of this requirement, del p197 elements and their descendants must not be counted as contributing to the ancestors of the del p197 element. This requirement is not a hard requirement, however, as there are many cases where an element can be empty legitimately, for example when it is used as a placeholder which will later be filled in by a script, or when the element is part of a template and would on most pages be filled in but on some pages is not relevant.
3.2.5.1.3 Sectioning content Sectioning content is content that defines the scope of headings p100 and footers p153 .
3.2.5.1.4 Heading content Heading content defines the header of a section (whether explicitly marked up using sectioning content p100 elements, or implied by the heading content itself).
a p173 (if it contains only phrasing content p100 ), abbr p180 , area p314 (if it is a descendant of a map p313
element), audio p231 , b p188 , bdi p193 , bdo p193 , br p194 , button p385 , canvas p286 , cite p178 , code p184 , command p427 , datalist p391 , del p197 (if it contains only phrasing content p100 ), dfn p180 , em p175 , embed p220 , i p187 , iframe p213 , img p199 , input p353 , ins p196 (if it contains only phrasing content p100 ), kbd p186 , keygen p398 , label p352 , link p119 (if the itemprop p464 attribute is present), map p313 (if it contains only phrasing content p100 ), mark p189 , math p319 , meta p122 (if the itemprop p464 attribute is present), meter p403 , noscript p140 , object p222 , output p400 , progress p402 , q p179 , ruby p191 , s p177 , samp p186 , script p133 , select p387 , small p176 , span p194 , strong p176 , sub p187 , sup p187 , svg p320 , textarea p395 , time p182 , var p185 , video p228 , wbr p195 , text p101 As a general rule, elements whose content model allows any phrasing content p100 should have either at least one descendant text node p29 that is not inter-element whitespace p98 , or at least one descendant element node that is
100
embedded content p101 . For the purposes of this requirement, nodes that are descendants of del p197 elements must not be counted as contributing to the ancestors of the del p197 element. Note: Most elements that are categorized as phrasing content can only contain elements that are themselves categorized as phrasing content, not any flow content. Text, in the context of content models, means text nodes p29 . Text p101 is sometimes used as a content model on its own, but is also phrasing content p100 , and can be inter-element whitespace p98 (if the text nodes p29 are empty or contain just space characters p37 ).
3.2.5.1.6 Embedded content Embedded content is content that imports another resource into the document, or content from another vocabulary that is inserted into the document.
audio p231 , canvas p286 , embed p220 , iframe p213 , img p199 , math p319 , object p222 , svg p320 , video p228
Elements that are from namespaces other than the HTML namespace p75 and that convey content but not metadata, are embedded content p101 for the purposes of the content models defined in this specification. (For example, MathML, or SVG.) Some embedded content elements can have fallback content: content that is to be used when the external resource cannot be used (e.g. because it is of an unsupported format). The element definitions state what the fallback is, if any.
3.2.5.1.7 Interactive content Interactive content is content that is specifically intended for user interaction.
a p173 , audio p231 (if the controls p281 attribute is present), button p385 , details p423 , embed p220 ,
iframe p213 , img p199 (if the usemap p317 attribute is present), input p353 (if the type p355 attribute is not in the hidden p358 state), keygen p398 , label p352 , menu p428 (if the type p429 attribute is in the toolbar p429 state), object p222 (if the usemap p317 attribute is present), select p387 , textarea p395 , video p228 (if the controls p281 attribute is present) Certain elements in HTML have an activation behavior p102 , which means that the user can activate them. This triggers a sequence of events dependent on the activation mechanism, and normally culminating in a click p33 event, as described below. The user agent should allow the user to manually trigger elements that have an activation behavior p102 , for instance using keyboard or voice input, or through mouse clicks. When the user triggers an element with a defined activation behavior p102 in a manner other than clicking it, the default action of the interaction event must be to run synthetic click activation steps p101 on the element. When a user agent is to run synthetic click activation steps on an element, the user agent must run pre-click activation steps p102 on the element, then fire a click event p559 at the element. The default action of this click p33 event must be to run post-click activation steps p102 on the element. If the event is canceled, the user agent must run canceled activation steps p102 on the element instead. When a pointing device is clicked, the user agent must run these steps: 1. Let e be the nearest activatable element p101 of the element designated by the user (defined below), if any. If there is an element e, run pre-click activation steps p102 on it. Dispatch the required click p33 event. If there is an element e, then the default action of the click p33 event must be to run post-click activation steps p102 on element e. If there is an element e but the event is canceled, the user agent must run canceled activation steps p102 on element e. Note: The above doesn't happen for arbitrary synthetic events dispatched by author script. However, the click() p571 method can be used to make it happen programmatically. Given an element target, the nearest activatable element is the element returned by the following algorithm: 1. If target has a defined activation behavior p102 , then return target and abort these steps.
2. 3.
101
2. 3.
If target has a parent element, then set target to that parent element and return to the first step. Otherwise, there is no nearest activatable element p101 .
When a user agent is to run pre-click activation steps on an element, it must run the pre-click activation steps defined for that element, if any. When a user agent is to run canceled activation steps on an element, it must run the canceled activation steps defined for that element, if any. When a user agent is to run post-click activation steps on an element, it must run the activation behavior defined for that element. Activation behaviors can refer to the click p33 event that was fired by the steps above leading up to this point.
3.2.5.2 Transparent content models Some elements are described as transparent; they have "transparent" in the description of their content model. The content model of a transparent p102 element is derived from the content model of its parent element: the elements required in the part of the content model that is "transparent" are the same elements as required in the part of the content model of the parent of the transparent element in which the transparent element finds itself. For instance, an ins p196 element inside a ruby p191 element cannot contain an rt p192 element, because the part of the ruby p191 element's content model that allows ins p196 elements is the part that allows phrasing content p100 , and the rt p192 element is not phrasing content p100 . Note: In some cases, where transparent elements are nested in each other, the process has to be applied iteratively. Consider the following markup fragment: <p><object><param><ins><map><a href="/">Apples</a></map></ins></object></p> To check whether "Apples" is allowed inside the a p173 element, the content models are examined. The a p173 element's content model is transparent, as is the map p313 element's, as is the ins p196 element's, as is the part of the object p222 element's in which the ins p196 element is found. The object p222 element is found in the p p160 element, whose content model is phrasing content p100 . Thus, "Apples" is allowed, as text is phrasing content. When a transparent element has no parent, then the part of its content model that is "transparent" must instead be treated as accepting any flow content p100 .
3.2.5.3 Paragraphs Note: The term paragraph p102 as defined in this section is distinct from (though related to) the p p160 element defined later. The paragraph p102 concept defined here is used to describe how to interpret documents. A paragraph is typically a run of phrasing content p100 that forms a block of text with one or more sentences that discuss a particular topic, as in typography, but can also be used for more general thematic grouping. For instance, an address is also a paragraph, as is a part of a form, a byline, or a stanza in a poem. In the following example, there are two paragraphs in a section. There is also a heading, which contains phrasing content that is not a paragraph. Note how the comments and inter-element whitespace p98 do not form paragraphs. <section> <h1>Example of paragraphs</h1> This is the <em>first</em> paragraph in this example. <p>This is the second.</p> <!-- This is not a paragraph. --> </section> Paragraphs in flow content p100 are defined relative to what the document looks like without the a p173 , ins p196 , del p197 , and map p313 elements complicating matters, since those elements, with their hybrid content models, can straddle paragraph boundaries, as shown in the first two examples below. Note: Generally, having elements straddle paragraph boundaries is best avoided. Maintaining such markup can be difficult.
102
The following example takes the markup from the earlier example and puts ins p196 and del p197 elements around some of the markup to show that the text was changed (though in this case, the changes admittedly don't make much sense). Notice how this example has exactly the same paragraphs as the previous one, despite the ins p196 and del p197 elements the ins p196 element straddles the heading and the first paragraph, and the del p197 element straddles the boundary between the two paragraphs. <section> <ins><h1>Example of paragraphs</h1> This is the <em>first</em> paragraph in</ins> this example<del>. <p>This is the second.</p></del> <!-- This is not a paragraph. --> </section> Let view be a view of the DOM that replaces all a p173 , ins p196 , del p197 , and map p313 elements in the document with their contents. Then, in view, for each run of sibling phrasing content p100 nodes uninterrupted by other types of content, in an element that accepts content other than phrasing content p100 as well as phrasing content p100 , let first be the first node of the run, and let last be the last node of the run. For each such run that consists of at least one node that is neither embedded content p101 nor inter-element whitespace p98 , a paragraph exists in the original DOM from immediately before first to immediately after last. (Paragraphs can thus span across a p173 , ins p196 , del p197 , and map p313 elements.) Conformance checkers may warn authors of cases where they have paragraphs that overlap each other (this can happen with object p222 , video p228 , audio p231 , and canvas p286 elements, and indirectly through elements in other namespaces that allow HTML to be further embedded therein, like svg p320 or math p319 ). A paragraph p102 is also formed explicitly by p p160 elements. Note: The p p160 element can be used to wrap individual paragraphs when there would otherwise not be any content other than phrasing content to separate the paragraphs from each other. In the following example, the link spans half of the first paragraph, all of the heading separating the two paragraphs, and half of the second paragraph. It straddles the paragraphs and the heading. <aside> Welcome! <a href="about.html"> This is home of... <h1>The Falcons!</h1> The Lockheed Martin multirole jet fighter aircraft! </a> This page discusses the F-16 Fighting Falcon's innermost secrets. </aside> Here is another way of marking this up, this time showing the paragraphs explicitly, and splitting the one link element into three: <aside> <p>Welcome! <a href="about.html">This is home of...</a></p> <h1><a href="about.html">The Falcons!</a></h1> <p><a href="about.html">The Lockheed Martin multirole jet fighter aircraft!</a> This page discusses the F-16 Fighting Falcon's innermost secrets.</p> </aside> It is possible for paragraphs to overlap when using certain elements that define fallback content. For example, in the following section: <section> <h1>My Cats</h1> You can play with my cat simulator. <object data="cats.sim"> To see the cat simulator, use one of the following links: <ul> <li><a href="cats.sim">Download simulator file</a> <li><a href="http://sims.example.com/watch?v=LYds5xY4INU">Use online simulator</a> </ul> Alternatively, upgrade to the Mellblom Browser. </object> I'm quite proud of it. </section>
103
There are five paragraphs: 1. 2. 3. 4. 5. The paragraph that says "You can play with my cat simulator. object I'm quite proud of it.", where object is the object p222 element. The paragraph that says "To see the cat simulator, use one of the following links:". The paragraph that says "Download simulator file". The paragraph that says "Use online simulator". The paragraph that says "Alternatively, upgrade to the Mellblom Browser.".
The first paragraph is overlapped by the other four. A user agent that supports the "cats.sim" resource will only show the first one, but a user agent that shows the fallback will confusingly show the first sentence of the first paragraph as if it was in the same paragraph as the second one, and will show the last paragraph as if it was at the start of the second sentence of the first paragraph. To avoid this confusion, explicit p p160 elements can be used.
Note: For convenience, where possible authors will likely prefer to use the dir p93 attribute, the bdo p193 element, and the bdi p193 element, rather than maintaining the bidirectional-algorithm formatting characters manually.
element
104
Language feature a p173 element that creates a hyperlink p440 area p314 element that creates a hyperlink p440 button p385 element datalist p391 element details p423 element h1 p150 element that does not have an hgroup p151 ancestor h2 p150 element that does not have an hgroup p151 ancestor h3 p150 element that does not have an hgroup p151 ancestor h4 p150 element that does not have an hgroup p151 ancestor h5 p150 element that does not have an hgroup p151 ancestor h6 p150 element that does not have an hgroup p151 ancestor head p116 element hgroup hr
p161 p151
Strong native semantics and implied ARIA semantics link role link role button role listbox role, with the aria-multiselectable property set to "false" aria-expanded state set to "true" if the element's open p423 attribute is present, and set to "false" otherwise heading role, with the aria-level property set to the element's outline depth p159 heading role, with the aria-level property set to the element's outline depth p159 heading role, with the aria-level property set to the element's outline depth p159 heading role, with the aria-level property set to the element's outline depth p159 heading role, with the aria-level property set to the element's outline depth p159 heading role, with the aria-level property set to the element's outline depth p159 No role heading role, with the aria-level property set to the element's outline depth p159 separator role No role presentation role button role aria-checked state set to "mixed" if the element's indeterminate p357 IDL attribute is true, or "true" if the element's checkedness p409 is true, or "false" otherwise No role No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute
element
element
html p116 element img p199 element whose alt p200 attribute's value is empty input p353 element with a type p355 attribute in the Button p375 state input p353 element with a type p355 attribute in the Checkbox p370 state input p353 element with a type p355 attribute in the Color p370 state input p353 element with a type p355 attribute in the Date p363 state
input p353 element with a type p355 No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute attribute in the Date and Time p362 state input p353 element with a type p355 attribute in the Local Date and Time p366 state No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute
input p353 element with a type p355 textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute in the E-mail p360 state with no attribute suggestions source element p377 input p353 element with a type p355 attribute in the File Upload p372 state input p353 element with a type p355 attribute in the Hidden p358 state input p353 element with a type p355 attribute in the Image Button p373 state input p353 element with a type p355 attribute in the Month p364 state input p353 element with a type p355 attribute in the Number p368 state No role No role button role No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute spinbutton role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute, the aria-valuemax property set to the element's maximum p381 , the aria-valuemin property set to the element's minimum p381 , and, if the result of applying the rules for parsing floating point number values p40 to the element's value p409 is a number, with the aria-valuenow property set to that number textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute aria-checked state set to "true" if the element's checkedness p409 is true, or "false" otherwise slider role, with the aria-valuemax property set to the element's maximum p381 , the ariavaluemin property set to the element's minimum p381 , and the aria-valuenow property set to the result of applying the rules for parsing floating point number values p40 to the element's value p409 , if that results in a number, or the default value p369 otherwise button role textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute
input p353 element with a type p355 attribute in the Password p362 state input p353 element with a type p355 attribute in the Radio Button p371 state input p353 element with a type p355 attribute in the Range p368 state
input p353 element with a type p355 attribute in the Reset Button p375 state input p353 element with a type p355 attribute in the Search p358 state with no suggestions source element p377
105
Language feature button role input p353 element with a type p355 attribute in the Submit Button p373 state
input p353 element with a type p355 textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute attribute in the Telephone p359 state with no suggestions source element p377 input p353 element with a type p355 attribute in the Text p358 state with no suggestions source element p377 input p353 element with a type p355 attribute in the Text p358 , Search p358 , Telephone p359 , URL p359 , or E-mail p360 states with a suggestions source element p377 input p353 element with a type p355 attribute in the Time p366 state input p353 element with a type p355 attribute in the URL p359 state with no suggestions source element p377 input p353 element with a type p355 attribute in the Week p365 state input p353 element that is required p379 keygen label
p398
textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute combobox role, with the aria-owns property set to the same value as the list p377 attribute, and the aria-readonly state set to "true" if the element has a readonly p378 attribute
No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute textbox role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute No role, with the aria-readonly state set to "true" if the element has a readonly p378 attribute The aria-required state set to "true" No role No role link role No role menu role toolbar role No role No role navigation role No role No role option role, with the aria-selected state set to "true" if the element's selectedness p393 is true, or "false" otherwise. No role progressbar role, with, if the progress bar is determinate, the aria-valuemax property set to the maximum value of the progress bar, the aria-valuemin property set to zero, and the ariavaluenow property set to the current value of the progress bar No role listbox role, with the aria-multiselectable property set to "true" listbox role, with the aria-multiselectable property set to "false" The aria-required state set to "true" No role No role heading role textbox role, with the aria-multiline property set to "true", and the aria-readonly state set to "true" if the element has a readonly p396 attribute The aria-required state set to "true" No role menuitemcheckbox role, with the aria-checked state set to "true" if the command's Checked State p432 facet is true, and "false" otherwise
element
p352
element
link p119 element that creates a hyperlink p440 menu p428 element with a type p429 attribute in the context menu p429 state menu p428 element with a type p429 attribute in the list p429 state menu p428 element with a type p429 attribute in the toolbar p429 state meta p122 element meter p403 element nav p145 element noscript p140 element optgroup p392 element option element that is in a list of options p388 or that represents a suggestion in a datalist p391 element param p227 element progress
p402 p393
element
script p133 element select p387 element with a multiple p388 attribute select p387 element with no multiple p388 attribute select p387 element with a required p388 attribute source p232 element style p130 element summary p426 element textarea p395 element textarea p395 element with a required p397 attribute title p117 element An element that defines a command p432 , whose Type p432 facet is "checkbox", and that is a descendant of a menu p428 element whose type p429 attribute in the list p429 state An element that defines a command p432 , whose Type p432 facet is "command", and that is a descendant of a menu p428 element whose type p429 attribute in the list p429 state
menuitem role
106
Language feature An element that defines a command p432 , whose Type p432 facet is "radio", and that is a descendant of a menu p428 element whose type p429 attribute in the list p429 state Element that is disabled p409 Element with a hidden p571 attribute Element that is a candidate for constraint validation p412 but that does not satisfy its constraints p413
Strong native semantics and implied ARIA semantics menuitemradio role, with the aria-checked state set to "true" if the command's Checked State p432 facet is true, and "false" otherwise
The aria-disabled state set to "true" The aria-hidden state set to "true" The aria-invalid state set to "true"
Some HTML elements p28 have native semantics that can be overridden. The following table lists these elements and their implicit ARIA semantics, along with the restrictions that apply to those elements. Each language feature (element or attribute) in a cell in the first column implies, unless otherwise overridden, the ARIA semantic (role, state, or property) given in the cell in the second column of the same row, but this semantic may be overridden under the conditions listed in the cell in the third column of that row. In addition, any element may be given the presentation role, regardless of the restrictions below.
Language feature address p154 element article
p147
Default implied ARIA semantic No role article role note role No role group role No role No role No role No role img role checkbox role radio role listitem role No role list role status role region role list role No role document role
Restrictions If specified, role must be contentinfo Role must be either article, document, application, or main Role must be either note, complementary, or search If specified, role must be application Role must be a role that supports aria-expanded If specified, role must be either application, document, or img If specified, role must be contentinfo If specified, role must be banner If specified, role must be either application, document, or img No restrictions Role must be either checkbox or menuitemcheckbox Role must be either radio or menuitemradio Role must be either listitem, menuitemcheckbox, menuitemradio, option, tab, or treeitem If specified, role must be either application, document, or image Role must be either directory, list, listbox, menu, menubar, tablist, toolbar, tree No restrictions Role must be either alert, alertdialog, application, contentinfo, dialog, document, log, main, marquee, region, search, or status Role must be either directory, list, listbox, menu, menubar, tablist, toolbar, tree If specified, role must be application Role must be either document or application
element
aside p148 element audio p231 element details p423 element embed p220 element footer p153 element header iframe
p152 p213
element element
img p199 element whose alt p200 attribute's value is absent input p353 element with a type p355 attribute in the Checkbox p370 state input p353 element with a type p355 attribute in the Radio Button p371 state li p166 element whose parent is an ol p164 or ul p166 element object p222 element ol p164 element output p400 element section p144 element ul p166 element video p228 element The body element p83
Conformance checkers are encouraged to phrase errors such that authors are encouraged to use more appropriate elements rather than remove accessibility annotations. For example, if an a p173 element is marked as having the button role, a conformance checker could say "Use a more appropriate element to represent a button, for example a button p385 element or an input p353 element" rather than "The button role cannot be used with a p173 elements". These features can be used to make accessibility tools render content to their users in more useful ways. For example, ASCII art, which is really an image, appears to be text, and in the absence of appropriate annotations would end up being rendered by screen readers as a very painful reading of lots of punctuation. Using the features described in this section, one can instead make the ATs skip the ASCII art and just read the caption: <figure role="img" aria-labelledby="fish-caption"> <pre> o .'`/ ' / ( O .-'` ` `'-._ .') _/ (o) '. .' / ) ))) >< < `\ |_\ _.' '. \
107
'-._ _ .-' '.) jgs `\__\ </pre> <figcaption id="fish-caption"> Joan G. Stark, "<cite>fish</cite>". October 1997. ASCII on electrons. 288. </figcaption> </figure>
108
2.
Note: This is equivalent to adding the default element namespace feature of XPath 2.0 to XPath 1.0, and using the HTML namespace as the default element namespace for HTML documents. It is motivated by the desire to have implementations be compatible with legacy HTML content while still supporting the changes that this specification introduces to HTML regarding the namespace used for HTML elements, and by the desire to use XPath 1.0 rather than XPath 2.0. Note: This change is a willful violation p18 of the XPath 1.0 specification, motivated by desire to have implementations be compatible with legacy content while still supporting the changes that this specification introduces to HTML regarding which namespace is used for HTML elements. [XPATH10] p786
XSLT 1.0 processors outputting to a DOM when the output method is "html" (either explicitly or via the defaulting rule in XSLT 1.0) are affected as follows: If the transformation program outputs an element in no namespace, the processor must, prior to constructing the corresponding DOM element node, change the namespace of the element to the HTML namespace p75 , ASCIIlowercase p36 the element's local name, and ASCII-lowercase p36 the names of any non-namespaced attributes on the element. Note: This requirement is a willful violation p18 of the XSLT 1.0 specification, required because this specification changes the namespaces and case-sensitivity rules of HTML in a manner that would otherwise be incompatible with DOM-based XSLT transformations. (Processors that serialize the output are unaffected.) [XSLT10] p786
109
This box is non-normative. Implementation requirements are given below this box. document = document . open p109 ( [ type [, replace ] ] ) Causes the Document p33 to be replaced in-place, as if it was a new Document p33 object, but reusing the previous object, which is then returned. If the type argument is omitted or has the value "text/html p757 ", then the resulting Document p33 has an HTML parser associated with it, which can be given data to parse using document.write() p112 . Otherwise, all content passed to document.write() p112 will be parsed as plain text. If the replace argument is present and has the value "replace", the existing entries in the session history for the Document p33 object are removed. The method has no effect if the Document p33 is still being parsed. Throws an INVALID_STATE_ERR p75 exception if the Document p33 is an XML document p77 . window = document . open p109 ( url, name, features [, replace ] ) Works like the window.open() p506 method.
When called with two or fewer arguments, the method must act as follows: 1. If the Document p33 object is not flagged as an HTML document p77 , throw an INVALID_STATE_ERR p75 exception and abort these steps. Let type be the value of the first argument, if there is one, or "text/html p757 " otherwise. Let replace be true if there is a second argument and it is an ASCII case-insensitive p36 match for the value "replace", and false otherwise. If the document has an active parser p82 that isn't a script-created parser p110 , and the insertion point p628 associated with that parser's input stream p621 is not undefined (that is, it does point to somewhere in the input stream), then the method does nothing. Abort these steps and return the Document p33 object on which the method was invoked. Note: This basically causes document.open() p109 to be ignored when it's called in an inline script found during the parsing of data sent over the network, while still letting it have an effect when called asynchronously or on a document that is itself being spoon-fed using these APIs. 5. 6. Release the storage mutex p553 . Prompt to unload p530 the Document p33 object. If the user refused to allow the document to be unloaded p530 , then these steps must be aborted. Unload p530 the Document p33 object, with the recycle parameter set to true. Abort p531 the Document p33 . Unregister all event listeners registered on the Document p33 node and its descendants. Remove any tasks p553 associated with the Document p33 in any task source p553 . Remove all child nodes of the document, without firing any mutation events. Replace the Document p33 's singleton objects with new instances of those objects. (This includes in particular the Window p503 , Location p518 , History p515 , ApplicationCache p546 , UndoManager p598 , and Navigator p565 , objects, the various BarProp p508 objects, the two Storage objects, the various HTMLCollection p64 objects, and objects defined by other specifications, like Selection. It also includes all the Web IDL prototypes in the JavaScript binding, including the Document p33 object's prototype.) Change the document's character encoding p81 to UTF-8. Set the Document p33 object's reload override flag p77 and set the Document p33 's reload override buffer p77 to the empty string. Change the document's address p77 to the entry script p502 's document p551 's address p77 . Create a new HTML parser p620 and associate it with the document. This is a script-created parser (meaning that it can be closed by the document.open() p109 and document.close() p111 methods, and that the tokenizer will wait for an explicit call to document.close() p111 before emitting an end-of-file token). The encoding confidence p622 is irrelevant. Set the current document readiness p82 of the document to "loading".
2. 3.
4.
13. 14.
15. 16.
17.
110
18.
If the type string contains a U+003B SEMICOLON character (;), remove the first such character and all characters from it up to the end of the string. Strip all leading and trailing space characters p37 from type. If type is not now an ASCII case-insensitive p36 match for the string "text/html p757 ", then act as if the tokenizer had emitted a start tag token with the tag name "pre" followed by a single U+000A LINE FEED (LF) character, then switch the HTML parser p620 's tokenizer to the PLAINTEXT state p634 .
19.
Remove all the entries in the browsing context p499 's session history p513 after the current entry p514 . If the current entry p514 is the last entry in the session history, then no entries are removed. Note: This doesn't necessarily have to affect p520 the user agent's user interface.
Remove any tasks p553 queued by the history traversal task source p554 . Remove any earlier entries that share the same Document p33 . If replace is false, then add a new entry, just before the last entry, and associate with the new entry the text that was parsed by the previous parser associated with the Document p33 object, as well as the state of the document at the start of these steps. (This allows the user to step backwards in the session history to see the page before it was blown away by the document.open() p109 call.) Finally, set the insertion point p628 to point at just before the end of the input stream p621 (which at this point will be empty). Return the Document p33 on which the method was invoked.
23.
24.
When called with three or more arguments, the open() p109 method on the HTMLDocument p77 object must call the open() p506 method on the Window p503 object of the HTMLDocument p77 object, with the same arguments as the original call to the open() p109 method, and return whatever that method returned. If the HTMLDocument p77 object has no Window p503 object, then the method must raise an INVALID_ACCESS_ERR p75 exception.
()
Closes the input stream that was opened by the document.open() p109 method. Throws an INVALID_STATE_ERR p75 exception if the Document p33 is an XML document p77 .
The close() method must run the following steps: 1. If the Document p33 object is not flagged as an HTML document p77 , throw an INVALID_STATE_ERR p75 exception and abort these steps. If there is no script-created parser p110 associated with the document, then abort these steps. Insert an explicit "EOF" character p628 at the end of the parser's input stream p621 . If there is a pending parsing-blocking script p136 , then abort these steps. Run the tokenizer, processing resulting tokens as they are emitted, and stopping when the tokenizer reaches the explicit "EOF" character p628 or spins the event loop p554 .
2. 3. 4. 5.
(text...)
In general, adds the given string(s) to the Document p33 's input stream. Warning! This method has very idiosyncratic behavior. In some cases, this method can affect the state of the HTML parser p620 while the parser is running, resulting in a DOM that does not correspond to the source of the document. In other cases, the call can clear the current page first, as if document.open() p109 had been called. In yet more cases, the method is simply ignored, or throws an exception. To make matters worse, the exact behavior of
111
this method can in some cases be dependent on network latency, which can lead to failures that are very hard to debug. For all these reasons, use of this method is strongly discouraged. This method throws an INVALID_STATE_ERR p75 exception when invoked on XML documents p77 .
Document p33 objects have an ignore-destructive-writes counter, which is used in conjunction with the processing of script p133 elements to prevent external scripts from being able to use document.write() p112 to blow away the document by implicitly calling document.open() p109 . Initially, the counter must be set to zero. The document.write(...) method must act as follows: 1. If the method was invoked on an XML document p77 , throw an INVALID_STATE_ERR p75 exception and abort these steps. If the insertion point p628 is undefined and the Document p33 's ignore-destructive-writes counter p112 is greater than zero, then abort these steps. If the insertion point p628 is undefined, call the open() p109 method on the document p33 object (with no arguments). If the user refused to allow the document to be unloaded p530 , then abort these steps. Otherwise, the insertion point p628 will point at just before the end of the (empty) input stream p621 . Insert the string consisting of the concatenation of all the arguments to the method into the input stream p621 just before the insertion point p628 . If the Document p33 object's reload override flag p77 is set, then append the string consisting of the concatenation of all the arguments to the method to the Document p33 's reload override buffer p77 . If there is no pending parsing-blocking script p136 , have the tokenizer process the characters that were inserted, one at a time, processing resulting tokens as they are emitted, and stopping when the tokenizer reaches the insertion point or when the processing of the tokenizer is aborted by the tree construction stage (this can happen if a script p133 end tag token is emitted by the tokenizer). Note: If the document.write() p112 method was called from script executing inline (i.e. executing because the parser parsed a set of script p133 tags), then this is a reentrant invocation of the parser p621 . 7. Finally, return from the method.
2.
3.
4.
5.
6.
(text...)
Adds the given string(s) to the Document p33 's input stream, followed by a newline character. If necessary, calls the open() p109 method implicitly first. This method throws an INVALID_STATE_ERR p75 exception when invoked on XML documents p77 .
The document.writeln(...) method, when invoked, must act as if the document.write() p112 method had been invoked with the same argument(s), plus an extra argument consisting of a string containing a single line feed character (U+000A).
112
In the case of XML documents p77 , will throw an INVALID_STATE_ERR p75 if the Document p33 cannot be serialized to XML, and a SYNTAX_ERR p75 if the given string is not well-formed. element . innerHTML p112 [ = value ] Returns a fragment of HTML or XML that represents the element's contents. Can be set, to replace the contents of the element with nodes parsed from the given string. In the case of XML documents p77 , will throw an INVALID_STATE_ERR p75 if the element cannot be serialized to XML, and a SYNTAX_ERR p75 if the given string is not well-formed.
On getting, if the node's document is an HTML document p77 , then the attribute must return the result of running the HTML fragment serialization algorithm p694 on the node; otherwise, the node's document is an XML document p77 , and the attribute must return the result of running the XML fragment serialization algorithm p706 on the node instead (this might raise an exception instead of returning a string). On setting, the following steps must be run: 1. If the node's document is an HTML document p77 : Invoke the HTML fragment parsing algorithm p696 . If the node's document is an XML document p77 : Invoke the XML fragment parsing algorithm p707 . In either case, the algorithm must be invoked with the string being assigned into the innerHTML p112 attribute as the input. If the node is an Element p33 node, then, in addition, that element must be passed as the context element. If this raises an exception, then abort these steps. Otherwise, let new children be the nodes returned. 2. If the attribute is being set on a Document p33 node, and that document has an active parser p82 , then abort that parser. Remove the child nodes of the node whose innerHTML p112 attribute is being set, firing appropriate mutation events. If the attribute is being set on a Document p33 node, let target document be that Document p33 node. Otherwise, the attribute is being set on an Element p33 node; let target document be the ownerDocument p33 of that Element p33 . Set the ownerDocument p33 of all the nodes in new children to the target document. Append all the new children nodes to the node whose innerHTML p112 attribute is being set, preserving their order, and firing mutation events as if a DocumentFragment p33 containing the new children had been inserted.
3.
4.
5. 6.
[ = value ]
Returns a fragment of HTML or XML that represents the element and its contents. Can be set, to replace the element with nodes parsed from the given string. In the case of XML documents p77 , will throw an INVALID_STATE_ERR p75 if the element cannot be serialized to XML, and a SYNTAX_ERR p75 if the given string is not well-formed. Throws a NO_MODIFICATION_ALLOWED_ERR p75 exception if the parent of the element is the Document p33 node.
On getting, if the node's document is an HTML document p77 , then the attribute must return the result of running the HTML fragment serialization algorithm p694 on a fictional node whose only child is the node on which the attribute was invoked; otherwise, the node's document is an XML document p77 , and the attribute must return the result of running the XML fragment serialization algorithm p706 on that fictional node instead (this might raise an exception instead of returning a string). On setting, the following steps must be run:
113
1. 2.
Let target be the element whose outerHTML p113 attribute is being set. If target has no parent node, then abort these steps. There would be no way to obtain a reference to the nodes created even if the remaining steps were run. If target's parent node is a Document p33 object, throw a NO_MODIFICATION_ALLOWED_ERR p75 exception and abort these steps. Let parent be target's parent node, unless that is a DocumentFragment p33 node, in which case let parent be an arbitrary body p142 element. If target's document is an HTML document p77 : Invoke the HTML fragment parsing algorithm p696 . If target's document is an XML document p77 : Invoke the XML fragment parsing algorithm p707 . In either case, the algorithm must be invoked with the string being assigned into the outerHTML p113 attribute as the input, and parent as the context element. If this raises an exception, then abort these steps. Otherwise, let new children be the nodes returned.
3.
4.
5.
6. 7.
Set the ownerDocument p33 of all the nodes in new children to target's document. Remove target from its parent node, firing mutation events as appropriate, and then insert in its place all the new children nodes, preserving their order, and again firing mutation events as if a DocumentFragment p33 containing the new children had been inserted.
The insertAdjacentHTML(position, text) method, when invoked, must run the following algorithm: 1. 2. 3. Let position and text be the method's first and second arguments, respectively. Let target be the element on which the method was invoked. Use the first matching item from this list: If position is an ASCII case-insensitive p36 match for the string "beforebegin" If position is an ASCII case-insensitive p36 match for the string "afterend" If target has no parent node, then abort these steps. If target's parent node is a Document p33 object, then throw a NO_MODIFICATION_ALLOWED_ERR p75 exception and abort these steps. Otherwise, let context be the parent node of target.
114
If position is an ASCII case-insensitive p36 match for the string "afterbegin" If position is an ASCII case-insensitive p36 match for the string "beforeend" Let context be the same as target. Otherwise Throw a SYNTAX_ERR p75 exception. 4. If target's document is an HTML document p77 : Invoke the HTML fragment parsing algorithm p696 . If target's document is an XML document p77 : Invoke the XML fragment parsing algorithm p707 . In either case, the algorithm must be invoked with text as the input, and the element selected in by the previous step as the context element. If this raises an exception, then abort these steps. Otherwise, let new children be the nodes returned. 5. 6. Set the ownerDocument p33 of all the nodes in new children to target's document. Use the first matching item from this list: If position is an ASCII case-insensitive p36 match for the string "beforebegin" Insert all the new children nodes immediately before target. If position is an ASCII case-insensitive p36 match for the string "afterbegin" Insert all the new children nodes before the first child of target, if there is one. If there is no such child, append them all to target. If position is an ASCII case-insensitive p36 match for the string "beforeend" Append all the new children nodes to target. If position is an ASCII case-insensitive p36 match for the string "afterend" Insert all the new children nodes immediately after target. The new children nodes must be inserted in a manner that preserves their order and fires mutation events as if a DocumentFragment p33 containing the new children had been inserted.
115
116
Content attributes: Global attributes p90 DOM interface: interface HTMLHeadElement : HTMLElement {}; The head p116 element represents p708 a collection of metadata for the Document p33 . The collection of metadata in a head p116 element can be large or small. Here is an example of a very short one: <!doctype html> <html> <head> <title>A document with a short head</title> </head> <body> ... Here is an example of a longer one: <!DOCTYPE HTML> <HTML> <HEAD> <META CHARSET="UTF-8"> <BASE HREF="http://www.example.com/"> <TITLE>An application with a long head</TITLE> <LINK REL="STYLESHEET" HREF="default.css"> <LINK REL="STYLESHEET ALTERNATE" HREF="big.css" TITLE="Big Text"> <SCRIPT SRC="support.js"></SCRIPT> <META NAME="APPLICATION-NAME" CONTENT="Long headed application"> </HEAD> <BODY> ... Note: The title p117 element is a required child in most situations, but when a higher-level protocol provides title information, e.g. in the Subject line of an e-mail when HTML is used as an e-mail authoring format, the title p117 element can be omitted.
117
This box is non-normative. Implementation requirements are given below this box. title . text
p118
[ = value ]
Returns the contents of the element, ignoring child nodes that aren't text nodes p29 . Can be set, to replace the element's children with the given value.
The IDL attribute text must return a concatenation of the contents of all the text nodes p29 that are direct children of the title p117 element (ignoring any other nodes such as comments or elements), in tree order. On setting, it must act the same way as the textContent p33 IDL attribute. Here are some examples of appropriate titles, contrasted with the top-level headings that might be used on those same pages. <title>Introduction to The Mating Rituals of Bees</title> ... <h1>Introduction</h1> <p>This companion guide to the highly successful <cite>Introduction to Medieval Bee-Keeping</cite> book is... The next page might be a part of the same site. Note how the title describes the subject matter unambiguously, while the first heading assumes the reader knows what the context is and therefore won't wonder if the dances are Salsa or Waltz: <title>Dances used during bee mating rituals</title> ... <h1>The Dances</h1> The string to use as the document's title is given by the document.title p82 IDL attribute. User agents should use the document's title when referring to the document in their user interface. When the contents of a title p117 element are used in this way, the directionality p94 of that title p117 element should be used to set the directionality of the document's title in the user interface.
118
Note: If there are multiple base p118 elements with href p118 attributes, all but the first are ignored. The target attribute, if specified, must contain a valid browsing context name or keyword p502 , which specifies which browsing context p499 is to be used as the default when hyperlinks p440 and forms p347 in the Document p33 cause navigation p520 . A base p118 element, if it has a target p119 attribute, must come before any elements in the tree that represent hyperlinks p440 . Note: If there are multiple base p118 elements with target p119 attributes, all but the first are ignored. The href IDL attribute, on getting, must return the page's document base URL p56 , and on setting, it must set the href p118 content attribute to the given new value. The target IDL attribute must reflect p62 the content attribute of the same name. In this example, a base p118 element is used to set the document base URL p56 : <!DOCTYPE html> <html> <head> <title>This is an example for the <base> element</title> <base href="http://www.example.com/news/index.html"> </head> <body> <p>Visit the <a href="archives.html">archives</a>.</p> </body> </html> The link in the above example would be a link to "http://www.example.com/news/archives.html".
119
}; HTMLLinkElement implements LinkStyle; The link p119 element allows authors to link their document to other resources. The destination of the link(s) is given by the href attribute, which must be present and must contain a valid nonempty URL potentially surrounded by spaces p55 . If the href p120 attribute is absent, then the element does not define a link. A link p119 element must have either a rel p120 attribute, or an itemprop p464 attribute, or both. The types of link indicated (the relationships) are given by the value of the rel attribute, which, if present, must have a value that is a set of space-separated tokens p53 . The allowed keywords and their meanings p442 are defined in a later section. If the rel p120 attribute is absent, has no keywords, or if none of the keywords used are allowed according to the definitions in this specification, then the element does not create any links. Two categories of links can be created using the link p119 element: Links to external resources p440 and hyperlinks p440 . The link types section p442 defines whether a particular link type is an external resource or a hyperlink. One link p119 element can create multiple links (of which some might be external resource links and some might be hyperlinks); exactly which and how many links are created depends on the keywords given in the rel p120 attribute. User agents must process the links on a per-link basis, not a per-element basis. Note: Each link created for a link p119 element is handled separately. For instance, if there are two link p119 elements with rel="stylesheet", they each count as a separate external resource, and each is affected by its own attributes independently. Similarly, if a single link p119 element has a rel p120 attribute with the value next stylesheet, it creates both a hyperlink p440 (for the next p449 keyword) and an external resource link p440 (for the stylesheet p447 keyword), and they are affected by other attributes (such as media p121 or title p122 ) differently. The exact behavior for links to external resources depends on the exact relationship, as defined for the relevant link type. Some of the attributes control whether or not the external resource is to be applied (as defined below). For external resources that are represented in the DOM (for example, style sheets), the DOM representation must be made available even if the resource is not applied. To obtain the resource, the user agent must run the following steps: 1. 2. 3. 4. If the href p120 attribute's value is the empty string, then abort these steps. Resolve p55 the URL p55 given by the href p120 attribute, relative to the element. If the previous step fails, then abort these steps. Fetch p59 the resulting absolute URL p56 .
User agents may opt to only try to obtain such resources when they are needed, instead of pro-actively fetching p59 all the external resources that are not applied. The semantics of the protocol used (e.g. HTTP) must be followed when fetching external resources. (For example, redirects will be followed and 404 responses will cause the external resource to not be applied.) Once the attempts to obtain the resource and its critical subresources p28 are complete, the user agent must, if the loads were successful, queue a task p553 to fire a simple event p559 named load at the link p119 element, or, if the resource or one of its critical subresources p28 failed to completely load for any reason (e.g. DNS error, HTTP 404 response, a connection being prematurely closed, unsupported Content-Type), queue a task p553 to fire a simple event p559 named error at the link p119 element. Non-network errors in processing the resource or its subresources (e.g. CSS parse errors, PNG decoding errors) are not failures for the purposes of this paragraph. The task source p553 for these tasks p553 is the DOM manipulation task source p554 . The element must delay the load event p687 of the element's document until all the attempts to obtain the resource and its critical subresources p28 are complete. (Resources that the user agent has not yet attempted to obtain, e.g. because it is waiting for the resource to be needed, do not delay the load event p687 .) Interactive user agents may provide users with a means to follow the hyperlinks p441 created using the link p119 element, somewhere within their user interface. The exact interface is not defined by this specification, but it could include the following information (obtained from the element's attributes, again as defined below), in some form or another (possibly simplified), for each hyperlink created with each link p119 element in the document: The relationship between this document and the resource (given by the rel p120 attribute)
120
The title of the resource (given by the title p122 attribute). The address of the resource (given by the href p120 attribute). The language of the resource (given by the hreflang p121 attribute). The optimum media for the resource (given by the media p121 attribute).
User agents could also include other information, such as the type of the resource (as given by the type p121 attribute). Note: Hyperlinks created with the link p119 element and its rel p120 attribute apply to the whole page. This contrasts with the rel p440 attribute of a p173 and area p314 elements, which indicates the type of a link whose context is given by the link's location within the document. The media attribute says which media the resource applies to. The value must be a valid media query p55 . If the link is a hyperlink p440 then the media p121 attribute is purely advisory, and describes for which media the document in question was designed. However, if the link is an external resource link p440 , then the media p121 attribute is prescriptive. The user agent must apply the external resource when the media p121 attribute's value matches the environment p55 and the other relevant conditions apply, and must not apply it otherwise. Note: The external resource might have further restrictions defined within that limit its applicability. For example, a CSS style sheet might have some @media blocks. This specification does not override such further restrictions or requirements. The default, if the media p121 attribute is omitted, is "all", meaning that by default links apply to all media. The hreflang attribute on the link p119 element has the same semantics as the hreflang attribute on a and area elements p440 . The type attribute gives the MIME type p28 of the linked resource. It is purely advisory. The value must be a valid MIME type p28 . For external resource links p440 , the type p121 attribute is used as a hint to user agents so that they can avoid fetching resources they do not support. If the attribute is present, then the user agent must assume that the resource is of the given type (even if that is not a valid MIME type p28 , e.g. the empty string). If the attribute is omitted, but the external resource link type has a default type defined, then the user agent must assume that the resource is of that type. If the UA does not support the given MIME type p28 for the given link relationship, then the UA should not obtain p120 the resource; if the UA does support the given MIME type p28 for the given link relationship, then the UA should obtain p120 the resource at the approprite time as specified for the external resource link p440 's particular type. If the attribute is omitted, and the external resource link type does not have a default type defined, but the user agent would obtain p120 the resource if the type was known and supported, then the user agent should obtain p120 the resource under the assumption that it will be supported. User agents must not consider the type p121 attribute authoritative upon fetching the resource, user agents must not use the type p121 attribute to determine its actual type. Only the actual type (as defined in the next paragraph) is used to determine whether to apply the resource, not the aforementioned assumed type. If the external resource link type defines rules for processing the resource's Content-Type metadata p61 , then those rules apply. Otherwise, if the resource is expected to be an image, user agents may apply the image sniffing rules p61 , with the official type being the type determined from the resource's Content-Type metadata p61 , and use the resulting sniffed type of the resource as if it was the actual type. Otherwise, if neither of these conditions apply or if the user agent opts not to apply the image sniffing rules, then the user agent must use the resource's Content-Type metadata p61 to determine the type of the resource. If there is no type metadata, but the external resource link type has a default type defined, then the user agent must assume that the resource is of that type. Note: The stylesheet p447 link type defines rules for processing the resource's Content-Type metadata p61 . Once the user agent has established the type of the resource, the user agent must apply the resource if it is of a supported type and the other relevant conditions apply, and must ignore the resource otherwise. If a document contains style sheet links labeled as follows: <link rel="stylesheet" href="A" type="text/plain"> <link rel="stylesheet" href="B" type="text/css"> <link rel="stylesheet" href="C">
121
...then a compliant UA that supported only CSS style sheets would fetch the B and C files, and skip the A file (since text/plain is not the MIME type p28 for CSS style sheets). For files B and C, it would then check the actual types returned by the server. For those that are sent as text/css, it would apply the styles, but for those labeled as text/plain, or any other type, it would not. If one of the two files was returned without a Content-Type p61 metadata, or with a syntactically incorrect type like Content-Type: "null", then the default type for stylesheet p447 links would kick in. Since that default type is text/css, the style sheet would nonetheless be applied. The title attribute gives the title of the link. With one exception, it is purely advisory. The value is text. The exception is for style sheet links, where the title p122 attribute defines alternative style sheet sets. Note: The title p122 attribute on link p119 elements differs from the global title p92 attribute of most other elements in that a link without a title does not inherit the title of the parent element: it merely has no title. The sizes p445 attribute is used with the icon p445 link type. The attribute must not be specified on link p119 elements that do not have a rel p120 attribute that specifies the icon p445 keyword. Some versions of HTTP defined a Link: header, to be processed like a series of link p119 elements. If supported, for the purposes of ordering links defined by HTTP headers must be assumed to come before any links in the document, in the order that they were given in the HTTP entity header. (URIs in these headers are to be processed and resolved according to the rules given in HTTP; the rules of this specification don't apply.) [HTTP] p782 [WEBLINK] p785 The IDL attributes href, rel, media, hreflang, and type, and sizes each must reflect p62 the respective content attributes of the same name. The IDL attribute relList must reflect p62 the rel p120 content attribute. The IDL attribute disabled only applies to style sheet links. When the link p119 element defines a style sheet link, then the disabled p122 attribute behaves as defined for the alternative style sheets DOM p132 . For all other link p119 elements it always return false and does nothing on setting. The LinkStyle interface is also implemented by this element; the styling processing model p132 defines how. [CSSOM] p782 Here, a set of link p119 elements provide some style sheets: <!-- a persistent style sheet --> <link rel="stylesheet" href="default.css"> <!-- the preferred alternate style sheet --> <link rel="stylesheet" href="green.css" title="Green styles"> <!-- some alternate style sheets <link rel="alternate stylesheet" <link rel="alternate stylesheet" <link rel="alternate stylesheet" --> href="contrast.css" title="High contrast"> href="big.css" title="Big fonts"> href="wide.css" title="Wide screen">
The following example shows how you can specify versions of the page that use alternative formats, are aimed at other languages, and that are intended for other media: <link rel=alternate href="/en/html" hreflang=en type=text/html title="English HTML"> <link rel=alternate href="/fr/html" hreflang=fr type=text/html title="French HTML"> <link rel=alternate href="/en/html/print" hreflang=en type=text/html media=print title="English HTML (for printing)"> <link rel=alternate href="/fr/html/print" hreflang=fr type=text/html media=print title="French HTML (for printing)"> <link rel=alternate href="/en/pdf" hreflang=en type=application/pdf title="English PDF"> <link rel=alternate href="/fr/pdf" hreflang=fr type=application/pdf title="French PDF">
122
Contexts in which this element can be used: If the charset p123 attribute is present, or if the element's http-equiv p125 attribute is in the Encoding declaration state p126 : in a head p116 element. If the http-equiv p125 attribute is present but not in the Encoding declaration state p126 : in a head p116 element. If the http-equiv p125 attribute is present but not in the Encoding declaration state p126 : in a noscript p140 element that is a child of a head p116 element. If the name p123 attribute is present: where metadata content p99 is expected. If the itemprop p464 attribute is present: where metadata content p99 is expected. If the itemprop p464 attribute is present: where phrasing content p100 is expected. Content model: Empty. Content attributes: Global attributes p90 name p123 http-equiv p125 content p123 charset p123 DOM interface: interface HTMLMetaElement : HTMLElement { attribute DOMString name; attribute DOMString httpEquiv; attribute DOMString content; }; The meta p122 element represents p708 various kinds of metadata that cannot be expressed using the title p117 , base p118 , link p119 , style p130 , and script p133 elements. The meta p122 element can represent document-level metadata with the name p123 attribute, pragma directives with the http-equiv p125 attribute, and the file's character encoding declaration p129 when an HTML document is serialized to string form (e.g. for transmission over the network or for disk storage) with the charset p123 attribute. Exactly one of the name p123 , http-equiv p125 , charset p123 , and itemprop p464 attributes must be specified. If either name p123 , http-equiv p125 , or itemprop p464 is specified, then the content p123 attribute must also be specified. Otherwise, it must be omitted. The charset attribute specifies the character encoding used by the document. This is a character encoding declaration p129 . If the attribute is present in an XML document p77 , its value must be an ASCII case-insensitive p36 match for the string "UTF-8" (and the document is therefore forced to use UTF-8 as its encoding). Note: The charset p123 attribute on the meta p122 element has no effect in XML documents, and is only allowed in order to facilitate migration to and from XHTML. There must not be more than one meta p122 element with a charset p123 attribute per document. The content attribute gives the value of the document metadata or pragma directive when the element is used for those purposes. The allowed values depend on the exact context, as described in subsequent sections of this specification. If a meta p122 element has a name attribute, it sets document metadata. Document metadata is expressed in terms of name/value pairs, the name p123 attribute on the meta p122 element giving the name, and the content p123 attribute on the same element giving the value. The name specifies what aspect of metadata is being set; valid names and the meaning of their values are described in the following sections. If a meta p122 element has no content p123 attribute, then the value part of the metadata name/value pair is the empty string. The name and content IDL attributes must reflect p62 the respective content attributes of the same name. The IDL attribute httpEquiv must reflect p62 the content attribute http-equiv p125 .
4.2.5.1 Standard metadata names This specification defines a few names for the name p123 attribute of the meta p122 element. Names are case-insensitive, and must be compared in an ASCII case-insensitive p36 manner.
123
application-name The value must be a short free-form string giving the name of the Web application that the page represents. If the page is not a Web application, the application-name p124 metadata name must not be used. There must not be more than one meta p122 element with its name p123 attribute set to the value applicationname p124 per document. User agents may use the application name in UI in preference to the page's title p117 , since the title might include status messages and the like relevant to the status of the page at a particular moment in time instead of just being the name of the application. author The value must be a free-form string giving the name of one of the page's authors. description The value must be a free-form string that describes the page. The value must be appropriate for use in a directory of pages, e.g. in a search engine. There must not be more than one meta p122 element with its name p123 attribute set to the value description p124 per document. generator The value must be a free-form string that identifies one of the software packages used to generate the document. This value must not be used on hand-authored pages. Here is what a tool called "Frontweaver" could include in its output, in the page's head p116 element, to identify itself as the tool used to generate the page: <meta name=generator content="Frontweaver 8.2"> keywords The value must be a set of comma-separated tokens p54 , each of which is a keyword relevant to the page. This page about typefaces on British motorways uses a meta p122 element to specify some keywords that users might use to look for the page: <!DOCTYPE HTML> <html> <head> <title>Typefaces on UK motorways</title> <meta name="keywords" content="british,type face,font,fonts,highway,highways"> </head> <body> ... Note: Many search engines do not consider such keywords, because this feature has historically been used unreliably and even misleadingly as a way to spam search engine results in a way that is not helpful for users. To obtain the list of keywords that the author has specified as applicable to the page, the user agent must run the following steps: 1. 2. Let keywords be an empty list. For each meta p122 element with a name p123 attribute and a content p123 attribute and whose name p123 attribute's value is keywords p124 , run the following substeps: 1. 2. 3. 4. Split the value of the element's content attribute on commas p54 . Add the resulting tokens, if any, to keywords.
Remove any duplicates from keywords. Return keywords. This is the list of keywords that the author has specified as applicable to the page.
User agents should not use this information when there is insufficient confidence in the reliability of the value. For instance, it would be reasonable for a content management system to use the keyword information of pages within the system to populate the index of a site-specific search engine, but a large-scale content aggregator that used this information would likely find that certain users would try to game its ranking mechanism through the use of inappropriate keywords.
4.2.5.2 Other metadata names Extensions to the predefined set of metadata names may be registered in the WHATWG Wiki MetaExtensions page. [WHATWGWIKI] p786
124
Anyone is free to edit the WHATWG Wiki MetaExtensions page at any time to add a type. These new names must be specified with the following information: Keyword The actual name being defined. The name should not be confusingly similar to any other defined name (e.g. differing only in case). Brief description A short non-normative description of what the metadata name's meaning is, including the format the value is required to be in. Specification A link to a more detailed description of the metadata name's semantics and requirements. It could be another page on the Wiki, or a link to an external page. Synonyms A list of other names that have exactly the same processing requirements. Authors should not use the names defined to be synonyms, they are only intended to allow user agents to support legacy content. Anyone may remove synonyms that are not used in practice; only names that need to be processed as synonyms for compatibility with legacy content are to be registered in this way. Status One of the following: Proposed The name has not received wide peer review and approval. Someone has proposed it and is, or soon will be, using it. Ratified The name has received wide peer review and approval. It has a specification that unambiguously defines how to handle pages that use the name, including when they use it in incorrect ways. Discontinued The metadata name has received wide peer review and it has been found wanting. Existing pages are using this metadata name, but new pages should avoid it. The "brief description" and "specification" entries will give details of what authors should use instead, if anything. If a metadata name is found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a metadata name is registered in the "proposed" state for a period of a month or more without being used or specified, then it may be removed from the registry. If a metadata name is added with the "proposed" status and found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a metadata name is added with the "proposed" status and found to be harmful, then it should be changed to "discontinued" status. Anyone can change the status at any time, but should only do so in accordance with the definitions above. Conformance checkers must use the information given on the WHATWG Wiki MetaExtensions page to establish if a value is allowed or not: values defined in this specification or marked as "proposed" or "ratified" must be accepted, whereas values marked as "discontinued" or not listed in either this specification or on the aforementioned page must be rejected as invalid. Conformance checkers may cache this information (e.g. for performance reasons or to avoid the use of unreliable network connectivity). When an author uses a new metadata name not defined by either this specification or the Wiki page, conformance checkers should offer to add the value to the Wiki, with the details described above, with the "proposed" status. Metadata names whose values are to be URLs p55 must not be proposed or accepted. Links must be represented using the link p119 element, not the meta p122 element.
4.2.5.3 Pragma directives When the http-equiv attribute is specified on a meta p122 element, the element is a pragma directive. The http-equiv p125 attribute is an enumerated attribute p38 . The following table lists the keywords defined for this attribute. The states given in the first cell of the rows with keywords give the states to which those keywords map. Some of the keywords are non-conforming, as noted in the last column.
State Content Language p126 Keyword Notes
default-style refresh
125
Notes
When a meta p122 element is inserted into the document p29 , if its http-equiv p125 attribute is present and represents one of the above states, then the user agent must run the algorithm appropriate for that state, as described in the following list: Content language state (http-equiv="content-language") This pragma sets the pragma-set default language. Until the pragma is successfully processed, there is no pragma-set default language p126 . Note: Conformance checkers will include a warning if this pragma is used. Authors are encouraged to use the lang p92 attribute instead. 1. If another meta p122 element with an http-equiv p125 attribute in the Content Language state p126 has already been successfully processed (i.e. when it was inserted the user agent processed it and reached the last step of this list of steps), then abort these steps. If the meta p122 element has no content p123 attribute, or if that attribute's value is the empty string, then abort these steps. If the element's content p123 attribute contains a U+002C COMMA character (,) then abort these steps. Let input be the value of the element's content p123 attribute. Let position point at the first character of input. Skip whitespace p38 . Collect a sequence of characters p37 that are not space characters p37 . Let the pragma-set default language p126 be the string that resulted from the previous step.
2.
3.
4. 5. 6. 7. 8.
For meta p122 elements with an http-equiv p125 attribute in the Content Language state p126 , the content p123 attribute must have a value consisting of a valid BCP 47 language tag. [BCP47] p781 Note: This pragma is not exactly equivalent to the HTTP Content-Language header, for instance it only supports one language. [HTTP] p782 Encoding declaration state (http-equiv="content-type") The Encoding declaration state p126 is just an alternative form of setting the charset attribute: it is a character encoding declaration p129 . This state's user agent requirements are all handled by the parsing section of the specification. For meta p122 elements with an http-equiv p125 attribute in the Encoding declaration state p126 , the content p123 attribute must have a value that is an ASCII case-insensitive p36 match for a string that consists of: the literal string "text/html;", optionally followed by any number of space characters p37 , followed by the literal string "charset=", followed by the character encoding name of the character encoding declaration p129 . If the document contains a meta p122 element with an http-equiv p125 attribute in the Encoding declaration state p126 , then the document must not contain a meta p122 element with the charset p123 attribute present. The Encoding declaration state p126 may be used in HTML documents p77 , but elements with an http-equiv p125 attribute in that state must not be used in XML documents p77 . Default style state (http-equiv="default-style") This pragma sets the name of the default alternative style sheet set. 1. If the meta p122 element has no content p123 attribute, or if that attribute's value is the empty string, then abort these steps. Set the preferred style sheet set to the value of the element's content p123 attribute. [CSSOM] p782
2.
Refresh state (http-equiv="refresh") This pragma acts as timed redirect. 1. If another meta p122 element with an http-equiv p125 attribute in the Refresh state p126 has already been successfully processed (i.e. when it was inserted the user agent processed it and reached the last step of this list of steps), then abort these steps.
126
2.
If the meta p122 element has no content p123 attribute, or if that attribute's value is the empty string, then abort these steps. Let input be the value of the element's content p123 attribute. Let position point at the first character of input. Skip whitespace p38 . Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and parse the resulting string using the rules for parsing non-negative integers p39 . If the sequence of characters collected is the empty string, then no number will have been parsed; abort these steps. Otherwise, let time be the parsed number. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) and U+002E FULL STOP (.). Ignore any collected characters. Skip whitespace p38 . Let url be the address of the current page. If the character in input pointed to by position is a U+003B SEMICOLON (";"), then advance position to the next character. Otherwise, jump to the last step. Skip whitespace p38 . If the character in input pointed to by position is a U+0055 LATIN CAPITAL LETTER U character (U) or a U+0075 LATIN SMALL LETTER U character (u), then advance position to the next character. Otherwise, jump to the last step. If the character in input pointed to by position is a U+0052 LATIN CAPITAL LETTER R character (R) or a U+0072 LATIN SMALL LETTER R character (r), then advance position to the next character. Otherwise, jump to the last step. If the character in input pointed to by position is s U+004C LATIN CAPITAL LETTER L character (L) or a U+006C LATIN SMALL LETTER L character (l), then advance position to the next character. Otherwise, jump to the last step. Skip whitespace p38 . If the character in input pointed to by position is a U+003D EQUALS SIGN ("="), then advance position to the next character. Otherwise, jump to the last step. Skip whitespace p38 . If the character in input pointed to by position is either a U+0027 APOSTROPHE character (') or U+0022 QUOTATION MARK character ("), then let quote be that character, and advance position to the next character. Otherwise, let quote be the empty string. Let url be equal to the substring of input from the character at position to the end of the string. If quote is not the empty string, and there is a character in url equal to quote, then truncate url at that character, so that it and all subsequent characters are removed. Strip any trailing space characters p37 from the end of url. Strip any U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), and U+000D CARRIAGE RETURN (CR) characters from url. Resolve p55 the url value to an absolute URL p56 , relative to the meta p122 element. If this fails, abort these steps. Perform one or more of the following steps: After the refresh has come due (as defined below), if the user has not canceled the redirect and if the meta p122 element's Document p33 's browsing context p499 did not have the sandboxed automatic features browsing context flag p217 set when the Document p33 was created, navigate p520 the Document p33 's browsing context p499 to url, with replacement enabled p528 , and with the Document p33 's browsing context p499 as the source browsing context p520 . For the purposes of the previous paragraph, a refresh is said to have come due as soon as the later of the following two conditions occurs: At least time seconds have elapsed since the document has completely loaded p687 , adjusted to take into account user or user agent preferences.
3. 4. 5. 6.
7.
8. 9. 10.
11. 12.
13.
14.
15. 16.
17. 18.
19. 20.
21. 22.
23.
24.
127
At least time seconds have elapsed since the meta p122 element was inserted into the Document p29 , adjusted to take into account user or user agent preferences.
Provide the user with an interface that, when selected, navigates p520 a browsing context p499 to url, with the document's browsing context as the source browsing context p520 . Do nothing.
In addition, the user agent may, as with anything, inform the user of any and all aspects of its operation, including the state of any timers, the destinations of any timed redirects, and so forth. For meta p122 elements with an http-equiv p125 attribute in the Refresh state p126 , the content p123 attribute must have a value consisting either of: just a valid non-negative integer p39 , or a valid non-negative integer p39 , followed by a U+003B SEMICOLON character (;), followed by one or more space characters p37 , followed by a substring that is an ASCII case-insensitive p36 match for the string "URL", followed by a U+003D EQUALS SIGN character (=), followed by a valid URL p55 .
In the former case, the integer represents a number of seconds before the page is to be reloaded; in the latter case the integer represents a number of seconds before the page is to be replaced by the page at the given URL p55 . A news organization's front page could include the following markup in the page's head p116 element, to ensure that the page automatically reloads from the server every five minutes: <meta http-equiv="Refresh" content="300"> A sequence of pages could be used as an automated slide show by making each page refresh to the next page in the sequence, using markup such as the following: <meta http-equiv="Refresh" content="20; URL=page4.html"> Cookie setter (http-equiv="set-cookie") This pragma sets an HTTP cookie. [COOKIES] p781 It is non-conforming. Real HTTP headers should be used instead. 1. If the meta p122 element has no content p123 attribute, or if that attribute's value is the empty string, then abort these steps. Obtain the storage mutex p554 . Act as if receiving a set-cookie-string for the document's address p77 via a "non-HTTP" API, consisting of the value of the element's content p123 attribute encoded as UTF-8. [COOKIES] p781 [RFC3629] p784
2. 3.
There must not be more than one meta p122 element with any particular state in the document at a time.
4.2.5.4 Other pragma directives Extensions to the predefined set of pragma directives may, under certain conditions, be registered in the WHATWG Wiki PragmaExtensions page. [WHATWGWIKI] p786 Such extensions must use a name that is identical to an HTTP header registered in the Permanent Message Header Field Registry, and must have behavior identical to that described for the HTTP header. [IANAPERMHEADERS] p783 Pragma directives corresponding to headers describing metadata, or not requiring specific user agent processing, must not be registered; instead, use metadata names p124 . Pragma directives corresponding to headers that affect the HTTP processing model (e.g. caching) must not be registered, as they would result in HTTP-level behavior being different for user agents that implement HTML than for user agents that do not. Anyone is free to edit the WHATWG Wiki PragmaExtensions page at any time to add a pragma directive satisfying these conditions. Such registrations must specify the following information: Keyword The actual name being defined. The name must match a previously-registered HTTP name with the same requirements. Brief description A short non-normative description of the purpose of the pragma directive.
128
Specification A link to the specification defining the corresponding HTTP header. Conformance checkers must use the information given on the WHATWG Wiki PragmaExtensions page to establish if a value is allowed or not: values defined in this specification or listed on the aforementioned page must be accepted, whereas values not listed in either this specification or on the aforementioned page must be rejected as invalid. Conformance checkers may cache this information (e.g. for performance reasons or to avoid the use of unreliable network connectivity).
4.2.5.5 Specifying the document's character encoding A character encoding declaration is a mechanism by which the character encoding used to store or transmit a document is specified. The following restrictions apply to character encoding declarations: The character encoding name given must be the name of the character encoding used to serialize the file. The value must be a valid character encoding name, and must be an ASCII case-insensitive p36 match for the preferred MIME name p30 for that encoding. [IANACHARSET] p782 The character encoding declaration must be serialized without the use of character references p619 or character escapes of any kind. The element containing the character encoding declaration must be serialized completely within the first 512 bytes of the document. There can only be one character encoding declaration in the document.
If an HTML document p77 does not start with a BOM, and if its encoding is not explicitly given by Content-Type metadata p61 , and the document is not an iframe srcdoc document p214 , then the character encoding used must be an ASCII-compatible character encoding p30 , and, in addition, if that encoding isn't US-ASCII itself, then the encoding must be specified using a meta p122 element with a charset p123 attribute or a meta p122 element with an http-equiv p125 attribute in the Encoding declaration state p126 . If the document is an iframe srcdoc document p214 , the document must not have a character encoding declaration p129 . (In this case, the source is already decoded, since it is part of the document that contained the iframe p213 .) If an HTML document p77 contains a meta p122 element with a charset p123 attribute or a meta p122 element with an http-equiv p125 attribute in the Encoding declaration state p126 , then the character encoding used must be an ASCIIcompatible character encoding p30 . Authors are encouraged to use UTF-8. Conformance checkers may advise authors against using legacy encodings. [RFC3629] p784 Authoring tools should default to using UTF-8 for newly-created documents. [RFC3629] p784 Encodings in which a series of bytes in the range 0x20 to 0x7E can encode characters other than the corresponding characters in the range U+0020 to U+007E represent a potential security vulnerability: a user agent that does not support the encoding (or does not support the label used to declare the encoding, or does not use the same mechanism to detect the encoding of unlabelled content as another user agent) might end up interpreting technically benign plain text content as HTML tags and JavaScript. For example, this applies to encodings in which the bytes corresponding to "<script>" in ASCII can encode a different string. Authors should not use such encodings, which are known to include JIS_C6226-1983, JIS_X0212-1990, HZ-GB-2312, JOHAB (Windows code page 1361), encodings based on ISO-2022, and encodings based on EBCDIC. Furthermore, authors must not use the CESU-8, UTF-7, BOCU-1 and SCSU encodings, which also fall into this category, because these encodings were never intended for use for Web content. [RFC1345] p783 [RFC1842] p784 [RFC1468] p783 [RFC2237] p784 [RFC1554] p783 [RFC1922] p784 [RFC1557] p783 [CESU8] p781 [UTF7] p785 [BOCU1] p781 [SCSU] p785 Authors should not use UTF-32, as the encoding detection algorithms described in this specification intentionally do not distinguish it from UTF-16. [UNICODE] p785 Note: Using non-UTF-8 encodings can have unexpected results on form submission and URL encodings, which use the document's character encoding p81 by default. In XHTML, the XML declaration should be used for inline character encoding information, if necessary. In HTML, to declare that the character encoding is UTF-8, the author could include the following markup near the top of the document (in the head p116 element): <meta charset="utf-8">
129
In XML, the XML declaration would be used instead, at the very top of the markup: <?xml version="1.0" encoding="utf-8"?>
130
The title attribute on style p130 elements defines alternative style sheet sets. If the style p130 element has no title p131 attribute, then it has no title; the title p92 attribute of ancestors does not apply to the style p130 element. [CSSOM] p782 Note: The title p131 attribute on style p130 elements, like the title p122 attribute on link p119 elements, differs from the global title p92 attribute in that a style p130 block without a title does not inherit the title of the parent element: it merely has no title. The textContent p33 of a style p130 element must match the style production in the following ABNF, the character set for which is Unicode. [ABNF] p781 style no-c-start c-start no-c-end c-end = = = = = no-c-start *( c-start no-c-end c-end no-c-start ) <any string that doesn't contain a substring that matches c-start > "<!--" <any string that doesn't contain a substring that matches c-end > "-->"
All descendant elements must be processed, according to their semantics, before the style p130 element itself is evaluated. For styling languages that consist of pure text, user agents must evaluate style p130 elements by passing the concatenation of the contents of all the text nodes p29 that are direct children of the style p130 element (not any other nodes such as comments or elements), in tree order p29 , to the style system. For XML-based styling languages, user agents must pass all the child nodes of the style p130 element to the style system. All URLs p55 found by the styling language's processor must be resolved p55 , relative to the element (or as defined by the styling language), when the processor is invoked. Once the attempts to obtain the style sheet's critical subresources p28 , if any, are complete, or, if the style sheet has no critical subresources p28 , once the style sheet has been parsed and processed, the user agent must, if the loads were successful or there were none, queue a task p553 to fire a simple event p559 named load at the style p130 element, or, if one of the style sheet's critical subresources p28 failed to completely load for any reason (e.g. DNS error, HTTP 404 response, a connection being prematurely closed, unsupported Content-Type), queue a task p553 to fire a simple event p559 named error at the style p130 element. Non-network errors in processing the style sheet or its subresources (e.g. CSS parse errors, PNG decoding errors) are not failures for the purposes of this paragraph. The task source p553 for these tasks p553 is the DOM manipulation task source p554 . The element must delay the load event p687 of the element's document until all the attempts to obtain the style sheet's critical subresources p28 , if any, are complete. Note: This specification does not specify a style system, but CSS is expected to be supported by most Web browsers. [CSS] p781 The media, type and scoped IDL attributes must reflect p62 the respective content attributes of the same name. The disabled IDL attribute behaves as defined for the alternative style sheets DOM p132 . The LinkStyle interface is also implemented by this element; the styling processing model p132 defines how. [CSSOM] p782 The following document has its emphasis styled as bright red text rather than italics text, while leaving titles of works and Latin words in their default italics. It shows how using appropriate elements enables easier restyling of documents. <!DOCTYPE html> <html lang="en-US"> <head> <title>My favorite book</title> <style> body { color: black; background: white; } em { font-style: normal; color: red; } </style> </head> <body> <p>My <em>favorite</em> book of all time has <em>got</em> to be <cite>A Cat's Life</cite>. It is a book by P. Rahmel that talks about the <i lang="la">Felis Catus</i> in modern human society.</p> </body> </html>
131
4.2.7 Styling
The link p119 and style p130 elements can provide styling information for the user agent to use when rendering the document. The DOM Styling specification specifies what styling information is to be used by the user agent and how it is to be used. [CSSOM] p782 The style p130 and link p119 elements implement the LinkStyle interface. [CSSOM] p782 For style p130 elements, if the user agent does not support the specified styling language, then the sheet attribute of the element's LinkStyle interface must return null. Similarly, link p119 elements that do not represent external resource links that contribute to the styling processing model p447 (i.e. that do not have a stylesheet p447 keyword in their rel p120 attribute), and link p119 elements whose specified resource has not yet been fetched, or is not in a supported styling language, must have their LinkStyle interface's sheet attribute return null. Otherwise, the LinkStyle interface's sheet attribute must return a StyleSheet object with the following properties: [CSSOM] p782 The style sheet type The style sheet type must be the same as the style's specified type. For style p130 elements, this is the same as the type p130 content attribute's value, or text/css if that is omitted. For link p119 elements, this is the Content-Type metadata of the specified resource p61 . The style sheet location For link p119 elements, the location must be the result of resolving p55 the URL p55 given by the element's href p120 content attribute, relative to the element, or the empty string if that fails. For style p130 elements, there is no location. The style sheet media The media must be the same as the value of the element's media content attribute, or the empty string, if the attribute is omitted. The style sheet title The title must be the same as the value of the element's title p92 content attribute, if the attribute is present and has a non-empty value. If the attribute is absent or its value is the empty string, then the style sheet does not have a title (it is the empty string). The title is used for defining alternative style sheet sets. The style sheet alternate flag For link p119 elements, true if the link is an alternative stylesheet p448 . In all other cases, false. The same object must be returned each time. The disabled IDL attribute on link p119 and style p130 elements must return false and do nothing on setting, if the sheet attribute of their LinkStyle interface is null. Otherwise, it must return the value of the StyleSheet interface's disabled attribute on getting, and forward the new value to that same attribute on setting. The rules for handling alternative style sheets are defined in the CSS object model specification. [CSSOM] p782 Style sheets, whether added by a link p119 element, a style p130 element, an <?xml-stylesheet> PI, an HTTP Link: header, or some other mechanism, have a style sheet ready flag, which is initially unset. When a style sheet is ready to be applied, its style sheet ready p132 flag must be set. If the style sheet referenced no other resources (e.g. it was an internal style sheet given by a style p130 element with no @import rules), then the style rules must be synchronously made available to script; otherwise, the style rules must only be made available to script once the event loop p552 reaches its "update the rendering" step. A style sheet in the context of the Document p33 of an HTML parser p620 or XML parser p705 is said to be a style sheet that is blocking scripts if the element was created by that Document p33 's parser, and the element is either a style p130 element or a link p119 element that was an external resource link that contributes to the styling processing model p447 when the element was created by the parser, and the element's style sheet was enabled when the element was created by the parser, and the element's style sheet ready p132 flag is not yet set, and, the last time the event loop p552 reached step 1, the element was in that Document p29 , and the user agent hasn't given up on that particular style sheet yet. A user agent may give up on a style sheet at any time. A Document p33 has a style sheet that is blocking scripts if there is either a style sheet that is blocking scripts p132 in the context of that Document p33 , or if that Document p33 is in a browsing context p499 that has a parent browsing context p499 , and the active document p499 of that parent browsing context p499 itself has a style sheet that is blocking scripts p132 . A Document p33 has no style sheet that is blocking scripts if it does not have a style sheet that is blocking scripts p132 as defined in the previous paragraph.
132
4.3 Scripting
Scripts allow authors to add interactivity to their documents. Authors are encouraged to use declarative alternatives to scripting where possible, as declarative mechanisms are often more maintainable, and many users disable scripting. For example, instead of using script to show or hide a section to show more details, the details p423 element could be used. Authors are also encouraged to make their applications degrade gracefully in the absence of scripting support. For example, if an author provides a link in a table header to dynamically resort the table, the link could also be made to function without scripts by requesting the sorted table from the server.
133
The charset attribute gives the character encoding of the external script resource. The attribute must not be specified if the src p133 attribute is not present. If the attribute is set, its value must be a valid character encoding name, must be an ASCII case-insensitive p36 match for the preferred MIME name p30 for that encoding, and must match the encoding given in the charset parameter of the Content-Type metadata p61 of the external file, if any. [IANACHARSET] p782 The async and defer attributes are boolean attributes p38 that indicate how the script should be executed. The defer p134 and async p134 attributes must not be specified if the src p133 attribute is not present. There are three possible modes that can be selected using these attributes. If the async p134 attribute is present, then the script will be executed asynchronously, as soon as it is available. If the async p134 attribute is not present but the defer p134 attribute is present, then the script is executed when the page has finished parsing. If neither attribute is present, then the script is fetched and executed immediately, before the user agent continues parsing the page. Note: The exact processing details for these attributes are, for mostly historical reasons, somewhat non-trivial, involving a number of aspects of HTML. The implementation requirements are therefore by necessity scattered throughout the specification. The algorithms below (in this section) describe the core of this processing, but these algorithms reference and are referenced by the parsing rules for script p133 start p663 and end p675 tags in HTML, in foreign content p684 , and in XML p705 , the rules for the document.write() p112 method, the handling of scripting p550 , etc. The defer p134 attribute may be specified even if the async p134 attribute is specified, to cause legacy Web browsers that only support defer p134 (and not async p134 ) to fall back to the defer p134 behavior instead of the synchronous blocking behavior that is the default. Changing the src p133 , type p133 , charset p134 , async p134 , and defer p134 attributes dynamically has no direct effect; these attribute are only used at specific times described below. A script p133 element has several associated pieces of state. The first is a flag indicating whether or not the script block has been "already started". Initially, script p133 elements must have this flag unset (script blocks, when created, are not "already started"). When a script p133 element is cloned, the "already started" flag, if set, must be propagated to the clone when it is created. The second is a flag indicating whether the element was "parser-inserted". Initially, script p133 elements must have this flag unset. It is set by the HTML parser p620 and the XML parser p705 on script p133 elements they insert and affects the processing of those elements. The third is a flag indicating whether or not the script block is "ready to be parser-executed". Initially, script p133 elements must have this flag unset (script blocks, when created, are not "ready to be parserexecuted"). This flag is used only for elements that are also "parser-inserted" p134 , to let the parser know when to execute the script. The last few pieces of state are the script block's type, the script block's character encoding, and the script block's fallback character encoding. They are determined when the script is run, based on the attributes on the element at that time, and the Document p33 of the script p133 element. When a script p133 element that is not marked as being "parser-inserted" p134 experiences one of the events listed in the following list, the user agent must synchronously run p134 the script p133 element: The script p133 element gets inserted into a document p29 . The script p133 element is in a Document p29 and its child nodes are changed. The script p133 element is in a Document p29 and has a src p133 attribute set where previously the element had no such attribute.
Running a script: When a script p133 element is to be run, the user agent must act as follows: 1. If the script p133 element is marked as having "already started" p134 , then the user agent must abort these steps at this point. The script is not executed. If the element has its "parser-inserted" p134 flag set, then set was-parser-inserted to true and unset the element's "parser-inserted" p134 flag. Otherwise, set was-parser-inserted to false. Note: This is done so that if parser-inserted script p133 elements fail to run when the parser tries to run them, e.g. because they are empty or specify an unsupported scripting language, another script can later mutate them and cause them to run again.
2.
134
3.
If the element has no src p133 attribute, and its child nodes, if any, consist only of comment nodes and empty text nodes p29 , then the user agent must abort these steps at this point. The script is not executed. If the element is not in a Document p29 , then the user agent must abort these steps at this point. The script is not executed. If either: the script p133 element has a type p133 attribute and its value is the empty string, or the script p133 element has no type p133 attribute but it has a language p742 attribute and that attribute's value is the empty string, or the script p133 element has neither a type p133 attribute nor a language p742 attribute, then
4.
5.
...let the script block's type p134 for this script p133 element be "text/javascript". Otherwise, if the script p133 element has a type p133 attribute, let the script block's type p134 for this script p133 element be the value of that attribute with any leading or trailing sequences of space characters p37 removed. Otherwise, the element has a non-empty language p742 attribute; let the script block's type p134 for this script p133 element be the concatenation of the string "text/" followed by the value of the language p742 attribute. Note: The language p742 attribute is never conforming, and is always ignored if there is a type p133 attribute present. 6. If the user agent does not support the scripting language p139 given by the script block's type p134 for this script p133 element, then the user agent must abort these steps at this point. The script is not executed. The user agent must set the element's "already started" p134 flag. If was-parser-inserted is true, then flag the element as "parser-inserted" p134 again. If scripting is disabled p550 for the script p133 element, then the user agent must abort these steps at this point. The script is not executed. If the script p133 element has an event p742 attribute and a for p742 attribute, then run these substeps: 1. 2. 3. 4. Let for be the value of the for p742 attribute. Let event be the value of the event p742 attribute. Strip leading and trailing whitespace p38 from event and for. If for is not an ASCII case-insensitive p36 match for the string "window", then the user agent must abort these steps at this point. The script is not executed. If event is not an ASCII case-insensitive p36 match for either the string "onload" or the string "onload()", then the user agent must abort these steps at this point. The script is not executed.
7. 8. 9.
10.
5.
11.
If the script p133 element has a charset p134 attribute, then let the script block's character encoding p134 for this script p133 element be the encoding given by the charset p134 attribute. Otherwise, let the script block's fallback character encoding p134 for this script p133 element be the same as the encoding of the document itself p81 . Note: Only one of these two pieces of state is set.
12.
If the element has a src p133 attribute whose value is not the empty string, then the value of that attribute must be resolved p55 relative to the element, and if that is successful, the specified resource must then be fetched p59 , from the origin p510 of the element's Document p33 . If the src p133 attribute's value is the empty string or if it could not be resolved, then the user agent must queue a task p553 to fire a simple event p559 named error at the element, and abort these steps. For historical reasons, if the URL p55 is a javascript: URL p554 , then the user agent must not, despite the requirements in the definition of the fetching p59 algorithm, actually execute the script in the URL; instead the user agent must act as if it had received an empty HTTP 400 response. For performance reasons, user agents may start fetching the script as soon as the attribute is set, instead, in the hope that the element will be inserted into the document. Either way, once the element is inserted into the document p29 , the load must have started. If the UA performs such prefetching, but the
135
element is never inserted in the document, or the src p133 attribute is dynamically changed, then the user agent will not execute the script, and the fetching process will have been effectively wasted. 13. Then, the first of the following options that describes the situation must be followed:
p133 attribute, and the element has a defer p134 attribute, and the If the element has a src element has been flagged as "parser-inserted" p134 , and the element does not have an async p134 attribute
The element must be added to the end of the list of scripts that will execute when the document has finished parsing associated with the Document p33 of the parser that created the element. The task p553 that the networking task source p554 places on the task queue p553 once the fetching algorithm p59 has completed must set the element's "ready to be parser-executed" p134 flag. The parser will handle executing the script.
p133 attribute, and the element has been flagged as "parser If the element has a src inserted" p134 , and the element does not have an async p134 attribute
The element is the pending parsing-blocking script p136 of the Document p33 of the parser that created the element. (There can only be one such script per Document p33 at a time.) The task p553 that the networking task source p554 places on the task queue p553 once the fetching algorithm p59 has completed must set the element's "ready to be parser-executed" p134 flag. The parser will handle executing the script.
p133 attribute, and the element has been flagged as If the element does not have a src "parser-inserted" p134 , and the Document p33 of the HTML parser p620 or XML parser p705 that created the script p133 element has a style sheet that is blocking scripts p132
The element is the pending parsing-blocking script p136 of the Document p33 of the parser that created the element. (There can only be one such script per Document p33 at a time.) Set the element's "ready to be parser-executed" p134 flag. The parser will handle executing the script.
p133 attribute If the element has a src
The element must be added to the set of scripts that will execute as soon as possible of the Document p33 of the script p133 element at the time the running a script p134 algorithm started. The task p553 that the networking task source p554 places on the task queue p553 once the fetching algorithm p59 has completed must execute the script block p136 and then remove the element from the set of scripts that will execute as soon as possible p136 . Otherwise The user agent must immediately execute the script block p136 , even if other scripts are already executing. Fetching an external script must delay the load event p687 of the element's document until the task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 (defined above) has been run. The pending parsing-blocking script of a Document p33 is used by the Document p33 's parser(s). Note: If a script p133 element that blocks a parser gets moved to another Document p33 before it would normally have stopped blocking that parser, it nonetheless continues blocking that parser until the condition that causes it to be blocking the parser no longer applies (e.g. if the script is a pending parsing-blocking script p136 because there was a style sheet that is blocking scripts p132 when it was parsed, but then the script is moved to another Document p33 before the style sheet loads, the script still blocks the parser until the style sheets are all loaded, at which time the script executes and the parser is unblocked). Executing a script block: When the steps above require that the script block be executed, the user agent must act as follows: If the load resulted in an error (for example a DNS error, or an HTTP 404 error) Executing the script block must just consist of firing a simple event p559 named error at the element. If the load was successful Executing the script block must consists of running the following steps. For the purposes of these steps, the script is considered to be from an external file if, while the running a script p134 algorithm above was running for this script, the script p133 element had a src p133 attribute specified.
136
1.
To obtain the string of Unicode characters, the user agent run the following steps: 1. If the resource's Content Type metadata p61 , if any, specifies a character encoding, and the user agent supports that encoding, then let character encoding be that encoding, and jump to the bottom step in this series of steps. If the algorithm above set the script block's character encoding p134 , then let character encoding be that encoding, and jump to the bottom step in this series of steps. For each of the rows in the following table, starting with the first one and going down, if the file has as many or more bytes available than the number of bytes in the first column, and the first bytes of the file match the bytes given in the first column, then set character encoding to the encoding given in the cell in the second column of that row, and jump to the bottom step in this series of steps:
Bytes in Hexadecimal FE FF FF FE EF BB BF Encoding Big-endian UTF-16 Little-endian UTF-16 UTF-8
2.
3.
Note: This step looks for Unicode Byte Order Marks (BOMs). 4. Let character encoding be the script block's fallback character encoding p134 . Convert the file to Unicode using character encoding, following the rules for doing so given by the specification for the script block's type p134 .
5.
p134 is an XML If the script is from an external file and the script block's type based language The external file is the script source. When it is later executed, it must be interpreted in a manner consistent with the specification defining the language given by the script block's type p134 . p134 is a text-based language If the script is inline and the script block's type The value of the text p138 IDL attribute at the time the element's "already started" p134 flag was set is the script source. p134 is an XML-based language If the script is inline and the script block's type p133 The child nodes of the script element at the time the element's "already started" p134 flag was set are the script source.
2.
If the script is from an external file, then increment the ignore-destructive-writes counter p112 of the script p133 element's Document p33 . Let neutralized doc be that Document p33 . Create a script p552 from the script p133 element node, using the script block's source p137 and the script block's type p134 . Note: This is where the script is compiled and actually executed.
3.
4.
Decrement the ignore-destructive-writes counter p112 of neutralized doc, if it was incremented in the earlier step. If the script is from an external file, fire a simple event p559 named load at the script p133 element. Otherwise, the script is internal; queue a task p553 to fire a simple event p559 named load at the script p133 element.
5.
The IDL attributes src, type, charset, async, and defer, each must reflect p62 the respective content attributes of the same name.
137
This box is non-normative. Implementation requirements are given below this box. script . text
p138
[ = value ]
Returns the contents of the element, ignoring child nodes that aren't text nodes p29 . Can be set, to replace the element's children with the given value.
The IDL attribute text must return a concatenation of the contents of all the text nodes p29 that are direct children of the script p133 element (ignoring any other nodes such as comments or elements), in tree order. On setting, it must act the same way as the textContent p33 IDL attribute. Note: When inserted using the document.write() p112 method, script p133 elements execute (typically synchronously), but when inserted using innerHTML p112 and outerHTML p113 attributes, they do not execute at all. In this example, two script p133 elements are used. One embeds an external script, and the other includes some data. <script src="game-engine.js"></script> <script type="text/x-game-map"> ........U.........e o............A....e .....A.....AAA....e .A..AAA...AAAAA...e </script> The data in this case might be used by the script to generate the map of a video game. The data doesn't have to be used that way, though; maybe the map data is actually embedded in other parts of the page's markup, and the data block here is just used by the site's search engine to help users who are looking for particular features in their game maps. The following sample shows how a script element can be used to define a function that is then used by other parts of the document. It also shows how a script p133 element can be used to invoke script while the document is being parsed, in this case to initialize the form's output. <script> function calculate(form) { var price = 52000; if (form.elements.brakes.checked) price += 1000; if (form.elements.radio.checked) price += 2500; if (form.elements.turbo.checked) price += 5000; if (form.elements.sticker.checked) price += 250; form.elements.result.value = price; } </script> <form name="pricecalc" onsubmit="return false"> <fieldset> <legend>Work out the price of your car</legend> <p>Base cost: 52000.</p> <p>Select additional options:</p> <ul> <li><label><input type=checkbox name=brakes> Ceramic brakes (1000)</label></li> <li><label><input type=checkbox name=radio> Satellite radio (2500)</label></li> <li><label><input type=checkbox name=turbo> Turbo charger (5000)</label></li> <li><label><input type=checkbox name=sticker> "XZ" sticker (250)</label></li> </ul> <p>Total: <output name=result onformchange="calculate(form)"></output></p> </fieldset> <script> document.forms.pricecalc.dispatchFormChange(); </script> </form>
138
4.3.1.1 Scripting languages A user agent is said to support the scripting language if the script block's type p134 is an ASCII caseinsensitive p36 match for the MIME type p28 string of a scripting language that the user agent implements. The following lists some MIME type p28 strings and the languages to which they refer: "application/ecmascript" "application/javascript" "application/x-ecmascript" "application/x-javascript" "text/ecmascript" "text/javascript" "text/javascript1.0" "text/javascript1.1" "text/javascript1.2" "text/javascript1.3" "text/javascript1.4" "text/javascript1.5" "text/jscript" "text/livescript" "text/x-ecmascript" "text/x-javascript" JavaScript. [ECMA262] p782 "text/javascript;e4x=1" JavaScript with ECMAScript for XML. [ECMA357] p782 User agents may support other MIME types p28 and other languages. When examining types to determine if they support the language, user agents must not ignore unknown MIME parameters types with unknown parameters must be assumed to be unsupported. The charset parameter must be treated as an unknown parameter for the purpose of comparing MIME types p28 here.
4.3.1.2 Restrictions for contents of script elements The textContent p33 of a script p133 element must match the script production in the following ABNF, the character set for which is Unicode. [ABNF] p781 script escape data1 not-data1 data2 not-data2 data3 not-data3 script-start script-end lt slash s s c c r r i i p p t t = data1 *( escape [ script-start data3 ] "-->" data1 ) [ escape ] = "<!--" data2 *( script-start data3 script-end data2 ) = <any string that doesn't contain a substring that matches not-data1> = "<!--" = <any string that doesn't contain a substring that matches not-data2> = script-start / "-->" = <any string that doesn't contain a substring that matches not-data3> = script-end / "-->" = lt s c r i p t tag-end = lt slash s c r i p t tag-end = = = =/ = =/ = =/ = =/ = =/ = =/ %x003C ; U+003C LESS-THAN SIGN character (<) %x002F ; U+002F SOLIDUS character (/) %x0053 %x0073 %x0043 %x0063 %x0052 %x0072 %x0049 %x0069 %x0050 %x0070 %x0054 %x0074 ; ; ; ; ; ; ; ; ; ; ; ; U+0053 U+0073 U+0043 U+0063 U+0052 U+0072 U+0049 U+0069 U+0050 U+0070 U+0054 U+0074 LATIN LATIN LATIN LATIN LATIN LATIN LATIN LATIN LATIN LATIN LATIN LATIN CAPITAL LETTER SMALL LETTER S CAPITAL LETTER SMALL LETTER C CAPITAL LETTER SMALL LETTER R CAPITAL LETTER SMALL LETTER I CAPITAL LETTER SMALL LETTER P CAPITAL LETTER SMALL LETTER T S C R I P T
139
= =/ =/ =/ =/ =/
; ; ; ; ; ;
CHARACTER TABULATION LINE FEED (LF) FORM FEED (FF) SPACE SOLIDUS (/) GREATER-THAN SIGN (>)
When a script p133 element contains script documentation p140 , there are further restrictions on the contents of the element, as described in the section below.
4.3.1.3 Inline documentation for external scripts If a script p133 element's src p133 attribute is specified, then the contents of the script p133 element, if any, must be such that the value of the text p138 IDL attribute, which is derived from the element's contents, matches the documentation production in the following ABNF, the character set for which is Unicode. [ABNF] p781 documentation = *( *( space / tab / comment ) [ line-comment ] newline ) comment = slash star *( not-star / star not-slash ) 1*star slash line-comment = slash slash *not-newline ; characters tab newline space star slash not-newline not-star not-slash
= = = = = =
%x0009 ; U+0009 TAB %x000A ; U+000A LINE FEED (LF) %x0020 ; U+0020 SPACE %x002A ; U+002A ASTERISK (*) %x002F ; U+002F SOLIDUS (/) %x0000-0009 / %x000B-10FFFF ; a Unicode character other than U+000A LINE FEED (LF) = %x0000-0029 / %x002B-10FFFF ; a Unicode character other than U+002A ASTERISK (*) = %x0000-002E / %x0030-10FFFF ; a Unicode character other than U+002F SOLIDUS (/)
Note: This corresponds to putting the contents of the element in JavaScript comments. Note: This requirement is in addition to the earlier restrictions on the syntax of contents of script p133 elements. This allows authors to include documentation, such as license information or API information, inside their documents while still referring to external script files. The syntax is constrained so that authors don't accidentally include what looks like valid script while also providing a src p133 attribute. <script src="cool-effects.js"> // create new instances using: // var e = new Effect(); // start the effect using .play, stop using .stop: // e.play(); // e.stop(); </script>
140
Otherwise: text that conforms to the requirements given in the prose. Content attributes: Global attributes p90 DOM interface: Uses HTMLElement p88 . The noscript p140 element represents p708 nothing if scripting is enabled p550 , and represents p708 its children if scripting is disabled p550 . It is used to present different markup to user agents that support scripting and those that don't support scripting, by affecting how the document is parsed. When used in HTML documents p77 , the allowed content model is as follows: In a head p116 element, if scripting is disabled p550 for the noscript p140 element The noscript p140 element must contain only link p119 , style p130 , and meta p122 elements. In a head p116 element, if scripting is enabled p550 for the noscript p140 element The noscript p140 element must contain only text, except that invoking the HTML fragment parsing algorithm p696 with the noscript p140 element as the context element and the text contents as the input must result in a list of nodes that consists only of link p119 , style p130 , and meta p122 elements that would be conforming if they were children of the noscript p140 element, and no parse errors p620 . Outside of head p116 elements, if scripting is disabled p550 for the noscript p140 element The noscript p140 element's content model is transparent p102 , with the additional restriction that a noscript p140 element must not have a noscript p140 element as an ancestor (that is, noscript p140 can't be nested). Outside of head p116 elements, if scripting is enabled p550 for the noscript p140 element The noscript p140 element must contain only text, except that the text must be such that running the following algorithm results in a conforming document with no noscript p140 elements and no script p133 elements, and such that no step in the algorithm causes an HTML parser p620 to flag a parse error p620 : 1. 2. Remove every script p133 element from the document. Make a list of every noscript p140 element in the document. For every noscript p140 element in that list, perform the following steps: 1. 2. Let the parent element be the parent element of the noscript p140 element. Take all the children of the parent element that come before the noscript p140 element, and call these elements the before children. Take all the children of the parent element that come after the noscript p140 element, and call these elements the after children. Let s be the concatenation of all the text node p29 children of the noscript p140 element. Set the innerHTML p112 attribute of the parent element to the value of s. (This, as a sideeffect, causes the noscript p140 element to be removed from the document.) Insert the before children at the start of the parent element, preserving their original relative order. Insert the after children at the end of the parent element, preserving their original relative order.
3.
4. 5.
6.
7.
Note: All these contortions are required because, for historical reasons, the noscript p140 element is handled differently by the HTML parser p620 based on whether scripting was enabled or not p632 when the parser was invoked. The noscript p140 element must not be used in XML documents p77 . Note: The noscript p140 element is only effective in the HTML syntax p613 , it has no effect in the XHTML syntax p705 . The noscript p140 element has no other requirements. In particular, children of the noscript p140 element are not exempt from form submission p416 , scripting, and so forth, even when scripting is enabled p550 for the element. In the following example, a noscript p140 element is used to provide fallback for a script.
141
<form action="calcSquare.php"> <p> <label for=x>Number</label>: <input id="x" name="x" type="number"> </p> <script> var x = document.getElementById('x'); var output = document.createElement('p'); output.textContent = 'Type a number; it will be squared right then!'; x.form.appendChild(output); x.form.onsubmit = function () { return false; } x.oninput = function () { var v = x.valueAsNumber; output.textContent = v + ' squared is ' + v * v; }; </script> <noscript> <input type=submit value="Calculate Square"> </noscript> </form> When script is disabled, a button appears to do the calculation on the server side. When script is enabled, the value is computed on-the-fly instead. The noscript p140 element is a blunt instrument. Sometimes, scripts might be enabled, but for some reason the page's script might fail. For this reason, it's generally better to avoid using noscript p140 , and to instead design the script to change the page from being a scriptless page to a scripted page on the fly, as in the next example: <form action="calcSquare.php"> <p> <label for=x>Number</label>: <input id="x" name="x" type="number"> </p> <input id="submit" type=submit value="Calculate Square"> <script> var x = document.getElementById('x'); var output = document.createElement('p'); output.textContent = 'Type a number; it will be squared right then!'; x.form.appendChild(output); x.form.onsubmit = function () { return false; } x.oninput = function () { var v = x.valueAsNumber; output.textContent = v + ' squared is ' + v * v; }; var submit = document.getElementById('submit'); submit.parentNode.removeChild(submit); </script> </form> The above technique is also useful in XHTML, since noscript p140 is not supported in the XHTML syntax p705 .
4.4 Sections
4.4.1 The body element
Categories Sectioning root p155 . Contexts in which this element can be used: As the second element in an html p116 element. Content model: Flow content p100 . Content attributes: Global attributes p90 onafterprint p559 onbeforeprint p559 onbeforeunload p559
142
onblur p559 onerror p559 onfocus p559 onhashchange p559 onload p559 onmessage p559 onoffline p559 ononline p559 onpagehide p559 onpageshow p559 onpopstate p559 onredo p559 onresize p559 onscroll p559 onstorage p559 onundo p559 onunload p559 DOM interface: interface HTMLBodyElement : HTMLElement { attribute Function onafterprint; attribute Function onbeforeprint; attribute Function onbeforeunload; attribute Function onblur; attribute Function onerror; attribute Function onfocus; attribute Function onhashchange; attribute Function onload; attribute Function onmessage; attribute Function onoffline; attribute Function ononline; attribute Function onpopstate; attribute Function onpagehide; attribute Function onpageshow; attribute Function onredo; attribute Function onresize; attribute Function onscroll; attribute Function onstorage; attribute Function onundo; attribute Function onunload; }; The body p142 element represents p708 the main content of the document. In conforming documents, there is only one body p142 element. The document.body p83 IDL attribute provides scripts with easy access to a document's body p142 element. Note: Some DOM operations (for example, parts of the drag and drop p581 model) are defined in terms of "the body element p83 ". This refers to a particular element in the DOM, as per the definition of the term, and not any arbitrary body p142 element. The body p142 element exposes as event handler content attributes p556 a number of the event handlers p555 of the Window p503 object. It also mirrors their event handler IDL attributes p556 . The onblur p559 , onerror p559 , onfocus p559 , onload p559 , and onscroll p559 event handlers p555 of the Window p503 object, exposed on the body p142 element, shadow the generic event handlers p555 with the same names normally supported by HTML elements p28 . Thus, for example, a bubbling error event fired on a child of the body element p83 of a Document p33 would first trigger the onerror p558 event handler content attributes p556 of that element, then that of the root html p116 element, and only then would it trigger the onerror p559 event handler content attribute p556 on the body p142 element. This is because the event would bubble from the target, to the body p142 , to the html p116 , to the Document p33 , to the Window p503 , and the event handler p555 on the body p142 is watching the Window p503 not the body p142 . A regular event listener attached to the body p142 using addEventListener(), however, would fire when the event bubbled through the body p142 and not when it reaches the Window p503 object.
143
This page updates an indicator to show whether or not the user is online: <!DOCTYPE HTML> <html> <head> <title>Online or offline?</title> <script> function update(online) { document.getElementById('status').textContent = online ? 'Online' : 'Offline'; } </script> </head> <body ononline="update(true)" onoffline="update(false)" onload="update(navigator.onLine)"> <p>You are: <span id="status">(Unknown)</span></p> </body> </html>
144
<p>These juicy, green apples make a great filling for apple pies.</p> </section> </article> Notice how the use of section p144 means that the author can use h1 p150 elements throughout, without having to worry about whether a particular section is at the top level, the second level, the third level, and so on. Here is a graduation programme with two sections, one for the list of people graduating, and one for the description of the ceremony. <!DOCTYPE Html> <Html ><Head ><Title >Graduation Ceremony Summer 2022</Title ></Head ><Body ><H1 >Graduation</H1 ><Section ><H1 >Ceremony</H1 ><P >Opening Procession</P ><P >Speech by Validactorian</P ><P >Speech by Class President</P ><P >Presentation of Diplomas</P ><P >Closing Speech by Headmaster</P ></Section ><Section ><H1 >Graduates</H1 ><Ul ><Li >Molly Carpenter</Li ><Li >Anastasia Luccio</Li ><Li >Ebenezar McCoy</Li ><Li >Karrin Murphy</Li ><Li >Thomas Raith</Li ><Li >Susan Rodriguez</Li ></Ul ></Section ></Body ></Html>
145
Content attributes: Global attributes p90 DOM interface: Uses HTMLElement p88 . The nav p145 element represents p708 a section of a page that links to other pages or to parts within the page: a section with navigation links. Not all groups of links on a page need to be in a nav p145 element only sections that consist of major navigation blocks are appropriate for the nav p145 element. In particular, it is common for footers to have a short list of links to various pages of a site, such as the terms of service, the home page, and a copyright page. The footer p153 element alone is sufficient for such cases, without a nav p145 element. Note: User agents (such as screen readers) that are targeted at users who can benefit from navigation information being omitted in the initial rendering, or who can benefit from navigation information being immediately available, can use this element as a way to determine what content on the page to initially skip and/or provide on request. In the following example, the page has several places where links are present, but only one of those places is considered a navigation section. <body> <header> <h1>Wake up sheeple!</h1> <p><a href="news.html">News</a> <a href="blog.html">Blog</a> <a href="forums.html">Forums</a></p> <p>Last Modified: <time>2009-04-01</time></p> <nav> <h1>Navigation</h1> <ul> <li><a href="articles.html">Index of all articles</a></li> <li><a href="today.html">Things sheeple need to wake up for today</a></li> <li><a href="successes.html">Sheeple we have managed to wake</a></li> </ul> </nav> </header> <div> <article> <header> <h1>My Day at the Beach</h1> </header> <div> <p>Today I went to the beach and had a lot of fun.</p> ...more content... </div> <footer> <p>Posted <time pubdate="" datetime="2009-10-10T14:36-08:00">Thursday</time>.</p> </footer> </article> ...more blog posts... </div> <footer> <p>Copyright 2006 The Example Company</p> <p><a href="about.html">About</a> <a href="policy.html">Privacy Policy</a> <a href="contact.html">Contact Us</a></p> </footer> </body> Notice the div p172 elements being used to wrap all the contents of the page other than the header and footer, and all the contents of the blog entry other than its header and footer. In the following example, there are two nav p145 elements, one for primary navigation around the site, and one for secondary navigation around the page itself. <body> <h1>The Wiki Center Of Exampland</h1> <nav>
146
<ul> <li><a href="/">Home</a></li> <li><a href="/events">Current Events</a></li> ...more... </ul> </nav> <article> <header> <h1>Demos in Exampland</h1> <p>Written by A. N. Other.</p> </header> <nav> <ul> <li><a href="#public">Public demonstrations</a></li> <li><a href="#destroy">Demolitions</a></li> ...more... </ul> </nav> <div> <section id="public"> <h1>Public demonstrations</h1> <p>...more...</p> </section> <section id="destroy"> <h1>Demolitions</h1> <p>...more...</p> </section> ...more... </div> <footer> <p><a href="?edit">Edit</a> | <a href="?delete">Delete</a> | <a href="?Rename">Rename</a></p> </footer> </article> <footer> <p><small> copyright 1998 Exampland Emperor</small></p> </footer> </body>
147
Note: When used specifically with content to be redistributed in syndication, the article p147 element is similar in purpose to the entry element in Atom. [ATOM] p781 Note: The time p182 element's pubdate p182 attribute can be used to provide the publication date for an article p147 element. This example shows a blog post using the article p147 element: <article> <header> <h1>The Very First Rule of Life</h1> <p><time pubdate datetime="2009-10-09T14:28-08:00"></time></p> </header> <p>If there's a microphone anywhere near you, assume it's hot and sending whatever you're saying to the world. Seriously.</p> <p>...</p> <footer> <a href="?comments=1">Show comments...</a> </footer> </article> Here is that same blog post, but showing some of the comments: <article> <header> <h1>The Very First Rule of Life</h1> <p><time pubdate datetime="2009-10-09T14:28-08:00"></time></p> </header> <p>If there's a microphone anywhere near you, assume it's hot and sending whatever you're saying to the world. Seriously.</p> <p>...</p> <section> <h1>Comments</h1> <article> <footer> <p>Posted by: George Washington</p> <p><time pubdate datetime="2009-10-10T19:10-08:00"></time></p> </footer> <p>Yeah! Especially when talking about your lobbyist friends!</p> </article> <article> <footer> <p>Posted by: George Hammond</p> <p><time pubdate datetime="2009-10-10T19:15-08:00"></time></p> </footer> <p>Hey, you have the same first name as me.</p> </article> </section> </article> Notice the use of footer p153 to give the information for each comment (such as who wrote it and when): the footer p153 element can appear at the start of its section when appropriate, such as in this case. (Using header p152 in this case wouldn't be wrong either; it's mostly a matter of authoring preference.)
148
DOM interface: Uses HTMLElement p88 . The aside p148 element represents p708 a section of a page that consists of content that is tangentially related to the content around the aside p148 element, and which could be considered separate from that content. Such sections are often represented as sidebars in printed typography. The element can be used for typographical effects like pull quotes or sidebars, for advertising, for groups of nav p145 elements, and for other content that is considered separate from the main content of the page. Note: It's not appropriate to use the aside p148 element just for parentheticals, since those are part of the main flow of the document. The following example shows how an aside is used to mark up background material on Switzerland in a much longer news story on Europe. <aside> <h1>Switzerland</h1> <p>Switzerland, a land-locked country in the middle of geographic Europe, has not joined the geopolitical European Union, though it is a signatory to a number of European treaties.</p> </aside> The following example shows how an aside is used to mark up a pull quote in a longer article. ... <p>He later joined a large company, continuing on the same work. <q>I love my job. People ask me what I do for fun when I'm not at work. But I'm paid to do my hobby, so I never know what to answer. Some people wonder what they would do if they didn't have to work... but I know what I would do, because I was unemployed for a year, and I filled that time doing exactly what I do now.</q></p> <aside> <q> People ask me what I do for fun when I'm not at work. But I'm paid to do my hobby, so I never know what to answer. </q> </aside> <p>Of course his work or should that be hobby? isn't his only passion. He also enjoys other pleasures.</p> ... The following extract shows how aside p148 can be used for blogrolls and other side content on a blog: <body> <header> <h1>My wonderful blog</h1> <p>My tagline</p> </header> <aside> <!-- this aside contains two sections that are tangentially related to the page, namely, links to other blogs, and links to blog posts from this blog --> <nav> <h1>My blogroll</h1> <ul> <li><a href="http://blog.example.com/">Example Blog</a> </ul> </nav> <nav> <h1>Archives</h1> <ol reversed> <li><a href="/last-post">My last post</a> <li><a href="/first-post">My first post</a> </ol> </nav> </aside> <aside>
149
<!-- this aside is tangentially related to the page also, it contains twitter messages from the blog author --> <h1>Twitter Feed</h1> <blockquote cite="http://twitter.example.net/t31351234"> I'm on vacation, writing my blog. </blockquote> <blockquote cite="http://twitter.example.net/t31219752"> I'm going to go on vacation soon. </blockquote> </aside> <article> <!-- this is a blog post --> <h1>My last post</h1> <p>This is my last post.</p> <footer> <p><a href="/last-post" rel=bookmark>Permalink</a> </footer> </article> <article> <!-- this is also a blog post --> <h1>My first post</h1> <p>This is my first post.</p> <aside> <!-- this aside is about the blog post, since it's inside the <article> element; it would be wrong, for instance, to put the blogroll here, since the blogroll isn't really related to this post specifically, only to the page as a whole --> <h1>Posting</h1> <p>While I'm thinking about it, I wanted to say something about posting. Posting is fun!</p> </aside> <footer> <p><a href="/first-post" rel=bookmark>Permalink</a> </footer> </article> <footer> <nav> <a href="/archives">Archives</a> <a href="/about">About me</a> <a href="/copyright">Copyright</a> </nav> </footer> </body>
150
These elements have a rank given by the number in their name. The h1 p150 element is said to have the highest rank, the h6 p150 element has the lowest rank, and two elements with the same name have equal rank. These two snippets are equivalent: <body> <h1>Let's call it a draw(ing surface)</h1> <h2>Diving in</h2> <h2>Simple shapes</h2> <h2>Canvas coordinates</h2> <h3>Canvas coordinates diagram</h3> <h2>Paths</h2> </body> <body> <h1>Let's call it a draw(ing surface)</h1> <section> <h1>Diving in</h1> </section> <section> <h1>Simple shapes</h1> </section> <section> <h1>Canvas coordinates</h1> <section> <h1>Canvas coordinates diagram</h1> </section> </section> <section> <h1>Paths</h1> </section> </body>
151
<h2>Space is not the only void</h2> </hgroup> <hgroup> <h1>Dr. Strangelove</h1> <h2>Or: How I Learned to Stop Worrying and Love the Bomb</h2> </hgroup> The point of using hgroup p151 in these examples is to mask the h2 p150 element (which acts as a secondary title) from the outline p157 algorithm.
152
In this example, the page has a page heading given by the h1 p150 element, and two subsections whose headings are given by h2 p150 elements. The content after the header p152 element is still part of the last subsection started in the header p152 element, because the header p152 element doesn't take part in the outline p157 algorithm. <body> <header> <h1>Little Green Guys With Guns</h1> <nav> <ul> <li><a href="/games">Games</a> <li><a href="/forum">Forum</a> <li><a href="/download">Download</a> </ul> </nav> <h2>Important News</h2> <!-- this starts a second subsection --> <!-- this is part of the subsection entitled "Important News" --> <p>To play today's games you will need to update your client.</p> <h2>Games</h2> <!-- this starts a third subsection --> </header> <p>You have three active games:</p> <!-- this is still part of the subsection entitled "Games" --> ...
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p> <footer><a href="../">Back to index...</a></footer> </body> Here is an example which shows the footer p153 element being used both for a site-wide footer and for a section footer. <!DOCTYPE HTML> <HTML><HEAD> <TITLE>The Ramblings of a Scientist</TITLE> <BODY> <H1>The Ramblings of a Scientist</H1> <ARTICLE> <H1>Episode 15</H1> <VIDEO SRC="/fm/015.ogv" CONTROLS PRELOAD> <P><A HREF="/fm/015.ogv">Download video</A>.</P> </VIDEO> <FOOTER> <!-- footer for article --> <P>Published <TIME PUBDATE DATETIME="2009-10-21T18:26-07:00"></TIME></P> </FOOTER> </ARTICLE> <ARTICLE> <H1>My Favorite Trains</H1> <P>I love my trains. My favorite train of all time is a Kf.</P> <P>It is fun to see them pull some coal cars because they look so dwarfed in comparison.</P> <FOOTER> <!-- footer for article --> <P>Published <TIME PUBDATE DATETIME="2009-09-15T14:54-07:00"></TIME></P> </FOOTER> </ARTICLE> <FOOTER> <!-- site wide footer --> <NAV> <P><A HREF="/credits.html">Credits</A> <A HREF="/tos.html">Terms of Service</A> <A HREF="/index.html">Blog Index</A></P> </NAV> <P>Copyright 2009 Gordon Freeman</P> </FOOTER> </BODY> </HTML>
154
contact persons for the <A href="Activity">W3C HTML Activity</A> </ADDRESS> The address p154 element must not be used to represent arbitrary addresses (e.g. postal addresses), unless those addresses are in fact the relevant contact information. (The p p160 element is the appropriate element for marking up postal addresses in general.) The address p154 element must not contain information other than contact information. For example, the following is non-conforming use of the address p154 element: <ADDRESS>Last Modified: 1999/12/24 23:37:50</ADDRESS> Typically, the address p154 element would be included along with other information in a footer p153 element. The contact information for a node node is a collection of address p154 elements defined by the first applicable entry from the following list:
p147 element If node is an article p142 element If node is a body
The contact information consists of all the address p154 elements that have node as an ancestor and do not have another body p142 or article p147 element ancestor that is a descendant of node.
p147 element If node has an ancestor element that is an article p142 element If node has an ancestor element that is a body
The contact information of node is the same as the contact information of the nearest article p147 or body p142 element ancestor, whichever is nearest.
p33 has a body element p83 If node's Document
The contact information of node is the same as the contact information of the body element p83 of the Document p33 . Otherwise There is no contact information for node. User agents may expose the contact information of a node to the user, or use it for other purposes, such as indexing sections based on the sections' contact information.
blockquote p163 , body p142 , details p423 , fieldset p350 , figure p170 , td p332
Sectioning content p100 elements are always considered subsections of their nearest ancestor sectioning root p155 or their nearest ancestor element of sectioning content p100 , whichever is nearest, regardless of what implied sections other headings may have created. For the following fragment: <body> <h1>Foo</h1> <h2>Bar</h2> <blockquote> <h3>Bla</h3> </blockquote> <p>Baz</p> <h2>Quux</h2> <section> <h3>Thud</h3> </section> <p>Grunt</p> </body>
155
...the structure would be: 1. Foo (heading of explicit body p142 section, containing the "Grunt" paragraph) 1. Bar (heading starting implied section, containing a block quote and the "Baz" paragraph) 2. Quux (heading starting implied section with no content other than the heading itself) 3. Thud (heading of explicit section p144 section)
Notice how the section p144 ends the earlier implicit section so that a later paragraph ("Grunt") is back at the top level. Sections may contain headings of any rank p151 , but authors are strongly encouraged to either use only h1 p150 elements, or to use elements of the appropriate rank p151 for the section's nesting level. Authors are also encouraged to explicitly wrap sections in elements of sectioning content p100 , instead of relying on the implicit sections generated by having multiple headings in one element of sectioning content p100 . For example, the following is correct: <body> <h4>Apples</h4> <p>Apples are fruit.</p> <section> <h2>Taste</h2> <p>They taste lovely.</p> <h6>Sweet</h6> <p>Red apples are sweeter than green ones.</p> <h1>Color</h1> <p>Apples come in various colors.</p> </section> </body> However, the same document would be more clearly expressed as: <body> <h1>Apples</h1> <p>Apples are fruit.</p> <section> <h2>Taste</h2> <p>They taste lovely.</p> <section> <h3>Sweet</h3> <p>Red apples are sweeter than green ones.</p> </section> </section> <section> <h2>Color</h2> <p>Apples come in various colors.</p> </section> </body> Both of the documents above are semantically identical and would produce the same outline in compliant user agents. This third example is also semantically identical, and might be easier to maintain (e.g. if sections are often moved around in editing): <body> <h1>Apples</h1> <p>Apples are fruit.</p> <section> <h1>Taste</h1> <p>They taste lovely.</p> <section> <h1>Sweet</h1> <p>Red apples are sweeter than green ones.</p> </section> </section> <section> <h1>Color</h1> <p>Apples come in various colors.</p> </section> </body>
156
4.4.11.1 Creating an outline This section defines an algorithm for creating an outline for a sectioning content p100 element or a sectioning root p155 element. It is defined in terms of a walk over the nodes of a DOM tree, in tree order, with each node being visited when it is entered and when it is exited during the walk. The outline for a sectioning content p100 element or a sectioning root p155 element consists of a list of one or more potentially nested sections p157 . A section is a container that corresponds to some nodes in the original DOM tree. Each section can have one heading associated with it, and can contain any number of further nested sections. The algorithm for the outline also associates each node in the DOM tree with a particular section and potentially a heading. (The sections in the outline aren't section p144 elements, though some may correspond to such elements they are merely conceptual sections.) The following markup fragment: <body> <h1>A</h1> <p>B</p> <h2>C</h2> <p>D</p> <h2>E</h2> <p>F</p> </body> ...results in the following outline being created for the body p142 node (and thus the entire document): 1. Section created for body p142 node. Associated with heading "A". Also associated with paragraph "B". Nested sections: 1. Section implied for first h2 p150 element. Associated with heading "C". Also associated with paragraph "D". No nested sections. Section implied for second h2 p150 element. Associated with heading "E". Also associated with paragraph "F". No nested sections.
2.
The algorithm that must be followed during a walk of a DOM subtree rooted at a sectioning content p100 element or a sectioning root p155 element to determine that element's outline p157 is as follows: 1. 2. Let current outlinee be null. (It holds the element whose outline p157 is being created.) Let current section be null. (It holds a pointer to a section p157 , so that elements in the DOM can all be associated with a section.) Create a stack to hold elements, which is used to handle nesting. Initialize this stack to empty. As you walk over the DOM in tree order p29 , trigger the first relevant step below for each element as you enter and exit it. If the top of the stack is an element, and you are exiting that element Note: The element being exited is a heading content p100 element. Pop that element from the stack.
p100 element If the top of the stack is a heading content
3. 4.
Do nothing.
p100 element or a sectioning root p155 element When entering a sectioning content
If current outlinee is not null, and the current section has no heading, create an implied heading and let that be the heading for the current section. If current outlinee is not null, push current outlinee onto the stack. Let current outlinee be the element that is being entered. Let current section be a newly created section p157 for the current outlinee element. Let there be a new outline p157 for the new current outlinee, initialized with just the new current section as the only section p157 in the outline.
157
p100 element, if the stack is not empty When exiting a sectioning content
Pop the top element from the stack, and let the current outlinee be that element. Let current section be the last section in the outline p157 of the current outlinee element. Append the outline p157 of the sectioning content p100 element being exited to the current section. (This does not change which section is the last section in the outline p157 .)
p155 element, if the stack is not empty When exiting a sectioning root
Run these steps: 1. 2. Pop the top element from the stack, and let the current outlinee be that element. Let current section be the last section in the outline p157 of the current outlinee element. Finding the deepest child: If current section has no child sections, stop these steps. Let current section be the last child section p157 of the current current section. Go back to the substep labeled finding the deepest child.
3. 4. 5.
p100 element or a sectioning root p155 element When exiting a sectioning content
Note: The current outlinee is the element being exited. Let current section be the first section p157 in the outline p157 of the current outlinee element. Skip to the next step in the overall set of steps. (The walk is over.) If the current outlinee is null Do nothing.
p100 element When entering a heading content
If the current section has no heading, let the element being entered be the heading for the current section. Otherwise, if the element being entered has a rank p151 equal to or greater than the heading of the last section of the outline p157 of the current outlinee, then create a new section p157 and append it to the outline p157 of the current outlinee element, so that this new section is the new last section of that outline. Let current section be that new section. Let the element being entered be the new heading for the current section. Otherwise, run these substeps: 1. 2. Let candidate section be current section. If the element being entered has a rank p151 lower than the rank p151 of the heading of the candidate section, then create a new section p157 , and append it to candidate section. (This does not change which section is the last section in the outline.) Let current section be this new section. Let the element being entered be the new heading for the current section. Abort these substeps. Let new candidate section be the section p157 that contains candidate section in the outline p157 of current outlinee. Let candidate section be new candidate section. Return to step 2.
3.
4. 5.
Push the element being entered onto the stack. (This causes the algorithm to skip any descendants of the element.) Note: Recall that h1 p150 has the highest rank, and h6 p150 has the lowest rank. Otherwise Do nothing. In addition, whenever you exit a node, after doing the steps above, if current section is not null, associate the node with the section p157 current section. 5. If the current outlinee is null, then there was no sectioning content p100 element or sectioning root p155 element in the DOM. There is no outline p157 . Abort these steps.
158
6.
Associate any nodes that were not associated with a section p157 in the steps above with current outlinee as their section. Associate all nodes with the heading of the section p157 with which they are associated, if any. If current outlinee is the body element p83 , then the outline created for that element is the outline p157 of the entire document.
7. 8.
The tree of sections created by the algorithm above, or a proper subset thereof, must be used when generating document outlines, for example when generating tables of contents. When creating an interactive table of contents, entries should jump the user to the relevant sectioning content p100 element, if the section p157 was created for a real element in the original document, or to the relevant heading content p100 element, if the section p157 in the tree was generated for a heading in the above process. Note: Selecting the first section p157 of the document therefore always takes the user to the top of the document, regardless of where the first heading in the body p142 is to be found. The outline depth of a heading content p100 element associated with a section p157 section is the number of sections p157 that are ancestors of section in the outline p157 that section finds itself in when the outlines p157 of its Document p33 's elements are created, plus 1. The outline depth p159 of a heading content p100 element not associated with a section p157 is 1. User agents should provide default headings for sections that do not have explicit section headings. Consider the following snippet: <body> <nav> <p><a href="/">Home</a></p> </nav> <p>Hello world.</p> <aside> <p>My cat is cute.</p> </aside> </body> Although it contains no headings, this snippet has three sections: a document (the body p142 ) with two subsections (a nav p145 and an aside p148 ). A user agent could present the outline as follows: 1. Untitled document 1. Navigation 2. Sidebar
These default headings ("Untitled document", "Navigation", "Sidebar") are not specified by this specification, and might vary with the user's language, the page's language, the user's preferences, the user agent implementor's preferences, etc. The following JavaScript function shows how the tree walk could be implemented. The root argument is the root of the tree to walk, and the enter and exit arguments are callbacks that are called with the nodes as they are entered and exited. [ECMA262] p782 function (root, enter, exit) { var node = root; start: while (node) { enter(node); if (node.firstChild) { node = node.firstChild; continue start; } while (node) { exit(node); if (node.nextSibling) { node = node.nextSibling; continue start; } if (node == root) node = null; else node = node.parentNode; } } }
159
161
<p><i>Maybe it won't be that bad</i>, he told himself. The lie was comforting enough to get him through the rest of the night's shift.</p> <hr> <p>The Carlton AllLander drove Dudley home just after dawn. Like the astronomer, the vehicle was old and worn, but perfectly capable of doing its job. It had a cheap diesel engine, common enough on a semi-frontier world like Gralmond, although its drive array was a thoroughly modern photoneural processor. With its high suspension and deep-tread tyres it could plough along the dirt track to the observatory in all weather and seasons, including the metre-deep snow of Gralmond's winters.</p> Note: The hr p161 element does not affect the document's outline p157 .
Note: Authors are encouraged to consider how preformatted text will be experienced when the formatting is lost, as will be the case for users of speech synthesizers, braille displays, and the like. For cases like ASCII art, it is likely that an alternative presentation, such as a textual description, would be more universally accessible to the readers of the document. To represent a block of computer code, the pre p162 element can be used with a code p184 element; to represent a block of computer output the pre p162 element can be used with a samp p186 element. Similarly, the kbd p186 element can be used within a pre p162 element to indicate text that the user is to enter. Note: A newline in a pre p162 element separates paragraphs for the purposes of the Unicode bidirectional algorithm. [BIDI] p781 In the following snippet, a sample of computer code is presented. <p>This is the <code>Panel</code> constructor:</p> <pre><code>function Panel(element, canClose, closeHandler) { this.element = element; this.canClose = canClose; this.closeHandler = function () { if (closeHandler) closeHandler() }; }</code></pre>
162
In the following snippet, samp p186 and kbd p186 elements are mixed in the contents of a pre p162 element to show a session of Zork I. <pre><samp>You are in an open field west of a big white house with a boarded front door. There is a small mailbox here. ></samp> <kbd>open mailbox</kbd> <samp>Opening the mailbox reveals: A leaflet. ></samp></pre> The following shows a contemporary poem that uses the pre p162 element to preserve its unusual formatting, which forms an intrinsic part of the poem itself. <pre> it is with a heavy that i admit loss of a feline so loved a friend lost to the unknown (night) ~cdr 11dec07</pre> maxling heart
The blockquote p163 element represents p708 a section that is quoted from another source. Content inside a blockquote p163 must be quoted from another source, whose address, if it has one, may be cited in the cite attribute. If the cite p163 attribute is present, it must be a valid URL potentially surrounded by spaces p55 . To obtain the corresponding citation link, the value of the attribute must be resolved p55 relative to the element. User agents should allow users to follow such citation links. The cite IDL attribute must reflect p62 the element's cite content attribute. This next example shows the use of cite p178 alongside blockquote p163 : <p>His next piece was the aptly named <cite>Sonnet 130</cite>:</p> <blockquote cite="http://quotes.example.org/s/sonnet130.html"> <p>My mistress' eyes are nothing like the sun,<br>
163
Coral is far more red, than her lips red,<br> ... This example shows how a forum post could use blockquote p163 to show what post a user is replying to. The article p147 element is used for each post, to mark up the threading. <article> <h1><a href="http://bacon.example.com/?blog=109431">Bacon on a crowbar</a></h1> <article> <header><strong>t3yw</strong> 12 points 1 hour ago</header> <p>I bet a narwhal would love that.</p> <footer><a href="?pid=29578">permalink</a></footer> <article> <header><strong>greg</strong> 8 points 1 hour ago</header> <blockquote><p>I bet a narwhal would love that.</p></blockquote> <p>Dude narwhals don't eat bacon.</p> <footer><a href="?pid=29579">permalink</a></footer> <article> <header><strong>t3yw</strong> 15 points 1 hour ago</header> <blockquote> <blockquote><p>I bet a narwhal would love that.</p></blockquote> <p>Dude narwhals don't eat bacon.</p> </blockquote> <p>Next thing you'll be saying they don't get capes and wizard hats either!</p> <footer><a href="?pid=29580">permalink</a></footer> <article> <article> <header><strong>boing</strong> -5 points 1 hour ago</header> <p>narwhals are worse than ceiling cat</p> <footer><a href="?pid=29581">permalink</a></footer> </article> </article> </article> </article> <article> <header><strong>fred</strong> 1 points 23 minutes ago</header> <blockquote><p>I bet a narwhal would love that.</p></blockquote> <p>I bet they'd love to peel a banana too.</p> <footer><a href="?pid=29582">permalink</a></footer> </article> </article> </article> This example shows the use of a blockquote p163 for short snippets, demonstrating that one does not have to use p p160 elements inside blockquote p163 elements: <p>He began his list of "lessons" with the following:</p> <blockquote>One should never assume that his side of the issue will be recognized, let alone that it will be conceded to have merits.</blockquote> <p>He continued with a number of similar points, ending with:</p> <blockquote>Finally, one should be prepared for the threat of breakdown in negotiations at any given moment and not be cowed by the possiblity.</blockquote> <p>We shall now discuss these points... Note: Examples of how to represent a conversation p453 are shown in a later section; it is not appropriate to use the cite p178 and blockquote p163 elements for this purpose.
164
Content attributes: Global attributes p90 reversed p165 start p165 type p165 DOM interface: interface HTMLOListElement : HTMLElement { attribute boolean reversed; attribute long start; attribute DOMString type; }; The ol p164 element represents p708 a list of items, where the items have been intentionally ordered, such that changing the order would change the meaning of the document. The items of the list are the li p166 element child nodes of the ol p164 element, in tree order p29 . The reversed attribute is a boolean attribute p38 . If present, it indicates that the list is a descending list (..., 3, 2, 1). If the attribute is omitted, the list is an ascending list (1, 2, 3, ...). The start attribute, if present, must be a valid integer p39 giving the ordinal value p167 of the first list item. If the start p165 attribute is present, user agents must parse it as an integer p39 , in order to determine the attribute's value. The default value, used if the attribute is missing or if the value cannot be converted to a number according to the referenced algorithm, is 1 if the element has no reversed p165 attribute, and is the number of child li p166 elements otherwise. The first item in the list has the ordinal value p167 given by the ol p164 element's start p165 attribute, unless that li p166 element has a value p167 attribute with a value that can be successfully parsed, in which case it has the ordinal value p167 given by that value p167 attribute. Each subsequent item in the list has the ordinal value p167 given by its value p167 attribute, if it has one, or, if it doesn't, the ordinal value p167 of the previous item, plus one if the reversed p165 is absent, or minus one if it is present. The type attribute can be used to specify the kind of marker to use in the list, in the cases where that matters (e.g. because items are to be referened by their number/letter). The attribute, if specified, must have a value that is a case-sensitive p36 match for one of the characters given in the first cell of one of the rows of the following table. The type p165 attribute represents the state given in the cell in the second column of the row whose first cell matches the attribute's value; if none of the cells match, or if the attribute is omitted, then the attribute represents the decimal p165 state.
Keyword State Description Decimal numbers Lowercase latin alphabet Uppercase latin alphabet Examples for values 1-3 and 3999-4001 1. 2. a. b. A. B. 3. c. C. ... ... ... 3999. ewu. EWU. 4000. 4001. ... ewv. EWV. iv. . IV eww. ... EWW. ... ivi. ... I. ... IV
i (U+0069) lower-roman Lowercase roman numerals i. ii. iii. ... mmmcmxcix. I (U+0049) upper-roman Uppercase roman numerals I. II. III. ... MMMCMXCIX.
User agents should render the items of the list in a manner consistent with the state of the type p165 attribute of the ol p164 element. Numbers less than or equal to zero should always use the decimal system regardless of the type p165 attribute. Note: For CSS user agents, a mapping for this attribute to the 'list-style-type' CSS property is given in the rendering section p716 (the mapping is straightforward: the states above have the same names as their corresponding CSS values). The reversed, start, and type IDL attributes must reflect p62 the respective content attributes of the same name. The start p165 IDL attribute has the same default as its content attribute. The following markup shows a list where the order matters, and where the ol p164 element is therefore appropriate. Compare this list to the equivalent list in the ul p166 section to see an example of the same items using the ul p166 element. <p>I have lived in the following countries (given in the order of when I first lived there):</p> <ol>
165
<li>Switzerland <li>United Kingdom <li>United States <li>Norway </ol> Note how changing the order of the list changes the meaning of the document. In the following example, changing the relative order of the first two items has changed the birthplace of the author: <p>I have lived in the following countries (given in the order of when I first lived there):</p> <ol> <li>United Kingdom <li>Switzerland <li>United States <li>Norway </ol>
166
Contexts in which this element can be used: Inside ol p164 elements. Inside ul p166 elements. Inside menu p428 elements. Content model: Flow content p100 . Content attributes: Global attributes p90 If the element is a child of an ol p164 element: value p167 DOM interface: interface HTMLLIElement : HTMLElement { attribute long value; }; The li p166 element represents p708 a list item. If its parent element is an ol p164 , ul p166 , or menu p428 element, then the element is an item of the parent element's list, as defined for those elements. Otherwise, the list item has no defined list-related relationship to any other li p166 element. If the parent element is an ol p164 element, then the li p166 element has an ordinal value. The value attribute, if present, must be a valid integer p39 giving the ordinal value p167 of the list item. If the value p167 attribute is present, user agents must parse it as an integer p39 , in order to determine the attribute's value. If the attribute's value cannot be converted to a number, the attribute must be treated as if it was absent. The attribute has no default value. The value p167 attribute is processed relative to the element's parent ol p164 element (q.v.), if there is one. If there is not, the attribute has no effect. The value IDL attribute must reflect p62 the value of the value p167 content attribute. The following example, the top ten movies are listed (in reverse order). Note the way the list is given a title by using a figure p170 element and its figcaption p172 element. <figure> <figcaption>The top 10 movies of all time</figcaption> <ol> <li value="10"><cite>Josie and the Pussycats</cite>, 2001</li> <li value="9"><cite lang="sh"> , </cite>, 1998</li> <li value="8"><cite>A Bug's Life</cite>, 1998</li> <li value="7"><cite>Toy Story</cite>, 1995</li> <li value="6"><cite>Monsters, Inc</cite>, 2001</li> <li value="5"><cite>Cars</cite>, 2006</li> <li value="4"><cite>Toy Story 2</cite>, 1999</li> <li value="3"><cite>Finding Nemo</cite>, 2003</li> <li value="2"><cite>The Incredibles</cite>, 2004</li> <li value="1"><cite>Ratatouille</cite>, 2007</li> </ol> </figure> The markup could also be written as follows, using the reversed p165 attribute on the ol p164 element: <figure> <figcaption>The top 10 movies of all time</figcaption> <ol reversed> <li><cite>Josie and the Pussycats</cite>, 2001</li> <li><cite lang="sh"> , </cite>, 1998</li> <li><cite>A Bug's Life</cite>, 1998</li> <li><cite>Toy Story</cite>, 1995</li> <li><cite>Monsters, Inc</cite>, 2001</li> <li><cite>Cars</cite>, 2006</li> <li><cite>Toy Story 2</cite>, 1999</li> <li><cite>Finding Nemo</cite>, 2003</li> <li><cite>The Incredibles</cite>, 2004</li> <li><cite>Ratatouille</cite>, 2007</li> </ol> </figure>
167
Note: If the li p166 element is the child of a menu p428 element and itself has a child that defines a command p432 , then the li p166 element will match the :enabled p456 and :disabled p457 pseudoclasses in the same way as the first such child element does.
In the following example, one definition is linked to two terms. <dl> <dt lang="en-US"> <dfn>color</dfn> </dt> <dt lang="en-GB"> <dfn>colour</dfn> </dt> <dd> A sensation which (in humans) derives from the ability of the fine structure of the eye to distinguish three differently filtered analyses of a view. </dd> </dl>
168
The following example illustrates the use of the dl p168 element to mark up metadata of sorts. At the end of the example, one group has two metadata labels ("Authors" and "Editors") and two values ("Robert Rothman" and "Daniel Jackson"). <dl> <dt> <dd> <dt> <dd> <dt> <dt> <dd> <dd> </dl>
Last modified time </dt> 2004-12-23T23:33Z </dd> Recommended update interval </dt> 60s </dd> Authors </dt> Editors </dt> Robert Rothman </dd> Daniel Jackson </dd>
The following example shows the dl p168 element used to give a set of instructions. The order of the instructions here is important (in the other examples, the order of the blocks was not important). <p>Determine the victory points as follows (use the first matching case):</p> <dl> <dt> If you have exactly five gold coins </dt> <dd> You get five victory points </dd> <dt> If you have one or more gold coins, and you have one or more silver coins </dt> <dd> You get two victory points </dd> <dt> If you have one or more silver coins </dt> <dd> You get one victory point </dd> <dt> Otherwise </dt> <dd> You get no victory points </dd> </dl> The following snippet shows a dl p168 element being used as a glossary. Note the use of dfn p180 to indicate the word being defined. <dl> <dt><dfn>Apartment</dfn>, n.</dt> <dd>An execution context grouping one or more threads with one or more COM objects.</dd> <dt><dfn>Flat</dfn>, n.</dt> <dd>A deflated tire.</dd> <dt><dfn>Home</dfn>, n.</dt> <dd>The user's login directory.</dd> </dl> Note: The dl p168 element is inappropriate for marking up dialogue. Examples of how to mark up dialogue p453 are shown below.
169
This example shows a list of frequently asked questions (a FAQ) marked up using the dt p169 element for questions and the dd p170 element for answers. <article> <h1>FAQ</h1> <dl> <dt>What do we want?</dt> <dd>Our data.</dd> <dt>When do we want it?</dt> <dd>Now.</dd> <dt>Where is it?</dt> <dd>We are not sure.</dd> </dl> </article>
170
The figure p170 element represents p708 some flow content p100 , optionally with a caption, that is self-contained and is typically referenced as a single unit from the main flow of the document. The element can thus be used to annotate illustrations, diagrams, photos, code listings, etc, that are referred to from the main content of the document, but that could, without affecting the flow of the document, be moved away from that primary content, e.g. to the side of the page, to dedicated pages, or to an appendix. The first figcaption p172 element child of the element, if any, represents the caption of the figure p170 element's contents. If there is no child figcaption p172 element, then there is no caption. This example shows the figure p170 element to mark up a code listing. <p>In <a href="#l4">listing 4</a> we see the primary core interface API declaration.</p> <figure id="l4"> <figcaption>Listing 4. The primary core interface API declaration.</figcaption> <pre><code>interface PrimaryCore { boolean verifyDataLine(); void sendData(in sequence<byte> data); void initSelfDestruct(); }</code></pre> </figure> <p>The API is designed to use UTF-8.</p> Here we see a figure p170 element to mark up a photo. <figure> <img src="bubbles-work.jpeg" alt="Bubbles, sitting in his office chair, works on his latest project intently."> <figcaption>Bubbles at work</figcaption> </figure> In this example, we see an image that is not a figure, as well as an image and a video that are. <h2>Malinko's comics</h2> <p>This case centered on some sort of "intellectual property" infringement related to a comic (see Exhibit A). The suit started after a trailer ending with these words: <blockquote> <img src="promblem-packed-action.png" alt="ROUGH COPY! Promblem-Packed Action!"> </blockquote> <p>...was aired. A lawyer, armed with a Bigger Notebook, launched a preemptive strike using snowballs. A complete copy of the trailer is included with Exhibit B. <figure> <img src="ex-a.png" alt="Two squiggles on a dirty piece of paper."> <figcaption>Exhibit A. The alleged <cite>rough copy</cite> comic.</figcaption> </figure> <figure> <video src="ex-b.mov"></video> <figcaption>Exhibit B. The <cite>Rough Copy</cite> trailer.</figcaption> </figure> <p>The case was resolved out of court. Here, a part of a poem is marked up using figure p170 . <figure> <p>'Twas brillig, and the slithy toves<br> Did gyre and gimble in the wabe;<br> All mimsy were the borogoves,<br> And the mome raths outgrabe.</p> <figcaption><cite>Jabberwocky</cite> (first verse). Lewis Carroll, 1832-98</figcaption> </figure>
171
In this example, which could be part of a much larger work discussing a castle, the figure has three images in it. <figure> <img src="castle1423.jpeg" title="Etching. Anonymous, ca. 1423." alt="The castle has one tower, and a tall wall around it."> <img src="castle1858.jpeg" title="Oil-based paint on canvas. Maria Towle, 1858." alt="The castle now has two towers and two walls."> <img src="castle1999.jpeg" title="Film photograph. Peter Jankle, 1999." alt="The castle lies in ruins, the original tower all that remains in one piece."> <figcaption>The castle through the ages: 1423, 1858, and 1999 respectively.</figcaption> </figure>
172
<article lang="en-US"> <h1>My use of language and my cats</h1> <p>My cat's behavior hasn't changed much since her absence, except that she plays her new physique to the neighbors regularly, in an attempt to get pets.</p> <div lang="en-GB"> <p>My other cat, coloured black and white, is a sweetie. He followed us to the pool today, walking down the pavement with us. Yesterday he apparently visited our neighbours. I wonder if he recognises that their flat is a mirror image of ours.</p> <p>Hm, I just noticed that in the last paragraph I used British English. But I'm supposed to write in American English. So I shouldn't say "pavement" or "flat" or "colour"...</p> </div> <p>I should say "sidewalk" and "apartment" and "color"!</p> </article>
attribute DOMString text; // URL decomposition IDL attributes attribute DOMString protocol; attribute DOMString host; attribute DOMString hostname; attribute DOMString port; attribute DOMString pathname; attribute DOMString search; attribute DOMString hash; };
173
If the a p173 element has an href p440 attribute, then it represents p708 a hyperlink p440 (a hypertext anchor). If the a p173 element has no href p440 attribute, then the element represents p708 a placeholder for where a link might otherwise have been placed, if it had been relevant. The target p440 , ping p440 , rel p440 , media p440 , hreflang p440 , and type p440 attributes must be omitted if the href p440 attribute is not present. If a site uses a consistent navigation toolbar on every page, then the link that would normally link to the page itself could be marked up using an a p173 element: <nav> <ul> <li> <li> <li> <li> </ul> </nav>
<a href="/">Home</a> </li> <a href="/news">News</a> </li> <a>Examples</a> </li> <a href="/legal">Legal</a> </li>
The href p440 , target p440 and ping p440 attributes affect what happens when users follow hyperlinks p441 created using the a p173 element. The rel p440 , media p440 , hreflang p440 , and type p440 attributes may be used to indicate to the user the likely nature of the target resource before the user follows the link. The activation behavior p102 of a p173 elements that create hyperlinks p440 is to run the following steps: 1. If the click p33 event in question is not trusted p29 (i.e. a click() p571 method call was the reason for the event being dispatched), and the a p173 element's target p440 attribute is such that applying the rules for choosing a browsing context given a browsing context name p502 , using the value of the target p440 attribute as the browsing context name, would result in there not being a chosen browsing context, then raise an INVALID_ACCESS_ERR p75 exception and abort these steps. If the target of the click p33 event is an img p199 element with an ismap p203 attribute specified, then server-side image map processing must be performed, as follows: 1. If the click p33 event was a real pointing-device-triggered click p33 event on the img p199 element, then let x be the distance in CSS pixels from the left edge of the image's left border, if it has one, or the left edge of the image otherwise, to the location of the click, and let y be the distance in CSS pixels from the top edge of the image's top border, if it has one, or the top edge of the image otherwise, to the location of the click. Otherwise, let x and y be zero. Let the hyperlink suffix be a U+003F QUESTION MARK character, the value of x expressed as a base-ten integer using ASCII digits, a U+002C COMMA character (,), and the value of y expressed as a base-ten integer using ASCII digits. ASCII digits are the characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
2.
2.
3.
Finally, the user agent must follow the hyperlink p441 created by the a p173 element. If the steps above defined a hyperlink suffix p174 , then take that into account when following the hyperlink. This box is non-normative. Implementation requirements are given below this box.
The IDL attributes href, ping, target, rel, media, hreflang, and type, must reflect p62 the respective content attributes of the same name. The IDL attribute relList must reflect p62 the rel p440 content attribute. The text IDL attribute, on getting, must return the same value as the textContent p33 IDL attribute on the element, and on setting, must act as if the textContent p33 IDL attribute on the element had been set to the new value. The a p173 element also supports the complement of URL decomposition IDL attributes p57 , protocol, host, port, hostname, pathname, search, and hash. These must follow the rules given for URL decomposition IDL attributes p57 , with the input p58 being the result of resolving p55 the element's href p440 attribute relative to the element, if there is such an attribute and resolving it is successful, or the empty string otherwise; and the common setter action p58 being the same as setting the element's href p440 attribute to the new output value.
174
The a p173 element may be wrapped around entire paragraphs, lists, tables, and so forth, even entire sections, so long as there is no interactive content within (e.g. buttons or other links). This example shows how this can be used to make an entire advertising block into a link: <aside class="advertising"> <h1>Advertising</h1> <a href="http://ad.example.com/?adid=1929&pubid=1422"> <section> <h1>Mellblomatic 9000!</h1> <p>Turn all your widgets into mellbloms!</p> <p>Only $9.99 plus shipping and handling.</p> </section> </a> <a href="http://ad.example.com/?adid=375&pubid=1422"> <section> <h1>The Mellblom Browser</h1> <p>Web browsing at the speed of light.</p> <p>No other browser goes faster!</p> </section> </a> </aside>
175
By emphasizing the entire sentence, it becomes clear that the speaker is fighting hard to get the point across. This kind of emphasis also typically affects the punctuation, hence the exclamation mark here. <p><em>Cats are cute animals!</em></p> Anger mixed with emphasizing the cuteness could lead to markup such as: <p><em>Cats are <em>cute</em> animals!</em></p> The em p175 element isn't a generic "italics" element. Sometimes, text is intended to stand out from the rest of the paragraph, as if it was in a different mood or voice. For this, the i p187 element is more appropriate. The em p175 element also isn't intended to convey importance; for that purpose, the strong p176 element is more appropriate.
176
Note: Small print typically features disclaimers, caveats, legal restrictions, or copyrights. Small print is also sometimes used for attribution, or for satisfying licensing requirements. Note: The small p176 element does not "de-emphasize" or lower the importance of text emphasized by the em p175 element or marked as important with the strong p176 element. To mark text as not emphasized or important, simply do not mark it up with the em p175 or strong p176 elements respectively. The small p176 element should not be used for extended spans of text, such as multiple paragraphs, lists, or sections of text. It is only intended for short runs of text. The text of a page listing terms of use, for instance, would not be a suitable candidate for the small p176 element: in such a case, the text is not a side comment, it is the main content of the page. In this example the footer contains contact information and a copyright notice. <footer> <address> For more details, contact <a href="mailto:[email protected]">John Smith</a>. </address> <p><small> copyright 2038 Example Corp.</small></p> </footer> In this second example, the small p176 element is used for a side comment in an article. <p>Example Corp today announced record profits for the second quarter <small>(Full Disclosure: Foo News is a subsidiary of Example Corp)</small>, leading to speculation about a third quarter merger with Demo Group.</p> This is distinct from a sidebar, which might be multiple paragraphs long and is removed from the main flow of text. In the following example, we see a sidebar from the same article. This sidebar also has small print, indicating the source of the information in the sidebar. <aside> <h1>Example Corp</h1> <p>This company mostly creates small software and Web sites.</p> <p>The Example Corp company mission is "To provide entertainment and news on a sample basis".</p> <p><small>Information obtained from <a href="http://example.com/about.html">example.com</a> home page.</small></p> </aside> In this last example, the small p176 element is marked as being important small print. <p><strong><small>Continued use of this service will result in a kiss.</small></strong></p>
177
Note: The s p177 element is not appropriate when indicating document edits; to mark a span of text as having been removed from a document, use the del p197 element. In this example a recommended retail price has been marked as no longer relevant as the product in question has a new sale price. <p>Buy our Iced Tea and Lemonade!</p> <p><s>Recommended retail price: $3.99 per bottle</s></p> <p><strong>Now selling for just $2.99 a bottle!</strong></p>
178
<p><q>This is still wrong!</q>, said <cite>Ian</cite>.</p> The correct usage does not use a cite p178 element: <p><q>This is correct</q>, said Ian.</p> As mentioned above, the b p188 element might be relevant for marking names as being keywords in certain kinds of documents: <p>And then <b>Ian</b> said <q>this might be right, in a gossip column, maybe!</q>.</p>
179
In the following example, there is no quote the quotation marks are used to name a word. Use of the q p179 element in this case would be inappropriate. <p>The word "ineffable" could have been used to describe the disaster resulting from the campaign's mismanagement.</p>
180
Also, the title p181 attribute has special semantics on this element. DOM interface: Uses HTMLElement p88 . The abbr p180 element represents p708 an abbreviation or acronym, optionally with its expansion. The title attribute may be used to provide an expansion of the abbreviation. The attribute, if specified, must contain an expansion of the abbreviation, and nothing else. The paragraph below contains an abbreviation marked up with the abbr p180 element. This paragraph defines the term p180 "Web Hypertext Application Technology Working Group". <p>The <dfn id=whatwg><abbr title="Web Hypertext Application Technology Working Group">WHATWG</abbr></dfn> is a loose unofficial collaboration of Web browser manufacturers and interested parties who wish to develop new technologies designed to allow authors to write and deploy Applications over the World Wide Web.</p> An alternative way to write this would be: <p>The <dfn id=whatwg>Web Hypertext Application Technology Working Group</dfn> (<abbr title="Web Hypertext Application Technology Working Group">WHATWG</abbr>) is a loose unofficial collaboration of Web browser manufacturers and interested parties who wish to develop new technologies designed to allow authors to write and deploy Applications over the World Wide Web.</p> This paragraph has two abbreviations. Notice how only one is defined; the other, with no expansion associated with it, does not use the abbr p180 element. <p>The <abbr title="Web Hypertext Application Technology Working Group">WHATWG</abbr> started working on HTML5 in 2004.</p> This paragraph links an abbreviation to its definition. <p>The <a href="#whatwg"><abbr title="Web Hypertext Application Technology Working Group">WHATWG</abbr></a> community does not have much representation from Asia.</p> This paragraph marks up an abbreviation without giving an expansion, possibly as a hook to apply styles for abbreviations (e.g. smallcaps). <p>Philip` and Dashiva both denied that they were going to get the issue counts from past revisions of the specification to backfill the <abbr>WHATWG</abbr> issue graph.</p> If an abbreviation is pluralized, the expansion's grammatical number (plural vs singular) must match the grammatical number of the contents of the element. Here the plural is outside the element, so the expansion is in the singular: <p>Two <abbr title="Working Group">WG</abbr>s worked on this specification: the <abbr>WHATWG</abbr> and the <abbr>HTMLWG</abbr>.</p> Here the plural is inside the element, so the expansion is in the plural: <p>Two <abbr title="Working Groups">WGs</abbr> worked on this specification: the <abbr>WHATWG</abbr> and the <abbr>HTMLWG</abbr>.</p> Abbreviations do not have to be marked up using this element. It is expected to be useful in the following cases: Abbreviations for which the author wants to give expansions, where using the abbr p180 element with a title p92 attribute is an alternative to including the expansion inline (e.g. in parentheses). Abbreviations that are likely to be unfamiliar to the document's readers, for which authors are encouraged to either mark up the abbreviation using a abbr p180 element with a title p92 attribute or include the expansion inline in the text the first time the abbreviation is used.
181
Abbreviations whose presence needs to be semantically annotated, e.g. so that they can be identified from a style sheet and given specific styles, for which the abbr p180 element can be used without a title p92 attribute.
Providing an expansion in a title p92 attribute once will not necessarily cause other abbr p180 elements in the same document with the same contents but without a title p92 attribute to behave as if they had the same expansion. Every abbr p180 element is independent.
182
If the element does not need a date, but the datetime p182 attribute is not present, then the element's textContent p33 must be a valid date or time string in content p50 . The date, if any, must be expressed using the Gregorian calendar. If the datetime p182 attribute is present, the user agent should convey the attribute's value to the user when rendering the element. The time p182 element can be used to encode dates, for example in Microformats. The following shows a hypothetical way of encoding an event using a variant on hCalendar that uses the time p182 element: <div class="vevent"> <a class="url" href="http://www.web2con.com/">http://www.web2con.com/</a> <span class="summary">Web 2.0 Conference</span>: <time class="dtstart" datetime="2007-10-05">October 5</time> <time class="dtend" datetime="2007-10-20">19</time>, at the <span class="location">Argent Hotel, San Francisco, CA</span> </div> (The end date is encoded as one day after the last date of the event because in the iCalendar format, end dates are exclusive, not inclusive.) The time p182 element is not necessary for encoding dates or times. In the following snippet, the time is encoded using time p182 , so that it can be restyled (e.g. using XBL2) to match local conventions, while the year is not marked up at all, since marking it up would not be particularly useful. <p>I usually have a snack at <time>16:00</time>.</p> <p>I've liked model trains since at least 1983.</p> Using a styling technology that supports restyling times, the first paragraph from the above snippet could be rendered as follows: I usually have a snack at 4pm. Or it could be rendered as follows: I usually have a snack at 16h00. The dateTime IDL attribute must reflect p62 the datetime p182 content attribute. The pubDate IDL attribute must reflect p62 the pubdate p182 content attribute. User agents, to obtain the date, time, and time-zone offset represented by a time p182 element, must follow these steps: 1. If the datetime p182 attribute is present, then use the rules to parse a date or time string p50 with the flag in attribute from the value of that attribute, and let the result be result. Otherwise, use the rules to parse a date or time string p50 with the flag in content from the element's textContent p33 , and let the result be result. If result is empty (because the parsing failed), then the date p183 is unknown, the time p183 is unknown, and the time-zone offset p183 is unknown. Otherwise: if result contains a date, then that is the date p183 ; if result contains a time, then that is the time p183 ; and if result contains a time-zone offset, then the time-zone offset is the element's time-zone offset p183 . (A time-zone offset can only be present if both a date and a time are also present.) This box is non-normative. Implementation requirements are given below this box. time . valueAsDate
p183
2.
3.
4.
The valueAsDate IDL attribute must return either null or a new Date object initialised to the relevant value as defined by the following list: If the date p183 is known but the time p183 is not The time corresponding to midnight UTC (i.e. the first second) of the given date p183 . If the time p183 is known but the date p183 is not The time corresponding to the given time p183 of 1970-01-01, with the time zone UTC.
183
If both the date p183 and the time p183 are known The time corresponding to the date p183 and time p183 , with the given time-zone offset p183 . If neither the date p183 nor the time p183 are known The null value. When a Date object is to be returned, a new one must be constructed. In the following snippet: <p>Our first date was <time datetime="2006-09-23">a Saturday</time>.</p> ...the time p182 element's valueAsDate p183 attribute would have the value 1,158,969,600,000ms. In the following snippet: <p>Many people get up at <time>08:00</time>.</p> ...the time p182 element's valueAsDate p183 attribute would have the value 28,800,000ms. In this example, an article's publication date is marked up using time p182 : <article> <h1>Small tasks</h1> <footer>Published <time pubdate>2009-08-30</time>.</footer> <p>I put a bike bell on his bike.</p> </article> Here is another way that could be marked up. In this example, legacy user agents would say "today", while newer user agents would render the time in a locale-specific manner based on the value of the attribute. <article> <h1>Small tasks</h1> <footer>Published <time pubdate datetime="2009-08-30">today</time>.</footer> <p>I put a bike bell on his bike.</p> </article> Here is the same thing but with the time included only. Because the element is empty, legacy user agents will not show anything useful; user agents that implement this specification, on the other hand, would show the date and time in a locale-specific manner. <article> <h1>Small tasks</h1> <footer>Published <time pubdate datetime="2009-08-30T07:13Z"></time>.</footer> <p>I put a bike bell on his bike.</p> </article>
184
The following example shows how the element can be used in a paragraph to mark up element names and computer code, including punctuation. <p>The <code>code</code> element represents a fragment of computer code.</p> <p>When you call the <code>activate()</code> method on the <code>robotSnowman</code> object, the eyes glow.</p> <p>The example the start of a keyword, which (full stop) to below uses the <code>begin</code> keyword to indicate statement block. It is paired with an <code>end</code> is followed by the <code>.</code> punctuation character indicate the end of the program.</p>
The following example shows how a block of code could be marked up using the pre p162 and code p184 elements. <pre><code class="language-pascal">var i: Integer; begin i := 1; end.</code></pre> A class is used in that example to indicate the language used. Note: See the pre p162 element for more details.
185
Using Pythagoras' theorem to solve for the hypotenuse <var>a</var> of a triangle with sides <var>b</var> and <var>c</var> </figcaption> </figure>
186
Here the kbd p186 element is used to indicate keys to press: <p>To make George eat an apple, press <kbd><kbd>Shift</kbd>+<kbd>F3</kbd></kbd></p> In this second example, the user is told to pick a particular menu item. The outer kbd p186 element marks up a block of input, with the inner kbd p186 elements representing each individual step of the input, and the samp p186 elements inside them indicating that the steps are input based on something being displayed by the system, in this case menu labels: <p>To make George eat an apple, select <kbd><kbd><samp>File</samp></kbd>|<kbd><samp>Eat Apple...</samp></kbd></kbd> </p> Such precision isn't necessary; the following is equally fine: <p>To make George eat an apple, select <kbd>File | Eat Apple...</kbd></p>
187
Contexts in which this element can be used: Where phrasing content p100 is expected. Content model: Phrasing content p100 . Content attributes: Global attributes p90 DOM interface: Uses HTMLElement p88 . The i p187 element represents p708 a span of text in an alternate voice or mood, or otherwise offset from the normal prose, such as a taxonomic designation, a technical term, an idiomatic phrase from another language, a thought, a ship name, or some other prose whose typical typographic presentation is italicized. Terms in languages different from the main text should be annotated with lang p92 attributes (or, in XML, lang attributes in the XML namespace p92 ). The examples below show uses of the i p187 element: <p>The <i class="taxonomy">Felis silvestris catus</i> is cute.</p> <p>The term <i>prose content</i> is defined above.</p> <p>There is a certain <i lang="fr">je ne sais quoi</i> in the air.</p> In the following example, a dream sequence is marked up using i p187 elements. <p>Raymond tried to sleep.</p> <p><i>The ship sailed away on Thursday</i>, he dreamt. <i>The ship had many people aboard, including a beautiful princess called Carey. He watched her, day-in, day-out, hoping she would notice him, but she never did.</i></p> <p><i>Finally one night he picked up the courage to speak with her</i></p> <p>Raymond woke with a start as the fire alarm rang out.</p> Authors can use the class p95 attribute on the i p187 element to identify why the element is being used, so that if the style of a particular use (e.g. dream sequences as opposed to taxonomic terms) is to be changed at a later date, the author doesn't have to go through the entire document (or series of related documents) annotating each use. Authors are encouraged to consider whether other elements might be more applicable than the i p187 element, for instance the em p175 element for marking up stress emphasis, or the dfn p180 element to mark up the defining instance of a term. Note: Style sheets can be used to format i p187 elements, just like any other element can be restyled. Thus, it is not the case that content in i p187 elements will necessarily be italicized.
188
The following example shows a use of the b p188 element to highlight key words without marking them up as important: <p>The <b>frobonitor</b> and <b>barbinator</b> components are fried.</p> In the following example, objects in a text adventure are highlighted as being special by use of the b p188 element. <p>You enter a small room. Your <b>sword</b> glows brighter. A <b>rat</b> scurries past the corner wall.</p> Another case where the b p188 element is appropriate is in marking up the lede (or lead) sentence or paragraph. The following example shows how a BBC article about kittens adopting a rabbit as their own could be marked up: <article> <h2>Kittens 'adopted' by pet rabbit</h2> <p><b class="lede">Six abandoned kittens have found an unexpected new mother figure a pet rabbit.</b></p> <p>Veterinary nurse Melanie Humble took the three-week-old kittens to her Aberdeen home.</p> [...] As with the i p187 element, authors can use the class p95 attribute on the b p188 element to identify why the element is being used, so that if the style of a particular use is to be changed at a later date, the author doesn't have to go through annotating each use. The b p188 element should be used as a last resort when no other element is more appropriate. In particular, headings should use the h1 p150 to h6 p150 elements, stress emphasis should use the em p175 element, importance should be denoted with the strong p176 element, and text marked or highlighted should use the mark p189 element. The following would be incorrect usage: <p><b>WARNING!</b> Do not frob the barbinator!</p> In the previous example, the correct element to use would have been strong p176 , not b p188 . Note: Style sheets can be used to format b p188 elements, just like any other element can be restyled. Thus, it is not the case that content in b p188 elements will necessarily be boldened.
</blockquote> <p lang="en-US">As we can tell from the <em>spelling</em> of the word, the person writing this quote is clearly not American.</p> Another example of the mark p189 element is highlighting parts of a document that are matching some search string. If someone looked at a document, and the server knew that the user was searching for the word "kitten", then the server might return the document with one paragraph modified as follows: <p>I also have some <mark>kitten</mark>s who are visiting me these days. They're really cute. I think they like my garden! Maybe I should adopt a <mark>kitten</mark>.</p> In the following snippet, a paragraph of text refers to a specific part of a code fragment. <p>The highlighted part below is where the error lies:</p> <pre><code>var i: Integer; begin i := <mark>1.1</mark>; end.</code></pre> This is separate from syntax highlighting, for which span p194 is more appropriate. Combining both, one would get: <p>The highlighted part below is where the error lies:</p> <pre><code><span class=keyword>var</span> <span class=ident>i</span>: <span class=type>Integer</span>; <span class=keyword>begin</span> <span class=ident>i</span> := <span class=literal><mark>1.1</mark></span>; <span class=keyword>end</span>.</code></pre> This is another example showing the use of mark p189 to highlight a part of quoted text that was originally not emphasized. In this example, common typographic conventions have led the author to explicitly style mark p189 elements in quotes to render in italics. <article> <style scoped> blockquote mark, q mark { font: inherit; font-style: italic; text-decoration: none; background: transparent; color: inherit; } .bubble em { font: inherit; font-size: larger; text-decoration: underline; } </style> <h1>She knew</h1> <p>Did you notice the subtle joke in the joke on panel 4?</p> <blockquote> <p class="bubble">I didn't <em>want</em> to believe. <mark>Of course on some level I realized it was a known-plaintext attack.</mark> But I couldn't admit it until I saw for myself.</p> </blockquote> <p>(Emphasis mine.) I thought that was great. It's so pedantic, yet it explains everything neatly.</p> </article> Note, incidentally, the distinction between the em p175 element in this example, which is part of the original text being quoted, and the mark p189 element, which is highlighting a part for comment. The following example shows the difference between denoting the importance of a span of text (strong p176 ) as opposed to denoting the relevance of a span of text (mark p189 ). It is an extract from a textbook, where the extract has had the parts relevant to the exam highlighted. The safety warnings, important though they may be, are apparently not relevant to the exam. <h3>Wormhole Physics Introduction</h3> <p><mark>A wormhole in normal conditions can be held open for a maximum of just under 39 minutes.</mark> Conditions that can increase the time include a powerful energy source coupled to one or both of the gates connecting the wormhole, and a large gravity well (such as a black hole).</p>
190
<p><mark>Momentum is preserved across the wormhole. Electromagnetic radiation can travel in both directions through a wormhole, but matter cannot.</mark></p> <p>When a wormhole is created, a vortex normally forms. <strong>Warning: The vortex caused by the wormhole opening will annihilate anything in its path.</strong> Vortexes can be avoided when using sufficiently advanced dialing technology.</p> <p><mark>An obstruction in a gate will prevent it from accepting a wormhole connection.</mark></p>
In this example, each ideograph in the traditional Chinese text is annotated with its bopomofo reading. <ruby><rt></rt><rt></rt></ruby> This might be rendered as:
In this example, each ideograph in the simplified Chinese text is annotated with its pinyin reading. ...<ruby><rt>hn</rt><rt>z </rt></ruby>...
191
192
193
Authors must specify the dir p93 attribute on this element, with the value ltr to specify a left-to-right override and with the value rtl to specify a right-to-left override. If the element has the dir p93 attribute set to the exact value ltr, then for the purposes of the bidirectional algorithm, the user agent must act as if there was a U+202D LEFT-TO-RIGHT OVERRIDE character at the start of the element, and a U+202C POP DIRECTIONAL FORMATTING at the end of the element. If the element has the dir p93 attribute set to the exact value rtl, then for the purposes of the bidirectional algorithm, the user agent must act as if there was a U+202E RIGHT-TO-LEFT OVERRIDE character at the start of the element, and a U+202C POP DIRECTIONAL FORMATTING at the end of the element. The requirements on handling the bdo p193 element for the bidirectional algorithm may be implemented indirectly through the style layer. For example, an HTML+CSS user agent could implement these requirements by implementing the CSS 'unicode-bidi' property. [CSS] p781
194
The br p194 element represents p708 a line break. Note: While line breaks are usually represented in visual media by physically moving subsequent text to a new line, a style sheet or user agent would be equally justified in causing line breaks to be rendered in a different manner, for instance as green dots, or as extra spacing. br p194 elements must be used only for line breaks that are actually part of the content, as in poems or addresses. The following example is correct usage of the br p194 element: <p>P. Sherman<br> 42 Wallaby Way<br> Sydney</p> br p194 elements must not be used for separating thematic groups in a paragraph. The following examples are non-conforming, as they abuse the br p194 element: <p><a ...>34 comments.</a><br> <a ...>Add a comment.</a></p> <p><label>Name: <input name="name"></label><br> <label>Address: <input name="address"></label></p> Here are alternatives to the above, which are correct: <p><a ...>34 comments.</a></p> <p><a ...>Add a comment.</a></p> <p><label>Name: <input name="name"></label></p> <p><label>Address: <input name="address"></label></p> If a paragraph p102 consists of nothing but a single br p194 element, it represents a placeholder blank line (e.g. as in a template). Such blank lines must not be used for presentation purposes. Any content inside br p194 elements must not be considered part of the surrounding text. Note: A br p194 element separates paragraphs for the purposes of the Unicode bidirectional algorithm. [BIDI] p781
195
Purpose Hyperlinks Stress emphasis Importance Side comments Inaccurate text Titles of works Quotations Defining instance Abbreviations Date and/or time Computer code Variables Computer output User input Subscripts Superscripts Alternative voice Keywords Highlight Ruby annotations Text directionality isolation Text directionality formatting Other Line break Line breaking opportunity
Example Visit my <a href="drinks.html">drinks</a> page. I must say I <em>adore</em> lemonade. This tea is <strong>very hot</strong>. These grapes are made into wine. <small>Alcohol is addictive.</small> Price: <s>4.50</s> 2.00! The case <cite>Hugo v. Danielle</cite> is relevant here. The judge said <q>You can drink water from the fish tank</q> but advised against it. The term <dfn>organic food</dfn> refers to food produced without synthetic chemicals. Organic food in Ireland is certified by the <abbr title="Irish Organic Farmers and Growers Association">IOFGA</abbr>. Published <time>2009-10-21</time>. The <code>fruitdb</code> program can be used for tracking fruit production. If there are <var>n</var> fruit in the bowl, at least <var>n</var>2 will be ripe. The computer said <samp>Unknown error -3</samp>. Hit <kbd>F1</kbd> to continue. Water is H<sub>2</sub>O. The Hydrogen in heavy water is usually <sup>2</sup>H. Lemonade consists primarily of <i>Citrus limon</i>. Take a <b>lemon</b> and squeeze it with a <b>juicer</b>. Elderflower cordial, with one <mark>part</mark> cordial to ten <mark>part</mark>s water, stands a<mark>part</mark> from the rest. <ruby> OJ <rp>(<rt>Orange Juice<rp>)</ruby> The recommended restaurant is <bdi lang="">My Juice Caf (At The Beach)</bdi>. The proposal is to write English, but in reverse order. "Juice" would become "<bdo dir=rtl>Juice</bdo>" In French we call it <span lang="fr">sirop de sureau</span>. Simply Orange Juice Company<br>Apopka, FL 32703<br>U.S.A. www.simply<wbr>orange<wbr>juice.com
cite p178 q p179 dfn p180 abbr p180 time p182 code p184 var p185 samp p186 kbd sub
p186 p187
sup p187 i p187 b p188 mark p189 ruby p191 , rt p192 , rp p192 bdi p193 bdo p193 span p194 br p194 wbr p195
4.7 Edits
The ins p196 and del p197 elements represent edits to the document.
</ins> </aside> As does this, because everything in the aside p148 element here counts as phrasing content p100 and therefore there is just one paragraph p102 : <aside> <ins> Apples are <em>tasty</em>. </ins> <ins> So are pears. </ins> </aside> ins p196 elements should not cross implied paragraph p102 boundaries. The following example represents the addition of two paragraphs, the second of which was inserted in two parts. The first ins p196 element in this example thus crosses a paragraph boundary, which is considered poor form. <aside> <!-- don't do this --> <ins datetime="2005-03-16T00:00Z"> <p> I like fruit. </p> Apples are <em>tasty</em>. </ins> <ins datetime="2007-12-19T00:00Z"> So are pears. </ins> </aside> Here is a better way of marking this up. It uses more elements, but none of the elements cross implied paragraph boundaries. <aside> <ins datetime="2005-03-16T00:00Z"> <p> I like fruit. </p> </ins> <ins datetime="2005-03-16T00:00Z"> Apples are <em>tasty</em>. </ins> <ins datetime="2007-12-19T00:00Z"> So are pears. </ins> </aside>
197
The following shows a "to do" list where items that have been done are crossed-off with the date and time of their completion. <h1>To Do</h1> <ul> <li>Empty the dishwasher</li> <li><del datetime="2009-10-11T01:25-07:00">Watch Walter Lewin's lectures</del></li> <li><del datetime="2009-10-10T23:38-07:00">Download more tracks</del></li> <li>Buy a printer</li> </ul>
<!-- (don't do this) --> </section> However, due to the way implied paragraphs p102 are defined, it is not possible to mark up the end of one paragraph and the start of the very next one using the same ins p196 or del p197 element. You instead have to use one (or two) p p160 element(s) and two ins p196 or del p197 elements, as for example: <section> <p>This is the first paragraph. <del>This sentence was deleted.</del></p> <p><del>This sentence was deleted too.</del> That sentence needed a separate <del> element.</p> </section> Partly because of the confusion described above, authors are strongly encouraged to always mark up all paragraphs with the p p160 element, instead of having ins p196 or del p197 elements that cross implied paragraphs p102 boundaries.
199
Contexts in which this element can be used: Where embedded content p101 is expected. Content model: Empty. Content attributes: Global attributes p90 alt p200 src p200 usemap p317 ismap p203 width p320 height p320 DOM interface: [NamedConstructor=Image(), NamedConstructor=Image(in unsigned long width), NamedConstructor=Image(in unsigned long width, in unsigned long height)] interface HTMLImageElement : HTMLElement { attribute DOMString alt; attribute DOMString src; attribute DOMString useMap; attribute boolean isMap; attribute unsigned long width; attribute unsigned long height; readonly attribute unsigned long naturalWidth; readonly attribute unsigned long naturalHeight; readonly attribute boolean complete; }; An img p199 element represents an image. The image given by the src attribute is the embedded content, and the value of the alt attribute is the img p199 element's fallback content p101 . The src p200 attribute must be present, and must contain a valid non-empty URL potentially surrounded by spaces p55 referencing a non-interactive, optionally animated, image resource that is neither paged nor scripted. Note: Images can thus be static bitmaps (e.g. PNGs, GIFs, JPEGs), single-page vector documents (single-page PDFs, XML files with an SVG root element), animated bitmaps (APNGs, animated GIFs), animated vector graphics (XML files with an SVG root element that use declarative SMIL animation), and so forth. However, this also precludes SVG files with script, multipage PDF files, interactive MNG files, HTML documents, plain text documents, and so forth. The requirements on the alt p200 attribute's value are described in the next section p205 . The img p199 must not be used as a layout tool. In particular, img p199 elements should not be used to display transparent images, as they rarely convey meaning and rarely add anything useful to the document. An img p199 is always in one of the following states: Unavailable The user agent hasn't obtained any image data. Partially available The user agent has obtained some of the image data. Completely available The user agent has obtained all of the image data. Broken The user agent has obtained all of the image data that it can, but it cannot decode the image (e.g. the image is corrupted, or the format is not supported, or no data could be obtained). When an img p199 element is either in the partially available p200 state or in the completely available p200 state, it is said to be available.
200
An img p199 element is initially unavailable p200 . User agents may obtain images immediately or on demand. A user agent that obtains images immediately must synchronously update the image data p201 of an img p199 element whenever that element is either created with a src p200 attribute, or has its src p200 attribute set, changed, or removed. A user agent that obtains images on demand must update the image data p201 of an img p199 element whenever it needs the image data (i.e. on demand), but only if the img p199 element has a src p200 attribute, and if it has not updated the image data p201 since the last time the src p200 attribute was set. When an img p199 element's src p200 attribute is changed or removed, if the user agent only obtains images on demand, the img p199 element must return to the unavailable p200 state. When the user agent is to update the image data of an img p199 element, it must run the following steps: 1. 2. Return the img p199 element to the unavailable p200 state. If an instance of the fetching p59 algorithm is still running for this element, then abort that algorithm, discarding any pending tasks p553 generated by that algorithm. Forget the img p199 element's current image data, if any. If the user agent cannot support images, or its support for images has been disabled, then abort these steps. If the element's src p200 attribute's value is the empty string, then set the element to the broken p200 state, queue a task p553 to fire a simple event p559 named error at the img p199 element, and abort these steps. Otherwise, resolve p55 the value of the element's src p200 attribute, relative to the element, and, if that is successful, fetch p59 that resource. The resouce obtained in this fashion is the img p199 element's image data. Fetching the image must delay the load event p687 of the element's document until the task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 (defined below p201 ) has been run. Warning! This, unfortunately, can be used to perform a rudimentary port scan of the user's local network (especially in conjunction with scripting, though scripting isn't actually necessary to carry out such an attack). User agents may implement cross-origin p510 access control policies that mitigate this attack, but unfortunately such policies are typically not compatible with existing Web content. Each task p553 that is queued p553 by the networking task source p554 while the image is being fetched p59 must set the img p199 element's state to partially available p200 and update the presentation of the image appropriately. The task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 must act as appropriate given the following alternatives: If the download was successful Set the img p199 element to the completely available p200 state, update the presentation of the image appropriately, and queue a task p553 to fire a simple event p559 named load at the img p199 element. Otherwise Set the img p199 element to the broken p200 state, and queue a task p553 to fire a simple event p559 named error at the img p199 element. If at any point the user agent discovers that the image data is corrupted in some fatal way, or that the image is not in a supported file format, then the user agent must set the img p199 element to the broken p200 state. If the fetching p59 algorithm is still running for this element, then the user agent must also abort that algorithm, discarding any pending tasks p553 generated by that algorithm, and then queue a task p553 to fire a simple event p559 named error at the img p199 element. When an img p199 element is in the completely available p200 state and the user agent can completely decode the media data without errors, then the img p199 element is said to be fully decodable. Whether the image is fetched successfully or not (e.g. whether the response code was a 2xx code or equivalent p61 ) must be ignored when determining the image's type and whether it is a valid image. Note: This allows servers to return images with error responses, and have them displayed.
3. 4.
5.
6.
201
The user agents should apply the image sniffing rules p61 to determine the type of the image, with the image's associated Content-Type headers p61 giving the official type. If these rules are not applied, then the type of the image must be the type given by the image's associated Content-Type headers p61 . User agents must not support non-image resources with the img p199 element (e.g. XML files whose root element is an HTML element). User agents must not run executable code (e.g. scripts) embedded in the image resource. User agents must only display the first page of a multipage resource (e.g. a PDF file). User agents must not allow the resource to act in an interactive fashion, but should honor any animation in the resource. This specification does not specify which image types are to be supported. The task source p553 for these tasks p553 is the DOM manipulation task source p554 . What an img p199 element represents depends on the src p200 attribute and the alt p200 attribute.
p200 attribute is set and the alt p200 attribute is set to the empty string If the src
The image is either decorative or supplemental to the rest of the content, redundant with some other information in the document. If the image is available p200 and the user agent is configured to display that image, then the element represents p708 the element's image data. Otherwise, the element represents p708 nothing, and may be omitted completely from the rendering. User agents may provide the user with a notification that an image is present but has been omitted from the rendering.
p200 attribute is set and the alt p200 attribute is set to a value that isn't empty If the src
The image is a key part of the content; the alt p200 attribute gives a textual equivalent or replacement for the image. If the image is available p200 and the user agent is configured to display that image, then the element represents p708 the element's image data. Otherwise, the element represents p708 the text given by the alt p200 attribute. User agents may provide the user with a notification that an image is present but has been omitted from the rendering.
p200 attribute is set and the alt p200 attribute is not If the src
The image might be a key part of the content, and there is no textual equivalent of the image available. Note: In a conforming document, the absence of the alt p200 attribute indicates that the image is a key part of the content but that a textual replacement for the image was not available when the image was generated. If the image is available p200 and the user agent is configured to display that image, then the element represents p708 the element's image data. Otherwise, the user agent should display some sort of indicator that there is an image that is not being rendered, and may, if requested by the user, or if so configured, or when required to provide contextual information in response to navigation, provide caption information for the image, derived as follows: 1. If the image has a title p92 attribute whose value is not the empty string, then the value of that attribute is the caption information; abort these steps. If the image is a descendant of a figure p170 element that has a child figcaption p172 element, and, ignoring the figcaption p172 element and its descendants, the figure p170 element has no text node descendants other than inter-element whitespace p98 , and no embedded content p101 descendant other than the img p199 element, then the contents of the first such figcaption p172 element are the caption information; abort these steps.
2.
p200 attribute is not set and either the alt p200 attribute is set to the empty string or the If the src p200 alt attribute is not set at all
The element represents p708 nothing. Otherwise The element represents p708 the text given by the alt p200 attribute. The alt p200 attribute does not represent advisory information. User agents must not present the contents of the alt p200 attribute in the same way as content of the title p92 attribute. User agents may always provide the user with the option to display any image, or to prevent any image from being displayed. User agents may also apply heuristics to help the user make use of the image when the user is unable to see it, e.g. due to a visual disability or because they are using a text terminal with no graphics
202
capabilities. Such heuristics could include, for instance, optical character recognition (OCR) of text found within the image. Warning! While user agents are encouraged to repair cases of missing alt p200 attributes, authors must not rely on such behavior. Requirements for providing text to act as an alternative for images p205 are described in detail below. The contents of img p199 elements, if any, are ignored for the purposes of rendering. The usemap p317 attribute, if present, can indicate that the image has an associated image map p317 . The ismap attribute, when used on an element that is a descendant of an a p173 element with an href p440 attribute, indicates by its presence that the element provides access to a server-side image map. This affects how events are handled on the corresponding a p173 element. The ismap p203 attribute is a boolean attribute p38 . The attribute must not be specified on an element that does not have an ancestor a p173 element with an href p440 attribute. The img p199 element supports dimension attributes p320 . The IDL attributes alt, src, useMap, and isMap each must reflect p62 the respective content attributes of the same name. This box is non-normative. Implementation requirements are given below this box. image . width p203 [ = value ] image . height p203 [ = value ] These attributes return the actual rendered dimensions of the image, or zero if the dimensions are not known. They can be set, to change the corresponding content attributes. image . naturalWidth p203 image . naturalHeight p203 These attributes return the intrinsic dimensions of the image, or zero if the dimensions are not known. image . complete p203 Returns true if the image has been completely downloaded or if no image is specified; otherwise, returns false. image = new Image p203 ( [ width [, height ] ] ) Returns a new img p199 element, with the width p320 and height p320 attributes set to the values passed in the relevant arguments, if applicable.
The IDL attributes width and height must return the rendered width and height of the image, in CSS pixels, if the image is being rendered p708 , and is being rendered to a visual medium; or else the intrinsic width and height of the image, in CSS pixels, if the image is available but not being rendered to a visual medium; or else 0, if the image is not available. [CSS] p781 On setting, they must act as if they reflected p62 the respective content attributes of the same name. The IDL attributes naturalWidth and naturalHeight must return the intrinsic width and height of the image, in CSS pixels, if the image is available, or else 0. [CSS] p781 The IDL attribute complete must return true if any of the following conditions is true: The src p200 attribute is omitted. The src p200 attribute's value is the empty string. The final task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 has been queued p553 , but has not yet been run, and the img p199 element is not in the broken p200 state. The img p199 element is completely available p200 .
Otherwise, the attribute must return false. Note: The value of complete p203 can thus change while a script p550 is executing. Three constructors are provided for creating HTMLImageElement p200 objects (in addition to the factory methods from DOM Core such as createElement()): Image(), Image(width), and Image(width, height). When invoked as constructors, these must return a new HTMLImageElement p200 object (a new img p199 element). If the width
203
argument is present, the new object's width p320 content attribute must be set to width. If the height argument is also present, the new object's height p320 content attribute must be set to height. The element's document must be the active document p499 of the browsing context p499 of the Window p503 object on which the interface object of the invoked constructor is found. A single image can have different appropriate alternative text depending on the context. In each of the following cases, the same image is used, yet the alt p200 text is different each time. The image is the coat of arms of the Carouge municipality in the canton Geneva in Switzerland. Here it is used as a supplementary icon: <p>I lived in <img src="carouge.svg" alt=""> Carouge.</p> Here it is used as an icon representing the town: <p>Home town: <img src="carouge.svg" alt="Carouge"></p> Here it is used as part of a text on the town: <p>Carouge has a coat of arms.</p> <p><img src="carouge.svg" alt="The coat of arms depicts a lion, sitting in front of a tree."></p> <p>It is used as decoration all over the town.</p> Here it is used as a way to support a similar text where the description is given as well as, instead of as an alternative to, the image: <p>Carouge has a coat of arms.</p> <p><img src="carouge.svg" alt=""></p> <p>The coat of arms depicts a lion, sitting in front of a tree. It is used as decoration all over the town.</p> Here it is used as part of a story: <p>He picked up the folder and a piece of paper fell out.</p> <p><img src="carouge.svg" alt="Shaped like a shield, the paper had a red background, a green tree, and a yellow lion with its tongue hanging out and whose tail was shaped like an S."></p> <p>He stared at the folder. S! The answer he had been looking for all this time was simply the letter S! How had he not seen that before? It all came together now. The phone call where Hector had referred to a lion's tail, the time Marco had stuck his tongue out...</p> Here it is not known at the time of publication what the image will be, only that it will be a coat of arms of some kind, and thus no replacement text can be provided, and instead only a brief caption for the image is provided, in the title p92 attribute: <p>The last user to have uploaded a coat of arms uploaded this one:</p> <p><img src="last-uploaded-coat-of-arms.cgi" title="User-uploaded coat of arms."></p> Ideally, the author would find a way to provide real replacement text even in this case, e.g. by asking the previous user. Not providing replacement text makes the document more difficult to use for people who are unable to view images, e.g. blind users, or users or very low-bandwidth connections or who pay by the byte, or users who are forced to use a text-only Web browser. Here are some more examples showing the same picture used in different contexts, with different appropriate alternate texts each time. <article> <h1>My cats</h1> <h2>Fluffy</h2> <p>Fluffy is my favorite.</p> <img src="fluffy.jpg" alt="She likes playing with a ball of yarn."> <p>She's just too cute.</p> <h2>Miles</h2> <p>My other cat, Miles just eats and sleeps.</p> </article> <article> <h1>Photography</h1> <h2>Shooting moving targets indoors</h2> <p>The trick here is to know how to anticipate; to know at what speed and what distance the subject will pass by.</p> <img src="fluffy.jpg" alt="A cat flying by, chasing a ball of yarn, can be photographed quite nicely using this technique.">
204
<h2>Nature by night</h2> <p>To achieve this, you'll need either an extremely sensitive film, or immense flash lights.</p> </article> <article> <h1>About me</h1> <h2>My pets</h2> <p>I've got a cat named Fluffy and a dog named Miles.</p> <img src="fluffy.jpg" alt="Fluffy, my cat, tends to keep itself busy."> <p>My dog Miles and I like go on long walks together.</p> <h2>music</h2> <p>After our walks, having emptied my mind, I like listening to Bach.</p> </article> <article> <h1>Fluffy and the Yarn</h1> <p>Fluffy was a cat who liked to play with yarn. He also liked to jump.</p> <aside><img src="fluffy.jpg" alt="" title="Fluffy"></aside> <p>He would play in the morning, he would play in the evening.</p> </article>
4.8.1.1 Requirements for providing text to act as an alternative for images 4.8.1.1.1 General guidelines Except where otherwise specified, the alt p200 attribute must be specified and its value must not be empty; the value must be an appropriate replacement for the image. The specific requirements for the alt p200 attribute depend on what the image is intended to represent, as described in the following sections. The most general rule to consider when writing alternative text is the following: the intent is that replacing every image with the text of its alt p200 attribute not change the meaning of the page. So, in general, alternative text can be written by considering what one would have written had one not been able to include the image. A corollary to this is that the alt p200 attribute's value should never contain text that could be considered the image's caption, title, or legend. It is supposed to contain replacement text that could be used by users instead of the image; it is not meant to supplement the image. The title p92 attribute can be used for supplemental information. Note: One way to think of alternative text is to think about how you would read the page containing the image to someone over the phone, without mentioning that there is an image present. Whatever you say instead of the image is typically a good start for writing the alternative text.
4.8.1.1.2 A link or button containing nothing but the image When an a p173 element that creates a hyperlink p440 , or a button p385 element, has no textual content but contains one or more images, the alt p200 attributes must contain text that together convey the purpose of the link or button. In this example, a user is asked to pick his preferred color from a list of three. Each color is given by an image, but for users who have configured their user agent not to display images, the color names are used instead: <h1>Pick your color</h1> <ul> <li><a href="green.html"><img src="green.jpeg" alt="Green"></a></li> <li><a href="blue.html"><img src="blue.jpeg" alt="Blue"></a></li> <li><a href="red.html"><img src="red.jpeg" alt="Red"></a></li> </ul> In this example, each button has a set of images to indicate the kind of color output desired by the user. The first image is used in each case to give the alternative text. <button name="rgb"><img src="red" alt="RGB"><img src="green" alt=""><img src="blue" alt=""></button> <button name="cmyk"><img src="cyan" alt="CMYK"><img src="magenta" alt=""><img src="yellow" alt=""><img src="black" alt=""></button> Since each image represents one part of the text, it could also be written like this:
205
<button name="rgb"><img src="red" alt="R"><img src="green" alt="G"><img src="blue" alt="B"></button> <button name="cmyk"><img src="cyan" alt="C"><img src="magenta" alt="M"><img src="yellow" alt="Y"><img src="black" alt="K"></button> However, with other alternative text, this might not work, and putting all the alternative text into one image in each case might make more sense: <button name="rgb"><img src="red" alt="sRGB profile"><img src="green" alt=""><img src="blue" alt=""></button> <button name="cmyk"><img src="cyan" alt="CMYK profile"><img src="magenta" alt=""><img src="yellow" alt=""><img src="black" alt=""></button>
4.8.1.1.3 A phrase or paragraph with an alternative graphical representation: charts, diagrams, graphs, maps, illustrations Sometimes something can be more clearly stated in graphical form, for example as a flowchart, a diagram, a graph, or a simple map showing directions. In such cases, an image can be given using the img p199 element, but the lesser textual version must still be given, so that users who are unable to view the image (e.g. because they have a very slow connection, or because they are using a text-only browser, or because they are listening to the page being read out by a hands-free automobile voice Web browser, or simply because they are blind) are still able to understand the message being conveyed. The text must be given in the alt p200 attribute, and must convey the same message as the image specified in the src p200 attribute. It is important to realize that the alternative text is a replacement for the image, not a description of the image. In the following example we have a flowchart in image form, with text in the alt p200 attribute rephrasing the flowchart in prose form: <p>In the common case, the data handled by the tokenization stage comes from the network, but it can also come from script.</p> <p><img src="images/parsing-model-overview.png" alt="The network passes data to the Tokenizer stage, which passes data to the Tree Construction stage. From there, data goes to both the DOM and to Script Execution. Script Execution is linked to the DOM, and, using document.write(), passes data to the Tokenizer."></p> Here's another example, showing a good solution and a bad solution to the problem of including an image in a description. First, here's the good solution. This sample shows how the alternative text should just be what you would have put in the prose if the image had never existed. <!-- This is the correct way to do things. --> <p> You are standing in an open field west of a house. <img src="house.jpeg" alt="The house is white, with a boarded front door."> There is a small mailbox here. </p> Second, here's the bad solution. In this incorrect way of doing things, the alternative text is simply a description of the image, instead of a textual replacement for the image. It's bad because when the image isn't shown, the text doesn't flow as well as in the first example. <!-- This is the wrong way to do things. --> <p> You are standing in an open field west of a house. <img src="house.jpeg" alt="A white house, with a boarded front door."> There is a small mailbox here. </p> Text such as "Photo of white house with boarded door" would be equally bad alternative text (though it could be suitable for the title p92 attribute or in the figcaption p172 element of a figure p170 with this image).
4.8.1.1.4 A short phrase or label with an alternative graphical representation: icons, logos A document can contain information in iconic form. The icon is intended to help users of visual browsers to recognize features at a glance.
206
In some cases, the icon is supplemental to a text label conveying the same meaning. In those cases, the alt p200 attribute must be present but must be empty. Here the icons are next to text that conveys the same meaning, so they have an empty alt p200 attribute: <nav> <p><a href="/help/"><img src="/icons/help.png" alt=""> Help</a></p> <p><a href="/configure/"><img src="/icons/configuration.png" alt=""> Configuration Tools</a></p> </nav> In other cases, the icon has no text next to it describing what it means; the icon is supposed to be selfexplanatory. In those cases, an equivalent textual label must be given in the alt p200 attribute. Here, posts on a news site are labeled with an icon indicating their topic. <body> <article> <header> <h1>Ratatouille wins <i>Best Movie of the Year</i> award</h1> <p><img src="movies.png" alt="Movies"></p> </header> <p>Pixar has won yet another <i>Best Movie of the Year</i> award, making this its 8th win in the last 12 years.</p> </article> <article> <header> <h1>Latest TWiT episode is online</h1> <p><img src="podcasts.png" alt="Podcasts"></p> </header> <p>The latest TWiT episode has been posted, in which we hear several tech news stories as well as learning much more about the iPhone. This week, the panelists compare how reflective their iPhones' Apple logos are.</p> </article> </body> Many pages include logos, insignia, flags, or emblems, which stand for a particular entity such as a company, organization, project, band, software package, country, or some such. If the logo is being used to represent the entity, e.g. as a page heading, the alt p200 attribute must contain the name of the entity being represented by the logo. The alt p200 attribute must not contain text like the word "logo", as it is not the fact that it is a logo that is being conveyed, it's the entity itself. If the logo is being used next to the name of the entity that it represents, then the logo is supplemental, and its alt p200 attribute must instead be empty. If the logo is merely used as decorative material (as branding, or, for example, as a side image in an article that mentions the entity to which the logo belongs), then the entry below on purely decorative images applies. If the logo is actually being discussed, then it is being used as a phrase or paragraph (the description of the logo) with an alternative graphical representation (the logo itself), and the first entry above applies. In the following snippets, all four of the above cases are present. First, we see a logo used to represent a company: <h1><img src="XYZ.gif" alt="The XYZ company"></h1> Next, we see a paragraph which uses a logo right next to the company name, and so doesn't have any alternative text: <article> <h2>News</h2> <p>We have recently been looking at buying the <img src="alpha.gif" alt=""> company, a small Greek company specializing in our type of product.</p> In this third snippet, we have a logo being used in an aside, as part of the larger article discussing the acquisition: <aside><p><img src="alpha-large.gif" alt=""></p></aside> <p>The company has had a good quarter, and our pie chart studies of their accounts suggest a much bigger blue slice than its green and orange slices, which is always a good sign.</p> </article>
207
Finally, we have an opinion piece talking about a logo, and the logo is therefore described in detail in the alternative text. <p>Consider for a moment their logo:</p> <p><img src="/images/logo" alt="It consists of a green circle with a green question mark centered inside it."></p> <p>How unoriginal can you get? I mean, oooooh, a question mark, how <em>revolutionary</em>, how utterly <em>ground-breaking</em>, I'm sure everyone will rush to adopt those specifications now! They could at least have tried for some sort of, I don't know, sequence of rounded squares with varying shades of green and bold white outlines, at least that would look good on the cover of a blue book.</p> This example shows how the alternative text should be written such that if the image isn't available, and the text is used instead, the text flows seamlessly into the surrounding text, as if the image had never been there in the first place.
4.8.1.1.5 Text that has been rendered to a graphic for typographical effect Sometimes, an image just consists of text, and the purpose of the image is not to highlight the actual typographic effects used to render the text, but just to convey the text itself. In such cases, the alt p200 attribute must be present but must consist of the same text as written in the image itself. Consider a graphic containing the text "Earth Day", but with the letters all decorated with flowers and plants. If the text is merely being used as a heading, to spice up the page for graphical users, then the correct alternative text is just the same text "Earth Day", and no mention need be made of the decorations: <h1><img src="earthdayheading.png" alt="Earth Day"></h1>
4.8.1.1.6 A graphical representation of some of the surrounding text In many cases, the image is actually just supplementary, and its presence merely reinforces the surrounding text. In these cases, the alt p200 attribute must be present but its value must be the empty string. In general, an image falls into this category if removing the image doesn't make the page any less useful, but including the image makes it a lot easier for users of visual browsers to understand the concept. A flowchart that repeats the previous paragraph in graphical form: <p>The network passes data to the Tokenizer stage, which passes data to the Tree Construction stage. From there, data goes to both the DOM and to Script Execution. Script Execution is linked to the DOM, and, using document.write(), passes data to the Tokenizer.</p> <p><img src="images/parsing-model-overview.png" alt=""></p> In these cases, it would be wrong to include alternative text that consists of just a caption. If a caption is to be included, then either the title p92 attribute can be used, or the figure p170 and figcaption p172 elements can be used. In the latter case, the image would in fact be a phrase or paragraph with an alternative graphical representation, and would thus require alternative text. <!-- Using the title="" attribute --> <p>The network passes data to the Tokenizer stage, which passes data to the Tree Construction stage. From there, data goes to both the DOM and to Script Execution. Script Execution is linked to the DOM, and, using document.write(), passes data to the Tokenizer.</p> <p><img src="images/parsing-model-overview.png" alt="" title="Flowchart representation of the parsing model."></p> <!-- Using <figure> and <figcaption> --> <p>The network passes data to the Tokenizer stage, which passes data to the Tree Construction stage. From there, data goes to both the DOM and to Script Execution. Script Execution is linked to the DOM, and, using document.write(), passes data to the Tokenizer.</p> <figure> <img src="images/parsing-model-overview.png" alt="The Network leads to the Tokenizer, which leads to the Tree Construction. The Tree
208
Construction leads to two items. The first is Script Execution, which leads via document.write() back to the Tokenizer. The second item from which Tree Construction leads is the DOM. The DOM is related to the Script Execution."> <figcaption>Flowchart representation of the parsing model.</figcaption> </figure> <!-- This is WRONG. Do not do this. Instead, do what the above examples do. --> <p>The network passes data to the Tokenizer stage, which passes data to the Tree Construction stage. From there, data goes to both the DOM and to Script Execution. Script Execution is linked to the DOM, and, using document.write(), passes data to the Tokenizer.</p> <p><img src="images/parsing-model-overview.png" alt="Flowchart representation of the parsing model."></p> <!-- Never put the image's caption in the alt="" attribute! --> A graph that repeats the previous paragraph in graphical form: <p>According to a study covering several billion pages, about 62% of documents on the Web in 2007 triggered the Quirks rendering mode of Web browsers, about 30% triggered the Almost Standards mode, and about 9% triggered the Standards mode.</p> <p><img src="rendering-mode-pie-chart.png" alt=""></p>
4.8.1.1.7 A purely decorative image that doesn't add any information In general, if an image is decorative but isn't especially page-specific, for example an image that forms part of a site-wide design scheme, the image should be specified in the site's CSS, not in the markup of the document. However, a decorative image that isn't discussed by the surrounding text but still has some relevance can be included in a page using the img p199 element. Such images are decorative, but still form part of the content. In these cases, the alt p200 attribute must be present but its value must be the empty string. Examples where the image is purely decorative despite being relevant would include things like a photo of the Black Rock City landscape in a blog post about an event at Burning Man, or an image of a painting inspired by a poem, on a page reciting that poem. The following snippet shows an example of the latter case (only the first verse is included in this snippet): <h1>The Lady of Shalott</h1> <p><img src="shalott.jpeg" alt=""></p> <p>On either side the river lie<br> Long fields of barley and of rye,<br> That clothe the wold and meet the sky;<br> And through the field the road run by<br> To many-tower'd Camelot;<br> And up and down the people go,<br> Gazing where the lilies blow<br> Round an island there below,<br> The island of Shalott.</p>
4.8.1.1.8 A group of images that form a single larger picture with no links When a picture has been sliced into smaller image files that are then displayed together to form the complete picture again, one of the images must have its alt p200 attribute set as per the relevant rules that would be appropriate for the picture as a whole, and then all the remaining images must have their alt p200 attribute set to the empty string. In the following example, a picture representing a company logo for XYZ Corp has been split into two pieces, the first containing the letters "XYZ" and the second with the word "Corp". The alternative text ("XYZ Corp") is all in the first image. <h1><img src="logo1.png" alt="XYZ Corp"><img src="logo2.png" alt=""></h1> In the following example, a rating is shown as three filled stars and two empty stars. While the alternative text could have been "", the author has instead decided to more helpfully give the rating in the form "3 out of 5". That is the alternative text of the first image, and the rest have blank alternative text. <p>Rating: <meter max=5 value=3><img src="1" alt="3 out of 5" ><img src="1" alt=""><img src="1" alt=""><img src="0" alt="" ><img src="0" alt=""></meter></p>
209
4.8.1.1.9 A group of images that form a single larger picture with links Generally, image maps p317 should be used instead of slicing an image for links. However, if an image is indeed sliced and any of the components of the sliced picture are the sole contents of links, then one image per link must have alternative text in its alt p200 attribute representing the purpose of the link. In the following example, a picture representing the flying spaghetti monster emblem, with each of the left noodly appendages and the right noodly appendages in different images, so that the user can pick the left side or the right side in an adventure. <h1>The Church</h1> <p>You come across a flying spaghetti monster. Which side of His Noodliness do you wish to reach out for?</p> <p><a href="?go=left" ><img src="fsm-left.png" alt="Left side. "></a ><img src="fsm-middle.png" alt="" ><a href="?go=right"><img src="fsm-right.png" alt="Right side."></a></p>
4.8.1.1.10 A key part of the content In some cases, the image is a critical part of the content. This could be the case, for instance, on a page that is part of a photo gallery. The image is the whole point of the page containing it. How to provide alternative text for an image that is a key part of the content depends on the image's provenance. The general case When it is possible for detailed alternative text to be provided, for example if the image is part of a series of screenshots in a magazine review, or part of a comic strip, or is a photograph in a blog entry about that photograph, text that can serve as a substitute for the image must be given as the contents of the alt p200 attribute. A screenshot in a gallery of screenshots for a new OS, with some alternative text: <figure> <img src="KDE%20Light%20desktop.png" alt="The desktop is blue, with icons along the left hand side in two columns, reading System, Home, K-Mail, etc. A window is open showing that menus wrap to a second line if they cannot fit in the window. The window has a list of icons along the top, with an address bar below it, a list of icons for tabs along the left edge, a status bar on the bottom, and two panes in the middle. The desktop has a bar at the bottom of the screen with a few buttons, a pager, a list of open applications, and a clock."> <figcaption>Screenshot of a KDE desktop.</figcaption> </figure> A graph in a financial report: <img src="sales.gif" title="Sales graph" alt="From 1998 to 2005, sales increased by the following percentages with each year: 624%, 75%, 138%, 40%, 35%, 9%, 21%"> Note that "sales graph" would be inadequate alternative text for a sales graph. Text that would be a good caption is not generally suitable as replacement text. Images that defy a complete description In certain cases, the nature of the image might be such that providing thorough alternative text is impractical. For example, the image could be indistinct, or could be a complex fractal, or could be a detailed topographical map. In these cases, the alt p200 attribute must contain some suitable alternative text, but it may be somewhat brief. Sometimes there simply is no text that can do justice to an image. For example, there is little that can be said to usefully describe a Rorschach inkblot test. However, a description, even if brief, is still better than nothing: <figure> <img src="/commons/a/a7/Rorschach1.jpg" alt="A shape with left-right symmetry with indistinct edges, with a small gap in the center, two larger gaps offset slightly from the center, with two similar gaps under them. The outline is wider in the top half than the bottom
210
half, with the sides extending upwards higher than the center, and the center extending below the sides."> <figcaption>A black outline of the first of the ten cards in the Rorschach inkblot test.</figcaption> </figure> Note that the following would be a very bad use of alternative text: <!-- This example is wrong. Do not copy it. --> <figure> <img src="/commons/a/a7/Rorschach1.jpg" alt="A black outline of the first of the ten cards in the Rorschach inkblot test."> <figcaption>A black outline of the first of the ten cards in the Rorschach inkblot test.</figcaption> </figure> Including the caption in the alternative text like this isn't useful because it effectively duplicates the caption for users who don't have images, taunting them twice yet not helping them any more than if they had only read or heard the caption once. Another example of an image that defies full description is a fractal, which, by definition, is infinite in detail. The following example shows one possible way of providing alternative text for the full view of an image of the Mandelbrot set. <img src="ms1.jpeg" alt="The Mandelbrot set appears as a cardioid with its cusp on the real axis in the positive direction, with a smaller bulb aligned along the same center line, touching it in the negative direction, and with these two shapes being surrounded by smaller bulbs of various sizes."> Images whose contents are not known In some unfortunate cases, there might be no alternative text available at all, either because the image is obtained in some automated fashion without any associated alternative text (e.g. a Webcam), or because the page is being generated by a script using user-provided images where the user did not provide suitable or usable alternative text (e.g. photograph sharing sites), or because the author does not himself know what the images represent (e.g. a blind photographer sharing an image on his blog). In such cases, the alt p200 attribute may be omitted, but one of the following conditions must be met as well: The title p92 attribute is present and has a non-empty value. The img p199 element is in a figure p170 element that contains a figcaption p172 element that contains content other than inter-element whitespace p98 , and, ignoring the figcaption p172 element and its descendants, the figure p170 element has no text node descendants other than interelement whitespace p98 , and no embedded content p101 descendant other than the img p199 element.
Note: Such cases are to be kept to an absolute minimum. If there is even the slightest possibility of the author having the ability to provide real alternative text, then it would not be acceptable to omit the alt p200 attribute. A photo on a photo-sharing site, if the site received the image with no metadata other than the caption, could be marked up as follows: <figure> <img src="1100670787_6a7c664aef.jpg"> <figcaption>Bubbles traveled everywhere with us.</figcaption> </figure> It would be better, however, if a detailed description of the important parts of the image obtained from the user and included on the page. A blind user's blog in which a photo taken by the user is shown. Initially, the user might not have any idea what the photo he took shows: <article> <h1>I took a photo</h1> <p>I went out today and took a photo!</p> <figure> <img src="photo2.jpeg"> <figcaption>A photograph taken blindly from my front porch.</figcaption> </figure> </article>
211
Eventually though, the user might obtain a description of the image from his friends and could then include alternative text: <article> <h1>I took a photo</h1> <p>I went out today and took a photo!</p> <figure> <img src="photo2.jpeg" alt="The photograph shows my hummingbird feeder hanging from the edge of my roof. It is half full, but there are no birds around. In the background, out-of-focus trees fill the shot. The feeder is made of wood with a metal grate, and it contains peanuts. The edge of the roof is wooden too, and is painted white with light blue streaks."> <figcaption>A photograph taken blindly from my front porch.</figcaption> </figure> </article> Sometimes the entire point of the image is that a textual description is not available, and the user is to provide the description. For instance, the point of a CAPTCHA image is to see if the user can literally read the graphic. Here is one way to mark up a CAPTCHA (note the title p92 attribute): <p><label>What does this image say? <img src="captcha.cgi?id=8934" title="CAPTCHA"> <input type=text name=captcha></label> (If you cannot see the image, you can use an <a href="?audio">audio</a> test instead.)</p> Another example would be software that displays images and asks for alternative text precisely for the purpose of then writing a page with correct alternative text. Such a page could have a table of images, like this: <table> <thead> <tr> <th> Image <th> Description <tbody> <tr> <td> <img src="2421.png" title="Image 640 by 100, filename 'banner.gif'"> <td> <input name="alt2421"> <tr> <td> <img src="2422.png" title="Image 200 by 480, filename 'ad3.gif'"> <td> <input name="alt2422"> </table> Notice that even in this example, as much useful information as possible is still included in the title p92 attribute. Note: Since some users cannot use images at all (e.g. because they have a very slow connection, or because they are using a text-only browser, or because they are listening to the page being read out by a hands-free automobile voice Web browser, or simply because they are blind), the alt p200 attribute is only allowed to be omitted rather than being provided with replacement text when no alternative text is available and none can be made available, as in the above examples. Lack of effort from the part of the author is not an acceptable reason for omitting the alt p200 attribute.
4.8.1.1.11 An image not intended for the user Generally authors should avoid using img p199 elements for purposes other than showing images. If an img p199 element is being used for purposes other than showing an image, e.g. as part of a service to count page views, then the alt p200 attribute must be the empty string. In such cases, the width p320 and height p320 attributes should both be set to zero.
4.8.1.1.12 An image in an e-mail or private document intended for a specific person who is known to be able to view images This section does not apply to documents that are publicly accessible, or whose target audience is not necessarily personally known to the author, such as documents on a Web site, e-mails sent to public mailing lists, or software documentation. When an image is included in a private communication (such as an HTML e-mail) aimed at a specific person who is known to be able to view images, the alt p200 attribute may be omitted. However, even in such cases it is strongly recommended that alternative text be included (as appropriate according to the kind of image involved, as
212
described in the above entries), so that the e-mail is still usable should the user use a mail client that does not support images, or should the document be forwarded on to other users whose abilities might not include easily seeing images.
4.8.1.1.13 Guidance for markup generators Markup generators (such as WYSIWYG authoring tools) should, wherever possible, obtain alternative text from their users. However, it is recognized that in many cases, this will not be possible. For images that are the sole contents of links, markup generators should examine the link target to determine the title of the target, or the URL of the target, and use information obtained in this manner as the alternative text. As a last resort, implementors should either set the alt p200 attribute to the empty string, under the assumption that the image is a purely decorative image that doesn't add any information but is still specific to the surrounding content, or omit the alt p200 attribute altogether, under the assumption that the image is a key part of the content. Markup generators should generally avoid using the image's own file name as the alternative text. Similarly, markup generators should avoid generating alternative text from any content that will be equally available to presentation user agents (e.g. Web browsers). Note: This is because once a page is generated, it will typically not be updated, whereas the browsers that later read the page can be updated by the user, therefore the browser is likely to have more up-to-date and finely-tuned heuristics than the markup generator did when generating the page.
4.8.1.1.14 Guidance for conformance checkers A conformance checker must report the lack of an alt p200 attribute as an error unless one of the conditions listed below applies: The title p92 attribute is present and has a non-empty value (as described above p211 ). The img p199 element is in a figure p170 element that satisfies the conditions described above p211 . The conformance checker has been configured to assume that the document is an e-mail or document intended for a specific person who is known to be able to view images. The document has a meta p122 element with a name p123 attribute whose value is an ASCII caseinsensitive p36 match for the string "generator p124 ". (This case does not represent a case where the document is conforming, only that the generator could not determine appropriate alternative text validators are required to not show an error in this case to discourage markup generators from including bogus alternative text purely in an attempt to silence validators.)
213
DOM interface: interface HTMLIFrameElement : HTMLElement { attribute DOMString src; attribute DOMString srcdoc; attribute DOMString name; [PutForwards=value] readonly attribute DOMSettableTokenList sandbox; attribute boolean seamless; attribute DOMString width; attribute DOMString height; readonly attribute Document contentDocument; readonly attribute WindowProxy contentWindow; }; The iframe p213 element represents p708 a nested browsing context p499 . The src attribute gives the address of a page that the nested browsing context p499 is to contain. The attribute, if present, must be a valid non-empty URL potentially surrounded by spaces p55 . The srcdoc attribute gives the content of the page that the nested browsing context p499 is to contain. The value of the attribute is the source of an iframe srcdoc document. For iframe p213 elements in HTML documents p77 , the attribute, if present, must have a value using the HTML syntax p613 that consists of the following syntactic components, in the given order: 1. 2. 3. 4. 5. Any number of comments p620 and space characters p37 . Optionally, a DOCTYPE p613 . Any number of comments p620 and space characters p37 . The root element, in the form of an html p116 element p614 . Any number of comments p620 and space characters p37 .
For iframe p213 elements in XML documents p77 , the attribute, if present, must have a value that matches the production labeled document p33 in the XML specification. [XML] p786 If the src p214 attribute and the srcdoc p214 attribute are both specified together, the srcdoc p214 attribute takes priority. This allows authors to provide a fallback URL p55 for legacy user agents that do not support the srcdoc p214 attribute. When an iframe p213 element is first inserted into a document p29 , the user agent must create a nested browsing context p499 , and then process the iframe attributes p214 for the first time. Whenever an iframe p213 element with a nested browsing context p499 has its srcdoc p214 attribute set, changed, or removed, the user agent must process the iframe attributes p214 . Similarly, whenever an iframe p213 element with a nested browsing context p499 but with no srcdoc p214 attribute specified has its src p214 attribute set, changed, or removed, the user agent must process the iframe attributes p214 . When the user agent is to process the iframe attributes, it must run the first appropriate steps from the following list:
p214 attribute is specified If the srcdoc
Navigate p520 the element's browsing context p499 to a resource whose Content-Type p61 is text/html p757 , whose URL p55 is about:srcdoc p56 , and whose data consists of the value of the attribute. The resulting Document p33 must be considered an iframe srcdoc document p214 .
p214 attribute is specified but the srcdoc p214 attribute is not If the src
1. 2. 3. 4.
If the value of the src p214 attribute is the empty string, jump to the empty step below. Resolve p55 the value of the src p214 attribute, relative to the iframe p213 element. If that is not successful, then jump to the empty step below. If the resulting absolute URL p56 is an ASCII case-insensitive p36 match for the string "about:blank p60 ", and the user agent is processing this iframe p213 's attributes for the first time, then jump to the empty step below. (In cases other than the first time, about:blank p60 is loaded normally.)
214
5.
Navigate p520 the element's browsing context p499 to the resulting absolute URL p56 .
Empty: When the steps above require the user agent to jump to the empty step, if the user agent is processing this iframe p213 's attributes for the first time, then the user agent must queue a task p553 to fire a simple event p559 named load at the iframe p213 element. (After jumping to this step, the above steps are not resumed.) Otherwise Queue a task p553 to fire a simple event p559 named load at the iframe p213 element. Any navigation p520 required of the user agent in the process the iframe attributes p214 algorithm must be completed with the iframe p213 element's document's browsing context p499 as the source browsing context p520 . Furthermore, if the browsing context p499 's session history p513 contained only one Document p33 when the process the iframe attributes p214 algorithm was invoked, and that was the about:blank p60 Document p33 created when the browsing context p499 was created, then any navigation p520 required of the user agent in that algorithm must be completed with replacement enabled p528 . Note: If, when the element is created, the srcdoc p214 attribute is not set, and the src p214 attribute is either also not set or set but its value cannot be resolved p55 , the browsing context will remain at the initial about:blank p60 page. Note: If the user navigates p520 away from this page, the iframe p213 's corresponding WindowProxy p510 object will proxy new Window p503 objects for new Document p33 objects, but the src p214 attribute will not change. Removing p29 an iframe p213 from a Document p33 does not cause its browsing context p499 to be discarded. Indeed, an iframe p213 's browsing context p499 can survive its original parent Document p33 if its iframe p213 is moved to another Document p33 . On the other hand, if an iframe p213 is removed p29 from a Document p33 and is then subsequently garbage collected, this will likely mean (in the absence of other references) that the child browsing context p499 's WindowProxy p510 object will become eligble for garbage collection, which will then lead to that browsing context p499 being discarded p508 , which will then lead to its Document p33 being discarded p508 also. This happens without notice to any scripts running in that Document p33 ; for example, no unload events are fired (the "unload a document p530 " steps are not run). Here a blog uses the srcdoc p214 attribute in conjunction with the sandbox p216 and seamless p218 attributes described below to provide users of user agents that support this feature with an extra layer of protection from script injection in the blog post comments: <article> <h1>I got my own magazine!</h1> <p>After much effort, I've finally found a publisher, and so now I have my own magazine! Isn't that awesome?! The first issue will come out in September, and we have articles about getting food, and about getting in boxes, it's going to be great!</p> <footer> <p>Written by <a href="/users/cap">cap</a>. <time pubdate>2009-08-21T23:32Z</time></p> </footer> <article> <footer> At <time pubdate>2009-08-21T23:35Z</time>, <a href="/users/ch">ch</a> writes: </footer> <iframe seamless sandbox srcdoc="<p>did you get a cover picture yet?"></iframe> </article> <article> <footer> At <time pubdate>2009-08-21T23:44Z</time>, <a href="/users/cap">cap</a> writes: </footer> <iframe seamless sandbox srcdoc="<p>Yeah, you can see it <a href="/ gallery?mode=cover&amp;page=1">in my gallery</a>."></iframe> </article> <article> <footer> At <time pubdate>2009-08-21T23:58Z</time>, <a href="/users/ch">ch</a> writes: </footer> <iframe seamless sandbox srcdoc="<p>hey that's earl's table. <p>you should get earl&amp;me on the next cover."></iframe> </article>
215
Notice the way that quotes have to be escaped (otherwise the sandbox p216 attribute would end prematurely), and the way raw ampersands (e.g. in URLs or in prose) mentioned in the sandboxed content have to be doubly escaped once so that the ampersand is preserved when originally parsing the sandbox p216 attribute, and once more to prevent the ampersand from being misinterpreted when parsing the sandboxed content. Note: In the HTML syntax p613 , authors need only remember to use U+0022 QUOTATION MARK characters (") to wrap the attribute contents and then to escape all U+0022 QUOTATION MARK (") and U+0026 AMPERSAND (&) characters, and to specify the sandbox p216 attribute, to ensure safe embedding of content. Note: Due to restrictions of the XML syntax, in XML the U+003C LESS-THAN SIGN character (<) needs to be escaped as well. In order to prevent attribute-value normalization, some of XML's whitespace characters specifically U+0009 CHARACTER TABULATION (HT), U+000A LINE FEED (LF), and U+000D CARRIAGE RETURN (CR) also need to be escaped. [XML] p786
The name attribute, if present, must be a valid browsing context name p502 . The given value is used to name the nested browsing context p499 . When the browsing context is created, if the attribute is present, the browsing context name p502 must be set to the value of this attribute; otherwise, the browsing context name p502 must be set to the empty string. Whenever the name p216 attribute is set, the nested browsing context p499 's name p502 must be changed to the new value. If the attribute is removed, the browsing context name p502 must be set to the empty string. When content loads in an iframe p213 , after any load events are fired within the content itself, the user agent must queue a task p553 to fire a simple event p559 named load at the iframe p213 element. When content whose URL p55 has the same origin p512 as the iframe p213 element's Document p33 fails to load (e.g. due to a DNS error, network error, or if the server returned a 4xx or 5xx status code or equivalent p61 ), then the user agent must queue a task p553 to fire a simple event p559 named error at the element instead. (This event does not fire for parse errors p620 , script errors, or any errors for cross-origin resources.) The task source p553 for these tasks p553 is the DOM manipulation task source p554 . Note: A load event is also fired at the iframe p213 element when it is created if no other data is loaded in it. When there is an active parser p82 in the iframe p213 , and when anything in the iframe p213 is delaying the load event p687 of the iframe p213 's browsing context p499 's active document p499 , the iframe p213 must delay the load event p687 of its document. Note: If, during the handling of the load event, the browsing context p499 in the iframe p213 is again navigated p520 , that will further delay the load event p687 .
The sandbox attribute, when specified, enables a set of extra restrictions on any content hosted by the iframe p213 . Its value must be an unordered set of unique space-separated tokens p53 that are ASCII case-insensitive p36 . The allowed values are allow-same-origin p217 , allow-top-navigation p217 , allow-forms p217 , and allow-scripts p217 . When the attribute is set, the content is treated as being from a unique origin p510 , forms and scripts are disabled, links are prevented from targeting other browsing contexts p499 , and plugins are disabled. The allow-sameorigin p217 keyword allows the content to be treated as being from the same origin instead of forcing it into a unique origin, the allow-top-navigation p217 keyword allows the content to navigate p520 its top-level browsing context p499 , and the allow-forms p217 and allow-scripts p217 keywords re-enable forms and scripts respectively (though scripts are still prevented from creating popups). Warning! Setting both the allow-scripts p217 and allow-same-origin p217 keywords together when the embedded page has the same origin p512 as the page containing the iframe p213 allows the embedded page to simply remove the sandbox p216 attribute. Warning! Sandboxing hostile content is of minimal help if an attacker can convince the user to just visit the hostile content directly, rather than in the iframe p213 . To limit the damage that can be caused by hostile HTML content, it should be served using the text/html-sandboxed p758 MIME type. While the sandbox p216 attribute is specified, the iframe p213 element's nested browsing context p499 must have the flags given in the following list set. In addition, any browsing contexts nested p499 within an iframe p213 , either directly or indirectly, must have all the flags set on them as were set on the iframe p213 's Document p33 's browsing context p499 when the iframe p213 's Document p33 was created.
216
The sandboxed navigation browsing context flag This flag prevents content from navigating browsing contexts other than the sandboxed browsing context itself p520 (or browsing contexts further nested inside it), and the top-level browsing context p499 (which is protected by the sandboxed top-level navigation browsing context flag p217 defined next). This flag also prevents content from creating new auxiliary browsing contexts p502 , e.g. using the target p440 attribute or the window.open() p506 method. The sandboxed top-level navigation browsing context flag, unless the sandbox p216 attribute's value, when split on spaces p53 , is found to have the allow-top-navigation keyword set This flag prevents content from navigating their top-level browsing context p520 . When the allow-top-navigation p217 is set, content can navigate its top-level browsing context p499 , but other browsing contexts p499 are still protected by the sandboxed navigation browsing context flag p217 defined above. The sandboxed plugins browsing context flag This flag prevents content from instantiating plugins p29 , whether using the embed element p220 , the object element p226 , the applet element p744 , or through navigation p526 of a nested browsing context p499 . The sandboxed seamless iframes flag This flag prevents content from using the seamless p218 attribute on descendant iframe p213 elements. Note: This prevents a page inserted using the allow-same-origin p217 keyword from using a CSS-selector-based method of probing the DOM of other pages on the same site (in particular, pages that contain user-sensitive information). The sandboxed origin browsing context flag, unless the sandbox p216 attribute's value, when split on spaces p53 , is found to have the allow-same-origin keyword set This flag forces content into a unique origin p511 , thus preventing it from accessing other content from the same origin p510 . This flag also prevents script from reading from or writing to the document.cookie IDL attribute p80 , and blocks access to localStorage. [WEBSTORAGE] p785 The allow-same-origin p217 attribute is intended for two cases. First, it can be used to allow content from the same site to be sandboxed to disable scripting, while still allowing access to the DOM of the sandboxed content. Second, it can be used to embed content from a third-party site, sandboxed to prevent that site from opening popup windows, etc, without preventing the embedded page from communicating back to its originating site, using the database APIs to store data, etc. The sandboxed forms browsing context flag, unless the sandbox p216 attribute's value, when split on spaces p53 , is found to have the allow-forms keyword set This flag blocks form submission p417 . The sandboxed scripts browsing context flag, unless the sandbox p216 attribute's value, when split on spaces p53 , is found to have the allow-scripts keyword set This flag blocks script execution p550 . The sandboxed automatic features browsing context flag, unless the sandbox p216 attribute's value, when split on spaces p53 , is found to have the allow-scripts p217 keyword (defined above) set This flag blocks features that trigger automatically, such as automatically playing a video p249 or automatically focusing a form control p409 . It is relaxed by the same flag as scripts, because when scripts are enabled these features are trivially possible anyway, and it would be unfortunate to force authors to use script to do them when sandboxed rather than allowing them to use the declarative features. These flags must not be set unless the conditions listed above define them as being set. Warning! These flags only take effect when the nested browsing context p499 of the iframe p213 is navigated p520 . Removing them, or removing the entire sandbox p216 attribute, has no effect on an already-loaded page. In this example, some completely-unknown, potentially hostile, user-provided HTML content is embedded in a page. Because it is sandboxed, it is treated by the user agent as being from a unique origin, despite the content being served from the same site. Thus it is affected by all the normal cross-site restrictions. In addition, the embedded page has scripting disabled, plugins disabled, forms disabled, and it cannot navigate any frames or windows other than itself (or any frames or windows it itself embeds).
217
<p>We're not scared of you! Here is your content, unedited:</p> <iframe sandbox src="getusercontent.cgi?id=12193"></iframe> Note that cookies are still sent to the server in the getusercontent.cgi request, though they are not visible in the document.cookie p80 IDL attribute. Warning! It is important that the server serve the user-provided HTML using the text/htmlsandboxed p758 MIME type so that if the attacker convinces the user to visit that page directly, the page doesn't run in the context of the site's origin, which would make the user vulnerable to any attack found in the page. In this example, a gadget from another site is embedded. The gadget has scripting and forms enabled, and the origin sandbox restrictions are lifted, allowing the gadget to communicate with its originating server. The sandbox is still useful, however, as it disables plugins and popups, thus reducing the risk of the user being exposed to malware and other annoyances. <iframe sandbox="allow-same-origin allow-forms allow-scripts" src="http://maps.example.com/embedded.html"></iframe> Suppose a file A contained the following fragment: <iframe sandbox="allow-same-origin allow-forms" src=B></iframe> Suppose that file B contained an iframe also: <iframe sandbox="allow-scripts" src=C></iframe> Further, suppose that file C contained a link: <a href=D>Link</a> For this example, suppose all the files were served as text/html p757 . Page C in this scenario has all the sandboxing flags set. Scripts are disabled, because the iframe p213 in A has scripts disabled, and this overrides the allow-scripts p217 keyword set on the iframe p213 in B. Forms are also disabled, because the inner iframe p213 (in B) does not have the allow-forms p217 keyword set. Suppose now that a script in A removes all the sandbox p216 attributes in A and B. This would change nothing immediately. If the user clicked the link in C, loading page D into the iframe p213 in B, page D would now act as if the iframe p213 in B had the allow-same-origin p217 and allow-forms p217 keywords set, because that was the state of the nested browsing context p499 in the iframe p213 in A when page B was loaded. Generally speaking, dynamically removing or changing the sandbox p216 attribute is ill-advised, because it can make it quite hard to reason about what will be allowed and what will not. Note: Potentially hostile files can be served from the same server as the file containing the iframe p213 element by labeling them as text/html-sandboxed p758 instead of text/html p757 . This ensures that scripts in the files are unable to attack the site (as if they were actually served from another server), even if the user is tricked into visiting those pages directly, without the protection of the sandbox p216 attribute. Warning! If the allow-scripts p217 keyword is set along with allow-same-origin p217 keyword, and the file is from the same origin p512 as the iframe p213 's Document p33 , then a script in the "sandboxed" iframe could just reach out, remove the sandbox p216 attribute, and then reload itself, effectively breaking out of the sandbox altogether. The seamless attribute is a boolean attribute p38 . When specified, it indicates that the iframe p213 element's browsing context p499 is to be rendered in a manner that makes it appear to be part of the containing document (seamlessly included in the parent document). Specifically, when the attribute is set on an iframe p213 element whose owner Document p33 's browsing context p499 did not have the sandboxed seamless iframes flag p217 set when that Document p33 was created, and while either the browsing context p499 's active document p499 has the same origin p512 as the iframe p213 element's document, or the browsing context p499 's active document p499 's address p77 has the same origin p512 as the iframe p213 element's document, or the browsing context p499 's active document p499 is an iframe srcdoc document p214 , the following requirements apply: The user agent must set the seamless browsing context flag to true for that browsing context p499 . This will cause links to open in the parent browsing context p521 unless an explicit self-navigation override p502 is used (target="_self"). In a CSS-supporting user agent: the user agent must add all the style sheets that apply to the iframe p213 element to the cascade of the active document p499 of the iframe p213 element's nested browsing context p499 , at the appropriate cascade levels, before any style sheets specified by the document itself.
218
In a CSS-supporting user agent: the user agent must, for the purpose of CSS property inheritance only, treat the root element of the active document p499 of the iframe p213 element's nested browsing context p499 as being a child of the iframe p213 element. (Thus inherited properties on the root element of the document in the iframe p213 will inherit the computed values of those properties on the iframe p213 element instead of taking their initial values.) In visual media, in a CSS-supporting user agent: the user agent should set the intrinsic width of the iframe p213 to the width that the element would have if it was a non-replaced block-level element with 'width: auto'. In visual media, in a CSS-supporting user agent: the user agent should set the intrinsic height of the iframe p213 to the height of the bounding box around the content rendered in the iframe p213 at its current width (as given in the previous bullet point), as it would be if the scrolling position was such that the top of the viewport for the content rendered in the iframe p213 was aligned with the origin of that content's canvas. In visual media, in a CSS-supporting user agent: the user agent must force the height of the initial containing block of the active document p499 of the nested browsing context p499 of the iframe p213 to zero. Note: This is intended to get around the otherwise circular dependency of percentage dimensions that depend on the height of the containing block, thus affecting the height of the document's bounding box, thus affecting the height of the viewport, thus affecting the size of the initial containing block.
In speech media, the user agent should render the nested browsing context p499 without announcing that it is a separate document. User agents should, in general, act as if the active document p499 of the iframe p213 's nested browsing context p499 was part of the document that the iframe p213 is in, if any. For example if the user agent supports listing all the links in a document, links in "seamlessly" nested documents would be included in that list without being significantly distinguished from links in the document itself.
If the attribute is not specified, or if the origin p510 conditions listed above are not met, then the user agent should render the nested browsing context p499 in a manner that is clearly distinguishable as a separate browsing context p499 , and the seamless browsing context flag p218 must be set to false for that browsing context p499 . Warning! It is important that user agents recheck the above conditions whenever the active document p499 of the nested browsing context p499 of the iframe p213 changes, such that the seamless browsing context flag p218 gets unset if the nested browsing context p499 is navigated p520 to another origin. Note: The attribute can be set or removed dynamically, with the rendering updating in tandem. In this example, the site's navigation is embedded using a client-side include using an iframe p213 . Any links in the iframe p213 will, in new user agents, be automatically opened in the iframe p213 's parent browsing context; for legacy user agents, the site could also include a base p118 element with a target p119 attribute with the value _parent. Similarly, in new user agents the styles of the parent page will be automatically applied to the contents of the frame, but to support legacy user agents authors might wish to include the styles explicitly. <nav><iframe seamless src="nav.include.html"></iframe></nav> The iframe p213 element supports dimension attributes p320 for cases where the embedded content has specific dimensions (e.g. ad units have well-defined dimensions). An iframe p213 element never has fallback content p101 , as it will always create a nested browsing context p499 , regardless of whether the specified initial contents are successfully used. Descendants of iframe p213 elements represent nothing. (In legacy user agents that do not support iframe p213 elements, the contents would be parsed as markup that could act as fallback content.) When used in HTML documents p77 , the allowed content model of iframe p213 elements is text, except that invoking the HTML fragment parsing algorithm p696 with the iframe p213 element as the context element and the text contents as the input must result in a list of nodes that are all phrasing content p100 , with no parse errors p620 having occurred, with no script p133 elements being anywhere in the list or as descendants of elements in the list, and with all the elements in the list (including their descendants) being themselves conforming. The iframe p213 element must be empty in XML documents p77 .
219
Note: The HTML parser p620 treats markup inside iframe p213 elements as text. The IDL attributes src, srcdoc, name, sandbox, and seamless must reflect p62 the respective content attributes of the same name. The contentDocument IDL attribute must return the Document p33 object of the active document p499 of the iframe p213 element's nested browsing context p499 . The contentWindow IDL attribute must return the WindowProxy p510 object of the iframe p213 element's nested browsing context p499 . Here is an example of a page using an iframe p213 to include advertising from an advertising broker: <iframe src="http://ads.example.com/?customerid=923513721&format=banner" width="468" height="60"></iframe>
220
the embed p220 element's Document p33 was parsed from a resource whose sniffed type p61 as determined during navigation p520 is text/html-sandboxed p758
...then the user agent must render the embed p220 element in a manner that conveys that the plugin p29 was disabled. The user agent may offer the user the option to override the sandbox and instantiate the plugin p29 anyway; if the user invokes such an option, the user agent must act as if the conditions above did not apply for the purposes of this element. Warning! Plugins are disabled in sandboxed browsing contexts because they might not honor the restrictions imposed by the sandbox (e.g. they might allow scripting even when scripting in the sandbox is disabled). User agents should convey the danger of overriding the sandbox to the user if an option to do so is provided. An embed p220 element is said to be potentially active when the following conditions are all met simultaneously: The element is in a Document p29 . The element's Document p33 is fully active p500 . The element has either a src p220 attribute set or a type p220 attribute set (or both). The element's src p220 attribute is either absent or its value is the empty string. The element is not in a Document p33 whose browsing context p499 had the sandboxed plugins browsing context flag p217 set when the Document p33 was created (unless this has been overridden as described above). The element's Document p33 was not parsed from a resource whose sniffed type p61 as determined during navigation p520 is text/html-sandboxed p758 (unless this has been overridden as described above). The element is not a descendant of a media element p235 . The element is not a descendant of an object p222 element that is not showing its fallback content p101 .
Whenever an embed p220 element that was not potentially active p221 becomes potentially active p221 , and whenever a potentially active p221 embed p220 element's src p220 attribute is set, changed, or removed, and whenever a potentially active p221 embed p220 element's type p220 attribute is set, changed, or removed, the appropriate set of steps from the following is then applied:
p220 attribute set If the element has a src
The user agent must resolve p55 the value of the element's src p220 attribute, relative to the element. If that is successful, the user agent should fetch p59 the resulting absolute URL p56 , from the element's browsing context scope origin p501 if it has one. The task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 must find and instantiate an appropriate plugin p29 based on the content's type p221 , and hand that plugin p29 the content of the resource, replacing any previously instantiated plugin for the element. Fetching the resource must delay the load event p687 of the element's document.
p220 attribute set If the element has no src
The user agent should find and instantiate an appropriate plugin p29 based on the value of the type p220 attribute. Whenever an embed p220 element that was potentially active p221 stops being potentially active p221 , any plugin p29 that had been instantiated for that element must be unloaded. Note: The embed p220 element is unaffected by the CSS 'display' property. The selected plugin is instantiated even if the element is hidden with a 'display:none' CSS style. The type of the content being embedded is defined as follows: 1. If the element has a type p220 attribute, and that attribute's value is a type that a plugin p29 supports, then the value of the type p220 attribute is the content's type p221 . Otherwise, if the <path> p55 component of the URL p55 of the specified resource (after any redirects) matches a pattern that a plugin p29 supports, then the content's type p221 is the type that that plugin can handle. For example, a plugin might say that it can handle resources with <path> p55 components that end with the four character string ".swf". 3. Otherwise, if the specified resource has explicit Content-Type metadata p61 , then that is the content's type p221 . Otherwise, the content has no type and there can be no appropriate plugin p29 for it.
2.
4.
The embed p220 element has no fallback content p101 . If the user agent can't find a suitable plugin, then the user agent must use a default plugin. (This default could be as simple as saying "Unsupported Format".)
221
Whether the resource is fetched successfully or not (e.g. whether the response code was a 2xx code or equivalent p61 ) must be ignored when determining the resource's type and when handing the resource to the plugin. Note: This allows servers to return data for plugins even with error responses (e.g. HTTP 500 Internal Server Error codes can still contain plugin data). Any namespace-less attribute other than name p741 , align p743 , hspace p743 , and vspace p743 may be specified on the embed p220 element, so long as its name is XML-compatible p29 and contains no characters in the range U+0041 to U+005A (LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z). These attributes are then passed as parameters to the plugin p29 . Note: All attributes in HTML documents p77 get lowercased automatically, so the restriction on uppercase letters doesn't affect such documents. Note: The four exceptions are to exclude legacy attributes that have side-effects beyond just sending parameters to the plugin p29 . The user agent should pass the names and values of all the attributes of the embed p220 element that have no namespace to the plugin p29 used, when it is instantiated. If the plugin p29 instantiated for the embed p220 element supports a scriptable interface, the HTMLEmbedElement p220 object representing the element should expose that interface while the element is instantiated. The embed p220 element supports dimension attributes p320 . The IDL attributes src and type each must reflect p62 the respective content attributes of the same name. Here's a way to embed a resource that requires a proprietary plug-in, like Flash: <embed src="catgame.swf"> If the user does not have the plug-in (for example if the plug-in vendor doesn't support the user's platform), then the user will be unable to use the resource. To pass the plugin a parameter "quality" with the value "high", an attribute can be specified: <embed src="catgame.swf" quality="high"> This would be equivalent to the following, when using an object p222 element instead: <object data="catgame.swf"> <param name="quality" value="high"> </object>
222
DOM interface: interface HTMLObjectElement : HTMLElement { attribute DOMString data; attribute DOMString type; attribute DOMString name; attribute DOMString useMap; readonly attribute HTMLFormElement form; attribute DOMString width; attribute DOMString height; readonly attribute Document contentDocument; readonly attribute WindowProxy contentWindow; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); }; Depending on the type of content instantiated by the object p222 element, the node also supports other interfaces. The object p222 element can represent an external resource, which, depending on the type of the resource, will either be treated as an image, as a nested browsing context p499 , or as an external resource to be processed by a plugin p29 . The data attribute, if present, specifies the address of the resource. If present, the attribute must be a valid nonempty URL potentially surrounded by spaces p55 . The type attribute, if present, specifies the type of the resource. If present, the attribute must be a valid MIME type p28 . At least one of either the data p223 attribute or the type p223 attribute must be present. The name attribute, if present, must be a valid browsing context name p502 . The given value is used to name the nested browsing context p499 , if applicable. When the element is created, when it is popped off the stack of open elements p629 of an HTML parser p620 or XML parser p705 , and subsequently whenever the element is inserted into a document p29 or removed from a document p29 ; and whenever the element's Document p33 changes whether it is fully active p500 ; and whenever an ancestor object p222 element changes to or from showing its fallback content p101 ; and whenever the element's classid p741 attribute is set, changed, or removed; and, when its classid p741 attribute is not present, whenever its data p223 attribute is set, changed, or removed; and, when neither its classid p741 attribute nor its data p223 attribute are present, whenever its type p223 attribute is set, changed, or removed: the user agent must queue a task p553 to run the following steps to (re)determine what the object p222 element represents. The task source p553 for this task p553 is the DOM manipulation task source p554 . 1. If the user has indicated a preference that this object p222 element's fallback content p101 be shown instead of the element's usual behavior, then jump to the last step in the overall set of steps (fallback). Note: For example, a user could ask for the element's fallback content p101 to be shown because that content uses a format that the user finds more accessible. 2. If the element has an ancestor media element p235 , or has an ancestor object p222 element that is not showing its fallback content p101 , or if the element is not in a Document p29 with a browsing context p499 , or if the element's Document p33 is not fully active p500 , or if the element is still in the stack of open elements p629 of an HTML parser p620 or XML parser p705 , then jump to the last step in the overall set of steps (fallback). If the classid p741 attribute is present, and has a value that isn't the empty string, then: if the user agent can find a plugin p29 suitable according to the value of the classid p741 attribute, and plugins aren't being sandboxed p226 , then that plugin p29 should be used p226 , and the value of the data p223 attribute, if any, should be passed to the plugin p29 . If no suitable plugin p29 can be found, or if the plugin p29 reports an error, jump to the last step in the overall set of steps (fallback). If the data p223 attribute is present and its value is not the empty string, then:
3.
4.
223
1.
If the type p223 attribute is present and its value is not a type that the user agent supports, and is not a type that the user agent can find a plugin p29 for, then the user agent may jump to the last step in the overall set of steps (fallback) without fetching the content to examine its real type. Resolve p55 the URL p55 specified by the data p223 attribute, relative to the element. If that failed, fire a simple event p559 named error at the element, then jump to the last step in the overall set of steps (fallback). Fetch p59 the resulting absolute URL p56 , from the element's browsing context scope origin p501 if it has one. Fetching the resource must delay the load event p687 of the element's document until the task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 (defined next) has been run.
2. 3.
4.
5.
If the resource is not yet available (e.g. because the resource was not available in the cache, so that loading the resource required making a request over the network), then jump to the last step in the overall set of steps (fallback). The task p553 that is queued p553 by the networking task source p554 once the resource is available must restart this algorithm from this step. Resources can load incrementally; user agents may opt to consider a resource "available" whenever enough data has been obtained to begin processing the resource. If the load failed (e.g. there was an HTTP 404 error, there was a DNS error), fire a simple event p559 named error at the element, then jump to the last step in the overall set of steps (fallback). Determine the resource type, as follows: 1. 2. Let the resource type be unknown. If the user agent is configured to strictly obey Content-Type headers for this resource, and the resource has associated Content-Type metadata p61 , then let the resource type be the type specified in the resource's Content-Type metadata p61 , and jump to the step below labeled handler. If there is a type p223 attribute present on the object p222 element, and that attribute's value is not a type that the user agent supports, but it is a type that a plugin p29 supports, then let the resource type be the type specified in that type p223 attribute, and jump to the step below labeled handler. Run the approprate set of steps from the following list:
p61 The resource has associated Content-Type metadata
6.
7.
3.
4.
1. 2.
Let binary be false. If the type specified in the resource's Content-Type metadata p61 is "text/plain", and the result of applying the rules for distingushing if a resource is text or binary p61 to the resource is that the resource is not text/plain, then set binary to true. If the type specified in the resource's Content-Type metadata p61 is "application/octet-stream", then set binary to true. If binary is false, then let the resource type be the type specified in the resource's Content-Type metadata p61 , and jump to the step below labeled handler. If there is a type p223 attribute present on the object p222 element, and its value is not application/octet-stream, then run the following steps: 1. If the attribute's value is a type that a plugin p29 supports, or the attribute's value is a type that starts with "image/" that is not also an XML MIME type p29 , then let the resource type be the type specified in that type p223 attribute. Jump to the step below labeled handler.
3.
4.
5.
2.
224
1.
If there is a type p223 attribute present on the object p222 element, then let the tentative type be the type specified in that type p223 attribute. Otherwise, let tentative type be the sniffed type of the resource p61 .
2.
If tentative type is not application/octet-stream, then let resource type be tentative type and jump to the step below labeled handler.
5.
If the <path> p55 component of the URL p55 of the specified resource (after any redirects) matches a pattern that a plugin p29 supports, then let resource type be the type that that plugin can handle. For example, a plugin might say that it can handle resources with <path> p55 components that end with the four character string ".swf".
Note: It is possible for this step to finish with resource type still being unknown, or for one of the substeps above to jump straight to the next step. In both cases, the next step will trigger fallback. 8. Handler: Handle the content as given by the first of the following cases that matches: If the resource type is not a type that the user agent supports, but it is a type that a plugin p29 supports If plugins are being sandboxed p226 , jump to the last step in the overall set of steps (fallback). Otherwise, the user agent should use the plugin that supports resource type p226 and pass the content of the resource to that plugin p29 . If the plugin p29 reports an error, then jump to the last step in the overall set of steps (fallback).
p29 If the resource type is an XML MIME type , or if the resource type does not start with "image/"
The object p222 element must be associated with a newly created nested browsing context p499 , if it does not already have one. If the URL p55 of the given resource is not about:blank p60 , the element's nested browsing context p499 must then be navigated p520 to that resource, with replacement enabled p528 , and with the object p222 element's document's browsing context p499 as the source browsing context p520 . (The data p223 attribute of the object p222 element doesn't get updated if the browsing context gets further navigated to other locations.) If the URL p55 of the given resource is about:blank p60 , then, instead, the user agent must queue a task p553 to fire a simple event p559 named load at the object p222 element. The object p222 element represents p708 the nested browsing context p499 . If the name p223 attribute is present, the browsing context name p502 must be set to the value of this attribute; otherwise, the browsing context name p502 must be set to the empty string. Note: It's possible that the navigation p520 of the browsing context p499 will actually obtain the resource from a different application cache p533 . Even if the resource is then found to have a different type, it is still used as part of a nested browsing context p499 ; this algorithm doesn't restart with the new resource. If the resource type starts with "image/", and support for images has not been disabled Apply the image sniffing p61 rules to determine the type of the image. The object p222 element represents p708 the specified image. The image is not a nested browsing context p499 .
225
If the image cannot be rendered, e.g. because it is malformed or in an unsupported format, jump to the last step in the overall set of steps (fallback). Otherwise The given resource type is not supported. Jump to the last step in the overall set of steps (fallback). Note: If the previous step ended with the resource type being unknown, this is the case that is triggered. 9. 10. The element's contents are not part of what the object p222 element represents. Once the resource is completely loaded, queue a task p553 to fire a simple event p559 named load at the element. The task source p553 for this task is the DOM manipulation task source p554 . 5. If the data p223 attribute is absent but the type p223 attribute is present, plugins aren't being sandboxed p226 , and the user agent can find a plugin p29 suitable according to the value of the type p223 attribute, then that plugin p29 should be used p226 . If no suitable plugin p29 can be found, or if the plugin p29 reports an error, jump to the next step (fallback). (Fallback.) The object p222 element represents p708 the element's children, ignoring any leading param p227 element children. This is the element's fallback content p101 . If the element has an instantiated plugin p29 , then unload it.
6.
When the algorithm above instantiates a plugin p29 , the user agent should pass to the plugin p29 used the names and values of all the attributes on the element, in the order they were added to the element, with the attributes added by the parser being ordered in source order, followed by a parameter named "PARAM" whose value is null, followed by all the names and values of parameters p228 given by param p227 elements that are children of the object p222 element, in tree order p29 . If the plugin p29 supports a scriptable interface, the HTMLObjectElement p223 object representing the element should expose that interface. The object p222 element represents p708 the plugin p29 . The plugin p29 is not a nested browsing context p499 . If either: the sandboxed plugins browsing context flag p217 was set on the object p222 element's Document p33 's browsing context p499 when the Document p33 was created, or the object p222 element's Document p33 was parsed from a resource whose sniffed type p61 as determined during navigation p520 is text/html-sandboxed p758
...then the steps above must always act as if they had failed to find a plugin p29 , even if one would otherwise have been used. Note: The above algorithm is independent of CSS properties (including 'display', 'overflow', and 'visibility'). For example, it runs even if the element is hidden with a 'display:none' CSS style, and does not run again if the element's visibility changes. Due to the algorithm above, the contents of object p222 elements act as fallback content p101 , used only when referenced resources can't be shown (e.g. because it returned a 404 error). This allows multiple object p222 elements to be nested inside each other, targeting multiple user agents with different capabilities, with the user agent picking the first one it supports. Whenever the name p223 attribute is set, if the object p222 element has a nested browsing context p499 , its name p502 must be changed to the new value. If the attribute is removed, if the object p222 element has a browsing context p499 , the browsing context name p502 must be set to the empty string. The usemap p317 attribute, if present while the object p222 element represents an image, can indicate that the object has an associated image map p317 . The attribute must be ignored if the object p222 element doesn't represent an image. The form p407 attribute is used to explicitly associate the object p222 element with its form owner p407 . Constraint validation: object p222 elements are always barred from constraint validation p412 . The object p222 element supports dimension attributes p320 . The IDL attributes data, type, name, and useMap each must reflect p62 the respective content attributes of the same name.
226
The contentDocument IDL attribute must return the Document p33 object of the active document p499 of the object p222 element's nested browsing context p499 , if it has one; otherwise, it must return null. The contentWindow IDL attribute must return the WindowProxy p510 object of the object p222 element's nested browsing context p499 , if it has one; otherwise, it must return null. The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The form p408 IDL attribute is part of the element's forms API. In the following example, a Java applet is embedded in a page using the object p222 element. (Generally speaking, it is better to avoid using applets like these and instead use native JavaScript and HTML to provide the functionality, since that way the application will work on all Web browsers without requiring a third-party plugin. Many devices, especially embedded devices, do not support third-party technologies like Java.) <figure> <object type="application/x-java-applet"> <param name="code" value="MyJavaClass"> <p>You do not have Java available, or it is disabled.</p> </object> <figcaption>My Java Clock</figcaption> </figure> In this example, an HTML page is embedded in another using the object p222 element. <figure> <object data="clock.html"></object> <figcaption>My HTML Clock</figcaption> </figure> The following example shows how a plugin can be used in HTML (in this case the Flash plugin, to show a video file). Fallback is provided for users who do not have Flash enabled, in this case using the video p228 element to show the video for those using user agents that support video p228 , and finally providing a link to the video for those who have neither Flash nor a video p228 -capable browser. <p>Look at my video: <object type="application/x-shockwave-flash"> <param name=movie value="http://video.example.com/library/watch.swf"> <param name=allowfullscreen value=true> <param name=flashvars value="http://video.example.com/vids/315981"> <video controls src="http://video.example.com/vids/315981"> <a href="http://video.example.com/vids/315981">View video</a>. </video> </object> </p>
227
The name attribute gives the name of the parameter. The value attribute gives the value of the parameter. Both attributes must be present. They may have any value. If both attributes are present, and if the parent element of the param p227 is an object p222 element, then the element defines a parameter with the given name/value pair. If either the name or value of a parameter p228 defined by a param p227 element that is the child of an object p222 element that represents p708 an instantiated plugin p29 changes, and if that plugin p29 is communicating with the user agent using an API that features the ability to update the plugin p29 when the name or value of a parameter p228 so changes, then the user agent must appropriately exercise that ability to notify the plugin p29 of the change. The IDL attributes name and value must both reflect p62 the respective content attributes of the same name. The following example shows how the param p227 element can be used to pass a parameter to a plugin, in this case the O3D plugin. <!DOCTYPE HTML> <html lang="en"> <head> <title>O3D Utah Teapot</title> </head> <body> <p> <object type="application/vnd.o3d.auto"> <param name="o3d_features" value="FloatingPointTextures"> <img src="o3d-teapot.png" title="3D Utah Teapot illustration rendered using O3D." alt="When O3D renders the Utah Teapot, it appears as a squat teapot with a shiny metallic finish on which the surroundings are reflected, with a faint shadow caused by the lighting."> <p>To see the teapot actually rendered by O3D on your computer, please download and install the <a href="http://code.google.com/apis/o3d/docs/gettingstarted.html#install">O3D plugin</a>.</p> </object> <script src="o3d-teapot.js"></script> </p> </body> </html>
228
width p320 height p320 DOM interface: interface HTMLVideoElement : HTMLMediaElement { attribute unsigned long width; attribute unsigned long height; readonly attribute unsigned long videoWidth; readonly attribute unsigned long videoHeight; attribute DOMString poster; [PutForwards=value attribute DOMSettableTokenList audio; }; A video p228 element is used for playing videos or movies. Content may be provided inside the video p228 element. User agents should not show this content to the user; it is intended for older Web browsers which do not support video p228 , so that legacy video plugins can be tried, or to show text to the users of these older browsers informing them of how to access the video contents. Note: In particular, this content is not intended to address accessibility concerns. To make video content accessible to the blind, deaf, and those with other physical or cognitive disabilities, authors are expected to provide alternative media streams and/or to embed accessibility aids (such as caption or subtitle tracks, audio description tracks, or signlanguage overlays) into their media streams. The video p228 element is a media element p235 whose media data p236 is ostensibly video data, possibly with associated audio data. The src p237 , preload p245 , autoplay p249 , loop p248 , and controls p281 attributes are the attributes common to all media elements p236 . The audio p282 attribute controls the audio channel p282 . The poster attribute gives the address of an image file that the user agent can show while no video data is available. The attribute, if present, must contain a valid non-empty URL potentially surrounded by spaces p55 . If the specified resource is to be used, then, when the element is created or when the poster p229 attribute is set, changed, or removed, the user agent must run the following steps to determine the element's poster frame: 1. If there is an existing instance of this algorithm running for this video p228 element, abort that instance of this algorithm without changing the poster frame p229 . If the poster p229 attribute's value is the empty string, then there is no poster frame p229 ; abort these steps. Resolve p55 the poster p229 attribute's value relative to the element. If this fails, then there is no poster frame p229 ; abort these steps. Fetch p59 the resulting absolute URL p56 , from the element's Document p33 's origin p510 . This must delay the load event p687 of the element's document. If an image is thus obtained, the poster frame p229 is that image. Otherwise, there is no poster frame p229 .
2.
3.
4.
5.
Note: The image given by the poster p229 attribute, the poster frame p229 , is intended to be a representative frame of the video (typically one of the first non-blank frames) that gives the user an idea of what the video is like.
When no video data is available (the element's readyState p249 attribute is either HAVE_NOTHING p248 , or HAVE_METADATA p248 but no video data has yet been obtained at all, or the element's readyState p249 attribute is any subsequent value but the media resource p236 does not have a video channel), the video p228 element represents p708 either the poster frame p229 , or nothing. When a video p228 element is paused p250 and the current playback position p247 is the first frame of video, the element represents p708 either the frame of video corresponding to the current playback position p247 or the poster frame p229 , at the discretion of the user agent. Notwithstanding the above, the poster frame p229 should be preferred over nothing, but the poster frame p229 should not be shown again after a frame of video has been shown.
229
When a video p228 element is paused p250 at any other position, and the media resource p236 has a video channel, the element represents p708 the frame of video corresponding to the current playback position p247 , or, if that is not yet available (e.g. because the video is seeking or buffering), the last frame of the video to have been rendered. When a video p228 element whose media resource p236 has a video channel is potentially playing p250 , it represents p708 the frame of video at the continuously increasing "current" position p247 . When the current playback position p247 changes such that the last frame rendered is no longer the frame corresponding to the current playback position p247 in the video, the new frame must be rendered. Similarly, any audio associated with the media resource p236 must, if played, be played synchronized with the current playback position p247 , at the specified volume p282 with the specified mute state p282 . When a video p228 element whose media resource p236 has a video channel is neither potentially playing p250 nor paused p250 (e.g. when seeking or stalled), the element represents p708 the last frame of the video to have been rendered. Note: Which frame in a video stream corresponds to a particular playback position is defined by the video stream's format. The video p228 element also represents p708 any text track cues p256 whose text track cue active flag p257 is set and whose text track p254 is in the showing p255 or showing by default p255 modes. In addition to the above, the user agent may provide messages to the user (such as "buffering", "no video loaded", "error", or more detailed information) by overlaying text or icons on the video or other areas of the element's playback area, or in another appropriate manner. User agents that cannot render the video may instead make the element represent p708 a link to an external video playback utility or to the video data itself. This box is non-normative. Implementation requirements are given below this box. video . videoWidth
p230
video . videoHeight p230 These attributes return the intrinsic dimensions of the video, or zero if the dimensions are not known.
The intrinsic width and intrinsic height of the media resource p236 are the dimensions of the resource in CSS pixels after taking into account the resource's dimensions, aspect ratio, clean aperture, resolution, and so forth, as defined for the format used by the resource. If an anamorphic format does not define how to apply the aspect ratio to the video data's dimensions to obtain the "correct" dimensions, then the user agent must apply the ratio by increasing one dimension and leaving the other unchanged. The videoWidth IDL attribute must return the intrinsic width p230 of the video in CSS pixels. The videoHeight IDL attribute must return the intrinsic height p230 of the video in CSS pixels. If the element's readyState p249 attribute is HAVE_NOTHING p248 , then the attributes must return 0. The video p228 element supports dimension attributes p320 . Video content should be rendered inside the element's playback area such that the video content is shown centered in the playback area at the largest possible size that fits completely within it, with the video content's aspect ratio being preserved. Thus, if the aspect ratio of the playback area does not match the aspect ratio of the video, the video will be shown letterboxed or pillarboxed. Areas of the element's playback area that do not contain the video represent nothing. The intrinsic width of a video p228 element's playback area is the intrinsic width p230 of the video resource, if that is available; otherwise it is the intrinsic width of the poster frame p229 , if that is available; otherwise it is 300 CSS pixels. The intrinsic height of a video p228 element's playback area is the intrinsic height p230 of the video resource, if that is available; otherwise it is the intrinsic height of the poster frame p229 , if that is available; otherwise it is 150 CSS pixels. User agents should provide controls to enable or disable the display of closed captions, audio description tracks, and other additional data associated with the video stream, though such features should, again, not interfere with the page's normal rendering. User agents may allow users to view the video content in manners more suitable to the user (e.g. full-screen or in an independent resizable window). As for the other user interface features, controls to enable this should not interfere with the page's normal rendering unless the user agent is exposing a user interface p282 . In such an independent context, however, user agents may make full user interfaces visible, with, e.g., play, pause, seeking, and volume controls, even if the controls p281 attribute is absent.
230
User agents may allow video playback to affect system features that could interfere with the user's experience; for example, user agents could disable screensavers while video playback is in progress. The poster IDL attribute must reflect p62 the poster p229 content attribute. The audio IDL attribute must reflect p62 the audio p282 content attribute. This example shows how to detect when a video has failed to play correctly: <script> function failed(e) { // video playback failed - show a message saying why switch (e.target.error.code) { case e.target.error.MEDIA_ERR_ABORTED: alert('You aborted the video playback.'); break; case e.target.error.MEDIA_ERR_NETWORK: alert('A network error caused the video download to fail part-way.'); break; case e.target.error.MEDIA_ERR_DECODE: alert('The video playback was aborted due to a corruption problem or because the video used features your browser did not support.'); break; case e.target.error.MEDIA_ERR_SRC_NOT_SUPPORTED: alert('The video could not be loaded, either because the server or network failed or because the format is not supported.'); break; default: alert('An unknown error occurred.'); break; } } </script> <p><video src="tgif.vid" autoplay controls onerror="failed(event)"></video></p> <p><a href="tgif.vid">Download the video file</a>.</p>
231
Content may be provided inside the audio p231 element. User agents should not show this content to the user; it is intended for older Web browsers which do not support audio p231 , so that legacy audio plugins can be tried, or to show text to the users of these older browsers informing them of how to access the audio contents. Note: In particular, this content is not intended to address accessibility concerns. To make audio content accessible to the deaf or to those with other physical or cognitive disabilities, authors are expected to provide alternative media streams and/or to embed accessibility aids (such as transcriptions) into their media streams. The audio p231 element is a media element p235 whose media data p236 is ostensibly audio data. The src p237 , preload p245 , autoplay p249 , loop p248 , and controls p281 attributes are the attributes common to all media elements p236 . When an audio p231 element is potentially playing p250 , it must have its audio data played synchronized with the current playback position p247 , at the specified volume p282 with the specified mute state p282 . When an audio p231 element is not potentially playing p250 , audio must not play for the element. This box is non-normative. Implementation requirements are given below this box. audio = new Audio
p232
( [ url ] )
Returns a new audio p231 element, with the src p237 attribute set to the value passed in the argument, if applicable.
Two constructors are provided for creating HTMLAudioElement p231 objects (in addition to the factory methods from DOM Core such as createElement()): Audio() and Audio(src). When invoked as constructors, these must return a new HTMLAudioElement p231 object (a new audio p231 element). The element must have its preload p245 attribute set to the literal value "auto p245 ". If the src argument is present, the object created must have its src p237 content attribute set to the provided value, and the user agent must invoke the object's resource selection algorithm p240 before returning. The element's document must be the active document p499 of the browsing context p499 of the Window p503 object on which the interface object of the invoked constructor is found.
232
The type attribute gives the type of the media resource p236 , to help the user agent determine if it can play this media resource p236 before fetching it. If specified, its value must be a valid MIME type p28 . The codecs parameter, which certain MIME types define, might be necessary to specify exactly how the resource is encoded. [RFC4281] p784 The following list shows some examples of how to use the codecs= MIME parameter in the type p233 attribute. H.264 Constrained baseline profile video (main and extended video compatible) level 3 and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'> H.264 Extended profile video (baseline-compatible) level 3 and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="avc1.58A01E, mp4a.40.2"'> H.264 Main profile video level 3 and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="avc1.4D401E, mp4a.40.2"'> H.264 'High' profile video (incompatible with main, baseline, or extended profiles) level 3 and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="avc1.64001E, mp4a.40.2"'> MPEG-4 Visual Simple Profile Level 0 video and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="mp4v.20.8, mp4a.40.2"'> MPEG-4 Advanced Simple Profile Level 0 video and Low-Complexity AAC audio in MP4 container <source src='video.mp4' type='video/mp4; codecs="mp4v.20.240, mp4a.40.2"'> MPEG-4 Visual Simple Profile Level 0 video and AMR audio in 3GPP container <source src='video.3gp' type='video/3gpp; codecs="mp4v.20.8, samr"'> Theora video and Vorbis audio in Ogg container <source src='video.ogv' type='video/ogg; codecs="theora, vorbis"'> Theora video and Speex audio in Ogg container <source src='video.ogv' type='video/ogg; codecs="theora, speex"'> Vorbis audio alone in Ogg container <source src='audio.ogg' type='audio/ogg; codecs=vorbis'> Speex audio alone in Ogg container <source src='audio.spx' type='audio/ogg; codecs=speex'> FLAC audio alone in Ogg container <source src='audio.oga' type='audio/ogg; codecs=flac'> Dirac video and Vorbis audio in Ogg container <source src='video.ogv' type='video/ogg; codecs="dirac, vorbis"'> Theora video and Vorbis audio in Matroska container <source src='video.mkv' type='video/x-matroska; codecs="theora, vorbis"'> The media attribute gives the intended media type of the media resource p236 , to help the user agent determine if this media resource p236 is useful to the user before fetching it. Its value must be a valid media query p55 . The default, if the media attribute is omitted, is "all", meaning that by default the media resource p236 is suitable for all media. If a source p232 element is inserted as a child of a media element p235 that has no src p237 attribute and whose networkState p238 has the value NETWORK_EMPTY p239 , the user agent must invoke the media element p235 's resource selection algorithm p240 . The IDL attributes src, type, and media must reflect p62 the respective content attributes of the same name. If the author isn't sure if the user agents will all be able to render the media resources provided, the author can listen to the error event on the last source p232 element and trigger fallback behavior: <script> function fallback(video) { // replace <video> with its contents while (video.hasChildNodes()) { if (video.firstChild instanceof HTMLSourceElement) video.removeChild(video.firstChild); else
233
video.parentNode.insertBefore(video.firstChild, video); } video.parentNode.removeChild(video); } </script> <video controls autoplay> <source src='video.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'> <source src='video.ogv' type='video/ogg; codecs="theora, vorbis"' onerror="fallback(parentNode)"> ... </video>
captions
Captions
descriptions Descriptions Textual descriptions of the video component of the media resource p236 , intended for audio synthesis when the visual component is unavailable (e.g. because the user is interacting with the application without a screen while driving, or because the user is blind). Synthesized as separate audio track. chapters metadata Chapters Metadata Chapter titles, intended to be used for navigating the media resource p236 . Displayed as an interactive list in the user agent's interface. Tracks intended for use from script. Not displayed by the user agent.
The attribute may be omitted. The missing value default is the subtitles p234 state. The src attribute gives the address of the text track data. The value must be a valid non-empty URL potentially surrounded by spaces p55 . This attribute must be present. If the element has a src p234 attribute whose value is not the empty string and whose value, when the attribute was set, could be successfully resolved p55 relative to the element, then the element's track URL is the resulting absolute URL p56 . Otherwise, the element's track URL p234 is the empty string.
234
If the elements's track URL p234 identifies a WebVTT p267 resource, and the element's kind p234 attribute is not in the metadata p234 state, then the WebVTT p267 file must be a WebVTT file using cue text p268 . The srclang attribute gives the language of the text track data. The value must be a valid BCP 47 language tag. This attribute must be present if the element's kind p234 attribute is in the subtitles p234 state. [BCP47] p781 If the element has a srclang p235 attribute whose value is not the empty string, then the element's track language is the value of the attribute. Otherwise, the element has no track language p235 . The label attribute gives a user-readable title for the track. This title is used by user agents when listing subtitle p234 , caption p234 , and audio description p234 tracks in their user interface. The value of the label p235 attribute, if the attribute is present, must not be the empty string. Furthermore, there must not be two track p234 element children of the same media element p235 whose kind p234 attributes are in the same state, whose srclang p235 attributes are both missing or have values that represent the same language, and whose label p235 attributes are again both missing or both have the same value. If the element has a label p235 attribute whose value is not the empty string, then the element's track label is the value of the attribute. Otherwise, the element's track label p235 is a user-agent defined string (e.g. the string "untitled" in the user's locale, or a value automatically generated from the other attributes). The default attribute, if specified, indicates that the track is to be enabled if the user's preferences do not indicate that another track would be more appropriate. There must not be more than one track p234 element with the same parent node with the default p235 attribute specified. This box is non-normative. Implementation requirements are given below this box. track . track
p235
Returns the TextTrack p260 object corresponding to the text track p254 of the track p234 element.
The track IDL attribute must, on getting, return the track p234 element's text track p254 's corresponding TextTrack p260 object. The src, srclang, label, and default IDL attributes must reflect p62 the respective content attributes of the same name. The kind IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . This video has subtitles in several languages: <video src="brave.webm"> <track kind=subtitles src=brave.en.vtt srclang=en label="English"> <track kind=captions src=brave.en.vtt srclang=en label="English for the Hard of Hearing"> <track kind=subtitles src=brave.fr.vtt srclang=fr label="Franais"> <track kind=subtitles src=brave.de.vtt srclang=de label="Deutsch"> </video>
235
// ready state const unsigned short HAVE_NOTHING = 0; const unsigned short HAVE_METADATA = 1; const unsigned short HAVE_CURRENT_DATA = 2; const unsigned short HAVE_FUTURE_DATA = 3; const unsigned short HAVE_ENOUGH_DATA = 4; readonly attribute unsigned short readyState; readonly attribute boolean seeking; // playback state attribute readonly attribute readonly attribute readonly attribute readonly attribute attribute attribute readonly attribute readonly attribute readonly attribute attribute attribute void play(); void pause();
double currentTime; double initialTime; double duration; Date startOffsetTime; boolean paused; double defaultPlaybackRate; double playbackRate; TimeRanges played; TimeRanges seekable; boolean ended; boolean autoplay; boolean loop;
// controls attribute boolean controls; attribute double volume; attribute boolean muted; // text tracks readonly attribute TextTrack[] tracks; MutableTextTrack addTrack(in DOMString kind, in optional DOMString label, in optional DOMString language); }; The media element attributes, src p237 , preload p245 , autoplay p249 , loop p248 , and controls p281 , apply to all media elements p235 . They are defined in this section. Media elements p235 are used to present audio data, or video and audio data, to the user. This is referred to as media data in this section, since this section applies equally to media elements p235 for audio or for video. The term media resource is used to refer to the complete set of media data, e.g. the complete video file, or complete audio file. Except where otherwise specified, the task source p553 for all the tasks queued p553 in this section and its subsections is the media element event task source.
4.8.10.1 Error codes This box is non-normative. Implementation requirements are given below this box. media . error
p236
Returns a MediaError p236 object representing the current error state of the element. Returns null if there is no error.
All media elements p235 have an associated error status, which records the last error the element encountered since its resource selection algorithm p240 was last invoked. The error attribute, on getting, must return the MediaError p236 object created for this last error, or null if there has not been an error. interface MediaError { const unsigned short const unsigned short const unsigned short const unsigned short
236
readonly attribute unsigned short code; }; This box is non-normative. Implementation requirements are given below this box. media . error
p236
. code p237
Returns the current error's error code, from the list below.
The code attribute of a MediaError p236 object must return the code for the error, which must be one of the following: MEDIA_ERR_ABORTED (numeric value 1) The fetching process for the media resource p236 was aborted by the user agent at the user's request. MEDIA_ERR_NETWORK (numeric value 2) A network error of some description caused the user agent to stop fetching the media resource p236 , after the resource was established to be usable. MEDIA_ERR_DECODE (numeric value 3) An error of some description occurred while decoding the media resource p236 , after the resource was established to be usable. MEDIA_ERR_SRC_NOT_SUPPORTED (numeric value 4) The media resource p236 indicated by the src p237 attribute was not suitable.
4.8.10.2 Location of the media resource The src content attribute on media elements p235 gives the address of the media resource (video, audio) to show. The attribute, if present, must contain a valid non-empty URL potentially surrounded by spaces p55 . If a src p237 attribute of a media element p235 is set or changed, the user agent must invoke the media element p235 's media element load algorithm p239 . (Removing the src p237 attribute does not do this, even if there are source p232 elements present.) The src IDL attribute on media elements p235 must reflect p62 the content attribute of the same name. This box is non-normative. Implementation requirements are given below this box. media . currentSrc
p237
Returns the address of the current media resource p236 . Returns the empty string when there is no media resource p236 .
The currentSrc IDL attribute is initially the empty string. Its value is changed by the resource selection algorithm p240 defined below. Note: There are two ways to specify a media resource p236 , the src p237 attribute, or source p232 elements. The attribute overrides the elements.
4.8.10.3 MIME types A media resource p236 can be described in terms of its type, specifically a MIME type p28 , in some cases with a codecs parameter. (Whether the codecs parameter is allowed or not depends on the MIME type.) [RFC4281] p784 Types are usually somewhat incomplete descriptions; for example "video/mpeg" doesn't say anything except what the container type is, and even a type like "video/mp4; codecs="avc1.42E01E, mp4a.40.2"" doesn't include information like the actual bitrate (only the maximum bitrate). Thus, given a type, a user agent can often only know whether it might be able to play media of that type (with varying levels of confidence), or whether it definitely cannot play media of that type. A type that the user agent knows it cannot render is one that describes a resource that the user agent definitely does not support, for example because it doesn't recognize the container type, or it doesn't support the listed codecs.
237
The MIME type p28 "application/octet-stream" with no parameters is never a type that the user agent knows it cannot render p237 . User agents must treat that type as equivalent to the lack of any explicit Content-Type metadata p61 when it is used to label a potential media resource p236 . Note: In the absence of a specification to the contrary, the MIME type p28 "application/octetstream" when used with parameters, e.g. "application/octet-stream;codecs=theora", is a type that the user agent knows it cannot render p237 , since that parameter is not defined for that type. This box is non-normative. Implementation requirements are given below this box. media . canPlayType
p238
(type)
Returns the empty string (a negative response), "maybe", or "probably" based on how confident the user agent is that it can play media resources of the given type.
The canPlayType(type) method must return the empty string if type is a type that the user agent knows it cannot render p237 or is the type "application/octet-stream"; it must return "probably" if the user agent is confident that the type represents a media resource p236 that it can render if used in with this audio p231 or video p228 element; and it must return "maybe" otherwise. Implementors are encouraged to return "maybe" unless the type can be confidently established as being supported or not. Generally, a user agent should never return "probably" for a type that allows the codecs parameter if that parameter is not present. This script tests to see if the user agent supports a (fictional) new format to dynamically decide whether to use a video p228 element or a plugin: <section id="video"> <p><a href="playing-cats.nfv">Download video</a></p> </section> <script> var videoSection = document.getElementById('video'); var videoElement = document.createElement('video'); var support = videoElement.canPlayType('video/ x-new-fictional-format;codecs="kittens,bunnies"'); if (support != "probably" && "New Fictional Video Plug-in" in navigator.plugins) { // not confident of browser support // but we have a plugin // so use plugin instead videoElement = document.createElement("embed"); } else if (support == "") { // no support from browser and no plugin // do nothing videoElement = null; } if (videoElement) { while (videoSection.hasChildNodes()) videoSection.removeChild(videoSection.firstChild); videoElement.setAttribute("src", "playing-cats.nfv"); videoSection.appendChild(videoElement); } </script> Note: The type p233 attribute of the source p232 element allows the user agent to avoid downloading resources that use formats it cannot render.
4.8.10.4 Network states This box is non-normative. Implementation requirements are given below this box. media . networkState
p238
Returns the current state of network activity for the element, from the codes in the list below.
As media elements p235 interact with the network, their current network activity is represented by the networkState attribute. On getting, it must return the current network state of the element, which must be one of the following values:
238
NETWORK_EMPTY (numeric value 0) The element has not yet been initialized. All attributes are in their initial states. NETWORK_IDLE (numeric value 1) The element's resource selection algorithm p240 is active and has selected a resource p236 , but it is not actually using the network at this time. NETWORK_LOADING (numeric value 2) The user agent is actively trying to download data. NETWORK_NO_SOURCE (numeric value 3) The element's resource selection algorithm p240 is active, but it has so not yet found a resource p236 to use. The resource selection algorithm p240 defined below describes exactly when the networkState p238 attribute changes value and what events fire to indicate changes in this state.
4.8.10.5 Loading the media resource This box is non-normative. Implementation requirements are given below this box. media . load
p239
()
Causes the element to reset and start selecting and loading a new media resource p236 from scratch.
All media elements p235 have an autoplaying flag, which must begin in the true state, and a delaying-the-loadevent flag, which must begin in the false state. While the delaying-the-load-event flag p239 is true, the element must delay the load event p687 of its document. When the load() method on a media element p235 is invoked, the user agent must run the media element load algorithm p239 . The media element load algorithm consists of the following steps. 1. 2. Abort any already-running instance of the resource selection algorithm p240 for this element. If there are any tasks p553 from the media element p235 's media element event task source p236 in one of the task queues p553 , then remove those tasks. Note: Basically, pending events and callbacks for the media element are discarded when the media element starts loading a new resource. 3. If the media element p235 's networkState p238 is set to NETWORK_LOADING p239 or NETWORK_IDLE p239 , queue a task p553 to fire a simple event p559 named abort p284 at the media element p235 . If the media element p235 's networkState p238 is not set to NETWORK_EMPTY p239 , then run these substeps: 1. 2. 3. 4. 5. 6. 7. If a fetching process is in progress for the media element p235 , the user agent should stop it. Set the networkState p238 attribute to NETWORK_EMPTY p239 . Forget the media element's media-resource-specific text tracks p257 . If readyState p249 is not set to HAVE_NOTHING p248 , then set it to that state. If the paused p250 attribute is false, then set to true. If seeking p253 is true, set it to false. Set the current playback position p247 to 0. If this changed the current playback position p247 , then queue a task p553 to fire a simple event p559 named timeupdate p284 at the media element p235 . 8. 9. 10. Set the initial playback position p247 to 0. Set the timeline offset p248 to Not-a-Number (NaN). Update the duration p247 attribute to Not-a-Number (NaN). Note: The user agent will not p247 fire a durationchange p285 event for this particular change of the duration.
4.
239
11. 5. 6. 7.
Queue a task p553 to fire a simple event p559 named emptied p284 at the media element p235 .
Set the playbackRate p251 attribute to the value of the defaultPlaybackRate p251 attribute. Set the error p236 attribute to null and the autoplaying flag p239 to true. Invoke the media element p235 's resource selection algorithm p240 . 8. Note: Playback of any previously playing media resource p236 for this element stops.
The resource selection algorithm for a media element p235 is as follows. This algorithm is always invoked synchronously, but one of the first steps in the algorithm is to return and continue running the remaining steps asynchronously, meaning that it runs in the background with scripts and other tasks p553 running in parallel. In addition, this algorithm interacts closely with the event loop p552 mechanism; in particular, it has synchronous sections p553 (which are triggered as part of the event loop p552 algorithm). Steps in such sections are marked with ?. 1. 2. Set the networkState p238 to NETWORK_NO_SOURCE p239 . Asynchronously await a stable state p553 , allowing the task p553 that invoked this algorithm to continue. The synchronous section p553 consists of all the remaining steps of this algorithm until the algorithm says the synchronous section p553 has ended. (Steps in synchronous sections p553 are marked with ?.) ? If the media element p235 has a src p237 attribute, then let mode be attribute. ? Otherwise, if the media element p235 does not have a src p237 attribute but has a source p232 element child, then let mode be children and let candidate be the first such source p232 element child in tree order p29 . ? Otherwise the media element p235 has neither a src p237 attribute nor a source p232 element child: set the networkState p238 to NETWORK_EMPTY p239 , and abort these steps; the synchronous section p553 ends. 4. ? Set the media element p235 's delaying-the-load-event flag p239 to true (this delays the load event p687 ), and set its networkState p238 to NETWORK_LOADING p239 . ? Queue a task p553 to fire a simple event p559 named loadstart p283 at the media element p235 . If mode is attribute, then run these substeps: 1. ? Process candidate: If the src p237 attribute's value is the empty string, then end the synchronous section p553 , and jump down to the failed step below. ? Let absolute URL be the absolute URL p56 that would have resulted from resolving p55 the URL p55 specified by the src p237 attribute's value relative to the media element p235 when the src p237 attribute was last changed. ? If absolute URL was obtained successfully, set the currentSrc p237 attribute to absolute URL. End the synchronous section p553 , continuing the remaining steps asynchronously. If absolute URL was obtained successfully, run the resource fetch algorithm p242 with absolute URL. If that algorithm returns without aborting this one, then the load failed. Failed: Reaching this step indicates that the media resource failed to load or that the given URL p55 could not be resolved p55 . In one atomic operation, run the following steps: 1. Set the error p236 attribute to a new MediaError p236 object whose code p237 attribute is set to MEDIA_ERR_SRC_NOT_SUPPORTED p237 . Forget the media element's media-resource-specific text tracks p257 . Set the element's networkState p238 attribute to the NETWORK_NO_SOURCE p239 value.
3.
5. 6.
2.
3. 4. 5.
6.
2. 3.
7. 8.
Queue a task p553 to fire a simple event p559 named error p284 at the media element p235 . Set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . Abort these steps. Until the load() p239 method is invoked or the src p237 attribute is changed, the element won't attempt to load another resource.
9.
Otherwise, the source p232 elements will be used; run these substeps: 1. ? Let pointer be a position defined by two adjacent nodes in the media element p235 's child list, treating the start of the list (before the first child in the list, if any) and end of the list (after the
240
last child in the list, if any) as nodes in their own right. One node is the node before pointer, and the other node is the node after pointer. Initially, let pointer be the position between the candidate node and the next node, if there are any, or the end of the list, if it is the last node. As nodes are inserted and removed into the media element p235 , pointer must be updated as follows: If a new node is inserted between the two nodes that define pointer Let pointer be the point between the node before pointer and the new node. In other words, insertions at pointer go after pointer. If the node before pointer is removed Let pointer be the point between the node after pointer and the node before the node after pointer. In other words, pointer doesn't move relative to the remaining nodes. If the node after pointer is removed Let pointer be the point between the node before pointer and the node after the node before pointer. Just as with the previous case, pointer doesn't move relative to the remaining nodes. Other changes don't affect pointer. 2. ? Process candidate: If candidate does not have a src p232 attribute, or if its src p232 attribute's value is the empty string, then end the synchronous section p553 , and jump down to the failed step below. ? Let absolute URL be the absolute URL p56 that would have resulted from resolving p55 the URL p55 specified by candidate's src p232 attribute's value relative to the candidate when the src p232 attribute was last changed. ? If absolute URL was not obtained successfully, then end the synchronous section p553 , and jump down to the failed step below. ? If candidate has a type p233 attribute whose value, when parsed as a MIME type p28 (including any codecs described by the codecs parameter, for types that define that parameter), represents a type that the user agent knows it cannot render p237 , then end the synchronous section p553 , and jump down to the failed step below. ? If candidate has a media p233 attribute whose value does not match the environment p55 , then end the synchronous section p553 , and jump down to the failed step below. ? Set the currentSrc p237 attribute to absolute URL. End the synchronous section p553 , continuing the remaining steps asynchronously. Run the resource fetch algorithm p242 with absolute URL. If that algorithm returns without aborting this one, then the load failed. Failed: Queue a task p553 to fire a simple event p559 named error at the candidate element, in the context of the fetching process p59 that was used to try to obtain candidate's corresponding media resource p236 in the resource fetch algorithm p242 . Asynchronously await a stable state p553 . The synchronous section p553 consists of all the remaining steps of this algorithm until the algorithm says the synchronous section p553 has ended. (Steps in synchronous sections p553 are marked with ?.) ? Forget the media element's media-resource-specific text tracks p257 . ? Find next candidate: Let candidate be null. ? Search loop: If the node after pointer is the end of the list, then jump to the waiting step below. ? If the node after pointer is a source p232 element, let candidate be that element. ? Advance pointer so that the node before pointer is now the node that was after pointer, and the node after pointer is the node after the node that used to be after pointer, if any. ? If candidate is null, jump back to the search loop step. Otherwise, jump back to the process candidate step. ? Waiting: Set the element's networkState p238 attribute to the NETWORK_NO_SOURCE p239 value.
3.
4.
5.
6.
7. 8. 9.
10.
11.
15. 16.
17.
18.
241
19.
? Set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . End the synchronous section p553 , continuing the remaining steps asynchronously. Wait until the node after pointer is a node other than the end of the list. (This step might wait forever.) Asynchronously await a stable state p553 . The synchronous section p553 consists of all the remaining steps of this algorithm until the algorithm says the synchronous section p553 has ended. (Steps in synchronous sections p553 are marked with ?.) ? Set the element's delaying-the-load-event flag p239 back to true (this delays the load event p687 again, in case it hasn't been fired yet). ? Set the networkState p238 back to NETWORK_LOADING p239 . ? Jump back to the find next candidate step above.
20. 21.
22.
23.
24. 25.
The resource fetch algorithm for a media element p235 and a given absolute URL p56 is as follows: 1. Let the current media resource be the resource given by the absolute URL p56 passed to this algorithm. This is now the element's media resource p236 . Begin to fetch p59 the current media resource, from the media element p235 's Document p33 's origin p510 , with the force same-origin flag set. Every 350ms (200ms) or for every byte received, whichever is least frequent, queue a task p553 to fire a simple event p559 named progress p284 at the element. The stall timeout is a user-agent defined length of time, which should be about three seconds. When a media element p235 that is actively attempting to obtain media data p236 has failed to receive any data for a duration equal to the stall timeout p242 , the user agent must queue a task p553 to fire a simple event p559 named stalled p284 at the element. User agents may allow users to selectively block or slow media data p236 downloads. When a media element p235 's download has been blocked altogether, the user agent must act as if it was stalled (as opposed to acting as if the connection was closed). The rate of the download may also be throttled automatically by the user agent, e.g. to balance the download with other connections sharing the same bandwidth. User agents may decide to not download more content at any time, e.g. after buffering five minutes of a one hour media resource, while waiting for the user to decide whether to play the resource or not, or while waiting for user input in an interactive resource. When a media element p235 's download has been suspended, the user agent must set the networkState p238 to NETWORK_IDLE p239 and queue a task p553 to fire a simple event p559 named suspend p284 at the element. If and when downloading of the resource resumes, the user agent must set the networkState p238 to NETWORK_LOADING p239 . Note: The preload p245 attribute provides a hint regarding how much buffering the author thinks is advisable, even in the absence of the autoplay p249 attribute. When a user agent decides to completely stall a download, e.g. if it is waiting until the user starts playback before downloading any further content, the element's delaying-the-load-event flag p239 must be set to false. This stops delaying the load event p687 . The user agent may use whatever means necessary to fetch the resource (within the constraints put forward by this and other specifications); for example, reconnecting to the server in the face of network errors, using HTTP range retrieval requests, or switching to a streaming protocol. The user agent must consider a resource erroneous only if it has given up trying to fetch it. The networking task source p554 tasks p553 to process the data as it is being fetched must, when appropriate, include the relevant substeps from the following list:
2.
242
p236 cannot be fetched at all, due to network errors, causing the user If the media data agent to give up trying to fetch the resource p236 is found to have Content-Type metadata p61 that, when parsed as If the media resource p28 a MIME type (including any codecs described by the codecs parameter, if the parameter is defined for that type), represents a type that the user agent knows it cannot render p237 (even if the actual media data p236 is in a supported format) p236 can be fetched but is found by inspection to be in an unsupported If the media data format, or can otherwise not be rendered at all
DNS errors, HTTP 4xx and 5xx errors (and equivalents in other protocols), and other fatal network errors that occur before the user agent has established whether the current media resource is usable, as well as the file using an unsupported container format, or using unsupported codecs for all the data, must cause the user agent to execute the following steps: 1. 2. The user agent should cancel the fetching process. Abort this subalgorithm, returning to the resource selection algorithm p240 .
p236 has been fetched to determine the duration of the Once enough of the media data p236 media resource , its dimensions, and other metadata, and once the text tracks are ready p256
This indicates that the resource is usable. The user agent must follow these substeps: 1. Establish the media timeline p246 for the purposes of the current playback position p247 , the earliest possible position p247 , and the initial playback position p247 , based on the media data p236 . Update the timeline offset p248 to the date and time that corresponds to the zero time in the media timeline p246 established in the previous step, if any. If no explicit time and date is given by the media resource p236 , the timeline offset p248 must be set to Not-a-Number (NaN). Set the current playback position p247 to the earliest possible position p247 . Update the duration p247 attribute with the time of the last frame of the resource, if known, on the media timeline p246 established above. If it is not known (e.g. a stream that is in principle infinite), update the duration p247 attribute to the value positive Infinity. Note: The user agent will p247 queue a task p553 to fire a simple event p559 named durationchange p285 at the element at this point. 5. 6. 7. Set the readyState p249 attribute to HAVE_METADATA p248 . For video p228 elements, set the videoWidth p230 and videoHeight p230 attributes. Queue a task p553 to fire a simple event p559 named loadedmetadata p284 at the element. Note: Before this task is run, as part of the event loop mechanism, the rendering will have been updated to resize the video p228 element if appropriate. 8. If either the media resource p236 or the address of the current media resource indicate a particular start time, then set the initial playback position p247 to that time and then seek seek p253 to that time. Ignore any resulting exceptions (if the position is out of range, it is effectively ignored). For example, a fragment identifier could be used to indicate a start position. 9. Once the readyState p249 attribute reaches HAVE_CURRENT_DATA p248 , after the loadeddata event has been fired p248 , set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . Note: A user agent that is attempting to reduce network usage while still fetching the metadata for each media resource p236 would also stop buffering at this point, causing the networkState p238 attribute to switch to the NETWORK_IDLE p239 value.
2.
3. 4.
243
Note: The user agent is required to determine the duration of the media resource p236 and go through this step before playing.
p236 has been fetched p59 (but potentially before any of it Once the entire media resource has been decoded)
Queue a task p553 to fire a simple event p559 named progress p284 at the media element p235 . If the connection is interrupted, causing the user agent to give up trying to fetch the resource Fatal network errors that occur after the user agent has established whether the current media resource is usable must cause the user agent to execute the following steps: 1. 2. The user agent should cancel the fetching process. Set the error p236 attribute to a new MediaError p236 object whose code p237 attribute is set to MEDIA_ERR_NETWORK p237 . Queue a task p553 to fire a simple event p559 named error p284 at the media element p235 . If the media element p235 's readyState p249 attribute has a value equal to HAVE_NOTHING p248 , set the element's networkState p238 attribute to the NETWORK_EMPTY p239 value and queue a task p553 to fire a simple event p559 named emptied p284 at the element. Otherwise, set the element's networkState p238 attribute to the NETWORK_IDLE p239 value. Set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . Abort the overall resource selection algorithm p240 .
3. 4.
5.
6.
Fatal errors in decoding the media data p236 that occur after the user agent has established whether the current media resource is usable must cause the user agent to execute the following steps: 1. 2. The user agent should cancel the fetching process. Set the error p236 attribute to a new MediaError p236 object whose code p237 attribute is set to MEDIA_ERR_DECODE p237 . Queue a task p553 to fire a simple event p559 named error p284 at the media element p235 . If the media element p235 's readyState p249 attribute has a value equal to HAVE_NOTHING p248 , set the element's networkState p238 attribute to the NETWORK_EMPTY p239 value and queue a task p553 to fire a simple event p559 named emptied p284 at the element. Otherwise, set the element's networkState p238 attribute to the NETWORK_IDLE p239 value. Set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . Abort the overall resource selection algorithm p240 .
3. 4.
5.
6.
The fetching process is aborted by the user, e.g. because the user navigated the browsing context to another page, the user agent must execute the following steps. These steps are not followed if the load() p239 method itself is invoked while these steps are running, as the steps above handle that particular kind of abort. 1. 2. The user agent should cancel the fetching process. Set the error p236 attribute to a new MediaError p236 object whose code p237 attribute is set to MEDIA_ERR_ABORTED p237 . Queue a task p553 to fire a simple event p559 named abort p284 at the media element p235 . If the media element p235 's readyState p249 attribute has a value equal to HAVE_NOTHING p248 , set the element's networkState p238 attribute to the NETWORK_EMPTY p239 value and queue a task p553 to fire a simple event p559 named emptied p284 at the element. Otherwise, set the element's networkState p238 attribute to the NETWORK_IDLE p239 value.
3. 4.
244
5.
Set the element's delaying-the-load-event flag p239 to false. This stops delaying the load event p687 . Abort the overall resource selection algorithm p240 .
6.
p236 can be fetched but has non-fatal errors or uses, in part, codecs that If the media data are unsupported, preventing the user agent from rendering the content completely correctly but not preventing playback altogether
The server returning data that is partially usable but cannot be optimally rendered must cause the user agent to render just the bits it can handle, and ignore the rest.
p236 is found to declare a media-resource-specific text track p257 that If the media resource the user agent supports
If the media resource p236 's origin p510 is the same origin p512 as the media element p235 's Document p33 's origin p510 , queue a task p553 to run the steps to expose a media-resource-specific text track p257 with the relevant data. Note: Cross-origin files do not expose their subtitles in the DOM, for security reasons. However, user agents may still provide the user with access to such data in their user interface. When the networking task source p554 has queued p553 the last task p553 as part of fetching p59 the media resource p236 (i.e. once the download has completed), if the fetching process completes without errors, including decoding the media data, and if all of the data is available to the user agent without network access, then, the user agent must move on to the next step. This might never happen, e.g. when streaming an infinite resource such as Web radio, or if the resource is longer than the user agent's ability to cache data. While the user agent might still need network access to obtain parts of the media resource p236 , the user agent must remain on this step. For example, if the user agent has discarded the first half of a video, the user agent will remain at this step even once the playback has ended p250 , because there is always the chance the user will seek back to the start. In fact, in this situation, once playback has ended p250 , the user agent will end up dispatching a stalled p284 event, as described earlier. 3. If the user agent ever reaches this step (which can only happen if the entire resource gets loaded and kept available): abort the overall resource selection algorithm p240 .
The preload attribute is an enumerated attribute p38 . The following table lists the keywords and states for the attribute the keywords in the left column map to the states in the cell in the second column on the same row as the keyword.
Keyword none State None Brief description Hints to the user agent that either the author does not expect the user to need the media resource, or that the server wants to minimise unnecessary traffic. Hints to the user agent that the author does not expect the user to need the media resource, but that fetching the resource metadata (dimensions, first frame, track list, duration, etc) is reasonable.
Automatic Hints to the user agent that the user agent can put the user's needs first without risk to the server, up to and including optimistically downloading the entire resource.
The empty string is also a valid keyword, and maps to the Automatic p245 state. The attribute's missing value default is user-agent defined, though the Metadata p245 state is suggested as a compromise between reducing server load and providing an optimal user experience. The preload p245 attribute is intended to provide a hint to the user agent about what the author thinks will lead to the best user experience. The attribute may be ignored altogether, for example based on explicit user preferences or based on the available connectivity. The preload IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . Note: The autoplay p249 attribute can override the preload p245 attribute (since if the media plays, it naturally has to buffer first, regardless of the hint given by the preload p245 attribute). Including both is not an error, however.
This box is non-normative. Implementation requirements are given below this box.
245
media . buffered p246 Returns a TimeRanges p283 object that represents the ranges of the media resource p236 that the user agent has buffered.
The buffered attribute must return a new static normalized TimeRanges object p283 that represents the ranges of the media resource p236 , if any, that the user agent has buffered, at the time the attribute is evaluated. Users agents must accurately determine the ranges available, even for media streams where this can only be determined by tedious inspection. Note: Typically this will be a single range anchored at the zero point, but if, e.g. the user agent uses HTTP range requests in response to seeking, then there could be multiple ranges. User agents may discard previously buffered data. Note: Thus, a time position included within a range of the objects return by the buffered p246 attribute at one time can end up being not included in the range(s) of objects returned by the same attribute at later times.
4.8.10.6 Offsets into the media resource This box is non-normative. Implementation requirements are given below this box. media . duration p247 Returns the length of the media resource p236 , in seconds, assuming that the start of the media resource p236 is at time zero. Returns NaN if the duration isn't available. Returns Infinity for unbounded streams. media . currentTime p247 [ = value ] Returns the current playback position p247 , in seconds. Can be set, to seek to the given time. Will throw an INVALID_STATE_ERR p75 exception if there is no selected media resource p236 . Will throw an INDEX_SIZE_ERR p75 exception if the given time is not within the ranges to which the user agent can seek. media . initialTime p247 Returns the initial playback position p247 , that is, time to which the media resource p236 was automatically seeked when it was loaded. Returns zero if the initial playback position p247 is still unknown.
A media resource p236 has a media timeline that maps times (in seconds) to positions in the media resource p236 . The origin of a timeline is its earliest defined position. The duration of a timeline is its last defined position. Establishing the media timeline: If the media resource p236 somehow specifies an explicit timeline whose origin is not negative, then the media timeline p246 should be that timeline. (Whether the media resource p236 can specify a timeline or not depends on the media resource's p236 format.) If the media resource p236 specifies an explicit start time and date, then that time and date should be considered the zero point in the media timeline p246 ; the timeline offset p248 will be the time and date, exposed using the startOffsetTime p248 attribute. If the media resource p236 has a discontinuous timeline, the user agent must extend the timeline used at the start of the resource across the entire resource, so that the media timeline p246 of the media resource p236 increases linearly starting from the earliest possible position p247 (as defined below), even if the underlying media data p236 has out-of-order or even overlapping time codes. For example, if two clips have been concatenated into one video file, but the video format exposes the original times for the two clips, the video data might expose a timeline that goes, say, 00:15..00:29 and then 00:05..00:38. However, the user agent would not expose those times; it would instead expose the times as 00:15..00:29 and 00:29..01:02, as a single video. In the absence of an explicit timeline, the zero time on the media timeline p246 should correspond to the first frame of the media resource p236 . For static audio and video files this is generally trivial. For streaming resources, if the user agent will be able to seek to an earlier point than the first frame originally provided by the server, then the zero time should correspond to the earliest seekable time of the media resource p236 ; otherwise, it should
246
correspond to the first frame received from the server (the point in the media resource p236 at which the user agent began receiving the stream). Another example would be a stream that carries a video with several concatenated fragments, broadcast by a server that does not allow user agents to request specific times but instead just streams the video data in a predetermined order. If a user agent connects to this stream and receives fragments defined as covering timestamps 2010-03-20 23:15:00 UTC to 2010-03-21 00:05:00 UTC and 2010-02-12 14:25:00 UTC to 2010-02-12 14:35:00 UTC, it would expose this with a media timeline p246 starting at 0s and extending to 3,600s (one hour). Assuming the streaming server disconnected at the end of the second clip, the duration p247 attribute would then return 3,600. The startOffsetTime p248 attribute would return a Date object with a time corresponding to 2010-03-20 23:15:00 UTC. However, if a different user agent connected five minutes later, it would (presumably) receive fragments covering timestamps 2010-03-20 23:20:00 UTC to 2010-03-21 00:05:00 UTC and 2010-02-12 14:25:00 UTC to 2010-02-12 14:35:00 UTC, and would expose this with a media timeline p246 starting at 0s and extending to 3,300s (fifty five minutes). In this case, the startOffsetTime p248 attribute would return a Date object with a time corresponding to 2010-03-20 23:20:00 UTC. In any case, the user agent must ensure that the earliest possible position p247 (as defined below) using the established media timeline p246 , is greater than or equal to zero. Media elements p235 have a current playback position, which must initially (i.e. in the absence of media data p236 ) be zero seconds. The current playback position p247 is a time on the media timeline p246 . The currentTime attribute must, on getting, return the current playback position p247 , expressed in seconds. On setting, the user agent must seek p253 to the new value (which might raise an exception). Media elements p235 have an initial playback position, which must initially (i.e. in the absence of media data p236 ) be zero seconds. The initial playback position p247 is updated when a media resource p236 is loaded. The initial playback position p247 is a time on the media timeline p246 . The initialTime attribute must, on getting, return the initial playback position p247 , expressed in seconds. If the media resource p236 is a streaming resource, then the user agent might be unable to obtain certain parts of the resource after it has expired from its buffer. Similarly, some media resources p236 might have a media timeline p246 that doesn't start at zero. The earliest possible position is the earliest position in the stream or resource that the user agent can ever obtain again. It is also a time on the media timeline p246 . Note: The earliest possible position p247 is not explicitly exposed in the API; it corresponds to the start time of the first range in the seekable p254 attribute's TimeRanges p283 object, if any, or the current playback position p247 otherwise. When the earliest possible position p247 changes, then: if the current playback position p247 is before the earliest possible position p247 , the user agent must seek p253 to the earliest possible position p247 ; otherwise, if the user agent has not fired a timeupdate p284 event at the element in the past 15 to 250ms and is not still running event handlers for such an event, then the user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. Note: Because of the above requirement and the requirement in the resource fetch algorithm p242 that kicks in when the metadata of the clip becomes known p243 , the current playback position p247 can never be less than the earliest possible position p247 . The duration attribute must return the time of the end of the media resource p236 , in seconds, on the media timeline p246 . If no media data p236 is available, then the attributes must return the Not-a-Number (NaN) value. If the media resource p236 is known to be unbounded (e.g. a streaming radio), then the attribute must return the positive Infinity value. The user agent must determine the duration of the media resource p236 before playing any part of the media data p236 and before setting readyState p249 to a value equal to or greater than HAVE_METADATA p248 , even if doing so requires fetching multiple parts of the resource. When the length of the media resource p236 changes to a known value (e.g. from being unknown to known, or from a previously established length to a new length) the user agent must queue a task p553 to fire a simple event p559 named durationchange p285 at the media element p235 . (The event is not fired when the duration is reset as part of loading a new media resource.) If an "infinite" stream ends for some reason, then the duration would change from positive Infinity to the time of the last frame or sample in the stream, and the durationchange p285 event would be fired. Similarly, if the user agent initially estimated the media resource p236 's duration instead of determining it precisely, and later revises the estimate based on new information, then the duration would change and the durationchange p285 event would be fired.
247
Some video files also have an explicit date and time corresponding to the zero time in the media timeline p246 , known as the timeline offset. Initially, the timeline offset p248 must be set to Not-a-Number (NaN). The startOffsetTime attribute must return a new Date object representing the current timeline offset p248 . The loop attribute is a boolean attribute p38 that, if specified, indicates that the media element p235 is to seek back to the start of the media resource p236 upon reaching the end. The loop IDL attribute must reflect p62 the content attribute of the same name.
4.8.10.7 The ready states This box is non-normative. Implementation requirements are given below this box. media . readyState
p249
Returns a value that expresses the current state of the element with respect to rendering the current playback position p247 , from the codes in the list below.
Media elements p235 have a ready state, which describes to what degree they are ready to be rendered at the current playback position p247 . The possible values are as follows; the ready state of a media element at any particular time is the greatest value describing the state of the element: HAVE_NOTHING (numeric value 0) No information regarding the media resource p236 is available. No data for the current playback position p247 is available. Media elements p235 whose networkState p238 attribute are set to NETWORK_EMPTY p239 are always in the HAVE_NOTHING p248 state. HAVE_METADATA (numeric value 1) Enough of the resource has been obtained that the duration of the resource is available. In the case of a video p228 element, the dimensions of the video are also available. The API will no longer raise an exception when seeking. No media data p236 is available for the immediate current playback position p247 . The text tracks p254 are ready p256 . HAVE_CURRENT_DATA (numeric value 2) Data for the immediate current playback position p247 is available, but either not enough data is available that the user agent could successfully advance the current playback position p247 in the direction of playback p251 at all without immediately reverting to the HAVE_METADATA p248 state, or there is no more data to obtain in the direction of playback p251 . For example, in video this corresponds to the user agent having data from the current frame, but not the next frame; and to when playback has ended p250 . HAVE_FUTURE_DATA (numeric value 3) Data for the immediate current playback position p247 is available, as well as enough data for the user agent to advance the current playback position p247 in the direction of playback p251 at least a little without immediately reverting to the HAVE_METADATA p248 state. For example, in video this corresponds to the user agent having data for at least the current frame and the next frame. The user agent cannot be in this state if playback has ended p250 , as the current playback position p247 can never advance in this case. HAVE_ENOUGH_DATA (numeric value 4) All the conditions described for the HAVE_FUTURE_DATA p248 state are met, and, in addition, the user agent estimates that data is being fetched at a rate where the current playback position p247 , if it were to advance at the rate given by the defaultPlaybackRate p251 attribute, would not overtake the available data before playback reaches the end of the media resource p236 . When the ready state of a media element p235 whose networkState p238 is not NETWORK_EMPTY p239 changes, the user agent must follow the steps given below:
p248 , and the new ready state is HAVE_METADATA p248 If the previous ready state was HAVE_NOTHING
Note: A loadedmetadata p284 DOM event will be fired p243 as part of the load() p239 algorithm.
p248 and the new ready state is HAVE_CURRENT_DATA p248 If the previous ready state was HAVE_METADATA or greater
If this is the first time this occurs for this media element p235 since the load() p239 algorithm was last invoked, the user agent must queue a task p553 to fire a simple event p559 named loadeddata p284 at the element.
248
If the new ready state is HAVE_FUTURE_DATA p248 or HAVE_ENOUGH_DATA p248 , then the relevant steps below must then be run also.
p248 or more, and the new ready state is If the previous ready state was HAVE_FUTURE_DATA p248 HAVE_CURRENT_DATA or less
Note: A waiting p284 DOM event can be fired p250 , depending on the current state of playback.
p248 or less, and the new ready state is If the previous ready state was HAVE_CURRENT_DATA p248 HAVE_FUTURE_DATA
The user agent must queue a task p553 to fire a simple event p559 named canplay p284 . If the element is potentially playing p250 , the user agent must queue a task p553 to fire a simple event p559 named playing p284 .
p248 If the new ready state is HAVE_ENOUGH_DATA
If the previous ready state was HAVE_CURRENT_DATA p248 or less, the user agent must queue a task p553 to fire a simple event p559 named canplay p284 , and, if the element is also potentially playing p250 , queue a task p553 to fire a simple event p559 named playing p284 . If the autoplaying flag p239 is true, and the paused p250 attribute is true, and the media element p235 has an autoplay p249 attribute specified, and the media element p235 's Document p33 's browsing context p499 did not have the sandboxed automatic features browsing context flag p217 set when the Document p33 was created, then the user agent may also set the paused p250 attribute to false, queue a task p553 to fire a simple event p559 named play p284 , and queue a task p553 to fire a simple event p559 named playing p284 . Note: User agents are not required to autoplay, and it is suggested that user agents honor user preferences on the matter. Authors are urged to use the autoplay p249 attribute rather than using script to force the video to play, so as to allow the user to override the behavior if so desired. In any case, the user agent must finally queue a task p553 to fire a simple event p559 named canplaythrough p284 . Note: It is possible for the ready state of a media element to jump between these states discontinuously. For example, the state of a media element can jump straight from HAVE_METADATA p248 to HAVE_ENOUGH_DATA p248 without passing through the HAVE_CURRENT_DATA p248 and HAVE_FUTURE_DATA p248 states. The readyState IDL attribute must, on getting, return the value described above that describes the current ready state of the media element p235 . The autoplay attribute is a boolean attribute p38 . When present, the user agent (as described in the algorithm described herein) will automatically begin playback of the media resource p236 as soon as it can do so without stopping. Note: Authors are urged to use the autoplay p249 attribute rather than using script to trigger automatic playback, as this allows the user to override the automatic playback when it is not desired, e.g. when using a screen reader. Authors are also encouraged to consider not using the automatic playback behavior at all, and instead to let the user agent wait for the user to start playback explicitly. The autoplay IDL attribute must reflect p62 the content attribute of the same name.
4.8.10.8 Playing the media resource This box is non-normative. Implementation requirements are given below this box. media . paused p250 Returns true if playback is paused; false otherwise. media . ended p250 Returns true if playback has reached the end of the media resource p236 .
249
media . defaultPlaybackRate p251 [ = value ] Returns the default rate of playback, for when the user is not fast-forwarding or reversing through the media resource p236 . Can be set, to change the default rate of playback. The default rate has no direct effect on playback, but if the user switches to a fast-forward mode, when they return to the normal playback mode, it is expected that the rate of playback will be returned to the default rate of playback. media . playbackRate p251 [ = value ] Returns the current rate playback, where 1.0 is normal speed. Can be set, to change the rate of playback. media . played p251 Returns a TimeRanges p283 object that represents the ranges of the media resource p236 that the user agent has played. media . play p251 () Sets the paused p250 attribute to false, loading the media resource p236 and beginning playback if necessary. If the playback had ended, will restart it from the start. media . pause p251 () Sets the paused p250 attribute to true, loading the media resource p236 if necessary.
The paused attribute represents whether the media element p235 is paused or not. The attribute must initially be true. A media element p235 is said to be potentially playing when its paused p250 attribute is false, the readyState p249 attribute is either HAVE_FUTURE_DATA p248 or HAVE_ENOUGH_DATA p248 , the element has not ended playback p250 , playback has not stopped due to errors p250 , and the element has not paused for user interaction p250 . A media element p235 is said to have ended playback when the element's readyState p249 attribute is HAVE_METADATA p248 or greater, and either the current playback position p247 is the end of the media resource p236 and the direction of playback p251 is forwards and the media element p235 does not have a loop p248 attribute specified, or the current playback position p247 is the earliest possible position p247 and the direction of playback p251 is backwards. The ended attribute must return true if the media element p235 has ended playback p250 and the direction of playback p251 is forwards, and false otherwise. A media element p235 is said to have stopped due to errors when the element's readyState p249 attribute is HAVE_METADATA p248 or greater, and the user agent encounters a non-fatal error p245 during the processing of the media data p236 , and due to that error, is not able to play the content at the current playback position p247 . A media element p235 is said to have paused for user interaction when its paused p250 attribute is false, the readyState p249 attribute is either HAVE_FUTURE_DATA p248 or HAVE_ENOUGH_DATA p248 and the user agent has reached a point in the media resource p236 where the user has to make a selection for the resource to continue. It is possible for a media element p235 to have both ended playback p250 and paused for user interaction p250 at the same time. When a media element p235 that is potentially playing p250 stops playing because it has paused for user interaction p250 , the user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. When a media element p235 that is potentially playing p250 stops playing because its readyState p249 attribute changes to a value lower than HAVE_FUTURE_DATA p248 , without the element having ended playback p250 , or playback having stopped due to errors p250 , or playback having paused for user interaction p250 , or the seeking algorithm p253 being invoked, the user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element, and queue a task p553 to fire a simple event p559 named waiting p284 at the element. When the current playback position p247 reaches the end of the media resource p236 when the direction of playback p251 is forwards, then the user agent must follow these steps: 1. If the media element p235 has a loop p248 attribute specified, then seek p253 to the earliest possible position p247 of the media resource p236 and abort these steps. Stop playback.
2.
250
Note: The ended p250 attribute becomes true. 3. 4. The user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. The user agent must queue a task p553 to fire a simple event p559 named ended p284 at the element.
When the current playback position p247 reaches the earliest possible position p247 of the media resource p236 when the direction of playback p251 is backwards, then the user agent must follow these steps: 1. 2. Stop playback. The user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element.
The defaultPlaybackRate attribute gives the desired speed at which the media resource p236 is to play, as a multiple of its intrinsic speed. The attribute is mutable: on getting it must return the last value it was set to, or 1.0 if it hasn't yet been set; on setting the attribute must be set to the new value. The playbackRate attribute gives the speed at which the media resource p236 plays, as a multiple of its intrinsic speed. If it is not equal to the defaultPlaybackRate p251 , then the implication is that the user is using a feature such as fast forward or slow motion playback. The attribute is mutable: on getting it must return the last value it was set to, or 1.0 if it hasn't yet been set; on setting the attribute must be set to the new value, and the playback must change speed (if the element is potentially playing p250 ). If the playbackRate p251 is positive or zero, then the direction of playback is forwards. Otherwise, it is backwards. The "play" function in a user agent's interface must set the playbackRate p251 attribute to the value of the defaultPlaybackRate p251 attribute before invoking the play() p251 method's steps. Features such as fast-forward or rewind must be implemented by only changing the playbackRate p251 attribute. When the defaultPlaybackRate p251 or playbackRate p251 attributes change value (either by being set by script or by being changed directly by the user agent, e.g. in response to user control) the user agent must queue a task p553 to fire a simple event p559 named ratechange p284 at the media element p235 . The played attribute must return a new static normalized TimeRanges object p283 that represents the ranges of the media resource p236 , if any, that the user agent has so far rendered, at the time the attribute is evaluated. When the play() method on a media element p235 is invoked, the user agent must run the following steps. 1. If the media element p235 's networkState p238 attribute has the value NETWORK_EMPTY p239 , invoke the media element p235 's resource selection algorithm p240 . If the playback has ended p250 and the direction of playback p251 is forwards, seek p253 to the earliest possible position p247 of the media resource p236 . Note: This will cause p254 the user agent to queue a task p553 to fire a simple event p559 named timeupdate p284 at the media element p235 . 3. If the media element p235 's paused p250 attribute is true, run the following substeps: 1. 2. 3. Change the value of paused p250 to false. Queue a task p553 to fire a simple event p559 named play p284 at the element. If the media element p235 's readyState p249 attribute has the value HAVE_NOTHING p248 , HAVE_METADATA p248 , or HAVE_CURRENT_DATA p248 , queue a task p553 to fire a simple event p559 named waiting p284 at the element. Otherwise, the media element p235 's readyState p249 attribute has the value HAVE_FUTURE_DATA p248 or HAVE_ENOUGH_DATA p248 ; queue a task p553 to fire a simple event p559 named playing p284 at the element. 4. Set the media element p235 's autoplaying flag p239 to false.
2.
When the pause() method is invoked, the user agent must run the following steps: 1. If the media element p235 's networkState p238 attribute has the value NETWORK_EMPTY p239 , invoke the media element p235 's resource selection algorithm p240 . Set the media element p235 's autoplaying flag p239 to false. If the media element p235 's paused p250 attribute is false, run the following steps:
2. 3.
251
1. 2. 3.
Change the value of paused p250 to true. Queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. Queue a task p553 to fire a simple event p559 named pause p284 at the element.
When a media element p235 is potentially playing p250 and its Document p33 is a fully active p500 Document p33 , its current playback position p247 must increase monotonically at playbackRate p251 units of media time per unit time of wall clock time. Note: This specification doesn't define how the user agent achieves the appropriate playback rate depending on the protocol and media available, it is plausible that the user agent could negotiate with the server to have the server provide the media data at the appropriate rate, so that (except for the period between when the rate is changed and when the server updates the stream's playback rate) the client doesn't actually have to drop or interpolate any frames. When the playbackRate p251 is negative (playback is backwards), any corresponding audio must be muted. When the playbackRate p251 is so low or so high that the user agent cannot play audio usefully, the corresponding audio must also be muted. If the playbackRate p251 is not 1.0, the user agent may apply pitch adjustments to the audio as necessary to render it faithfully. The playbackRate p251 can be 0.0, in which case the current playback position p247 doesn't move, despite playback not being paused (paused p250 doesn't become true, and the pause p284 event doesn't fire). Media elements p235 that are potentially playing p250 while not in a Document p29 must not play any video, but should play any audio component. Media elements must not stop playing just because all references to them have been removed; only once a media element to which no references exist has reached a point where no further audio remains to be played for that element (e.g. because the element is paused, or because the end of the clip has been reached, or because its playbackRate p251 is 0.0) may the element be garbage collected. When the current playback position p247 of a media element p235 changes (e.g. due to playback or seeking), the user agent must run the following steps. If the current playback position p247 changes while the steps are running, then the user agent must wait for the steps to complete, and then must immediately rerun the steps. (These steps are thus run as often as possible or needed if one iteration takes a long time, this can cause certain cues p256 to be skipped over as the user agent rushes ahead to "catch up".) 1. Let current cues be an ordered list of cues p256 , initialized to contain all the cues p256 of all the hidden p255 , showing p255 , or showing by default p255 text tracks p254 of the media element p235 (not the disabled p255 ones) whose start times p256 are less than or equal to the current playback position p247 and whose end times p256 are greater than the current playback position p247 , in text track cue order p257 . Let other cues be an ordered list of cues p256 , initialized to contain all the cues p256 of hidden p255 , showing p255 , and showing by default p255 text tracks p254 of the media element p235 that are not present in current cues, also in text track cue order p257 . If the time was reached through the usual monotonic increase of the current playback position during normal playback, and if the user agent has not fired a timeupdate p284 event at the element in the past 15 to 250ms and is not still running event handlers for such an event, then the user agent must queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. (In the other cases, such as explicit seeks, relevant events get fired as part of the overall process of changing the current playback position.) Note: The event thus is not to be fired faster than about 66Hz or slower than 4Hz (assuming the event handlers don't take longer than 250ms to run). User agents are encouraged to vary the frequency of the event based on the system load and the average cost of processing the event each time, so that the UI updates are not any more frequent than the user agent can comfortably handle while decoding the video. 4. If all of the cues p256 in current cues have their text track cue active flag p257 set, and none of the cues p256 in other cues have their text track cue active flag p257 set, then abort these steps. If the time was reached through the usual monotonic increase of the current playback position during normal playback, and there are cues p256 in other cues that have both their text track cue active flag p257 set and their text track cue pause-on-exit flag p256 set, then immediately act as if the element's pause() p251 method had been invoked. (In the other cases, such as explicit seeks, playback is not paused by going past the end time of a cue p256 , even if that cue p256 has its text track cue pause-on-exit flag p256 set.) Let affected tracks be a list of text tracks p254 , initially empty.
2.
3.
5.
6.
252
7.
For each text track cue p256 in other cues that has its text track cue active flag p257 set, in list order, queue a task p553 to fire a simple event p559 named exit at the TextTrackCue p264 object, and add the cue p256 's text track p254 to affected tracks, if it's not already in the list. For each text track cue p256 in current cues that does not have its text track cue active flag p257 set, in list order, queue a task p553 to fire a simple event p559 named enter at the TextTrackCue p264 object, and add the cue p256 's text track p254 to affected tracks, if it's not already in the list. For each text track p254 in affected tracks, in the order they were added to the list (which will match the relative order of the text tracks p254 in the media element p235 's list of text tracks p254 ), queue a task p553 to fire a simple event p559 named cuechange at the TextTrack p260 object, and, if the text track p254 has a corresponding track p234 element, to then fire a simple event p559 named cuechange at the track p234 element as well. Set the text track cue active flag p257 of all the cues p256 in the current cues, and unset the text track cue active flag p257 of all the cues p256 in the other cues. Run the rules for updating the text track rendering p255 of each of the text tracks p254 in affected tracks that are showing p255 or showing by default p255 . For example, for text tracks p254 based on WebVTT p267 , the rules for updating the display of WebVTT text tracks p719 .
8.
9.
10.
11.
For the purposes of the algorithm above, a text track cue p256 is considered to be part of a text track p254 only if it is listed in the text track list of cues p255 , not merely if it is associated with the text track p254 . When a media element p235 is removed from a Document p29 , if the media element p235 's networkState p238 attribute has a value other than NETWORK_EMPTY p239 then the user agent must act as if the pause() p251 method had been invoked. Note: If the media element p235 's Document p33 stops being a fully active p500 document, then the playback will stop p252 until the document is active again.
4.8.10.9 Seeking This box is non-normative. Implementation requirements are given below this box. media . seeking
p253
Returns true if the user agent is currently seeking. media . seekable p254 Returns a TimeRanges p283 object that represents the ranges of the media resource p236 to which it is possible for the user agent to seek.
The seeking attribute must initially have the value false. When the user agent is required to seek to a particular new playback position in the media resource p236 , it means that the user agent must run the following steps. This algorithm interacts closely with the event loop p552 mechanism; in particular, it has a synchronous section p553 (which is triggered as part of the event loop p552 algorithm). Steps in that section are marked with ?. 1. If the media element p235 's readyState p249 is HAVE_NOTHING p248 , then raise an INVALID_STATE_ERR p75 exception (if the seek was in response to a DOM method call or setting of an IDL attribute), and abort these steps. If the element's seeking p253 IDL attribute is true, then another instance of this algorithm is already running. Abort that other instance of the algorithm without waiting for the step that it is running to complete. Set the seeking p253 IDL attribute to true. If the seek was in response to a DOM method call or setting of an IDL attribute, then continue the script. The remainder of these steps must be run asynchronously. With the exception of the steps marked with ?, they could be aborted at any time by another instance of this algorithm being invoked. If the new playback position is later than the end of the media resource p236 , then let it be the end of the media resource p236 instead. If the new playback position is less than the earliest possible position p247 , let it be that position instead.
2.
3. 4.
5.
6.
253
7.
If the (possibly now changed) new playback position is not in one of the ranges given in the seekable p254 attribute, then let it be the position in one of the ranges given in the seekable p254 attribute that is the nearest to the new playback position. If two positions both satisfy that constraint (i.e. the new playback position is exactly in the middle between two ranges in the seekable p254 attribute) then use the position that is closest to the current playback position p247 . If there are no ranges given in the seekable p254 attribute then set the seeking p253 IDL attribute to false and abort these steps. Set the current playback position p247 to the given new playback position. Queue a task p553 to fire a simple event p559 named seeking p284 at the element. Queue a task p553 to fire a simple event p559 named timeupdate p284 at the element. If the media element p235 was potentially playing p250 immediately before it started seeking, but seeking caused its readyState p249 attribute to change to a value lower than HAVE_FUTURE_DATA p248 , then queue a task p553 to fire a simple event p559 named waiting p284 at the element. Wait until the user agent has established whether or not the media data p236 for the new playback position is available, and, if it is, until it has decoded enough data to play back that position. Await a stable state p553 . The synchronous section p553 consists of all the remaining steps of this algorithm. (Steps in the synchronous section p553 are marked with ?.) ? Set the seeking p253 IDL attribute to false. ? Queue a task p553 to fire a simple event p559 named seeked p284 at the element.
8. 9. 10. 11.
12.
13.
14. 15.
The seekable attribute must return a new static normalized TimeRanges object p283 that represents the ranges of the media resource p236 , if any, that the user agent is able to seek to, at the time the attribute is evaluated. Note: If the user agent can seek to anywhere in the media resource p236 , e.g. because it is a simple movie file and the user agent and the server support HTTP Range requests, then the attribute would return an object with one range, whose start is the time of the first frame (the earliest possible position p247 , typically zero), and whose end is the same as the time of the first frame plus the duration p247 attribute's value (which would equal the time of the last frame, and might be positive Infinity). Note: The range might be continuously changing, e.g. if the user agent is buffering a sliding window on an infinite stream. This is the behavior seen with DVRs viewing live TV, for instance. Media resources p236 might be internally scripted or interactive. Thus, a media element p235 could play in a nonlinear fashion. If this happens, the user agent must act as if the algorithm for seeking p253 was used whenever the current playback position p247 changes in a discontinuous fashion (so that the relevant events fire).
4.8.10.10 Timed text tracks 4.8.10.10.1 Text track model A media element p235 can have a group of associated text tracks, known as the media element p235 's list of text tracks. The text tracks p254 are sorted as follows: 1. 2. 3. The text tracks p254 corresponding to track p234 element children of the media element p235 , in tree order p29 . Any text tracks p254 added using the addTrack() p263 method, in the order they were added, oldest first. Any media-resource-specific text tracks p257 (text tracks p254 corresponding to data in the media resource p236 ), in the order defined by the media resource p236 's format specification.
A text track p254 consists of: The kind of text track This decides how the track is handled by the user agent. The kind is represented by a string. The possible strings are: subtitles captions descriptions chapters metadata
The kind of track p254 can change dynamically, in the case of a text track p254 corresponding to a track p234 element.
254
A label This is a human-readable string intended to identify the track for the user. In certain cases, the label might be generated automatically. The label of a track p255 can change dynamically, in the case of a text track p254 corresponding to a track p234 element or in the case of an automatically-generated label whose value depends on variable factors such as the user's preferred user interface language. A language This is a string (a BCP 47 language tag) representing the language of the text track's cues. [BCP47] p781 The language of a text track p255 can change dynamically, in the case of a text track p254 corresponding to a track p234 element. A readiness state One of the following: Not loaded Indicates that the text track is known to exist (e.g. it has been declared with a track p234 element), but its cues have not been obtained. Loading Indicates that the text track is loading and there have been no fatal errors encountered so far. Further cues might still be added to the track. Loaded Indicates that the text track has been loaded with no fatal errors. No new cues will be added to the track except if the text track p254 corresponds to a MutableTextTrack p262 object. Failed to load Indicates that the text track was enabled, but when the user agent attempted to obtain it, this failed in some way (e.g. URL p55 could not be resolved p55 , network error, unknown text track format). Some or all of the cues are likely missing and will not be obtained. The readiness state p255 of a text track p254 changes dynamically as the track is obtained. A mode One of the following: Disabled Indicates that the text track is not active. Other than for the purposes of exposing the track in the DOM, the user agent is ignoring the text track. No cues are active, no events are fired, and the user agent will not attempt to obtain the track's cues. Hidden Indicates that the text track is active, but that the user agent is not actively displaying the cues. If no attempt has yet been made to obtain the track's cues, the user agent will perform such an attempt momentarily. The user agent is maintaining a list of which cues are active, and events are being fired accordingly. Showing Showing by default Indicates that the text track is active. If no attempt has yet been made to obtain the track's cues, the user agent will perform such an attempt momentarily. The user agent is maintaining a list of which cues are active, and events are being fired accordingly. In addition, for text tracks whose kind p254 is subtitles or captions, the cues are being displayed over the video as appropriate; for text tracks whose kind p254 is descriptions, the user agent is making the cues available to the user in a non-visual fashion; and for text tracks whose kind p254 is chapters, the user agent is making available to the user a mechanism by which the user can navigate to any point in the media resource p236 by selecting a cue. The showing by default p255 state is used in conjunction with the default p235 attribute on track p234 elements to indicate that the text track was enabled due to that attribute. This allows the user agent to override the state if a later track is discovered that is more appropriate per the user's preferences. A list of zero or more cues A list of text track cues p256 , along with rules for updating the text track rendering. For example, for WebVTT p267 , the rules for updating the display of WebVTT text tracks p719 . The list of cues of a text track p255 can change dynamically, either because the text track p254 has not yet been loaded p255 or is still loading p255 , or because the text track p254 corresponds to a MutableTextTrack p262 object, whose API allows individual cues can be added or removed dynamically. Each text track p254 has a corresponding TextTrack p260 object.
255
The text tracks p254 of a media element p235 are ready if all the text tracks p254 whose mode p255 was not in the disabled p255 state when the element's resource selection algorithm p240 last started now have a text track readiness state p255 of loaded p255 or failed to load p255 . A text track cue is the unit of time-sensitive data in a text track p254 , corresponding for instance for subtitles and captions to the text that appears at a particular time and disappears at another time. Each text track cue p256 consists of: An identifier An arbitrary string. A start time A time, in seconds and fractions of a second, at which the cue becomes relevant. An end time A time, in seconds and fractions of a second, at which the cue stops being relevant. A pause-on-exit flag A boolean indicating whether playback of the media resource p236 is to pause when the cue stops being relevant. A writing direction A writing direction, either horizontal (a line extends horizontally and is positioned vertically, with consecutive lines displayed below each other), vertical growing left (a line extends vertically and is positioned horizontally, with consecutive lines displayed to the left of each other), or vertical growing right (a line extends vertically and is positioned horizontally, with consecutive lines displayed to the right of each other). If the writing direction p256 is horizontal p256 , then line position p256 percentages are relative to the height of the video, and text position p256 and size p256 percentages are relative to the width of the video. Otherwise, line position p256 percentages are relative to the width of the video, and text position p256 and size p256 percentages are relative to the height of the video. A snap-to-lines flag A boolean indicating whether the line's position p256 is a line position (positioned to a multiple of the line dimensions of the first line of the cue), or whether it is a percentage of the dimension of the video. A line position Either a number giving the position of the lines of the cue, to be interpreted as defined by the writing direction p256 and snap-to-lines flag p256 of the cue, or the special value auto, which means the position is to depend on the other active tracks. A text position A number giving the position of the text of the cue within each line, to be interpreted as a percentage of the video, as defined by the writing direction p256 . A size A number giving the size of the box within which the text of each line of the cue is to be aligned, to be interpreted as a percentage of the video, as defined by the writing direction p256 . An alignment An alignment for the text of each line of the cue, either start alignment (the text is aligned towards its start side), middle alignment (the text is aligned centered between its start and end sides), end alignment (the text is aligned towards its end side). Which sides are the start and end sides depends on the Unicode bidirectional algorithm and the writing direction p256 . [BIDI] p781 The text of the cue The raw text of the cue, and rules for its interpretation, allowing the text to be rendered and converted to a DOM fragment. A text track cue p256 is immutable. Each text track cue p256 has a corresponding TextTrackCue p264 object, and can be associated with a particular text track p254 . Once a text track cue p256 is associated with a particular text track p254 , the association is permanent. In addition, each text track cue p256 has two pieces of dynamic information:
256
The active flag This flag must be initially unset. The flag is used to ensure events are fired appropriately when the cue becomes active or inactive, and to make sure the right cues are rendered. The user agent must synchronously unset this flag whenever the text track cue p256 is removed from its text track p254 's text track list of cues p255 ; whenever the text track p254 itself is removed from its media element p235 's list of text tracks p254 or has its text track mode p255 changed to disabled p255 ; and whenever the media element p235 's readyState p249 is changed back to HAVE_NOTHING p248 . When the flag is unset in this way for one or more cues in text tracks p254 that were showing p255 or showing by default p255 prior to the relevant incident, the user agent must, after having unset the flag for all the affected cues, apply the rules for updating the text track rendering p255 of those text tracks p254 . For example, for text tracks p254 based on WebVTT p267 , the rules for updating the display of WebVTT text tracks p719 . The display state This is used as part of the rendering model, to keep cues in a consistent position. It must initially be empty. Whenever the text track cue active flag p257 is unset, the user agent must empty the text track cue display state p257 . The text track cues p256 of a media element p235 's text tracks p254 are ordered relative to each other in the text track cue order, which is determined as follows: first group the cues p256 by their text track p254 , with the groups being sorted in the same order as their text tracks p254 appear in the media element p235 's list of text tracks p254 ; then, within each group, cues p256 must be sorted by their start time p256 , earliest first; then, any cues p256 with the same start time p256 must be sorted by their end time p256 , earliest first; and finally, any cues p256 with identical end times p256 must be sorted in the order they were created (so e.g. for cues from a WebVTT p267 file, that would be the order in which the cues were listed in the file).
4.8.10.10.2 Sourcing in-band text tracks A media-resource-specific text track is a text track p254 that corresponds to data found in the media resource p236 . Rules for processing and rendering such data are defined by the relevant specifications, e.g. the specification of the video format if the media resource p236 is a video. When a media resource p236 contains data that the user agent recognises and supports as being equivalent to a text track p254 , the user agent runs p245 the steps to expose a media-resource-specific text track with the relevant data, as follows: 1. Associate the relevant data with a new text track p254 and its corresponding new TextTrack p260 object. The text track p254 is a media-resource-specific text track p257 . Set the new text track p254 's kind p254 , label p255 , and language p255 based on the semantics of the relevant data, as defined by the relevant specification. Populate the new text track p254 's list of cues p255 with the cues parsed so far, folllowing the guidelines for exposing cues p259 , and begin updating it dynamically as necessary. Set the new text track p254 's readiness state p255 to the value that most correctly describes the current state, and begin updating it dynamically as necessary. For example, if the relevant data in the media resource p236 has been fully parsed and completely describes the cues, then the text track p254 would be loaded p255 . On the other hand, if the data for the cues is interleaved with the media data p236 , and the media resource p236 as a whole is still being downloaded, then the loading p255 state might be more accurate. 5. Set the new text track p254 's mode p255 to the mode consistent with the user's preferences and the requirements of the relevant specification for the data. Leave the text track list of cues p255 empty, and associate with it the rules for updating the text track rendering p255 appropriate for the format in question. Add the new text track p254 to the media element p235 's list of text tracks p254 .
2.
3.
4.
6.
7.
When a media element p235 is to forget the media element's media-resource-specific text tracks, the user agent must remove from the media element p235 's list of text tracks p254 all the media-resource-specific text tracks p257 .
4.8.10.10.3 Sourcing out-of-band text tracks When a track p234 element is created, it must be associated with a new text track p254 (with its value set as defined below) and its corresponding new TextTrack p260 object.
257
The text track kind p254 is determined from the state of the element's kind p234 attribute according to the following table; for a state given in a cell of the first column, the kind p254 is the string given in the second column:
State Subtitles
p234
Captions p234
The text track label p255 is the element's track label p235 . The text track language p255 is the element's track language p235 , if any, or the empty string otherwise. As the kind p234 , label p235 , and srclang p235 attributes are added, removed, or changed, the text track p254 must update accordingly, as per the definitions above. Note: Changes to the track URL p234 are handled in the algorithm below. The text track list of cues p255 is initially empty. It is dynamically modified when the referenced file is parsed. Associated with the list are the rules for updating the text track rendering p255 appropriate for the format in question; for WebVTT p267 , this is the rules for updating the display of WebVTT text tracks p719 . When a track p234 element's parent element changes and the new parent is a media element p235 , then the user agent must add the track p234 element's corresponding text track p254 to the media element p235 's list of text tracks p254 . When a track p234 element's parent element changes and the old parent was a media element p235 , then the user agent must remove the track p234 element's corresponding text track p254 from the media element p235 's list of text tracks p254 . When a text track p254 corresponding to a track p234 element is added to a media element p235 's list of text tracks p254 , the user agent must set the text track mode p255 appropriately, as determined by the following conditions:
p254 is subtitles p254 or captions p254 and the user has indicated an interest in If the text track kind having a track with this text track kind p254 , text track language p255 , and text track label p255 enabled, and there is no other text track p254 in the media element p235 's list of text tracks p254 with a text track kind p254 of either subtitles p254 or captions p254 whose text track mode p255 is showing p255 p254 is descriptions p254 and the user has indicated an interest in having text If the text track kind descriptions with this text track language p255 and text track label p255 enabled, and there is no other text track p254 in the media element p235 's list of text tracks p254 with a text track kind p254 of descriptions p254 whose text track mode p255 is showing p255 p254 is chapters p254 and the text track language p255 is one that the user agent If the text track kind has reason to believe is appropriate for the user, and there is no other text track p254 in the media element p235 's list of text tracks p254 with a text track kind p254 of chapters p254 whose text track mode p255 is showing p255
Let the text track mode p255 be showing p255 . If there is a text track p254 in the media element p235 's list of text tracks p254 whose text track mode p255 is showing by default p255 , the user agent must furthermore change that text track p254 's text track mode p255 to hidden p255 .
p234 element has a default p235 attribute specified, and there is no other text track p254 in If the track the media element p235 's list of text tracks p254 whose text track mode p255 is showing p255 or showing by default p255
Let the text track mode p255 be showing by default p255 . Otherwise Let the text track mode p255 be disabled p255 . When a text track p254 corresponding to a track p234 element is created with text track mode p255 set to hidden p255 , showing p255 , or showing by default p255 , and when a text track p254 corresponding to a track p234 element is created with text track mode p255 set to disabled p255 and subsequently changes its text track mode p255 to hidden p255 , showing p255 , or showing by default p255 for the first time, the user agent must immediately and synchronously run the following algorithm. This algorithm interacts closely with the event loop p552 mechanism; in particular, it has a synchronous section p553 (which is triggered as part of the event loop p552 algorithm). The step in that section is marked with ?. 1. Set the text track readiness state p255 to loading p255 .
258
2. 3.
Let URL be the track URL p234 of the track p234 element. Asynchronously run the remaining steps, while continuing with whatever task was responsible for creating the text track p254 or changing the text track mode p255 . Download: If URL is not the empty string, and its origin p510 is the same as the media element p235 's Document p33 's origin p510 , then fetch p59 URL, from the media element p235 's Document p33 's origin p510 , with the force same-origin flag set. The tasks p553 queued p553 by the fetching algorithm p59 on the networking task source p554 to process the data as it is being fetched must examine the resource's Content Type metadata p61 , once it is available, if it ever is. If no Content Type metadata p61 is ever available, or if the type is not recognised as a text track format, then the resource's format must be assumed to be unsupported (this causes the load to fail, as described below). If a type is obtained, and represents a supported text track format, then the resource's data must be passed to the appropriate parser (e.g. the WebVTT parser p271 if the Content Type metadata p61 is text/vtt p761 ) as it is received, with the text track list of cues p255 being used for that parser's output. If the fetching algorithm p59 fails for any reason (network error, the server returns an error code, a crossorigin check fails, etc), or if URL is the empty string or has the wrong origin p510 as determined by the condition at the start of this step, or if the fetched resource is not in a supported format, then queue a task p553 to first change the text track readiness state p255 to failed to load p255 and then fire a simple event p559 named error at the track p234 element; and then, once that task p553 is queued p553 , move on to the step below labeled monitoring. If the fetching algorithm p59 does not fail, then, when it completes, queue a task p553 to first change the text track readiness state p255 to loaded p255 and then fire a simple event p559 named load at the track p234 element; and then, once that task p553 is queued p553 , move on to the step below labeled monitoring. If, while the fetching algorithm p59 is active, either: the track URL p234 changes so that it is no longer equal to URL, while the text track mode p255 is set to hidden p255 , showing p255 , or showing by default p255 ; or the text track mode p255 changes to hidden p255 , showing p255 , or showing by default p255 , while the track URL p234 is not equal to URL
4.
...then the user agent must run the following steps: 1. 2. 3. 4. Abort the fetching algorithm p59 . Queue a task p553 to fire a simple event p559 named abort at the track p234 element. Let URL be the new track URL p234 . Jump back to the top of the step labeled download.
Until one of the above circumstances occurs, the user agent must remain on this step. 5. Monitoring: Wait until the track URL p234 is no longer equal to URL, at the same time as the text track mode p255 is set to hidden p255 , showing p255 , or showing by default p255 . Wait until the text track readiness state p255 is no longer set to loading p255 . Await a stable state p553 . The synchronous section p553 consists of the following step. (The step in the synchronous section p553 is marked with ?.) ? Set the text track readiness state p255 to loading p255 . End the synchronous section p553 , continuing the remaining steps asynchronously. Jump to the step labeled download.
6. 7.
8. 9. 10.
4.8.10.10.4 Guidelines for exposing cues in various formats as text track cues p256 How a specific format's text track cues are to be interpreted for the purposes of processing by an HTML user agent is defined by that format. In the absence of such a specification, this section provides some constraints within which implementations can attempt to consistently expose such formats. To support the text track p254 model of HTML, each unit of timed data is converted to a text track cue p256 . Where the mapping of the format's features to the aspects of a text track cue p256 as defined in this specification are not defined, implementations must ensure that the mapping is consistent with the definitions of the aspects of a text track cue p256 as defined above, as well as with the following constraints:
259
The text track cue identifier p256 Should be set to the empty string if the format has no obvious analogue to a per-cue identifier. The text track cue pause-on-exit flag p256 Should be set to false. The text track cue writing direction p256 Should be set to horizontal p256 if the concept of writing direction doesn't really apply (e.g. the cue consists of a bitmap image). The text track cue snap-to-lines flag p256 Should be set to false unless the format uses a rendering and positioning model for cues that is largely consistent with the WebVTT cue text rendering rules p719 . The text track cue line position p256 The text track cue text position p256 The text track cue size p256 The text track cue alignment p256 If the format uses a rendering and positioning model for cues that can be largely simulated using the WebVTT cue text rendering rules p719 , then these should be set to the values that would give the same effect for WebVTT p267 cues. Otherwise, they should be set to zero.
4.8.10.10.5 Text track API This box is non-normative. Implementation requirements are given below this box. media . tracks p260 . length Returns the number of text tracks p254 associated with the media element p235 (e.g. from track p234 elements). This is the number of text tracks p254 in the media element p235 's list of text tracks p254 . media . tracks[ p260 n ] Returns the TextTrack p260 object representing the nth text track p254 in the media element p235 's list of text tracks p254 . track . track p235 Returns the TextTrack p260 object representing the track p234 element's text track p254 .
The tracks attribute of media elements p235 must return an array host object for objects of type TextTrack p260 that is fixed length and read only. The same object must be returned each time the attribute is accessed. [WEBIDL] p785 The array must contain the TextTrack p260 objects of the text tracks p254 in the media element p235 's list of text tracks p254 , in the same order as in the list of text tracks p254 .
interface TextTrack { readonly attribute DOMString kind; readonly attribute DOMString label; readonly attribute DOMString language; const unsigned short NONE = 0; const unsigned short LOADING = 1; const unsigned short LOADED = 2; const unsigned short ERROR = 3; readonly attribute unsigned short readyState; readonly attribute Function onload; readonly attribute Function onerror; const unsigned short OFF = 0; const unsigned short HIDDEN = 1; const unsigned short SHOWING = 2; attribute unsigned short mode; readonly attribute TextTrackCueList cues; readonly attribute TextTrackCueList activeCues;
260
readonly attribute Function oncuechange; }; This box is non-normative. Implementation requirements are given below this box. timedTrack . kind
p261
Returns the text track kind p254 string. timedTrack . label p261 Returns the text track label p255 . timedTrack . language p261 Returns the text track language p255 string. timedTrack . readyState p261 Returns the text track readiness state p255 , represented by a number from the following list: TextTrack p260 . NONE p261 (0) The text track not loaded p255 state. TextTrack p260 . LOADING p261 (1) The text track loading p255 state. TextTrack p260 . LOADED p262 (2) The text track loaded p255 state. TextTrack p260 . ERROR p262 (3) The text track failed to load p255 state. timedTrack . mode p262 Returns the text track mode p255 , represented by a number from the following list: TextTrack p260 . OFF p262 (0) The text track disabled p255 mode. TextTrack p260 . HIDDEN p262 (1) The text track hidden p255 mode. TextTrack p260 . SHOWING p262 (2) The text track showing p255 and showing by default p255 modes. Can be set, to change the mode. timedTrack . cues p262 Returns the text track list of cues p255 , as a TextTrackCueList p264 object. timedTrack . activeCues p262 Returns the text track cues p256 from the text track list of cues p255 that are currently active (i.e. that start before the current playback position p247 and end after it), as a TextTrackCueList p264 object.
The kind attribute must return the text track kind p254 of the text track p254 that the TextTrack p260 object represents. The label attribute must return the text track label p255 of the text track p254 that the TextTrack p260 object represents. The language attribute must return the text track language p255 of the text track p254 that the TextTrack p260 object represents. The readyState attribute must return the numeric value corresponding to the text track readiness state p255 of the text track p254 that the TextTrack p260 object represents, as defined by the following list: NONE (numeric value 0) The text track not loaded p255 state. LOADING (numeric value 1) The text track loading p255 state.
261
LOADED (numeric value 2) The text track loaded p255 state. ERROR (numeric value 3) The text track failed to load p255 state. The mode attribute, on getting, must return the numeric value corresponding to the text track mode p255 of the text track p254 that the TextTrack p260 object represents, as defined by the following list: OFF (numeric value 0) The text track disabled p255 mode. HIDDEN (numeric value 1) The text track hidden p255 mode. SHOWING (numeric value 2) The text track showing p255 and showing by default p255 modes. On setting, if the new value is not either 0, 1, or 2, the user agent must throw an INVALID_ACCESS_ERR p75 exception. Otherwise, if the new value isn't equal to what the attribute would currently return, the new value must be processed as follows: If the new value is 0 Set the text track mode p255 of the text track p254 that the TextTrack p260 object represents to the text track disabled p255 mode. If the new value is 1 Set the text track mode p255 of the text track p254 that the TextTrack p260 object represents to the text track hidden p255 mode. If the new value is 2 Set the text track mode p255 of the text track p254 that the TextTrack p260 object represents to the text track showing p255 mode. Note: If the mode had been showing by default p255 , this will change it to showing p255 , even though the value of mode p262 would appear not to change. If the text track mode p255 of the text track p254 that the TextTrack p260 object represents is not the text track disabled p255 mode, then the cues attribute must return a live p29 TextTrackCueList p264 object that represents the subset of the text track list of cues p255 of the text track p254 that the TextTrack p260 object represents whose start times p256 occur before the earliest possible position when the script started p262 , in text track cue order p257 . Otherwise, it must return null. When an object is returned, the same object must be returned each time. The earliest possible position when the script started is whatever the earliest possible position p247 was the last time the event loop p552 reached step 1. If the text track mode p255 of the text track p254 that the TextTrack p260 object represents is not the text track disabled p255 mode, then the activeCues attribute must return a live p29 TextTrackCueList p264 object that represents the subset of the text track list of cues p255 of the text track p254 that the TextTrack p260 object represents whose active flag was set when the script started p262 , in text track cue order p257 . Otherwise, it must return null. When an object is returned, the same object must be returned each time. A text track cue p256 's active flag was set when the script started if its text track cue active flag p257 was set the last time the event loop p552 reached step 1.
interface MutableTextTrack : TextTrack { void addCue(in TextTrackCue cue); void removeCue(in TextTrackCue cue); }; This box is non-normative. Implementation requirements are given below this box. mutableTextTrack = media . addTrack p263 ( kind [, label [, language ] ] ) Creates and returns a new MutableTextTrack p262 object, which is also added to the media element p235 's list of text tracks p254 .
262
mutableTextTrack . addCue p263 ( cue ) Adds the given cue to mutableTextTrack's text track list of cues p255 . Raises an exception if the argument is null, associated with another text track p254 , or already in the list of cues. mutableTextTrack . removeCue p263 ( cue ) Removes the given cue from mutableTextTrack's text track list of cues p255 . Raises an exception if the argument is null, associated with another text track p254 , or not in the list of cues.
The addTrack(kind, label, language) method of media elements p235 , when invoked, must run the following steps: 1. If kind is not one of the following strings, then throw a SYNTAX_ERR p75 exception and abort these steps: 2. 3. 4. subtitles p254 captions p254 descriptions p254 chapters p254 metadata p254
If the label argument was omitted, let label be the empty string. If the language argument was omitted, let language be the empty string. Create a new text track p254 , and set its text track kind p254 to kind, its text track label p255 to label, its text track language p255 to language, its text track readiness state p255 to the text track loaded p255 state, its text track mode p255 to the text track hidden p255 mode, and its text track list of cues p255 to an empty list. Associate the text track list of cues p255 with the rules for updating the display of WebVTT text tracks p719 as its rules for updating the text track rendering p255 . Add the new text track p254 to the media element p235 's list of text tracks p254 .
5.
The addCue(cue) method of MutableTextTrack p262 objects, when invoked, must run the following steps: 1. 2. If cue is null, then throw an INVALID_ACCESS_ERR p75 exception and abort these steps. If the given cue is already associated with a text track p254 other than the method's MutableTextTrack p262 object's text track p254 , then throw an INVALID_STATE_ERR p75 exception and abort these steps. Associate cue with the method's MutableTextTrack p262 object's text track p254 , if it is not currently associated with a text track p254 . If the given cue is already listed in the method's MutableTextTrack p262 object's text track p254 's text track list of cues p255 , then throw an INVALID_STATE_ERR p75 exception. Add cue to the method's MutableTextTrack p262 object's text track p254 's text track list of cues p255 .
3.
4.
5.
The removeCue(cue) method of MutableTextTrack p262 objects, when invoked, must run the following steps: 1. 2. If cue is null, then throw an INVALID_ACCESS_ERR p75 exception and abort these steps. If the given cue is not associated with the method's MutableTextTrack p262 object's text track p254 , then throw an INVALID_STATE_ERR p75 exception. If the given cue is not currently listed in the method's MutableTextTrack p262 object's text track p254 's text track list of cues p255 , then throw a NOT_FOUND_ERR p75 exception. Remove cue from the method's MutableTextTrack p262 object's text track p254 's text track list of cues p255 .
3.
4.
In this example, an audio p231 element is used to play a specific sound-effect from a sound file containing many sound effects. A cue is used to pause the audio, so that it ends exactly at the end of the clip, even if the browser is busy running some script. If the page had relied on script to pause the audio, then the start of the next clip might be heard if the browser was not able to run the script at the exact time specified. var sfx = new Audio('sfx.wav'); var sounds = a.addTrack('metadata'); // add sounds we care about sounds.addCue(new TextTrackCue('dog bark', 12.783, 13.612, '', '', '', true)); sounds.addCue(new TextTrackCue('kitten mew', 13.612, 15.091, '', '', '', true));
263
function playSound(id) { sfx.currentTime = sounds.getCueById(id).startTime; sfx.play(); } sfx.oncanplaythrough = function () { playSound('dog bark'); } window.onbeforeunload = function () { playSound('kitten mew'); return 'Are you sure you want to leave this awesome page?'; }
interface TextTrackCueList { readonly attribute unsigned long length; getter TextTrackCue (in unsigned long index); TextTrackCue getCueById(in DOMString id); }; This box is non-normative. Implementation requirements are given below this box. cuelist . length
p264
Returns the number of cues p256 in the list. cuelist[index] Returns the text track cue p256 with index index in the list. The cues are sorted in text track cue order p257 . cuelist . getCueById p264 ( id ) Returns the first text track cue p256 (in text track cue order p257 ) with text track cue identifier p256 id. Returns null if none of the cues have the given identifier or if the argument is the empty string.
A TextTrackCueList p264 object represents a dynamically updating list of text track cues p256 in a given order. The length attribute must return the number of cues p256 in the list represented by the TextTrackCueList p264 object. The supported property indicies of a TextTrackCueList p264 object at any instant are the numbers from zero to the number of cues p256 in the list represented by the TextTrackCueList p264 object minus one, if any. If there are no cues p256 in the list, there are no supported property indicies. To determine the value of an indexed property for a given index index, the user agent must return the indexth text track cue p256 in the list represented by the TextTrackCueList p264 object. The getCueById(id) method, when called with an argument other than the empty string, must return the first text track cue p256 in the list represented by the TextTrackCueList p264 object whose text track cue identifier p256 is id, if any, or null otherwise. If the argument is the empty string, then the method must return null.
[Constructor(in DOMString id, in double startTime, in double endTime, in DOMString text, in optional DOMString settings, in optional boolean pauseOnExit)] interface TextTrackCue { readonly attribute TextTrack track; readonly attribute DOMString id; readonly attribute double startTime; readonly attribute double endTime; readonly attribute boolean pauseOnExit;
264
DOMString getCueAsSource(); DocumentFragment getCueAsHTML(); readonly attribute Function onenter; readonly attribute Function onexit; }; This box is non-normative. Implementation requirements are given below this box. cue = new TextTrackCue p266 ( id, startTime, endTime, text [, settings [, pauseOnExit ] ] ) Returns a new TextTrackCue p264 object, for use with the addCue() p263 method. The id argument sets the text track cue identifier p256 . The startTime argument sets the text track cue start time p256 . The endTime argument sets the text track cue end time p256 . The text argument sets the text track cue text p256 . The settings argument is a string in the format of WebVTT cue settings p269 . If omitted, the empty string is assumed. The pauseOnExit argument sets the text track cue pause-on-exit flag p256 . If omitted, false is assumed. cue . track p266 Returns the TextTrack p260 object to which this text track cue p256 belongs, if any, or null otherwise. cue . id p266 Returns the text track cue identifier p256 . cue . startTime p266 Returns the text track cue start time p256 , in seconds. cue . endTime p266 Returns the text track cue end time p256 , in seconds. cue . pauseOnExit p267 Returns true if the text track cue pause-on-exit flag p256 is set, false otherwise. cue . direction p267 Returns a string representing the text track cue writing direction p256 , as follows:
p256 If it is horizontal
The string "vertical-lr". cue . snapToLines p267 Returns true if the text track cue snap-to-lines flag p256 is set, false otherwise. cue . linePosition p267 Returns the text track cue line position p256 . In the case of the value being auto p256 , the appropriate default is returned. cue . textPosition p267 Returns the text track cue text position p256 . cue . size p267 Returns the text track cue size p256 .
265
cue . alignment p267 Returns a string representing the text track cue alignment p256 , as follows:
p256 If it is start alignment
The string "end". source = cue . getCueAsSource p267 () Returns the text track cue text p256 in raw unparsed form. fragment = cue . getCueAsHTML p267 () Returns the text track cue text p256 as a DocumentFragment p33 of HTML elements p28 and other DOM nodes.
The TextTrackCue(id, startTime, endTime, text, settings, pauseOnExit) constructor, when invoked, must run the following steps: 1. Create a new text track cue p256 that is not associated with any text track p254 . Let cue be that text track cue p256 . Let cue's text track cue identifier p256 be the value of the id argument. Let cue's text track cue start time p256 be the value of the startTime argument, interpreted as a time in seconds. Let cue's text track cue end time p256 be the value of the endTime argument, interpreted as a time in seconds. Let cue's text track cue pause-on-exit flag p256 be true if the pauseOnExit is present and true. Otherwise, let it be false. Let cue's text track cue text p256 be the value of the text argument, and let the rules for its interpretation be the WebVTT cue text parsing rules p277 , the WebVTT cue text rendering rules p719 , and the WebVTT cue text DOM construction rules p281 . Let cue's text track cue writing direction p256 be horizontal p256 . Let cue's text track cue snap-to-lines flag p256 be true. Let cue's text track cue line position p256 be auto p256 . Let cue's text track cue text position p256 be 50. Let cue's text track cue size p256 be 100. Let cue's text track cue alignment p256 be middle alignment p256 . Let input be the string given by the settings argument. Let position be a pointer into input, initially pointing at the start of the string. Parse the WebVTT settings p274 for cue. Return the TextTrackCue p264 object representing cue.
2. 3.
4.
5.
6.
The track attribute must return the TextTrack p260 object of the text track p254 with which the text track cue p256 that the TextTrackCue p264 object represents is associated, if any; or null otherwise. The id attribute must return the text track cue identifier p256 of the text track cue p256 that the TextTrackCue p264 object represents. The startTime attribute must return the text track cue start time p256 of the text track cue p256 that the TextTrackCue p264 object represents, in seconds. The endTime attribute must return the text track cue end time p256 of the text track cue p256 that the TextTrackCue p264 object represents, in seconds.
266
The pauseOnExit attribute must return true if the text track cue pause-on-exit flag p256 of the text track cue p256 that the TextTrackCue p264 object represents is set; or false otherwise. The direction attribute must return the text track cue writing direction p256 of the text track cue p256 that the TextTrackCue p264 object represents. The snapToLines attribute must return true if the text track cue snap-to-lines flag p256 of the text track cue p256 that the TextTrackCue p264 object represents is set; or false otherwise. The linePosition attribute must return the text track cue line position p256 of the text track cue p256 that the TextTrackCue p264 object represents, if that value is numeric. Otherwise, the value is the special value auto p256 ; if the text track cue snap-to-lines flag p256 of the text track cue p256 that the TextTrackCue p264 object represents is not set, the attribute must return the value 100; otherwise, it must return the value returned by the following algorithm: 1. 2. 3. 4. Let cue be the text track cue p256 that the TextTrackCue p264 object represents. If cue is not associated with a text track p254 , return 1 and abort these steps. Let track be the text track p254 that the cue is associated with. Let n be the number of text tracks p254 whose text track mode p255 is showing p255 or showing by default p255 and that are in the media element p235 's list of text tracks p254 before track. Return n.
5.
The textPosition attribute must return the text track cue text position p256 of the text track cue p256 that the TextTrackCue p264 object represents. The size attribute must return the text track cue size p256 of the text track cue p256 that the TextTrackCue p264 object represents. The alignment attribute must return the text track cue alignment p256 of the text track cue p256 that the TextTrackCue p264 object represents. The getCueAsSource() method must return the raw text track cue text p256 . The getCueAsHTML() method must convert the text track cue text p256 to a DocumentFragment p33 for the media element p235 's Document p33 , using the appropriate rules for doing so. For example, for WebVTT p267 , those rules are the WebVTT cue text parsing rules p277 and the WebVTT cue text DOM construction rules p281 .
4.8.10.10.6 Event definitions The following are the event handlers p555 that must be supported, as IDL attributes, by all objects implementing the TextTrack p260 interface:
Event handler p555 Event handler event type p556 onload onerror oncuechange load error cuechange
The following are the event handlers p555 that must be supported, as IDL attributes, by all objects implementing the TextTrackCue p264 interface:
Event handler p555 Event handler event type p556 onenter onexit enter exit
4.8.10.11 WebVTT The WebVTT format (Web Video Text Tracks) is a format intended for marking up external text track resources.
4.8.10.11.1 Syntax A WebVTT file must consist of a WebVTT file body p267 encoded as UTF-8 and labeled with the MIME type p28 text/ vtt p761 . [RFC3629] p784 A WebVTT file body consists of the following components, in the following order: 1. An optional U+FEFF BYTE ORDER MARK (BOM) character.
267
2. 3.
The string "WEBVTT", a single U+0020 SPACE character, and the string "FILE". Optionally, either a U+0020 SPACE character or a U+0009 CHARACTER TABULATION (tab) character followed by any number of characters that are not U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. Two or more WebVTT line terminators p268 . Zero or more WebVTT cues p268 separated from each other by two or more WebVTT line terminators p268 . Zero or more WebVTT line terminators p268 .
4. 5. 6.
A WebVTT cue consists of the following components, in the given order: 1. 2. 3. Optionally, a WebVTT cue identifier p268 followed by a WebVTT line terminator p268 . WebVTT cue timings p268 . Optionally, one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters followed by WebVTT cue settings p269 . A WebVTT line terminator p268 . The cue payload: either WebVTT cue text p270 or WebVTT metadata text p270 .
4. 5.
WebVTT cue text p270 is syntactically a subset of WebVTT metadata text p270 . Conformance checkers, when validating WebVTT p267 files, may offer to restrict all cues to only having WebVTT cue text p270 as their cue payload p268 ; WebVTT metadata text p270 cues are only useful for scripted applications (using the metadata text track kind p254 ). A WebVTT file p267 whose cues all have a cue payload p268 that is WebVTT cue text p270 is said to be a WebVTT file using cue text. A WebVTT line terminator consists of one of the following: A U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair. A single U+000A LINE FEED (LF) character. A single U+000D CARRIAGE RETURN (CR) character.
A WebVTT cue identifier is any sequence of one or more characters not containing the substring "-->" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN), nor containing any U+000A LINE FEED (LF) characters or U+000D CARRIAGE RETURN (CR) characters. The WebVTT cue timings part of a WebVTT cue p268 consists of the following components, in the given order: 1. A WebVTT timestamp p268 representing the start time offset of the cue. The time represented by this WebVTT timestamp p268 must be greater than or equal to the start time offsets of all previous cues in the file. A U+0020 SPACE character. The string "-->" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN). A U+0020 SPACE character. A WebVTT timestamp p268 representing the end time offset of the cue. The time represented by this WebVTT timestamp p268 must be greater than the start time offset of the cue.
2. 3. 4. 5.
A WebVTT timestamp representing a time in seconds and fractions of a second is a WebVTT timestamp p268 representing hours hours, minutes minutes, seconds seconds, and thousandths of a second seconds-frac, calculated as follows: 1. 2. Let seconds be the integer part of the time. Let seconds-frac be the fractional component of the time, expressed as the digits of the decimal fraction given to three decimal digits. If seconds is greater than 59, then let minutes be the integer component of seconds divided by sixty, and then let seconds be the remainder of dividing seconds divided by sixty. Otherwise, let minutes be zero. If minutes is greater than 59, then let hours be the integer component of minutes divided by sixty, and then let minutes be the remainder of dividing minutes divided by sixty. Otherwise, let hours be zero.
3.
4.
A WebVTT timestamp p268 representing hours hours, minutes minutes, seconds seconds, and thousandths of a second seconds-frac, consists of the following components, in the given order:
268
1.
Optionally (required if hour is non-zero): 1. Two or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), representing the hours as a base ten integer. 2. A U+003A COLON character (:) Two characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), representing the minutes as a base ten integer in the range 0 minutes 59. A U+003A COLON character (:) Two characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), representing the seconds as a base ten integer in the range 0 seconds 59. A U+002E FULL STOP character (.). Three characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), representing the thousandths of a second seconds-frac as a base ten integer.
2.
3. 4.
5. 6.
The WebVTT cue settings part of a WebVTT cue p268 consists of zero or more of the following components, in any order, separated from each other by one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters. Each component must not be included more than once per WebVTT cue settings p269 string. A A A A A WebVTT WebVTT WebVTT WebVTT WebVTT vertical text cue setting p269 . line position cue setting p269 . text position cue setting p269 . size cue setting p269 . alignment cue setting p269 .
A WebVTT vertical text cue setting consists of the following components, in the order given: 1. 2. 3. A U+0044 LATIN CAPITAL LETTER D character. A U+003A COLON character (:). One of the following strings: "vertical", "vertical-lr".
A WebVTT line position cue setting consists of the following components, in the order given: 1. 2. 3. A U+004C LATIN CAPITAL LETTER L character. A U+003A COLON character (:). Either: To represent a specific position relative to the video frame 1. 2. One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A U+0025 PERCENT SIGN character (%).
To represent a line number 1. 2. Optionally a U+002D HYPHEN-MINUS character (-). One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
A WebVTT text position cue setting consists of the following components, in the order given: 1. 2. 3. 4. A U+0054 LATIN CAPITAL LETTER T character. A U+003A COLON character (:). One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A U+0025 PERCENT SIGN character (%).
A WebVTT size cue setting consists of the following components, in the order given: 1. 2. 3. 4. A U+0053 LATIN CAPITAL LETTER S character. A U+003A COLON character (:). One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A U+0025 PERCENT SIGN character (%).
A WebVTT alignment cue setting consists of the following components, in the order given: 1. A U+0041 LATIN CAPITAL LETTER A character.
269
2. 3.
A U+003A COLON character (:). One of the following strings: "start", "middle", "end"
WebVTT metadata text consists of any sequence of one or more characters other than U+000A LINE FEED (LF) characters and U+000D CARRIAGE RETURN (CR) characters, each optionally separated from the next by a WebVTT line terminator p268 . (In other words, any text that does not have two consecutive WebVTT line terminators p268 and does not start or end with a WebVTT line terminator p268 .) WebVTT cue text consists of zero or more WebVTT cue components p270 , in any order, each optionally separated from the next by a WebVTT line terminator p268 . The WebVTT cue components are: A WebVTT cue class span p270 . A WebVTT cue italics span p270 . A WebVTT cue bold span p270 . A WebVTT cue ruby span p270 . A WebVTT cue voice span p270 . A WebVTT cue timestamp p271 . A WebVTT cue text span p271 , representing the text of the cue. A WebVTT cue amp escape p271 , representing a "&" character in the text of the cue. A WebVTT cue lt escape p271 , representing a "<" character in the text of the cue. A WebVTT cue gt escape p271 , representing a ">" character in the text of the cue.
WebVTT cue internal text consists of an optional WebVTT line terminator p268 , followed by zero or more WebVTT cue components p270 , in any order, each optionally followed by a WebVTT line terminator p268 . A WebVTT cue class span consists of a WebVTT cue span start tag p271 "c" that disallows an annotation, WebVTT cue internal text p270 representing cue text, and a WebVTT cue span end tag p271 "c". A WebVTT cue italics span consists of a WebVTT cue span start tag p271 "i" that disallows an annotation, WebVTT cue internal text p270 representing the italicized text, and a WebVTT cue span end tag p271 "i". A WebVTT cue bold span consists of a WebVTT cue span start tag p271 "b" that disallows an annotation, WebVTT cue internal text p270 representing the boldened text, and a WebVTT cue span end tag p271 "b". A WebVTT cue ruby span consists of the following components, in the order given: 1. 2. A WebVTT cue span start tag p271 "i" that disallows an annotation. One or more occurrences of the following group of components, in the order given: 1. WebVTT cue internal text p270 , representing the ruby base. 2. A WebVTT cue span start tag p271 "rt" that disallows an annotation. 3. A WebVTT cue ruby text span: WebVTT cue internal text p270 , representing the ruby text component of the ruby annotation. 4. A WebVTT cue span end tag p271 "rt". If this is the last occurance of this group of components in the WebVTT cue ruby span p270 , then this last end tag string may be omitted. If the last end tag string was not omitted: Optionally, a WebVTT line terminator p268 . If the last end tag string was not omitted: Zero or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters, each optionally followed by a WebVTT line terminator p268 . A WebVTT cue span end tag p271 "ruby".
3. 4.
5.
A WebVTT cue voice span consists of the following components, in the order given: 1. A WebVTT cue span start tag p271 "v" that requires an annotation; the annotation represents the name of the voice. WebVTT cue internal text p270 . A WebVTT cue span end tag p271 "v". If this WebVTT cue voice span p270 is the only component p270 of its WebVTT cue text p270 sequence, then the end tag may be omitted for brevity.
2. 3.
270
A WebVTT cue span start tag has a tag name and either allows, requires, and disallows an annotation, and consists of the following components, in the order given: 1. 2. 3. A U+003C LESS-THAN SIGN character (<). The tag name. Zero or more occurrences of the following sequence: 1. U+002E FULL STOP character (.) 2. One or more characters other than U+0009 CHARACTER TABULATION (tab) characters, U+000A LINE FEED (LF) characters, U+000D CARRIAGE RETURN (CR) characters, U+0020 SPACE characters, U+0026 AMPERSAND characters (&), U+003C LESS-THAN SIGN characters (<), U+003E GREATER-THAN SIGN characters (>), and U+002E FULL STOP characters (.), representing a class that describes the cue span's significance. If the start tag requires an annotation: one or more of the following components, the concatenation of their representations having a value that contains at least one character other than U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters: WebVTT cue span start tag annotation text p271 , representing the text of the annotation. A WebVTT cue amp escape p271 , representing a "&" character in the text of the annotation. A WebVTT cue lt escape p271 , representing a "<" character in the text of the annotation. A WebVTT cue gt escape p271 , representing a ">" character in the text of the annotation. A U+003E GREATER-THAN SIGN character (>).
4.
5.
A WebVTT cue span end tag has a tag name and consists of the following components, in the order given: 1. 2. 3. 4. A U+003C LESS-THAN SIGN character (<). U+002F SOLIDUS character (/). The tag name. A U+003E GREATER-THAN SIGN character (>).
A WebVTT cue timestamp consists of a U+003C LESS-THAN SIGN character (<), followed by a WebVTT timestamp p268 representing the time that the given point in the cue becomes active, followed by a U+003E GREATER-THAN SIGN character (>). The time represented by the WebVTT timestamp p268 must be greater than the times represented by any previous WebVTT cue timestamps p271 in the cue, as well as greater than the cue's start time offset, and less than the cue's end time offset. A WebVTT cue text span consists of one or more characters other than U+000A LINE FEED (LF) characters, U+000D CARRIAGE RETURN (CR) characters, U+0026 AMPERSAND characters (&), and U+003C LESS-THAN SIGN characters (<). WebVTT cue span start tag annotation text consists of one or more characters other than U+000A LINE FEED (LF) characters, U+000D CARRIAGE RETURN (CR) characters, U+0026 AMPERSAND characters (&), and U+003E GREATER-THAN SIGN characters (>). A WebVTT cue amp escape is the five character string "&". A WebVTT cue lt escape is the five character string "<". A WebVTT cue gt escape is the five character string ">".
4.8.10.11.2 Parsing A WebVTT parser, given an input byte stream and a text track list of cues p255 output, must decode the byte stream as UTF-8, with error handling p36 , and then must parse the resulting string according to the WebVTT parser algorithm p271 below. This results in text track cues p256 being added to output. [RFC3629] p784 A WebVTT parser p271 , specifically its conversion and parsing steps, is typically run asynchronously, with the input byte stream being updated incrementally as the resource is downloaded; this is called an incremental WebVTT parser. A WebVTT parser p271 verifies a file signature before parsing the provided byte stream. If the stream lacks this WebVTT file signature, then the parser aborts. When converting the bytes into Unicode characters, if the encoding used is UTF-8, the bytes must be decoded with the error handling p36 defined in this specification, and all U+0000 NULL characters must be replaced by U+FFFD REPLACEMENT CHARACTERs. The WebVTT parser algorithm is as follows:
271
1.
Let input be the string being parsed, after conversion to Unicode and after the replacement of U+0000 NULL characters described above. Let position be a pointer into input, initially pointing at the start of the string. In an incremental WebVTT parser p271 , when this algorithm (or further algorithms that it uses) moves the position pointer, the user agent must wait until appropriate further characters from the byte stream have been added to input before moving the pointer, so that the algorithm never reads past the end of the input string. Once the byte stream has ended, and all characters have been added to input, then the position pointer may, when so instructed by the algorithms, be moved past the end of input. If the character indicated by position is a U+FEFF BYTE ORDER MARK (BOM) character, advance position to the next character in input. Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If line is less than eleven characters long, then abort these steps. The file is not a WebVTT file p267 . If line is exactly eleven characters long but does not exactly equal "WEBVTT FILE", then abort these steps. The file is not a WebVTT file p267 . If line is more than eleven characters long but does the first elevent characters do not exactly equal "WEBVTT FILE", or the twelfth character is neither a U+0020 SPACE character nor a U+0009 CHARACTER TABULATION (tab) character, then abort these steps. The file is not a WebVTT file p267 . If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000D CARRIAGE RETURN (CR) character, advance position to the next character in input. If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000A LINE FEED (LF) character, advance position to the next character in input. Header p152 : Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000D CARRIAGE RETURN (CR) character, advance position to the next character in input. If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000A LINE FEED (LF) character, advance position to the next character in input. If line is not the empty string, then jump back to the step labeled header p152 . Cue loop: Collect a sequence of characters p37 that are either U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let cue be a new text track cue p256 associated with output's text track p254 . Let cue's text track cue identifier p256 be the empty string. Let cue's text track cue pause-on-exit flag p256 be false. Let cue's text track cue writing direction p256 be horizontal p256 . Let cue's text track cue snap-to-lines flag p256 be true. Let cue's text track cue line position p256 be auto p256 . Let cue's text track cue text position p256 be 50. Let cue's text track cue size p256 be 100. Let cue's text track cue alignment p256 be middle alignment p256 . Let cue's text track cue text p256 be the empty string. Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If line is the empty string, then discard cue and jump to the step labeled end.
2.
3.
4.
5. 6.
7.
8. 9.
10. 11.
12.
13. 14.
15. 16.
17. 18.
19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29.
30.
272
31.
If line contains the three-character substring "-->" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN), then jump to the step labeled timings below. Let cue's text track cue identifier p256 be line. If position is past the end of input, then discard cue and jump to the step labeled end. If the character indicated by position is a U+000D CARRIAGE RETURN (CR) character, advance position to the next character in input. If position is past the end of input, then discard cue and jump to the step labeled end. If the character indicated by position is a U+000A LINE FEED (LF) character, advance position to the next character in input. Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If line is the empty string, then discard cue and jump to the step labeled cue loop. Timings: Collect WebVTT cue timings and settings p273 from line, using cue for the results. If that fails, jump to the step labeled bad cue. Let cue text be the empty string. Cue text loop: If position is past the end of input, then discard cue and jump to the step labeled cue text processing. If the character indicated by position is a U+000D CARRIAGE RETURN (CR) character, advance position to the next character in input. If position is past the end of input, then discard cue and jump to the step labeled cue text processing. If the character indicated by position is a U+000A LINE FEED (LF) character, advance position to the next character in input. Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If line is the empty string, then jump to the step labeled cue text processing. If cue text is not empty, append a U+000A LINE FEED (LF) character to cue text. Let cue text be the concatenation of cue text and line. Return to the step labeled cue text loop. Cue text processing: Let the text track cue text p256 of cue be cue text, and let the rules for its interpretation be the WebVTT cue text parsing rules p277 , the WebVTT cue text rendering rules p719 , and the WebVTT cue text DOM construction rules p281 . Add cue to the text track list of cues p255 output. Jump to the step labeled cue loop. Bad cue: Discard cue. Bad cue loop: If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000D CARRIAGE RETURN (CR) character, advance position to the next character in input. If position is past the end of input, then jump to the step labeled end. If the character indicated by position is a U+000A LINE FEED (LF) character, advance position to the next character in input. Collect a sequence of characters p37 that are not U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) characters. Let line be those characters, if any. If line is the empty string, then jump to the step labeled cue loop. Otherwise, jump to the step labeled bad cue loop. End: The file has ended. Abort these steps. The WebVTT parser p271 has finished.
35. 36.
37.
38. 39.
40. 41.
42.
43. 44.
45.
56. 57.
58.
When the algorithm above requires that the user agent collect WebVTT cue timings and settings from a string input for a text track cue p256 cue, the user agent must run the following algorithm.
273
1. 2. 3. 4.
Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Skip whitespace p38 . Collect a WebVTT timestamp p276 . If that algorithm fails, then abort these steps and return failure. Otherwise, let cue's text track cue start time p256 be the collected time. Skip whitespace p38 . If the character at position is not a U+002D HYPHEN-MINUS character (-) then abort these steps and return failure. Otherwise, move position forwards one character. If the character at position is not a U+002D HYPHEN-MINUS character (-) then abort these steps and return failure. Otherwise, move position forwards one character. If the character at position is not a U+003E GREATER-THAN SIGN character (>) then abort these steps and return failure. Otherwise, move position forwards one character. Skip whitespace p38 . Collect a WebVTT timestamp p276 . If that algorithm fails, then abort these steps and return failure. Otherwise, let cue's text track cue end time p256 be the collected time. Skip whitespace p38 . Parse the WebVTT settings p274 for cue.
5. 6.
7.
8.
9. 10.
11. 12.
When the user agent is to parse the WebVTT settings for a text track cue p256 cue, the user agent must run the following steps: 1. Let input and position be the same variables as those of the same name in the algorithm that invoked these steps. Settings: If position is beyond the end of input then abort these steps. Let setting be the character at position, and move position forwards one character. If position is beyond the end of input then abort these steps. If the character at position is not a U+003A COLON character (:), then set setting to the empty string. Move position forwards one character. If position is beyond the end of input then abort these steps. Run the appropriate substeps that apply for the value of setting, as follows: If setting is a U+0044 LATIN CAPITAL LETTER D character 1. Collect a sequence of characters p37 that are not space characters p37 . Let value be those characters, if any. If value is a case-sensitive p36 match for the string "vertical", then let cue's text track cue writing direction p256 be vertical growing left p256 . Otherwise, if value is a case-sensitive p36 match for the string "vertical-lr", then let cue's text track cue writing direction p256 be vertical growing right p256 .
2. 3. 4. 5. 6. 7. 8.
2.
3.
If setting is a U+004C LATIN CAPITAL LETTER L character 1. Collect a sequence of characters p37 that are either U+002D HYPHEN-MINUS characters (-), U+0025 PERCENT SIGN characters (%), or characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Let value be those characters, if any. If position is not beyond the end of input but the character at position is not a space character p37 , then jump to the "otherwise" case below. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump back to the step labeled settings. If any character in value other than the first character is a U+002D HYPHEN-MINUS character (-), then jump back to the step labeled settings. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%), then jump back to the step labeled settings.
2.
3.
4.
5.
274
6.
If the first character in value is a U+002D HYPHEN-MINUS character (-) and the last character in value is a U+0025 PERCENT SIGN character (%), then jump back to the step labeled settings. If the last character in value is a U+0025 PERCENT SIGN character (%), then let cue's text track cue snap-to-lines flag p256 to true. Ignoring the trailing percent sign, if any, interpret value as a (potentially signed) integer, and let number be that number. If the modulus of number is not in the range 0 number 100, then jump back to the step labeled settings. Let cue's text track cue line position p256 be number.
7.
8.
9.
10.
If setting is a U+0054 LATIN CAPITAL LETTER T character 1. Collect a sequence of characters p37 that are in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Let value be those characters, if any. If position is beyond the end of input then jump back to the step labeled settings. If the character at position is not a U+0025 PERCENT SIGN character (%), then then jump to the "otherwise" case below. Move position forwards one character. If position is not beyond the end of input but the character at position is not a space character p37 , then jump to the "otherwise" case below. If value is the empty string, then jump back to the step labeled settings. Interpret value as an integer, and let number be that number. If number is not in the range 0 number 100, then jump back to the step labeled settings. Let cue's text track cue text position p256 be number.
2. 3.
4. 5.
6. 7. 8.
9.
If setting is a U+0053 LATIN CAPITAL LETTER S character 1. Collect a sequence of characters p37 that are in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Let value be those characters, if any. If position is beyond the end of input then jump back to the step labeled settings. If the character at position is not a U+0025 PERCENT SIGN character (%), then then jump to the "otherwise" case below. Move position forwards one character. If position is not beyond the end of input but the character at position is not a space character p37 , then jump to the "otherwise" case below. If value is the empty string, then jump back to the step labeled settings. Interpret value as an integer, and let number be that number. If number is not in the range 0 number 100, then jump back to the step labeled settings. Let cue's text track cue size p256 be number.
2. 3.
4. 5.
6. 7. 8.
9.
If setting is a U+0041 LATIN CAPITAL LETTER A character 1. Collect a sequence of characters p37 that are not space characters p37 . Let value be those characters, if any. If value is a case-sensitive p36 match for the string "start", then let cue's text track cue alignment p256 be start alignment p256 . If value is a case-sensitive p36 match for the string "middle", then let cue's text track cue alignment p256 be middle alignment p256 . If value is a case-sensitive p36 match for the string "end", then let cue's text track cue alignment p256 be end alignment p256 .
2.
3.
4.
275
Otherwise Collect a sequence of characters p37 that are not space characters p37 and discard them. 9. Jump back to the step labeled settings.
When this specification says that a user agent is to collect a WebVTT timestamp, the user agent must run the following steps: 1. Let input and position be the same variables as those of the same name in the algorithm that invoked these steps. Let most significant units be minutes. If position is past the end of input, return an error and abort these steps. If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error and abort these steps. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and let string be the collected substring. Interpret string as a base-ten integer. Let value1 be that integer. If string is not exactly two characters in length, or if value1 is greater than 59, let most significant units be hours. If position is beyond the end of input or if the character at position is not a U+003A COLON character (:), then return an error and abort these steps. Otherwise, move position forwards one character. If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error and abort these steps. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and let string be the collected substring. If string is not exactly two characters in length, return an error and abort these steps. Interpret string as a base-ten integer. Let value2 be that integer. If most significant units is hours, or if position is not beyond the end of input and the character at position is not a U+003A COLON character (:), run these substeps: 1. If position is beyond the end of input or if the character at position is not a U+003A COLON character (:), then return an error and abort these steps. Otherwise, move position forwards one character. If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error and abort these steps. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and let string be the collected substring. If string is not exactly two characters in length, return an error and abort these steps. Interpret string as a base-ten integer. Let value3 be that integer.
2. 3. 4.
5.
6. 7.
8.
9.
10.
2.
3.
4. 5.
Otherwise (if most significant units is not hours, and either position is beyond the end of input, or the character at position is not a U+003A COLON character (:)), let value3 have the value of value2, then value2 have the value of value1, then let value1 equal zero. 14. If position is beyond the end of input or if the character at position is not a U+002E FULL STOP character (.), then return an error and abort these steps. Otherwise, move position forwards one character. If the character indicated by position is not one of U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then return an error and abort these steps. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and let string be the collected substring. If string is not exactly three characters in length, return an error and abort these steps. Interpret string as a base-ten integer. Let value4 be that integer. If value2 is greater than 59, if value3 is greater than 59, or if value4 is greater than 999, return an error and abort these steps. Let result be value16060 + value260 + value3 + value41000.
15.
16.
20.
276
21.
Return result.
4.8.10.11.3 WebVTT cue text parsing rules A WebVTT Node Object is a conceptual construct used to represent components of WebVTT cue text p270 so that its processing can be described without reference to the underlying syntax. There are two broad classes of WebVTT Node Objects p277 : WebVTT Internal Node Objects p277 and WebVTT Leaf Node Objects p277 . WebVTT Internal Node Objects are those that can contain further WebVTT Node Objects p277 . They are conceptually similar to elements in HTML or the DOM. WebVTT Internal Node Objects p277 have an ordered list of child WebVTT Node Objects p277 . The WebVTT Internal Node Object p277 is said to be the parent of the children. Cycles do not occur; the parent-child relationships so constructed form a tree structure. WebVTT Internal Node Objects p277 also have an ordered list of class names, know as their applicable classes. There are several concrete classes of WebVTT Internal Node Objects p277 : Lists of WebVTT Node Objects These are used as root nodes for trees of WebVTT Node Objects p277 . WebVTT Class Objects These represent spans of text (a WebVTT cue class span p270 ) in WebVTT cue text p270 , and are used to annotate parts of the cue with applicable classes p277 without implying further meaning (such as italics or bold). WebVTT Italic Objects These represent spans of italic text (a WebVTT cue italics span p270 ) in WebVTT cue text p270 . WebVTT Bold Objects These represent spans of bold text (a WebVTT cue bold span p270 ) in WebVTT cue text p270 . WebVTT Ruby Objects These represent spans of ruby (a WebVTT cue ruby span p270 ) in WebVTT cue text p270 . WebVTT Ruby Text Objects These represent spans of ruby text (a WebVTT cue ruby text span p270 ) in WebVTT cue text p270 . WebVTT Voice Objects These represent spans of text associated with a specific voice (a WebVTT cue voice span p270 ) in WebVTT cue text p270 . A WebVTT Voice Object p277 has a value, which is the name of the voice. WebVTT Leaf Node Objects are those that contain data, such as text, and cannot contain child WebVTT Node Objects p277 . There are two concrete classes of WebVTT Leaf Node Objects p277 : WebVTT Text Objects A fragment of text. A WebVTT Text Object p277 has a value, which is the text it represents. WebVTT Timestamp Objects A timestamp. A WebVTT Timestamp Object p277 has a value, in seconds and fractions of a second, which is the time represented by the timestamp. To parse a string input supposedly containing WebVTT cue text p270 , user agents must use the following algorithm. This algorithm returns a list of WebVTT Node Objects p277 . 1. 2. 3. 4. 5. 6. 7. Let input be the string being parsed. Let position be a pointer into input, initially pointing at the start of the string. Let result be a List of WebVTT Node Objects p277 , initially empty. Let current be the WebVTT Internal Node Object p277 result. Loop: If position is past the end of input, return result and abort these steps. Let token be the result of invoking the WebVTT cue text tokenizer p278 . Run the appropriate steps given the type of token:
277
If token is a string 1. 2. Create a WebVTT Text Object p277 whose value is the value of the string token token. Append the newly created WebVTT Text Object p277 to current.
If token is a start tag How the start tag token token is processed depends on its tag name, as follows: If the tag name is the empty string Ignore the token. If the tag name is "c" Attach p278 a WebVTT Class Object p277 . If the tag name is "i" Attach p278 a WebVTT Italic Object p277 . If the tag name is "b" Attach p278 a WebVTT Bold Object p277 . If the tag name is "ruby" Attach p278 a WebVTT Ruby Object p277 . If the tag name is "rt" If current is a WebVTT Ruby Object p277 , then attach p278 a WebVTT Ruby Text Object p277 . If the tag name is "v" Attach p278 a WebVTT Voice Object p277 , and set its value to the token's annotation string. Otherwise Ignore the token. When the steps above say to attach a WebVTT Internal Node Object of a particular class, the user agent must first create an object of the specified class, then set its list of applicable classes p277 to the list of classes in the token, append the newly created node object to current, and finally let current be the newly created node object. If token is an end tag If any of the following conditions is true, then let current be the parent node of current. The tag name The tag name The tag name The tag name Object p277 . The tag name Object p277 . The tag name of of of of the the the the end end end end tag tag tag tag token token token token token token token token is is is is "c" and current is a WebVTT Class Object p277 . "i" and current is a WebVTT Italic Object p277 . "b" and current is a WebVTT Bold Object p277 . "ruby" and current is a WebVTT Ruby
of the end tag token token is "rt" and current is a WebVTT Ruby Text of the end tag token token is "v" and current is a WebVTT Voice Object p277 .
Otherwise, if the tag name of the end tag token token is "ruby" and current is a WebVTT Ruby Text Object p277 , then let current be the parent node of current of the parent node of current. Otherwise, ignore the token. If token is a timestamp tag 1. 2. 3. 4. Let input be the tag value. Let position be a pointer into input, initially pointing at the start of the string. Collect a WebVTT timestamp p276 . If that algorithm does not fail, and if position now points at the end of input (i.e. there are no trailing characters after the timestamp), then create a WebVTT Timestamp Object p277 whose value is the collected time, then append it to current. Otherwise, ignore the token. 8. Jump to the step labeled loop.
The WebVTT cue text tokenizer is as follows. It emits a token, which is either a string (whose value is a sequence of Unicode characters), a start tag (with a tag name, a list of classes, and optionally an annotation), an end tag (with a tag name), or a timestamp tag (with a tag value). 1. Let input and position be the same variables as those of the same name in the algorithm that invoked these steps.
278
2. 3. 4. 5. 6.
Let tokenizer state be WebVTT data state p279 . Let result be the empty string. Let buffer be the empty string. Let classes be an empty list. Loop: If position is past the end of input, let c be an end-of-file marker. Otherwise, let c be the character in input pointed to by position. Jump to the state given by tokenizer state: WebVTT data state Jump to the entry that matches the value of c: U+0026 AMPERSAND (&) Set buffer to c, set tokenizer state to the WebVTT escape state p279 , and jump to the step labeled next. U+003C LESS-THAN SIGN (<) If result is the empty string, then set tokenizer state to the WebVTT tag state p279 and jump to the step labeled next. Otherwise, return a string token whose value is result and abort these steps. End-of-file marker Return a string token whose value is result and abort these steps. Anything else Append c to result and jump to the step labeled next. WebVTT escape state Jump to the entry that matches the value of c: U+003B SEMICOLON character (;) First, examine the value of buffer: If buffer is the string "&", then append a U+0026 AMPERSAND character (&) to result. If buffer is the string "<", then append a U+003C LESS-THAN SIGN character (<) to result. If buffer is the string ">", then append a U+003E GREATER-THAN SIGN character (>) to result. Otherwise, append buffer followed by a U+003B SEMICOLON character (;) to result. Then, in any case, set tokenizer state to the WebVTT data state p279 , and jump to the step labeled next. Characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) Characters in the range U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z Characters in the range U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z Append c to buffer and jump to the step labeled next. End-of-file marker Append buffer to result, return a string token whose value is result, and abort these steps. Anything else Append buffer to result, set tokenizer state to the WebVTT data state p279 , and jump to the step labeled next. WebVTT tag state Jump to the entry that matches the value of c: U+0020 SPACE character U+0009 CHARACTER TABULATION (tab) character Set tokenizer state to the WebVTT start tag annotation state p280 , and jump to the step labeled next. U+002E FULL STOP character (.) Set tokenizer state to the WebVTT start tag class state p280 , and jump to the step labeled next.
7.
279
U+002F SOLIDUS character (/) Set tokenizer state to the WebVTT end tag state p280 , and jump to the step labeled next. Characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) Set result to c, set tokenizer state to the WebVTT timestamp tag state p281 , and jump to the step labeled next. U+003E GREATER-THAN SIGN character (>) End-of-file marker Return a start tag whose tag name is the empty string, with no classes and no annotation, and abort these steps. Anything else Set result to c, set tokenizer state to the WebVTT start tag state p280 , and jump to the step labeled next. WebVTT start tag state Jump to the entry that matches the value of c: U+0020 SPACE character U+0009 CHARACTER TABULATION (tab) character Set tokenizer state to the WebVTT start tag annotation state p280 , and jump to the step labeled next. U+002E FULL STOP character (.) Set tokenizer state to the WebVTT start tag class state p280 , and jump to the step labeled next. U+003E GREATER-THAN SIGN character (>) End-of-file marker Return a start tag whose tag name is result, with no classes and no annotation, and abort these steps. Anything else Append c to result and jump to the step labeled next. WebVTT start tag class state Jump to the entry that matches the value of c: U+0020 SPACE character U+0009 CHARACTER TABULATION (tab) character Append to classes an entry whose value is buffer, set buffer to the empty string, set tokenizer state to the WebVTT start tag annotation state p280 , and jump to the step labeled next. U+002E FULL STOP character (.) Append to classes an entry whose value is buffer, set buffer to the empty string, and jump to the step labeled next. U+003E GREATER-THAN SIGN character (>) End-of-file marker Append to classes an entry whose value is buffer, then return a start tag whose tag name is result, with the classes given in classes but no annotation, and abort these steps. Anything else Append c to buffer and jump to the step labeled next. WebVTT start tag annotation state Jump to the entry that matches the value of c: U+003E GREATER-THAN SIGN character (>) End-of-file marker Remove any leading or trailing U+0020 SPACE or U+0009 CHARACTER TABULATION (tab) characters from buffer, and replace any sequence of one or more consecutive U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters in buffer with a single U+0020 SPACE character; then, return a start tag whose tag name is result, with the classes given in classes, and with buffer as the annotation, and abort these steps. Anything else Append c to buffer and jump to the step labeled next. WebVTT end tag state Jump to the entry that matches the value of c:
280
U+003E GREATER-THAN SIGN character (>) End-of-file marker Return an end tag whose tag name is result and abort these steps. Anything else Append c to result and jump to the step labeled next. WebVTT timestamp tag state Jump to the entry that matches the value of c: U+003E GREATER-THAN SIGN character (>) End-of-file marker Return a timestamp tag whose tag name is result and abort these steps. Anything else Append c to result and jump to the step labeled next. 8. 9. Next: Advance position to the next character in input. Jump to the step labeled loop.
4.8.10.11.4 WebVTT cue text DOM construction rules To convert a List of WebVTT Node Objects p277 to a DOM tree for Document p33 owner, user agents must create a tree of DOM nodes that is isomorphous to the tree of WebVTT Node Objects p277 , with the following mapping of WebVTT Node Objects p277 to DOM nodes:
WebVTT Node Object p277 List of WebVTT Node Objects p277 WebVTT Class Object p277 WebVTT Italic Object p277 DocumentFragment p33 node DOM node
HTMLElement p88 element node with localName p33 "span p194 ".
HTMLElement p88 element node with localName p33 "i p187 ".
WebVTT Bold HTMLElement p88 element node with localName p33 "b p188 ". Object p277 WebVTT Ruby Object p277 WebVTT Ruby Text Object p277 WebVTT Voice Object p277 WebVTT Text Object p277 WebVTT Timestamp Object p277 HTMLElement p88 element node with localName p33 "ruby p191 ".
HTMLElement p88 element node with localName p33 "rt p192 ".
HTMLElement p88 element node with localName p33 "q p179 ", a title p92 attribute set to the WebVTT Voice Object p277 's value.
Text p33 node whose character data is the value of the WebVTT Text Object p277 . ProcessingInstruction p33 node whose target is "timestamp" and whose data is a WebVTT timestamp p268 representing the value of the WebVTT Timestamp Object p277 , with all optional components included and with the seconds separator being a U+002E FULL STOP character (.).
HTMLElement p88 nodes created as part of the mapping described above must have their namespaceURI p33 set to the HTML namespace p75 , and must have a class p95 attribute set to the string obtained by concatenating all the classes that apply to the corresponding WebVTT Internal Node Object p277 , each separated from the next by a single U+0020 SPACE character. The ownerDocument p33 attribute of all nodes in the DOM tree must be set to the given document owner. All characteristics of the DOM nodes that are not described above or dependent on characteristics defined above must be left at their initial values.
4.8.10.12 User interface The controls attribute is a boolean attribute p38 . If present, it indicates that the author has not provided a scripted controller and would like the user agent to provide its own set of controls.
281
If the attribute is present, or if scripting is disabled p550 for the media element p235 , then the user agent should expose a user interface to the user. This user interface should include features to begin playback, pause playback, seek to an arbitrary position in the content (if the content supports arbitrary seeking), change the volume, change the display of closed captions or embedded sign-language tracks, select different audio tracks or turn on audio descriptions, and show the media content in manners more suitable to the user (e.g. full-screen video or in an independent resizable window). Other controls may also be made available. Even when the attribute is absent, however, user agents may provide controls to affect playback of the media resource (e.g. play, pause, seeking, and volume controls), but such features should not interfere with the page's normal rendering. For example, such features could be exposed in the media element p235 's context menu. Where possible (specifically, for starting, stopping, pausing, and unpausing playback, for seeking, for listing, enabling, and disabling text tracks, and for muting or changing the volume of the audio), user interface features exposed by the user agent must be implemented in terms of the DOM API described above, so that, e.g., all the same events fire. For the purposes of listing chapters in the media resource p236 , only text tracks p254 in the media element p235 's list of text tracks p254 showing p255 or showing by default p255 and whose text track kind p254 is chapters should be used. Each cue p256 in such a text track p254 represents a chapter starting at the cue's start time p256 . The name of the chapter is the text track cue text p256 , interpreted literally. The controls IDL attribute must reflect p62 the content attribute of the same name. This box is non-normative. Implementation requirements are given below this box. media . volume
p282
[ = value ]
Returns the current playback volume, as a number in the range 0.0 to 1.0, where 0.0 is the quietest and 1.0 the loudest. Can be set, to change the volume. Throws an INDEX_SIZE_ERR p75 if the new value is not in the range 0.0 .. 1.0. media . muted p282 [ = value ] Returns true if audio is muted, overriding the volume p282 attribute, and false if the volume p282 attribute is being honored. Can be set, to change whether the audio is muted or not.
The volume attribute must return the playback volume of any audio portions of the media element p235 , in the range 0.0 (silent) to 1.0 (loudest). Initially, the volume must be 1.0, but user agents may remember the last set value across sessions, on a per-site basis or otherwise, so the volume may start at other values. On setting, if the new value is in the range 0.0 to 1.0 inclusive, the attribute must be set to the new value and the playback volume must be correspondingly adjusted as soon as possible after setting the attribute, with 0.0 being silent, and 1.0 being the loudest setting, values in between increasing in loudness. The range need not be linear. The loudest setting may be lower than the system's loudest possible setting; for example the user could have set a maximum volume. If the new value is outside the range 0.0 to 1.0 inclusive, then, on setting, an INDEX_SIZE_ERR p75 exception must be raised instead. The muted attribute must return true if the audio channels are muted and false otherwise. Initially, the audio channels should not be muted (false), but user agents may remember the last set value across sessions, on a persite basis or otherwise, so the muted state may start as muted (true). On setting, the attribute must be set to the new value; if the new value is true, audio playback for this media resource p236 must then be muted, and if false, audio playback must then be enabled. Whenever either the muted p282 or volume p282 attributes are changed, the user agent must queue a task p553 to fire a simple event p559 named volumechange p285 at the media element p235 . The audio attribute on the video p228 element controls the default state of the audio channel of the media resource p236 , potentially overriding user preferences. The audio p282 attribute, if specified, must have a value that is an unordered set of unique space-separated tokens p53 , which are ASCII case-insensitive p36 . The tokens must be from the following list (currently, only one allowed token is defined): muted Causes the user agent to override the user's preferences, if any, and always default the video to muted. Note: A future version of this specification will probably introduce new values here, e.g. to control the default volume, or to select a default audio track.
282
When a video p228 element is created, if it has an audio p282 attribute specified, the user agent must split the attribute's value on spaces p53 ; if any of the tokens are an ASCII case-insensitive p36 match for the string muted p282 , the user agent must then set the muted p282 attribute to true, overriding any user preference. Note: This attribute has no dynamic effect (it only controls the default state of the element). This video (an advertisment) autoplays, but to avoid annoying users, it does so without sound, and allows the user to turn the sound on. <video src="adverts.cgi?kind=video" controls autoplay loop audio=muted></video>
4.8.10.13 Time ranges Objects implementing the TimeRanges p283 interface represent a list of ranges (periods) of time. interface TimeRanges { readonly attribute unsigned long length; double start(in unsigned long index); double end(in unsigned long index); }; This box is non-normative. Implementation requirements are given below this box. media . length p283 Returns the number of ranges in the object. time = media . start p283 (index) Returns the time for the start of the range with the given index. Throws an INDEX_SIZE_ERR p75 if the index is out of range. time = media . end p283 (index) Returns the time for the end of the range with the given index. Throws an INDEX_SIZE_ERR p75 if the index is out of range.
The length IDL attribute must return the number of ranges represented by the object. The start(index) method must return the position of the start of the indexth range represented by the object, in seconds measured from the start of the timeline that the object covers. The end(index) method must return the position of the end of the indexth range represented by the object, in seconds measured from the start of the timeline that the object covers. These methods must raise INDEX_SIZE_ERR p75 exceptions if called with an index argument greater than or equal to the number of ranges represented by the object. When a TimeRanges p283 object is said to be a normalized TimeRanges object, the ranges it represents must obey the following criteria: The start of a range must be greater than the end of all earlier ranges. The start of a range must be less than the end of that same range.
In other words, the ranges in such an object are ordered, don't overlap, aren't empty, and don't touch (adjacent ranges are folded into one bigger range). The timelines used by the objects returned by the buffered p246 , seekable p254 and played p251 IDL attributes of media elements p235 must be that element's media timeline p246 .
4.8.10.14 Event summary This section is non-normative. The following events fire on media elements p235 as part of the processing model described above:
Event name loadstart Interface Event
p33
Dispatched when... The user agent begins looking for media data p236 , as part of the resource selection algorithm p240 . networkState
p238
283
Dispatched when... The user agent is fetching media data p236 . The user agent is intentionally not currently fetching media data p236 , but does not have the entire media resource p236 downloaded. The user agent stops fetching the media data p236 before it is completely downloaded, but not due to an error. An error occurs while fetching the media data p236 .
Preconditions networkState p238 equals NETWORK_LOADING p239 networkState p238 equals NETWORK_IDLE p239
abort
Event p33
error p236 is an object with the code MEDIA_ERR_ABORTED p237 . networkState p238 equals either NETWORK_EMPTY p239 or NETWORK_IDLE p239 , depending on when the download was aborted. error p236 is an object with the code MEDIA_ERR_NETWORK p237 or higher. networkState p238 equals either NETWORK_EMPTY p239 or NETWORK_IDLE p239 , depending on when the download was aborted.
error
Event p33
emptied
Event p33
A media element p235 whose networkState p238 networkState p238 is NETWORK_EMPTY p239 ; all the IDL was previously not in the NETWORK_EMPTY p239 attributes are in their initial states. state has just switched to that state (either because of a fatal error during load that's about to be reported, or because the load() p239 method was invoked while the resource selection algorithm p240 was already running). The user agent is trying to fetch media data p236 , but data is unexpectedly not forthcoming. networkState p238 is NETWORK_LOADING p239 .
stalled
Event p33
play
Event p33
Playback has begun. Fired after the paused p250 is newly false. play() p251 method has returned, or when the autoplay p249 attribute has caused playback to begin. Playback has been paused. Fired after the pause() p251 method has returned. paused p250 is newly true.
pause
Event p33
The user agent has just determined the readyState p249 is newly equal to HAVE_METADATA p248 or duration and dimensions of the media greater for the first time. resource p236 and the text tracks are ready p256 . The user agent can render the media data p236 readyState p249 newly increased to HAVE_CURRENT_DATA p248 or greater for the first time. at the current playback position p247 for the first time. Playback has stopped because the next frame is not available, but the user agent expects that frame to become available in due course. readyState p249 is newly equal to or less than HAVE_CURRENT_DATA p248 , and paused p250 is false. Either seeking p253 is true, or the current playback position p247 is not contained in any of the ranges in buffered p246 . It is possible for playback to stop for two other reasons without paused p250 being false, but those two reasons do not fire this event: maybe playback ended p250 , or playback stopped due to errors p250 . readyState p249 is newly equal to or greater than HAVE_FUTURE_DATA p248 , paused p250 is false, seeking p253 is false, or the current playback position p247 is contained in one of the ranges in buffered p246 . readyState p249 newly increased to HAVE_FUTURE_DATA p248 or greater.
loadeddata
Event p33
waiting
Event p33
playing
Event p33
canplay
Event p33
The user agent can resume playback of the media data p236 , but estimates that if playback were to be started now, the media resource p236 could not be rendered at the current playback rate up to its end without having to stop for further buffering of content.
The user agent estimates that if playback readyState p249 is newly equal to HAVE_ENOUGH_DATA p248 . were to be started now, the media resource p236 could be rendered at the current playback rate all the way to its end without having to stop for further buffering. The seeking p253 IDL attribute changed to true and the seek operation is taking long enough that the user agent has time to fire the event. The seeking p253 IDL attribute changed to false. The current playback position p247 changed as part of normal playback or in an especially interesting way, for example discontinuously. Playback has stopped because the end of the currentTime p247 equals the end of the media resource p236 ; media resource p236 was reached. ended p250 is true. Either the defaultPlaybackRate p251 or the playbackRate p251 attribute has just been updated.
seeking
Event p33
seeked timeupdate
ended ratechange
284
Event name
Interface
Dispatched when... The duration p247 attribute has just been updated. Either the volume p282 attribute or the muted p282 attribute has changed. Fired after the relevant attribute's setter has returned.
Preconditions
4.8.10.15 Security and privacy considerations The main security and privacy implications of the video p228 and audio p231 elements come from the ability to embed media cross-origin. There are two directions that threats can flow: from hostile content to a victim page, and from a hostile page to victim content. If a victim page embeds hostile content, the threat is that the content might contain scripted code that attempts to interact with the Document p33 that embeds the content. To avoid this, user agents must ensure that there is no access from the content to the embedding page. In the case of media content that uses DOM concepts, the embedded content must be treated as if it was in its own unrelated top-level browsing context p499 . For instance, if an SVG animation was embedded in a video p228 element, the user agent would not give it access to the DOM of the outer page. From the perspective of scripts in the SVG resource, the SVG file would appear to be in a lone top-level browsing context with no parent. If a hostile page embeds victim content, the threat is that the embedding page could obtain information from the content that it would not otherwise have access to. The API does expose some information: the existence of the media, its type, its duration, its size, and the performance characteristics of its host. Such information is already potentially problematic, but in practice the same information can more or less be obtained using the img p199 element, and so it has been deemed acceptable. However, significantly more sensitive information could be obtained if the user agent further exposes metadata within the content such as subtitles or chapter titles. This version of the API does not expose such information. Future extensions to this API will likely reuse a mechanism such as CORS to check that the embedded content's site has opted in to exposing such information. [CORS] p781 An attacker could trick a user running within a corporate network into visiting a site that attempts to load a video from a previously leaked location on the corporation's intranet. If such a video included confidential plans for a new product, then being able to read the subtitles would present a confidentiality breach.
4.8.10.16 Best practices for authors using media elements This section is non-normative. Playing audio and video resources on small devices such as set-top boxes or mobile phones is often constrained by limited hardware resources in the device. For example, a device might only support three simultaneous videos. For this reason, it is a good practice to release resources held by media elements p235 when they are done playing, either by being very careful about removing all references to the element and allowing it to be garbage collected, or, even better, by removing the element's src p237 attribute and any source p232 element descendants, and invoking the element's load() p239 method.
4.8.10.17 Best practices for implementors of media elements This section is non-normative. How accurately various aspects of the media element p235 API are implemented is considered a quality-ofimplementation issue. For example, when implementing the buffered attribute, how precise an implementation reports the ranges that have been buffered depends on how carefully the user agent inspects the data. Since the API reports ranges as times, but the data is obtained in byte streams, a user agent receiving a variable-bit-rate stream might only be able to determine precise times by actually decoding all of the data. User agents aren't required to do this, however; they can instead return estimates (e.g. based on the average bit rate seen so far) which get revised as more information becomes available. As a general rule, user agents are urged to be conservative rather than optimistic. For example, it would be bad to report that everything had been buffered when it had not. Another quality-of-implementation issue would be playing a video backwards when the codec is designed only for forward playback (e.g. there aren't many key frames, and they are far apart, and the intervening frames only have deltas from the previous frame). User agents could do a poor job, e.g. only showing key frames; however, better
285
implementations would do more work and thus do a better job, e.g. actually decoding parts of the video forwards, storing the complete frames, and then playing the frames backwards. Similarly, while implementations are allowed to drop buffered data at any time (there is no requirement that a user agent keep all the media data obtained for the lifetime of the media element), it is again a quality of implementation issue: user agents with sufficient resources to keep all the data around are encouraged to do so, as this allows for a better user experience. For example, if the user is watching a live stream, a user agent could allow the user only to view the live video; however, a better user agent would buffer everything and allow the user to seek through the earlier material, pause it, play it forwards and backwards, etc. When a media element p235 that is paused is removed from a document p29 and not reinserted before the next time the event loop p552 spins, implementations that are resource constrained are encouraged to take that opportunity to release all hardware resources (like video planes, networking resources, and data buffers) used by the media element p235 . (User agents still have to keep track of the playback position and so forth, though, in case playback is later restarted.)
286
When a canvas p286 element represents p708 embedded content p101 , the user can still focus descendants of the canvas p286 element (in the fallback content p101 ). This allows authors to make an interactive canvas keyboardfocusable: authors should have a one-to-one mapping of interactive regions to focusable elements in the fallback content p101 . The canvas p286 element has two attributes to control the size of the coordinate space: width and height. These attributes, when specified, must have values that are valid non-negative integers p39 . The rules for parsing nonnegative integers p39 must be used to obtain their numeric values. If an attribute is missing, or if parsing its value returns an error, then the default value must be used instead. The width p287 attribute defaults to 300, and the height p287 attribute defaults to 150. The intrinsic dimensions of the canvas p286 element equal the size of the coordinate space, with the numbers interpreted in CSS pixels. However, the element can be sized arbitrarily by a style sheet. During rendering, the image is scaled to fit this layout size. The size of the coordinate space does not necessarily represent the size of the actual bitmap that the user agent will use internally or during rendering. On high-definition displays, for instance, the user agent may internally use a bitmap with two device pixels per unit in the coordinate space, so that the rendering remains at high quality throughout. When the canvas p286 element is created, and subsequently whenever the width p287 and height p287 attributes are set (whether to a new value or to the previous value), the bitmap and any associated contexts must be cleared back to their initial state and reinitialized with the newly specified coordinate space dimensions. When the canvas is initialized, its bitmap must be cleared to transparent black. The width and height IDL attributes must reflect p62 the respective content attributes of the same name, with the same defaults. Only one square appears to be drawn in the following example: // canvas is a reference to a <canvas> element var context = canvas.getContext('2d'); context.fillRect(0,0,50,50); canvas.setAttribute('width', '300'); // clears the canvas context.fillRect(0,100,50,50); canvas.width = canvas.width; // clears the canvas context.fillRect(100,0,50,50); // only this square remains This box is non-normative. Implementation requirements are given below this box. context = canvas . getContext p287 (contextId [, ... ]) Returns an object that exposes an API for drawing on the canvas. The first argument specifies the desired API. Subsequent arguments are handled by that API. This specification defines the "2d p289 " context below. There is also a specification that defines a "webgl" context. [WEBGL] p785 The list of defined contexts is given on the WHATWG Wiki CanvasContexts page. [WHATWGWIKI] p786 Returns null if the given context ID is not supported or if the canvas has already been initialised with some other (incompatible) context type (e.g. trying to get a "2d p289 " context after getting a "webgl" context).
A canvas p286 element can have a primary context, which is the first context to have been obtained for that element. When created, a canvas p286 element must not have a primary context p287 . The getContext(contextId, args...) method of the canvas p286 element, when invoked, must run the following steps: 1. 2. 3. Let contextId be the first argument to the method. If contextId is not the name of a context supported by the user agent, return null and abort these steps. If the element has a primary context p287 and that context's entry in the WHATWG Wiki CanvasContexts page does not list contextId as a context with which it is compatible, return null and abort these steps. [WHATWGWIKI] p786 If the element does not have a primary context p287 , let the element's primary context p287 be contextId. If the getContext() p287 method has already been invoked on this element for the same contextId, return the same object as was returned that time, and abort these steps. The additional arguments are ignored.
4. 5.
287
6.
Return a new object for contextId, as defined by the specification given for contextId's entry in the WHATWG Wiki CanvasContexts page. [WHATWGWIKI] p786
New context types may be registered in the WHATWG Wiki CanvasContexts page. [WHATWGWIKI] p786 Anyone is free to edit the WHATWG Wiki CanvasContexts page at any time to add a new context type. These new context types must be specified with the following information: Keyword The value of contextID that will return the object for the new API. Specification A link to a formal specification of the context type's API. It could be another page on the Wiki, or a link to an external page. If the type does not have a formal specification, an informal description can be substituted until such time as a formal specification is available. Compatible with The list of context types that are compatible with this one (i.e. that operate on the same underlying bitmap). This list must be transitive and symmetric; if one context type is defined as compatible with another, then all types it is compatible with must be compatible with all types the other is compatible with. Vendors may also define experimental contexts using the syntax vendorname-context, for example, moz-3d. Such contexts should be registered in the WHATWG Wiki CanvasContexts page. This box is non-normative. Implementation requirements are given below this box. url = canvas . toDataURL p288 ( [ type, ... ]) Returns a data: URL p28 for the image in the canvas. The first argument, if provided, controls the type of the image to be returned (e.g. PNG or JPEG). The default is image/png; that type is also used if the given type isn't supported. The other arguments are specific to the type, and control the way that the image is generated, as given in the table below.
The toDataURL() method must, when called with no arguments, return a data: URL p28 containing a representation of the image as a PNG file. [PNG] p783 [RFC2397] p784 If the canvas has no pixels (i.e. either its horizontal dimension or its vertical dimension is zero) then the method must return the string "data:,". (This is the shortest data: URL p28 ; it represents the empty string in a text/plain resource.) When the toDataURL(type) p288 method is called with one or more arguments, it must return a data: URL p28 containing a representation of the image in the format given by type. The possible values are MIME types p28 with no parameters, for example image/png, image/jpeg, or even maybe image/svg+xml if the implementation actually keeps enough information to reliably render an SVG image from the canvas. For image types that do not support an alpha channel, the image must be composited onto a solid black background using the source-over operator, and the resulting image must be the one used to create the data: URL p28 . Only support for image/png is required. User agents may support other types. If the user agent does not support the requested type, it must return the image using the PNG format. User agents must convert the provided type to ASCII lowercase p36 before establishing if they support that type and before creating the data: URL p28 . Note: When trying to use types other than image/png, authors can check if the image was really returned in the requested format by checking to see if the returned string starts with one of the exact strings "data:image/png," or "data:image/png;". If it does, the image is PNG, and thus the requested type was not supported. (The one exception to this is if the canvas has either no height or no width, in which case the result might simply be "data:,".) If the method is invoked with the first argument giving a type corresponding to one of the types given in the first column of the following table, and the user agent supports that type, then the subsequent arguments, if any, must be treated as described in the second cell of that row.
Type Other arguments
image/ The second argument, if it is a number in the range 0.0 to 1.0 inclusive, must be treated as the desired quality level. If it is not a jpeg number or is outside that range, the user agent must use its default value, as if the argument had been omitted.
For the purposes of these rules, an argument is considered to be a number if it is converted to an IDL double value by the rules for handling arguments of type any in the Web IDL specification. [WEBIDL] p785
288
Other arguments must be ignored and must not cause the user agent to raise an exception. A future version of this specification will probably define other parameters to be passed to toDataURL() p288 to allow authors to more carefully control compression settings, image metadata, etc.
4.8.11.1 The 2D context This specification defines the 2d context type, whose API is implemented using the CanvasRenderingContext2D p289 interface. When the getContext() p287 method of a canvas p286 element is to return a new object for the contextId p288 2d p289 , the user agent must return a new CanvasRenderingContext2D p289 object. Any additional arguments are ignored. The 2D context represents a flat Cartesian surface whose origin (0,0) is at the top left corner, with the coordinate space having x values increasing when going right, and y values increasing when going down. interface CanvasRenderingContext2D { // back-reference to the canvas readonly attribute HTMLCanvasElement canvas; // state void save(); // push state on state stack void restore(); // pop state stack and restore state // transformations (default transform is the identity matrix) void scale(in double x, in double y); void rotate(in double angle); void translate(in double x, in double y); void transform(in double a, in double b, in double c, in double d, in double e, in double f); void setTransform(in double a, in double b, in double c, in double d, in double e, in double f); // compositing attribute double globalAlpha; // (default 1.0) attribute DOMString globalCompositeOperation; // (default source-over) // colors and styles attribute any strokeStyle; // (default black) attribute any fillStyle; // (default black) CanvasGradient createLinearGradient(in double x0, in double y0, in double x1, in double y1); CanvasGradient createRadialGradient(in double x0, in double y0, in double r0, in double x1, in double y1, in double r1); CanvasPattern createPattern(in HTMLImageElement image, in DOMString repetition); CanvasPattern createPattern(in HTMLCanvasElement image, in DOMString repetition); CanvasPattern createPattern(in HTMLVideoElement image, in DOMString repetition); // line caps/joins attribute attribute attribute attribute // shadows attribute attribute attribute attribute
double lineWidth; // (default 1) DOMString lineCap; // "butt", "round", "square" (default "butt") DOMString lineJoin; // "round", "bevel", "miter" (default "miter") double miterLimit; // (default 10)
double shadowOffsetX; // (default 0) double shadowOffsetY; // (default 0) double shadowBlur; // (default 0) DOMString shadowColor; // (default transparent black)
// rects void clearRect(in double x, in double y, in double w, in double h); void fillRect(in double x, in double y, in double w, in double h); void strokeRect(in double x, in double y, in double w, in double h); // path API void beginPath(); void closePath(); void moveTo(in double x, in double y);
289
void lineTo(in double x, in double y); void quadraticCurveTo(in double cpx, in double cpy, in double x, in double y); void bezierCurveTo(in double cp1x, in double cp1y, in double cp2x, in double cp2y, in double x, in double y); void arcTo(in double x1, in double y1, in double x2, in double y2, in double radius); void rect(in double x, in double y, in double w, in double h); void arc(in double x, in double y, in double radius, in double startAngle, in double endAngle, in optional boolean anticlockwise); void fill(); void stroke(); void clip(); boolean isPointInPath(in double x, in double y); // focus management boolean drawFocusRing(in Element element, in double xCaret, in double yCaret, in optional boolean canDrawCustom); // text attribute DOMString font; // (default 10px sans-serif) attribute DOMString textAlign; // "start", "end", "left", "right", "center" (default: "start") attribute DOMString textBaseline; // "top", "hanging", "middle", "alphabetic", "ideographic", "bottom" (default: "alphabetic") void fillText(in DOMString text, in double x, in double y, in optional double maxWidth); void strokeText(in DOMString text, in double x, in double y, in optional double maxWidth); TextMetrics measureText(in DOMString text); // drawing images void drawImage(in HTMLImageElement image, in double dx, in double dy, in optional double dw, in double dh); void drawImage(in HTMLImageElement image, in double sx, in double sy, in double sw, in double sh, in double dx, in double dy, in double dw, in double dh); void drawImage(in HTMLCanvasElement image, in double dx, in double dy, in optional double dw, in double dh); void drawImage(in HTMLCanvasElement image, in double sx, in double sy, in double sw, in double sh, in double dx, in double dy, in double dw, in double dh); void drawImage(in HTMLVideoElement image, in double dx, in double dy, in optional double dw, in double dh); void drawImage(in HTMLVideoElement image, in double sx, in double sy, in double sw, in double sh, in double dx, in double dy, in double dw, in double dh); // pixel manipulation ImageData createImageData(in double sw, in double sh); ImageData createImageData(in ImageData imagedata); ImageData getImageData(in double sx, in double sy, in double sw, in double sh); void putImageData(in ImageData imagedata, in double dx, in double dy, in optional double dirtyX, in double dirtyY, in double dirtyWidth, in double dirtyHeight); }; interface CanvasGradient { // opaque object void addColorStop(in double offset, in DOMString color); }; interface CanvasPattern { // opaque object }; interface TextMetrics { readonly attribute double width; }; interface ImageData { readonly attribute unsigned long width; readonly attribute unsigned long height; readonly attribute CanvasPixelArray data; };
290
interface CanvasPixelArray { readonly attribute unsigned long length; getter octet (in unsigned long index); setter void (in unsigned long index, in octet value); }; This box is non-normative. Implementation requirements are given below this box. context . canvas
p291
The canvas attribute must return the canvas p286 element that the context paints on. Except where otherwise specified, for the 2D context interface, any method call with a numeric argument whose value is infinite or a NaN value must be ignored. Whenever the CSS value currentColor is used as a color in this API, the "computed value of the 'color' property" for the purposes of determining the computed value of the currentColor keyword is the computed value of the 'color' property on the element in question at the time that the color is specified (e.g. when the appropriate attribute is set, or when the method is called; not when the color is rendered or otherwise used). If the computed value of the 'color' property is undefined for a particular case (e.g. because the element is not in a Document p29 ), then the "computed value of the 'color' property" for the purposes of determining the computed value of the currentColor keyword is fully opaque black. [CSSCOLOR] p781 In the case of addColorStop() p295 on CanvasGradient p290 , the "computed value of the 'color' property" for the purposes of determining the computed value of the currentColor keyword is always fully opaque black (there is no associated element). [CSSCOLOR] p781 Note: This is because CanvasGradient p290 objects are canvas p286 -neutral a CanvasGradient p290 object created by one canvas p286 can be used by another, and there is therefore no way to know which is the "element in question" at the time that the color is specified.
4.8.11.1.1 The canvas state Each context maintains a stack of drawing states. Drawing states consist of: The current transformation matrix p291 . The current clipping region p302 . The current values of the following attributes: strokeStyle p294 , fillStyle p294 , globalAlpha p293 , lineWidth p297 , lineCap p297 , lineJoin p297 , miterLimit p297 , shadowOffsetX p298 , shadowOffsetY p298 , shadowBlur p298 , shadowColor p298 , globalCompositeOperation p293 , font p304 , textAlign p304 , textBaseline p305 .
Note: The current path and the current bitmap are not part of the drawing state. The current path is persistent, and can only be reset using the beginPath() p300 method. The current bitmap is a property of the canvas, not the context. This box is non-normative. Implementation requirements are given below this box. context . save
p291
()
Pushes the current state onto the stack. context . restore p291 () Pops the top state on the stack, restoring the context to that state.
The save() method must push a copy of the current drawing state onto the drawing state stack. The restore() method must pop the top entry in the drawing state stack, and reset the drawing state it describes. If there is no saved state, the method must do nothing.
4.8.11.1.2 Transformations The transformation matrix is applied to coordinates when creating shapes and paths.
291
When the context is created, the transformation matrix must initially be the identity transform. It may then be adjusted using the transformation methods. The transformations must be performed in reverse order. For instance, if a scale transformation that doubles the width is applied, followed by a rotation transformation that rotates drawing operations by a quarter turn, and a rectangle twice as wide as it is tall is then drawn on the canvas, the actual result will be a square. This box is non-normative. Implementation requirements are given below this box. context . scale p292 (x, y) Changes the transformation matrix to apply a scaling transformation with the given characteristics. context . rotate p292 (angle) Changes the transformation matrix to apply a rotation transformation with the given characteristics. The angle is in radians. context . translate p292 (x, y) Changes the transformation matrix to apply a translation transformation with the given characteristics. context . transform p292 (a, b, c, d, e, f) Changes the transformation matrix to apply the matrix given by the arguments as described below. context . setTransform p292 (a, b, c, d, e, f) Changes the transformation matrix to the matrix given by the arguments as described below.
The scale(x, y) method must add the scaling transformation described by the arguments to the transformation matrix. The x argument represents the scale factor in the horizontal direction and the y argument represents the scale factor in the vertical direction. The factors are multiples. The rotate(angle) method must add the rotation transformation described by the argument to the transformation matrix. The angle argument represents a clockwise rotation angle expressed in radians. The translate(x, y) method must add the translation transformation described by the arguments to the transformation matrix. The x argument represents the translation distance in the horizontal direction and the y argument represents the translation distance in the vertical direction. The arguments are in coordinate space units. The transform(a, b, c, d, e, f) method must replace the current transformation matrix with the result of multiplying the current transformation matrix with the matrix described by:
a c e b d f 0 0 1
Note: The arguments a, b, c, d, e, and f are sometimes called m11, m12, m21, m22, dx, and dy or m11, m21, m12, m22, dx, and dy. Care should be taken in particular with the order of the second and third arguments (b and c) as their order varies from API to API and APIs sometimes use the notation m12/m21 and sometimes m21/m12 for those positions. The setTransform(a, b, c, d, e, f) method must reset the current transform to the identity matrix, and then invoke the transform p292 (a, b, c, d, e, f) method with the same arguments.
4.8.11.1.3 Compositing This box is non-normative. Implementation requirements are given below this box. context . globalAlpha p293 [ = value ] Returns the current alpha value applied to rendering operations. Can be set, to change the alpha value. Values outside of the range 0.0 .. 1.0 are ignored. context . globalCompositeOperation p293 [ = value ] Returns the current composition operation, from the list below. Can be set, to change the composition operation. Unknown values are ignored.
292
All drawing operations are affected by the global compositing attributes, globalAlpha p293 and globalCompositeOperation p293 . The globalAlpha attribute gives an alpha value that is applied to shapes and images before they are composited onto the canvas. The value must be in the range from 0.0 (fully transparent) to 1.0 (no additional transparency). If an attempt is made to set the attribute to a value outside this range, including Infinity and Not-a-Number (NaN) values, the attribute must retain its previous value. When the context is created, the globalAlpha p293 attribute must initially have the value 1.0. The globalCompositeOperation attribute sets how shapes and images are drawn onto the existing bitmap, once they have had globalAlpha p293 and the current transformation matrix applied. It must be set to a value from the following list. In the descriptions below, the source image, A, is the shape or image being rendered, and the destination image, B, is the current state of the bitmap. source-atop A atop B. Display the source image wherever both images are opaque. Display the destination image wherever the destination image is opaque but the source image is transparent. Display transparency elsewhere. source-in A in B. Display the source image wherever both the source image and destination image are opaque. Display transparency elsewhere. source-out A out B. Display the source image wherever the source image is opaque and the destination image is transparent. Display transparency elsewhere. source-over (default) A over B. Display the source image wherever the source image is opaque. Display the destination image elsewhere. destination-atop B atop A. Same as source-atop p293 but using the destination image instead of the source image and vice versa. destination-in B in A. Same as source-in p293 but using the destination image instead of the source image and vice versa. destination-out B out A. Same as source-out p293 but using the destination image instead of the source image and vice versa. destination-over B over A. Same as source-over p293 but using the destination image instead of the source image and vice versa. lighter A plus B. Display the sum of the source image and destination image, with color values approaching 255 (100%) as a limit. copy A (B is ignored). xor A xor B. Exclusive OR of the source image and destination image. Display the source image instead of the destination image.
vendorName-operationName Vendor-specific extensions to the list of composition operators should use this syntax. The operators in the above list must be treated as described by the Porter-Duff operator given at the start of their description (e.g. A over B). They are to be applied as part of the drawing model p311 , at which point the clipping region p302 is also applied. (Without a clipping region, these operators act on the whole bitmap with every operation.) [PORTERDUFF] p783 These values are all case-sensitive they must be used exactly as shown. User agents must not recognize values that are not a case-sensitive p36 match for one of the values given above. On setting, if the user agent does not recognize the specified value, it must be ignored, leaving the value of globalCompositeOperation p293 unaffected. When the context is created, the globalCompositeOperation p293 attribute must initially have the value sourceover.
293
4.8.11.1.4 Colors and styles This box is non-normative. Implementation requirements are given below this box. context . strokeStyle
p294
[ = value ]
Returns the current style used for stroking shapes. Can be set, to change the stroke style. The style can be either a string containing a CSS color, or a CanvasGradient p290 or CanvasPattern p290 object. Invalid values are ignored. context . fillStyle p294 [ = value ] Returns the current style used for filling shapes. Can be set, to change the fill style. The style can be either a string containing a CSS color, or a CanvasGradient p290 or CanvasPattern p290 object. Invalid values are ignored.
The strokeStyle attribute represents the color or style to use for the lines around shapes, and the fillStyle attribute represents the color or style to use inside the shapes. Both attributes can be either strings, CanvasGradient p290 s, or CanvasPattern p290 s. On setting, strings must be parsed as CSS <color> values p34 and the color assigned, and CanvasGradient p290 and CanvasPattern p290 objects must be assigned themselves. [CSSCOLOR] p781 If the value is a string but cannot be parsed as a CSS <color> value p34 , or is neither a string, a CanvasGradient p290 , nor a CanvasPattern p290 , then it must be ignored, and the attribute must retain its previous value. When set to a CanvasPattern p290 or CanvasGradient p290 object, the assignment is live p29 , meaning that changes made to the object after the assignment do affect subsequent stroking or filling of shapes. On getting, if the value is a color, then the serialization of the color p294 must be returned. Otherwise, if it is not a color but a CanvasGradient p290 or CanvasPattern p290 , then the respective object must be returned. (Such objects are opaque and therefore only useful for assigning to other attributes or for comparison to other gradients or patterns.) The serialization of a color for a color value is a string, computed as follows: if it has alpha equal to 1.0, then the string is a lowercase six-digit hex value, prefixed with a "#" character (U+0023 NUMBER SIGN), with the first two digits representing the red component, the next two digits representing the green component, and the last two digits representing the blue component, the digits being in the range 0-9 a-f (U+0030 to U+0039 and U+0061 to U+0066). Otherwise, the color value has alpha less than 1.0, and the string is the color value in the CSS rgba() functional-notation format: the literal string rgba (U+0072 U+0067 U+0062 U+0061) followed by a U+0028 LEFT PARENTHESIS, a base-ten integer in the range 0-255 representing the red component (using digits 0-9, U+0030 to U+0039, in the shortest form possible), a literal U+002C COMMA and U+0020 SPACE, an integer for the green component, a comma and a space, an integer for the blue component, another comma and space, a U+0030 DIGIT ZERO, a U+002E FULL STOP (representing the decimal point), one or more digits in the range 0-9 (U+0030 to U+0039) representing the fractional part of the alpha value, and finally a U+0029 RIGHT PARENTHESIS. When the context is created, the strokeStyle p294 and fillStyle p294 attributes must initially have the string value #000000. There are two types of gradients, linear gradients and radial gradients, both represented by objects implementing the opaque CanvasGradient p290 interface. Once a gradient has been created (see below), stops are placed along it to define how the colors are distributed along the gradient. The color of the gradient at each stop is the color specified for that stop. Between each such stop, the colors and the alpha component must be linearly interpolated over the RGBA space without premultiplying the alpha value to find the color to use at that offset. Before the first stop, the color must be the color of the first stop. After the last stop, the color must be the color of the last stop. When there are no stops, the gradient is transparent black. This box is non-normative. Implementation requirements are given below this box. gradient . addColorStop p295 (offset, color) Adds a color stop with the given color to the gradient at the given offset. 0.0 is the offset at one end of the gradient, 1.0 is the offset at the other end. Throws an INDEX_SIZE_ERR p75 exception if the offset is out of range. Throws a SYNTAX_ERR p75 exception if the color cannot be parsed.
294
gradient = context . createLinearGradient p295 (x0, y0, x1, y1) Returns a CanvasGradient p290 object that represents a linear gradient that paints along the line given by the coordinates represented by the arguments. If any of the arguments are not finite numbers, throws a NOT_SUPPORTED_ERR p75 exception. gradient = context . createRadialGradient p295 (x0, y0, r0, x1, y1, r1) Returns a CanvasGradient p290 object that represents a radial gradient that paints along the cone given by the circles represented by the arguments. If any of the arguments are not finite numbers, throws a NOT_SUPPORTED_ERR p75 exception. If either of the radii are negative, throws an INDEX_SIZE_ERR p75 exception.
The addColorStop(offset, color) method on the CanvasGradient p290 interface adds a new stop to a gradient. If the offset is less than 0, greater than 1, infinite, or NaN, then an INDEX_SIZE_ERR p75 exception must be raised. If the color cannot be parsed as a CSS <color> value p34 , then a SYNTAX_ERR p75 exception must be raised. Otherwise, the gradient must have a new stop placed, at offset offset relative to the whole gradient, and with the color obtained by parsing color as a CSS <color> value. If multiple stops are added at the same offset on a gradient, they must be placed in the order added, with the first one closest to the start of the gradient, and each subsequent one infinitesimally further along towards the end point (in effect causing all but the first and last stop added at each point to be ignored). The createLinearGradient(x0, y0, x1, y1) method takes four arguments that represent the start point (x0, y0) and end point (x1, y1) of the gradient. If any of the arguments to createLinearGradient() p295 are infinite or NaN, the method must raise a NOT_SUPPORTED_ERR p75 exception. Otherwise, the method must return a linear CanvasGradient p290 initialized with the specified line. Linear gradients must be rendered such that all points on a line perpendicular to the line that crosses the start and end points have the color at the point where those two lines cross (with the colors coming from the interpolation and extrapolation p294 described above). The points in the linear gradient must be transformed as described by the current transformation matrix p291 when rendering. If x0 = x1 and y0 = y1, then the linear gradient must paint nothing. The createRadialGradient(x0, y0, r0, x1, y1, r1) method takes six arguments, the first three representing the start circle with origin (x0, y0) and radius r0, and the last three representing the end circle with origin (x1, y1) and radius r1. The values are in coordinate space units. If any of the arguments are infinite or NaN, a NOT_SUPPORTED_ERR p75 exception must be raised. If either of r0 or r1 are negative, an INDEX_SIZE_ERR p75 exception must be raised. Otherwise, the method must return a radial CanvasGradient p290 initialized with the two specified circles. Radial gradients must be rendered by following these steps: 1. 2. If x0 = x1 and y0 = y1 and r0 = r1, then the radial gradient must paint nothing. Abort these steps. Let x() = (x1-x0) + x0 Let y() = (y1-y0) + y0 Let r() = (r1-r0) + r0 Let the color at be the color at that position on the gradient (with the colors coming from the interpolation and extrapolation p294 described above). 3. For all values of where r() > 0, starting with the value of nearest to positive infinity and ending with the value of nearest to negative infinity, draw the circumference of the circle with radius r() at position (x(), y()), with the color at , but only painting on the parts of the canvas that have not yet been painted on by earlier circles in this step for this rendering of the gradient.
Note: This effectively creates a cone, touched by the two circles defined in the creation of the gradient, with the part of the cone before the start circle (0.0) using the color of the first offset, the part of the cone after the end circle (1.0) using the color of the last offset, and areas outside the cone untouched by the gradient (transparent black). The points in the radial gradient must be transformed as described by the current transformation matrix p291 when rendering. Gradients must be painted only where the relevant stroking or filling effects requires that they be drawn. Patterns are represented by objects implementing the opaque CanvasPattern p290 interface.
295
This box is non-normative. Implementation requirements are given below this box. pattern = context . createPattern p296 (image, repetition) Returns a CanvasPattern p290 object that uses the given image and repeats in the direction(s) given by the repetition argument. The allowed values for repetition are repeat (both directions), repeat-x (horizontal only), repeat-y (vertical only), and no-repeat (neither). If the repetition argument is empty or null, the value repeat is used. If the first argument isn't an img p199 , canvas p286 , or video p228 element, throws a TYPE_MISMATCH_ERR p75 exception. If the image has no image data, throws an INVALID_STATE_ERR p75 exception. If the second argument isn't one of the allowed values, throws a SYNTAX_ERR p75 exception. If the image isn't yet fully decoded, then the method returns null.
To create objects of this type, the createPattern(image, repetition) method is used. The first argument gives the image to use as the pattern (either an HTMLImageElement p200 , HTMLCanvasElement p286 , or HTMLVideoElement p229 object). Modifying this image after calling the createPattern() p296 method must not affect the pattern. The second argument must be a string with one of the following values: repeat, repeat-x, repeat-y, no-repeat. If the empty string or null is specified, repeat must be assumed. If an unrecognized value is given, then the user agent must raise a SYNTAX_ERR p75 exception. User agents must recognize the four values described above exactly (e.g. they must not do case folding). Except as specified below, the method must return a CanvasPattern p290 object suitably initialized. The image argument is an instance of either HTMLImageElement p200 , HTMLCanvasElement p286 , or HTMLVideoElement p229 . If the image is null, the implementation must raise a TYPE_MISMATCH_ERR p75 exception. If the image argument is an HTMLImageElement p200 object that is not fully decodable p201 , or if the image argument is an HTMLVideoElement p229 object whose readyState p249 attribute is either HAVE_NOTHING p248 or HAVE_METADATA p248 , then the implementation must return null. If the image argument is an HTMLCanvasElement p286 object with either a horizontal dimension or a vertical dimension equal to zero, then the implementation must raise an INVALID_STATE_ERR p75 exception. Patterns must be painted so that the top left of the first image is anchored at the origin of the coordinate space, and images are then repeated horizontally to the left and right (if the repeat-x string was specified) or vertically up and down (if the repeat-y string was specified) or in all four directions all over the canvas (if the repeat string was specified). The images are not scaled by this process; one CSS pixel of the image must be painted on one coordinate space unit. Of course, patterns must actually be painted only where the stroking or filling effect requires that they be drawn, and are affected by the current transformation matrix. If the original image data is a bitmap image, the value painted at a point in the area of the repetitions is computed by filtering the original image data. The user agent may use any filtering algorithm (for example bilinear interpolation or nearest-neighbor). When the filtering algorithm requires a pixel value from outside the original image data, it must instead use the value from wrapping the pixel's coordinates to the original image's dimensions. (That is, the filter uses 'repeat' behavior, regardless of the value of repetition.) When the createPattern() p296 method is passed an animated image as its image argument, the user agent must use the poster frame of the animation, or, if there is no poster frame, the first frame of the animation. When the image argument is an HTMLVideoElement p229 , then the frame at the current playback position p247 must be used as the source image, and the source image's dimensions must be the intrinsic width p230 and intrinsic height p230 of the media resource p236 (i.e. after any aspect-ratio correction has been applied).
4.8.11.1.5 Line styles This box is non-normative. Implementation requirements are given below this box. context . lineWidth
p297
[ = value ]
Returns the current line width. Can be set, to change the line width. Values that are not finite values greater than zero are ignored. context . lineCap p297 [ = value ] Returns the current line cap style. Can be set, to change the line cap style. The possible line cap styles are butt, round, and square. Other values are ignored.
296
context . lineJoin p297 [ = value ] Returns the current line join style. Can be set, to change the line join style. The possible line join styles are bevel, round, and miter. Other values are ignored. context . miterLimit p297 [ = value ] Returns the current miter limit ratio. Can be set, to change the miter limit ratio. Values that are not finite values greater than zero are ignored.
The lineWidth attribute gives the width of lines, in coordinate space units. On getting, it must return the current value. On setting, zero, negative, infinite, and NaN values must be ignored, leaving the value unchanged; other values must change the current value to the new value. When the context is created, the lineWidth p297 attribute must initially have the value 1.0. The lineCap attribute defines the type of endings that UAs will place on the end of lines. The three valid values are butt, round, and square. The butt value means that the end of each line has a flat edge perpendicular to the direction of the line (and that no additional line cap is added). The round value means that a semi-circle with the diameter equal to the width of the line must then be added on to the end of the line. The square value means that a rectangle with the length of the line width and the width of half the line width, placed flat against the edge perpendicular to the direction of the line, must be added at the end of each line. On getting, it must return the current value. On setting, if the new value is one of the literal strings butt, round, and square, then the current value must be changed to the new value; other values must ignored, leaving the value unchanged. When the context is created, the lineCap p297 attribute must initially have the value butt. The lineJoin attribute defines the type of corners that UAs will place where two lines meet. The three valid values are bevel, round, and miter. On getting, it must return the current value. On setting, if the new value is one of the literal strings bevel, round, and miter, then the current value must be changed to the new value; other values must be ignored, leaving the value unchanged. When the context is created, the lineJoin p297 attribute must initially have the value miter. A join exists at any point in a subpath shared by two consecutive lines. When a subpath is closed, then a join also exists at its first point (equivalent to its last point) connecting the first and last lines in the subpath. In addition to the point where the join occurs, two additional points are relevant to each join, one for each line: the two corners found half the line width away from the join point, one perpendicular to each line, each on the side furthest from the other line. A filled triangle connecting these two opposite corners with a straight line, with the third point of the triangle being the join point, must be rendered at all joins. The lineJoin p297 attribute controls whether anything else is rendered. The three aforementioned values have the following meanings: The bevel value means that this is all that is rendered at joins. The round value means that a filled arc connecting the two aforementioned corners of the join, abutting (and not overlapping) the aforementioned triangle, with the diameter equal to the line width and the origin at the point of the join, must be rendered at joins. The miter value means that a second filled triangle must (if it can given the miter length) be rendered at the join, with one line being the line between the two aforementioned corners, abutting the first triangle, and the other two being continuations of the outside edges of the two joining lines, as long as required to intersect without going over the miter length. The miter length is the distance from the point where the join occurs to the intersection of the line edges on the outside of the join. The miter limit ratio is the maximum allowed ratio of the miter length to half the line width. If the miter length would cause the miter limit ratio to be exceeded, this second triangle must not be rendered. The miter limit ratio can be explicitly set using the miterLimit attribute. On getting, it must return the current value. On setting, zero, negative, infinite, and NaN values must be ignored, leaving the value unchanged; other values must change the current value to the new value.
297
When the context is created, the miterLimit p297 attribute must initially have the value 10.0.
4.8.11.1.6 Shadows All drawing operations are affected by the four global shadow attributes. This box is non-normative. Implementation requirements are given below this box. context . shadowColor
p298
[ = value ]
Returns the current shadow color. Can be set, to change the shadow color. Values that cannot be parsed as CSS colors are ignored. context . shadowOffsetX p298 [ = value ] context . shadowOffsetY p298 [ = value ] Returns the current shadow offset. Can be set, to change the shadow offset. Values that are not finite numbers are ignored. context . shadowBlur p298 [ = value ] Returns the current level of blur applied to shadows. Can be set, to change the blur level. Values that are not finite numbers greater than or equal to zero are ignored.
The shadowColor attribute sets the color of the shadow. When the context is created, the shadowColor p298 attribute initially must be fully-transparent black. On getting, the serialization of the color p294 must be returned. On setting, the new value must be parsed as a CSS <color> value p34 and the color assigned. If the value cannot be parsed as a CSS <color> value then it must be ignored, and the attribute must retain its previous value. [CSSCOLOR] p781 The shadowOffsetX and shadowOffsetY attributes specify the distance that the shadow will be offset in the positive horizontal and positive vertical distance respectively. Their values are in coordinate space units. They are not affected by the current transformation matrix. When the context is created, the shadow offset attributes must initially have the value 0. On getting, they must return their current value. On setting, the attribute being set must be set to the new value, except if the value is infinite or NaN, in which case the new value must be ignored. The shadowBlur attribute specifies the level of the blurring effect. (The units do not map to coordinate space units, and are not affected by the current transformation matrix.) When the context is created, the shadowBlur p298 attribute must initially have the value 0. On getting, the attribute must return its current value. On setting the attribute must be set to the new value, except if the value is negative, infinite or NaN, in which case the new value must be ignored. Shadows are only drawn if the opacity component of the alpha component of the color of shadowColor p298 is non-zero and either the shadowBlur p298 is non-zero, or the shadowOffsetX p298 is non-zero, or the shadowOffsetY p298 is non-zero. When shadows are drawn p298 , they must be rendered as follows: 1. Let A be an infinite transparent black bitmap on which the source image for which a shadow is being created has been rendered. Let B be an infinite transparent black bitmap, with a coordinate space and an origin identical to A. Copy the alpha channel of A to B, offset by shadowOffsetX p298 in the positive x direction, and shadowOffsetY p298 in the positive y direction. If shadowBlur p298 is greater than 0: 1. 2. Let be half the value of shadowBlur p298 . Perform a 2D Gaussian Blur on B, using as the standard deviation.
2. 3.
4.
298
User agents may limit values of to an implementation-specific maximum value to avoid exceeding hardware limitations during the Gaussian blur operation. 5. Set the red, green, and blue components of every pixel in B to the red, green, and blue components (respectively) of the color of shadowColor p298 . Multiply the alpha component of every pixel in B by the alpha component of the color of shadowColor p298 . The shadow is in the bitmap B, and is rendered as part of the drawing model p311 described below.
6.
7.
If the current composition operation is copy p293 , shadows effectively won't render (since the shape will overwrite the shadow).
4.8.11.1.7 Simple shapes (rectangles) There are three methods that immediately draw rectangles to the bitmap. They each take four arguments; the first two give the x and y coordinates of the top left of the rectangle, and the second two give the width w and height h of the rectangle, respectively. The current transformation matrix p291 must be applied to the following four coordinates, which form the path that must then be closed to get the specified rectangle: (x, y), (x+w, y), (x+w, y+h), (x, y+h). Shapes are painted without affecting the current path, and are subject to the clipping region p302 , and, with the exception of clearRect() p299 , also shadow effects p298 , global alpha p293 , and global composition operators p293 . This box is non-normative. Implementation requirements are given below this box. context . clearRect
p299
(x, y, w, h)
Clears all pixels on the canvas in the given rectangle to transparent black. context . fillRect p299 (x, y, w, h) Paints the given rectangle onto the canvas, using the current fill style. context . strokeRect p299 (x, y, w, h) Paints the box that outlines the given rectangle onto the canvas, using the current stroke style.
The clearRect(x, y, w, h) method must clear the pixels in the specified rectangle that also intersect the current clipping region to a fully transparent black, erasing any previous image. If either height or width are zero, this method has no effect. The fillRect(x, y, w, h) method must paint the specified rectangular area using the fillStyle p294 . If either height or width are zero, this method has no effect. The strokeRect(x, y, w, h) method must stroke the specified rectangle's path using the strokeStyle p294 , lineWidth p297 , lineJoin p297 , and (if appropriate) miterLimit p297 attributes. If both height and width are zero, this method has no effect, since there is no path to stroke (it's a point). If only one of the two is zero, then the method will draw a line instead (the path for the outline is just a straight line along the non-zero dimension).
4.8.11.1.8 Complex shapes (paths) The context always has a current path. There is only one current path, it is not part of the drawing state p291 . A path has a list of zero or more subpaths. Each subpath consists of a list of one or more points, connected by straight or curved lines, and a flag indicating whether the subpath is closed or not. A closed subpath is one where the last point of the subpath is connected to the first point of the subpath by a straight line. Subpaths with fewer than two points are ignored when painting the path. This box is non-normative. Implementation requirements are given below this box. context . beginPath p300 () Resets the current path. context . moveTo p300 (x, y) Creates a new subpath with the given point.
299
context . closePath p300 () Marks the current subpath as closed, and starts a new subpath with a point the same as the start and end of the newly closed subpath. context . lineTo p301 (x, y) Adds the given point to the current subpath, connected to the previous one by a straight line. context . quadraticCurveTo p301 (cpx, cpy, x, y) Adds the given point to the current subpath, connected to the previous one by a quadratic Bzier curve with the given control point. context . bezierCurveTo p301 (cp1x, cp1y, cp2x, cp2y, x, y) Adds the given point to the current subpath, connected to the previous one by a cubic Bzier curve with the given control points. context . arcTo p301 (x1, y1, x2, y2, radius) Adds an arc with the given control points and radius to the current subpath, connected to the previous point by a straight line. Throws an INDEX_SIZE_ERR p75 exception if the given radius is negative. context . arc p301 (x, y, radius, startAngle, endAngle [, anticlockwise ] ) Adds points to the subpath such that the arc described by the circumference of the circle described by the arguments, starting at the given start angle and ending at the given end angle, going in the given direction (defaulting to clockwise), is added to the path, connected to the previous point by a straight line. Throws an INDEX_SIZE_ERR p75 exception if the given radius is negative. context . rect p301 (x, y, w, h) Adds a new closed subpath to the path, representing the given rectangle. context . fill p301 () Fills the subpaths with the current fill style. context . stroke p301 () Strokes the subpaths with the current stroke style. context . clip p302 () Further constrains the clipping region to the given path. context . isPointInPath p302 (x, y) Returns true if the given point is in the current path.
Initially, the context's path must have zero subpaths. The points and lines added to the path by these methods must be transformed according to the current transformation matrix p291 as they are added. The beginPath() method must empty the list of subpaths so that the context once again has zero subpaths. The moveTo(x, y) method must create a new subpath with the specified point as its first (and only) point. When the user agent is to ensure there is a subpath for a coordinate (x, y), the user agent must check to see if the context has any subpaths, and if it does not, then the user agent must create a new subpath with the point (x, y) as its first (and only) point, as if the moveTo() p300 method had been called. The closePath() method must do nothing if the context has no subpaths. Otherwise, it must mark the last subpath as closed, create a new subpath whose first point is the same as the previous subpath's first point, and finally add this new subpath to the path. Note: If the last subpath had more than one point in its list of points, then this is equivalent to adding a straight line connecting the last point back to the first point, thus "closing" the shape, and then repeating the last (possibly implied) moveTo() p300 call. New points and the lines connecting them are added to subpaths using the methods described below. In all cases, the methods only modify the last subpath in the context's paths.
300
The lineTo(x, y) method must ensure there is a subpath p300 for (x, y) if the context has no subpaths. Otherwise, it must connect the last point in the subpath to the given point (x, y) using a straight line, and must then add the given point (x, y) to the subpath. The quadraticCurveTo(cpx, cpy, x, y) method must ensure there is a subpath p300 for (cpx, cpy), and then must connect the last point in the subpath to the given point (x, y) using a quadratic Bzier curve with control point (cpx, cpy), and must then add the given point (x, y) to the subpath. [BEZIER] p781 The bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y) method must ensure there is a subpath p300 for (cp1x, cp1y), and then must connect the last point in the subpath to the given point (x, y) using a cubic Bzier curve with control points (cp1x, cp1y) and (cp2x, cp2y). Then, it must add the point (x, y) to the subpath. [BEZIER] p781 The arcTo(x1, y1, x2, y2, radius) method must first ensure there is a subpath p300 for (x1, y1). Then, the behavior depends on the arguments and the last point in the subpath, as described below. Negative values for radius must cause the implementation to raise an INDEX_SIZE_ERR p75 exception. Let the point (x0, y0) be the last point in the subpath. If the point (x0, y0) is equal to the point (x1, y1), or if the point (x1, y1) is equal to the point (x2, y2), or if the radius radius is zero, then the method must add the point (x1, y1) to the subpath, and connect that point to the previous point (x0, y0) by a straight line. Otherwise, if the points (x0, y0), (x1, y1), and (x2, y2) all lie on a single straight line, then the method must add the point (x1, y1) to the subpath, and connect that point to the previous point (x0, y0) by a straight line. Otherwise, let The Arc be the shortest arc given by circumference of the circle that has radius radius, and that has one point tangent to the half-infinite line that crosses the point (x0, y0) and ends at the point (x1, y1), and that has a different point tangent to the half-infinite line that ends at the point (x1, y1) and crosses the point (x2, y2). The points at which this circle touches these two lines are called the start and end tangent points respectively. The method must connect the point (x0, y0) to the start tangent point by a straight line, adding the start tangent point to the subpath, and then must connect the start tangent point to the end tangent point by The Arc, adding the end tangent point to the subpath. The arc(x, y, radius, startAngle, endAngle, anticlockwise) method draws an arc. If the context has any subpaths, then the method must add a straight line from the last point in the subpath to the start point of the arc. In any case, it must draw the arc between the start point of the arc and the end point of the arc, and add the start and end points of the arc to the subpath. The arc and its start and end points are defined as follows: Consider a circle that has its origin at (x, y) and that has radius radius. The points at startAngle and endAngle along this circle's circumference, measured in radians clockwise from the positive x-axis, are the start and end points respectively. If the anticlockwise argument is omitted or false and endAngle-startAngle is equal to or greater than 2, or, if the anticlockwise argument is true and startAngle-endAngle is equal to or greater than 2, then the arc is the whole circumference of this circle. Otherwise, the arc is the path along the circumference of this circle from the start point to the end point, going anti-clockwise if the anticlockwise argument is true, and clockwise otherwise. Since the points are on the circle, as opposed to being simply angles from zero, the arc can never cover an angle greater than 2 radians. If the two points are the same, or if the radius is zero, then the arc is defined as being of zero length in both directions. Negative values for radius must cause the implementation to raise an INDEX_SIZE_ERR p75 exception. The rect(x, y, w, h) method must create a new subpath containing just the four points (x, y), (x+w, y), (x+w, y+h), (x, y+h), with those four points connected by straight lines, and must then mark the subpath as closed. It must then create a new subpath with the point (x, y) as the only point in the subpath. The fill() method must fill all the subpaths of the current path, using fillStyle p294 , and using the non-zero winding number rule. Open subpaths must be implicitly closed when being filled (without affecting the actual subpaths). Note: Thus, if two overlapping but otherwise independent subpaths have opposite windings, they cancel out and result in no fill. If they have the same winding, that area just gets painted once. The stroke() method must calculate the strokes of all the subpaths of the current path, using the lineWidth p297 , lineCap p297 , lineJoin p297 , and (if appropriate) miterLimit p297 attributes, and then fill the combined stroke area using the strokeStyle p294 attribute.
301
Note: Since the subpaths are all stroked as one, overlapping parts of the paths in one stroke operation are treated as if their union was what was painted. Paths, when filled or stroked, must be painted without affecting the current path, and must be subject to shadow effects p298 , global alpha p293 , the clipping region p302 , and global composition operators p293 . (Transformations affect the path when the path is created, not when it is painted, though the stroke style is still affected by the transformation during painting.) Zero-length line segments must be pruned before stroking a path. Empty subpaths must be ignored. The clip() method must create a new clipping region by calculating the intersection of the current clipping region and the area described by the current path, using the non-zero winding number rule. Open subpaths must be implicitly closed when computing the clipping region, without affecting the actual subpaths. The new clipping region replaces the current clipping region. When the context is initialized, the clipping region must be set to the rectangle with the top left corner at (0,0) and the width and height of the coordinate space. The isPointInPath(x, y) method must return true if the point given by the x and y coordinates passed to the method, when treated as coordinates in the canvas coordinate space unaffected by the current transformation, is inside the current path as determined by the non-zero winding number rule; and must return false otherwise. Points on the path itself are considered to be inside the path. If either of the arguments is infinite or NaN, then the method must return false.
4.8.11.1.9 Focus management When a canvas is interactive, authors should include focusable elements in the element's fallback content corresponding to each focusable part of the canvas. To indicate which focusable part of the canvas is currently focused, authors should use the drawFocusRing() p302 method, passing it the element for which a ring is being drawn. This method only draws the focus ring if the element is focused, so that it can simply be called whenever drawing the element, without checking whether the element is focused or not first. The position of the center of the control, or of the editing caret if the control has one, should be given in the x and y arguments. This box is non-normative. Implementation requirements are given below this box. shouldDraw = context . drawFocusRing p302 (element, x, y, [ canDrawCustom ]) If the given element is focused, draws a focus ring around the current path, following the platform conventions for focus rings. The given coordinate is used if the user's attention needs to be brought to a particular position (e.g. if a magnifier is following the editing caret in a text field). If the canDrawCustom argument is true, then the focus ring is only drawn if the user has configured his system to draw focus rings in a particular manner. (For example, high contrast focus rings.) Returns true if the given element is focused, the canDrawCustom argument is true, and the user has not configured his system to draw focus rings in a particular manner. Otherwise, returns false. When the method returns true, the author is expected to manually draw a focus ring.
The drawFocusRing(element, x, y, [canDrawCustom]) method, when invoked, must run the following steps: 1. If element is not focused or is not a descendant of the element with whose context the method is associated, then return false and abort these steps. Transform the given point (x, y) according to the current transformation matrix p291 . Optionally, inform the user that the focus is at the given (transformed) coordinate on the canvas. (For example, this could involve moving the user's magnification tool.) If the user has requested the use of particular focus rings (e.g. high-contrast focus rings), or if the canDrawCustom argument is absent or false, then draw a focus ring of the appropriate style along the path, following platform conventions, return false, and abort these steps. The focus ring should not be subject to the shadow effects p298 , the global alpha p293 , or the global composition operators p293 , but should be subject to the clipping region p302 . 5. Return true.
2. 3.
4.
This canvas p286 element has a couple of checkboxes: <canvas height=400 width=750> <label><input type=checkbox id=showA> Show As</label>
302
<label><input type=checkbox id=showB> Show Bs</label> <!-- ... --> </canvas> <script> function drawCheckbox(context, element, x, y) { context.save(); context.font = '10px sans-serif'; context.textAlign = 'left'; context.textBaseline = 'middle'; var metrics = context.measureText(element.labels[0].textContent); context.beginPath(); context.strokeStyle = 'black'; context.rect(x-5, y-5, 10, 10); context.stroke(); if (element.checked) { context.fillStyle = 'black'; context.fill(); } context.fillText(element.labels[0].textContent, x+5, y); context.beginPath(); context.rect(x-7, y-7, 12 + metrics.width+2, 14); if (context.drawFocusRing(element, x, y, true)) { context.strokeStyle = 'silver'; context.stroke(); } context.restore(); } function drawBase() { /* ... */ } function drawAs() { /* ... */ } function drawBs() { /* ... */ } function redraw() { var canvas = document.getElementsByTagName('canvas')[0]; var context = canvas.getContext('2d'); context.clearRect(0, 0, canvas.width, canvas.height); drawCheckbox(context, document.getElementById('showA'), 20, 40); drawCheckbox(context, document.getElementById('showB'), 20, 60); drawBase(); if (document.getElementById('showA').checked) drawAs(); if (document.getElementById('showB').checked) drawBs(); } function processClick(event) { var canvas = document.getElementsByTagName('canvas')[0]; var context = canvas.getContext('2d'); var x = event.clientX - canvas.offsetLeft; var y = event.clientY - canvas.offsetTop; drawCheckbox(context, document.getElementById('showA'), 20, 40); if (context.isPointInPath(x, y)) document.getElementById('showA').checked = !(document.getElementById('showA').checked); drawCheckbox(context, document.getElementById('showB'), 20, 60); if (context.isPointInPath(x, y)) document.getElementById('showB').checked = !(document.getElementById('showB').checked); redraw(); } document.getElementsByTagName('canvas')[0].addEventListener('focus', redraw, true); document.getElementsByTagName('canvas')[0].addEventListener('blur', redraw, true); document.getElementsByTagName('canvas')[0].addEventListener('change', redraw, true); document.getElementsByTagName('canvas')[0].addEventListener('click', processClick, false); redraw(); </script>
4.8.11.1.10 Text This box is non-normative. Implementation requirements are given below this box.
303
context . font p304 [ = value ] Returns the current font settings. Can be set, to change the font. The syntax is the same as for the CSS 'font' property; values that cannot be parsed as CSS font values are ignored. Relative keywords and lengths are computed relative to the font of the canvas p286 element. context . textAlign p304 [ = value ] Returns the current text alignment settings. Can be set, to change the alignment. The possible values are start, end, left, right, and center. Other values are ignored. The default is start. context . textBaseline p305 [ = value ] Returns the current baseline alignment settings. Can be set, to change the baseline alignment. The possible values and their meanings are given below. Other values are ignored. The default is alphabetic. context . fillText p305 (text, x, y [, maxWidth ] ) context . strokeText p305 (text, x, y [, maxWidth ] ) Fills or strokes (respectively) the given text at the given position. If a maximum width is provided, the text will be scaled to fit that width if necessary. metrics = context . measureText p306 (text) Returns a TextMetrics p290 object with the metrics of the given text in the current font. metrics . width p306 Returns the advance width of the text that was passed to the measureText() p306 method.
The font IDL attribute, on setting, must be parsed the same way as the 'font' property of CSS (but without supporting property-independent style sheet syntax like 'inherit'), and the resulting font must be assigned to the context, with the 'line-height' component forced to 'normal', with the 'font-size' component converted to CSS pixels, and with system fonts being computed to explicit values. If the new value is syntactically incorrect (including using property-independent style sheet syntax like 'inherit' or 'initial'), then it must be ignored, without assigning a new font value. [CSS] p781 Font names must be interpreted in the context of the canvas p286 element's stylesheets; any fonts embedded using @font-face must therefore be available once they are loaded. (If a font is referenced before it is fully loaded, then it must be treated as if it was an unknown font, falling back to another as described by the relevant CSS specifications.) [CSSFONTS] p781 Only vector fonts should be used by the user agent; if a user agent were to use bitmap fonts then transformations would likely make the font look very ugly. On getting, the font p304 attribute must return the serialized form of the current font of the context (with no 'lineheight' component). [CSSOM] p782 For example, after the following statement: context.font = 'italic 400 12px/2 Unknown Font, sans-serif'; ...the expression context.font would evaluate to the string "italic 12px "Unknown Font", sansserif". The "400" font-weight doesn't appear because that is the default value. The line-height doesn't appear because it is forced to "normal", the default value. When the context is created, the font of the context must be set to 10px sans-serif. When the 'font-size' component is set to lengths using percentages, 'em' or 'ex' units, or the 'larger' or 'smaller' keywords, these must be interpreted relative to the computed value of the 'font-size' property of the corresponding canvas p286 element at the time that the attribute is set. When the 'font-weight' component is set to the relative values 'bolder' and 'lighter', these must be interpreted relative to the computed value of the 'font-weight' property of the corresponding canvas p286 element at the time that the attribute is set. If the computed values are undefined for a particular case (e.g. because the canvas p286 element is not in a Document p29 ), then the relative keywords must be interpreted relative to the normal-weight 10px sans-serif default. The textAlign IDL attribute, on getting, must return the current value. On setting, if the value is one of start, end, left, right, or center, then the value must be changed to the new value. Otherwise, the new value must be ignored. When the context is created, the textAlign p304 attribute must initially have the value start.
304
The textBaseline IDL attribute, on getting, must return the current value. On setting, if the value is one of top p305 , hanging p305 , middle p305 , alphabetic p305 , ideographic p305 , or bottom p305 , then the value must be changed to the new value. Otherwise, the new value must be ignored. When the context is created, the textBaseline p305 attribute must initially have the value alphabetic. The textBaseline p305 attribute's allowed keywords correspond to alignment points in the font:
The keywords map to these alignment points as follows: top The top of the em square hanging The hanging baseline middle The middle of the em square alphabetic The alphabetic baseline ideographic The ideographic baseline bottom The bottom of the em square The fillText() and strokeText() methods take three or four arguments, text, x, y, and optionally maxWidth, and render the given text at the given (x, y) coordinates ensuring that the text isn't wider than maxWidth if specified, using the current font p304 , textAlign p304 , and textBaseline p305 values. Specifically, when the methods are called, the user agent must run the following steps: 1. 2. 3. 4. If maxWidth is present but less than or equal to zero, return without doing anything; abort these steps. Let font be the current font of the context, as given by the font p304 attribute. Replace all the space characters p37 in text with U+0020 SPACE characters. Form a hypothetical infinitely wide CSS line box containing a single inline box containing the text text, with all the properties at their initial values except the 'font' property of the inline box set to font and the 'direction' property of the inline box set to the directionality p94 of the canvas p286 element. [CSS] p781 If the maxWidth argument was specified and the hypothetical width of the inline box in the hypothetical line box is greater than maxWidth CSS pixels, then change font to have a more condensed font (if one is available or if a reasonably readable one can be synthesized by applying a horizontal scale factor to the font) or a smaller font, and return to the previous step. Let the anchor point be a point on the inline box, determined by the textAlign p304 and textBaseline p305 values, as follows: Horizontal position:
5.
6.
305
If textAlign p304 is left If textAlign p304 is start and the directionality p94 of the canvas p286 element is 'ltr' If textAlign p304 is end and the directionality p94 of the canvas p286 element is 'rtl' Let the anchor point's horizontal position be the left edge of the inline box. If textAlign p304 is right If textAlign p304 is end and the directionality p94 of the canvas p286 element is 'ltr' If textAlign p304 is start and the directionality p94 of the canvas p286 element is 'rtl' Let the anchor point's horizontal position be the right edge of the inline box. If textAlign p304 is center Let the anchor point's horizontal position be half way between the left and right edges of the inline box. Vertical position: If textBaseline p305 is top p305 Let the anchor point's vertical position be the top of the em box of the first available font of the inline box. If textBaseline p305 is hanging p305 Let the anchor point's vertical position be the hanging baseline of the first available font of the inline box. If textBaseline p305 is middle p305 Let the anchor point's vertical position be half way between the bottom and the top of the em box of the first available font of the inline box. If textBaseline p305 is alphabetic p305 Let the anchor point's vertical position be the alphabetic baseline of the first available font of the inline box. If textBaseline p305 is ideographic p305 Let the anchor point's vertical position be the ideographic baseline of the first available font of the inline box. If textBaseline p305 is bottom p305 Let the anchor point's vertical position be the bottom of the em box of the first available font of the inline box. 7. Paint the hypothetical inline box as the shape given by the text's glyphs, as transformed by the current transformation matrix p291 , and anchored and sized so that before applying the current transformation matrix p291 , the anchor point is at (x, y) and each CSS pixel is mapped to one coordinate space unit. For fillText() p305 fillStyle p294 must be applied to the glyphs and strokeStyle p294 must be ignored. For strokeText() p305 the reverse holds and strokeStyle p294 must be applied to the glyph outlines and fillStyle p294 must be ignored. Text is painted without affecting the current path, and is subject to shadow effects p298 , global alpha p293 , the clipping region p302 , and global composition operators p293 . The measureText() method takes one argument, text. When the method is invoked, the user agent must replace all the space characters p37 in text with U+0020 SPACE characters, and then must form a hypothetical infinitely wide CSS line box containing a single inline box containing the text text, with all the properties at their initial values except the 'font' property of the inline element set to the current font of the context, as given by the font p304 attribute, and must then return a new TextMetrics p290 object with its width p306 attribute set to the width of that inline box, in CSS pixels. [CSS] p781 The TextMetrics p290 interface is used for the objects returned from measureText() p306 . It has one attribute, width, which is set by the measureText() p306 method. Note: Glyphs rendered using fillText() p305 and strokeText() p305 can spill out of the box given by the font size (the em square size) and the width returned by measureText() p306 (the text width). This version of the specification does not provide a way to obtain the bounding box dimensions of the text. If the text is to be rendered and removed, care needs to be taken to replace the entire area of the canvas that the clipping region covers, not just the box given by the em square height and measured text width.
306
Note: A future version of the 2D context API may provide a way to render fragments of documents, rendered using CSS, straight to the canvas. This would be provided in preference to a dedicated way of doing multiline layout.
4.8.11.1.11 Images To draw images onto the canvas, the drawImage method can be used. This method can be invoked with three different sets of arguments: drawImage(image, dx, dy) drawImage(image, dx, dy, dw, dh) drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh)
Each of those three can take either an HTMLImageElement p200 , an HTMLCanvasElement p286 , or an HTMLVideoElement p229 for the image argument. This box is non-normative. Implementation requirements are given below this box. context . drawImage
p307
context . drawImage p307 (image, dx, dy, dw, dh) context . drawImage p307 (image, sx, sy, sw, sh, dx, dy, dw, dh) Draws the given image onto the canvas. The arguments are interpreted as follows:
If the first argument isn't an img p199 , canvas p286 , or video p228 element, throws a TYPE_MISMATCH_ERR p75 exception. If the image has no image data, throws an INVALID_STATE_ERR p75 exception. If the numeric arguments don't make sense (e.g. the destination is a 00 rectangle), throws an INDEX_SIZE_ERR p75 exception. If the image isn't yet fully decoded, then nothing is drawn.
If not specified, the dw and dh arguments must default to the values of sw and sh, interpreted such that one CSS pixel in the image is treated as one unit in the canvas coordinate space. If the sx, sy, sw, and sh arguments are omitted, they must default to 0, 0, the image's intrinsic width in image pixels, and the image's intrinsic height in image pixels, respectively. The image argument is an instance of either HTMLImageElement p200 , HTMLCanvasElement p286 , or HTMLVideoElement p229 . If the image is null, the implementation must raise a TYPE_MISMATCH_ERR p75 exception. If the image argument is an HTMLImageElement p200 object that is not fully decodable p201 , or if the image argument is an HTMLVideoElement p229 object whose readyState p249 attribute is either HAVE_NOTHING p248 or HAVE_METADATA p248 , then the implementation must return without drawing anything. If the image argument is an HTMLCanvasElement p286 object with either a horizontal dimension or a vertical dimension equal to zero, then the implementation must raise an INVALID_STATE_ERR p75 exception.
307
The source rectangle is the rectangle whose corners are the four points (sx, sy), (sx+sw, sy), (sx+sw, sy+sh), (sx, sy+sh). If one of the sw or sh arguments is zero, the implementation must raise an INDEX_SIZE_ERR p75 exception. The destination rectangle is the rectangle whose corners are the four points (dx, dy), (dx+dw, dy), (dx+dw, dy+dh), (dx, dy+dh). When drawImage() p307 is invoked, the region of the image specified by the source rectangle must be painted on the region of the canvas specified by the destination rectangle, after applying the current transformation matrix p291 to the points of the destination rectangle. The original image data of the source image must be used, not the image as it is rendered (e.g. width p320 and height p320 attributes on the source element have no effect). The image data must be processed in the original direction, even if the dimensions given are negative. Note: This specification does not define the algorithm to use when scaling the image, if necessary. Note: When a canvas is drawn onto itself, the drawing model p311 requires the source to be copied before the image is drawn back onto the canvas, so it is possible to copy parts of a canvas onto overlapping parts of itself. If the original image data is a bitmap image, the value painted at a point in the destination rectangle is computed by filtering the original image data. The user agent may use any filtering algorithm (for example bilinear interpolation or nearest-neighbor). When the filtering algorithm requires a pixel value from outside the original image data, it must instead use the value from the nearest edge pixel. (That is, the filter uses 'clamp-to-edge' behavior.) When the drawImage() p307 method is passed an animated image as its image argument, the user agent must use the poster frame of the animation, or, if there is no poster frame, the first frame of the animation. When the image argument is an HTMLVideoElement p229 , then the frame at the current playback position p247 must be used as the source image, and the source image's dimensions must be the intrinsic width p230 and intrinsic height p230 of the media resource p236 (i.e. after any aspect-ratio correction has been applied). Images are painted without affecting the current path, and are subject to shadow effects p298 , global alpha p293 , the clipping region p302 , and global composition operators p293 .
4.8.11.1.12 Pixel manipulation This box is non-normative. Implementation requirements are given below this box. imagedata = context . createImageData p309 (sw, sh) Returns an ImageData p290 object with the given dimensions in CSS pixels (which might map to a different number of actual device pixels exposed by the object itself). All the pixels in the returned object are transparent black. imagedata = context . createImageData p309 (imagedata) Returns an ImageData p290 object with the same dimensions as the argument. All the pixels in the returned object are transparent black. Throws a NOT_SUPPORTED_ERR p75 exception if the argument is null. imagedata = context . getImageData p309 (sx, sy, sw, sh) Returns an ImageData p290 object containing the image data for the given rectangle of the canvas. Throws a NOT_SUPPORTED_ERR p75 exception if any of the arguments are not finite. Throws an INDEX_SIZE_ERR p75 exception if the either of the width or height arguments are zero. imagedata . width p309 imagedata . height p309 Returns the actual dimensions of the data in the ImageData p290 object, in device pixels. imagedata . data p309 Returns the one-dimensional array containing the data in RGBA order, as integers in the range 0 to 255.
308
context . putImageData p309 (imagedata, dx, dy [, dirtyX, dirtyY, dirtyWidth, dirtyHeight ]) Paints the data from the given ImageData p290 object onto the canvas. If a dirty rectangle is provided, only the pixels from that rectangle are painted. The globalAlpha p293 and globalCompositeOperation p293 attributes, as well as the shadow attributes, are ignored for the purposes of this method call; pixels in the canvas are replaced wholesale, with no composition, alpha blending, no shadows, etc. If the first argument is null, throws a TYPE_MISMATCH_ERR p75 exception. Throws a NOT_SUPPORTED_ERR p75 exception if any of the other arguments are not finite.
The createImageData() method is used to instantiate new blank ImageData p290 objects. When the method is invoked with two arguments sw and sh, it must return an ImageData p290 object representing a rectangle with a width in CSS pixels equal to the absolute magnitude of sw and a height in CSS pixels equal to the absolute magnitude of sh. When invoked with a single imagedata argument, it must return an ImageData p290 object representing a rectangle with the same dimensions as the ImageData p290 object passed as the argument. The ImageData p290 object return must be filled with transparent black. The getImageData(sx, sy, sw, sh) method must return an ImageData p290 object representing the underlying pixel data for the area of the canvas denoted by the rectangle whose corners are the four points (sx, sy), (sx+sw, sy), (sx+sw, sy+sh), (sx, sy+sh), in canvas coordinate space units. Pixels outside the canvas must be returned as transparent black. Pixels must be returned as non-premultiplied alpha values. If any of the arguments to createImageData() p309 or getImageData() p309 are infinite or NaN, or if the createImageData() p309 method is invoked with only one argument but that argument is null, the method must instead raise a NOT_SUPPORTED_ERR p75 exception. If either the sw or sh arguments are zero, the method must instead raise an INDEX_SIZE_ERR p75 exception. ImageData p290 objects must be initialized so that their width attribute is set to w, the number of physical device pixels per row in the image data, their height attribute is set to h, the number of rows in the image data, and their data attribute is initialized to a CanvasPixelArray p291 object holding the image data. At least one pixel's worth of image data must be returned. The CanvasPixelArray p291 object provides ordered, indexed access to the color components of each pixel of the image data. The data must be represented in left-to-right order, row by row top to bottom, starting with the top left, with each pixel's red, green, blue, and alpha components being given in that order for each pixel. Each component of each device pixel represented in this array must be in the range 0..255, representing the 8 bit value for that component. The components must be assigned consecutive indices starting with 0 for the top left pixel's red component. The CanvasPixelArray p291 object thus represents hw4 integers. The length attribute of a CanvasPixelArray p291 object must return this number. The object's supported property indices p34 are the numbers in the range 0 .. hw4-1. To determine the value of an indexed property index, the user agent must return the value of the indexth component in the array. To set the value of an existing indexed property index to value value, the value of the indexth component in the array must be set to value. Note: The width and height (w and h) might be different from the sw and sh arguments to the above methods, e.g. if the canvas is backed by a high-resolution bitmap, or if the sw and sh arguments are negative. The putImageData(imagedata, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight) method writes data from ImageData p290 structures back to the canvas. If any of the arguments to the method are infinite or NaN, the method must raise a NOT_SUPPORTED_ERR p75 exception. If the first argument to the method is null, then the putImageData() p309 method must raise a TYPE_MISMATCH_ERR p75 exception. When the last four arguments are omitted, they must be assumed to have the values 0, 0, the width p309 member of the imagedata structure, and the height p309 member of the imagedata structure, respectively. When invoked with arguments that do not, per the last few paragraphs, cause an exception to be raised, the putImageData() p309 method must act as follows:
309
1.
Let dxdevice be the x-coordinate of the device pixel in the underlying pixel data of the canvas corresponding to the dx coordinate in the canvas coordinate space. Let dydevice be the y-coordinate of the device pixel in the underlying pixel data of the canvas corresponding to the dy coordinate in the canvas coordinate space.
2.
If dirtyWidth is negative, let dirtyX be dirtyX+dirtyWidth, and let dirtyWidth be equal to the absolute magnitude of dirtyWidth. If dirtyHeight is negative, let dirtyY be dirtyY+dirtyHeight, and let dirtyHeight be equal to the absolute magnitude of dirtyHeight.
3.
If dirtyX is negative, let dirtyWidth be dirtyWidth+dirtyX, and let dirtyX be zero. If dirtyY is negative, let dirtyHeight be dirtyHeight+dirtyY, and let dirtyY be zero.
4.
If dirtyX+dirtyWidth is greater than the width p309 attribute of the imagedata argument, let dirtyWidth be the value of that width p309 attribute, minus the value of dirtyX. If dirtyY+dirtyHeight is greater than the height p309 attribute of the imagedata argument, let dirtyHeight be the value of that height p309 attribute, minus the value of dirtyY.
5.
If, after those changes, either dirtyWidth or dirtyHeight is negative or zero, stop these steps without affecting the canvas. Otherwise, for all integer values of x and y where dirtyX x < dirtyX+dirtyWidth and dirtyY y < dirtyY+dirtyHeight, copy the four channels of the pixel with coordinate (x, y) in the imagedata data structure to the pixel with coordinate (dxdevice+x, dydevice+y) in the underlying pixel data of the canvas.
6.
The handling of pixel rounding when the specified coordinates do not exactly map to the device coordinate space is not defined by this specification, except that the following must result in no visible changes to the rendering: context.putImageData(context.getImageData(x, y, w, h), p, q); ...for any value of x, y, w, and h and where p is the smaller of x and the sum of x and w, and q is the smaller of y and the sum of y and h; and except that the following two calls: context.createImageData(w, h); context.getImageData(0, 0, w, h); ...must return ImageData p290 objects with the same dimensions, for any value of w and h. In other words, while user agents may round the arguments of these methods so that they map to device pixel boundaries, any rounding performed must be performed consistently for all of the createImageData() p309 , getImageData() p309 and putImageData() p309 operations. Note: Due to the lossy nature of converting to and from premultiplied alpha color values, pixels that have just been set using putImageData() p309 might be returned to an equivalent getImageData() p309 as different values. The current path, transformation matrix p291 , shadow attributes p298 , global alpha p293 , the clipping region p302 , and global composition operator p293 must not affect the getImageData() p309 and putImageData() p309 methods. The data returned by getImageData() p309 is at the resolution of the canvas backing store, which is likely to not be one device pixel to each CSS pixel if the display used is a high resolution display. In the following example, the script generates an ImageData p290 object so that it can draw onto it. // canvas is a reference to a <canvas> element var context = canvas.getContext('2d'); // create a blank slate var data = context.createImageData(canvas.width, canvas.height); // create some plasma FillPlasma(data, 'green'); // green plasma // add a cloud to the plasma AddCloud(data, data.width/2, data.height/2); // put a cloud in the middle // paint the plasma+cloud on the canvas context.putImageData(data, 0, 0); // support methods
310
function FillPlasma(data, color) { ... } function AddCloud(data, x, y) { ... } Here is an example of using getImageData() p309 and putImageData() p309 to implement an edge detection filter. <!DOCTYPE HTML> <html> <head> <title>Edge detection demo</title> <script> var image = new Image(); function init() { image.onload = demo; image.src = "image.jpeg"; } function demo() { var canvas = document.getElementsByTagName('canvas')[0]; var context = canvas.getContext('2d'); // draw the image onto the canvas context.drawImage(image, 0, 0); // get the image data to manipulate var input = context.getImageData(0, 0, canvas.width, canvas.height); // get an empty slate to put the data into var output = context.createImageData(canvas.width, canvas.height); // alias some variables for convenience // notice that we are using input.width and input.height here // as they might not be the same as canvas.width and canvas.height // (in particular, they might be different on high-res displays) var w = input.width, h = input.height; var inputData = input.data; var outputData = output.data; // edge detection for (var y = 1; y < h-1; y += 1) { for (var x = 1; x < w-1; x += 1) { for (var c = 0; c < 3; c += 1) { var i = (y*w + x)*4 + c; outputData[i] = 127 + -inputData[i - w*4 - 4] inputData[i - w*4] inputData[i - w*4 + 4] + -inputData[i - 4] + 8*inputData[i] inputData[i + 4] + -inputData[i + w*4 - 4] inputData[i + w*4] inputData[i + w*4 + 4]; } outputData[(y*w + x)*4 + 3] = 255; // alpha } } // put the image data back after manipulation context.putImageData(output, 0, 0); } </script> </head> <body onload="init()"> <canvas></canvas> </body> </html>
4.8.11.1.13 Drawing model When a shape or image is painted, user agents must follow these steps, in the order given (or act as if they do): 1. Render the shape or image onto an infinite transparent black bitmap, creating image A, as described in the previous sections. For shapes, the current fill, stroke, and line styles must be honored, and the stroke must itself also be subjected to the current transformation matrix.
311
2.
When shadows are drawn p298 , render the shadow from image A, using the current shadow styles, creating image B. When shadows are drawn p298 , multiply the alpha component of every pixel in B by globalAlpha p293 . When shadows are drawn p298 , composite B within the clipping region p302 over the current canvas bitmap using the current composition operator. Multiply the alpha component of every pixel in A by globalAlpha p293 . Composite A within the clipping region p302 over the current canvas bitmap using the current composition operator.
3. 4.
5. 6.
4.8.11.1.14 Examples This section is non-normative. Here is an example of a script that uses canvas to draw pretty glowing lines. <canvas width="800" height="450"></canvas> <script> var context = document.getElementsByTagName('canvas')[0].getContext('2d'); var lastX = context.canvas.width * Math.random(); var lastY = context.canvas.height * Math.random(); var hue = 0; function line() { context.save(); context.translate(context.canvas.width/2, context.canvas.height/2); context.scale(0.9, 0.9); context.translate(-context.canvas.width/2, -context.canvas.height/2); context.beginPath(); context.lineWidth = 5 + Math.random() * 10; context.moveTo(lastX, lastY); lastX = context.canvas.width * Math.random(); lastY = context.canvas.height * Math.random(); context.bezierCurveTo(context.canvas.width * Math.random(), context.canvas.height * Math.random(), context.canvas.width * Math.random(), context.canvas.height * Math.random(), lastX, lastY); hue = hue + 10 * Math.random(); context.strokeStyle = 'hsl(' + hue + ', 50%, 50%)'; context.shadowColor = 'white'; context.shadowBlur = 10; context.stroke(); context.restore(); } setInterval(line, 50); function blank() { context.fillStyle = 'rgba(0,0,0,0.1)'; context.fillRect(0, 0, context.canvas.width, context.canvas.height); } setInterval(blank, 40); </script>
4.8.11.2 Color spaces and color correction The canvas p286 APIs must perform color correction at only two points: when rendering images with their own gamma correction and color space information onto the canvas, to convert the image to the color space used by the canvas (e.g. using the 2D Context's drawImage() p307 method with an HTMLImageElement p200 object), and when rendering the actual canvas bitmap to the output device. Note: Thus, in the 2D context, colors used to draw shapes onto the canvas will exactly match colors obtained through the getImageData() p309 method.
312
The toDataURL() p288 method must not include color space information in the resource returned. Where the output format allows it, the color of pixels in resources created by toDataURL() p288 must match those returned by the getImageData() p309 method. In user agents that support CSS, the color space used by a canvas p286 element must match the color space used for processing any colors for that element in CSS. The gamma correction and color space information of images must be handled in such a way that an image rendered directly using an img p199 element would use the same colors as one painted on a canvas p286 element that is then itself rendered. Furthermore, the rendering of images that have no color correction information (such as those returned by the toDataURL() p288 method) must be rendered with no color correction. Note: Thus, in the 2D context, calling the drawImage() p307 method to render the output of the toDataURL() p288 method to the canvas, given the appropriate dimensions, has no visible effect.
4.8.11.3 Security with canvas p286 elements Information leakage can occur if scripts from one origin p510 can access information (e.g. read pixels) from images from another origin (one that isn't the same p512 ). To mitigate this, canvas p286 elements are defined to have a flag indicating whether they are origin-clean. All canvas p286 elements must start with their origin-clean set to true. The flag must be set to false if any of the following actions occur: The element's 2D context's drawImage() p307 method is called with an HTMLImageElement p200 or an HTMLVideoElement p229 whose origin p510 is not the same p512 as that of the Document p33 object that owns the canvas p286 element. The element's 2D context's drawImage() p307 method is called with an HTMLCanvasElement p286 whose origin-clean flag is false. The element's 2D context's fillStyle p294 attribute is set to a CanvasPattern p290 object that was created from an HTMLImageElement p200 or an HTMLVideoElement p229 whose origin p510 was not the same p512 as that of the Document p33 object that owns the canvas p286 element when the pattern was created. The element's 2D context's fillStyle p294 attribute is set to a CanvasPattern p290 object that was created from an HTMLCanvasElement p286 whose origin-clean flag was false when the pattern was created. The element's 2D context's strokeStyle p294 attribute is set to a CanvasPattern p290 object that was created from an HTMLImageElement p200 or an HTMLVideoElement p229 whose origin p510 was not the same p512 as that of the Document p33 object that owns the canvas p286 element when the pattern was created. The element's 2D context's strokeStyle p294 attribute is set to a CanvasPattern p290 object that was created from an HTMLCanvasElement p286 whose origin-clean flag was false when the pattern was created.
Whenever the toDataURL() p288 method of a canvas p286 element whose origin-clean flag is set to false is called, the method must raise a SECURITY_ERR p75 exception. Whenever the getImageData() p309 method of the 2D context of a canvas p286 element whose origin-clean flag is set to false is called with otherwise correct arguments, the method must raise a SECURITY_ERR p75 exception. Note: Even resetting the canvas state by changing its width p287 or height p287 attributes doesn't reset the origin-clean flag.
313
Content attributes: Global attributes p90 name p314 DOM interface: interface HTMLMapElement : HTMLElement { attribute DOMString name; readonly attribute HTMLCollection areas; readonly attribute HTMLCollection images; }; The map p313 element, in conjunction with any area p314 element descendants, defines an image map p317 . The element represents p708 its children. The name attribute gives the map a name so that it can be referenced. The attribute must be present and must have a non-empty value with no space characters p37 . The value of the name p314 attribute must not be a compatibility-caseless p36 match for the value of the name p314 attribute of another map p313 element in the same document. If the id p92 attribute is also specified, both attributes must have the same value. This box is non-normative. Implementation requirements are given below this box. map . areas p314 Returns an HTMLCollection p64 of the area p314 elements in the map p313 . map . images p314 Returns an HTMLCollection p64 of the img p199 and object p222 elements that use the map p313 .
The areas attribute must return an HTMLCollection p64 rooted at the map p313 element, whose filter matches only area p314 elements. The images attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only img p199 and object p222 elements that are associated with this map p313 element according to the image map p317 processing model. The IDL attribute name must reflect p62 the content attribute of the same name. Image maps can be defined in conjunction with other content on the page, to ease maintenance. This example is of a page with an image map at the top of the page and a corresponding set of text links at the bottom. <!DOCTYPE HTML> <TITLE>Babies: Toys</TITLE> <HEADER> <H1>Toys</H1> <IMG SRC="/images/menu.gif" ALT="Babies navigation menu. Select a department to go to its page." USEMAP="#NAV"> </HEADER> ... <FOOTER> <MAP NAME="NAV"> <P> <A HREF="/clothes/">Clothes</A> <AREA ALT="Clothes" COORDS="0,0,100,50" HREF="/clothes/"> | <A HREF="/toys/">Toys</A> <AREA ALT="Toys" COORDS="0,0,100,50" HREF="/toys/"> | <A HREF="/food/">Food</A> <AREA ALT="Food" COORDS="0,0,100,50" HREF="/food/"> | <A HREF="/books/">Books</A> <AREA ALT="Books" COORDS="0,0,100,50" HREF="/books/"> </MAP> </FOOTER>
314
Categories Flow content p100 . Phrasing content p100 . Contexts in which this element can be used: Where phrasing content p100 is expected, but only if there is a map p313 element ancestor. Content model: Empty. Content attributes: Global attributes p90 alt p315 coords p316 shape p316 href p440 target p440 ping p440 rel p440 media p440 hreflang p440 type p440 DOM interface: interface HTMLAreaElement : HTMLElement { attribute DOMString alt; attribute DOMString coords; attribute DOMString shape; stringifier attribute DOMString href; attribute DOMString target; attribute DOMString ping; attribute readonly attribute attribute attribute attribute DOMString rel; DOMTokenList relList; DOMString media; DOMString hreflang; DOMString type;
// URL decomposition IDL attributes attribute DOMString protocol; attribute DOMString host; attribute DOMString hostname; attribute DOMString port; attribute DOMString pathname; attribute DOMString search; attribute DOMString hash; }; The area p314 element represents p708 either a hyperlink with some text and a corresponding area on an image map p317 , or a dead area on an image map. If the area p314 element has an href p440 attribute, then the area p314 element represents a hyperlink p440 . In this case, the alt attribute must be present. It specifies the text of the hyperlink. Its value must be text that, when presented with the texts specified for the other hyperlinks of the image map p317 , and with the alternative text of the image, but without the image itself, provides the user with the same kind of choice as the hyperlink would when used without its text but with its shape applied to the image. The alt p315 attribute may be left blank if there is another area p314 element in the same image map p317 that points to the same resource and has a non-blank alt p315 attribute. If the area p314 element has no href p440 attribute, then the area represented by the element cannot be selected, and the alt p315 attribute must be omitted. In both cases, the shape p316 and coords p316 attributes specify the area.
315
The shape attribute is an enumerated attribute p38 . The following table lists the keywords defined for this attribute. The states given in the first cell of the rows with keywords give the states to which those keywords map. Some of the keywords are non-conforming, as noted in the last column.
State Circle state p316 Default state p316 Polygon state p316 Keywords circle circ default poly polygon Rectangle state p316 rect rectangle Non-conforming Non-conforming Non-conforming Notes
The attribute may be omitted. The missing value default is the rectangle p316 state. The coords attribute must, if specified, contain a valid list of integers p42 . This attribute gives the coordinates for the shape described by the shape p316 attribute. The processing for this attribute is described as part of the image map p317 processing model. In the circle state, area p314 elements must have a coords p316 attribute present, with three integers, the last of which must be non-negative. The first integer must be the distance in CSS pixels from the left edge of the image to the center of the circle, the second integer must be the distance in CSS pixels from the top edge of the image to the center of the circle, and the third integer must be the radius of the circle, again in CSS pixels. In the default state state, area p314 elements must not have a coords p316 attribute. (The area is the whole image.) In the polygon state, area p314 elements must have a coords p316 attribute with at least six integers, and the number of integers must be even. Each pair of integers must represent a coordinate given as the distances from the left and the top of the image in CSS pixels respectively, and all the coordinates together must represent the points of the polygon, in order. In the rectangle state, area p314 elements must have a coords p316 attribute with exactly four integers, the first of which must be less than the third, and the second of which must be less than the fourth. The four points must represent, respectively, the distance from the left edge of the image to the left side of the rectangle, the distance from the top edge to the top side, the distance from the left edge to the right side, and the distance from the top edge to the bottom side, all in CSS pixels. When user agents allow users to follow hyperlinks p441 created using the area p314 element, as described in the next section, the href p440 , target p440 and ping p440 attributes decide how the link is followed. The rel p440 , media p440 , hreflang p440 , and type p440 attributes may be used to indicate to the user the likely nature of the target resource before the user follows the link. The target p440 , ping p440 , rel p440 , media p440 , hreflang p440 , and type p440 attributes must be omitted if the href p440 attribute is not present. The activation behavior p102 of area p314 elements is to run the following steps: 1. If the click p33 event in question is not trusted p29 (i.e. a click() p571 method call was the reason for the event being dispatched), and the area p314 element's target p440 attribute is such that applying the rules for choosing a browsing context given a browsing context name p502 , using the value of the target p440 attribute as the browsing context name, would result in there not being a chosen browsing context, then raise an INVALID_ACCESS_ERR p75 exception and abort these steps. Otherwise, the user agent must follow the hyperlink p441 created by the area p314 element, if any.
2.
The IDL attributes alt, coords, href, target, ping, rel, media, hreflang, and type, each must reflect p62 the respective content attributes of the same name. The IDL attribute shape must reflect p62 the shape p316 content attribute. The IDL attribute relList must reflect p62 the rel p440 content attribute. The area p314 element also supports the complement of URL decomposition IDL attributes p57 , protocol, host, port, hostname, pathname, search, and hash. These must follow the rules given for URL decomposition IDL attributes p57 , with the input p58 being the result of resolving p55 the element's href p440 attribute relative to the element, if there is such an attribute and resolving it is successful, or the empty string otherwise; and the common setter action p58 being the same as setting the element's href p440 attribute to the new output value.
316
If we wanted just the colored areas to be clickable, we could do it as follows: <p> Please select a shape: <img src="shapes.png" usemap="#shapes" alt="Four shapes are available: a red hollow box, a green circle, a blue triangle, and a yellow four-pointed star."> <map name="shapes"> <area shape=rect coords="50,50,100,100"> <!-- the hole in the red box --> <area shape=rect coords="25,25,125,125" href="red.html" alt="Red box."> <area shape=circle coords="200,75,50" href="green.html" alt="Green circle."> <area shape=poly coords="325,25,262,125,388,125" href="blue.html" alt="Blue triangle."> <area shape=poly coords="450,25,435,60,400,75,435,90,450,125,465,90,500,75,465,60" href="yellow.html" alt="Yellow star."> </map> </p>
4.8.14.2 Processing model If an img p199 element or an object p222 element representing an image has a usemap p317 attribute specified, user agents must process it as follows: 1. First, rules for parsing a hash-name reference p54 to a map p313 element must be followed. This will return either an element (the map) or null. If that returned null, then abort these steps. The image is not associated with an image map after all. Otherwise, the user agent must collect all the area p314 elements that are descendants of the map. Let those be the areas.
2. 3.
Having obtained the list of area p314 elements that form the image map (the areas), interactive user agents must process the list in one of two ways. If the user agent intends to show the text that the img p199 element represents, then it must use the following steps. Note: In user agents that do not support images, or that have images disabled, object p222 elements cannot represent images, and thus this section never applies (the fallback content p101 is shown instead). The following steps therefore only apply to img p199 elements. 1. 2. Remove all the area p314 elements in areas that have no href p440 attribute. Remove all the area p314 elements in areas that have no alt p315 attribute, or whose alt p315 attribute's value is the empty string, if there is another area p314 element in areas with the same value in the href p440 attribute and with a non-empty alt p315 attribute.
317
3.
Each remaining area p314 element in areas represents a hyperlink p440 . Those hyperlinks should all be made available to the user in a manner associated with the text of the img p199 . In this context, user agents may represent area p314 and img p199 elements with no specified alt attributes, or whose alt attributes are the empty string or some other non-visible text, in a user-agentdefined fashion intended to indicate the lack of suitable author-provided text.
If the user agent intends to show the image and allow interaction with the image to select hyperlinks, then the image must be associated with a set of layered shapes, taken from the area p314 elements in areas, in reverse tree order (so the last specified area p314 element in the map is the bottom-most shape, and the first element in the map, in tree order, is the top-most shape). Each area p314 element in areas must be processed as follows to obtain a shape to layer onto the image: 1. 2. Find the state that the element's shape p316 attribute represents. Use the rules for parsing a list of integers p42 to parse the element's coords p316 attribute, if it is present, and let the result be the coords list. If the attribute is absent, let the coords list be the empty list. If the number of items in the coords list is less than the minimum number given for the area p314 element's current state, as per the following table, then the shape is empty; abort these steps.
State Circle state
p316 p316
3.
Default state
4.
Check for excess items in the coords list as per the entry in the following list corresponding to the shape p316 attribute's state:
p316 Circle state
Drop any items in the list beyond the fourth. 5. If the shape p316 attribute represents the rectangle state p316 , and the first number in the list is numerically less than the third number in the list, then swap those two numbers around. If the shape p316 attribute represents the rectangle state p316 , and the second number in the list is numerically less than the fourth number in the list, then swap those two numbers around. If the shape p316 attribute represents the circle state p316 , and the third number in the list is less than or equal to zero, then the shape is empty; abort these steps. Now, the shape represented by the element is the one described for the entry in the list below corresponding to the state of the shape p316 attribute:
p316 Circle state
6.
7.
8.
Let x be the first number in coords, y be the second number, and r be the third number. The shape is a circle whose center is x CSS pixels from the left edge of the image and y CSS pixels from the top edge of the image, and whose radius is r pixels.
p316 Default state
Let xi be the (2i)th entry in coords, and yi be the (2i+1)th entry in coords (the first entry in coords being the one with index 0). Let the coordinates be (xi, yi), interpreted in CSS pixels measured from the top left of the image, for all integer values of i from 0 to (N/2)-1, where N is the number of items in coords. The shape is a polygon whose vertices are given by the coordinates, and whose interior is established using the even-odd rule. [GRAPHICS] p782
318
Let x1 be the first number in coords, y1 be the second number, x2 be the third number, and y2 be the fourth number. The shape is a rectangle whose top-left corner is given by the coordinate (x1, y1) and whose bottom right corner is given by the coordinate (x2, y2), those coordinates being interpreted as CSS pixels from the top left corner of the image. For historical reasons, the coordinates must be interpreted relative to the displayed image, even if it stretched using CSS or the image element's width and height attributes. Mouse clicks on an image associated with a set of layered shapes per the above algorithm must be dispatched to the top-most shape covering the point that the pointing device indicated (if any), and then, must be dispatched again (with a new Event p33 object) to the image element itself. User agents may also allow individual area p314 elements representing hyperlinks p440 to be selected and activated (e.g. using a keyboard); events from this are not also propagated to the image. Note: Because a map p313 element (and its area p314 elements) can be associated with multiple img p199 and object p222 elements, it is possible for an area p314 element to correspond to multiple focusable areas of the document. Image maps are live p29 ; if the DOM is mutated, then the user agent must act as if it had rerun the algorithms for image maps.
4.8.15 MathML
The math element from the MathML namespace p75 falls into the embedded content p101 , phrasing content p100 , and flow content p100 categories for the purposes of the content models in this specification. User agents must handle text other than inter-element whitespace p98 found in MathML elements whose content models do not allow straight text by pretending for the purposes of MathML content models, layout, and rendering that that text is actually wrapped in an mtext element in the MathML namespace p75 . (Such text is not, however, conforming.) User agents must act as if any MathML element whose contents does not match the element's content model was replaced, for the purposes of MathML layout and rendering, by an merror element in the MathML namespace p75 containing some appropriate error message. To enable authors to use MathML tools that only accept MathML in its XML form, interactive HTML user agents are encouraged to provide a way to export any MathML fragment as an XML namespace-well-formed XML fragment. The semantics of MathML elements are defined by the MathML specification and other applicable specifications p36 . [MATHML] p783 Here is an example of the use of MathML in an HTML document: <!DOCTYPE html> <html> <head> <title>The quadratic formula</title> </head> <body> <h1>The quadratic formula</h1> <p> <math> <mi>x</mi> <mo>=</mo> <mfrac> <mrow> <mo form="prefix"></mo> <mi>b</mi> <mo></mo> <msqrt> <msup> <mi>b</mi> <mn>2</mn> </msup> <mo></mo> <mn>4</mn> <mo></mo> <mi>a</mi> <mo></mo> <mi>c</mi> </msqrt> </mrow> <mrow> <mn>2</mn> <mo></mo> <mi>a</mi> </mrow> </mfrac>
319
4.8.16 SVG
The svg element from the SVG namespace p75 falls into the embedded content p101 , phrasing content p100 , and flow content p100 categories for the purposes of the content models in this specification. To enable authors to use SVG tools that only accept SVG in its XML form, interactive HTML user agents are encouraged to provide a way to export any SVG fragment as an XML namespace-well-formed XML fragment. When the SVG foreignObject element contains elements from the HTML namespace p75 , such elements must all be flow content p100 . [SVG] p785 The content model for title elements in the SVG namespace p75 inside HTML documents p77 is phrasing content p100 . (This further constrains the requirements given in the SVG specification.) The semantics of SVG elements are defined by the SVG specification and other applicable specifications p36 . [SVG] p785 The SVG specification includes requirements regarding the handling of elements in the DOM that are not in the SVG namespace, that are in SVG fragments, and that are not included in a foreignObject element. This specification does not define any processing for elements in SVG fragments that are not in the HTML namespace; they are considered neither conforming nor non-conforming from the perspective of this specification.
The target ratio is the ratio of the intrinsic width to the intrinsic height in the resource. The specified width and specified height are the values of the width p320 and height p320 attributes respectively. The two attributes must be omitted if the resource in question does not have both an intrinsic width and an intrinsic height. If the two attributes are both zero, it indicates that the element is not intended for the user (e.g. it might be a part of a service to count page views). Note: The dimension attributes are not intended to be used to stretch the image. User agent requirements: User agents are expected to use these attributes as hints for the rendering p728 . The width and height IDL attributes on the iframe p213 , embed p220 , object p222 , and video p228 elements must reflect p62 the respective content attributes of the same name. Note: For iframe p213 , embed p220 , and object p222 the IDL attributes are DOMString; for video p228 the IDL attributes are unsigned long.
320
Categories Flow content p100 . Contexts in which this element can be used: Where flow content p100 is expected. Content model: In this order: optionally a caption p327 element, followed by zero or more colgroup p328 elements, followed optionally by a thead p329 element, followed optionally by a tfoot p330 element, followed by either zero or more tbody p328 elements or one or more tr p331 elements, followed optionally by a tfoot p330 element (but there can only be one tfoot p330 element child in total). Content attributes: Global attributes p90 summary p324 (but see prose) DOM interface: interface HTMLTableElement : HTMLElement { attribute HTMLTableCaptionElement caption; HTMLElement createCaption(); void deleteCaption(); attribute HTMLTableSectionElement tHead; HTMLElement createTHead(); void deleteTHead(); attribute HTMLTableSectionElement tFoot; HTMLElement createTFoot(); void deleteTFoot(); readonly attribute HTMLCollection tBodies; HTMLElement createTBody(); readonly attribute HTMLCollection rows; HTMLElement insertRow(in optional long index); void deleteRow(in long index); attribute DOMString summary; }; The table p320 element represents p708 data with more than one dimension, in the form of a table p335 . The table p320 element takes part in the table model p335 . Tables must not be used as layout aids. Historically, some Web authors have misused tables in HTML as a way to control their page layout. This usage is non-conforming, because tools attempting to extract tabular data from such documents would obtain very confusing results. In particular, users of accessibility tools like screen readers are likely to find it very difficult to navigate pages with tables used for layout. Note: There are a variety of alternatives to using HTML tables for layout, primarily using CSS positioning and the CSS table model. User agents that do table analysis on arbitrary content are encouraged to find heuristics to determine which tables actually contain data and which are merely being used for layout. This specification does not define a precise heuristic. Tables have rows, columns, and cells given by their descendants. The rows and columns form a grid; a table's cells must completely cover that grid without overlap. Precise rules for determining whether this conformance requirement is met are described in the description of the table model p335 . For tables that consist of more than just a grid of cells with headers in the first row and headers in the first column, and for any table in general where the reader might have difficulty understanding the content, authors should include explanatory information introducing the table. This information is useful for all users, but is especially useful for users who cannot see the table, e.g. users of screen readers. Such explanatory information should introduce the purpose of the table, outline its basic cell structure, highlight any trends or patterns, and generally teach the user how to use the table. For instance, the following table:
Characteristics with positive and negative sides Negative Characteristic Positive Sad Mood Happy
321
...might benefit from a description explaining the way the table is laid out, something like "Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column". There are a variety of ways to include this information, such as: In prose, surrounding the table <p>In the following table, characteristics are given in the second column, with the negative side in the left column and the positive side in the right column.</p> <table> <caption>Characteristics with positive and negative sides</caption> <thead> <tr> <th id="n"> Negative <th> Characteristic <th> Positive <tbody> <tr> <td headers="n r1"> Sad <th id="r1"> Mood <td> Happy <tr> <td headers="n r2"> Failing <th id="r2"> Grade <td> Passing </table> In the table's caption p327 <table> <caption> <strong>Characteristics with positive and negative sides.</strong> <p>Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column.</p> </caption> <thead> <tr> <th id="n"> Negative <th> Characteristic <th> Positive <tbody> <tr> <td headers="n r1"> Sad <th id="r1"> Mood <td> Happy <tr> <td headers="n r2"> Failing <th id="r2"> Grade <td> Passing </table> In the table's caption p327 , in a details p423 element <table> <caption> <strong>Characteristics with positive and negative sides.</strong> <details> <summary>Help</summary> <p>Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column.</p> </details> </caption> <thead> <tr> <th id="n"> Negative <th> Characteristic <th> Positive
322
<tbody> <tr> <td headers="n r1"> Sad <th id="r1"> Mood <td> Happy <tr> <td headers="n r2"> Failing <th id="r2"> Grade <td> Passing </table> Next to the table, in the same figure p170 <figure> <figcaption>Characteristics with positive and negative sides</figcaption> <p>Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column.</p> <table> <thead> <tr> <th id="n"> Negative <th> Characteristic <th> Positive <tbody> <tr> <td headers="n r1"> Sad <th id="r1"> Mood <td> Happy <tr> <td headers="n r2"> Failing <th id="r2"> Grade <td> Passing </table> </figure> Next to the table, in a figure p170 's figcaption p172 <figure> <figcaption> <strong>Characteristics with positive and negative sides</strong> <p>Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column.</p> </figcaption> <table> <thead> <tr> <th id="n"> Negative <th> Characteristic <th> Positive <tbody> <tr> <td headers="n r1"> Sad <th id="r1"> Mood <td> Happy <tr> <td headers="n r2"> Failing <th id="r2"> Grade <td> Passing </table> </figure> Authors may also use other techniques, or combinations of the above techniques, as appropriate. The best option, of course, rather than writing a description explaining the way the table is laid out, is to adjust the table such that no explanation is needed. In the case of the table used in the examples above, a simple rearrangement of the table so that the headers are on the top and left sides removes the need for an explanation as well as removing the need for the use of headers p334 attributes: <table> <caption>Characteristics with positive and negative sides</caption>
323
<thead> <tr> <th> Characteristic <th> Negative <th> Positive <tbody> <tr> <th> Mood <td> Sad <td> Happy <tr> <th> Grade <td> Failing <td> Passing </table> The summary attribute on table p320 elements was suggested in earlier versions of the language as a technique for providing explanatory text for complex tables for users of screen readers. One of the techniques p321 described above should be used instead. Note: In particular, authors are encouraged to consider whether their explanatory text for tables is likely to be useful to the visually impaired: if their text would not be useful, then it is best to not include a summary p324 attribute. Similarly, if their explanatory text could help someone who is not visually impaired, e.g. someone who is seeing the table for the first time, then the text would be more useful before the table or in the caption p327 . For example, describing the conclusions of the data in a table is useful to everyone; explaining how to read the table, if not obvious from the headers alone, is useful to everyone; describing the structure of the table, if it is easy to grasp visually, may not be useful to everyone, but it might also not be useful to users who can quickly navigate the table with an accessibility tool. If a table p320 element has a summary p324 attribute, the user agent may report the contents of that attribute to the user. This box is non-normative. Implementation requirements are given below this box. table . caption
p325
[ = value ]
Returns the table's caption p327 element. Can be set, to replace the caption p327 element. If the new value is not a caption p327 element, throws a HIERARCHY_REQUEST_ERR p75 exception. caption = table . createCaption p325 () Ensures the table has a caption p327 element, and returns it. table . deleteCaption p325 () Ensures the table does not have a caption p327 element. table . tHead p325 [ = value ] Returns the table's thead p329 element. Can be set, to replace the thead p329 element. If the new value is not a thead p329 element, throws a HIERARCHY_REQUEST_ERR p75 exception. thead = table . createTHead p325 () Ensures the table has a thead p329 element, and returns it. table . deleteTHead p325 () Ensures the table does not have a thead p329 element. table . tFoot p325 [ = value ] Returns the table's tfoot p330 element. Can be set, to replace the tfoot p330 element. If the new value is not a tfoot p330 element, throws a HIERARCHY_REQUEST_ERR p75 exception. tfoot = table . createTFoot p325 () Ensures the table has a tfoot p330 element, and returns it.
324
table . deleteTFoot p325 () Ensures the table does not have a tfoot p330 element. table . tBodies p326 Returns an HTMLCollection p64 of the tbody p328 elements of the table. tbody = table . createTBody p326 () Creates a tbody p328 element, inserts it into the table, and returns it. table . rows p326 Returns an HTMLCollection p64 of the tr p331 elements of the table. tr = table . insertRow p326 (index) Creates a tr p331 element, along with a tbody p328 if required, inserts them into the table at the position given by the argument, and returns the tr p331 . The position is relative to the rows in the table. The index 1 is equivalent to inserting at the end of the table. If the given position is less than 1 or greater than the number of rows, throws an INDEX_SIZE_ERR p75 exception. table . deleteRow p326 (index) Removes the tr p331 element with the given position in the table. The position is relative to the rows in the table. The index 1 is equivalent to deleting the last row of the table. If the given position is less than 1 or greater than the index of the last row, or if there are no rows, throws an INDEX_SIZE_ERR p75 exception.
The caption IDL attribute must return, on getting, the first caption p327 element child of the table p320 element, if any, or null otherwise. On setting, if the new value is a caption p327 element, the first caption p327 element child of the table p320 element, if any, must be removed, and the new value must be inserted as the first node of the table p320 element. If the new value is not a caption p327 element, then a HIERARCHY_REQUEST_ERR p75 DOM exception must be raised instead. The createCaption() method must return the first caption p327 element child of the table p320 element, if any; otherwise a new caption p327 element must be created, inserted as the first node of the table p320 element, and then returned. The deleteCaption() method must remove the first caption p327 element child of the table p320 element, if any. The tHead IDL attribute must return, on getting, the first thead p329 element child of the table p320 element, if any, or null otherwise. On setting, if the new value is a thead p329 element, the first thead p329 element child of the table p320 element, if any, must be removed, and the new value must be inserted immediately before the first element in the table p320 element that is neither a caption p327 element nor a colgroup p328 element, if any, or at the end of the table if there are no such elements. If the new value is not a thead p329 element, then a HIERARCHY_REQUEST_ERR p75 DOM exception must be raised instead. The createTHead() method must return the first thead p329 element child of the table p320 element, if any; otherwise a new thead p329 element must be created and inserted immediately before the first element in the table p320 element that is neither a caption p327 element nor a colgroup p328 element, if any, or at the end of the table if there are no such elements, and then that new element must be returned. The deleteTHead() method must remove the first thead p329 element child of the table p320 element, if any. The tFoot IDL attribute must return, on getting, the first tfoot p330 element child of the table p320 element, if any, or null otherwise. On setting, if the new value is a tfoot p330 element, the first tfoot p330 element child of the table p320 element, if any, must be removed, and the new value must be inserted immediately before the first element in the table p320 element that is neither a caption p327 element, a colgroup p328 element, nor a thead p329 element, if any, or at the end of the table if there are no such elements. If the new value is not a tfoot p330 element, then a HIERARCHY_REQUEST_ERR p75 DOM exception must be raised instead. The createTFoot() method must return the first tfoot p330 element child of the table p320 element, if any; otherwise a new tfoot p330 element must be created and inserted immediately before the first element in the table p320 element that is neither a caption p327 element, a colgroup p328 element, nor a thead p329 element, if any, or at the end of the table if there are no such elements, and then that new element must be returned. The deleteTFoot() method must remove the first tfoot p330 element child of the table p320 element, if any.
325
The tBodies attribute must return an HTMLCollection p64 rooted at the table p320 node, whose filter matches only tbody p328 elements that are children of the table p320 element. The createTBody() method must create a new tbody p328 element, insert it immediately after the last tbody p328 element in the table p320 element, if any, or at the end of the table p320 element if the table p320 element has no tbody p328 element children, and then must return the new tbody p328 element. The rows attribute must return an HTMLCollection p64 rooted at the table p320 node, whose filter matches only tr p331 elements that are either children of the table p320 element, or children of thead p329 , tbody p328 , or tfoot p330 elements that are themselves children of the table p320 element. The elements in the collection must be ordered such that those elements whose parent is a thead p329 are included first, in tree order, followed by those elements whose parent is either a table p320 or tbody p328 element, again in tree order, followed finally by those elements whose parent is a tfoot p330 element, still in tree order. The behavior of the insertRow(index) method depends on the state of the table. When it is called, the method must act as required by the first item in the following list of conditions that describes the state of the table and the index argument:
p326 collection: If index is less than 1 or greater than the number of elements in rows
The method must create a tbody p328 element, then create a tr p331 element, then append the tr p331 element to the tbody p328 element, then append the tbody p328 element to the table p320 element, and finally return the tr p331 element.
p326 collection has zero elements in it: If the rows
The method must create a tr p331 element, append it to the last tbody p328 element in the table, and return the tr p331 element.
p326 collection: If index is missing, equal to 1, or equal to the number of items in rows
The method must create a tr p331 element, and append it to the parent of the last tr p331 element in the rows p326 collection. Then, the newly created tr p331 element must be returned. Otherwise: The method must create a tr p331 element, insert it immediately before the indexth tr p331 element in the rows p326 collection, in the same parent, and finally must return the newly created tr p331 element. When the deleteRow(index) method is called, the user agent must run the following steps: 1. If index is equal to 1, then index must be set to the number if items in the rows p326 collection, minus one. Now, if index is less than zero, or greater than or equal to the number of elements in the rows p326 collection, the method must instead raise an INDEX_SIZE_ERR p75 exception, and these steps must be aborted. Otherwise, the method must remove the indexth element in the rows p326 collection from its parent.
2.
3.
The summary IDL attribute must reflect p62 the content attribute of the same name. Here is an example of a table being used to mark up a Sudoku puzzle. Observe the lack of headers, which are not necessary in such a table. <section> <style scoped> table { border-collapse: collapse; border: solid thick } colgroup, tbody { border: solid medium; } td { border: solid thin; height: 1.4em; width: 1.4em; text-align: center; padding: 0; } </style> <h1>Today's Sudoku</h1> <table> <colgroup><col><col><col> <colgroup><col><col><col> <colgroup><col><col><col> <tbody> <tr> <td> 1 <td> <td> 3 <td> 6 <td> <td> 4 <td> 7 <td> <td> 9 <tr> <td> <td> 2 <td> <td> <td> 9 <td> <td> <td> 1 <td> <tr> <td> 7 <td> <td> <td> <td> <td> <td> <td> <td> 6 <tbody> <tr> <td> 2 <td> <td> 4 <td> <td> 3 <td> <td> 9 <td> <td> 8 <tr> <td> <td> <td> <td> <td> <td> <td> <td> <td>
326
<tr> <td> 5 <td> <tbody> <tr> <td> 6 <td> <tr> <td> <td> <tr> <td> 9 <td> </table> </section>
<td> 9 <td>
<td> 7 <td>
<td> <td> 5 <td> <td> <td> <td> 7 <td> <td> <td> 8 <td> <td> 2 <td>
In the abstract, this table is not clear. However, with a caption giving the table's number (for reference in the main prose) and explaining its use, it makes more sense: <caption> <p>Table 1. <p>This table shows the total score obtained from rolling two six-sided dice. The first row represents the value of the first die, the first column the value of the second die. The total is given in the cell that corresponds to the values of the two dice. </caption> This provides the user with more context:
Table 1. This table shows the total score obtained from rolling two six-sided dice. The first row represents the value of the first die, the first column the value of the second die. The total is given in the cell that corresponds to the values of the two dice.
1 2 3 4 5 6
1 2 3 4 5 6 7
2 3 4 5 6 7 8
3 4 5 6 7 8 9
4 5 6 5 6 7 6 7 8 7 8 9 8 9 10 9 1011 101112
327
328
Contexts in which this element can be used: As a child of a table p320 element, after any caption p327 , colgroup p328 , and thead p329 elements, but only if there are no tr p331 elements that are children of the table p320 element. Content model: Zero or more tr p331 elements Content attributes: Global attributes p90 DOM interface: interface HTMLTableSectionElement : HTMLElement { readonly attribute HTMLCollection rows; HTMLElement insertRow(in optional long index); void deleteRow(in long index); }; The HTMLTableSectionElement p329 interface is also used for thead p329 and tfoot p330 elements. The tbody p328 element represents p708 a block p335 of rows p335 that consist of a body of data for the parent table p320 element, if the tbody p328 element has a parent and it is a table p320 . The tbody p328 element takes part in the table model p335 . This box is non-normative. Implementation requirements are given below this box. tbody . rows
p329
Returns an HTMLCollection p64 of the tr p331 elements of the table section. tr = tbody . insertRow p329 ( [ index ] ) Creates a tr p331 element, inserts it into the table section at the position given by the argument, and returns the tr p331 . The position is relative to the rows in the table section. The index 1, which is the default if the argument is omitted, is equivalent to inserting at the end of the table section. If the given position is less than 1 or greater than the number of rows, throws an INDEX_SIZE_ERR p75 exception. tbody . deleteRow p329 (index) Removes the tr p331 element with the given position in the table section. The position is relative to the rows in the table section. The index 1 is equivalent to deleting the last row of the table section. If the given position is less than 1 or greater than the index of the last row, or if there are no rows, throws an INDEX_SIZE_ERR p75 exception.
The rows attribute must return an HTMLCollection p64 rooted at the element, whose filter matches only tr p331 elements that are children of the element. The insertRow(index) method must, when invoked on an element table section, act as follows: If index is less than 1 or greater than the number of elements in the rows p329 collection, the method must raise an INDEX_SIZE_ERR p75 exception. If index is missing, equal to 1, or equal to the number of items in the rows p329 collection, the method must create a tr p331 element, append it to the element table section, and return the newly created tr p331 element. Otherwise, the method must create a tr p331 element, insert it as a child of the table section element, immediately before the indexth tr p331 element in the rows p329 collection, and finally must return the newly created tr p331 element. The deleteRow(index) method must remove the indexth element in the rows p329 collection from its parent. If index is less than zero or greater than or equal to the number of elements in the rows p329 collection, the method must instead raise an INDEX_SIZE_ERR p75 exception.
329
Categories None. Contexts in which this element can be used: As a child of a table p320 element, after any caption p327 , and colgroup p328 elements and before any tbody p328 , tfoot p330 , and tr p331 elements, but only if there are no other thead p329 elements that are children of the table p320 element. Content model: Zero or more tr p331 elements Content attributes: Global attributes p90 DOM interface: HTMLTableSectionElement p329 , as defined for tbody p328 elements. The thead p329 element represents p708 the block p335 of rows p335 that consist of the column labels (headers) for the parent table p320 element, if the thead p329 element has a parent and it is a table p320 . The thead p329 element takes part in the table model p335 . This example shows a thead p329 element being used. Notice the use of both th p332 and td p332 elements in the thead p329 element: the first row is the headers, and the second row is an explanation of how to fill in the table. <table> <caption> School auction sign-up sheet </caption> <thead> <tr> <th><label for=e1>Name</label> <th><label for=e2>Product</label> <th><label for=e3>Picture</label> <th><label for=e4>Price</label> <tr> <td>Your name here <td>What are you selling? <td>Link to a picture <td>Your reserve price <tbody> <tr> <td>Ms Danus <td>Doughnuts <td><img src="http://example.com/mydoughnuts.png" title="Doughnuts from Ms Danus"> <td>$45 <tr> <td><input id=e1 type=text name=who required form=f> <td><input id=e2 type=text name=what required form=f> <td><input id=e3 type=url name=pic form=f> <td><input id=e4 type=number step=0.01 min=0 value=0 required form=f> </table> <form id=f action="/auction.cgi"> <input type=button name=add value="Submit"> </form>
330
Content model: Zero or more tr p331 elements Content attributes: Global attributes p90 DOM interface: HTMLTableSectionElement p329 , as defined for tbody p328 elements. The tfoot p330 element represents p708 the block p335 of rows p335 that consist of the column summaries (footers) for the parent table p320 element, if the tfoot p330 element has a parent and it is a table p320 . The tfoot p330 element takes part in the table model p335 .
element. element. element. element, after any caption p327 , colgroup p328 , and thead p329 elements, but only elements that are children of the table p320 element.
Returns the position of the row in the table's rows p326 list. Returns 1 if the element isn't in a table. tr . sectionRowIndex p332 Returns the position of the row in the table section's rows p329 list. Returns 1 if the element isn't in a table section. tr . cells p332 Returns an HTMLCollection p64 of the td p332 and th p332 elements of the row. cell = tr . insertCell p332 ( [ index ] ) Creates a td p332 element, inserts it into the table row at the position given by the argument, and returns the td p332 . The position is relative to the cells in the row. The index 1, which is the default if the argument is omitted, is equivalent to inserting at the end of the row.
331
If the given position is less than 1 or greater than the number of cells, throws an INDEX_SIZE_ERR p75 exception. tr . deleteCell p332 (index) Removes the td p332 or th p332 element with the given position in the row. The position is relative to the cells in the row. The index 1 is equivalent to deleting the last cell of the row. If the given position is less than 1 or greater than the index of the last cell, or if there are no cells, throws an INDEX_SIZE_ERR p75 exception.
The rowIndex attribute must, if the element has a parent table p320 element, or a parent tbody p328 , thead p329 , or tfoot p330 element and a grandparent table p320 element, return the index of the tr p331 element in that table p320 element's rows p326 collection. If there is no such table p320 element, then the attribute must return 1. The sectionRowIndex attribute must, if the element has a parent table p320 , tbody p328 , thead p329 , or tfoot p330 element, return the index of the tr p331 element in the parent element's rows collection (for tables, that's the HTMLTableElement.rows p326 collection; for table sections, that's the HTMLTableRowElement.rows p329 collection). If there is no such parent element, then the attribute must return 1. The cells attribute must return an HTMLCollection p64 rooted at the tr p331 element, whose filter matches only td p332 and th p332 elements that are children of the tr p331 element. The insertCell(index) method must act as follows: If index is less than 1 or greater than the number of elements in the cells p332 collection, the method must raise an INDEX_SIZE_ERR p75 exception. If index is missing, equal to 1, or equal to the number of items in cells p332 collection, the method must create a td p332 element, append it to the tr p331 element, and return the newly created td p332 element. Otherwise, the method must create a td p332 element, insert it as a child of the tr p331 element, immediately before the indexth td p332 or th p332 element in the cells p332 collection, and finally must return the newly created td p332 element. The deleteCell(index) method must remove the indexth element in the cells p332 collection from its parent. If index is less than zero or greater than or equal to the number of elements in the cells p332 collection, the method must instead raise an INDEX_SIZE_ERR p75 exception.
332
Contexts in which this element can be used: As a child of a tr p331 element. Content model: Phrasing content p100 . Content attributes: Global attributes p90 colspan p334 rowspan p334 headers p334 scope p333 DOM interface: interface HTMLTableHeaderCellElement : HTMLTableCellElement { attribute DOMString scope; }; The th p332 element represents p708 a header cell p335 in a table. The th p332 element may have a scope content attribute specified. The scope p333 attribute is an enumerated attribute p38 with five states, four of which have explicit keywords: The row keyword, which maps to the row state The row state means the header cell applies to some of the subsequent cells in the same row(s). The col keyword, which maps to the column state The column state means the header cell applies to some of the subsequent cells in the same column(s). The rowgroup keyword, which maps to the row group state The row group state means the header cell applies to all the remaining cells in the row group. A th p332 element's scope p333 attribute must not be in the row group p333 state if the element is not anchored in a row group p335 . The colgroup keyword, which maps to the column group state The column group state means the header cell applies to all the remaining cells in the column group. A th p332 element's scope p333 attribute must not be in the column group p333 state if the element is not anchored in a column group p335 . The auto state The auto state makes the header cell apply to a set of cells selected based on context. The scope p333 attribute's missing value default is the auto state. The th p332 element and its colspan p334 , rowspan p334 , headers p334 , and scope p333 attributes take part in the table model p335 . The scope IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . The following example shows how the scope p333 attribute's rowgroup p333 value affects which data cells a header cell applies to. Here is a markup fragment showing a table: <table> <thead> <tr> <th> <tbody> <tr> <td> <tr> <td> <tr> <td> <tbody> <tr> <td> <tr> <td> <tr> <td> </table>
ID <th> Measurement <th> Average <th> Maximum <th scope=rowgroup> Cats <td> <td> 93 <th> Legs <td> 3.5 <td> 4 10 <th> Tails <td> 1 <td> 1 <th scope=rowgroup> English speakers <td> <td> 32 <th> Legs <td> 2.67 <td> 4 35 <th> Tails <td> 0.33 <td> 1
333
ID
Measurement
2.67 0.33
4 1
The headers in the first row all apply directly down to the rows in their column. The headers with the explicit scope p333 attributes apply to all the cells in their row group other than the cells in the first column. The remaining headers apply just to the cells to the right of them.
334
This box is non-normative. Implementation requirements are given below this box. cell . cellIndex
p335
Returns the position of the cell in the row's cells p332 list. This does not necessarily correspond to the x-position of the cell in the table, since earlier cells might cover multiple rows or columns. Returns 0 if the element isn't in a row.
The colSpan IDL attribute must reflect p62 the content attribute of the same name. The value must be limited to only non-negative numbers greater than zero p63 . The rowSpan IDL attribute must reflect p62 the content attribute of the same name. Its default value, which must be used if parsing the attribute as a non-negative integer p39 returns an error, is 1. The headers IDL attribute must reflect p62 the content attribute of the same name. The cellIndex IDL attribute must, if the element has a parent tr p331 element, return the index of the cell's element in the parent element's cells p332 collection. If there is no such parent element, then the attribute must return 0.
4.9.12.1 Forming a table To determine which elements correspond to which slots in a table p335 associated with a table p320 element, to determine the dimensions of the table (xwidth and yheight), and to determine if there are any table model errors p335 , user agents must use the following algorithm: 1. 2. Let xwidth be zero. Let yheight be zero.
335
3. 4.
Let pending tfoot p330 elements be a list of tfoot p330 elements, initially empty. Let the table be the table p335 represented by the table p320 element. The xwidth and yheight variables give the table's dimensions. The table is initially empty. If the table p320 element has no children elements, then return the table (which will be empty), and abort these steps. Associate the first caption p327 element child of the table p320 element with the table. If there are no such children, then it has no associated caption p327 element. Let the current element be the first element child of the table p320 element. If a step in this algorithm ever requires the current element to be advanced to the next child of the table when there is no such next child, then the user agent must jump to the step labeled end, near the end of this algorithm.
5.
6.
7.
8.
While the current element is not one of the following elements, advance p336 the current element to the next child of the table p320 : colgroup p328 thead p329 tbody p328 tfoot p330 tr p331
9.
If the current element is a colgroup p328 , follow these substeps: 1. Column groups: Process the current element according to the appropriate case below:
p328 element children If the current element has any col
Follow these steps: 1. 2. Let xstart have the value of xwidth. Let the current column be the first col p328 element child of the colgroup p328 element. Columns: If the current column col p328 element has a span p328 attribute, then parse its value using the rules for parsing non-negative integers p39 . If the result of parsing the value is not an error or zero, then let span be that value. Otherwise, if the col p328 element has no span p328 attribute, or if trying to parse the attribute's value resulted in an error or zero, then let span be 1. 4. 5. Increase xwidth by span. Let the last span columns p335 in the table correspond to the current column col p328 element. If current column is not the last col p328 element child of the colgroup p328 element, then let the current column be the next col p328 element child of the colgroup p328 element, and return to the step labeled columns. Let all the last columns p335 in the table from x=xstart to x=xwidth-1 form a new column group p335 , anchored at the slot (xstart, 0), with width xwidth-xstart, corresponding to the colgroup p328 element.
3.
6.
7.
1.
If the colgroup p328 element has a span p328 attribute, then parse its value using the rules for parsing non-negative integers p39 . If the result of parsing the value is not an error or zero, then let span be that value. Otherwise, if the colgroup p328 element has no span p328 attribute, or if trying to parse the attribute's value resulted in an error or zero, then let span be 1.
2.
336
3.
Let the last span columns p335 in the table form a new column group p335 , anchored at the slot (xwidth-span, 0), with width span, corresponding to the colgroup p328 element.
2. 3.
Advance p336 the current element to the next child of the table p320 . While the current element is not one of the following elements, advance p336 the current element to the next child of the table p320 : colgroup p328 thead p329 tbody p328 tfoot p330 tr p331
4.
If the current element is a colgroup p328 element, jump to the step labeled column groups above.
Let ycurrent be zero. Let the list of downward-growing cells be an empty list. Rows: While the current element is not one of the following elements, advance p336 the current element to the next child of the table p320 : thead p329 tbody p328 tfoot p330 tr p331
13.
If the current element is a tr p331 , then run the algorithm for processing rows p338 , advance p336 the current element to the next child of the table p320 , and return to the step labeled rows. Run the algorithm for ending a row group p337 . If the current element is a tfoot p330 , then add that element to the list of pending tfoot p330 elements, advance p336 the current element to the next child of the table p320 , and return to the step labeled rows. The current element is either a thead p329 or a tbody p328 . Run the algorithm for processing row groups p337 .
14. 15.
16.
Advance p336 the current element to the next child of the table p320 . Return to the step labeled rows. End: For each tfoot p330 element in the list of pending tfoot p330 elements, in tree order, run the algorithm for processing row groups p337 . If there exists a row p335 or column p335 in the table containing only slots p335 that do not have a cell p335 anchored to them, then this is a table model error p335 . Return the table.
20.
21.
The algorithm for processing row groups, which is invoked by the set of steps above for processing thead p329 , tbody p328 , and tfoot p330 elements, is: 1. 2. Let ystart have the value of yheight. For each tr p331 element that is a child of the element being processed, in tree order, run the algorithm for processing rows p338 . If yheight > ystart, then let all the last rows p335 in the table from y=ystart to y=yheight-1 form a new row group p335 , anchored at the slot with coordinate (0, ystart), with height yheight-ystart, corresponding to the element being processed. Run the algorithm for ending a row group p337 .
3.
4.
The algorithm for ending a row group, which is invoked by the set of steps above when starting and ending a block of rows, is: 1. While ycurrent is less than yheight, follow these steps: 1. 2. Run the algorithm for growing downward-growing cells p338 . Increase ycurrent by 1.
337
2.
The algorithm for processing rows, which is invoked by the set of steps above for processing tr p331 elements, is: 1. 2. 3. 4. If yheight is equal to ycurrent, then increase yheight by 1. (ycurrent is never greater than yheight.) Let xcurrent be 0. Run the algorithm for growing downward-growing cells p338 . If the tr p331 element being processed has no td p332 or th p332 element children, then increase ycurrent by 1, abort this set of steps, and return to the algorithm above. Let current cell be the first td p332 or th p332 element in the tr p331 element being processed. Cells: While xcurrent is less than xwidth and the slot with coordinate (xcurrent, ycurrent) already has a cell assigned to it, increase xcurrent by 1. If xcurrent is equal to xwidth, increase xwidth by 1. (xcurrent is never greater than xwidth.) If the current cell has a colspan p334 attribute, then parse that attribute's value p39 , and let colspan be the result. If parsing that value failed, or returned zero, or if the attribute is absent, then let colspan be 1, instead. 9. If the current cell has a rowspan p334 attribute, then parse that attribute's value p39 , and let rowspan be the result. If parsing that value failed or if the attribute is absent, then let rowspan be 1, instead. 10. If rowspan is zero, then let cell grows downward be true, and set rowspan to 1. Otherwise, let cell grows downward be false. If xwidth < xcurrent+colspan, then let xwidth be xcurrent+colspan. If yheight < ycurrent+rowspan, then let yheight be ycurrent+rowspan. Let the slots with coordinates (x, y) such that xcurrent x < xcurrent+colspan and ycurrent y < ycurrent+rowspan be covered by a new cell p335 c, anchored at (xcurrent, ycurrent), which has width colspan and height rowspan, corresponding to the current cell element. If the current cell element is a th p332 element, let this new cell c be a header cell; otherwise, let it be a data cell. To establish which header cells apply to the current cell element, use the algorithm for assigning header cells p338 described in the next section. If any of the slots involved already had a cell p335 covering them, then this is a table model error p335 . Those slots now have two cells overlapping. 14. If cell grows downward is true, then add the tuple {c, xcurrent, colspan} to the list of downward-growing cells. Increase xcurrent by colspan. If current cell is the last td p332 or th p332 element in the tr p331 element being processed, then increase ycurrent by 1, abort this set of steps, and return to the algorithm above. Let current cell be the next td p332 or th p332 element in the tr p331 element being processed. Return to the step labelled cells.
5. 6.
7. 8.
15. 16.
17. 18.
When the algorithms above require the user agent to run the algorithm for growing downward-growing cells, the user agent must, for each {cell, cellx, width} tuple in the list of downward-growing cells, if any, extend the cell p335 cell so that it also covers the slots with coordinates (x, ycurrent), where cellx x < cellx+width. 4.9.12.2 Forming relationships between data cells and header cells Each cell can be assigned zero or more header cells. The algorithm for assigning header cells to a cell principal cell is as follows. 1. 2. Let header list be an empty list of cells. Let (principalx, principaly) be the coordinate of the slot to which the principal cell is anchored.
338
3. If the principal cell has a headers p334 attribute specified 1. Take the value of the principal cell's headers p334 attribute and split it on spaces p53 , letting id list be the list of tokens obtained. For each token in the id list, if the first element in the Document p33 with an ID p92 equal to the token is a cell in the same table p335 , and that cell is not the principal cell, then add that cell to header list.
2.
1. 2. 3.
Let principalwidth be the width of the principal cell. Let principalheight be the height of the principal cell. For each value of y from principaly to principaly+principalheight-1, run the internal algorithm for scanning and assigning header cells p339 , with the principal cell, the header list, the initial coordinate (principalx,y), and the increments x=1 and y=0. For each value of x from principalx to principalx+principalwidth-1, run the internal algorithm for scanning and assigning header cells p339 , with the principal cell, the header list, the initial coordinate (x,principaly), and the increments x=0 and y=1. If the principal cell is anchored in a row group p335 , then add all header cells that are row group headers p340 and are anchored in the same row group with an x-coordinate less than or equal to principalx+principalwidth-1 and a y-coordinate less than or equal to principaly+principalheight-1 to header list. If the principal cell is anchored in a column group p335 , then add all header cells that are column group headers p340 and are anchored in the same column group with an xcoordinate less than or equal to principalx+principalwidth-1 and a y-coordinate less than or equal to principaly+principalheight-1 to header list.
4.
5.
6.
4. 5. 6. 7.
Remove all the empty cells p340 from the header list. Remove any duplicates from the header list. Remove principal cell from the header list if it is there. Assign the headers in the header list to the principal cell.
The internal algorithm for scanning and assigning header cells, given a principal cell, a header list, an initial coordinate (initialx, initialy), and x and y increments, is as follows: 1. 2. 3. Let x equal initialx. Let y equal initialy. Let opaque headers be an empty list of cells. 4. If principal cell is a header cell Let in header block be true, and let headers from current header block be a list of cells containing just the principal cell. Otherwise Let in header block be false and let headers from current header block be an empty list of cells. 5. Loop: Increment x by x; increment y by y. Note: For each invocation of this algorithm, one of x and y will be 1, and the other will be 0. 6. 7. If either x or y is less than 0, then abort this internal algorithm. If there is no cell covering slot (x, y), or if there is more than one cell covering slot (x, y), return to the substep labeled loop. Let current cell be the cell covering slot (x, y). 9. If current cell is a header cell 1. 2. Set in header block to true. Add current cell to headers from current header block.
8.
339
3.
Let blocked be false. 4. If x is 0 If there are any cells in the opaque headers list anchored with the same xcoordinate as the current cell, and with the same width as current cell, then let blocked be true. If the current cell is not a column header p340 , then let blocked be true. If y is 0 If there are any cells in the opaque headers list anchored with the same ycoordinate as the current cell, and with the same height as current cell, then let blocked be true. If the current cell is not a row header p340 , then let blocked be true.
5.
If blocked is false, then add the current cell to the headers list.
If current cell is a data cell and in header block is true Set in header block to false. Add all the cells in headers from current header block to the opaque headers list, and empty the headers from current header block list. 10. Return to the step labeled loop.
A header cell anchored at the slot with coordinate (x, y) with width width and height height is said to be a column header if any of the following conditions are true: The cell's scope p333 attribute is in the column p333 state, or The cell's scope p333 attribute is in the auto p333 state, and there are no data cells in any of the cells covering slots with y-coordinates y .. y+height-1.
A header cell anchored at the slot with coordinate (x, y) with width width and height height is said to be a row header if any of the following conditions are true: The cell's scope p333 attribute is in the row p333 state, or The cell's scope p333 attribute is in the auto p333 state, the cell is not a column header p340 , and there are no data cells in any of the cells covering slots with x-coordinates x .. x+width-1.
A header cell is said to be a column group header if its scope p333 attribute is in the column group p333 state. A header cell is said to be a row group header if its scope p333 attribute is in the row group p333 state. A cell is said to be an empty cell if it contains no elements and its text content, if any, consists only of White_Space p37 characters.
4.9.13 Examples
This section is non-normative. The following shows how might one mark up the bottom part of table 45 of the Smithsonian physical tables, Volume 71: <table> <caption>Specification values: <b>Steel</b>, <b>Castings</b>, Ann. A.S.T.M. A27-16, Class B;* P max. 0.06; S max. 0.05.</caption> <thead> <tr> <th rowspan=2>Grade.</th> <th rowspan=2>Yield Point.</th> <th colspan=2>Ultimate tensile strength</th> <th rowspan=2>Per cent elong. 50.8mm or 2 in.</th> <th rowspan=2>Per cent reduct. area.</th> </tr> <tr> <th>kg/mm<sup>2</sup></th> <th>lb/in<sup>2</sup></th> </tr> </thead> <tbody> <tr> <td>Hard</td> <td>0.45 ultimate</td>
340
<td>56.2</td> <td>80,000</td> <td>15</td> <td>20</td> </tr> <tr> <td>Medium</td> <td>0.45 ultimate</td> <td>49.2</td> <td>70,000</td> <td>18</td> <td>25</td> </tr> <tr> <td>Soft</td> <td>0.45 ultimate</td> <td>42.2</td> <td>60,000</td> <td>22</td> <td>30</td> </tr> </tbody> </table> This table could look like this:
Specification values: Steel, Castings, Ann. A.S.T.M. A27-16, Class B;* P max. 0.06; S max. 0.05. Grade. Hard . . . . . Medium . . . . Soft . . . . . . Yield Point. 0.45 ultimate 0.45 ultimate 0.45 ultimate Ultimate tensile strength kg/mm 56.2 49.2 42.2
2 2
lb/in
The following shows how one might mark up the gross margin table on page 46 of Apple, Inc's 10-K filing for fiscal year 2008: <table> <thead> <tr> <th> <th>2008 <th>2007 <th>2006 <tbody> <tr> <th>Net sales <td>$ 32,479 <td>$ 24,006 <td>$ 19,315 <tr> <th>Cost of sales <td> 21,334 <td> 15,852 <td> 13,717 <tbody> <tr> <th>Gross margin <td>$ 11,145 <td>$ 8,154 <td>$ 5,598 <tfoot> <tr> <th>Gross margin percentage <td>34.3% <td>34.0% <td>29.0% </table> This table could look like this:
341
2008
2007
2006
The following shows how one might mark up the operating expenses table from lower on the same page of that document: <table> <colgroup> <col> <colgroup> <col> <col> <col> <thead> <tr> <th> <th>2008 <th>2007 <th>2006 <tbody> <tr> <th scope=rowgroup> Research and development <td> $ 1,109 <td> $ 782 <td> $ 712 <tr> <th scope=row> Percentage of net sales <td> 3.4% <td> 3.3% <td> 3.7% <tbody> <tr> <th scope=rowgroup> Selling, general, and administrative <td> $ 3,761 <td> $ 2,963 <td> $ 2,433 <tr> <th scope=row> Percentage of net sales <td> 11.6% <td> 12.3% <td> 12.6% </table> This table could look like this:
2008 2007 2006
Research and development . . . . . . . . . . . . . . . . . . . . . Percentage of net sales . . . . . . . . . . . . . . . . . . . . . . Selling, general, and administrative . . . . . . . . . . . . . . Percentage of net sales . . . . . . . . . . . . . . . . . . . . . .
4.10 Forms
4.10.1 Introduction
This section is non-normative. A form is a component of a Web page that has form controls, such as text fields, buttons, checkboxes, range controls, or color pickers. A user can interact with such a form, providing data that can then be sent to the server for further processing (e.g. returning the results of a search or calculation). No client-side scripting is needed in many cases, though an API is available so that scripts can augment the user experience or use forms for purposes other than submitting data to a server. Writing a form consists of several steps, which can be performed in any order: writing the user interface, implementing the server-side processing, and configuring the user interface to communicate with the server.
4.10.1.1 Writing a form's user interface This section is non-normative. For the purposes of this brief introduction, we will create a pizza ordering form. Any form starts with a form p347 element, inside which are placed the controls. Most controls are represented by the input p353 element, which by default provides a one-line text field. To label a control, the label p352 element is used; the label text and the control itself go inside the label p352 element. Each part of a form is considered a paragraph p102 , and is typically separated from other parts using p p160 elements. Putting this together, here is how one might ask for the customer's name: <form> <p><label>Customer name: <input></label></p> </form> To let the user select the size of the pizza, we can use a set of radio buttons. Radio buttons also use the input p353 element, this time with a type p355 attribute with the value radio p371 . To make the radio buttons work as a group, they are given a common name using the name p408 attribute. To group a batch of controls together, such as, in this case, the radio buttons, one can use the fieldset p350 element. The title of such a group of controls is given by the first element in the fieldset p350 , which has to be a legend p351 element.
342
<form> <p><label>Customer name: <input></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset> </form> Note: Changes from the previous step are highlighted. To pick toppings, we can use checkboxes. These use the input p353 element with a type p355 attribute with the value checkbox p370 : <form> <p><label>Customer name: <input></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox> Bacon </label></p> <p><label> <input type=checkbox> Extra Cheese </label></p> <p><label> <input type=checkbox> Onion </label></p> <p><label> <input type=checkbox> Mushroom </label></p> </fieldset> </form> The pizzeria for which this form is being written is always making mistakes, so it needs a way to contact the customer. For this purpose, we can use form controls specifically for telephone numbers (input p353 elements with their type p355 attribute set to tel p359 ) and e-mail addresses (input p353 elements with their type p355 attribute set to email p360 ): <form> <p><label>Customer name: <input></label></p> <p><label>Telephone: <input type=tel></label></p> <p><label>E-mail address: <input type=email></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox> Bacon </label></p> <p><label> <input type=checkbox> Extra Cheese </label></p> <p><label> <input type=checkbox> Onion </label></p> <p><label> <input type=checkbox> Mushroom </label></p> </fieldset> </form> We can use an input p353 element with its type p355 attribute set to time p366 to ask for a delivery time. Many of these form controls have attributes to control exactly what values can be specified; in this case, three attributes of particular interest are min p381 , max p381 , and step p381 . These set the minimum time, the maximum time, and the interval between allowed values (in seconds). This pizzeria only delivers between 11am and 9pm, and doesn't promise anything better than 15 minute increments, which we can mark up as follows: <form> <p><label>Customer name: <input></label></p> <p><label>Telephone: <input type=tel></label></p> <p><label>E-mail address: <input type=email></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset>
343
<fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox> Bacon </label></p> <p><label> <input type=checkbox> Extra Cheese </label></p> <p><label> <input type=checkbox> Onion </label></p> <p><label> <input type=checkbox> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900"></label></p> </form> The textarea p395 element can be used to provide a free-form text field. In this instance, we are going to use it to provide a space for the customer to give delivery instructions: <form> <p><label>Customer name: <input></label></p> <p><label>Telephone: <input type=tel></label></p> <p><label>E-mail address: <input type=email></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox> Bacon </label></p> <p><label> <input type=checkbox> Extra Cheese </label></p> <p><label> <input type=checkbox> Onion </label></p> <p><label> <input type=checkbox> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900"></label></p> <p><label>Delivery instructions: <textarea></textarea></label></p> </form> Finally, to make the form submittable we use the button p385 element: <form> <p><label>Customer name: <input></label></p> <p><label>Telephone: <input type=tel></label></p> <p><label>E-mail address: <input type=email></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size> Small </label></p> <p><label> <input type=radio name=size> Medium </label></p> <p><label> <input type=radio name=size> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox> Bacon </label></p> <p><label> <input type=checkbox> Extra Cheese </label></p> <p><label> <input type=checkbox> Onion </label></p> <p><label> <input type=checkbox> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900"></label></p> <p><label>Delivery instructions: <textarea></textarea></label></p> <p><button>Submit order</button></p> </form>
4.10.1.2 Implementing the server-side processing for a form This section is non-normative. The exact details for writing a server-side processor are out of scope for this specification. For the purposes of this introduction, we will assume that the script at https://pizza.example.com/order.cgi is configured to accept submissions using the application/x-www-form-urlencoded p410 format, expecting the following parameters sent in an HTTP POST body:
344
custname Customer's name custtel Customer's telephone number custemail Customer's e-mail address size The pizza size, either small, medium, or large toppings The topping, specified once for each selected topping, with the allowed values being bacon, cheese, onion, and mushroom delivery The requested delivery time comments The delivery instructions
4.10.1.3 Configuring a form to communicate with a server This section is non-normative. Form submissions are exposed to servers in a variety of ways, most commonly as HTTP GET or POST requests. To specify the exact method used, the method p410 attribute is specified on the form p347 element. This doesn't specify how the form data is encoded, though; to specify that, you use the enctype p410 attribute. You also have to specify the URL p55 of the service that will handle the submitted data, using the action p410 attribute. For each form control you want submitted, you then have to give a name that will be used to refer to the data in the submission. We already specified the name for the group of radio buttons; the same attribute (name p408 ) also specifies the submission name. Radio buttons can be distinguished from each other in the submission by giving them different values, using the value p357 attribute. Multiple controls can have the same name; for example, here we give all the checkboxes the same name, and the server distinguishes which checkbox was checked by seeing which values are submitted with that name like the radio buttons, they are also given unique values with the value p357 attribute. Given the settings in the previous section, this all becomes: <form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order.cgi"> <p><label>Customer name: <input name="custname"></label></p> <p><label>Telephone: <input type=tel name="custtel"></label></p> <p><label>E-mail address: <input type=email name="custemail"></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size value="small"> Small </label></p> <p><label> <input type=radio name=size value="medium"> Medium </label></p> <p><label> <input type=radio name=size value="large"> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox name="topping" value="bacon"> Bacon </label></p> <p><label> <input type=checkbox name="topping" value="cheese"> Extra Cheese </label></p> <p><label> <input type=checkbox name="topping" value="onion"> Onion </label></p> <p><label> <input type=checkbox name="topping" value="mushroom"> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900" name="delivery"></label></p> <p><label>Delivery instructions: <textarea name="comments"></textarea></label></p> <p><button>Submit order</button><p> </form> For example, if the customer entered "Denise Lawrence" as their name, "555-321-8642" as their telephone number, did not specify an e-mail address, asked for a medium-sized pizza, selected the Extra Cheese and Mushroom toppings, entered a delivery time of 7pm, and left the delivery instructions text field blank, the user agent would submit the following to the online Web service:
custname=Denise+Lawrence&custtel=555-321-8624&custemail=&size=medium&topping=cheese&topping=mushroom&
345
4.10.1.4 Client-side form validation This section is non-normative. Forms can be annotated in such a way that the user agent will check the user's input before the form is submitted. The server still has to verify the input is valid (since hostile users can easily bypass the form validation), but it allows the user to avoid the wait incurred by having the server be the sole checker of the user's input. The simplest annotation is the required p379 attribute, which can be specified on input p353 elements to indicate that the form is not to be submitted until a value is given. By adding this attribute to the customer name and delivery time fields, we allow the user agent to notify the user when the user submits the form without filling in those fields: <form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order.cgi"> <p><label>Customer name: <input name="custname" required></label></p> <p><label>Telephone: <input type=tel name="custtel"></label></p> <p><label>E-mail address: <input type=email name="custemail"></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size value="small"> Small </label></p> <p><label> <input type=radio name=size value="medium"> Medium </label></p> <p><label> <input type=radio name=size value="large"> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox name="topping" value="bacon"> Bacon </label></p> <p><label> <input type=checkbox name="topping" value="cheese"> Extra Cheese </label></p> <p><label> <input type=checkbox name="topping" value="onion"> Onion </label></p> <p><label> <input type=checkbox name="topping" value="mushroom"> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900" name="delivery" required></label></p> <p><label>Delivery instructions: <textarea name="comments"></textarea></label></p> <p><button>Submit order</button><p> </form> It is also possible to limit the length of the input, using the maxlength p410 attribute. By adding this to the textarea p395 element, we can limit users to 1000 characters, preventing them from writing huge essays to the busy delivery drivers instead of staying focused and to the point: <form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order.cgi"> <p><label>Customer name: <input name="custname" required></label></p> <p><label>Telephone: <input type=tel name="custtel"></label></p> <p><label>E-mail address: <input type=email name="custemail"></label></p> <fieldset> <legend> Pizza Size </legend> <p><label> <input type=radio name=size value="small"> Small </label></p> <p><label> <input type=radio name=size value="medium"> Medium </label></p> <p><label> <input type=radio name=size value="large"> Large </label></p> </fieldset> <fieldset> <legend> Pizza Toppings </legend> <p><label> <input type=checkbox name="topping" value="bacon"> Bacon </label></p> <p><label> <input type=checkbox name="topping" value="cheese"> Extra Cheese </label></p> <p><label> <input type=checkbox name="topping" value="onion"> Onion </label></p> <p><label> <input type=checkbox name="topping" value="mushroom"> Mushroom </label></p> </fieldset> <p><label>Preferred delivery time: <input type=time min="11:00" max="21:00" step="900" name="delivery" required></label></p> <p><label>Delivery instructions: <textarea name="comments" maxlength=1000></textarea></label></p> <p><button>Submit order</button><p> </form>
346
4.10.2 Categories
Mostly for historical reasons, elements in this section fall into several overlapping (but subtly different) categories in addition to the usual ones like flow content p100 , phrasing content p100 , and interactive content p101 . A number of the elements are form-associated elements, which means they can have a form owner p407 and, to expose this, have a form p407 content attribute with a matching form p408 IDL attribute.
button p385 , fieldset p350 , input p353 , keygen p398 , label p352 , meter p403 , object p222 , output p400 ,
progress p402 , select p387 , textarea p395 The form-associated elements p347 fall into several subcategories: Listed elements Denotes elements that are listed in the form.elements p349 and fieldset.elements p351 APIs.
button p385 , fieldset p350 , input p353 , keygen p398 , object p222 , output p400 , select p387 , textarea p395
Labelable elements Denotes elements that can be associated with label p352 elements.
button p385 , input p353 (if the type p355 attribute is not in the hidden p358 state), keygen p398 ,
meter p403 , output p400 , progress p402 , select p387 , textarea p395 Submittable elements Denotes elements that can be used for constructing the form data set p417 when a form p347 element is submitted p417 .
button p385 , input p353 , keygen p398 , object p222 , select p387 , textarea p395
Resettable elements Denotes elements that can be affected when a form p347 element is reset p422 .
input p353 , keygen p398 , output p400 , select p387 , textarea p395
In addition, some submittable elements p347 can be, depending on their attributes, buttons. The prose below defines when an element is a button. Some buttons are specifically submit buttons. Note: The object p222 element is also a form-associated element p347 and can, with the use of a suitable plugin p29 , partake in form submission p416 .
347
readonly attribute HTMLFormControlsCollection elements; readonly attribute long length; caller getter any (in unsigned long index); caller getter any (in DOMString name); void submit(); void reset(); boolean checkValidity(); void dispatchFormInput(); void dispatchFormChange(); }; The form p347 element represents p708 a collection of form-associated elements p347 , some of which can represent editable values that can be submitted to a server for processing. The accept-charset attribute gives the character encodings that are to be used for the submission. If specified, the value must be an ordered set of unique space-separated tokens p53 that are ASCII case-insensitive p36 , and each token must be an ASCII case-insensitive p36 match for the preferred MIME name p30 of an ASCII-compatible character encoding p30 . [IANACHARSET] p782 The name attribute represents the form p347 's name within the forms p83 collection. The value must not be the empty string, and the value must be unique amongst the form p347 elements in the forms p83 collection that it is in, if any. The autocomplete attribute is an enumerated attribute p38 . The attribute has two states. The on keyword maps to the on state, and the off keyword maps to the off state. The attribute may also be omitted. The missing value default is the on p348 state. The off p348 state indicates that by default, input p353 elements in the form will have their resulting autocompletion state p376 set to off; the on p348 state indicates that by default, input p353 elements in the form will have their resulting autocompletion state p376 set to on. The action p410 , enctype p410 , method p410 , novalidate p411 , and target p411 attributes are attributes for form submission p410 . This box is non-normative. Implementation requirements are given below this box. form . elements
p349
Returns an HTMLCollection p64 of the form controls in the form (excluding image buttons for historical reasons). form . length p349 Returns the number of form controls in the form (excluding image buttons for historical reasons). form[index] form(index) Returns the indexth element in the form (excluding image buttons for historical reasons). form[name] form(name) Returns the form control in the form with the given ID p92 or name p408 (excluding image buttons for historical reasons). Once an element has been referenced using a particular name, that name will continue being available as a way to reference that element in this method, even if the element's actual ID p92 or name p408 changes, for as long as the element remains in the Document p33 . If there are multiple matching items, then a NodeList p33 object containing all those elements is returned. Returns null if no element with that ID p92 or name p408 could be found. form . submit p349 () Submits the form.
348
form . reset p349 () Resets the form. form . checkValidity p350 () Returns true if the form's controls are all valid; otherwise, returns false. form . dispatchFormInput p350 () Dispatches a forminput event at all the form controls. form . dispatchFormChange p350 () Dispatches a formchange event at all the form controls.
The autocomplete IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . The name IDL attribute must reflect p62 the content attribute of the same name. The acceptCharset IDL attribute must reflect p62 the accept-charset p348 content attribute. The elements IDL attribute must return an HTMLFormControlsCollection p66 rooted at the Document p33 node, whose filter matches listed elements p347 whose form owner p407 is the form p347 element, with the exception of input p353 elements whose type p355 attribute is in the Image Button p373 state, which must, for historical reasons, be excluded from this particular collection. The length IDL attribute must return the number of nodes represented p64 by the elements p349 collection. The supported property indices p34 at any instant are the indices supported by the object returned by the elements p349 attribute at that instant. When a form p347 element is indexed for indexed property retrieval, the user agent must return the value returned by the item method on the elements p349 collection, when invoked with the given index as its argument. Each form p347 element has a mapping of names to elements called the past names map. It is used to persist names of controls even when they change names. The supported property names p34 are the union of the names currently supported by the object returned by the elements p349 attribute, and the names currently in the past names map p349 . When a form p347 element is indexed for named property retrieval, the user agent must run the following steps: 1. If name is one of the supported property names p34 of the object returned by the elements p349 attribute, then run these substeps: 1. Let candidate be the object returned by the namedItem() p66 method on the object returned by the elements p349 attribute when passed the name argument. If candidate is an element, then add a mapping from name to candidate in the form p347 element's past names map p349 , replacing the previous entry with the same name, if any. Return candidate and abort these steps.
2.
3. 2.
Otherwise, name is the name of one of the entries in the form p347 element's past names map p349 : return the object associated with name in that map.
If an element listed in the form p347 element's past names map p349 is removed from the Document p33 , then its entries must be removed from the map. The submit() method, when invoked, must submit p417 the form p347 element from the form p347 element itself, with the scripted-submit flag set. The reset() method, when invoked, must run the following steps: 1. 2. 3. If the form p347 element is marked as locked for reset p349 , then abort these steps. Mark the form p347 element as locked for reset. Reset p422 the form p347 element.
349
4.
If the checkValidity() method is invoked, the user agent must statically validate the constraints p413 of the form p347 element, and return true if the constraint validation return a positive result, and false if it returned a negative result. If the dispatchFormInput() method is invoked, the user agent must broadcast forminput events p423 from the form p347 element. If the dispatchFormChange() method is invoked, the user agent must broadcast formchange events p423 from the form p347 element. This example shows two search forms: <form action="http://www.google.com/search" method="get"> <label>Google: <input type="search" name="q"></label> <input type="submit" value="Search..."> </form> <form action="http://www.bing.com/search" method="get"> <label>Bing: <input type="search" name="q"></label> <input type="submit" value="Search..."> </form>
350
This box is non-normative. Implementation requirements are given below this box. fieldset . type
p351
Returns the string "fieldset". fieldset . elements p349 Returns an HTMLCollection p64 of the form controls in the element.
The disabled IDL attribute must reflect p62 the content attribute of the same name. The type IDL attribute must return the string "fieldset". The elements IDL attribute must return an HTMLFormControlsCollection p66 rooted at the fieldset p350 element, whose filter matches listed elements p347 . The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The form p408 and name p409 IDL attributes are part of the element's forms API. Constraint validation: fieldset p350 elements are always barred from constraint validation p412 . The following snippet shows a fieldset with a checkbox in the legend that controls whether or not the fieldset is enabled. The contents of the fieldset consist of two required text fields and an optional year/ month control. <fieldset name="clubfields" disabled> <legend> <label> <input type=checkbox name=club onchange="form.clubfields.disabled = !checked"> Use Club Card </label> </legend> <p><label>Name on card: <input name=clubname required></label></p> <p><label>Card number: <input name=clubnum required pattern="[-0-9]+"></label></p> <p><label>Expiry date: <input name=clubexp type=month></label></p> </fieldset> You can also nest fieldset p350 elements. Here is an example expanding on the previous one that does so: <fieldset name="clubfields" disabled> <legend> <label> <input type=checkbox name=club onchange="form.clubfields.disabled = !checked"> Use Club Card </label> </legend> <p><label>Name on card: <input name=clubname required></label></p> <fieldset name="numfields"> <legend> <label> <input type=radio checked name=clubtype onchange="form.numfields.disabled = !checked"> My card has numbers on it </label> </legend> <p><label>Card number: <input name=clubnum required pattern="[-0-9]+"></label></p> </fieldset> <fieldset name="letfields" disabled> <legend> <label> <input type=radio name=clubtype onchange="form.letfields.disabled = !checked"> My card has letters on it </label> </legend> <p><label>Card code: <input name=clublet required pattern="[A-Za-z]+"></label></p> </fieldset> </fieldset> In this example, if the outer "Use Club Card" checkbox is not checked, everything inside the outer fieldset p350 , including the two radio buttons in the legends of the two nested fieldset p350 s, will be disabled. However, if the checkbox is checked, then the radio buttons will both be enabled and will let you select which of the two inner fieldset p350 s is to be enabled.
351
Contexts in which this element can be used: As the first child of a fieldset p350 element. Content model: Phrasing content p100 . Content attributes: Global attributes p90 DOM interface: interface HTMLLegendElement : HTMLElement { readonly attribute HTMLFormElement form; }; The legend p351 element represents p708 a caption for the rest of the contents of the legend p351 element's parent fieldset p350 element, if any. This box is non-normative. Implementation requirements are given below this box. legend . form
p352
The form IDL attribute's behavior depends on whether the legend p351 element is in a fieldset p350 element or not. If the legend p351 has a fieldset p350 element as its parent, then the form p352 IDL attribute must return the same value as the form p408 IDL attribute on that fieldset p350 element. Otherwise, it must return null.
352
If the for p352 attribute is not specified, but the label p352 element has a labelable form-associated element p347 descendant, then the first such descendant in tree order p29 is the label p352 element's labeled control p352 . The label p352 element's exact default presentation and behavior, in particular what its activation behavior p102 might be, if anything, should match the platform's label behavior. For example, on platforms where clicking a checkbox label checks the checkbox, clicking the label p352 in the following snippet could trigger the user agent to run synthetic click activation steps p101 on the input p353 element, as if the element itself had been triggered by the user: <label><input type=checkbox name=lost> Lost</label> On other platforms, the behavior might be just to focus the control, or do nothing. This box is non-normative. Implementation requirements are given below this box. label . control
p353
The form p407 attribute is used to explicitly associate the label p352 element with its form owner p407 . The htmlFor IDL attribute must reflect p62 the for p352 content attribute. The control IDL attribute must return the label p352 element's labeled control p352 , if any, or null if there isn't one. This box is non-normative. Implementation requirements are given below this box. control . labels p353 Returns a NodeList p33 of all the label p352 elements that the form control is associated with.
Labelable form-associated elements p347 have a NodeList p33 object associated with them that represents the list of label p352 elements, in tree order p29 , whose labeled control p352 is the element in question. The labels IDL attribute of labelable form-associated elements p347 , on getting, must return that NodeList p33 object. The form p408 IDL attribute is part of the element's forms API. The following example shows three form controls each with a label, two of which have small text showing the right format for users to use. <p><label>Full name: <input name=fn> <small>Format: First Last</small></label></p> <p><label>Age: <input name=age type=number min=0></label></p> <p><label>Post code: <input name=pc> <small>Format: AB12 3CD</small></label></p>
353
disabled p409 form p407 formaction p410 formenctype p410 formmethod p410 formnovalidate p411 formtarget p411 height p320 list p377 max p381 maxlength p380 min p381 multiple p379 name p408 pattern p380 placeholder p382 readonly p378 required p379 size p379 src p374 step p381 type p355 value p357 width p320 DOM interface: interface HTMLInputElement : HTMLElement { attribute DOMString accept; attribute DOMString alt; attribute DOMString autocomplete; attribute boolean autofocus; attribute boolean defaultChecked; attribute boolean checked; attribute DOMString dirName; attribute boolean disabled; readonly attribute HTMLFormElement form; readonly attribute FileList files; attribute DOMString formAction; attribute DOMString formEnctype; attribute DOMString formMethod; attribute boolean formNoValidate; attribute DOMString formTarget; attribute DOMString height; attribute boolean indeterminate; readonly attribute HTMLElement list; attribute DOMString max; attribute long maxLength; attribute DOMString min; attribute boolean multiple; attribute DOMString name; attribute DOMString pattern; attribute DOMString placeholder; attribute boolean readOnly; attribute boolean required; attribute unsigned long size; attribute DOMString src; attribute DOMString step; attribute DOMString type; attribute DOMString defaultValue; attribute DOMString value; attribute Date valueAsDate; attribute double valueAsNumber; readonly attribute HTMLOptionElement selectedOption; attribute DOMString width;
354
void stepUp(in optional long n); void stepDown(in optional long n); readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); readonly attribute NodeList labels; void select(); attribute unsigned long selectionStart; attribute unsigned long selectionEnd; void setSelectionRange(in unsigned long start, in unsigned long end); }; The input p353 element represents p708 a typed data field, usually with a form control to allow the user to edit the data. The type attribute controls the data type (and associated control) of the element. It is an enumerated attribute p38 . The following table lists the keywords and states for the attribute the keywords in the left column map to the states in the cell in the second column on the same row as the keyword.
Keyword hidden text search tel url email password datetime date month week time State Hidden p358 Text p358 Search p358 Telephone URL
p359 p359
Data type An arbitrary string Text with no line breaks Text with no line breaks Text with no line breaks An absolute IRI An e-mail address or list of e-mail addresses Text with no line breaks (sensitive information) A date and time (year, month, day, hour, minute, second, fraction of a second) with the time zone set to UTC A date (year, month, day) with no time zone A date consisting of a year and a month with no time zone A date consisting of a week-year number and a week number with no time zone A time (hour, minute, seconds, fractional seconds) with no time zone n/a
Control type
Text field Search field A text field A text field A text field Text field that obscures data entry A date and time control A date control A month control A week control A time control
E-mail p360 Password p362 Date and Time p362 Date p363 Month p364 Week p365 Time p366
datetime- Local Date local and Time p366 number range color checkbox radio file submit image reset button Number p368 Range p368 Color p370 Checkbox p370 Radio Button p371 File Upload p372 Submit Button p373 Image Button p373 Reset Button p375 Button p375
A date and time (year, month, day, hour, minute, second, fraction of a second) with no A date and time time zone control A numerical value A numerical value, with the extra semantic that the exact value is not important An sRGB color with 8-bit red, green, and blue components A set of zero or more values from a predefined list An enumerated value Zero or more files each with a MIME type p28 and optionally a file name An enumerated value, with the extra semantic that it must be the last value selected and initiates form submission A text field or spinner control A slider control or similar A color well A checkbox A radio button A label and a button A button
A coordinate, relative to a particular image's size, with the extra semantic that it must Either a clickable be the last value selected and initiates form submission image, or a button n/a n/a A button A button
The missing value default is the Text p358 state. Which of the accept p372 , alt p374 , autocomplete p376 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 content attributes, the checked p384 , files p384 , valueAsDate p384 , valueAsNumber p384 , list p384 , and selectedOption p385 IDL attributes, the select() p412 method, the selectionStart p412 and selectionEnd p412 IDL
355
attributes, the setSelectionRange() p412 method, the stepUp() p384 and stepDown() p384 methods, and the input p385 and change p385 events apply to an input p353 element depends on the state of its type p355 attribute. The following table is non-normative and summarizes which of those content attributes, IDL attributes, methods, and events apply to each state:
Hidden p358 EText p358 , URL p359 , Password p362 p360 Search p358 Telephone p359 mail
Date and Local Date Range p368 Color p370 Che and Time p362 , Time p366 , Date p363 , B p368 Month p364 , Number Week p365 , Time p366
Content attributes accept p372 alt p374 autocomplete p376 checked p357 dirname p376 formaction
p410
Yes Yes
formenctype p410 formmethod p410 formnovalidate p411 formtarget p411 height p320 list
p377
max p381 maxlength p380 min p381 multiple p379 pattern p380 placeholder p382 readonly required size p379 src p374 step p381 width p320 IDL attributes and methods checked p384 files p384 value p383 valueAsDate p384 valueAsNumber p384 list
p384 p378 p379
default p383
def
selectedOption p385 select() p412 selectionStart p412 selectionEnd p412 setSelectionRange() p412 stepDown() p384 stepUp() Events input p385 event change p385 event
p384
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Note: The dagger symbol () indicates that the feature only applies when the multiple p379 attribute is not specified. Some states of the type p355 attribute define a value sanitization algorithm. Each input p353 element has a value p409 , which is exposed by the value p383 IDL attribute. Some states define an algorithm to convert a string to a number, an algorithm to convert a number to a string, an algorithm to convert a string to a Date object, and an algorithm to convert a Date object to a string, which are used by max p381 , min p381 , step p381 , valueAsDate p384 , valueAsNumber p384 , stepDown() p384 , and stepUp() p384 .
356
Each input p353 element has a boolean dirty value flag. The dirty value flag p357 must be initially set to false when the element is created, and must be set to true whenever the user interacts with the control in a way that changes the value p409 . The value content attribute gives the default value p409 of the input p353 element. When the value p357 content attribute is added, set, or removed, if the control's dirty value flag p357 is false, the user agent must set the value p409 of the element to the value of the value p357 content attribute, if there is one, or the empty string otherwise, and then run the current value sanitization algorithm p356 , if one is defined. Each input p353 element has a checkedness p409 , which is exposed by the checked p384 IDL attribute. Each input p353 element has a boolean dirty checkedness flag. When it is true, the element is said to have a dirty checkedness. The dirty checkedness flag p357 must be initially set to false when the element is created, and must be set to true whenever the user interacts with the control in a way that changes the checkedness p409 . The checked content attribute is a boolean attribute p38 that gives the default checkedness p409 of the input p353 element. When the checked p357 content attribute is added, if the control does not have dirty checkedness p357 , the user agent must set the checkedness p409 of the element to true; when the checked p357 content attribute is removed, if the control does not have dirty checkedness p357 , the user agent must set the checkedness p409 of the element to false. The reset algorithm p423 for input p353 elements is to set the dirty value flag p357 and dirty checkedness flag p357 back to false, set the value p409 of the element to the value of the value p357 content attribute, if there is one, or the empty string otherwise, set the checkedness p409 of the element to true if the element has a checked p357 content attribute and false if it does not, empty the list of selected files p372 , and then invoke the value sanitization algorithm p356 , if the type p355 attribute's current state defines one. Each input p353 element is either mutable or immutable. Except where otherwise specified, an input p353 element is always mutable p357 . Similarly, except where otherwise specified, the user agent should not allow the user to modify the element's value p409 or checkedness p409 . When an input p353 element is disabled p409 , it is immutable p357 . When an input p353 element does not have a Document p33 node as one of its ancestors (i.e. when it is not in the document), it is immutable p357 . Note: The readonly p378 attribute can also in some cases (e.g. for the Date p363 state, but not the Checkbox p370 state) make an input p353 element immutable p357 . When an input p353 element is cloned, the element's value p409 , dirty value flag p357 , checkedness p409 , and dirty checkedness flag p357 must be propagated to the clone when it is created. When an input p353 element is first created, the element's rendering and behavior must be set to the rendering and behavior defined for the type p355 attribute's state, and the value sanitization algorithm p356 , if one is defined for the type p355 attribute's state, must be invoked. When an input p353 element's type p355 attribute changes state, the user agent must run the following steps: 1. If the previous state of the element's type p355 attribute put the value p383 IDL attribute in the value p383 mode, and the element's value p409 is not the empty string, and the new state of the element's type p355 attribute puts the value p383 IDL attribute in either the default p383 mode or the default/on p383 mode, then set the element's value p357 content attribute to the element's value p409 . Otherwise, if the previous state of the element's type p355 attribute put the value p383 IDL attribute in any mode other than the value p383 mode, and the new state of the element's type p355 attribute puts the value p383 IDL attribute in the value p383 mode, then set the value p409 of the element to the value of the value p357 content attribute, if there is one, or the empty string otherwise, and then set the control's dirty value flag p357 to false. Update the element's rendering and behavior to the new state's. Invoke the value sanitization algorithm p356 , if one is defined for the type p355 attribute's new state.
2.
3. 4.
The form p407 attribute is used to explicitly associate the input p353 element with its form owner p407 . The name p408 attribute represents the element's name. The disabled p409 attribute is used to make the control non-interactive and to prevent its value from being submitted. The autofocus p409 attribute controls focus. The indeterminate IDL attribute must initially be set to false. On getting, it must return the last value it was set to. On setting, it must be set to the new value. It has no effect except for changing the appearance of checkbox p370 controls.
357
The accept, alt, max, min, multiple, pattern, placeholder, required, size, src, and step IDL attributes must reflect p62 the respective content attributes of the same name. The dirName IDL attribute must reflect p62 the dirname p376 content attribute. The readOnly IDL attribute must reflect p62 the readonly p378 content attribute. The defaultChecked IDL attribute must reflect p62 the checked p357 content attribute. The defaultValue IDL attribute must reflect p62 the value p357 content attribute. The autocomplete and type IDL attributes must reflect p62 the respective content attributes of the same name, limited to only known values p62 . The maxLength IDL attribute must reflect p62 the maxlength p380 content attribute, limited to only non-negative numbers p63 . The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The select() p412 , selectionStart p412 , selectionEnd p412 , and setSelectionRange() p412 methods and attributes expose the element's text selection. The autofocus p410 , disabled p409 , form p408 , and name p409 IDL attributes are part of the element's forms API.
4.10.7.1 States of the type p355 attribute 4.10.7.1.1 Hidden state When an input p353 element's type p355 attribute is in the Hidden p358 state, the rules in this section apply. The input p353 element represents p708 a value that is not intended to be examined or manipulated by the user. Constraint validation: If an input p353 element's type p355 attribute is in the Hidden p358 state, it is barred from constraint validation p412 . If the name p357 attribute is present and has a value that is a case-sensitive p36 match for the string "_charset_ p409 ", then the element's value p357 attribute must be omitted.
Bookkeeping details The value p383 IDL attribute applies to this element and is in mode default p383 . The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 and change p385 events do not apply.
4.10.7.1.2 Text state and Search state When an input p353 element's type p355 attribute is in the Text p358 state or the Search p358 state, the rules in this section apply. The input p353 element represents p708 a one line plain text edit control for the element's value p409 . Note: The difference between the Text p358 state and the Search p358 state is primarily stylistic: on platforms where search fields are distinguished from regular text fields, the Search p358 state might result in an appearance consistent with the platform's search fields rather than appearing like a regular text field. If the element is mutable p357 , its value p409 should be editable by the user. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the element's value p409 . If the element is mutable p357 , the user agent should allow the user to change the writing direction of the element, setting it either to a left-to-right writing direction or a right-to-left writing direction. If the user does so, the user agent must then run the following steps: 1. Set the element's dir p93 attribute to "ltr p93 " if the user selected a left-to-right writing direction, and "rtl p93 " if the user selected a right-to-left writing direction. Queue a task p553 to first fire a simple event p559 that bubbles named input at the input p353 element, and to then broadcast forminput events p423 from the input p353 element's form owner p407 , if any.
2.
The value p357 attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. The value sanitization algorithm p356 is as follows: Strip line breaks p38 from the value p409 .
358
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , dirname p376 , list p377 , maxlength p380 , pattern p380 , placeholder p382 , readonly p378 , required p379 , and size p379 content attributes; list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , and value p383 IDL attributes; select() p412 and setSelectionRange() p412 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , max p381 , min p381 , multiple p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; stepDown() p384 and stepUp() p384 methods.
4.10.7.1.3 Telephone state When an input p353 element's type p355 attribute is in the Telephone p359 state, the rules in this section apply. The input p353 element represents p708 a control for editing a telephone number given in the element's value p409 . If the element is mutable p357 , its value p409 should be editable by the user. User agents may change the spacing and, with care, the punctuation of values p409 that the user enters. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the element's value p409 . The value p357 attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. The value sanitization algorithm p356 is as follows: Strip line breaks p38 from the value p409 . Note: Unlike the URL p359 and E-mail p360 types, the Telephone p359 type does not enforce a particular syntax. This is intentional; in practice, telephone number fields tend to be free-form fields, because there are a wide variety of valid phone numbers. Systems that need to enforce a particular format are encouraged to use the pattern p380 attribute or the setCustomValidity() p415 method to hook into the client-side validation mechanism.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , maxlength p380 , pattern p380 , placeholder p382 , readonly p378 , required p379 , and size p379 content attributes; list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , and value p383 IDL attributes; select() p412 and setSelectionRange() p412 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , max p381 , min p381 , multiple p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; stepDown() p384 and stepUp() p384 methods.
4.10.7.1.4 URL state When an input p353 element's type p355 attribute is in the URL p359 state, the rules in this section apply. The input p353 element represents p708 a control for editing a single absolute URL p56 given in the element's value p409 . If the element is mutable p357 , the user agent should allow the user to change the URL represented by its value p409 . User agents may allow the user to set the value p409 to a string that is not a valid p55 absolute URL p56 , but may also or instead automatically escape characters entered by the user so that the value p409 is always a valid p55 absolute URL p56 (even if that isn't the actual value seen and edited by the user in the interface). User agents should allow the user to set the value p409 to the empty string. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value p409 . The value p357 attribute, if specified, must have a value that is a valid URL potentially surrounded by spaces p55 that is also an absolute URL p56 . The value sanitization algorithm p356 is as follows: Strip line breaks p38 from the value p409 , then strip leading and trailing whitespace p38 from the value p409 . Constraint validation: While the value p409 of the element is not a valid p55 absolute URL p56 , the element is suffering from a type mismatch p413 .
Bookkeeping details
359
The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , maxlength p380 , pattern p380 , placeholder p382 , readonly p378 , required p379 , and size p379 content attributes; list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , and value p383 IDL attributes; select() p412 and setSelectionRange() p412 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , max p381 , min p381 , multiple p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; stepDown() p384 and stepUp() p384 methods.
If a document contained the following markup: <input type="url" name="location" list="urls"> <datalist id="urls"> <option label="MIME: Format of Internet Message Bodies" value="http://tools.ietf.org/ html/rfc2045"> <option label="HTML 4.01 Specification" value="http://www.w3.org/TR/html4/"> <option label="Form Controls" value="http://www.w3.org/TR/xforms/ slice8.html#ui-commonelems-hint"> <option label="Scalable Vector Graphics (SVG) 1.1 Specification" value="http://www.w3.org/TR/SVG/"> <option label="Feature Sets - SVG 1.1 - 20030114" value="http://www.w3.org/TR/SVG/ feature.html"> <option label="The Single UNIX Specification, Version 3" value="http://www.unix-systems.org/version3/"> </datalist> ...and the user had typed "www.w3", and the user agent had also found that the user had visited http://www.w3.org/Consortium/#membership and http://www.w3.org/TR/XForms/ in the recent past, then the rendering might look like this:
The first four URLs in this sample consist of the four URLs in the author-specified list that match the text the user has entered, sorted in some UA-defined manner (maybe by how frequently the user refers to those URLs). Note how the UA is using the knowledge that the values are URLs to allow the user to omit the scheme part and perform intelligent matching on the domain name. The last two URLs (and probably many more, given the scrollbar's indications of more values being available) are the matches from the user agent's session history data. This data is not made available to the page DOM. In this particular case, the UA has no titles to provide for those values.
4.10.7.1.5 E-mail state When an input p353 element's type p355 attribute is in the E-mail p360 state, the rules in this section apply. How the E-mail p360 state operates depends on whether the multiple p379 attribute is specified or not.
p379 attribute is not specified on the element When the multiple
The input p353 element represents p708 a control for editing an e-mail address given in the element's value p409 . If the element is mutable p357 , the user agent should allow the user to change the e-mail address represented by its value p409 . User agents may allow the user to set the value p409 to a string that is not a valid e-mail address p361 . The user agent should act in a manner consistent with expecting the user to provide a single e-mail address. User agents should allow the user to set the value p409 to the empty string. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value p409 . User agents may transform the value p409 for display and editing (e.g. converting punycode in the value p409 to IDN in the display and vice versa). The value p357 attribute, if specified, must have a value that is a single valid e-mail address p361 .
360
The value sanitization algorithm p356 is as follows: Strip line breaks p38 from the value p409 . When the multiple p379 attribute is removed, the user agent must run the value sanitization algorithm p356 . Constraint validation: While the value p409 of the element is not a single valid e-mail address p361 , the element is suffering from a type mismatch p413 .
p379 attribute is specified on the element When the multiple
The element's values p409 are the result of splitting on commas p54 the element's value p409 . The input p353 element represents p708 a control for adding, removing, and editing the e-mail addresses given in the element's values p409 . If the element is mutable p357 , the user agent should allow the user to add, remove, and edit the e-mail addresses represented by its values p409 . User agents may allow the user to set any individual value in the list of values p409 to a string that is not a valid e-mail address p361 , but must not allow users to set any individual value to a string containing U+002C COMMA (,), U+000A LINE FEED (LF), or U+000D CARRIAGE RETURN (CR) characters. User agents should allow the user to remove all the addresses in the element's values p409 . User agents may transform the values p409 for display and editing (e.g. converting punycode in the values p409 to IDN in the display and vice versa). Whenever the user changes the element's values p409 , the user agent must run the following steps: 1. 2. 3. Let latest values be a copy of the element's values p409 . Strip leading and trailing whitespace p38 from each value in latest values. Let the element's value p409 be the result of concatenating all the values in latest values, separating each value from the next by a single U+002C COMMA character (,), maintaining the list's order.
The value p357 attribute, if specified, must have a value that is a valid e-mail address list p361 . The value sanitization algorithm p356 is as follows: 1. Split on commas p54 the element's value p409 , strip leading and trailing whitespace p38 from each resulting token, if any, and let the element's values p409 be the (possibly empty) resulting list of (possibly empty) tokens, maintaining the original order. Let the element's value p409 be the result of concatenating the element's values p409 , separating each value from the next by a single U+002C COMMA character (,), maintaining the list's order.
2.
When the multiple p379 attribute is set, the user agent must run the value sanitization algorithm p356 . Constraint validation: While the value p409 of the element is not a valid e-mail address list p361 , the element is suffering from a type mismatch p413 . A valid e-mail address is a string that matches the ABNF production 1*( atext / "." ) "@" ldhstr 1*( "." ldh-str ) where atext is defined in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section 3.5. [ABNF] p781 [RFC5322] p785 [RFC1034] p783 Note: This requirement is a willful violation p18 of RFC 5322, which defines a syntax for e-mail addresses that is simultaneously too strict (before the "@" character), too vague (after the "@" character), and too lax (allowing comments, white space characters, and quoted strings in manners unfamiliar to most users) to be of practical use here. A valid e-mail address list is a set of comma-separated tokens p54 , where each token is itself a valid e-mail address p361 . To obtain the list of tokens from a valid e-mail address list p361 , and implementation must split the string on commas p54 .
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , and size p379 content attributes; list p384 and value p383 IDL attributes. The following common input p353 element content attributes, IDL attributes, and methods apply to the element when the multiple p379 attribute is not specified: selectedOption p385 IDL attribute. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply.
361
The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , max p381 , min p381 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 and stepUp() p384 methods.
4.10.7.1.6 Password state When an input p353 element's type p355 attribute is in the Password p362 state, the rules in this section apply. The input p353 element represents p708 a one line plain text edit control for the element's value p409 . The user agent should obscure the value so that people other than the user cannot see it. If the element is mutable p357 , its value p409 should be editable by the user. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value p409 . The value p357 attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. The value sanitization algorithm p356 is as follows: Strip line breaks p38 from the value p409 .
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , maxlength p380 , pattern p380 , placeholder p382 , readonly p378 , required p379 , and size p379 content attributes; selectionStart p412 , selectionEnd p412 , and value p383 IDL attributes; select() p412 , and setSelectionRange() p412 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , min p381 , multiple p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; stepDown() p384 and stepUp() p384 methods.
4.10.7.1.7 Date and Time state When an input p353 element's type p355 attribute is in the Date and Time p362 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a specific global date and time p47 . User agents may display the date and time in whatever time zone is appropriate for the user. If the element is mutable p357 , the user agent should allow the user to change the global date and time p47 represented by its value p409 , as obtained by parsing a global date and time p48 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid global date and time string p47 expressed in UTC, though user agents may allow the user to set and view the time in another time zone and silently translate the time to and from the UTC time zone in the value p409 . If the user agent provides a user interface for selecting a global date and time p47 , then the value p409 must be set to a valid global date and time string p47 expressed in UTC representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present dates and times according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid global date and time string p47 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is a valid global date and time string p47 , then adjust the time so that the value p409 represents the same point in time but expressed in the UTC time zone, otherwise, set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid global date and time string p47 . The max p381 attribute, if specified, must have a value that is a valid global date and time string p47 . The step p381 attribute is expressed in seconds. The step scale factor p381 is 1000 (which converts the seconds to milliseconds, as used in the other algorithms). The default step p381 is 60 seconds. When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest global date and time p47 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a global date and time p48 from input results in an error, then return an error; otherwise, return the number of milliseconds
362
elapsed from midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z") to the parsed global date and time p47 , ignoring leap seconds. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid global date and time string p47 expressed in UTC that represents the global date and time p47 that is input milliseconds after midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z"). The algorithm to convert a string to a Date object p356 , given a string input, is as follows: If parsing a global date and time p48 from input results in an error, then return an error; otherwise, return a Date object representing the parsed global date and time p47 , expressed in UTC. The algorithm to convert a Date object to a string p356 , given a Date object input, is as follows: Return a valid global date and time string p47 expressed in UTC that represents the global date and time p47 that is represented by input.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsDate p384 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , and selectionEnd p412 IDL attributes; select() p412 and setSelectionRange() p412 methods.
The following fragment shows part of a calendar application. A user can specify a date and time for a meeting (in his local time zone, probably, though the user agent can allow the user to change that), and since the submitted data includes the time-zone offset, the application can ensure that the meeting is shown at the correct time regardless of the time zones used by all the participants. <fieldset> <legend>Add Meeting</legend> <p><label>Meeting name: <input type=text name="meeting.label"></label> <p><label>Meeting time: <input type=datetime name="meeting.start"></label> </fieldset> Had the application used the datetime-local p366 type instead, the calendar application would have also had to explicitly determine which time zone the user intended.
4.10.7.1.8 Date state When an input p353 element's type p355 attribute is in the Date p363 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a specific date p45 . If the element is mutable p357 , the user agent should allow the user to change the date p45 represented by its value p409 , as obtained by parsing a date p45 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid date string p45 . If the user agent provides a user interface for selecting a date p45 , then the value p409 must be set to a valid date string p45 representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present dates according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid date string p45 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid date string p45 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid date string p45 . The max p381 attribute, if specified, must have a value that is a valid date string p45 . The step p381 attribute is expressed in days. The step scale factor p381 is 86,400,000 (which converts the days to milliseconds, as used in the other algorithms). The default step p381 is 1 day.
363
When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest date p45 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a date p45 from input results in an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z") to midnight UTC on the morning of the parsed date p45 , ignoring leap seconds. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid date string p45 that represents the date p45 that, in UTC, is current input milliseconds after midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z"). The algorithm to convert a string to a Date object p356 , given a string input, is as follows: If parsing a date p45 from input results in an error, then return an error; otherwise, return a Date object representing midnight UTC on the morning of the parsed date p45 . The algorithm to convert a Date object to a string p356 , given a Date object input, is as follows: Return a valid date string p45 that represents the date p45 current at the time represented by input in the UTC time zone.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsDate p384 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , selectionStart p412 , and selectionEnd p412 IDL attributes; select() p412 and setSelectionRange() p412 methods.
4.10.7.1.9 Month state When an input p353 element's type p355 attribute is in the Month p364 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a specific month p44 . If the element is mutable p357 , the user agent should allow the user to change the month p44 represented by its value p409 , as obtained by parsing a month p45 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid month string p45 . If the user agent provides a user interface for selecting a month p44 , then the value p409 must be set to a valid month string p45 representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present months according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid month string p45 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid month string p45 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid month string p45 . The max p381 attribute, if specified, must have a value that is a valid month string p45 . The step p381 attribute is expressed in months. The step scale factor p381 is 1 (there is no conversion needed as the algorithms use months). The default step p381 is 1 month. When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest month p44 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a month p45 from input results in an error, then return an error; otherwise, return the number of months between January 1970 and the parsed month p44 . The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid month string p45 that represents the month p44 that has input months between it and January 1970.
364
The algorithm to convert a string to a Date object p356 , given a string input, is as follows: If parsing a month p45 from input results in an error, then return an error; otherwise, return a Date object representing midnight UTC on the morning of the first day of the parsed month p44 . The algorithm to convert a Date object to a string p356 , given a Date object input, is as follows: Return a valid month string p45 that represents the month p44 current at the time represented by input in the UTC time zone.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsDate p384 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , and selectionEnd p412 IDL attributes; select() p412 and setSelectionRange() p412 methods.
4.10.7.1.10 Week state When an input p353 element's type p355 attribute is in the Week p365 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a specific week p49 . If the element is mutable p357 , the user agent should allow the user to change the week p49 represented by its value p409 , as obtained by parsing a week p50 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid week string p49 . If the user agent provides a user interface for selecting a week p49 , then the value p409 must be set to a valid week string p49 representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present weeks according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid week string p49 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid week string p49 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid week string p49 . The max p381 attribute, if specified, must have a value that is a valid week string p49 . The step p381 attribute is expressed in weeks. The step scale factor p381 is 604,800,000 (which converts the weeks to milliseconds, as used in the other algorithms). The default step p381 is 1 week. The default step base p381 is 259,200,000 (the start of week 1970-W01). When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest week p49 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a week string p50 from input results in an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z") to midnight UTC on the morning of the Monday of the parsed week p49 , ignoring leap seconds. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid week string p49 that represents the week p49 that, in UTC, is current input milliseconds after midnight UTC on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z"). The algorithm to convert a string to a Date object p356 , given a string input, is as follows: If parsing a week p50 from input results in an error, then return an error; otherwise, return a Date object representing midnight UTC on the morning of the Monday of the parsed week p49 . The algorithm to convert a Date object to a string p356 , given a Date object input, is as follows: Return a valid week string p49 that represents the week p49 current at the time represented by input in the UTC time zone.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsDate p384 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods.
365
The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , and selectionEnd p412 IDL attributes; select() p412 and setSelectionRange() p412 methods.
4.10.7.1.11 Time state When an input p353 element's type p355 attribute is in the Time p366 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a specific time p46 . If the element is mutable p357 , the user agent should allow the user to change the time p46 represented by its value p409 , as obtained by parsing a time p46 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid time string p46 . If the user agent provides a user interface for selecting a time p46 , then the value p409 must be set to a valid time string p46 representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present times according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid time string p46 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid time string p46 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid time string p46 . The max p381 attribute, if specified, must have a value that is a valid time string p46 . The step p381 attribute is expressed in seconds. The step scale factor p381 is 1000 (which converts the seconds to milliseconds, as used in the other algorithms). The default step p381 is 60 seconds. When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest time p46 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a time p46 from input results in an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight to the parsed time p46 on a day with no time changes. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid time string p46 that represents the time p46 that is input milliseconds after midnight on a day with no time changes. The algorithm to convert a string to a Date object p356 , given a string input, is as follows: If parsing a time p46 from input results in an error, then return an error; otherwise, return a Date object representing the parsed time p46 in UTC on 1970-01-01. The algorithm to convert a Date object to a string p356 , given a Date object input, is as follows: Return a valid time string p46 that represents the UTC time p46 component that is represented by input.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsDate p384 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , and selectionEnd p412 IDL attributes; select() p412 and setSelectionRange() p412 methods.
4.10.7.1.12 Local Date and Time state When an input p353 element's type p355 attribute is in the Local Date and Time p366 state, the rules in this section apply.
366
The input p353 element represents p708 a control for setting the element's value p409 to a string representing a local date and time p47 , with no time-zone offset information. If the element is mutable p357 , the user agent should allow the user to change the date and time p47 represented by its value p409 , as obtained by parsing a date and time p47 from it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid local date and time string p47 . If the user agent provides a user interface for selecting a local date and time p47 , then the value p409 must be set to a valid local date and time string p47 representing the user's selection. User agents should allow the user to set the value p409 to the empty string. Note: The format shown to the user is independent of the format used for form submission. Browsers are encouraged to use user interfaces that present dates and times according to the conventions of the user's preferred locale. The value p357 attribute, if specified, must have a value that is a valid local date and time string p47 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid local date and time string p47 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid local date and time string p47 . The max p381 attribute, if specified, must have a value that is a valid local date and time string p47 . The step p381 attribute is expressed in seconds. The step scale factor p381 is 1000 (which converts the seconds to milliseconds, as used in the other algorithms). The default step p381 is 60 seconds. When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest local date and time p47 for which the element would not suffer from a step mismatch p413 . The algorithm to convert a string to a number p356 , given a string input, is as follows: If parsing a date and time p47 from input results in an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0") to the parsed local date and time p47 , ignoring leap seconds. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid local date and time string p47 that represents the date and time that is input milliseconds after midnight on the morning of 1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0").
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , selectionEnd p412 , and valueAsDate p384 IDL attributes; select() p412 and setSelectionRange() p412 methods.
The following example shows part of a flight booking application. The application uses an input p353 element with its type p355 attribute set to datetime-local p366 , and it then interprets the given date and time in the time zone of the selected airport. <fieldset> <legend>Destination</legend> <p><label>Airport: <input type=text name=to list=airports></label></p> <p><label>Departure time: <input type=datetime-local name=totime step=3600></label></p> </fieldset> <datalist id=airports> <option value=ATL label="Atlanta"> <option value=MEM label="Memphis"> <option value=LHR label="London Heathrow"> <option value=LAX label="Los Angeles"> <option value=FRA label="Frankfurt"> </datalist> If the application instead used the datetime p362 type, then the user would have to work out the time-zone conversions himself, which is clearly not a good user experience!
367
4.10.7.1.13 Number state When an input p353 element's type p355 attribute is in the Number p368 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a number. If the element is mutable p357 , the user agent should allow the user to change the number represented by its value p409 , as obtained from applying the rules for parsing floating point number values p40 to it. User agents must not allow the user to set the value p409 to a non-empty string that is not a valid floating point number p40 . If the user agent provides a user interface for selecting a number, then the value p409 must be set to the best representation of the number representing the user's selection as a floating point number p40 . User agents should allow the user to set the value p409 to the empty string. The value p357 attribute, if specified, must have a value that is a valid floating point number p40 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid floating point number p40 , then set it to the empty string instead. The min p381 attribute, if specified, must have a value that is a valid floating point number p40 . The max p381 attribute, if specified, must have a value that is a valid floating point number p40 . The step scale factor p381 is 1. The default step p381 is 1 (allowing only integers, unless the min p381 attribute has a non-integer value). When the element is suffering from a step mismatch p413 , the user agent may round the element's value p409 to the nearest number for which the element would not suffer from a step mismatch p413 . If there are two such numbers, user agents are encouraged to pick the one nearest positive infinity. The algorithm to convert a string to a number p356 , given a string input, is as follows: If applying the rules for parsing floating point number values p40 to input results in an error, then return an error; otherwise, return the resulting number. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid floating point number p40 that represents input.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , readonly p378 , required p379 , and step p381 content attributes; list p384 , value p383 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , selectionEnd p412 , and valueAsDate p384 IDL attributes; select() p412 and setSelectionRange() p412 methods.
4.10.7.1.14 Range state When an input p353 element's type p355 attribute is in the Range p368 state, the rules in this section apply. The input p353 element represents p708 a control for setting the element's value p409 to a string representing a number, but with the caveat that the exact value is not important, letting UAs provide a simpler interface than they do for the Number p368 state. Note: In this state, the range and step constraints are enforced even during user input, and there is no way to set the value to the empty string. If the element is mutable p357 , the user agent should allow the user to change the number represented by its value p409 , as obtained from applying the rules for parsing floating point number values p40 to it. User agents must not allow the user to set the value p409 to a string that is not a valid floating point number p40 . If the user agent provides a user interface for selecting a number, then the value p409 must be set to a best representation of the number representing the user's selection as a floating point number p40 . User agents must not allow the user to set the value p409 to the empty string. The value p357 attribute, if specified, must have a value that is a valid floating point number p40 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is not a valid floating point number p40 , then set it to a valid floating point number p40 that represents the default value p369 .
368
The min p381 attribute, if specified, must have a value that is a valid floating point number p40 . The default minimum p381 is 0. The max p381 attribute, if specified, must have a value that is a valid floating point number p40 . The default maximum p381 is 100. The default value is the minimum p381 plus half the difference between the minimum p381 and the maximum p381 , unless the maximum p381 is less than the minimum p381 , in which case the default value p369 is the minimum p381 . When the element is suffering from an underflow p413 , the user agent must set the element's value p409 to a valid floating point number p40 that represents the minimum p381 . When the element is suffering from an overflow p413 , if the maximum p381 is not less than the minimum p381 , the user agent must set the element's value p409 to a valid floating point number p40 that represents the maximum p381 . The step scale factor p381 is 1. The default step p381 is 1 (allowing only integers, unless the min p381 attribute has a non-integer value). When the element is suffering from a step mismatch p413 , the user agent must round the element's value p409 to the nearest number for which the element would not suffer from a step mismatch p413 , and which is greater than or equal to the minimum p381 , and, if the maximum p381 is not less than the minimum p381 , which is less than or equal to the maximum p381 . If two numbers match these constraints, then user agents must use the one nearest to positive infinity. For example, the markup <input type="range" min=0 max=100 step=20 value=50> results in a range control whose initial value is 60. The algorithm to convert a string to a number p356 , given a string input, is as follows: If applying the rules for parsing floating point number values p40 to input results in an error, then return an error; otherwise, return the resulting number. The algorithm to convert a number to a string p356 , given a number input, is as follows: Return a valid floating point number p40 that represents input.
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 , list p377 , max p381 , min p381 , and step p381 content attributes; list p384 , value p383 , valueAsNumber p384 , and selectedOption p385 IDL attributes; stepDown() p384 and stepUp() p384 methods. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , selectionEnd p412 , and valueAsDate p384 IDL attributes; select() p412 and setSelectionRange() p412 methods.
Here is an example of a range control using an autocomplete list with the list p377 attribute. This could be useful if there are values along the full range of the control that are especially important, such as preconfigured light levels or typical speed limits in a range control used as a speed control. The following markup fragment: <input type="range" min="-100" max="100" value="0" step="10" name="power" list="powers"> <datalist id="powers"> <option value="0"> <option value="-30"> <option value="30"> <option value="+50"> </datalist> ...with the following style sheet applied: input { height: 75px; width: 49px; background: #D5CCBB; color: black; } ...might render as:
Note how the UA determined the orientation of the control from the ratio of the style-sheet-specified height and width properties. The colors were similiarly derived from the style sheet. The tick marks, however, were
369
derived from the markup. In particular, the step p381 attribute has not affected the placement of tick marks, the UA deciding to only use the author-specified completion values and then adding longer tick marks at the extremes. Note also how the invalid value +50 was completely ignored. For another example, consider the following markup fragment: <input name=x type=range min=100 max=700 step=9.09090909 value=509.090909> A user agent could display in a variety of ways, for instance:
The user agent could pick which one to display based on the dimensions given in the style sheet. This would allow it to maintain the same resolution for the tick marks, despite the differences in width.
4.10.7.1.15 Color state When an input p353 element's type p355 attribute is in the Color p370 state, the rules in this section apply. The input p353 element represents p708 a color well control, for setting the element's value p409 to a string representing a simple color p51 . Note: In this state, there is always a color picked, and there is no way to set the value to the empty string. If the element is mutable p357 , the user agent should allow the user to change the color represented by its value p409 , as obtained from applying the rules for parsing simple color values p51 to it. User agents must not allow the user to set the value p409 to a string that is not a valid lowercase simple color p51 . If the user agent provides a user interface for selecting a color, then the value p409 must be set to the result of using the rules for serializing simple color values p52 to the user's selection. User agents must not allow the user to set the value p409 to the empty string. The value p357 attribute, if specified, must have a value that is a valid simple color p51 . The value sanitization algorithm p356 is as follows: If the value p409 of the element is a valid simple color p51 , then set it to the value p409 of the element converted to ASCII lowercase p36 ; otherwise, set it to the string "#000000".
Bookkeeping details The following common input p353 element content attributes, IDL attributes, and methods apply to the element: autocomplete p376 and list p377 content attributes; list p384 , value p383 , and selectedOption p385 IDL attributes. The value p383 IDL attribute is in mode value p383 . The input p385 and change p385 events apply. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , maxlength p380 , max p381 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods.
4.10.7.1.16 Checkbox state When an input p353 element's type p355 attribute is in the Checkbox p370 state, the rules in this section apply. The input p353 element represents p708 a two-state control that represents the element's checkedness p409 state. If the element's checkedness p409 state is true, the control represents a positive selection, and if it is false, a negative selection. If the element's indeterminate p357 IDL attribute is set to true, then the control's selection should be obscured as if the control was in a third, indeterminate, state.
370
Note: The control is never a true tri-state control, even if the element's indeterminate p357 IDL attribute is set to true. The indeterminate p357 IDL attribute only gives the appearance of a third state. If the element is mutable p357 , then: The pre-click activation steps p102 consist of setting the element's checkedness p409 to its opposite value (i.e. true if it is false, false if it is true), and of setting the element's indeterminate p357 IDL attribute to false. The canceled activation steps p102 consist of setting the checkedness p409 and the element's indeterminate p357 IDL attribute back to the values they had before the pre-click activation steps p102 were run. The activation behavior p102 is to fire a simple event p559 that bubbles named change at the element, then broadcast formchange events p423 from the element's form owner p407 , if any. Constraint validation: If the element is required p379 and its checkedness p409 is false, then the element is suffering from being missing p413 . This box is non-normative. Implementation requirements are given below this box. input . indeterminate
p357
[ = value ]
When set, overrides the rendering of checkbox p370 controls so that the current value is not visible.
Bookkeeping details The following common input p353 element content attributes and IDL attributes apply to the element: checked p357 , and required p379 content attributes; checked p384 and value p383 IDL attributes. The value p383 IDL attribute is in mode default/on p383 . The change p385 event applies. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 event does not apply.
4.10.7.1.17 Radio Button state When an input p353 element's type p355 attribute is in the Radio Button p371 state, the rules in this section apply. The input p353 element represents p708 a control that, when used in conjunction with other input p353 elements, forms a radio button group p371 in which only one control can have its checkedness p409 state set to true. If the element's checkedness p409 state is true, the control represents the selected control in the group, and if it is false, it indicates a control in the group that is not selected. The radio button group that contains an input p353 element a also contains all the other input p353 elements b that fulfill all of the following conditions: The input p353 element b's type p355 attribute is in the Radio Button p371 state. Either a and b have the same form owner p407 , or they both have no form owner p407 . They both have a name p408 attribute, and the value of a's name p408 attribute is a compatibility caseless p36 match for the value of b's name p408 attribute.
A document must not contain an input p353 element whose radio button group p371 contains only that element. When any of the following phenomena occur, if the element's checkedness p409 state is true after the occurrence, the checkedness p409 state of all the other elements in the same radio button group p371 must be set to false: The element's checkedness p409 state is set to true (for whatever reason). The element's name p408 attribute is added, removed, or changes value. The element's form owner p407 changes.
If the element is mutable p357 , then: The pre-click activation steps p102 consist of setting the element's checkedness p409 to true. The canceled activation steps p102 consist of setting the element's checkedness p409 to false. The activation behavior p102 is to fire a simple event p559 that bubbles named change at the element, then broadcast formchange events p423 from the element's form owner p407 , if any. Constraint validation: If the element is required p379 and all of the input p353 elements in the radio button group p371 have a checkedness p409 that is false, then the element is suffering from being missing p413 .
371
Note: If none of the radio buttons in a radio button group p371 are checked when they are inserted into the document, then they will all be initially unchecked in the interface, until such time as one of them is checked (either by the user or by script).
Bookkeeping details The following common input p353 element content attributes and IDL attributes apply to the element: checked p357 and required p379 content attributes; checked p384 and value p383 IDL attributes. The value p383 IDL attribute is in mode default/on p383 . The change p385 event applies. The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 event does not apply.
4.10.7.1.18 File Upload state When an input p353 element's type p355 attribute is in the File Upload p372 state, the rules in this section apply. The input p353 element represents p708 a list of selected files, each file consisting of a file name, a file type, and a file body (the contents of the file). File names may contain partial paths, e.g. in the case that a user has selected an entire directory hierarchy. Path components should be separated from each other using U+005C REVERSE SOLIDUS character (\). If the element is mutable p357 , the user agent should allow the user to change the files on the list, e.g. adding or removing files. Files can be from the filesystem or created on the fly, e.g. a picture taken from a camera connected to the user's device. Constraint validation: If the element is required p379 and the list of selected files p372 is empty, then the element is suffering from being missing p413 . Unless the multiple p379 attribute is set, there must be no more than one file in the list of selected files p372 . The accept attribute may be specified to provide user agents with a hint of what file types will be accepted. If specified, the attribute must consist of a set of comma-separated tokens p54 , each of which must be an ASCII case-insensitive p36 match for one of the following: The string audio/* Indicates that sound files are accepted. The string video/* Indicates that video files are accepted. The string image/* Indicates that image files are accepted. A valid MIME type with no parameters p28 Indicates that files of the specified type are accepted. The tokens must not be ASCII case-insensitive p36 matches for any of the other tokens (i.e. duplicates are not allowed). To obtain the list of tokens from the attribute, the user agent must split the attribute value on commas p54 . User agents should prevent the user from selecting files that are not accepted by one (or more) of these tokens. For historical reasons, the value p383 IDL attribute prefixes the filename with the string "C:\fakepath\". Some legacy user agents actually included the full path (which was a security vulnerability). As a result of this, obtaining the filename from the value p383 IDL attribute in a backwards-compatible way is non-trivial. The following function extracts the filename in a suitably compatible manner: function extractFilename(path) { var x; x = path.lastIndexOf('\\'); if (x >= 0) // Windows-based path return path.substr(x+1); x = path.lastIndexOf('/'); if (x >= 0) // Unix-based path return path.substr(x+1);
372
return path; // just the filename } This can be used as follows: <p><input type=file name=image onchange="updateFilename(this.value)"></p> <p>The name of the file you picked is: <span id="filename">(none)</span></p> <script> function updateFilename(path) { var name = extractFilename(path); document.getElementById('filename').textContent = name; } </script>
Bookkeeping details The following common input p353 element content attributes apply to the element: The following common input p353 element content attributes and IDL attributes apply to the element: accept p372 , multiple p379 , and required p379 ; files p384 and value p383 IDL attributes. The value p383 IDL attribute is in mode filename p383 . The change p385 event applies. The following content attributes must not be specified and do not apply to the element: alt p374 , autocomplete p376 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , pattern p380 , placeholder p382 , readonly p378 , size p379 , src p374 , step p381 , and width p320 . The element's value p357 attribute must be omitted. The following IDL attributes and methods do not apply to the element: checked p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 event does not apply.
4.10.7.1.19 Submit Button state When an input p353 element's type p355 attribute is in the Submit Button p373 state, the rules in this section apply. The input p353 element represents p708 a button that, when activated, submits the form. If the element has a value p357 attribute, the button's label must be the value of that attribute; otherwise, it must be an implementation-defined string that means "Submit" or some such. The element is a button p347 , specifically a submit button p347 . If the element is mutable p357 , the user agent should allow the user to activate the element. The element's activation behavior p102 , if the element has a form owner p407 , is to submit p417 the form owner p407 from the input p353 element; otherwise, it is to do nothing. The formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 attributes are attributes for form submission p410 . Note: The formnovalidate p411 attribute can be used to make submit buttons that do not trigger the constraint validation.
Bookkeeping details The following common input p353 element content attributes and IDL attributes apply to the element: formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 content attributes; value p383 IDL attribute. The value p383 IDL attribute is in mode default p383 . The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , checked p357 , dirname p376 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 and change p385 events do not apply.
4.10.7.1.20 Image Button state When an input p353 element's type p355 attribute is in the Image Button p373 state, the rules in this section apply. The input p353 element represents p708 either an image from which a user can select a coordinate and submit the form, or alternatively a button from which the user can submit the form. The element is a button p347 , specifically a submit button p347 .
373
The image is given by the src attribute. The src p374 attribute must be present, and must contain a valid nonempty URL potentially surrounded by spaces p55 referencing a non-interactive, optionally animated, image resource that is neither paged nor scripted. When any of the following events occur, unless the user agent cannot support images, or its support for images has been disabled, or the user agent only fetches elements on demand, or the src p374 attribute's value is the empty string, the user agent must resolve p55 the value of the src p374 attribute, relative to the element, and if that is successful, must fetch p59 the resulting absolute URL p56 : The input p353 element's type p355 attribute is first set to the Image Button p373 state (possibly when the element is first created), and the src p374 attribute is present. The input p353 element's type p355 attribute is changed back to the Image Button p373 state, and the src p374 attribute is present, and its value has changed since the last time the type p355 attribute was in the Image Button p373 state. The input p353 element's type p355 attribute is in the Image Button p373 state, and the src p374 attribute is set or changed.
Fetching the image must delay the load event p687 of the element's document until the task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 (defined below) has been run. If the image was successfully obtained, with no network errors, and the image's type is a supported image type, and the image is a valid image of that type, then the image is said to be available. If this is true before the image is completely downloaded, each task p553 that is queued p553 by the networking task source p554 while the image is being fetched p59 must update the presentation of the image appropriately. The user agents should apply the image sniffing rules p61 to determine the type of the image, with the image's associated Content-Type headers p61 giving the official type. If these rules are not applied, then the type of the image must be the type given by the image's associated Content-Type headers p61 . User agents must not support non-image resources with the input p353 element. User agents must not run executable code embedded in the image resource. User agents must only display the first page of a multipage resource. User agents must not allow the resource to act in an interactive fashion, but should honor any animation in the resource. The task p553 that is queued p553 by the networking task source p554 once the resource has been fetched p59 , must, if the download was successful and the image is available p374 , queue a task p553 to fire a simple event p559 named load at the input p353 element; and otherwise, if the fetching process fails without a response from the remote server, or completes but the image is not a valid or supported image, queue a task p553 to fire a simple event p559 named error on the input p353 element. The alt attribute provides the textual label for the alternative button for users and user agents who cannot use the image. The alt p374 attribute must also be present, and must contain a non-empty string. The input p353 element supports dimension attributes p320 . If the src p374 attribute is set, and the image is available p374 and the user agent is configured to display that image, then: The element represents p708 a control for selecting a coordinate p374 from the image specified by the src p374 attribute; if the element is mutable p357 , the user agent should allow the user to select this coordinate p374 . The activation behavior p102 in this case consists of taking the user's selected coordinate p374 , and then, if the element has a form owner p407 , submitting p417 the input p353 element's form owner p407 from the input p353 element. If the user activates the control without explicitly selecting a coordinate, then the coordinate (0,0) must be assumed. Otherwise, the element represents p708 a submit button whose label is given by the value of the alt p374 attribute; if the element is mutable p357 , the user agent should allow the user to activate the button. The activation behavior p102 in this case consists of setting the selected coordinate p374 to (0,0), and then, if the element has a form owner p407 , submitting p417 the input p353 element's form owner p407 from the input p353 element. The selected coordinate must consist of an x-component and a y-component. The coordinates represent the position relative to the edge of the image, with the coordinate space having the positive x direction to the right, and the positive y direction downwards. The x-component must be a valid integer p39 representing a number x in the range (borderleft+paddingleft) x width+borderright+paddingright, where width is the rendered width of the image, borderleft is the width of the border on the left of the image, paddingleft is the width of the padding on the left of the image, borderright is the width of the border on the right of the image, and paddingright is the width of the padding on the right of the image, with all dimensions given in CSS pixels. The y-component must be a valid integer p39 representing a number y in the range (bordertop+paddingtop) y height+borderbottom+paddingbottom, where height is the rendered height of the image, bordertop is the width of
374
the border above the image, paddingtop is the width of the padding above the image, borderbottom is the width of the border below the image, and paddingbottom is the width of the padding below the image, with all dimensions given in CSS pixels. Where a border or padding is missing, its width is zero CSS pixels. The formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 attributes are attributes for form submission p410 .
Bookkeeping details The following common input p353 element content attributes and IDL attributes apply to the element: alt p374 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , src p374 , and width p320 content attributes; value p383 IDL attribute. The value p383 IDL attribute is in mode default p383 . The following content attributes must not be specified and do not apply to the element: accept p372 , autocomplete p376 , checked p357 , dirname p376 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , and step p381 . The element's value p357 attribute must be omitted. The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 and change p385 events do not apply.
Note: Many aspects of this state's behavior are similar to the behavior of the img p199 element. Readers are encouraged to read that section, where many of the same requirements are described in more detail.
4.10.7.1.21 Reset Button state When an input p353 element's type p355 attribute is in the Reset Button p375 state, the rules in this section apply. The input p353 element represents p708 a button that, when activated, resets the form. If the element has a value p357 attribute, the button's label must be the value of that attribute; otherwise, it must be an implementation-defined string that means "Reset" or some such. The element is a button p347 . If the element is mutable p357 , the user agent should allow the user to activate the element. The element's activation behavior p102 , if the element has a form owner p407 , is to reset p422 the form owner p407 ; otherwise, it is to do nothing. Constraint validation: The element is barred from constraint validation p412 .
Bookkeeping details The value p383 IDL attribute applies to this element and is in mode default p383 . The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 and change p385 events do not apply.
4.10.7.1.22 Button state When an input p353 element's type p355 attribute is in the Button p375 state, the rules in this section apply. The input p353 element represents p708 a button with no default behavior. A label for the button must be provided in the value p357 attribute. If the element has a value p357 attribute, the button's label must be the value of that attribute; otherwise, it must be the empty string. The element is a button p347 . If the element is mutable p357 , the user agent should allow the user to activate the element. The element's activation behavior p102 is to do nothing. Constraint validation: The element is barred from constraint validation p412 .
Bookkeeping details The value p383 IDL attribute applies to this element and is in mode default p383 .
375
The following content attributes must not be specified and do not apply to the element: accept p372 , alt p374 , autocomplete p376 , checked p357 , dirname p376 , formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , formtarget p411 , height p320 , list p377 , max p381 , maxlength p380 , min p381 , multiple p379 , pattern p380 , placeholder p382 , readonly p378 , required p379 , size p379 , src p374 , step p381 , and width p320 . The following IDL attributes and methods do not apply to the element: checked p384 , files p384 , list p384 , selectedOption p385 , selectionStart p412 , selectionEnd p412 , valueAsDate p384 , and valueAsNumber p384 IDL attributes; select() p412 , setSelectionRange() p412 , stepDown() p384 , and stepUp() p384 methods. The input p385 and change p385 events do not apply.
4.10.7.2 Common input p353 element attributes These attributes only apply to an input p353 element if its type p355 attribute is in a state whose definition declares that the attribute applies. When an attribute doesn't apply to an input p353 element, user agents must ignore p29 the attribute, regardless of the requirements and definitions below. 4.10.7.2.1 The autocomplete p376 attribute User agents sometimes have features for helping users fill forms in, for example prefilling the user's address based on earlier user input. The autocomplete attribute is an enumerated attribute p38 . The attribute has three states. The on keyword maps to the on state, and the off keyword maps to the off state. The attribute may also be omitted. The missing value default is the default state. The off p376 state indicates either that the control's input data is particularly sensitive (for example the activation code for a nuclear weapon); or that it is a value that will never be reused (for example a one-time-key for a bank login) and the user will therefore have to explicitly enter the data each time, instead of being able to rely on the UA to prefill the value for him; or that the document provides its own autocomplete mechanism and does not want the user agent to provide autocompletion values. Conversely, the on p376 state indicates that the value is not particularly sensitive and the user can expect to be able to rely on his user agent to remember values he has entered for that control. The default p376 state indicates that the user agent is to use the autocomplete p348 attribute on the element's form owner p407 instead. (By default, the autocomplete p348 attribute of form p347 elements is in the on p348 state.) Each input p353 element has a resulting autocompletion state, which is either on or off. When an input p353 element is in one of the following conditions, the input p353 element's resulting autocompletion state p376 is on; otherwise, the input p353 element's resulting autocompletion state p376 is off: Its autocomplete p376 attribute is in the on p376 state. Its autocomplete p376 attribute is in the default p376 state, and the element has no form owner p407 . Its autocomplete p376 attribute is in the default p376 state, and the element's form owner p407 's autocomplete p348 attribute is in the on p348 state.
When an input p353 element's resulting autocompletion state p376 is on, the user agent may store the value entered by the user so that if the user returns to the page, the UA can prefill the form. Otherwise, the user agent should not remember the control's value p409 , and should not offer past values to the user. In addition, if the resulting autocompletion state p376 is off, values are reset p528 when traversing the history p527 . The autocompletion mechanism must be implemented by the user agent acting as if the user had modified the element's value p409 , and must be done at a time where the element is mutable p357 (e.g. just after the element has been inserted into the document, or when the user agent stops parsing p687 ). Banks frequently do not want UAs to prefill login information: <p><label>Account: <input type="text" name="ac" autocomplete="off"></label></p> <p><label>PIN: <input type="password" name="pin" autocomplete="off"></label></p> A user agent may allow the user to override the resulting autocompletion state p376 and set it to always on, always allowing values to be remembered and prefilled), or always off, never remembering values. However, the ability to override the resulting autocompletion state p376 to on should not be trivially accessible, as there are significant security implications for the user if all values are always remembered, regardless of the site's preferences.
4.10.7.2.2 The dirname p376 attribute The dirname attribute, when it applies, is a form control dirname attribute p411 . In this example, a form contains a text field and a submission button: <form action="addcomment.cgi" method=post> <p><label>Comment: <input type=text name="comment" dirname="comment.dir" required></label></p>
376
<p><button name="mode" type=submit value="add">Post Comment</button></p> </form> When the user submits the form, the user agent includes three fields, one called "comment", one called "comment.dir", and one called "mode"; so if the user types "Hello", the submission body might be something like: comment=Hello&comment.dir=ltr&mode=add If the user manually switches to a right-to-left writing direction and enters " ,"the submission body might be something like: comment=%D9%85%D8%B1%D8%AD%D8%A8%D9%8B%D8%A7&comment.dir=rtl&mode=add
4.10.7.2.3 The list p377 attribute The list attribute is used to identify an element that lists predefined options suggested to the user. If present, its value must be the ID p92 of a datalist p391 element in the same document. The suggestions source element is the first element in the document in tree order p29 to have an ID p92 equal to the value of the list p377 attribute, if that element is a datalist p391 element. If there is no list p377 attribute, or if there is no element with that ID p92 , or if the first element with that ID p92 is not a datalist p391 element, then there is no suggestions source element p377 . If there is a suggestions source element p377 , then, when the user agent is allowing the user to edit the input p353 element's value p409 , the user agent should offer the suggestions represented by the suggestions source element p377 to the user in a manner suitable for the type of control used. The user agent may use the suggestion's label p393 to identify the suggestion if appropriate. How user selections of suggestions are handled depends on whether the element is a control accepting a single value only, or whether it accepts multiple values:
p379 attribute specified or if the multiple p379 attribute does If the element does not have a multiple not apply
When the user selects a suggestion, the input p353 element's value p409 must be set to the selected suggestion's value p393 , as if the user had written that value himself.
p379 attribute specified, and the multiple p379 attribute does If the element does have a multiple apply
When the user selects a suggestion, the user agent must either add a new entry to the input p353 element's values p409 , whose value is the selected suggestion's value p393 , or change an existing entry in the input p353 element's values p409 to have the value given by the selected suggestion's value p393 , as if the user had himself added an entry with that value, or edited an existing entry to be that value. Which behavior is to be applied depends on the user interface in a user-agent-defined manner. If the list p377 attribute does not apply, there is no suggestions source element p377 . This URL field offers some suggestions. <label>Homepage: <input name=hp type=url list=hpurls></label> <datalist id=hpurls> <option value="http://www.google.com/" label="Google"> <option value="http://www.reddit.com/" label="Reddit"> </datalist> Other URLs from the user's history might show also; this is up to the user agent. This example demonstrates how to design a form that uses the autocompletion list feature while still degrading usefully in legacy user agents. If the autocompletion list is merely an aid, and is not important to the content, then simply using a datalist p391 element with children option p393 elements is enough. To prevent the values from being rendered in legacy user agents, they should be placed inside the value p393 attribute instead of inline. <p> <label> Enter a breed: <input type="text" name="breed" list="breeds"> <datalist id="breeds"> <option value="Abyssinian"> <option value="Alpaca"> <!-- ... -->
377
</datalist> </label> </p> However, if the values need to be shown in legacy UAs, then fallback content can be placed inside the datalist p391 element, as follows: <p> <label> Enter a breed: <input type="text" name="breed" list="breeds"> </label> <datalist id="breeds"> <label> or select one from the list: <select name="breed"> <option value=""> (none selected) <option>Abyssinian <option>Alpaca <!-- ... --> </select> </label> </datalist> </p> The fallback content will only be shown in UAs that don't support datalist p391 . The options, on the other hand, will be detected by all UAs, even though they are not direct children of the datalist p391 element. Note that if an option p393 element used in a datalist p391 is selected p393 , it will be selected by default by legacy UAs (because it affects the select p387 ), but it will not have any effect on the input p353 element in UAs that support datalist p391 .
4.10.7.2.4 The readonly p378 attribute The readonly attribute is a boolean attribute p38 that controls whether or not the user can edit the form control. When specified, the element is immutable p357 . Constraint validation: If the readonly p378 attribute is specified on an input p353 element, the element is barred from constraint validation p412 . In the following example, the existing product identifiers cannot be modified, but they are still displayed as part of the form, for consistency with the row representing a new product (where the identifier is not yet filled in). <form action="products.cgi" method=post enctype="multipart/form-data"> <table> <tr> <th> Product ID <th> Product name <th> Price <th> Action <tr> <td> <input readonly name="1.pid" value="H412"> <td> <input required name="1.pname" value="Floor lamp Ulke"> <td> $<input required type=number min=0 step=0.01 name="1.pprice" value="49.99"> <td> <button formnovalidate name="action" value="delete:1">Delete</button> <tr> <td> <input readonly name="2.pid" value="FG28"> <td> <input required name="2.pname" value="Table lamp Ulke"> <td> $<input required type=number min=0 step=0.01 name="2.pprice" value="24.99"> <td> <button formnovalidate name="action" value="delete:2">Delete</button> <tr> <td> <input required name="3.pid" value="" pattern="[A-Z0-9]+"> <td> <input required name="3.pname" value=""> <td> $<input required type=number min=0 step=0.01 name="3.pprice" value=""> <td> <button formnovalidate name="action" value="delete:3">Delete</button> </table> <p> <button formnovalidate name="action" value="add">Add</button> </p> <p> <button name="action" value="update">Save</button> </p> </form>
378
4.10.7.2.5 The size p379 attribute The size attribute gives the number of characters that, in a visual rendering, the user agent is to allow the user to see while editing the element's value p409 . The size p379 attribute, if specified, must have a value that is a valid non-negative integer p39 greater than zero. If the attribute is present, then its value must be parsed using the rules for parsing non-negative integers p39 , and if the result is a number greater than zero, then the user agent should ensure that at least that many characters are visible. The size p358 IDL attribute is limited to only non-negative numbers greater than zero p63 and has a default value of 20.
4.10.7.2.6 The required p379 attribute The required attribute is a boolean attribute p38 . When specified, the element is required. Constraint validation: If the element is required p379 , and its value p383 IDL attribute applies and is in the mode value p383 , and the element is mutable p357 , and the element's value p409 is the empty string, then the element is suffering from being missing p413 . The following form has two required fields, one for an e-mail address and one for a password. It also has a third field that is only considerd valid if the user types the same password in the password field and this third field. <h1>Create new account</h1> <form action="/newaccount" method=post> <p> <label for="username">E-mail address:</label> <input id="username" type=email required name=un> <p> <label for="password1">Password:</label> <input id="password1" type=password required name=up> <p> <label for="password2">Confirm password:</label> <input id="password2" type=password onforminput="setCustomValidity(value != password1.value ? 'Passwords do not match.' : '')"> <p> <input type=submit value="Create account"> </form>
4.10.7.2.7 The multiple p379 attribute The multiple attribute is a boolean attribute p38 that indicates whether the user is to be allowed to specify more than one value. The following extract shows how an e-mail client's "Cc" field could accept multiple e-mail addresses. <label>Cc: <input type=email multiple name=cc></label> If the user had, amongst many friends in his user contacts database, two friends "Arthur Dent" (with address "[email protected]") and "Adam Josh" (with address "[email protected]"), then, after the user has typed "a", the user agent might suggest these two e-mail addresses to the user.
The page could also link in the user's contacts database from the site: <label>Cc: <input type=email multiple name=cc list=contacts></label> ... <datalist id="contacts"> <option value="[email protected]"> <option value="[email protected]">
379
<option value="[email protected]"> <option value="[email protected]"> </datalist> Suppose the user had entered "[email protected]" into this text field, and then started typing a second email address starting with "a". The user agent might show both the two friends mentioned earlier, as well as the "astrophy" and "astronomy" values given in the datalist p391 element.
The following extract shows how an e-mail client's "Attachments" field could accept multiple files for upload. <label>Attachments: <input type=file multiple name=att></label>
4.10.7.2.8 The maxlength p380 attribute The maxlength attribute, when it applies, is a form control maxlength attribute p410 controlled by the input p353 element's dirty value flag p357 . If the input p353 element has a maximum allowed value length p410 , then the code-point length p38 of the value of the element's value p357 attribute must be equal to or less than the element's maximum allowed value length p410 . The following extract shows how a messaging client's text entry could be arbitrarily restricted to a fixed number of characters, thus forcing any conversation through this medium to be terse and discouraging intelligent discourse. What are you doing? <input name=status maxlength=140>
4.10.7.2.9 The pattern p380 attribute The pattern attribute specifies a regular expression against which the control's value p409 , or, when the multiple p379 attribute applies and is set, the control's values p409 , are to be checked. If specified, the attribute's value must match the JavaScript Pattern production. [ECMA262] p782 If an input p353 element has a pattern p380 attribute specified, and the attribute's value, when compiled as a JavaScript regular expression with the global, ignoreCase, and multiline flags disabled (see ECMA262 Edition 5, sections 15.10.7.2 through 15.10.7.4), compiles successfully, then the resulting regular expression is the element's compiled pattern regular expression. If the element has no such attribute, or if the value doesn't compile successfully, then the element has no compiled pattern regular expression p380 . [ECMA262] p782 Constraint validation: If the element's value p409 is not the empty string, and either the element's multiple p379 attribute is not specified or it does not apply to the input p353 element given its type p355 attribute's current state, and the element has a compiled pattern regular expression p380 but that regular expression does not match the entirety of the element's value p409 , then the element is suffering from a pattern mismatch p413 . Constraint validation: If the element's value p409 is not the empty string, and the element's multiple p379 attribute is specified and applies to the input p353 element, and the element has a compiled pattern regular expression p380 but that regular expression does not match the entirety of each of the element's values p409 , then the element is suffering from a pattern mismatch p413 . Note: This implies that the regular expression language used for this attribute is the same as that used in JavaScript, except that the pattern p380 attribute must match the entire value, not just any subset (somewhat as if it implied a ^(?: at the start of the pattern and a )$ at the end). When an input p353 element has a pattern p380 attribute specified, authors should include a title p92 attribute to give a description of the pattern. User agents may use the contents of this attribute, if it is present, when informing the user that the pattern is not matched, or at any other suitable time, such as in a tooltip or read out by assistive technology when the control gains focus.
380
For example, the following snippet: <label> Part number: <input pattern="[0-9][A-Z]{3}" name="part" title="A part number is a digit followed by three uppercase letters."/> </label> ...could cause the UA to display an alert such as: A part number is a digit followed by three uppercase letters. You cannot submit this form when the field is incorrect. When a control has a pattern p380 attribute, the title p92 attribute, if used, must describe the pattern. Additional information could also be included, so long as it assists the user in filling in the control. Otherwise, assistive technology would be impaired. For instance, if the title attribute contained the caption of the control, assistive technology could end up saying something like The text you have entered does not match the required pattern. Birthday, which is not useful. UAs may still show the title p117 in non-error situations (for example, as a tooltip when hovering over the control), so authors should be careful not to word title p117 s as if an error has necessarily occurred.
4.10.7.2.10 The min p381 and max p381 attributes The min and max attributes indicate the allowed range of values for the element. Their syntax is defined by the section that defines the type p355 attribute's current state. If the element has a min p381 attribute, and the result of applying the algorithm to convert a string to a number p356 to the value of the min p381 attribute is a number, then that number is the element's minimum; otherwise, if the type p355 attribute's current state defines a default minimum, then that is the minimum p381 ; otherwise, the element has no minimum p381 . Constraint validation: When the element has a minimum p381 , and the result of applying the algorithm to convert a string to a number p356 to the string given by the element's value p409 is a number, and the number obtained from that algorithm is less than the minimum p381 , the element is suffering from an underflow p413 . The min p381 attribute also defines the step base p382 . If the element has a max p381 attribute, and the result of applying the algorithm to convert a string to a number p356 to the value of the max p381 attribute is a number, then that number is the element's maximum; otherwise, if the type p355 attribute's current state defines a default maximum, then that is the maximum p381 ; otherwise, the element has no maximum p381 . Constraint validation: When the element has a maximum p381 , and the result of applying the algorithm to convert a string to a number p356 to the string given by the element's value p409 is a number, and the number obtained from that algorithm is more than the maximum p381 , the element is suffering from an overflow p413 . The max p381 attribute's value (the maximum p381 ) must not be less than the min p381 attribute's value (its minimum p381 ). Note: If an element has a maximum p381 that is less than its minimum p381 , then so long as the element has a value p409 , it will either be suffering from an underflow p413 or suffering from an overflow p413 . The following date control limits input to dates that are before the 1980s: <input name=bday type=date max="1979-12-31"> The following number control limits input to whole numbers greater than zero: <input name=quantity required type=number min=1 value=1>
4.10.7.2.11 The step p381 attribute The step attribute indicates the granularity that is expected (and required) of the value p409 , by limiting the allowed values. The section that defines the type p355 attribute's current state also defines the default step, the step scale factor, and in some cases the default step base, which are used in processing the attribute as described below.
381
The step p381 attribute, if specified, must either have a value that is a valid floating point number p40 that parses p40 to a number that is greater than zero, or must have a value that is an ASCII case-insensitive p36 match for the string "any". The attribute provides the allowed value step for the element, as follows: 1. If the attribute is absent, then the allowed value step p382 is the default step p381 multiplied by the step scale factor p381 . Otherwise, if the attribute's value is an ASCII case-insensitive p36 match for the string "any", then there is no allowed value step p382 . Otherwise, if the rules for parsing floating point number values p40 , when they are applied to the attribute's value, return an error, zero, or a number less than zero, then the allowed value step p382 is the default step p381 multiplied by the step scale factor p381 . Otherwise, the allowed value step p382 is the number returned by the rules for parsing floating point number values p40 when they are applied to the attribute's value, multiplied by the step scale factor p381 .
2.
3.
4.
The step base is the result of applying the algorithm to convert a string to a number p356 to the value of the min p381 attribute, unless the element does not have a min p381 attribute specified or the result of applying that algorithm is an error, in which case the step base p382 is the default step base p381 , if one is defined, or zero, if not. Constraint validation: When the element has an allowed value step p382 , and the result of applying the algorithm to convert a string to a number p356 to the string given by the element's value p409 is a number, and that number subtracted from the step base p382 is not an integral multiple of the allowed value step p382 , the element is suffering from a step mismatch p413 . The following range control only accepts values in the range 0..1, and allows 256 steps in that range: <input name=opacity type=range min=0 max=1 step=0.00392156863> The following control allows any time in the day to be selected, with any accuracy (e.g. thousandth-of-asecond accuracy or more): <input name=favtime type=time step=any> Normally, time controls are limited to an accuracy of one minute.
4.10.7.2.12 The placeholder p382 attribute The placeholder attribute represents a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format. The attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. Note: For a longer hint or other advisory text, the title p92 attribute is more appropriate. The placeholder p382 attribute should not be used as an alternative to a label p352 . User agents should present this hint to the user, after having stripped line breaks p38 from it, when the element's value p409 is the empty string and the control is not focused (e.g. by displaying it inside a blank unfocused control). Here is an example of a mail configuration user interface that uses the placeholder p382 attribute: <fieldset> <legend>Mail Account</legend> <p><label>Name: <input type="text" name="fullname" placeholder="John Ratzenberger"></label></p> <p><label>Address: <input type="email" name="address" placeholder="[email protected]"></label></p> <p><label>Password: <input type="password" name="password"></label></p> <p><label>Description: <input type="text" name="desc" placeholder="My Email Account"></label></p> </fieldset>
4.10.7.3 Common input p353 element APIs This box is non-normative. Implementation requirements are given below this box.
382
input . value p383 [ = value ] Returns the current value p409 of the form control. Can be set, to change the value. Throws an INVALID_STATE_ERR p75 exception if it is set to any value other than the empty string when the control is a file upload control. input . checked p384 [ = value ] Returns the current checkedness p409 of the form control. Can be set, to change the checkedness p409 . input . files p384 Returns a FileList object listing the selected files p372 of the form control. Returns null if the control isn't a file control. input . valueAsDate p384 [ = value ] Returns a Date object representing the form control's value p409 , if applicable; otherwise, returns null. Can be set, to change the value. Throws an INVALID_STATE_ERR p75 exception if the control isn't date- or time-based. input . valueAsNumber p384 [ = value ] Returns a number representing the form control's value p409 , if applicable; otherwise, returns null. Can be set, to change the value. Throws an INVALID_STATE_ERR p75 exception if the control is neither date- or time-based nor numeric. input . stepUp p384 ( [ n ] ) input . stepDown p384 ( [ n ] ) Changes the form control's value p409 by the value given in the step p381 attribute, multiplied by n. The default value for n is 1. Throws INVALID_STATE_ERR p75 exception if the control is neither date- or time-based nor numeric, if the step p381 attribute's value is "any", if the current value p409 could not be parsed, or if stepping in the given direction by the given amount would take the value out of range. input . list p384 Returns the datalist p391 element indicated by the list p377 attribute. input . selectedOption p385 Returns the option p393 element from the datalist p391 element indicated by the list p377 attribute that matches the form control's value p409 .
The value IDL attribute allows scripts to manipulate the value p409 of an input p353 element. The attribute is in one of the following modes, which define its behavior: value On getting, it must return the current value p409 of the element. On setting, it must set the element's value p409 to the new value, set the element's dirty value flag p357 to true, and then invoke the value sanitization algorithm p356 , if the element's type p355 attribute's current state defines one. default On getting, if the element has a value p357 attribute, it must return that attribute's value; otherwise, it must return the empty string. On setting, it must set the element's value p357 attribute to the new value. default/on On getting, if the element has a value p357 attribute, it must return that attribute's value; otherwise, it must return the string "on". On setting, it must set the element's value p357 attribute to the new value. filename On getting, it must return the string "C:\fakepath\" followed by the filename of the first file in the list of selected files p372 , if any, or the empty string if the list is empty. On setting, if the new value is the empty string, it must empty the list of selected files p372 ; otherwise, it must throw an INVALID_STATE_ERR p75 exception.
383
The checked IDL attribute allows scripts to manipulate the checkedness p409 of an input p353 element. On getting, it must return the current checkedness p409 of the element; and on setting, it must set the element's checkedness p409 to the new value and set the element's dirty checkedness flag p357 to true. The files IDL attribute allows scripts to access the element's selected files p372 . On getting, if the IDL attribute applies, it must return a FileList object that represents the current selected files p372 . The same object must be returned until the list of selected files p372 changes. If the IDL attribute does not apply, then it must instead return null. [FILEAPI] p782 The valueAsDate IDL attribute represents the value p409 of the element, interpreted as a date. On getting, if the valueAsDate p384 attribute does not apply, as defined for the input p353 element's type p355 attribute's current state, then return null. Otherwise, run the algorithm to convert a string to a Date object p356 defined for that state; if the algorithm returned a Date object, then return it, otherwise, return null. On setting, if the valueAsDate p384 attribute does not apply, as defined for the input p353 element's type p355 attribute's current state, then throw an INVALID_STATE_ERR p75 exception; otherwise, if the new value is null, then set the value p409 of the element to the empty string; otherwise, run the algorithm to convert a Date object to a string p356 , as defined for that state, on the new value, and set the value p409 of the element to resulting string. The valueAsNumber IDL attribute represents the value p409 of the element, interpreted as a number. On getting, if the valueAsNumber p384 attribute does not apply, as defined for the input p353 element's type p355 attribute's current state, then return a Not-a-Number (NaN) value. Otherwise, if the valueAsDate p384 attribute applies, run the algorithm to convert a string to a Date object p356 defined for that state; if the algorithm returned a Date object, then return the time value of the object (the number of milliseconds from midnight UTC the morning of 1970-01-01 to the time represented by the Date object), otherwise, return a Not-a-Number (NaN) value. Otherwise, run the algorithm to convert a string to a number p356 defined for that state; if the algorithm returned a number, then return it, otherwise, return a Not-a-Number (NaN) value. On setting, if the valueAsNumber p384 attribute does not apply, as defined for the input p353 element's type p355 attribute's current state, then throw an INVALID_STATE_ERR p75 exception. Otherwise, if the valueAsDate p384 attribute applies, run the algorithm to convert a Date object to a string p356 defined for that state, passing it a Date object whose time value is the new value, and set the value p409 of the element to resulting string. Otherwise, run the algorithm to convert a number to a string p356 , as defined for that state, on the new value, and set the value p409 of the element to resulting string. The stepDown(n) and stepUp(n) methods, when invoked, must run the following algorithm: 1. If the stepDown() p384 and stepUp() p384 methods do not apply, as defined for the input p353 element's type p355 attribute's current state, then throw an INVALID_STATE_ERR p75 exception, and abort these steps. If the element has no allowed value step p382 , then throw an INVALID_STATE_ERR p75 exception, and abort these steps. If applying the algorithm to convert a string to a number p356 to the string given by the element's value p409 results in an error, then throw an INVALID_STATE_ERR p75 exception, and abort these steps; otherwise, let value be the result of that algorithm. Let n be the argument, or 1 if the argument was omitted. Let delta be the allowed value step p382 multiplied by n. If the method invoked was the stepDown() p384 method, negate delta. Let value be the result of adding delta to value. If the element has a minimum p381 , and the value is less than that minimum p381 , then throw a INVALID_STATE_ERR p75 exception. If the element has a maximum p381 , and the value is greater than that maximum p381 , then throw a INVALID_STATE_ERR p75 exception. Let value as string be the result of running the algorithm to convert a number to a string p356 , as defined for the input p353 element's type p355 attribute's current state, on value. Set the value p409 of the element to value as string.
2.
3.
4. 5. 6. 7. 8.
9.
10.
11.
The list IDL attribute must return the current suggestions source element p377 , if any, or null otherwise.
384
The selectedOption IDL attribute must return the value determined by the following steps: 1. If there is no suggestions source element p377 (e.g. because the list p377 attribute doesn't apply or is not specified), then return null and abort thee steps. If the multiple p379 attribute is specified and applies, then return null and abort these steps. (The selectedOption p385 IDL attribute doesn't apply.) Return the first option p393 element, in tree order p29 , to be a child of the suggestions source element p377 and whose value p393 matches the input p353 element's value p409 , if any. If the suggestions source element p377 contains no matching option p393 element, then return null instead.
2.
3.
4.10.7.4 Common event behaviors When the input event applies, any time the user causes the element's value p409 to change, the user agent must queue a task p553 to first fire a simple event p559 that bubbles named input at the input p353 element, and then to broadcast forminput events p423 from the input p353 element's form owner p407 , if any. User agents may wait for a suitable break in the user's interaction before queuing the task; for example, a user agent could wait for the user to have not hit a key for 100ms, so as to only fire the event when the user pauses, instead of continuously for each keystroke. Examples of a user changing the element's value p409 would include the user typing into a text field, pasting a new value into the field, or undoing an edit in that field. Some user interactions do not cause changes to the value, e.g. hitting the "delete" key in an empty text field, or replacing some text in the field with text from the clipboard that happens to be exactly the same text. When the change event applies, if the element does not have an activation behavior p102 defined but uses a user interface that involves an explicit commit action, then any time the user commits a change to the element's value p409 or list of selected files p372 , the user agent must queue a task p553 to first fire a simple event p559 that bubbles named change at the input p353 element, and then to broadcast formchange events p423 from the input p353 element's form owner p407 , if any. An example of a user interface with a commit action would be a File Upload p372 control that consists of a single button that brings up a file selection dialog: when the dialog is closed, if that the file selection p372 changed as a result, then the user has committed a new file selection p372 . Another example of a user interface with a commit action would be a Date p363 control that allows both textbased user input and user selection from a drop-down calendar: while text input might not have an explicit commit step, selecting a date from the drop down calendar and then dismissing the drop down would be a commit action. When the user agent changes the element's value p409 on behalf of the user (e.g. as part of a form prefilling feature), the user agent must follow these steps: 1. If the input p385 event applies, queue a task p553 to fire a simple event p559 that bubbles named input at the input p353 element. If the input p385 event applies, queue a task p553 to broadcast forminput events p423 from the input p353 element's form owner p407 , if any. If the change p385 event applies, queue a task p553 to fire a simple event p559 that bubbles named change at the input p353 element. If the change p385 event applies, queue a task p553 to broadcast formchange events p423 from the input p353 element's form owner p407 , if any.
2.
3.
4.
Note: In addition, when the change p385 event applies, change events can also be fired as part of the element's activation behavior p102 and as part of the unfocusing steps p573 . The task source p553 for these tasks p553 is the user interaction task source p554 .
385
Contexts in which this element can be used: Where phrasing content p100 is expected. Content model: Phrasing content p100 , but there must be no interactive content p101 descendant. Content attributes: Global attributes p90 autofocus p409 disabled p409 form p407 formaction p410 formenctype p410 formmethod p410 formnovalidate p411 formtarget p411 name p408 type p386 value p387 DOM interface: interface HTMLButtonElement : HTMLElement { attribute boolean autofocus; attribute boolean disabled; readonly attribute HTMLFormElement form; attribute DOMString formAction; attribute DOMString formEnctype; attribute DOMString formMethod; attribute DOMString formNoValidate; attribute DOMString formTarget; attribute DOMString name; attribute DOMString type; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); readonly attribute NodeList labels; }; The button p385 element represents p708 a button. If the element is not disabled p409 , then the user agent should allow the user to activate the button. The element is a button p347 . The type attribute controls the behavior of the button when it is activated. It is an enumerated attribute p38 . The following table lists the keywords and states for the attribute the keywords in the left column map to the states in the cell in the second column on the same row as the keyword.
Keyword submit reset button State Brief description
Submit Button p387 Submits the form. Reset Button p387 Button
p387
The missing value default is the Submit Button p387 state. If the type p386 attribute is in the Submit Button p387 state, the element is specifically a submit button p347 . Constraint validation: If the type p386 attribute is in the Reset Button p387 state or the Button p387 state, the element is barred from constraint validation p412 . If the element is not disabled p409 , the activation behavior p102 of the button p385 element is to run the steps defined in the following list for the current state of the element's type p386 attribute.
386
Submit Button If the element has a form owner p407 , the element must submit p417 the form owner p407 from the button p385 element. Reset Button If the element has a form owner p407 , the element must reset p422 the form owner p407 . Button Do nothing. The form p407 attribute is used to explicitly associate the button p385 element with its form owner p407 . The name p408 attribute represents the element's name. The disabled p409 attribute is used to make the control non-interactive and to prevent its value from being submitted. The autofocus p409 attribute controls focus. The formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 attributes are attributes for form submission p410 . Note: The formnovalidate p411 attribute can be used to make submit buttons that do not trigger the constraint validation. The formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 must not be specified if the element's type p386 attribute is not in the Submit Button p387 state. The value attribute gives the element's value for the purposes of form submission. The element's value p409 is the value of the element's value p387 attribute, if there is one, or the empty string otherwise. Note: A button (and its value) is only included in the form submission if the button itself was used to initiate the form submission. The value IDL attribute must reflect p62 the content attribute of the same name. The type IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The autofocus p410 , disabled p409 , form p408 , and name p409 IDL attributes are part of the element's forms API. The following button is labeled "Show hint" and pops up a dialog box when activated: <button type=button onclick="alert('This 15-20 minute piece was composed by George Gershwin.')"> Show hint </button>
387
DOM interface: interface HTMLSelectElement : HTMLElement { attribute boolean autofocus; attribute boolean disabled; readonly attribute HTMLFormElement form; attribute boolean multiple; attribute DOMString name; attribute boolean required; attribute unsigned long size; readonly attribute DOMString type; readonly attribute HTMLOptionsCollection options; attribute unsigned long length; getter any item(in unsigned long index); any namedItem(in DOMString name); void add(in HTMLElement element, in optional HTMLElement before); void add(in HTMLElement element, in long before); void remove(in long index); readonly attribute HTMLCollection selectedOptions; attribute long selectedIndex; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); readonly attribute NodeList labels; }; The select p387 element represents a control for selecting amongst a set of options. The multiple attribute is a boolean attribute p38 . If the attribute is present, then the select p387 element represents p708 a control for selecting zero or more options from the list of options p388 . If the attribute is absent, then the select p387 element represents p708 a control for selecting a single option from the list of options p388 . The size attribute gives the number of options to show to the user. The size p379 attribute, if specified, must have a value that is a valid non-negative integer p39 greater than zero. If the multiple p388 attribute is present, then the size p379 attribute's default value is 4. If the multiple p388 attribute is absent, then the size p379 attribute's default value is 1. The display size of a select p387 element is the result of applying the rules for parsing non-negative integers p39 to the value of element's size p379 attribute, if it has one and parsing it is successful. If applying those rules to the attribute's value is not successful, or if the size p379 attribute is absent, the element's display size p388 is the default value of the attribute. The list of options for a select p387 element consists of all the option p393 element children of the select p387 element, and all the option p393 element children of all the optgroup p392 element children of the select p387 element, in tree order p29 . The required attribute is a boolean attribute p38 . When specified, the user will be required to select a value before submitting the form. If a select p387 element has a required p388 attribute specified, does not have a multiple p388 attribute specified, and has a display size p388 of 1; and if the value p393 of the first option p393 element in the select p387 element's list of options p388 (if any) is the empty string, and that option p393 is not disabled p393 , and, finally, that option p393 element's parent node is the select p387 element (and not an optgroup p392 element), then that option p393 is the select p387 element's placeholder label option. Constraint validation: If the element has its required p388 attribute specified, and either none of the option p393 elements in the select p387 element's list of options p388 have their selectedness p393 set to true, or the only option p393 element in the selected element's list of options p388 with its selectedness p393 set to true is the placeholder label option p388 , then the element is suffering from being missing p413 .
388
If the multiple p388 attribute is absent, and the element is not disabled p409 , then the user agent should allow the user to pick an option p393 element in its list of options p388 that is itself not disabled p393 . Upon this option p393 element being picked (either through a click, or through unfocusing the element after changing its value, or through a menu command p435 , or through any other mechanism), and before the relevant user interaction event is queued (e.g. before the click p33 event), the user agent must set the selectedness p393 of the picked option p393 element to true and then queue a task p553 to first fire a simple event p559 that bubbles named change at the select p387 element, using the user interaction task source p554 as the task source, and then to broadcast formchange events p423 from the element's form owner p407 . If the multiple p388 attribute is absent, whenever an option p393 element in the select p387 element's list of options p388 has its selectedness p393 set to true, and whenever an option p393 element with its selectedness p393 set to true is added to the select p387 element's list of options p388 , the user agent must set the selectedness p393 of all the other option p393 element in its list of options p388 to false. If the multiple p388 attribute is absent and the element's display size p388 is greater than 1, then the user agent should also allow the user to request that the option p393 whose selectedness p393 is true, if any, be unselected. Upon this request being conveyed to the user agent, and before the relevant user interaction event is queued (e.g. before the click p33 event), the user agent must set the selectedness p393 of that option p393 element to false and then queue a task p553 to first fire a simple event p559 that bubbles named change at the select p387 element, using the user interaction task source p554 as the task source, and then to broadcast formchange events p423 from the element's form owner p407 . If the multiple p388 attribute is absent and the element's display size p388 is 1, then whenever there are no option p393 elements in the select p387 element's list of options p388 that have their selectedness p393 set to true, the user agent must set the selectedness p393 of the first option p393 element in the list of options p388 in tree order p29 that is not disabled p393 , if any, to true. If the multiple p388 attribute is present, and the element is not disabled p409 , then the user agent should allow the user to toggle the selectedness p393 of the option p393 elements in its list of options p388 that are themselves not disabled p393 (either through a click, or through a menu command p435 , or any other mechanism). Upon the selectedness p393 of one or more option p393 elements being changed by the user, and before the relevant user interaction event is queued (e.g. before a related click p33 event), the user agent must queue a task p553 to first fire a simple event p559 that bubbles named change at the select p387 element, using the user interaction task source p554 as the task source, and then to broadcast formchange events p423 from the element's form owner p407 . The reset algorithm p423 for select p387 elements is to go through all the option p393 elements in the element's list of options p388 , and set their selectedness p393 to true if the option p393 element has a selected p393 attribute, and false otherwise. The form p407 attribute is used to explicitly associate the select p387 element with its form owner p407 . The name p408 attribute represents the element's name. The disabled p409 attribute is used to make the control non-interactive and to prevent its value from being submitted. The autofocus p409 attribute controls focus. This box is non-normative. Implementation requirements are given below this box. select . type
p390
Returns "select-multiple" if the element has a multiple p388 attribute, and "select-one" otherwise. select . options p390 Returns an HTMLOptionsCollection p67 of the list of options p388 . select . length p390 [ = value ] Returns the number of elements in the list of options p388 . When set to a smaller number, truncates the number of option p393 elements in the select p387 . When set to a greater number, adds new blank option p393 elements to the select p387 . element = select . item p390 (index) select[index] Returns the item with index index from the list of options p388 . The items are sorted in tree order p29 . Returns null if index is out of range. element = select . namedItem p390 (name) Returns the item with ID p92 or name p741 name from the list of options p388 . If there are multiple matching items, then a NodeList p33 object containing all those elements is returned.
389
Returns null if no element with that ID p92 could be found. select . add p390 (element [, before ]) Inserts element before the node given by before. The before argument can be a number, in which case element is inserted before the item with that number, or an element from the list of options p388 , in which case element is inserted before that element. If before is omitted, null, or a number out of range, then element will be added at the end of the list. This method will throw a HIERARCHY_REQUEST_ERR p75 exception if element is an ancestor of the element into which it is to be inserted. If element is not an option p393 or optgroup p392 element, then the method does nothing. select . selectedOptions p390 Returns an HTMLCollection p64 of the list of options p388 that are selected. select . selectedIndex p390 [ = value ] Returns the index of the first selected item, if any, or 1 if there is no selected item. Can be set, to change the selection. select . value p390 [ = value ] Returns the value p409 of the first selected item, if any, or the empty string if there is no selected item. Can be set, to change the selection.
The type IDL attribute, on getting, must return the string "select-one" if the multiple p388 attribute is absent, and the string "select-multiple" if the multiple p388 attribute is present. The options IDL attribute must return an HTMLOptionsCollection p67 rooted at the select p387 node, whose filter matches the elements in the list of options p388 . The options p390 collection is also mirrored on the HTMLSelectElement p388 object. The supported property indices p34 at any instant are the indices supported by the object returned by the options p390 attribute at that instant. The length IDL attribute must return the number of nodes represented p64 by the options p390 collection. On setting, it must act like the attribute of the same name on the options p390 collection. The item(index) method must return the value returned by the method of the same name on the options p390 collection, when invoked with the same argument. The namedItem(name) method must return the value returned by the method of the same name on the options p390 collection, when invoked with the same argument. Similarly, the add() and remove() methods must act like their namesake methods on that same options p390 collection. The selectedOptions IDL attribute must return an HTMLCollection p64 rooted at the select p387 node, whose filter matches the elements in the list of options p388 that have their selectedness p393 set to true. The selectedIndex IDL attribute, on getting, must return the index p394 of the first option p393 element in the list of options p388 in tree order p29 that has its selectedness p393 set to true, if any. If there isn't one, then it must return 1. On setting, the selectedIndex p390 attribute must set the selectedness p393 of all the option p393 elements in the list of options p388 to false, and then the option p393 element in the list of options p388 whose index p394 is the given new value, if any, must have its selectedness p393 set to true. The value IDL attribute, on getting, must return the value p393 of the first option p393 element in the list of options p388 in tree order p29 that has its selectedness p393 set to true, if any. If there isn't one, then it must return the empty string. On setting, the value p390 attribute must set the selectedness p393 of all the option p393 elements in the list of options p388 to false, and then the first option p393 element in the list of options p388 , in tree order p29 , whose value p393 is equal to the given new value, if any, must have its selectedness p393 set to true. The multiple, required, and size IDL attributes must reflect p62 the respective content attributes of the same name. The size p390 IDL attribute is limited to only non-negative numbers greater than zero p63 , and has no default value (unlike the size p388 content attribute that it reflects).
390
The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The autofocus p410 , disabled p409 , form p408 , and name p409 IDL attributes are part of the element's forms API. The following example shows how a select p387 element can be used to offer the user with a set of options from which the user can select a single option. The default option is preselected. <p> <label for="unittype">Select unit type:</label> <select id="unittype" name="unittype"> <option value="1"> Miner </option> <option value="2"> Puffer </option> <option value="3" selected> Snipey </option> <option value="4"> Max </option> <option value="5"> Firebot </option> </select> </p> Here, the user is offered a set of options from which he can select any number. By default, all five options are selected. <p> <label for="allowedunits">Select unit types to enable on this map:</label> <select id="allowedunits" name="allowedunits" multiple> <option value="1" selected> Miner </option> <option value="2" selected> Puffer </option> <option value="3" selected> Snipey </option> <option value="4" selected> Max </option> <option value="5" selected> Firebot </option> </select> </p>
391
datalist . options p392 Returns an HTMLCollection p64 of the options elements of the table.
The options IDL attribute must return an HTMLCollection p64 rooted at the datalist p391 node, whose filter matches option p393 elements. Constraint validation: If an element has a datalist p391 element ancestor, it is barred from constraint validation p412 .
392
393
Note: The Option() p394 constructor with three or fewer arguments overrides the initial state of the selectedness p393 state to always be false even if the third argument is true (implying that a selected p393 attribute is to be set). The fourth argument can be used to explicitly set the initial selectedness p393 state when using the constructor. A select p387 element whose multiple p388 attribute is not specified must not have more than one descendant option p393 element with its selected p393 attribute set. An option p393 element's index is the number of option p393 element that are in the same list of options p388 but that come before it in tree order p29 . If the option p393 element is not in a list of options p388 , then the option p393 element's index p394 is zero. This box is non-normative. Implementation requirements are given below this box. option . selected
p394
Returns true if the element is selected, and false otherwise. Can be set, to override the current state of the element. option . index p394 Returns the index of the element in its select p387 element's options p390 list. option . form p394 Returns the element's form p347 element, if any, or null otherwise. option . text p394 Same as textContent p33 , except that spaces are collapsed. option = new Option p394 ( [ text [, value [, defaultSelected [, selected ] ] ] ] ) Returns a new option p393 element. The text argument sets the contents of the element. The value argument sets the value p393 attribute. The defaultSelected argument sets the selected p393 attribute. The selected argument sets whether or not the element is selected. If it is omitted, even if the defaultSelected argument is true, the element is not selected.
The disabled and label IDL attributes must reflect p62 the respective content attributes of the same name. The defaultSelected IDL attribute must reflect p62 the selected p393 content attribute. The value IDL attribute, on getting, must return the value of the element's value p393 content attribute, if it has one, or else the value of the element's textContent p33 IDL attribute. On setting, the element's value p393 content attribute must be set to the new value. The selected IDL attribute, on getting, must return true if the element's selectedness p393 is true, and false otherwise. On setting, it must set the element's selectedness p393 to the new value. The index IDL attribute must return the element's index p394 . The text IDL attribute, on getting, must return the value of the textContent p33 IDL attribute on the element with leading and trailing space characters p37 removed, and with any sequences of two or more space characters p37 replaced by a single U+0020 SPACE character. On setting, it must act as if the textContent p33 IDL attribute on the element had been set to the new value. The form IDL attribute's behavior depends on whether the option p393 element is in a select p387 element or not. If the option p393 has a select p387 element as its parent, or has a colgroup p328 element as its parent and that colgroup p328 element has a select p387 element as its parent, then the form p394 IDL attribute must return the same value as the form p408 IDL attribute on that select p387 element. Otherwise, it must return null. Several constructors are provided for creating HTMLOptionElement p393 objects (in addition to the factory methods from DOM Core such as createElement()): Option(), Option(text), Option(text, value), Option(text, value, defaultSelected), and Option(text, value, defaultSelected, selected). When invoked as constructors, these must return a new HTMLOptionElement p393 object (a new option p393 element). If the text argument is present, the new object must have as its only child a Node p33 with node type TEXT_NODE (3) whose data is the value of that argument. If the value argument is present, the new object must have a value p393 attribute set with the value of the argument as its value. If the defaultSelected argument is present and true, the new object must have a selected p393 attribute set with no value. If the selected argument is present and true, the new object must have its selectedness p393 set to true; otherwise the fourth argument is absent or false, and the
394
selectedness p393 must be set to false, even if the defaultSelected argument is present and true. The element's document must be the active document p499 of the browsing context p499 of the Window p503 object on which the interface object of the invoked constructor is found.
readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); readonly attribute NodeList labels; void select(); attribute unsigned long selectionStart; attribute unsigned long selectionEnd; void setSelectionRange(in unsigned long start, in unsigned long end); };
395
The textarea p395 element represents p708 a multiline plain text edit control for the element's raw value. The contents of the control represent the control's default value. The raw value p396 of a textarea p395 control must be initially the empty string. Note: A newline in a textarea p395 element, and in its raw value p396 , separates paragraphs for the purposes of the Unicode bidirectional algorithm. [BIDI] p781 The readonly attribute is a boolean attribute p38 used to control whether the text can be edited by the user or not. Constraint validation: If the readonly p396 attribute is specified on a textarea p395 element, the element is barred from constraint validation p412 . A textarea p395 element is mutable if it is neither disabled p409 nor has a readonly p396 attribute specified. When a textarea p395 is mutable p396 , its raw value p396 should be editable by the user. Any time the user causes the element's raw value p396 to change, the user agent must queue a task p553 to first fire a simple event p559 that bubbles named input at the textarea p395 element, and then to broadcast forminput events p423 from the textarea p395 element's form owner p407 . User agents may wait for a suitable break in the user's interaction before queuing the task; for example, a user agent could wait for the user to have not hit a key for 100ms, so as to only fire the event when the user pauses, instead of continuously for each keystroke. A textarea p395 element has a dirty value flag, which must be initially set to false, and must be set to true whenever the user interacts with the control in a way that changes the raw value p396 . When the textarea p395 element's textContent p33 IDL attribute changes value, if the element's dirty value flag p396 is false, then the element's raw value p396 must be set to the value of the element's textContent p33 IDL attribute. The reset algorithm p423 for textarea p395 elements is to set the element's value p396 to the value of the element's textContent p33 IDL attribute. If the element is mutable p396 , the user agent should allow the user to change the writing direction of the element, setting it either to a left-to-right writing direction or a right-to-left writing direction. If the user does so, the user agent must then run the following steps: 1. Set the element's dir p93 attribute to "ltr p93 " if the user selected a left-to-right writing direction, and "rtl p93 " if the user selected a right-to-left writing direction. Queue a task p553 to first fire a simple event p559 that bubbles named input at the textarea p395 element, and to then broadcast forminput events p423 from the textarea p395 element's form owner p407 , if any.
2.
The cols attribute specifies the expected maximum number of characters per line. If the cols p396 attribute is specified, its value must be a valid non-negative integer p39 greater than zero. If applying the rules for parsing nonnegative integers p39 to the attribute's value results in a number greater than zero, then the element's character width is that value; otherwise, it is 20. The user agent may use the textarea p395 element's character width p396 as a hint to the user as to how many characters the server prefers per line (e.g. for visual user agents by making the width of the control be that many characters). In visual renderings, the user agent should wrap the user's input in the rendering so that each line is no wider than this number of characters. The rows attribute specifies the number of lines to show. If the rows p396 attribute is specified, its value must be a valid non-negative integer p39 greater than zero. If applying the rules for parsing non-negative integers p39 to the attribute's value results in a number greater than zero, then the element's character height is that value; otherwise, it is 2. Visual user agents should set the height of the control to the number of lines given by character height p396 . The wrap attribute is an enumerated attribute p38 with two keywords and states: the soft keyword which maps to the Soft p396 state, and the hard keyword which maps to the Hard p396 state. The missing value default is the Soft p396 state. The Soft state indicates that the text in the textarea p395 is not to be wrapped when it is submitted (though it can still be wrapped in the rendering). The Hard state indicates that the text in the textarea p395 is to have newlines added by the user agent so that the text is wrapped when it is submitted. If the element's wrap p396 attribute is in the Hard p396 state, the cols p396 attribute must be specified. The element's value p409 is defined to be the element's raw value p396 with the following transformation applied:
396
1.
Replace every occurrence of a U+000D CARRIAGE RETURN (CR) character not followed by a U+000A LINE FEED (LF) character, and every occurrence of a U+000A LINE FEED (LF) character not preceded by a U+000D CARRIAGE RETURN (CR) character, by a two-character string consisting of a U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair. If the element's wrap p396 attribute is in the Hard p396 state, insert U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pairs into the string using a UA-defined algorithm so that each line has no more than character width p396 characters. For the purposes of this requirement, lines are delimited by the start of the string, the end of the string, and U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pairs.
2.
The maxlength attribute is a form control maxlength attribute p410 controlled by the textarea p395 element's dirty value flag p396 . If the textarea p395 element has a maximum allowed value length p410 , then the element's children must be such that the code-point length p38 of the value of the element's textContent p33 IDL attribute is equal to or less than the element's maximum allowed value length p410 . The required attribute is a boolean attribute p38 . When specified, the user will be required to enter a value before submitting the form. Constraint validation: If the element has its required p397 attribute specified, and the element is mutable p396 , and the element's value p409 is the empty string, then the element is suffering from being missing p413 . The placeholder attribute represents a hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format. The attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. Note: For a longer hint or other advisory text, the title p92 attribute is more appropriate. The placeholder p397 attribute should not be used as an alternative to a label p352 . User agents should present this hint to the user, after having stripped line breaks p38 from it, when the element's value p409 is the empty string and the control is not focused (e.g. by displaying it inside a blank unfocused control). The dirname attribute is a form control dirname attribute p411 . The form p407 attribute is used to explicitly associate the textarea p395 element with its form owner p407 . The name p408 attribute represents the element's name. The disabled p409 attribute is used to make the control non-interactive and to prevent its value from being submitted. The autofocus p409 attribute controls focus. This box is non-normative. Implementation requirements are given below this box. textarea . type Returns the string "textarea". textarea . value Returns the current value of the element. Can be set, to change the value.
The cols, placeholder, required, rows, and wrap attributes must reflect p62 the respective content attributes of the same name. The cols p397 and rows p397 attributes are limited to only non-negative numbers greater than zero p63 . The cols p397 attribute's default value is 20. The rows p397 attribute's default value is 2. The dirName IDL attribute must reflect p62 the dirname p397 content attribute. The maxLength IDL attribute must reflect p62 the maxlength p397 content attribute, limited to only non-negative numbers p63 . The readOnly IDL attribute must reflect p62 the readonly p396 content attribute. The type IDL attribute must return the value "textarea". The defaultValue IDL attribute must act like the element's textContent p33 IDL attribute. The value attribute must, on getting, return the element's raw value p396 ; on setting, it must set the element's raw value p396 to the new value. The textLength IDL attribute must return the code-point length p38 of the element's value p409 . The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The select() p412 , selectionStart p412 , selectionEnd p412 , and
397
setSelectionRange() p412 methods and attributes expose the element's text selection. The autofocus p410 , disabled p409 , form p408 , and name p409 IDL attributes are part of the element's forms API. Here is an example of a textarea p395 being used for unrestricted free-form text input in a form: <p>If you have any comments, please let us know: <textarea cols=80 name=comments></textarea></p> To specify that a maximum length for the comments, one can use the maxlength p397 attribute: <p>If you have any short comments, please let us know: <textarea cols=80 name=comments maxlength=200></textarea></p> To give a default value, text can be included inside the element: <p>If you have any comments, please let us know: <textarea cols=80 name=comments>You rock!</textarea></p> To have the browser submit the directionality p94 of the element along with the value, the dirname p397 attribute can be specified: <p>If you have any comments, please let us know (you may use either English or Hebrew for your comments): <textarea cols=80 name=comments dirname=comments.dir></textarea></p>
398
The challenge attribute may be specified. Its value will be packaged with the submitted key. The keytype attribute is an enumerated attribute p38 . The following table lists the keywords and states for the attribute the keywords in the left column map to the states listed in the cell in the second column on the same row as the keyword. User agents are not required to support these values, and must only recognize values whose corresponding algorithms they support.
Keyword State rsa RSA
The invalid value default state is the unknown state. The missing value default state is the RSA state, if it is supported, or the unknown state otherwise. Note: This specification does not specify what key types user agents are to support it is possible for a user agent to not support any key types at all. The user agent may expose a user interface for each keygen p398 element to allow the user to configure settings of the element's key pair generator, e.g. the key length. The reset algorithm p423 for keygen p398 elements is to set these various configuration settings back to their defaults. The element's value p409 is the string returned from the following algorithm: 1. Use the appropriate step from the following list:
p399 attribute is in the RSA state If the keytype
Generate an RSA key pair using the settings given by the user, if appropriate, using the md5WithRSAEncryption RSA signature algorithm (the signature algorithm with MD5 and the RSA encryption algorithm) referenced in section 2.2.1 ("RSA Signature Algorithm") of RFC 3279, and defined in RFC 2313. [RFC3279] p784 [RFC2313] p784
p399 attribute is in the unknown state Otherwise, the keytype
The given key type is not supported. Return the empty string and abort this algorithm. Let private key be the generated private key. Let public key be the generated public key. Let signature algorithm be the selected signature algorithm. 2. If the element has a challenge p399 attribute, then let challenge be that attribute's value. Otherwise, let challenge be the empty string. Let algorithm be an ASN.1 AlgorithmIdentifier structure as defined by RFC 5280, with the algorithm field giving the ASN.1 OID used to identify signature algorithm, using the OIDs defined in section 2.2 ("Signature Algorithms") of RFC 3279, and the parameters field set up as required by RFC 3279 for AlgorithmIdentifier structures for that algorithm. [X690] p786 [RFC5280] p785 [RFC3279] p784 Let spki be an ASN.1 SubjectPublicKeyInfo structure as defined by RFC 5280, with the algorithm field set to the algorithm structure from the previous step, and the subjectPublicKey field set to the BIT STRING value resulting from ASN.1 DER encoding the public key. [X690] p786 [RFC5280] p785 Let publicKeyAndChallenge be an ASN.1 PublicKeyAndChallenge p399 structure as defined below, with the spki field set to the spki structure from the previous step, and the challenge field set to the string challenge obtained earlier. [X690] p786 Let signature be the BIT STRING value resulting from ASN.1 DER encoding the signature generated by applying the signature algorithm to the byte string obtained by ASN.1 DER encoding the publicKeyAndChallenge structure, using private key as the signing key. [X690] p786 Let signedPublicKeyAndChallenge be an ASN.1 SignedPublicKeyAndChallenge p400 structure as defined below, with the publicKeyAndChallenge field set to the publicKeyAndChallenge structure, the signatureAlgorithm field set to the algorithm structure, and the signature field set to the BIT STRING signature from the previous step. [X690] p786 Return the result of base64 encoding the result of ASN.1 DER encoding the signedPublicKeyAndChallenge structure. [RFC4648] p784 [X690] p786
3.
4.
5.
6.
7.
8.
The data objects used by the above algorithm are defined as follows. These definitions use the same "ASN.1-like" syntax defined by RFC 5280. [RFC5280] p785 PublicKeyAndChallenge ::= SEQUENCE { spki SubjectPublicKeyInfo,
399
challenge IA5STRING } SignedPublicKeyAndChallenge ::= SEQUENCE { publicKeyAndChallenge PublicKeyAndChallenge, signatureAlgorithm AlgorithmIdentifier, signature BIT STRING }
Constraint validation: The keygen p398 element is barred from constraint validation p412 . The form p407 attribute is used to explicitly associate the keygen p398 element with its form owner p407 . The name p408 attribute represents the element's name. The disabled p409 attribute is used to make the control non-interactive and to prevent its value from being submitted. The autofocus p409 attribute controls focus. This box is non-normative. Implementation requirements are given below this box. keygen . type Returns the string "keygen".
The challenge IDL attribute must reflect p62 the content attribute of the same name. The keytype IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . The type IDL attribute must return the value "keygen". The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The autofocus p410 , disabled p409 , form p408 , and name p409 IDL attributes are part of the element's forms API. Note: This specification does not specify how the private key generated is to be used. It is expected that after receiving the SignedPublicKeyAndChallenge p400 (SPKAC) structure, the server will generate a client certificate and offer it back to the user for download; this certificate, once downloaded and stored in the key store along with the private key, can then be used to authenticate to services that use TLS and certificate authentication. To generate a key pair, add the private key to the user's key store, and submit the public key to the server, markup such as the following can be used: <form action="processkey.cgi" method="post" enctype="multipart/form-data"> <p><keygen name="key"></p> <p><input type=submit value="Submit key..."></p> </form> The server will then receive a form submission with a packaged RSA public key as the value of "key". This can then be used for various purposes, such as generating a client certificate, as mentioned above.
400
DOM interface: interface HTMLOutputElement : HTMLElement { [PutForwards=value] readonly attribute DOMSettableTokenList htmlFor; readonly attribute HTMLFormElement form; attribute DOMString name; readonly attribute DOMString type; attribute DOMString defaultValue; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); void setCustomValidity(in DOMString error); readonly attribute NodeList labels; }; The output p400 element represents p708 the result of a calculation. The for content attribute allows an explicit relationship to be made between the result of a calculation and the elements that represent the values that went into the calculation or that otherwise influenced the calculation. The for p401 attribute, if specified, must contain a string consisting of an unordered set of unique space-separated tokens p53 that are case-sensitive p36 , each of which must have the value of an ID p92 of an element in the same Document p33 . The form p407 attribute is used to explicitly associate the output p400 element with its form owner p407 . The name p408 attribute represents the element's name. The element has a value mode flag which is either value or default. Initially, the value mode flag p401 must be set to default. The element also has a default value. Initially, the default value p401 must be the empty string. When the value mode flag p401 is in mode default, the contents of the element represent both the value of the element and its default value p401 . When the value mode flag p401 is in mode value, the contents of the element represent the value of the element only, and the default value p401 is only accessible using the defaultValue p402 IDL attribute. Whenever the element's descendants are changed in any way, if the value mode flag p401 is in mode default, the element's default value p401 must be set to the value of the element's textContent p33 IDL attribute. The reset algorithm p423 for output p400 elements is to set the element's value mode flag p401 to default and then to set the element's textContent p33 IDL attribute to the value of the element's default value p401 (thus replacing the element's child nodes). This box is non-normative. Implementation requirements are given below this box. output . value
p401
[ = value ]
Returns the element's current value. Can be set, to change the value. output . defaultValue p402 [ = value ] Returns the element's current default value. Can be set, to change the default value. output . type p402 Returns the string "output".
The value IDL attribute must act like the element's textContent p33 IDL attribute, except that on setting, in addition, before the child nodes are changed, the element's value mode flag p401 must be set to value.
401
The defaultValue IDL attribute, on getting, must return the element's default value p401 . On setting, the attribute must set the element's default value p401 , and, if the element's value mode flag p401 is in the mode default, set the element's textContent p33 IDL attribute as well. The type attribute must return the string "output". The htmlFor IDL attribute must reflect p62 the for p401 content attribute. The willValidate p415 , validity p415 , and validationMessage p416 attributes, and the checkValidity() p415 and setCustomValidity() p415 methods, are part of the constraint validation API p414 . The labels p353 attribute provides a list of the element's label p352 s. The form p408 and name p409 IDL attributes are part of the element's forms API. Constraint validation: output p400 elements are always barred from constraint validation p412 . A simple calculator could use output p400 for its display of calculated results: <form onsubmit="return false"> <input name=a type=number step=any> + <input name=b type=number step=any> = <output onforminput="value = a.valueAsNumber + b.valueAsNumber"></output> </form>
} </script> </section> (The updateProgress() method in this example would be called by some other code on the page to update the actual progress bar as the task progressed.) The value p402 and max p402 attributes, when present, must have values that are valid floating point numbers p40 . The value p402 attribute, if present, must have a value equal to or greater than zero, and less than or equal to the value of the max p402 attribute, if present, or 1.0, otherwise. The max p402 attribute, if present, must have a value greater than zero. Note: The progress p402 element is the wrong element to use for something that is just a gauge, as opposed to task progress. For instance, indicating disk space usage using progress p402 would be inappropriate. Instead, the meter p403 element is available for such use cases. User agent requirements: If the value p402 attribute is omitted, then the progress bar is an indeterminate progress bar. Otherwise, it is a determinate progress bar. If the progress bar is a determinate progress bar and the element has a max p402 attribute, the user agent must parse the max p402 attribute's value according to the rules for parsing floating point number values p40 . If this does not result in an error, and if the parsed value is greater than zero, then the maximum value of the progress bar is that value. Otherwise, if the element has no max p402 attribute, or if it has one but parsing it resulted in an error, or if the parsed value was less than or equal to zero, then the maximum value p403 of the progress bar is 1.0. If the progress bar is a determinate progress bar, user agents must parse the value p402 attribute's value according to the rules for parsing floating point number values p40 . If this does not result in an error, and if the parsed value is less than the maximum value p403 and greater than zero, then the current value of the progress bar is that parsed value. Otherwise, if the parsed value was greater than or equal to the maximum value p403 , then the current value p403 of the progress bar is the maximum value p403 of the progress bar. Otherwise, if parsing the value p402 attribute's value resulted in an error, or a number less than or equal to zero, then the current value p403 of the progress bar is zero. UA requirements for showing the progress bar: When representing a progress p402 element to the user, the UA should indicate whether it is a determinate or indeterminate progress bar, and in the former case, should indicate the relative position of the current value p403 relative to the maximum value p403 . The form p407 attribute is used to explicitly associate the progress p402 element with its form owner p407 . This box is non-normative. Implementation requirements are given below this box. progress . position
p403
For a determinate progress bar (one with known current and maximum values), returns the result of dividing the current value by the maximum value. For an indeterminate progress bar, returns 1.
If the progress bar is an indeterminate progress bar, then the position IDL attribute must return 1. Otherwise, it must return the result of dividing the current value p403 by the maximum value p403 . Similarly, if the progress bar is an indeterminate progress bar, then the value IDL attribute, on getting, must return 1. Otherwise, it must return the current value p403 . On setting, the given value must be converted to the best representation of the number as a floating point number p40 and then the value p403 content attribute must be set to that string. The max IDL attribute must reflect p62 the content attribute of the same name. The default value for max p403 is 1.0. The labels p353 attribute provides a list of the element's label p352 s. The form p408 IDL attribute is part of the element's forms API.
403
Content model: Phrasing content p100 , but there must be no meter p403 element descendants. Content attributes: Global attributes p90 value p404 min p404 max p404 low p404 high p404 optimum p404 form p407 DOM interface: interface HTMLMeterElement : HTMLElement { attribute double value; attribute double min; attribute double max; attribute double low; attribute double high; attribute double optimum; readonly attribute HTMLFormElement form; readonly attribute NodeList labels; }; The meter p403 element represents p708 a scalar measurement within a known range, or a fractional value; for example disk usage, the relevance of a query result, or the fraction of a voting population to have selected a particular candidate. This is also known as a gauge. Note: The meter p403 element should not be used to indicate progress (as in a progress bar). For that role, HTML provides a separate progress p402 element. Note: The meter p403 element also does not represent a scalar value of arbitrary range for example, it would be wrong to use this to report a weight, or height, unless there is a known maximum value. There are six attributes that determine the semantics of the gauge represented by the element. The min attribute specifies the lower bound of the range, and the max attribute specifies the upper bound. The value attribute specifies the value to have the gauge indicate as the "measured" value. The other three attributes can be used to segment the gauge's range into "low", "medium", and "high" parts, and to indicate which part of the gauge is the "optimum" part. The low attribute specifies the range that is considered to be the "low" part, and the high attribute specifies the range that is considered to be the "high" part. The optimum attribute gives the position that is "optimum"; if that is higher than the "high" value then this indicates that the higher the value, the better; if it's lower than the "low" mark then it indicates that lower values are better, and naturally if it is in between then it indicates that neither high nor low values are good. Authoring requirements: The value p404 attribute must be specified. The value p404 , min p404 , low p404 , high p404 , max p404 , and optimum p404 attributes, when present, must have values that are valid floating point numbers p40 . In addition, the attributes' values are further constrained: Let value be the value p404 attribute's number. If the min p404 attribute attribute is specified, then let minimum be that attribute's value; otherwise, let it be zero. If the max p404 attribute attribute is specified, then let maximum be that attribute's value; otherwise, let it be 1.0. The following inequalities must hold, as applicable: minimum value maximum minimum low p404 maximum (if low p404 is specified) minimum high p404 maximum (if high p404 is specified) minimum optimum p404 maximum (if optimum p404 is specified) low p404 high p404 (if both low p404 and high p404 are specified)
404
Note: If no minimum or maximum is specified, then the range is assumed to be 0..1, and the value thus has to be within that range. Authors are encouraged to include a textual representation of the gauge's state in the element's contents, for users of user agents that do not support the meter p403 element. The following examples show three gauges that would all be three-quarters full: Storage space usage: <meter value=6 max=8>6 blocks used (out of 8 total)</meter> Voter turnout: <meter value=0.75><img alt="75%" src="graph75.png"></meter> Tickets sold: <meter min="0" max="100" value="75"></meter> The following example is incorrect use of the element, because it doesn't give a range (and since the default maximum is 1, both of the gauges would end up looking maxed out): <p>The grapefruit pie had a radius of <meter value=12>12cm</meter> and a height of <meter value=2>2cm</meter>.</p> <!-- BAD! --> Instead, one would either not include the meter element, or use the meter element with a defined range to give the dimensions in context compared to other pies: <p>The grapefruit pie had a radius of 12cm and a height of 2cm.</p> <dl> <dt>Radius: <dd> <meter min=0 max=20 value=12>12cm</meter> <dt>Height: <dd> <meter min=0 max=10 value=2>2cm</meter> </dl> There is no explicit way to specify units in the meter p403 element, but the units may be specified in the title p92 attribute in free-form text. The example above could be extended to mention the units: <dl> <dt>Radius: <dd> <meter min=0 max=20 value=12 title="centimeters">12cm</meter> <dt>Height: <dd> <meter min=0 max=10 value=2 title="centimeters">2cm</meter> </dl> User agent requirements: User agents must parse the min p404 , max p404 , value p404 , low p404 , high p404 , and optimum p404 attributes using the rules for parsing floating point number values p40 . User agents must then use all these numbers to obtain values for six points on the gauge, as follows. (The order in which these are evaluated is important, as some of the values refer to earlier ones.) The minimum value If the min p404 attribute is specified and a value could be parsed out of it, then the minimum value is that value. Otherwise, the minimum value is zero. The maximum value If the max p404 attribute is specified and a value could be parsed out of it, the maximum value is that value. Otherwise, the maximum value is 1.0. If the maximum value would be less than the minimum value, then the maximum value is actually the same as the minimum value. The actual value If the value p404 attribute is specified and a value could be parsed out of it, then that value is the actual value. Otherwise, the actual value is zero. If the actual value would be less than the minimum value, then the actual value is actually the same as the minimum value. If, on the other hand, the actual value would be greater than the maximum value, then the actual value is the maximum value. The low boundary If the low p404 attribute is specified and a value could be parsed out of it, then the low boundary is that value. Otherwise, the low boundary is the same as the minimum value. If the low boundary is then less than the minimum value, then the low boundary is actually the same as the minimum value. Similarly, if the low boundary is greater than the maximum value, then it is actually the maximum value instead.
405
The high boundary If the high p404 attribute is specified and a value could be parsed out of it, then the high boundary is that value. Otherwise, the high boundary is the same as the maximum value. If the high boundary is then less than the low boundary, then the high boundary is actually the same as the low boundary. Similarly, if the high boundary is greater than the maximum value, then it is actually the maximum value instead. The optimum point If the optimum p404 attribute is specified and a value could be parsed out of it, then the optimum point is that value. Otherwise, the optimum point is the midpoint between the minimum value and the maximum value. If the optimum point is then less than the minimum value, then the optimum point is actually the same as the minimum value. Similarly, if the optimum point is greater than the maximum value, then it is actually the maximum value instead. All of which will result in the following inequalities all being true: minimum value actual value maximum value minimum value low boundary high boundary maximum value minimum value optimum point maximum value
UA requirements for regions of the gauge: If the optimum point is equal to the low boundary or the high boundary, or anywhere in between them, then the region between the low and high boundaries of the gauge must be treated as the optimum region, and the low and high parts, if any, must be treated as suboptimal. Otherwise, if the optimum point is less than the low boundary, then the region between the minimum value and the low boundary must be treated as the optimum region, the region between the low boundary and the high boundary must be treated as a suboptimal region, and the region between the high boundary and the maximum value must be treated as an even less good region. Finally, if the optimum point is higher than the high boundary, then the situation is reversed; the region between the high boundary and the maximum value must be treated as the optimum region, the region between the high boundary and the low boundary must be treated as a suboptimal region, and the remaining region between the low boundary and the minimum value must be treated as an even less good region. UA requirements for showing the gauge: When representing a meter p403 element to the user, the UA should indicate the relative position of the actual value to the minimum and maximum values, and the relationship between the actual value and the three regions of the gauge. The following markup: <h3>Suggested groups</h3> <menu type="toolbar"> <a href="?cmd=hsg" onclick="hideSuggestedGroups()">Hide suggested groups</a> </menu> <ul> <li> <p><a href="/group/comp.infosystems.www.authoring.stylesheets/ view">comp.infosystems.www.authoring.stylesheets</a> <a href="/group/comp.infosystems.www.authoring.stylesheets/subscribe">join</a></p> <p>Group description: <strong>Layout/presentation on the WWW.</strong></p> <p><meter value="0.5">Moderate activity,</meter> Usenet, 618 subscribers</p> </li> <li> <p><a href="/group/netscape.public.mozilla.xpinstall/ view">netscape.public.mozilla.xpinstall</a> <a href="/group/netscape.public.mozilla.xpinstall/subscribe">join</a></p> <p>Group description: <strong>Mozilla XPInstall discussion.</strong></p> <p><meter value="0.25">Low activity,</meter> Usenet, 22 subscribers</p> </li> <li> <p><a href="/group/mozilla.dev.general/view">mozilla.dev.general</a> <a href="/group/mozilla.dev.general/subscribe">join</a></p> <p><meter value="0.25">Low activity,</meter> Usenet, 66 subscribers</p> </li> </ul> Might be rendered as follows:
406
User agents may combine the value of the title p92 attribute and the other attributes to provide context-sensitive help or inline text detailing the actual values. For example, the following snippet: <meter min=0 max=60 value=23.2 title=seconds></meter> ...might cause the user agent to display a gauge with a tooltip saying "Value: 23.2 out of 60." on one line and "seconds" on a second line. The form p407 attribute is used to explicitly associate the meter p403 element with its form owner p407 . The value IDL attribute, on getting, must return the actual value p405 . On setting, the given value must be converted to the best representation of the number as a floating point number p40 and then the value p407 content attribute must be set to that string. The min, max, low, high, and optimum IDL attributes must reflect p62 the respective content attributes of the same name. The labels p353 attribute provides a list of the element's label p352 s. The form p408 IDL attribute is part of the element's forms API. The following example shows how a gauge could fall back to localized or pretty-printed text. <p>Disk usage: <meter min=0 value=170261928 max=233257824>170 261 928 bytes used out of 233 257 824 bytes available</meter></p>
407
When a form-associated element p347 's form p407 attribute is added, removed, or has its value changed, then the user agent must reset the form owner p408 of that element. When a form-associated element p347 has a form p407 attribute and the ID p92 of any of the elements in the Document p33 changes, then the user agent must reset the form owner p408 of that form-associated element p347 . When a form-associated element p347 has a form p407 attribute and an element with an ID p92 is inserted into p29 or removed from p29 the Document p33 , then the user agent must reset the form owner p408 of that form-associated element p347 . When the user agent is to reset the form owner of a form-associated element p347 , it must run the following steps: 1. If the element's form owner p407 is not null, and the element's form p407 content attribute is not present, and the element's form owner p407 is its nearest form p347 element ancestor after the change to the ancestor chain, then do nothing, and abort these steps. Let the element's form owner p407 be null. If the element has a form p407 content attribute, then run these substeps: 1. If the first element in the Document p29 to have an ID p92 that is case-sensitively p36 equal to the element's form p407 content attribute's value is a form p347 element, then associate p407 the formassociated element p347 with that form p347 element. Abort the "reset the form owner" steps.
2. 3.
2. 4.
Otherwise, if the form-associated element p347 in question has an ancestor form p347 element, then associate p407 the form-associated element p347 with the nearest such ancestor form p347 element. Otherwise, the element is left unassociated.
5.
In the following non-conforming snippet: ... <form id="a"> <div id="b"></div> </form> <script> document.getElementById('b').innerHTML = '<table><tr><td><form id="c"><input id="d"></table>' + '<input id="e">'; </script> ... The form owner p407 of "d" would be the inner nested form "c", while the form owner p407 of "e" would be the outer form "a". This happens as follows: First, the "e" node gets associated with "c" in the HTML parser p620 . Then, the innerHTML p112 algorithm moves the nodes from the temporary document to the "b" element. At this point, the nodes see their ancestor chain change, and thus all the "magic" associations done by the parser are reset to normal ancestor associations. This example is a non-conforming document, though, as it is a violation of the content models to nest form p347 elements. This box is non-normative. Implementation requirements are given below this box. element . form
p408
Returns the element's form owner p407 . Returns null if there isn't one.
Form-associated elements p347 have a form IDL attribute, which, on getting, must return the element's form owner p407 , or null if there isn't one.
408
Any non-empty value for name p348 is allowed, but the names "_charset_ p409 " and "isindex p409 " are special: isindex This value, if used as the name of a Text p358 control that is the only control in a form that is submitted using the application/x-www-form-urlencoded p410 mechanism, causes the submission to only include the value of this control, with no name. _charset_ This value, if used as the name of a Hidden p358 control with no value p357 attribute, is automatically given a value during submission consisting of the submission character encoding. The name IDL attribute must reflect p62 the name p408 content attribute.
4.10.19.2 Enabling and disabling form controls The disabled content attribute is a boolean attribute p38 . A form control is disabled if its disabled p409 attribute is set, or if it is a descendant of a fieldset p350 element whose disabled p350 attribute is set and is not a descendant of that fieldset p350 element's first legend p351 element child, if any. A form control that is disabled p409 must prevent any click p33 events that are queued p553 on the user interaction task source p554 from being dispatched on the element. Constraint validation: If an element is disabled p409 , it is barred from constraint validation p412 . The disabled IDL attribute must reflect p62 the disabled p409 content attribute.
4.10.19.3 A form control's value Form controls have a value and a checkedness. (The latter is only used by input p353 elements.) These are used to describe how the user interacts with the control. To define the behaviour of constraint validation in the face of the input p353 element's multiple p379 attribute, input p353 elements can also have separately defined values.
4.10.19.4 Autofocusing a form control The autofocus content attribute allows the author to indicate that a control is to be focused as soon as the page is loaded, allowing the user to just start typing without having to manually focus the main control. The autofocus p409 attribute is a boolean attribute p38 . There must not be more than one element in the document with the autofocus p409 attribute specified. When an element with the autofocus p409 attribute specified is inserted into a document p29 , user agents should run the following steps: 1. 2. 3. Let target be the element's Document p33 . If target has no browsing context p499 , abort these steps. If target's browsing context p499 has no top-level browsing context p499 (e.g. it is a nested browsing context p499 with no parent browsing context p499 ), abort these steps. If target's browsing context p499 had the sandboxed automatic features browsing context flag p217 set when target was created, abort these steps. If target's origin p510 is not the same p512 as the origin p510 of the Document p33 of the currently focused element in target's top-level browsing context p499 , abort these steps. If target's origin p510 is not the same p512 as the origin p510 of the active document p499 of target's top-level browsing context p499 , abort these steps. If the user agent has already reached the last step of this list of steps in response to an element being inserted p29 into a Document p33 whose top-level browsing context p499 's active document p499 is the same as target's top-level browsing context p499 's active document p499 , abort these steps. If the user has indicated (for example, by starting to type in a form control) that he does not wish focus to be changed, then optionally abort these steps.
4.
5.
6.
7.
8.
409
9.
Queue a task p553 that checks to see if the element is focusable p573 , and if so, runs the focusing steps p573 for that element. User agents may also change the scrolling position of the document, or perform some other action that brings the element to the user's attention. The task source p553 for this task is the DOM manipulation task source p554 .
Note: Focusing the control does not imply that the user agent must focus the browser window if it has lost focus. The autofocus IDL attribute must reflect p62 the content attribute of the same name. In the following snippet, the text control would be focused when the document was loaded. <input maxlength="256" name="q" value="" autofocus> <input type="submit" value="Search">
4.10.19.5 Limiting user input length A form control maxlength attribute, controlled by a dirty value flag declares a limit on the number of characters a user can input. If an element has its form control maxlength attribute p410 specified, the attribute's value must be a valid nonnegative integer p39 . If the attribute is specified and applying the rules for parsing non-negative integers p39 to its value results in a number, then that number is the element's maximum allowed value length. If the attribute is omitted or parsing its value results in an error, then there is no maximum allowed value length p410 . Constraint validation: If an element has a maximum allowed value length p410 , and its dirty value flag is true, and the code-point length p38 of the element's value p409 is greater than the element's maximum allowed value length p410 , then the element is suffering from being too long p413 . User agents may prevent the user from causing the element's value p409 to be set to a value whose code-point length p38 is greater than the element's maximum allowed value length p410 .
4.10.19.6 Form submission Attributes for form submission can be specified both on form p347 elements and on submit buttons p347 (elements that represent buttons that submit forms, e.g. an input p353 element whose type p355 attribute is in the Submit Button p373 state). The attributes for form submission p410 that may be specified on form p347 elements are action p410 , enctype p410 , method p410 , novalidate p411 , and target p411 . The corresponding attributes for form submission p410 that may be specified on submit buttons p347 are formaction p410 , formenctype p410 , formmethod p410 , formnovalidate p411 , and formtarget p411 . When omitted, they default to the values given on the corresponding attributes on the form p347 element. The action and formaction content attributes, if specified, must have a value that is a valid non-empty URL potentially surrounded by spaces p55 . The action of an element is the value of the element's formaction p410 attribute, if the element is a submit button p347 and has such an attribute, or the value of its form owner p407 's action p410 attribute, if it has one, or else the empty string. The method and formmethod content attributes are enumerated attributes p38 with the following keywords and states: The keyword get, mapping to the state GET, indicating the HTTP GET method. The keyword post, mapping to the state POST, indicating the HTTP POST method.
The missing value default for these attributes is the GET p410 state. The method of an element is one of those states. If the element is a submit button p347 and has a formmethod p410 attribute, then the element's method p410 is that attribute's state; otherwise, it is the form owner p407 's method p410 attribute's state. The enctype and formenctype content attributes are enumerated attributes p38 with the following keywords and states: The "application/x-www-form-urlencoded" keyword and corresponding state.
410
The "multipart/form-data" keyword and corresponding state. The "text/plain" keyword and corresponding state.
The missing value default for these attributes is the application/x-www-form-urlencoded p410 state. The enctype of an element is one of those three states. If the element is a submit button p347 and has a formenctype p410 attribute, then the element's enctype p411 is that attribute's state; otherwise, it is the form owner p407 's enctype p410 attribute's state. The target and formtarget content attributes, if specified, must have values that are valid browsing context names or keywords p502 . The target of an element is the value of the element's formtarget p411 attribute, if the element is a submit button p347 and has such an attribute; or the value of its form owner p407 's target p411 attribute, if it has such an attribute; or, if the Document p33 contains a base p118 element with a target p119 attribute, then the value of the target p119 attribute of the first such base p118 element; or, if there is no such element, the empty string. The novalidate and formnovalidate content attributes are boolean attributes p38 . If present, they indicate that the form is not to be validated during submission. The no-validate state of an element is true if the element is a submit button p347 and the element's formnovalidate p411 attribute is present, or if the element's form owner p407 's novalidate p411 attribute is present, and false otherwise. This attribute is useful to include "save" buttons on forms that have validation constraints, to allow users to save their progress even though they haven't fully entered the data in the form. The following example shows a simple form that has two required fields. There are three buttons: one to submit the form, which requires both fields to be filled in; one to save the form so that the user can come back and fill it in later; and one to cancel the form altogether. <form action="editor.cgi" method="post"> <p><label>Name: <input required name=fn></label></p> <p><label>Essay: <textarea required name=essay></textarea></label></p> <p><input type=submit name=submit value="Submit essay"></p> <p><input type=submit formnovalidate name=save value="Save essay"></p> <p><input type=submit formnovalidate name=cancel value="Cancel"></p> </form> The action IDL attribute must reflect p62 the content attribute of the same name, except that on getting, when the content attribute is missing or its value is the empty string, the document's address p77 must be returned instead. The target IDL attribute must reflect p62 the content attribute of the same name. The method and enctype IDL attributes must reflect p62 the respective content attributes of the same name, limited to only known values p62 . The encoding IDL attribute must reflect p62 the enctype p410 content attribute, limited to only known values p62 . The noValidate IDL attribute must reflect the novalidate p411 content attribute. The formAction IDL attribute must reflect the formaction p410 content attribute, except that on getting, when the content attribute is missing or its value is the empty string, the document's address p77 must be returned instead. The formEnctype IDL attribute must reflect the formenctype p410 content attribute, limited to only known values p62 . The formMethod IDL attribute must reflect the formmethod p410 content attribute, limited to only known values p62 . The formNoValidate IDL attribute must reflect the formnovalidate p411 content attribute. The formTarget IDL attribute must reflect the formtarget p411 content attribute.
4.10.19.7 Submitting element directionality A form control dirname attribute on a form control element enables the submission of the directionality p94 of the element, and gives the name of the field that contains this value during form submission p416 . If such an attribute is specified, its value must not be the empty string.
411
These methods and attributes expose and control the selection of input p353 and textarea p395 text fields. This box is non-normative. Implementation requirements are given below this box. element . select
p412
()
Selects everything in the text field. element . selectionStart [ = value ] Returns the offset to the start of the selection. Can be set, to change the start of the selection. element . selectionEnd [ = value ] Returns the offset to the end of the selection. Can be set, to change the end of the selection. element . setSelectionRange p412 (start, end) Changes the selection to cover the given substring.
When these methods and attributes are used with input p353 elements while they don't apply, they must raise an INVALID_STATE_ERR p75 exception. Otherwise, they must act as described below. For input p353 elements, these methods and attributes must operate on the element's value p409 . For textarea p395 elements, these methods and attributes must operate on the element's raw value p396 . The select() method must cause the contents of the text field to be fully selected. The selectionStart attribute must, on getting, return the offset (in logical order) to the character that immediately follows the start of the selection. If there is no selection, then it must return the offset (in logical order) to the character that immediately follows the text entry cursor. On setting, it must act as if the setSelectionRange() p412 method had been called, with the new value as the first argument, and the current value of the selectionEnd p412 attribute as the second argument, unless the current value of the selectionEnd p412 is less than the new value, in which case the second argument must also be the new value. The selectionEnd attribute must, on getting, return the offset (in logical order) to the character that immediately follows the end of the selection. If there is no selection, then it must return the offset (in logical order) to the character that immediately follows the text entry cursor. On setting, it must act as if the setSelectionRange() p412 method had been called, with the current value of the selectionStart p412 attribute as the first argument, and new value as the second argument. The setSelectionRange(start, end) method must set the selection of the text field to the sequence of characters starting with the character at the startth position (in logical order) and ending with the character at the (end-1)th position. Arguments greater than the length of the value in the text field must be treated as pointing at the end of the text field. If end is less than or equal to start then the start of the selection and the end of the selection must both be placed immediately before the character with offset end. In UAs where there is no concept of an empty selection, this must set the cursor to be just before the character with offset end. To obtain the currently selected text, the following JavaScript suffices: var selectionText = control.value.substring(control.selectionStart, control.selectionEnd); ...where control is the input p353 or textarea p395 element. Characters with no visible rendering, such as U+200D ZERO WIDTH JOINER, still count as characters. Thus, for instance, the selection can include just an invisible character, and the text insertion cursor can be placed to one side or another of such a character.
4.10.21 Constraints
4.10.21.1 Definitions A listed form-associated element p347 is a candidate for constraint validation except when a condition has barred the element from constraint validation. (For example, an element is barred from constraint validation p412 if it is an output p400 or fieldset p350 element.) An element can have a custom validity error message defined. Initially, an element must have its custom validity error message p412 set to the empty string. When its value is not the empty string, the element is suffering
412
from a custom error p413 . It can be set using the setCustomValidity() p415 method. The user agent should use the custom validity error message p412 when alerting the user to the problem with the control. An element can be constrained in various ways. The following is the list of validity states that a form control can be in, making the control invalid for the purposes of constraint validation. (The definitions below are nonnormative; other parts of this specification define more precisely when each state applies or does not.) Suffering from being missing When a control has no value p409 but has a required attribute (input p353 required p379 , select p387 required p388 , textarea p395 required p397 ). Suffering from a type mismatch When a control that allows arbitrary user input has a value p409 that is not in the correct syntax (E-mail p360 , URL p359 ). Suffering from a pattern mismatch When a control has a value p409 that doesn't satisfy the pattern p380 attribute. Suffering from being too long When a control has a value p409 that is too long for the form control maxlength attribute p410 (input p353 maxlength p380 , textarea p395 maxlength p397 ). Suffering from an underflow When a control has a value p409 that is too low for the min p381 attribute. Suffering from an overflow When a control has a value p409 that is too high for the max p381 attribute. Suffering from a step mismatch When a control has a value p409 that doesn't fit the rules given by the step p381 attribute. Suffering from a custom error When a control's custom validity error message p412 (as set by the element's setCustomValidity() p415 method) is not the empty string. Note: An element can still suffer from these states even when the element is disabled p409 ; thus these states can be represented in the DOM even if validating the form during submission wouldn't indicate a problem to the user. An element satisfies its constraints if it is not suffering from any of the above validity states p413 .
4.10.21.2 Constraint validation When the user agent is required to statically validate the constraints of form p347 element form, it must run the following steps, which return either a positive result (all the controls in the form are valid) or a negative result (there are invalid controls) along with a (possibly empty) list of elements that are invalid and for which no script has claimed responsibility: 1. 2. 3. Let controls be a list of all the submittable elements p347 whose form owner p407 is form, in tree order p29 . Let invalid controls be an initially empty list of elements. For each element field in controls, in tree order p29 , run the following substeps: 1. 2. 3. 4. 5. 6. If field is not a candidate for constraint validation p412 , then move on to the next element. Otherwise, if field satisfies its constraints p413 , then move on to the next element. Otherwise, add field to invalid controls.
If invalid controls is empty, then return a positive result and abort these steps. Let unhandled invalid controls be an initially empty list of elements. For each element field in invalid controls, if any, in tree order p29 , run the following substeps: 1. 2. Fire a simple event p559 named invalid that is cancelable at field. If the event was not canceled, then add field to unhandled invalid controls.
7.
Return a negative result with the list of elements in the unhandled invalid controls list.
413
If a user agent is to interactively validate the constraints of form p347 element form, then the user agent must run the following steps: 1. Statically validate the constraints p413 of form, and let unhandled invalid controls be the list of elements returned if the result was negative. If the result was positive, then return that result and abort these steps. Report the problems with the constraints of at least one of the elements given in unhandled invalid controls to the user. User agents may focus one of those elements in the process, by running the focusing steps p573 for that element, and may change the scrolling position of the document, or perform some other action that brings the element to the user's attention. User agents may report more than one constraint violation. User agents may coalesce related constraint violation reports if appropriate (e.g. if multiple radio buttons in a group p371 are marked as required, only one error need be reported). If one of the controls is not being rendered p708 (e.g. it has the hidden p571 attribute set) then user agents may report a script error. Return a negative result.
2. 3.
4.
4.10.21.3 The constraint validation API This box is non-normative. Implementation requirements are given below this box. element . willValidate p415 Returns true if the element will be validated when the form is submitted; false otherwise. element . setCustomValidity p415 (message) Sets a custom error, so that the element would fail to validate. The given message is the message to be shown to the user when reporting the problem to the user. If the argument is the empty string, clears the custom error. element . validity p415 . valueMissing p415 Returns true if the element has no value but is a required field; false otherwise. element . validity p415 . typeMismatch p415 Returns true if the element's value is not in the correct syntax; false otherwise. element . validity p415 . patternMismatch p415 Returns true if the element's value doesn't match the provided pattern; false otherwise. element . validity p415 . tooLong p415 Returns true if the element's value is longer than the provided maximum length; false otherwise. element . validity p415 . rangeUnderflow p415 Returns true if the element's value is lower than the provided minimum; false otherwise. element . validity p415 . rangeOverflow p415 Returns true if the element's value is higher than the provided maximum; false otherwise. element . validity p415 . stepMismatch p415 Returns true if the element's value doesn't fit the rules given by the step p381 attribute; false otherwise. element . validity p415 . customError p415 Returns true if the element has a custom error; false otherwise. element . validity p415 . valid p415 Returns true if the element's value has no validity problems; false otherwise. valid = element . checkValidity p415 () Returns true if the element's value has no validity problems; false otherwise. Fires an invalid event at the element in the latter case. element . validationMessage p416 Returns the error message that would be shown to the user if the element was to be checked for validity.
414
The willValidate attribute must return true if an element is a candidate for constraint validation p412 , and false otherwise (i.e. false if any conditions are barring it from constraint validation p412 ). The setCustomValidity(message), when invoked, must set the custom validity error message p412 to the value of the given message argument. In the following example, a script checks the value of a form control each time it is edited, and whenever it is not a valid value, uses the setCustomValidity() p415 method to set an appropriate message. <label>Feeling: <input name=f type="text" oninput="check(this)"></label> <script> function check(input) { if (input.value == "good" || input.value == "fine" || input.value == "tired") { input.setCustomValidity('"' + input.value + '" is not a feeling.'); } else { // input is fine -- reset the error message input.setCustomValidity(''); } } </script> The validity attribute must return a ValidityState p415 object that represents the validity states p413 of the element. This object is live p29 , and the same object must be returned each time the element's validity p415 attribute is retrieved. interface ValidityState { readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean readonly attribute boolean };
A ValidityState p415 object has the following attributes. On getting, they must return true if the corresponding condition given in the following list is true, and false otherwise. valueMissing The control is suffering from being missing p413 . typeMismatch The control is suffering from a type mismatch p413 . patternMismatch The control is suffering from a pattern mismatch p413 . tooLong The control is suffering from being too long p413 . rangeUnderflow The control is suffering from an underflow p413 . rangeOverflow The control is suffering from an overflow p413 . stepMismatch The control is suffering from a step mismatch p413 . customError The control is suffering from a custom error p413 . valid None of the other conditions are true. When the checkValidity() method is invoked, if the element is a candidate for constraint validation p412 and does not satisfy its constraints p413 , the user agent must fire a simple event p559 named invalid that is cancelable (but in
415
this case has no default action) at the element and return false. Otherwise, it must only return true without doing anything else. The validationMessage attribute must return the empty string if the element is not a candidate for constraint validation p412 or if it is one but it satisfies its constraints p413 ; otherwise, it must return a suitably localized message that the user agent would show the user if this were the only form control with a validity constraint problem. If the user agent would not actually show a textual message in such a situation (e.g. it would show a graphical cue instead), then the attribute must return a suitably localized message that expresses (one or more of) the validity constraint(s) that the control does not satisfy. If the element is a candidate for constraint validation p412 and is suffering from a custom error p413 , then the custom validity error message p412 should be present in the return value.
4.10.21.4 Security Servers should not rely on client-side validation. Client-side validation can be intentionally bypassed by hostile users, and unintentionally bypassed by users of older user agents or automated tools that do not implement these features. The constraint validation features are only intended to improve the user experience, not to provide any kind of security mechanism.
4.10.22.2 Implicit submission User agents may establish a button p347 in each form as being the form's default button. This should be the first submit button p347 in tree order p29 whose form owner p407 is that form p347 element, but user agents may pick another button if another would be more appropriate for the platform. If the platform supports letting the user submit a form implicitly (for example, on some platforms hitting the "enter" key while a text field is focused implicitly submits the form), then doing so must cause the form's default button p416 's activation behavior p102 , if any, to be run.
416
Note: Consequently, if the default button p416 is disabled p409 , the form is not submitted when such an implicit submission mechanism is used. (A button has no activation behavior p102 when disabled.) If the form has no submit button p347 , then the implicit submission mechanism must just submit p417 the form p347 element from the form p347 element itself.
4.10.22.3 Form submission algorithm When a form p347 element form is submitted from an element submitter (typically a button), optionally with a scripted-submit flag set, the user agent must run the following steps: 1. 2. Let form document be the form's Document p33 . If form document has no associated browsing context p499 or its browsing context p499 had its sandboxed forms browsing context flag p217 set when the Document p33 was created, then abort these steps without doing anything. Let form browsing context be the browsing context p499 of form document. If form is already being submitted (i.e. the form was submitted p417 again while processing the events fired from the next two steps, probably from a script redundantly calling the submit() p349 method on form), then abort these steps. This doesn't affect the earlier instance of this algorithm. If the scripted-submit flag is not set, and the submitter element's no-validate state p411 is false, then interactively validate the constraints p414 of form and examine the result: if the result is negative (the constraint validation concluded that there were invalid fields and probably informed the user of this) then abort these steps. If the scripted-submit flag is not set, then fire a simple event p559 that is cancelable named submit, at form. If the event's default action is prevented (i.e. if the event is canceled) then abort these steps. Otherwise, continue (effectively the default action is to perform the submission). Let controls be a list of all the submittable elements p347 whose form owner p407 is form, in tree order p29 . Let the form data set be a list of name-value-type tuples, initially empty. Constructing the form data set. For each element field in controls, in tree order p29 , run the following substeps: 1. If any of the following conditions are met, then skip these substeps for this element: The field element has a datalist p391 element ancestor. The field element is disabled p409 . The field element is a button p347 but it is not submitter. The field element is an input p353 element whose type p355 attribute is in the Checkbox p370 state and whose checkedness p409 is false. The field element is an input p353 element whose type p355 attribute is in the Radio Button p371 state and whose checkedness p409 is false. The field element is not an input p353 element whose type p355 attribute is in the Image Button p373 state, and either the field element does not have a name p408 attribute specified, or its name p408 attribute's value is the empty string. The field element is an object p222 element that is not using a plugin p29 .
3. 4.
5.
6.
7. 8. 9.
Otherwise, process field as follows: 2. 3. Let type be the value of the type IDL attribute of field. If the field element is an input p353 element whose type p355 attribute is in the Image Button p373 state, then run these further nested substeps: 1. If the field element has a name p408 attribute specified and value is not the empty string, let name be that value followed by a single U+002E FULL STOP character (.). Otherwise, let name be the empty string. Let namex be the string consisting of the concatenation of name and a single U+0078 LATIN SMALL LETTER X character (x).
2.
417
3.
Let namey be the string consisting of the concatenation of name and a single U+0079 LATIN SMALL LETTER Y character (y). The field element is submitter, and before this algorithm was invoked the user indicated a coordinate p374 . Let x be the x-component of the coordinate selected by the user, and let y be the y-component of the coordinate selected by the user. Append an entry to the form data set with the name namex, the value x, and the type type. Append an entry to the form data set with the name namey and the value y, and the type type. Skip the remaining substeps for this element: if there are any more elements in controls, return to the top of the constructing the form data set p417 step, otherwise, jump to the next step in the overall form submission algorithm.
4.
5.
6.
7.
4. 5.
Let name be the value of the field element's name p408 attribute. If the field element is a select p387 element, then for each option p393 element in the select p387 element whose selectedness p393 is true, append an entry to the form data set with the name as the name, the value p393 of the option p393 element as the value, and type as the type. Otherwise, if the field element is an input p353 element whose type p355 attribute is in the Checkbox p370 state or the Radio Button p371 state, then run these further nested substeps: 1. If the field element has a value p357 attribute specified, then let value be the value of that attribute; otherwise, let value be the string "on". Append an entry to the form data set with name as the name, value as the value, and type as the type.
6.
2.
7.
Otherwise, if the field element is an input p353 element whose type p355 attribute is in the File Upload p372 state, then for each file selected p372 in the input p353 element, append an entry to the form data set with the name as the name, the file (consisting of the name, the type, and the body) as the value, and type as the type. If there are no selected files p372 , then append an entry to the form data set with the name as the name, the empty string as the value, and application/octet-stream as the type. Otherwise, if the field element is an object p222 element: try to obtain a form submission value from the plugin p29 , and if that is successful, append an entry to the form data set with name as the name, the returned form submission value as the value, and the string "object" as the type. Otherwise, append an entry to the form data set with name as the name, the value p409 of the field element as the value, and type as the type. If the element has a form control dirname attribute p411 , and that attribute's value is not the empty string, then run these substeps: 1. 2. Let dirname be the value of the element's dirname attribute. Let dir be the string "ltr" if the directionality p94 of the element is 'ltr p94 ', and "rtl" otherwise (i.e. when the directionality p94 of the element is 'rtl p94 '). Append an entry to the form data set with dirname as the name, dir as the value, and the string "direction" as the type.
8.
9.
10.
3.
Note: An element can only have a form control dirname attribute p411 if it is a textarea p395 element or an input p353 element whose type p355 attribute is in either the Text p358 state or the Search p358 state. 10. 11. Let action be the submitter element's action p410 . If action is the empty string, let action be the document's address p77 of the form document. Note: This step is a willful violation p18 of RFC 3986, which would require base URL processing here. This violation is motivated by a desire for compatibility with legacy content. [RFC3986] p784 12. Resolve p55 the URL p55 action, relative to the submitter element. If this fails, abort these steps. Otherwise, let action be the resulting absolute URL p56 .
418
Let scheme be the <scheme> p55 of the resulting absolute URL p56 . Let enctype be the submitter element's enctype p411 . Let method be the submitter element's method p410 . Let target be the submitter element's target p411 . If the user indicated a specific browsing context p499 to use when submitting the form, then let target browsing context be that browsing context p499 . Otherwise, apply the rules for choosing a browsing context given a browsing context name p502 using target as the name and form browsing context as the context in which the algorithm is executed, and let target browsing context be the resulting browsing context p499 . If target browsing context was created in the previous step, or if the form document has not yet completely loaded p687 , then let replace be true. Otherwise, let it be false. Select the appropriate row in the table below based on the value of scheme as given by the first cell of each row. Then, select the appropriate cell on that row based on the value of method as given in the first cell of each column. Then, jump to the steps named in that cell and defined below the table.
GET p410 http https ftp Mutate action URL Mutate action URL Get action URL p419
p419 p419
18.
19.
POST p410 Submit as entity body p419 Submit as entity body p419 Get action URL p419 Get action URL p419 Post to data: p419 Mail as body p420
javascript Get action URL p419 data mailto Get action URL
p419 p420
If scheme is not one of those listed in this table, then the behavior is not defined by this specification. User agents should, in the absence of another specification defining this, act in a manner analogous to that defined in this specification for similar schemes. The behaviors are as follows: Mutate action URL Let query be the result of encoding the form data set using the application/x-www-formurlencoded encoding algorithm p420 , interpreted as a US-ASCII string. Let destination be a new URL p55 that is equal to the action except that its <query> p55 component is replaced by query (adding a U+003F QUESTION MARK character (?) if appropriate). Navigate p520 target browsing context to destination. If replace is true, then target browsing context must be navigated with replacement enabled p528 . Submit as entity body Let entity body be the result of encoding the form data set using the appropriate form encoding algorithm p420 . Let MIME type be determined as follows: If enctype is application/x-www-form-urlencoded p410 Let MIME type be "application/x-www-form-urlencoded". If enctype is multipart/form-data p411 Let MIME type be "multipart/form-data". If enctype is text/plain p411 Let MIME type be "text/plain". Otherwise, navigate p520 target browsing context to action using the HTTP method given by method and with entity body as the entity body, of type MIME type. If replace is true, then target browsing context must be navigated with replacement enabled p528 . Get action URL Navigate p520 target browsing context to action. If replace is true, then target browsing context must be navigated with replacement enabled p528 . Post to data: Let data be the result of encoding the form data set using the appropriate form encoding algorithm p420 . If action contains the string "%%%%" (four U+0025 PERCENT SIGN characters), then %-escape all bytes in data that, if interpreted as US-ASCII, do not match the unreserved production in the URI
419
Generic Syntax, and then, treating the result as a US-ASCII string, further %-escape all the U+0025 PERCENT SIGN characters in the resulting string and replace the first occurrence of "%%%%" in action with the resulting double-escaped string. [RFC3986] p784 Otherwise, if action contains the string "%%" (two U+0025 PERCENT SIGN characters in a row, but not four), then %-escape all characters in data that, if interpreted as US-ASCII, do not match the unreserved production in the URI Generic Syntax, and then, treating the result as a US-ASCII string, replace the first occurrence of "%%" in action with the resulting escaped string. [RFC3986] p784 Navigate p520 target browsing context to the potentially modified action (which will be a data: URL p28 ). If replace is true, then target browsing context must be navigated with replacement enabled p528 . Mail with headers Let headers be the resulting encoding the form data set using the application/x-www-formurlencoded encoding algorithm p420 , interpreted as a US-ASCII string. Replace occurrences of U+002B PLUS SIGN characters (+) in headers with the string "%20". Let destination consist of all the characters from the first character in action to the character immediately before the first U+003F QUESTION MARK character (?), if any, or the end of the string if there are none. Append a single U+003F QUESTION MARK character (?) to destination. Append headers to destination. Navigate p520 target browsing context to destination. If replace is true, then target browsing context must be navigated with replacement enabled p528 . Mail as body Let body be the resulting encoding the form data set using the appropriate form encoding algorithm p420 and then %-escaping all the bytes in the resulting byte string that, when interpreted as US-ASCII, do not match the unreserved production in the URI Generic Syntax. [RFC3986] p784 Let destination have the same value as action. If destination does not contain a U+003F QUESTION MARK character (?), append a single U+003F QUESTION MARK character (?) to destination. Otherwise, append a single U+0026 AMPERSAND character (&). Append the string "body=" to destination. Append body, interpreted as a US-ASCII string, to destination. Navigate p520 target browsing context to destination. If replace is true, then target browsing context must be navigated with replacement enabled p528 . The appropriate form encoding algorithm is determined as follows: If enctype is application/x-www-form-urlencoded p410 Use the application/x-www-form-urlencoded encoding algorithm p420 . If enctype is multipart/form-data p411 Use the multipart/form-data encoding algorithm p421 . If enctype is text/plain p411 Use the text/plain encoding algorithm p422 .
4.10.22.4 URL-encoded form data The application/x-www-form-urlencoded encoding algorithm is as follows: 1. 2. Let result be the empty string. If the form p347 element has an accept-charset p348 attribute, then, taking into account the characters found in the form data set's names and values, and the character encodings supported by the user agent, select a character encoding from the list given in the form p347 's accept-charset p348 attribute that is an ASCII-compatible character encoding p30 . If none of the encodings are supported, or if none are listed, then let the selected character encoding be UTF-8.
420
Otherwise, if the document's character encoding p81 is an ASCII-compatible character encoding p30 , then that is the selected character encoding. Otherwise, let the selected character encoding be UTF-8. 3. 4. Let charset be the preferred MIME name p30 of the selected character encoding. For each entry in the form data set, perform these substeps: 1. 2. 3. If the entry's name is "_charset_ p409 " and its type is "hidden", replace its value with charset. If the entry's type is "file", replace its value with the file's filename only. For each character in the entry's name and value that cannot be expressed using the selected character encoding, replace the character by a string consisting of a U+0026 AMPERSAND character (&), a U+0023 NUMBER SIGN character (#), one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) representing the Unicode code point of the character in base ten, and finally a U+003B SEMICOLON character (;). For each character in the entry's name and value, apply the appropriate subsubsteps from the following list: The character is a U+0020 SPACE character Replace the character with a single U+002B PLUS SIGN character (+). If the character isn't in the range U+0020, U+002A, U+002D, U+002E, U+0030 to U+0039, U+0041 to U+005A, U+005F, U+0061 to U+007A Replace the character with a string formed as follows: 1. 2. Let s be an empty string. For each byte b of the character when expressed in the selected character encoding in turn, run the appropriate subsubsubstep from the list below: If the byte is in the range 0x20, 0x2A, 0x2D, 0x2E, 0x30 to 0x39, 0x41 to 0x5A, 0x5F, 0x61 to 0x7A Append to s the Unicode character with the codepoint equal to the byte. Otherwise Append to the string a U+0025 PERCENT SIGN character (%) followed by two characters in the ranges U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) and U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F representing the hexadecimal value of the byte (zero-padded if necessary). Otherwise Leave the character as is. 5. If the entry's name is "isindex p409 ", its type is "text", and this is the first entry in the form data set, then append the value to result and skip the rest of the substeps for this entry, moving on to the next entry, if any, or the next step in the overall algorithm otherwise. If this is not the first entry, append a single U+0026 AMPERSAND character (&) to result. Append the entry's name to result. Append a single U+003D EQUALS SIGN character (=) to result. Append the entry's value to result.
4.
6. 7. 8. 9. 5.
4.10.22.5 Multipart form data The multipart/form-data encoding algorithm is as follows: 1. 2. Let result be the empty string. If the algorithm was invoked with an explicit character encoding, let the selected character encoding be that encoding. (This algorithm is used by other specifications, which provide an explicit character encoding to avoid the dependency on the form p347 element described in the next paragraph.) Otherwise, if the form p347 element has an accept-charset p348 attribute, then, taking into account the characters found in the form data set's names and values, and the character encodings supported by
421
the user agent, select a character encoding from the list given in the form p347 's accept-charset p348 attribute that is an ASCII-compatible character encoding p30 . If none of the encodings are supported, or if none are listed, then let the selected character encoding be UTF-8. Otherwise, if the document's character encoding p81 is an ASCII-compatible character encoding p30 , then that is the selected character encoding. Otherwise, let the selected character encoding be UTF-8. 3. 4. Let charset be the preferred MIME name p30 of the selected character encoding. For each entry in the form data set, perform these substeps: 1. 2. If the entry's name is "_charset_ p409 " and its type is "hidden", replace its value with charset. For each character in the entry's name and value that cannot be expressed using the selected character encoding, replace the character by a string consisting of a U+0026 AMPERSAND character (&), a U+0023 NUMBER SIGN character (#), one or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) representing the Unicode code point of the character in base ten, and finally a U+003B SEMICOLON character (;).
5.
Encode the (now mutated) form data set using the rules described by RFC 2388, Returning Values from Forms: multipart/form-data, and return the resulting byte stream. [RFC2388] p784 Each entry in the form data set is a field, the name of the entry is the field name and the value of the entry is the field value. The order of parts must be the same as the order of fields in the form data set. Multiple entries with the same name must be treated as distinct fields. The parts of the generated multipart/form-data resource that correspond to non-file fields must not have a Content-Type p61 header specified. Their names and values must be encoded using the character encoding selected above (field names in particular do not get converted to a 7-bit safe encoding as suggested in RFC 2388).
4.10.22.6 Plain text form data The text/plain encoding algorithm is as follows: 1. 2. Let result be the empty string. If the form p347 element has an accept-charset p348 attribute, then, taking into account the characters found in the form data set's names and values, and the character encodings supported by the user agent, select a character encoding from the list given in the form p347 's accept-charset p348 attribute. If none of the encodings are supported, or if none are listed, then let the selected character encoding be UTF-8. Otherwise, the selected character encoding is the document's character encoding p81 . 3. 4. 5. 6. Let charset be the preferred MIME name p30 of the selected character encoding. If the entry's name is "_charset_ p409 " and its type is "hidden", replace its value with charset. If the entry's type is "file", replace its value with the file's filename only. For each entry in the form data set, perform these substeps: 1. 2. 3. 4. 7. Append the entry's name to result. Append a single U+003D EQUALS SIGN character (=) to result. Append the entry's value to result. Append a U+000D CARRIAGE RETURN (CR) U+000A LINE FEED (LF) character pair to result.
Encode result using the selected character encoding and return the resulting byte stream.
422
Each resettable element p347 defines its own reset algorithm. Changes made to form controls as part of these algorithms do not count as changes caused by the user (and thus, e.g., do not cause input events to fire).
3.
423
<dt>Local filename:</dt> <dd>/home/rpausch/raycd.m4v</dd> <dt>Remote filename:</dt> <dd>/var/www/lectures/raycd.m4v</dd> <dt>Duration:</dt> <dd>01:16:27</dd> <dt>Color profile:</dt> <dd>SD (6-1-6)</dd> <dt>Dimensions:</dt> <dd>320240</dd> </dl> </details> </section> The following shows how a details p423 element can be used to hide some controls by default: <details> <summary><label for=fn>Name & Extension:</label></summary> <p><input type=text id=fn name=fn value="Pillar Magazine.pdf"> <p><label><input type=checkbox name=ext checked> Hide extension</label> </details> One could use this in conjuction with other details p423 in a list to allow the user to collapse a set of fields down to a small set of headings, with the ability to open each one.
424
425
In these examples, the summary really just summarises what the controls can change, and not the actual values, which is less than ideal.
426
427
Note: The distinction between disabled p427 and hidden p571 is subtle. A command would be disabled if, in the same context, it could be enabled if only certain aspects of the situation were changed. A command would be marked as hidden if, in that situation, the command will never be enabled. For example, in the context menu for a water faucet, the command "open" might be disabled if the faucet is already open, but the command "eat" would be marked hidden since the faucet could never be eaten. The checked attribute is a boolean attribute p38 that, if present, indicates that the command is selected. The attribute must be omitted unless the type p427 attribute is in either the Checkbox p427 state or the Radio p427 state. The radiogroup attribute gives the name of the group of commands that will be toggled when the command itself is toggled, for commands whose type p427 attribute has the value "radio". The scope of the name is the child list of the parent element. The attribute must be omitted unless the type p427 attribute is in the Radio p427 state. The type IDL attribute must reflect p62 the content attribute of the same name, limited to only known values p62 . The label, icon, disabled, checked, and radiogroup IDL attributes must reflect p62 the respective content attributes of the same name. The element's activation behavior p102 depends on the value of the type p427 attribute of the element, as follows:
p427 attribute is in the Checkbox p427 state If the type
If the element has a checked p428 attribute, the UA must remove that attribute. Otherwise, the UA must add a checked p428 attribute, with the literal value checked. The UA must then fire a click event p559 at the element.
p427 attribute is in the Radio p427 state If the type
If the element has a parent, then the UA must walk the list of child nodes of that parent element, and for each node that is a command p427 element, if that element has a radiogroup p428 attribute whose value exactly matches the current element's (treating missing radiogroup p428 attributes as if they were the empty string), and has a checked p428 attribute, must remove that attribute. Then, the element's checked p428 attribute attribute must be set to the literal value checked and the user agent must fire a click event p559 at the element. Otherwise The element has no activation behavior p102 . Note: Firing a synthetic click p33 event at the element does not cause any of the actions described above to happen. Note: command p427 elements are not rendered unless they form part of a menu p428 . Here is an example of a toolbar with three buttons that let the user toggle between left, center, and right alignment. One could imagine such a toolbar as part of a text editor. The toolbar also has a separator followed by another button labeled "Publish", though that button is disabled. <menu type="toolbar"> <command type="radio" radiogroup="alignment" checked="checked" label="Left" icon="icons/alL.png" onclick="setAlign('left')"> <command type="radio" radiogroup="alignment" label="Center" icon="icons/alC.png" onclick="setAlign('center')"> <command type="radio" radiogroup="alignment" label="Right" icon="icons/alR.png" onclick="setAlign('right')"> <hr> <command type="command" disabled label="Publish" icon="icons/pub.png" onclick="publish()"> </menu>
428
Content model: Either: Zero or more li p166 elements. Or: Flow content p100 . Content attributes: Global attributes p90 type p429 label p429 DOM interface: interface HTMLMenuElement : HTMLElement { attribute DOMString type; attribute DOMString label; }; The menu p428 element represents a list of commands. The type attribute is an enumerated attribute p38 indicating the kind of menu being declared. The attribute has three states. The context keyword maps to the context menu state, in which the element is declaring a context menu. The toolbar keyword maps to the toolbar state, in which the element is declaring a toolbar. The attribute may also be omitted. The missing value default is the list state, which indicates that the element is merely a list of commands that is neither declaring a context menu nor defining a toolbar. If a menu p428 element's type p429 attribute is in the context menu p429 state, then the element represents p708 the commands of a context menu, and the user can only interact with the commands if that context menu is activated. If a menu p428 element's type p429 attribute is in the toolbar p429 state, then the element represents p708 a list of active commands that the user can immediately interact with. If a menu p428 element's type p429 attribute is in the list p429 state, then the element either represents p708 an unordered list of items (each represented by an li p166 element), each of which represents a command that the user can perform or activate, or, if the element has no li p166 element children, flow content p100 describing available commands. The label attribute gives the label of the menu. It is used by user agents to display nested menus in the UI. For example, a context menu containing another menu would use the nested menu's label p429 attribute for the submenu's menu label. The type and label IDL attributes must reflect p62 the respective content attributes of the same name.
4.11.4.1 Introduction This section is non-normative. The menu p428 element is used to define context menus and toolbars. For example, the following represents a toolbar with three menu buttons on it, each of which has a dropdown menu with a series of options: <menu type="toolbar"> <li> <menu label="File"> <button type="button" onclick="fnew()">New...</button> <button type="button" onclick="fopen()">Open...</button> <button type="button" onclick="fsave()">Save</button> <button type="button" onclick="fsaveas()">Save as...</button> </menu> </li> <li> <menu label="Edit"> <button type="button" onclick="ecopy()">Copy</button> <button type="button" onclick="ecut()">Cut</button> <button type="button" onclick="epaste()">Paste</button> </menu> </li> <li> <menu label="Help"> <li><a href="help.html">Help</a></li>
429
<li><a href="about.html">About</a></li> </menu> </li> </menu> In a supporting user agent, this might look like this:
In a legacy user agent, the above would look like a bulleted list with three items, the first of which has four buttons, the second of which has three, and the third of which has two nested bullet points with two items consisting of links. The following implements a similar toolbar, with a single button whose values, when selected, redirect the user to Web sites. <form action="redirect.cgi"> <menu type="toolbar"> <label for="goto">Go to...</label> <menu label="Go"> <select id="goto"> <option value="" selected="selected"> Select site: </option> <option value="http://www.apple.com/"> Apple </option> <option value="http://www.mozilla.org/"> Mozilla </option> <option value="http://www.opera.com/"> Opera </option> </select> <span><input type="submit" value="Go"></span> </menu> </menu> </form> The behavior in supporting user agents is similar to the example above, but here the legacy behavior consists of a single select p387 element with a submit button. The submit button doesn't appear in the toolbar, because it is not a direct child of the menu p428 element or of its li p166 children.
4.11.4.2 Building menus and toolbars A menu (or toolbar) consists of a list of zero or more of the following components: Commands p432 , which can be marked as default commands Separators Other menus (which allows the list to be nested)
The list corresponding to a particular menu p428 element is built by iterating over its child nodes. For each child node in tree order p29 , the required behavior depends on what the node is, as follows:
p432 An element that defines a command
Append a separator to the menu, then iterate over the children of the menu p428 or select p387 element, then append another separator.
430
p428 element with a label p429 attribute A menu p392 element with a label p429 attribute An optgroup
Append a submenu to the menu, using the value of the element's label attribute as the label of the menu. The submenu must be constructed by taking the element and creating a new menu for it using the complete process described in this section. Any other node Ignore p29 the node. Once all the nodes have been processed as described above, the user agent must the post-process the menu as follows: 1. Except for separators, any menu item with no label, or whose label is the empty string, must be removed. Any sequence of two or more separators in a row must be collapsed to a single separator. Any separator at the start or end of the menu must be removed.
2. 3.
4.11.4.3 Context menus The contextmenu attribute gives the element's context menu p431 . The value must be the ID p92 of a menu p428 element in the DOM. If the node that would be obtained by the invoking the getElementById() p33 method using the attribute's value as the only argument is null or not a menu p428 element, then the element has no assigned context menu. Otherwise, the element's assigned context menu is the element so identified. When an element's context menu is requested (e.g. by the user right-clicking the element, or pressing a context menu key), the user agent must apply the appropriate rules from the following list: If the user requested a context menu using a pointing device The user agent must dispatch an event with the name contextmenu, that bubbles and is cancelable, and that uses the MouseEvent interface, at the element for which the menu was requested. The context information of the event must be set to the same values as the last MouseEvent user interaction event that was dispatched as part of the gesture that that was interpreted as a request for the context menu. Otherwise The user agent must fire a synthetic mouse event named contextmenu p559 that bubbles and is cancelable at the element for which the menu was requested. Note: Typically, therefore, the firing of the contextmenu event will be the default action of a mouseup or keyup event. The exact sequence of events is UA-dependent, as it will vary based on platform conventions. The default action of the contextmenu event depends on whether the element or one of its ancestors has a context menu assigned (using the contextmenu p431 attribute) or not. If there is no context menu assigned, the default action must be for the user agent to show its default context menu, if it has one. If the element or one of its ancestors does have a context menu assigned, then the user agent must fire a simple event p559 named show at the menu p428 element of the context menu of the nearest ancestor (including the element itself) with one assigned. The default action of this event is that the user agent must show a context menu built p430 from the menu p428 element. The user agent may also provide access to its default context menu, if any, with the context menu shown. For example, it could merge the menu items from the two menus together, or provide the page's context menu as a submenu of the default menu. If the user dismisses the menu without making a selection, nothing in particular happens. If the user selects a menu item that represents a command p432 , then the UA must invoke that command's Action p432 . Context menus must not, while being shown, reflect changes in the DOM; they are constructed as the default action of the show event and must remain as constructed until dismissed. User agents may provide means for bypassing the context menu processing model, ensuring that the user can always access the UA's default context menus. For example, the user agent could handle right-clicks that have the Shift key depressed in such a way that it does not fire the contextmenu event and instead always shows the default context menu. The contextMenu attribute must reflect p62 the contextmenu p431 content attribute.
431
Here is an example of a context menu for an input control: <form name="npc"> <label>Character name: <input name=char type=text contextmenu=namemenu required></label> <menu type=context id=namemenu> <command label="Pick random name" onclick="document.forms.npc.elements.char.value = getRandomName()"> <command label="Prefill other fields based on name" onclick="prefillFields(document.forms.npc.elements.char.value)"> </menu> </form> This adds two items to the control's context menu, one called "Pick random name", and one called "Prefill other fields based on name". They invoke scripts that are not shown in the example above.
4.11.4.4 Toolbars When a menu p428 element has a type p429 attribute in the toolbar p429 state, then the user agent must build p430 the menu for that menu p428 element, and use the result in the rendering. The user agent must reflect changes made to the menu p428 's DOM, by immediately rebuilding p430 the menu.
4.11.5 Commands
A command is the abstraction behind menu items, buttons, and links. Commands are defined to have the following facets: Type The kind of command: "command", meaning it is a normal command; "radio", meaning that triggering the command will, amongst other things, set the Checked State p432 to true (and probably uncheck some other commands); or "checkbox", meaning that triggering the command will, amongst other things, toggle the value of the Checked State p432 . ID The name of the command, for referring to the command from the markup or from script. If a command has no ID, it is an anonymous command. Label The name of the command as seen by the user. Hint A helpful or descriptive string that can be shown to the user. Icon An absolute URL p56 identifying a graphical image that represents the action. A command might not have an Icon. Access Key A key combination selected by the user agent that triggers the command. A command might not have an Access Key. Hidden State Whether the command is hidden or not (basically, whether it should be shown in menus). Disabled State Whether the command is relevant and can be triggered or not. Checked State Whether the command is checked or not. Action The actual effect that triggering the command will have. This could be a scripted event handler, a URL p55 to which to navigate p520 , or a form submission. These facets are exposed on elements using the command API: This box is non-normative. Implementation requirements are given below this box.
432
element . commandType p433 Exposes the Type p432 facet of the command. element . id p92 Exposes the ID p432 facet of the command. element . label p433 Exposes the Label p432 facet of the command. element . title p92 Exposes the Hint p432 facet of the command. element . icon p433 Exposes the Icon p432 facet of the command. element . accessKeyLabel p577 Exposes the Access Key p432 facet of the command. element . hidden p571 Exposes the state of the element's hidden p571 attribute, which is generally equivalent to the Hidden State p432 facet of the command. For label p352 and legend p351 elements (used in conjunction with the accesskey p575 attribute), the Hidden State p432 facet is derived from another element (the one that the assigned access key p576 will trigger), and cannot be directly accessed from the element. element . disabled p433 Exposes the Disabled State p432 facet of the command. element . checked p433 Exposes the Checked State p432 facet of the command. element . click p571 () Triggers the Action p432 of the command.
The commandType attribute must return a string whose value is either "command", "radio", or "checkbox", depending on whether the Type p432 of the command defined by the element is "command", "radio", or "checkbox" respectively. If the element does not define a command, it must return null. The label attribute must return the command's Label p432 , or null if the element does not define a command or does not specify a Label p432 . This attribute will be shadowed by the label IDL attribute on various elements. The icon attribute must return the absolute URL p56 of the command's Icon p432 . If the element does not specify an icon, or if the element does not define a command, then the attribute must return null. This attribute will be shadowed by the icon p428 IDL attribute on command p427 elements. The disabled attribute must return true if the command's Disabled State p432 is that the command is disabled, and false if the command is not disabled. This attribute is not affected by the command's Hidden State p432 . If the element does not define a command, the attribute must return false. This attribute will be shadowed by the disabled IDL attribute on various elements. The checked attribute must return true if the command's Checked State p432 is that the command is checked, and false if it is that the command is not checked. If the element does not define a command, the attribute must return false. This attribute will be shadowed by the checked IDL attribute on input p353 and command p427 elements. Note: The ID p432 facet is exposed by the id p92 IDL attribute, the Hint p432 facet is exposed by the title p92 IDL attribute, the AccessKey p432 facet is exposed by the accessKeyLabel p577 IDL attribute, and the Hidden State p432 facet is exposed by the hidden p571 IDL attribute.
This box is non-normative. Implementation requirements are given below this box. document . commands
p434
Returns an HTMLCollection p64 of the elements in the Document p33 that define commands and have IDs.
433
The commands attribute of the document's HTMLDocument p77 interface must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only elements that define commands p432 and have IDs p432 . User agents may expose the commands p432 whose Hidden State p432 facet is false (visible), e.g. in the user agent's menu bar. User agents are encouraged to do this especially for commands that have Access Keys p432 , as a way to advertise those keys to the user.
4.11.5.1 Using the a element to define a command An a p173 element with an href p440 attribute defines a command p432 . The Type p432 of the command is "command". The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command is the string given by the element's textContent p33 IDL attribute. The Hint p432 of the command is the value of the title p92 attribute of the element. If the attribute is not present, the Hint p432 is the empty string. The Icon p432 of the command is the absolute URL p56 obtained from resolving p55 the value of the src p200 attribute of the first img p199 element descendant of the element, relative to that element, if there is such an element and resolving its attribute is successful. Otherwise, there is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 , if any. The Hidden State p432 of the command is true (hidden) if the element has a hidden p571 attribute, and false otherwise. The Disabled State p432 facet of the command is always false. (The command is always enabled.) The Checked State p432 of the command is always false. (The command is never checked.) The Action p432 of the command is to fire a click event p559 at the element.
4.11.5.2 Using the button element to define a command A button p385 element always defines a command p432 . The Type p432 , ID p432 , Label p432 , Hint p432 , Icon p432 , Access Key p432 , Hidden State p432 , Checked State p432 , and Action p432 facets of the command are determined as for a elements p434 (see the previous section). The Disabled State p432 of the command mirrors the disabled p409 state of the button.
4.11.5.3 Using the input element to define a command An input p353 element whose type p355 attribute is in one of the Submit Button p373 , Reset Button p375 , Image Button p373 , Button p375 , Radio Button p371 , or Checkbox p370 states defines a command p432 . The Type p432 of the command is "radio" if the type p355 attribute is in the Radio Button p371 state, "checkbox" if the type p355 attribute is in the Checkbox p370 state, and "command" otherwise. The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command depends on the Type of the command: If the Type p432 is "command", then it is the string given by the value p357 attribute, if any, and a UA-dependent, locale-dependent value that the UA uses to label the button itself if the attribute is absent. Otherwise, the Type p432 is "radio" or "checkbox". If the element is a labeled control p352 , the textContent p33 of the first label p352 element in tree order p29 whose labeled control p352 is the element in question is the Label p432 (in DOM terms, this is the string given by element.labels[0].textContent). Otherwise, the value of the value p357 attribute, if present, is the Label p432 . Otherwise, the Label p432 is the empty string. The Hint p432 of the command is the value of the title p92 attribute of the input p353 element. If the attribute is not present, the Hint p432 is the empty string. If the element's type p355 attribute is in the Image Button p373 state, and the element has a src p200 attribute, and that attribute's value can be successfully resolved p55 relative to the element, then the Icon p432 of the command is
434
the absolute URL p56 obtained from resolving that attribute that way. Otherwise, there is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 , if any. The Hidden State p432 of the command is true (hidden) if the element has a hidden p571 attribute, and false otherwise. The Disabled State p432 of the command mirrors the disabled p409 state of the control. The Checked State p432 of the command is true if the command is of Type p432 "radio" or "checkbox" and the element is checked p409 attribute, and false otherwise. The Action p432 of the command, if the element has a defined activation behavior p102 , is to run synthetic click activation steps p101 on the element. Otherwise, it is just to fire a click event p559 at the element.
4.11.5.4 Using the option element to define a command An option p393 element with an ancestor select p387 element and either no value p393 attribute or a value p393 attribute that is not the empty string defines a command p432 . The Type p432 of the command is "radio" if the option p393 's nearest ancestor select p387 element has no multiple p388 attribute, and "checkbox" if it does. The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command is the value of the option p393 element's label p393 attribute, if there is one, or the value of the option p393 element's textContent p33 IDL attribute if there isn't. The Hint p432 of the command is the string given by the element's title p92 attribute, if any, and the empty string if the attribute is absent. There is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 , if any. The Hidden State p432 of the command is true (hidden) if the element has a hidden p571 attribute, and false otherwise. The Disabled State p432 of the command is true (disabled) if the element is disabled p393 or if its nearest ancestor select p387 element is disabled p409 , and false otherwise. The Checked State p432 of the command is true (checked) if the element's selectedness p393 is true, and false otherwise. The Action p432 of the command depends on its Type p432 . If the command is of Type p432 "radio" then it must pick p389 the option p393 element. Otherwise, it must toggle p389 the option p393 element.
4.11.5.5 Using the command element to define a command A command p427 element defines a command p432 . The Type p432 of the command is "radio" if the command p427 's type p427 attribute is "radio", "checkbox" if the attribute's value is "checkbox", and "command" otherwise. The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command is the value of the element's label p427 attribute, if there is one, or the empty string if it doesn't. The Hint p432 of the command is the string given by the element's title p427 attribute, if any, and the empty string if the attribute is absent. The Icon p432 for the command is the absolute URL p56 obtained from resolving p55 the value of the element's icon p427 attribute, relative to the element, if it has such an attribute and resolving it is successful. Otherwise, there is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 , if any. The Hidden State p432 of the command is true (hidden) if the element has a hidden p571 attribute, and false otherwise.
435
The Disabled State p432 of the command is true (disabled) if the element has a disabled p427 attribute, and false otherwise. The Checked State p432 of the command is true (checked) if the element has a checked p428 attribute, and false otherwise. The Action p432 of the command, if the element has a defined activation behavior p102 , is to run synthetic click activation steps p101 on the element. Otherwise, it is just to fire a click event p559 at the element.
4.11.5.6 Using the accesskey attribute on a label element to define a command A label p352 element that has an assigned access key p576 and a labeled control p352 and whose labeled control p352 defines a command p432 , itself defines a command p432 . The Type p432 of the command is "command". The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command is the string given by the element's textContent p33 IDL attribute. The Hint p432 of the command is the value of the title p92 attribute of the element. There is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 . The Hidden State p432 , Disabled State p432 , and Action p432 facets of the command are the same as the respective facets of the element's labeled control p352 . The Checked State p432 of the command is always false. (The command is never checked.)
4.11.5.7 Using the accesskey attribute on a legend element to define a command A legend p351 element that has an assigned access key p576 and is a child of a fieldset p350 element that has a descendant that is not a descendant of the legend p351 element and is neither a label p352 element nor a legend p351 element but that defines a command p432 , itself defines a command p432 . The Type p432 of the command is "command". The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command is the string given by the element's textContent p33 IDL attribute. The Hint p432 of the command is the value of the title p92 attribute of the element. There is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 . The Hidden State p432 , Disabled State p432 , and Action p432 facets of the command are the same as the respective facets of the first element in tree order p29 that is a descendant of the parent of the legend p351 element that defines a command p432 but is not a descendant of the legend p351 element and is neither a label p352 nor a legend p351 element. The Checked State p432 of the command is always false. (The command is never checked.)
4.11.5.8 Using the accesskey attribute to define a command on other elements An element that has an assigned access key p576 defines a command p432 . If one of the other sections that define elements that define commands p432 define that this element defines a command p432 , then that section applies to this element, and this section does not. Otherwise, this section applies to that element. The Type p432 of the command is "command". The ID p432 of the command is the value of the id p92 attribute of the element, if the attribute is present and not empty. Otherwise the command is an anonymous command p432 . The Label p432 of the command depends on the element. If the element is a labeled control p352 , the textContent p33 of the first label p352 element in tree order p29 whose labeled control p352 is the element in question is the Label p432
436
(in DOM terms, this is the string given by element.labels[0].textContent). Otherwise, the Label p432 is the textContent p33 of the element itself. The Hint p432 of the command is the value of the title p92 attribute of the element. If the attribute is not present, the Hint p432 is the empty string. There is no Icon p432 for the command. The AccessKey p432 of the command is the element's assigned access key p576 . The Hidden State p432 of the command is true (hidden) if the element has a hidden p571 attribute, and false otherwise. The Disabled State p432 facet of the command is always false. (The command is always enabled.) The Checked State p432 of the command is always false. (The command is never checked.) The Action p432 of the command is to run the following steps: 1. 2. If the element is focusable p573 , run the focusing steps p573 for the element. If the element has a defined activation behavior p102 , run synthetic click activation steps p101 on the element. Otherwise, if the element does not have a defined activation behavior p102 , fire a click event p559 at the element.
3.
File system File system. RS232 USB RS232 device. USB device.
** **
processing model: 'change' event fires once user selects a new device; .data is set to new Stream, LocalFS, USB, or RS232 object as appropriate.
437
<p>To start chatting, select a video camera: <device type=media onchange="update(this.data)"></p> <video autoplay></video> <script> function update(stream) { document.getElementsByTagName('video')[0].src = stream.url; } </script>
4.11.6.1 Stream API The Stream p438 interface is used to represent streams. interface Stream { readonly attribute DOMString url; StreamRecorder record(); }; The url attribute must return a File URN representing the stream. [FILEAPI] p782 For audio and video streams, the stream must be in a format supported by the user agent for use in audio p231 and video p228 elements. ** This will be pinned down to a specific codec. When the record() method is invoked, the user agent must return a new StreamRecorder p438 object associated with the stream. interface StreamRecorder { File stop(); }; The stop() method must return a new File object representing the data that was streamed between the creation of the StreamRecorder p438 object and the invocation of the stop() p438 method. [FILEAPI] p782 For audio and video streams, the file must be in a format supported by the user agent for use in audio p231 and video p228 elements. ** This again will be pinned down to a specific codec.
4.11.6.2 Peer-to-peer connections ** ** This section will be moved to a more appropriate location in due course; it is here currently to keep it near the device p437 element to allow reviewers to look at it. [Constructor(in DOMString serverConfiguration)] interface ConnectionPeer { void sendText(in DOMString text, in optional boolean unimportant); // if second arg is true, then use unreliable low-latency transport (UDP-like), otherwise guarantee delivery (TCP-like) attribute Function ontext; // receiving void sendBitmap(in HTMLImageElement image); attribute Function onbitmap; // receiving void sendFile(in File file); attribute Function onfile; // receiving void addStream(in Stream stream); void removeStream(in Stream stream); readonly attribute Stream[] localStreams; readonly attribute Stream[] remoteStreams; attribute Function onstream; // receiving void getLocalConfiguration(in ConnectionPeerConfigurationCallback callback); // maybe this should be in the constructor, or be an event
438
void addRemoteConfiguration(in DOMString configuration, in optional DOMString remoteOrigin); // remote origin is assumed to be same-origin if not specified. If specified, has to match remote origin (checked in handshake). Should support leading "*." to mean "any subdomain of". void close(); // disconnects and stops listening attribute Function onconnect; attribute Function onerror; attribute Function ondisconnect; }; [Callback=FunctionOnly, NoInterfaceObject] interface ConnectionPeerConfigurationCallback { void handleEvent(in ConnectionPeer server, in DOMString configuration); }; ** ...
**
This relies on some currently hypothetical other standard to define: The format of server configuration strings. The format of client configuration strings. The protocols that clients use to talk to third-party servers mentioned in the server configuration strings. The protocols that clients use to talk to each other.
**
When two peers decide they are going to set up a connection to each other, they both go through these steps. The serverConfig comes from a third-party server they can use to get things like their public IP address or to set up NAT traversal. They also have to send their respective configuration to each other using the same out-of-band mechanism they used to establish that they were going to communicate in the first place. var serverConfig = ...; // configuration string obtained from server // contains details such as the IP address of a server that can speak some // protocol to help the client determine its public IP address, route packets // if necessary, etc. var local = new ConnectionPeer(serverConfig); local.getLocalConfiguration(function (configuration) { if (configuration != '') { ...; // send configuration to other peer using out-of-band mechanism } else { // we've exhausted our options; wait for connection } }); function ... (configuration) { // called whenever we get configuration information out-of-band local.addRemoteConfiguration(configuration); } local.onconnect = function (event) { // we are connected! local.sendText('Hello'); local.addStream(...); // send video local.onstream = function (event) { // receive video // (videoElement is some <video> element) if (local.remoteStreams.length > 0) videoElement.src = local.remoteStreams[0].url; }; };
439
Warning! To prevent network sniffing from allowing a fourth party to establish a connection to a peer using the information sent out-of-band to the other peer and thus spoofing the client, the configuration information should always be transmitted using an encrypted connection.
4.12 Links
4.12.1 Introduction
Links are a conceptual construct, created by a p173 , area p314 , and link p119 elements, that represent p708 a connection between two resources, one of which is the current Document p33 . There are two kinds of links in HTML: Links to external resources These are links to resources that are to be used to augment the current document, generally automatically processed by the user agent. Hyperlinks These are links to other resources that are generally exposed to the user by the user agent so that the user can cause the user agent to navigate p520 to those resources, e.g. to visit them in a browser or download them. For link p119 elements with an href p120 attribute and a rel p120 attribute, links must be created for the keywords of the rel p120 attribute, as defined for those keywords in the link types p442 section. Similarly, for a p173 and area p314 elements with an href p440 attribute and a rel p440 attribute, links must be created for the keywords of the rel p440 attribute as defined for those keywords in the link types p442 section. Unlike link p119 elements, however, a p173 and area p314 element with an href p440 attribute that either do not have a rel p440 attribute, or whose rel p440 attribute has no keywords that are defined as specifying hyperlinks p440 , must also create a hyperlink p440 . This implied hyperlink has no special meaning (it has no link type p442 ) beyond linking the element's document to the resource given by the element's href p440 attribute. A hyperlink p440 can have one or more hyperlink annotations that modify the processing semantics of that hyperlink.
440
4.12.3.1 Hyperlink auditing If a hyperlink p440 created by an a p173 or area p314 element has a ping p440 attribute, and the user follows the hyperlink, and the value of the element's href p440 attribute can be resolved p55 , relative to the element, without failure, then the user agent must take the ping p440 attribute's value, split that string on spaces p53 , resolve p55 each resulting token relative to the element, and then should send a request (as described below) to each of the resulting absolute URLs p56 . (Tokens that fail to resolve are ignored.) This may be done in parallel with the primary request, and is independent of the result of that request. User agents should allow the user to adjust this behavior, for example in conjunction with a setting that disables the sending of HTTP Referer (sic) headers. Based on the user's preferences, UAs may either ignore p29 the ping p440 attribute altogether, or selectively ignore URLs in the list (e.g. ignoring any third-party URLs). For URLs that are HTTP URLs, the requests must be performed by fetching p59 the specified URLs using the POST method, with an entity body with the MIME type p28 text/ping p761 consisting of the four-character string "PING", from the origin p510 of the Document p33 containing the hyperlink p440 . All relevant cookie and HTTP authentication headers must be included in the request. Which other headers are required depends on the URLs involved.
p77 of the Document p33 object containing the hyperlink being audited and the If both the address ping URL have the same origin p512
The request must include a Ping-From p763 HTTP header with, as its value, the address p77 of the document containing the hyperlink, and a Ping-To p764 HTTP header with, as its value, the address of the absolute URL p56 of the target of the hyperlink. The request must not include a Referer (sic) HTTP header. Otherwise, if the origins are different, but the document containing the hyperlink being audited was not retrieved over an encrypted connection The request must include a Referer (sic) HTTP header with, as its value, the current address p77 of the document containing the hyperlink, a Ping-From p763 HTTP header with the same value, and a Ping-To p764 HTTP header with, as its value, the address of the target of the hyperlink. Otherwise, the origins are different and the document containing the hyperlink being audited was retrieved over an encrypted connection The request must include a Ping-To p764 HTTP header with, as its value, the address of the target of the hyperlink. The request must neither include a Referer (sic) HTTP header nor include a Ping-From p763 HTTP header.
441
Note: To save bandwidth, implementors might also wish to consider omitting optional headers such as Accept from these requests. User agents must, unless otherwise specified by the user, honor the HTTP headers (including, in particular, redirects and HTTP cookie headers), but must ignore any entity bodies returned in the responses. User agents may close the connection prematurely once they start receiving an entity body. [COOKIES] p781 For URLs that are not HTTP URLs, the requests must be performed by fetching p59 the specified URL normally, and discarding the results. When the ping p440 attribute is present, user agents should clearly indicate to the user that following the hyperlink will also cause secondary requests to be sent in the background, possibly including listing the actual target URLs. For example, a visual user agent could include the hostnames of the target ping URLs along with the hyperlink's actual URL in a status bar or tooltip. The ping p440 attribute is redundant with pre-existing technologies like HTTP redirects and JavaScript in allowing Web pages to track which off-site links are most popular or allowing advertisers to track click-through rates. However, the ping p440 attribute provides these advantages to the user over those alternatives: It allows the user to see the final target URL unobscured. It allows the UA to inform the user about the out-of-band notifications. It allows the user to disable the notifications without losing the underlying link functionality. It allows the UA to optimize the use of available network bandwidth so that the target page loads faster.
Thus, while it is possible to track users without this feature, authors are encouraged to use the ping p440 attribute so that the user agent can make the user experience more transparent.
Brief description
a p173 and area p314 Hyperlink p440 Hyperlink p440 Hyperlink p440 Hyperlink p440 Hyperlink p440 Hyperlink p440 Hyperlink p440 not allowed Hyperlink p440 Gives alternate representations of the current document. Provides a link to a collection of records, documents, or other materials of historical interest. Gives a link to the current document's author. Gives the permalink for the nearest ancestor section. Indicates that the referenced document is not part of the same site as the current document. Indicates that the current document is a part of a series, and that the first document in the series is the referenced document. Provides a link to context-sensitive help. Imports an icon to represent the current document. Gives a link to the document that provides a table of contents or index listing the current document.
Hyperlink p440 not allowed not allowed Hyperlink p440 Hyperlink p440 External Resource p440 Hyperlink p440
index p448
442
Link type
Effect on... link p119 a p173 and area p314 Hyperlink p440 Hyperlink p440 Hyperlink p440
Brief description
Indicates that the current document is a part of a series, and that the last document in the series is the referenced document. Indicates that the main content of the current document is covered by the copyright license described by the referenced document. Indicates that the current document is a part of a series, and that the next document in the series is the referenced document.
Annotation p440 Indicates that the current document's original author or publisher does not endorse the referenced document. Annotation p440 Requires that the user agent not send an HTTP Referer (sic) header if the user follows the hyperlink. not allowed External Resource p440 Hyperlink p440 Hyperlink p440 not allowed Hyperlink p440 Hyperlink p440 Hyperlink p440 Gives the address of the pingback server that handles pingbacks to the current document. Specifies that the target resource should be preemptively cached. Indicates that the current document is a part of a series, and that the previous document in the series is the referenced document. Gives a link to a resource that can be used to search through the current document and its related pages. Imports a stylesheet. Specifies that the referenced document, if retrieved, is intended to be shown in the browser's sidebar (if it has one). Gives a tag (identified by the given address) that applies to the current document. Provides a link to a document giving the context for the current document.
noreferrer p447 not allowed pingback p447 prefetch p447 prev p450 search p447 External Resource p440 External Resource p440 Hyperlink p440 Hyperlink p440
Some of the types described below list synonyms for these values. These are to be handled as specified by user agents, but must not be used in documents.
4.12.4.1 Link type "alternate" The alternate p443 keyword may be used with link p119 , a p173 , and area p314 elements. The meaning of this keyword depends on the values of the other attributes.
p119 element and the rel p120 attribute also contains the keyword If the element is a link p447 stylesheet
The alternate p443 keyword modifies the meaning of the stylesheet p447 keyword in the way described for that keyword. The alternate p443 keyword does not create a link of its own.
p443 keyword is used with the type p440 attribute set to the value application/rss+xml The alternate or the value application/atom+xml
The keyword creates a hyperlink p440 referencing a syndication feed (though not necessarily syndicating exactly the same content as the current page). The first link p119 , a p173 , or area p314 element in the document (in tree order) with the alternate p443 keyword used with the type p440 attribute set to the value application/rss+xml or the value application/atom+xml must be treated as the default syndication feed for the purposes of feed autodiscovery. The following link p119 element gives the syndication feed for the current page: <link rel="alternate" type="application/atom+xml" href="data.xml"> The following extract offers various different syndication feeds: <p>You can access the planets database using Atom feeds:</p> <ul> <li><a href="recently-visited-planets.xml" rel="alternate" type="application/ atom+xml">Recently Visited Planets</a></li> <li><a href="known-bad-planets.xml" rel="alternate" type="application/ atom+xml">Known Bad Planets</a></li> <li><a href="unexplored-planets.xml" rel="alternate" type="application/ atom+xml">Unexplored Planets</a></li> </ul> Otherwise The keyword creates a hyperlink p440 referencing an alternate representation of the current document. The nature of the referenced document is given by the media p440 , hreflang p440 , and type p440 attributes.
443
If the alternate p443 keyword is used with the media p440 attribute, it indicates that the referenced document is intended for use with the media specified. If the alternate p443 keyword is used with the hreflang p440 attribute, and that attribute's value differs from the root element p29 's language p93 , it indicates that the referenced document is a translation. If the alternate p443 keyword is used with the type p440 attribute, it indicates that the referenced document is a reformulation of the current document in the specified format. The media p440 , hreflang p440 , and type p440 attributes can be combined when specified with the alternate p443 keyword. For example, the following link is a French translation that uses the PDF format: <link rel=alternate type=application/pdf hreflang=fr href=manual-fr> This relationship is transitive that is, if a document links to two other documents with the link type "alternate p443 ", then, in addition to implying that those documents are alternative representations of the first document, it is also implying that those two documents are alternative representations of each other.
4.12.4.2 Link type "archives" The archives p444 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The archives p444 keyword indicates that the referenced document describes a collection of records, documents, or other materials of historical interest. A blog's index page could link to an index of the blog's past posts with rel="archives". Synonyms: For historical reasons, user agents must also treat the keyword "archive" like the archives p444 keyword.
4.12.4.3 Link type "author" The author p444 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . For a p173 and area p314 elements, the author p444 keyword indicates that the referenced document provides further information about the author of the nearest article p147 element ancestor of the element defining the hyperlink, if there is one, or of the page as a whole, otherwise. For link p119 elements, the author p444 keyword indicates that the referenced document provides further information about the author for the page as a whole. Note: The "referenced document" can be, and often is, a mailto: URL giving the e-mail address of the author. [MAILTO] p783 Synonyms: For historical reasons, user agents must also treat link p119 , a p173 , and area p314 elements that have a rev attribute with the value "made" as having the author p444 keyword specified as a link relationship.
4.12.4.4 Link type "bookmark" The bookmark p444 keyword may be used with a p173 and area p314 elements. This keyword creates a hyperlink p440 . The bookmark p444 keyword gives a permalink for the nearest ancestor article p147 element of the linking element in question, or of the section the linking element is most closely associated with p158 , if there are no ancestor article p147 elements. The following snippet has three permalinks. A user agent could determine which permalink applies to which part of the spec by looking at where the permalinks are given. ... <body> <h1>Example of permalinks</h1> <div id="a"> <h2>First example</h2> <p><a href="a.html" rel="bookmark">This</a> permalink applies to only the content from the first H2 to the second H2. The DIV isn't exactly that section, but it roughly corresponds to it.</p> </div>
444
<h2>Second example</h2> <article id="b"> <p><a href="b.html" rel="bookmark">This</a> permalink applies to the outer ARTICLE element (which could be, e.g., a blog post).</p> <article id="c"> <p><a href="c.html" rel="bookmark">This</a> permalink applies to the inner ARTICLE element (which could be, e.g., a blog comment).</p> </article> </article> </body> ...
4.12.4.5 Link type "external" The external p445 keyword may be used with a p173 and area p314 elements. This keyword creates a hyperlink p440 . The external p445 keyword indicates that the link is leading to a document that is not part of the site that the current document forms a part of.
4.12.4.6 Link type "help" The help p445 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . For a p173 and area p314 elements, the help p445 keyword indicates that the referenced document provides further help information for the parent of the element defining the hyperlink, and its children. In the following example, the form control has associated context-sensitive help. The user agent could use this information, for example, displaying the referenced document if the user presses the "Help" or "F1" key. <p><label> Topic: <input name=topic> <a href="help/topic.html" rel="help">(Help)</a></label></p> For link p119 elements, the help p445 keyword indicates that the referenced document provides help for the page as a whole.
4.12.4.7 Link type "icon" The icon p445 keyword may be used with link p119 elements. This keyword creates an external resource link p440 . The specified resource is an icon representing the page or site, and should be used by the user agent when representing the page in the user interface. Icons could be auditory icons, visual icons, or other kinds of icons. If multiple icons are provided, the user agent must select the most appropriate icon according to the type p121 , media p121 , and sizes p445 attributes. If there are multiple equally appropriate icons, user agents must use the last one declared in tree order p29 . If the user agent tries to use an icon but that icon is determined, upon closer examination, to in fact be inappropriate (e.g. because it uses an unsupported format), then the user agent must try the next-most-appropriate icon as determined by the attributes. There is no default type for resources given by the icon p445 keyword. However, for the purposes of determining the type of the resource p121 , user agents must expect the resource to be an image. The sizes attribute gives the sizes of icons for visual media. If specified, the attribute must have a value that is an unordered set of unique space-separated tokens p53 , which are ASCII case-insensitive p36 . The values must all be either an ASCII case-insensitive p36 match for the string "any p445 ", or a value that consists of two valid non-negative integers p39 that do not have a leading U+0030 DIGIT ZERO (0) character and that are separated by a single U+0078 LATIN SMALL LETTER X or U+0058 LATIN CAPITAL LETTER X character. The keywords represent icon sizes. To parse and process the attribute's value, the user agent must first split the attribute's value on spaces p53 , and must then parse each resulting keyword to determine what it represents. The any keyword represents that the resource contains a scalable icon, e.g. as provided by an SVG image. Other keywords must be further parsed as follows to determine what they represent: If the keyword doesn't contain exactly one U+0078 LATIN SMALL LETTER X or U+0058 LATIN CAPITAL LETTER X character, then this keyword doesn't represent anything. Abort these steps for that keyword.
445
Let width string be the string before the "x" or "X". Let height string be the string after the "x" or "X". If either width string or height string start with a U+0030 DIGIT ZERO (0) character or contain any characters other than characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then this keyword doesn't represent anything. Abort these steps for that keyword. Apply the rules for parsing non-negative integers p39 to width string to obtain width. Apply the rules for parsing non-negative integers p39 to height string to obtain height. The keyword represents that the resource contains a bitmap icon with a width of width device pixels and a height of height device pixels.
The keywords specified on the sizes p445 attribute must not represent icon sizes that are not actually available in the linked resource. If the attribute is not specified, then the user agent must assume that the given icon is appropriate, but less appropriate than an icon of a known and appropriate size. The following snippet shows the top part of an application with several icons. <!DOCTYPE HTML> <html> <head> <title>lsForums Inbox</title> <link rel=icon href=favicon.png sizes="16x16" type="image/png"> <link rel=icon href=windows.ico sizes="32x32 48x48" type="image/vnd.microsoft.icon"> <link rel=icon href=mac.icns sizes="128x128 512x512 8192x8192 32768x32768"> <link rel=icon href=iphone.png sizes="57x57" type="image/png"> <link rel=icon href=gnome.svg sizes="any" type="image/svg+xml"> <link rel=stylesheet href=lsforums.css> <script src=lsforums.js></script> <meta name=application-name content="lsForums"> </head> <body> ...
4.12.4.8 Link type "license" The license p446 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The license p446 keyword indicates that the referenced document provides the copyright license terms under which the main content of the current document is provided. This specification does not specify how to distinguish between the main content of a document and content that is not deemed to be part of that main content. The distinction should be made clear to the user. Consider a photo sharing site. A page on that site might describe and show a photograph, and the page might be marked up as follows: <!DOCTYPE HTML> <html> <head> <title>Exampl Pictures: Kissat</title> <link rel="stylesheet" href="/style/default"> </head> <body> <h1>Kissat</h1> <nav> <a href="../">Return to photo index</a> </nav> <figure> <img src="/pix/39627052_fd8dcd98b5.jpg"> <figcaption>Kissat</figcaption> </figure> <p>One of them has six toes!</p> <p><small><a rel="license" href="http://www.opensource.org/licenses/ mit-license.php">MIT Licensed</a></small></p> <footer> <a href="/">Home</a> | <a href="../">Photo index</a>
446
<p><small> copyright 2009 Exampl Pictures. All Rights Reserved.</small></p> </footer> </body> </html> In this case the license p446 applies to just the photo (the main content of the document), not the whole document. In particular not the design of the page itself, which is covered by the copyright given at the bottom of the document. This could be made clearer in the styling (e.g. making the license link prominently positioned near the photograph, while having the page copyright in light small text at the foot of the page. Synonyms: For historical reasons, user agents must also treat the keyword "copyright" like the license p446 keyword.
4.12.4.9 Link type "nofollow" The nofollow p447 keyword may be used with a p173 and area p314 elements. This keyword does not create a hyperlink p440 , but annotates p440 any other hyperlinks created by the element (the implied hyperlink, if no other keywords create one). The nofollow p447 keyword indicates that the link is not endorsed by the original author or publisher of the page, or that the link to the referenced document was included primarily because of a commercial relationship between people affiliated with the two pages.
4.12.4.10 Link type "noreferrer" The noreferrer p447 keyword may be used with a p173 and area p314 elements. This keyword does not create a hyperlink p440 , but annotates p440 any other hyperlinks created by the element (the implied hyperlink, if no other keywords create one). It indicates that no referrer information is to be leaked when following the link. If a user agent follows a link defined by an a p173 or area p314 element that has the noreferrer p447 keyword, the user agent must not include a Referer (sic) HTTP header (or equivalent p61 for other protocols) in the request. This keyword also causes the opener attribute to remain null p502 if the hyperlink creates a new browsing context p499 .
4.12.4.11 Link type "pingback" The pingback p447 keyword may be used with link p119 elements. This keyword creates an external resource link p440 . For the semantics of the pingback p447 keyword, see the Pingback 1.0 specification. [PINGBACK] p783
4.12.4.12 Link type "prefetch" The prefetch p447 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates an external resource link p440 . The prefetch p447 keyword indicates that preemptively fetching and caching the specified resource is likely to be beneficial, as it is highly likely that the user will require this resource. There is no default type for resources given by the prefetch p447 keyword.
4.12.4.13 Link type "search" The search p447 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The search p447 keyword indicates that the referenced document provides an interface specifically for searching the document and its related resources. Note: OpenSearch description documents can be used with link p119 elements and the search p447 link type to enable user agents to autodiscover search interfaces. [OPENSEARCH] p783
4.12.4.14 Link type "stylesheet" The stylesheet p447 keyword may be used with link p119 elements. This keyword creates an external resource link p440 that contributes to the styling processing model p132 .
447
The specified resource is a resource that describes how to present the document. Exactly how the resource is to be processed depends on the actual type of the resource. If the alternate p443 keyword is also specified on the link p119 element, then the link is an alternative stylesheet; in this case, the title p92 attribute must be specified on the link p119 element, with a non-empty value. The default type for resources given by the stylesheet p447 keyword is text/css. The appropriate time to obtain p120 the resource is when the external resource link p440 is created or when its element is inserted into a document p29 , whichever happens last. If the resource is an alternative stylesheet p448 then the user agent may defer obtaining the resource until it is part of the preferred style sheet set. [CSSOM] p782 Quirk: If the document has been set to quirks mode p81 , has the same origin p512 as the URL p55 of the external resource, and the Content-Type metadata p61 of the external resource is not a supported style sheet type, the user agent must instead assume it to be text/css.
4.12.4.15 Link type "sidebar" The sidebar p448 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The sidebar p448 keyword indicates that the referenced document, if retrieved, is intended to be shown in a secondary browsing context p501 (if possible), instead of in the current browsing context p499 . A hyperlink p440 with the sidebar p448 keyword specified is a sidebar hyperlink.
4.12.4.16 Link type "tag" The tag p448 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The tag p448 keyword indicates that the tag that the referenced document represents applies to the current document. Note: Since it indicates that the tag applies to the current document, it would be inappropriate to use this keyword in the markup of a tag cloud p453 , which lists the popular tag across a set of pages.
4.12.4.17 Hierarchical link types Some documents form part of a hierarchical structure of documents. A hierarchical structure of documents is one where each document can have various subdocuments. The document of which a document is a subdocument is said to be the document's parent. A document with no parent forms the top of the hierarchy. A document may be part of multiple hierarchies.
4.12.4.17.1 Link type "index" The index p448 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The index p448 keyword indicates that the document is part of a hierarchical structure, and that the link is leading to the document that is the top of the hierarchy. It conveys more information when used with the up p448 keyword (q.v.). Synonyms: For historical reasons, user agents must also treat the keywords "top", "contents", and "toc" like the index p448 keyword.
4.12.4.17.2 Link type "up" The up p448 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The up p448 keyword indicates that the document is part of a hierarchical structure, and that the link is leading to a document that is an ancestor of the current document. The up p448 keyword may be repeated within a rel p440 attribute to indicate the hierarchical distance from the current document to the referenced document. If it occurs only once, then the link is leading to the current
448
document's parent; each additional occurrence of the keyword represents one further level. If the index p448 keyword is also present, then the number of up p448 keywords is the depth of the current page relative to the top of the hierarchy. Only one link is created for the set of one or more up p448 keywords and, if present, the index p448 keyword. If the page is part of multiple hierarchies, then they should be described in different paragraphs p102 . User agents must scope any interpretation of the up p448 and index p448 keywords together indicating the depth of the hierarchy to the paragraph p102 in which the link finds itself, if any, or to the document otherwise. When two links have both the up p448 and index p448 keywords specified together in the same scope and contradict each other by having a different number of up p448 keywords, the link with the greater number of up p448 keywords must be taken as giving the depth of the document. This can be used to mark up a navigation style sometimes known as bread crumbs. In the following example, the current page can be reached via two paths. <nav> <p> <a href="/" rel="index up up up">Main</a> > <a href="/products/" rel="up up">Products</a> > <a href="/products/dishwashers/" rel="up">Dishwashers</a> > <a>Second hand</a> </p> <p> <a href="/" rel="index up up">Main</a> > <a href="/second-hand/" rel="up">Second hand</a> > <a>Dishwashers</a> </p> </nav> Note: The relList p174 IDL attribute (e.g. on the a p173 element) does not currently represent multiple up p448 keywords (the interface hides duplicates).
4.12.4.18 Sequential link types Some documents form part of a sequence of documents. A sequence of documents is one where each document can have a previous sibling and a next sibling. A document with no previous sibling is the start of its sequence, a document with no next sibling is the end of its sequence. A document may be part of multiple sequences.
4.12.4.18.1 Link type "first" The first p449 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The first p449 keyword indicates that the document is part of a sequence, and that the link is leading to the document that is the first logical document in the sequence. Synonyms: For historical reasons, user agents must also treat the keywords "begin" and "start" like the first p449 keyword.
4.12.4.18.2 Link type "last" The last p449 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The last p449 keyword indicates that the document is part of a sequence, and that the link is leading to the document that is the last logical document in the sequence. Synonyms: For historical reasons, user agents must also treat the keyword "end" like the last p449 keyword.
4.12.4.18.3 Link type "next" The next p449 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The next p449 keyword indicates that the document is part of a sequence, and that the link is leading to the document that is the next logical document in the sequence.
449
4.12.4.18.4 Link type "prev" The prev p450 keyword may be used with link p119 , a p173 , and area p314 elements. This keyword creates a hyperlink p440 . The prev p450 keyword indicates that the document is part of a sequence, and that the link is leading to the document that is the previous logical document in the sequence. Synonyms: For historical reasons, user agents must also treat the keyword "previous" like the prev p450 keyword.
4.12.4.19 Other link types Extensions to the predefined set of link types may be registered in the WHATWG Wiki RelExtensions page. [WHATWGWIKI] p786 Anyone is free to edit the WHATWG Wiki RelExtensions page at any time to add a type. Extension types must be specified with the following information: Keyword The actual value being defined. The value should not be confusingly similar to any other defined value (e.g. differing only in case). If the value contains a U+003A COLON character (:), it must also be an absolute URL p56 . Effect on... link p119 One of the following: Not allowed The keyword must not be specified on link p119 elements. Hyperlink The keyword may be specified on a link p119 element; it creates a hyperlink p440 . External Resource The keyword may be specified on a link p119 element; it creates an external resource link p440 . Effect on... a p173 and area p314 One of the following: Not allowed The keyword must not be specified on a p173 and area p314 elements. Hyperlink The keyword may be specified on a p173 and area p314 elements; it creates a hyperlink p440 . External Resource The keyword may be specified on a a p173 and area p314 elements; it creates an external resource link p440 . Hyperlink Annotation The keyword may be specified on a a p173 and area p314 elements; it annotates p440 other hyperlinks p440 created by the element. Brief description A short non-normative description of what the keyword's meaning is. Specification A link to a more detailed description of the keyword's semantics and requirements. It could be another page on the Wiki, or a link to an external page. Synonyms A list of other keyword values that have exactly the same processing requirements. Authors should not use the values defined to be synonyms, they are only intended to allow user agents to support legacy content. Anyone may remove synonyms that are not used in practice; only names that need to be processed as synonyms for compatibility with legacy content are to be registered in this way. Status One of the following: Proposed The keyword has not received wide peer review and approval. Someone has proposed it and is, or soon will be, using it. Ratified The keyword has received wide peer review and approval. It has a specification that unambiguously defines how to handle pages that use the keyword, including when they use it in incorrect ways.
450
Discontinued The keyword has received wide peer review and it has been found wanting. Existing pages are using this keyword, but new pages should avoid it. The "brief description" and "specification" entries will give details of what authors should use instead, if anything. If a keyword is found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a keyword is registered in the "proposed" state for a period of a month or more without being used or specified, then it may be removed from the registry. If a keyword is added with the "proposed" status and found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a keyword is added with the "proposed" status and found to be harmful, then it should be changed to "discontinued" status. Anyone can change the status at any time, but should only do so in accordance with the definitions above. Conformance checkers must use the information given on the WHATWG Wiki RelExtensions page to establish if a value is allowed or not: values defined in this specification or marked as "proposed" or "ratified" must be accepted when used on the elements for which they apply as described in the "Effect on..." field, whereas values marked as "discontinued" or not listed in either this specification or on the aforementioned page must be rejected as invalid. Conformance checkers may cache this information (e.g. for performance reasons or to avoid the use of unreliable network connectivity). When an author uses a new type not defined by either this specification or the Wiki page, conformance checkers should offer to add the value to the Wiki, with the details described above, with the "proposed" status. Types defined as extensions in the WHATWG Wiki RelExtensions page with the status "proposed" or "ratified" may be used with the rel attribute on link p119 , a p173 , and area p314 elements in accordance to the "Effect on..." field. [WHATWGWIKI] p786
451
<!DOCTYPE HTML> <html> <head> <title> The Boy Blog: My Toys </title> </head> <body> <header> <h1>The Boy Blog</h1> </header> <nav> <p><a href="/">Home</a></p> <p><a href="/contact">Contact</a></p> </nav> <article> <header> <h1>My toys</h1> <p>Published <time pubdate datetime="2010-08-04">August 4th</time></p> </header> <p>I really like my chained book and my telephone. I'm not such a fan of my big ball.</p> <p>Another toy I like is my mirror.</p> </article> <footer> <p> copyright 2010 by the boy</p> </footer> </body> </html> If the main content is not an independent unit of content so much as a section of a larger work, for instance a chapter, then the section p144 element would be appropriate to mark up the main content of the document. Here is the same document, case as a chapter in an online book: <!DOCTYPE HTML> <html> <head> <title> Chapter 2: My Toys The Book of the Boy </title> </head> <body> <header> <h1>Chapter 2: My Toys</h1> </header> <nav> <p><a href="/">Front Page</a></p> <p><a href="/toc">Table of Contents</a></p> <p><a href="/c1">Chapter 1</a> <a href="/c3">Chapter 3</a></p> </nav> <section> <p>I really like my chained book and my telephone. I'm not such a fan of my big ball.</p> <p>Another toy I like is my mirror.</p> </section> <footer> <p> copyright 2010 by the boy</p> </footer> </body> </html> If neither article p147 nor section p144 would be appropriate, but the main content still needs an explicit element, for example for styling purposes, then the div p172 element can be used. This is the same as the original example, but using div p172 for the main content instead of leaving it implied: <!DOCTYPE HTML> <html> <head> <title> My Toys </title> <style> body > div { background: navy; color: yellow; } </style> </head> <body>
452
<header> <h1>My toys</h1> </header> <nav> <p><a href="/">Home</a></p> <p><a href="/contact">Contact</a></p> </nav> <div> <p>I really like my chained book and my telephone. I'm not such a fan of my big ball.</p> <p>Another toy I like is my mirror.</p> </div> <footer> <p> copyright 2010 by the boy</p> </footer> </body> </html>
4.13.3 Conversations
This specification does not define a specific element for marking up conversations, meeting minutes, chat transcripts, dialogues in screenplays, instant message logs, and other situations where different players take turns in discourse. Instead, authors are encouraged to mark up conversations using p p160 elements and punctuation. Authors who need to mark the speaker for styling purposes are encouraged to use span p194 or b p188 . Paragraphs with their text wrapped in the i p187 element can be used for marking up stage directions.
453
This example demonstrates this using an extract from Abbot and Costello's famous sketch, Who's on first: <p> <p> <p> <p> <p> <p> <p> Costello: Look, you gotta first baseman? Abbott: Certainly. Costello: Who's playing first? Abbott: That's right. Costello becomes exasperated. Costello: When you pay off the first baseman every month, who gets the money? Abbott: Every dollar of it.
The following extract shows how an IM conversation log could be marked up. <p> <time>14:22</time> <b>egof</b> I'm not that nerdy, I've only seen 30% of the star trek episodes <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 <p> <time>14:23</time> <b>egof</b> it's unarguably <p> <time>14:23</time> <i>* kaj blinks</i> <p> <time>14:24</time> <b>kaj</b> you are not helping your case
4.13.4 Footnotes
HTML does not have a dedicated mechanism for marking up footnotes. Here are the recommended alternatives. For short inline annotations, the title p92 attribute should be used. In this example, two parts of a dialogue are annotated with footnote-like content using the title p92 attribute. <p> <b>Customer</b>: Hello! I wish to register a complaint. Hello. Miss? <p> <b>Shopkeeper</b>: <span title="Colloquial pronunciation of 'What do you'" >Watcha</span> mean, miss? <p> <b>Customer</b>: Uh, I'm sorry, I have a cold. I wish to make a complaint. <p> <b>Shopkeeper</b>: Sorry, <span title="This is, of course, a lie.">we're closing for lunch</span>. For longer annotations, the a p173 element should be used, pointing to an element later in the document. The convention is that the contents of the link be a number in square brackets. In this example, a footnote in the dialogue links to a paragraph below the dialogue. The paragraph then reciprocally links back to the dialogue, allowing the user to return to the location of the footnote. <p> Announcer: Number 16: The <i>hand</i>. <p> Interviewer: Good evening. I have with me in the studio tonight Mr Norman St John Polevaulter, who for the past few years has been contradicting people. Mr Polevaulter, why <em>do</em> you contradict people? <p> Norman: I don't. <sup><a href="#fn1" id="r1">[1]</a></sup> <p> Interviewer: You told me you did! ... <section> <p id="fn1"><a href="#r1">[1]</a> This is, naturally, a lie, but paradoxically if it were true he could not say so without contradicting the interviewer and thus making it false.</p> </section> For side notes, longer annotations that apply to entire sections of the text rather than just specific words or sentences, the aside p148 element should be used. In this example, a sidebar is given after a dialogue, giving it some context. <p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched. <p> <span class="speaker">Shopkeeper</span>: I'm sorry? <p> <span class="speaker">Customer</span>: I will not buy this record, it is scratched. <p> <span class="speaker">Shopkeeper</span>: No no no, this's'a tobacconist's. <aside> <p>In 1970, the British Empire lay in ruins, and foreign nationalists frequented the streets many of them Hungarians (not the streets the foreign nationals). Sadly, Alexander Yalt has been publishing incompetently-written phrase books. </aside>
454
For figures or tables, footnotes can be included in the relevant figcaption p172 or caption p327 element, or in surrounding prose. In this example, a table has cells with footnotes that are given in prose. A figure p170 element is used to give a single legend to the combination of the table and its footnotes. <figure> <figcaption>Table 1. Alternative activities for knights.</figcaption> <table> <tr> <th> Activity <th> Location <th> Cost <tr> <td> Dance <td> Wherever possible <td> 0<sup><a href="#fn1">1</a></sup> <tr> <td> Routines, chorus scenes<sup><a href="#fn2">2</a></sup> <td> Undisclosed <td> Undisclosed <tr> <td> Dining<sup><a href="#fn3">3</a></sup> <td> Camelot <td> Cost of ham, jam, and spam<sup><a href="#fn4">4</a></sup> </table> <p id="fn1">1. Assumed.</p> <p id="fn2">2. Footwork impeccable.</p> <p id="fn3">3. Quality described as "well".</p> <p id="fn4">4. A lot.</p> </figure>
455
nowrap readonly rel rev rules scope scrolling selected shape target text type (except as specified below) valign valuetype vlink
All other attribute values on HTML elements p28 must be treated as case-sensitive p36 . The exception to the list above is the type p165 attribute on ol p164 elements, which must be treated as casesensitive p36 .
4.14.2 Pseudo-classes
There are a number of dynamic selectors that can be used with HTML. This section defines when these selectors match HTML elements. :link :visited All a p173 elements that have an href p440 attribute, all area p314 elements that have an href p440 attribute, and all link p119 elements that have an href p120 attribute, must match one of :link p456 and :visited p456 . Other specification might apply more specific rules regarding how these elements are to match these pseudo-elements, to mitigate some privacy concerns that apply with straightforward implementations of this requirement. :active The :active p456 pseudo-class must match any element falling into one of the following categories between the time the user begins to activate the element and the time the user stops activating the element: a p173 elements that have an href p440 attribute area p314 elements that have an href p440 attribute link p119 elements that have an href p120 attribute button p385 elements that are not disabled p409 input p353 elements whose type p355 attribute is in the Submit Button p373 , Image Button p373 , Reset Button p375 , or Button p375 state command p427 elements that do not have a disabled p427 attribute elements that are specially focusable p572
For example, if the user is using a keyboard to push a button p385 element by pressing the space bar, the element would match this pseudo-class in between the time that the element received the keydown event and the time the element received the keyup event. :enabled The :enabled p456 pseudo-class must match any element falling into one of the following categories: a p173 elements that have an href p440 attribute area p314 elements that have an href p440 attribute link p119 elements that have an href p120 attribute button p385 elements that are not disabled p409 input p353 elements whose type p355 attribute are not in the Hidden p358 state and that are not disabled p409 select p387 elements that are not disabled p409 textarea p395 elements that are not disabled p409
456
option p393 elements that are not disabled p393 command p427 elements that do not have a disabled p427 attribute li p166 elements that are children of menu p428 elements, and that have a child element that defines a command p432 , if the first such element's Disabled State p432 facet is false (not disabled)
:disabled The :disabled p457 pseudo-class must match any element falling into one of the following categories: button p385 elements that are disabled p409 input p353 elements whose type p355 attribute are not in the Hidden p358 state and that are disabled p409 select p387 elements that are disabled p409 textarea p395 elements that are disabled p409 option p393 elements that are disabled p393 command p427 elements that have a disabled p427 attribute li p166 elements that are children of menu p428 elements, and that have a child element that defines a command p432 , if the first such element's Disabled State p432 facet is true (disabled)
:checked The :checked p457 pseudo-class must match any element falling into one of the following categories: input p353 elements whose type p355 attribute is in the Checkbox p370 state and whose checkedness p409 state is true input p353 elements whose type p355 attribute is in the Radio Button p371 state and whose checkedness p409 state is true option p393 elements whose selectedness p393 is true command p427 elements whose type p427 attribute is in the Checkbox p427 state and that have a checked p428 attribute command p427 elements whose type p427 attribute is in the Radio p427 state and that have a checked p428 attribute
:indeterminate The :indeterminate p457 pseudo-class must match input p353 elements whose type p355 attribute is in the Checkbox p370 state and whose indeterminate p357 IDL attribute is set to true. :default The :default p457 pseudo-class must match any element falling into one of the following categories: button p385 elements that are their form's default button p416 input p353 elements whose type p355 attribute is in the Submit Button p373 or Image Button p373 state, and that are their form's default button p416 input p353 elements to which the checked p357 attribute applies and that have a checked p357 attribute option p393 elements that have a selected p393 attribute
:valid
The :valid p457 pseudo-class must match all elements that are candidates for constraint validation p412 and that satisfy their constraints p413 . :invalid The :invalid p457 pseudo-class must match all elements that are candidates for constraint validation p412 but that do not satisfy their constraints p413 . :in-range The :in-range p457 pseudo-class must match all elements that are candidates for constraint validation p412 and that are neither suffering from an underflow p413 nor suffering from an overflow p413 . :out-of-range The :out-of-range p457 pseudo-class must match all elements that are candidates for constraint validation p412 and that are suffering from an underflow p413 or suffering from an overflow p413 .
457
:required The :required p458 pseudo-class must match any element falling into one of the following categories: :optional The :optional p458 pseudo-class must match any element falling into one of the following categories: :read-only :read-write The :read-write p458 pseudo-class must match any element falling into one of the following categories: input p353 elements to which the readonly p378 attribute applies, but that are not immutable p357 (i.e. that do not have the readonly p378 attribute specified and that are not disabled p409 ) textarea p395 elements that do not have a readonly p396 attribute, and that are not disabled p409 elements that are editable p577 and is neither an input p353 element nor a textarea p395 element input p353 elements to which the required p379 attribute applies that are not required p379 select p387 elements that do not have a required p388 attribute textarea p395 elements that do not have a required p397 attribute input p353 elements that are required p379 select p387 elements that have a required p388 attribute textarea p395 elements that have a required p397 attribute
The :read-only p458 pseudo-class must match all other HTML elements p28 . :ltr The :ltr p458 pseudo-class must match all elements whose directionality p94 is 'ltr p94 '. :rtl The :rtl p458 pseudo-class must match all elements whose directionality p94 is 'rtl p94 '. Note: Another section of this specification defines the target element p527 used with the :target pseudo-class. Note: This specification does not define when an element matches the :hover, :focus, or :lang() dynamic pseudo-classes, as those are all defined in sufficient detail in a languageagnostic fashion in the Selectors specification. [SELECTORS] p785
458
5 Microdata
5.1 Introduction
5.1.1 Overview
This section is non-normative. Sometimes, it is desirable to annotate content with specific machine-readable labels, e.g. to allow generic scripts to provide services that are customised to the page, or to enable content from a variety of cooperating authors to be processed by a single script in a consistent manner. For this purpose, authors can use the microdata features described in this section. Microdata allows nested groups of name-value pairs to be added to documents, in parallel with the existing content.
459
(<span itemprop="size">12</span> players)</span></p> </div> The outer item here has two properties, "name" and "band". The "name" is "Amanda", and the "band" is an item in its own right, with two properties, "name" and "size". The "name" of the band is "Jazz Band", and the "size" is "12". The outer item in this example is a top-level microdata item. Properties that are not descendants of the element with the itemscope p464 attribute can be associated with the item p464 using the itemref p464 attribute. This attribute takes a list of IDs of elements to crawl in addition to crawling the children of the element with the itemscope p464 attribute. This example is the same as the previous one, but all the properties are separated from their items p464 : <div itemscope id="amanda" itemref="a b"></div> <p id="a">Name: <span itemprop="name">Amanda</span></p> <div id="b" itemprop="band" itemscope itemref="c"></div> <div id="c"> <p>Band: <span itemprop="name">Jazz Band</span></p> <p>Size: <span itemprop="size">12</span> players</p> </div> This gives the same result as the previous example. The first item has two properties, "name", set to "Amanda", and "band", set to another item. That second item has two further properties, "name", set to "Jazz Band", and "size", set to "12". An item p464 can have multiple properties with the same name and different values. This example describes an ice cream, with two flavors: <div itemscope> <p>Flavors in my favorite ice cream:</p> <ul> <li itemprop="flavor">Lemon sorbet</li> <li itemprop="flavor">Apricot sorbet</li> </ul> </div> This thus results in an item with two properties, both "flavor", having the values "Lemon sorbet" and "Apricot sorbet". An element introducing a property can also introduce multiple properties at once, to avoid duplication when some of the properties have the same value. Here we see an item with two properties, "favorite-color" and "favorite-fruit", both set to the value "orange": <div itemscope> <span itemprop="favorite-color favorite-fruit">orange</span> </div> It's important to note that there is no relationship between the microdata and the content of the document where the microdata is marked up. There is no semantic difference, for instance, between the following two examples: <figure> <img src="castle.jpeg"> <figcaption><span itemscope><span itemprop="name">The Castle</span></span> (1986)</figcaption> </figure> <span itemscope><meta itemprop="name" content="The Castle"></span> <figure> <img src="castle.jpeg"> <figcaption>The Castle (1986)</figcaption> </figure> Both have a figure with a caption, and both, completely unrelated to the figure, have an item with a namevalue pair with the name "name" and the value "The Castle". The only difference is that if the user drags the caption out of the document, in the former case, the item will be included in the drag-and-drop data. In neither case is the image in any way associated with the item.
460
461
For instance, if Jon and Adam both write content at example.com, at http://example.com/~jon/... and http://example.com/~adam/... respectively, then they could select identifiers of the form "http://example.com/~jon/name" and "http://example.com/~adam/name" respectively. Properties whose names are just plain words can only be used within the context of the types for which they are intended; properties named using URLs can be reused in items of any type. If an item has no type, and is not part of another item, then if its properties have names that are just plain words, they are not intended to be globally unique, and are instead only intended for limited use. Generally speaking, authors are encouraged to use either properties with globally unique names (URLs) or ensure that their items are typed. Here, an item is an "http://example.org/animals#cat", and most of the properties have names that are words defined in the context of that type. There are also a few additional properties whose names come from other vocabularies. <section itemscope itemtype="http://example.org/animals#cat"> <h1 itemprop="name http://example.com/fn">Hedral</h1> <p itemprop="desc">Hedral is a male american domestic shorthair, with a fluffy <span itemprop="http://example.com/color">black</span> fur with <span itemprop="http://example.com/color">white</span> paws and belly.</p> <img itemprop="img" src="hedral.jpeg" alt="" title="Hedral, age 18 months"> </section> This example has one item with the type "http://example.org/animals#cat" and the following properties:
Property name http://example.com/fn desc Value Hedral Hedral Hedral is a male american domestic shorthair, with a fluffy black fur with white paws and belly.
462
In an earlier example, a "http://example.org/animals#cat" item had two "http://example.com/color" values. This script looks up the first such item and then lists all its values. var cat = document.getItems('http://example.org/animals#cat')[0]; var colors = cat.properties['http://example.com/color'].values; var result; if (colors.length == 0) { result = 'Color unknown.'; } else if (colors.length == 1) { result = 'Color: ' + colors[0]; } else { result = 'Colors:'; for (var i = 0; i < colors.length; i += 1) result += ' ' + colors[i]; } It's also possible to get a list of all the property names p465 using the object's names p70 IDL attribute. This example creates a big list with a nested list for each item on the page, each with of all the property names used in that item. var outer = document.createElement('ul'); var items = document.getItems(); for (var item = 0; item < items.length; item += 1) { var itemLi = document.createElement('li'); var inner = document.createElement('ul'); for (var name = 0; name < items[item].properties.names.length; name += 1) { var propLi = document.createElement('li'); propLi.appendChild(document.createTextNode(items[item].properties.names[name])); inner.appendChild(propLi); } itemLi.appendChild(inner); outer.appendChild(itemLi); } document.body.appendChild(outer); If faced with the following from an earlier example: <section itemscope itemtype="http://example.org/animals#cat"> <h1 itemprop="name http://example.com/fn">Hedral</h1> <p itemprop="desc">Hedral is a male american domestic shorthair, with a fluffy <span itemprop="http://example.com/color">black</span> fur with <span itemprop="http://example.com/color">white</span> paws and belly.</p> <img itemprop="img" src="hedral.jpeg" alt="" title="Hedral, age 18 months"> </section> ...it would result in the following output: name http://example.com/fn desc http://example.com/color img
463
5.2.2 Items
Every HTML element p28 may have an itemscope attribute specified. The itemscope p464 attribute is a boolean attribute p38 . An element with the itemscope p464 attribute specified creates a new item, a group of name-value pairs. Elements with an itemscope p464 attribute may have an itemtype attribute specified, to give the item type p464 of the item p464 . The itemtype p464 attribute, if specified, must have a value that is a valid URL p55 that is an absolute URL p56 for which the string "http://www.w3.org/1999/xhtml/microdata#" is not a prefix match p36 . The item type of an item p464 is the value of its element's itemtype p464 attribute, if it has one and its value is not the empty string. If the itemtype p464 attribute is missing or its value is the empty string, the item p464 is said to have no item type p464 . The item type p464 must be a type defined in an applicable specification p36 . Except if otherwise specified by that specification, the URL p55 given as the item type p464 should not be automatically dereferenced. Note: A specification could define that its item type p464 can be derefenced to provide the user with help information, for example. In fact, vocabulary authors are encouraged to provide useful information at the given URL p55 . Item types p464 are opaque identifiers, and user agents must not dereference unknown item types p464 , or otherwise deconstruct them, in order to determine how to process items p464 that use them. The itemtype p464 attribute must not be specified on elements that do not have an itemscope p464 attribute specified. Elements with an itemscope p464 attribute and an itemtype p464 attribute that references a vocabulary that is defined to support global identifiers for items may also have an itemid attribute specified, to give a global identifier for the item p464 , so that it can be related to other items p464 on pages elsewhere on the Web. The itemid p464 attribute, if specified, must have a value that is a valid URL potentially surrounded by spaces p55 . The global identifier of an item p464 is the value of its element's itemid p464 attribute, if it has one, resolved p55 relative to the element on which the attribute is specified. If the itemid p464 attribute is missing or if resolving it fails, it is said to have no global identifier p464 . The itemid p464 attribute must not be specified on elements that do not have both an itemscope p464 attribute and an itemtype p464 attribute specified, and must not be specified on elements with an itemscope p464 attribute whose itemtype p464 attribute specifies a vocabulary that does not support global identifiers for items p464 , as defined by that vocabulary's specification. Elements with an itemscope p464 attribute may have an itemref attribute specified, to give a list of additional elements to crawl to find the name-value pairs of the item p464 . The itemref p464 attribute, if specified, must have a value that is an unordered set of unique space-separated tokens p53 that are case-sensitive p36 , consisting of IDs p92 of elements in the same home subtree p29 . The itemref p464 attribute must not be specified on elements that do not have an itemscope p464 attribute specified.
464
If the item is a typed item p463 : a defined property name allowed in this situation according to the specification that defines the relevant type p463 for the item, or If the item is not a typed item p463 : a string that contains no U+002E FULL STOP characters (.) and no U+003A COLON characters (:).
When an element with an itemprop attribute adds a property p466 to multiple items p464 , the requirement above regarding the tokens applies for each item p464 individually. The property names of an element are the tokens that the element's itemprop p464 attribute is found to contain when its value is split on spaces p53 , with the order preserved but with duplicates removed (leaving only the first occurrence of each name). Within an item p464 , the properties are unordered with respect to each other, except for properties with the same name, which are ordered in the order they are given by the algorithm that defines the properties of an item p466 . In the following example, the "a" property has the values "1" and "2", in that order, but whether the "a" property comes before the "b" property or not is not important: <div itemscope> <p itemprop="a">1</p> <p itemprop="a">2</p> <p itemprop="b">test</p> </div> Thus, the following is equivalent: <div itemscope> <p itemprop="b">test</p> <p itemprop="a">1</p> <p itemprop="a">2</p> </div> As is the following: <div itemscope> <p itemprop="a">1</p> <p itemprop="b">test</p> <p itemprop="a">2</p> </div> And the following: <div itemscope itemref="x"> <p itemprop="b">test</p> <p itemprop="a">2</p> </div> <div id="x"> <p itemprop="a">1</p> </div>
5.2.4 Values
The property value of a name-value pair added by an element with an itemprop p464 attribute depends on the element, as follows: If the element also has an itemscope p464 attribute The value is the item p464 created by the element. If the element is a meta p122 element The value is the value of the element's content attribute, if any, or the empty string if there is no such attribute. If the element is an audio p231 , embed p220 , iframe p213 , img p199 , source p232 , track p234 , or video p228 element The value is the absolute URL p56 that results from resolving p55 the value of the element's src attribute relative to the element at the time the attribute is set, or the empty string if there is no such attribute or if resolving p55 it results in an error. If the element is an a p173 , area p314 , or link p119 element The value is the absolute URL p56 that results from resolving p55 the value of the element's href attribute relative to the element at the time the attribute is set, or the empty string if there is no such attribute or if resolving p55 it results in an error.
465
If the element is an object p222 element The value is the absolute URL p56 that results from resolving p55 the value of the element's data attribute relative to the element at the time the attribute is set, or the empty string if there is no such attribute or if resolving p55 it results in an error. If the element is a time p182 element with a datetime p182 attribute The value is the value of the element's datetime p182 attribute. Otherwise The value is the element's textContent p33 . The URL property elements are the a p173 , area p314 , audio p231 , embed p220 , iframe p213 , img p199 , link p119 , object p222 , source p232 , track p234 , and video p228 elements. If a property's value p465 is an absolute URL p56 , the property must be specified using a URL property element p466 . If a property's value p465 represents a date p45 , time p46 , or global date and time p47 , the property must be specified using the datetime p182 attribute of a time p182 element.
3. 4. 5.
6. 7.
To collect all the elements in the item root, the user agent must run these steps. They return a list of elements and a count of errors. 1. 2. 3. 4. Let results and pending be empty lists of elements. Let errors be zero. Add all the children elements of root to pending. If root has an itemref p464 attribute, split the value of that itemref attribute on spaces p53 . For each resulting token ID, if there is an element in the home subtree p29 of root with the ID p92 ID, then add the first such element to pending. Loop: Remove an element from pending and let current be that element. If current is already in results, increment errors. If current is not already in results and current does not have an itemscope p464 attribute, then: add all the child elements of current to pending. If current is not already in results, then: add current to results. End of loop: If pending is not empty, return to the step labeled loop. Return results and errors.
5. 6. 7.
8. 9. 10.
An item p464 is a top-level microdata item if its element does not have an itemprop p464 attribute.
466
An item p464 is a used microdata item if it is a top-level microdata item p466 , or if it has an itemprop p464 attribute and would be found to be the property p466 of an item p464 that is itself a used microdata item p467 . A document must not contain any items p464 that are not used microdata items p467 . A document must not contain any elements that have an itemprop p464 attribute that would not be found to be a property of any of the items p464 in that document were their properties p466 all to be determined. A document must not contain any items p464 for which crawling the properties p466 of the element, with an empty list as the value of memory, either fails or returns an error count other than zero. Note: The algorithms in this section are especially inefficient, in the interests of keeping them easy to understand. Implementors are strongly encouraged to refactor and optimize them in their user agents. In this example, a single license statement is applied to two works, using itemref p464 from the items representing the works: <!DOCTYPE HTML> <html> <head> <title>Photo gallery</title> </head> <body> <h1>My photos</h1> <figure itemscope itemtype="http://n.whatwg.org/work" itemref="licenses"> <img itemprop="work" src="images/house.jpeg" alt="A white house, boarded up, sits in a forest."> <figcaption itemprop="title">The house I found.</figcaption> </figure> <figure itemscope itemtype="http://n.whatwg.org/work" itemref="licenses"> <img itemprop="work" src="images/mailbox.jpeg" alt="Outside the house is a mailbox. It has a leaflet inside."> <figcaption itemprop="title">The mailbox.</figcaption> </figure> <footer> <p id="licenses">All images licensed under the <a itemprop="license" href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</p> </footer> </body> </html> The above results in two items with the type "http://n.whatwg.org/work", one with: work images/house.jpeg title The house I found. license http://www.opensource.org/licenses/mit-license.php ...and one with: work images/mailbox.jpeg title The mailbox. license http://www.opensource.org/licenses/mit-license.php
467
document . getItems p468 ( [ types ] ) Returns a NodeList p33 of the elements in the Document p33 that create items p464 , that are not part of other items p464 , and that are of one of the types given in the argument, if any are listed. The types argument is interpreted as a space-separated list of types. element . properties p468 If the element has an itemscope p464 attribute, returns an HTMLPropertiesCollection p69 object with all the element's properties. Otherwise, an empty HTMLPropertiesCollection p69 object. element . itemValue p468 [ = value ] Returns the element's value p465 . Can be set, to change the element's value p465 . Setting the value p465 when the element has no itemprop p464 attribute or when the element's value is an item p464 throws an INVALID_ACCESS_ERR p75 exception.
The document.getItems(typeNames) method takes an optional string that contains an unordered set of unique space-separated tokens p53 that are case-sensitive p36 , representing types. When called, the method must return a live p29 NodeList p33 object containing all the elements in the document, in tree order p29 , that are each top-level microdata items p466 with a type p464 equal to one of the types specified in that argument, having obtained the types by splitting the string on spaces p53 . If there are no tokens specified in the argument, or if the argument is missing, then the method must return a NodeList p33 containing all the top-level microdata items p466 in the document. When the method is invoked on a Document p33 object again with the same argument, the user agent may return the same object as the object returned by the earlier call. In other cases, a new NodeList p33 object must be returned. The itemScope IDL attribute on HTML elements p28 must reflect p62 the itemscope p464 content attribute. The itemType IDL attribute on HTML elements p28 must reflect p62 the itemtype p464 content attribute, as if it was a regular string attribute, not a URL p55 string attribute. The itemId IDL attribute on HTML elements p28 must reflect p62 the itemid p464 content attribute. The itemProp IDL attribute on HTML elements p28 must reflect p62 the itemprop p464 content attribute. The itemRef IDL attribute on HTML elements p28 must reflect p62 the itemref p464 content attribute. The properties IDL attribute on HTML elements p28 must return an HTMLPropertiesCollection p69 rooted at the Document p33 node, whose filter matches only elements that have property names p465 and are the properties of the item p466 created by the element on which the attribute was invoked, while that element is an item p464 , and matches nothing the rest of the time. The itemValue IDL attribute's behavior depends on the element, as follows: If the element has no itemprop p464 attribute The attribute must return null on getting and must throw an INVALID_ACCESS_ERR p75 exception on setting. If the element has an itemscope p464 attribute The attribute must return the element itself on getting and must throw an INVALID_ACCESS_ERR p75 exception on setting. If the element is a meta p122 element The attribute must act as it would if it was reflecting p62 the element's content p123 content attribute. If the element is an audio p231 , embed p220 , iframe p213 , img p199 , source p232 , track p234 , or video p228 element The attribute must act as it would if it was reflecting p62 the element's src content attribute. If the element is an a p173 , area p314 , or link p119 element The attribute must act as it would if it was reflecting p62 the element's href content attribute. If the element is an object p222 element The attribute must act as it would if it was reflecting p62 the element's data content attribute. If the element is a time p182 element with a datetime p182 attribute The attribute must act as it would if it was reflecting p62 the element's datetime p182 content attribute. Otherwise The attribute must act the same as the element's textContent p33 attribute.
468
When the itemValue p468 IDL attribute is reflecting p62 a content attribute or acting like the element's textContent p33 attribute, the user agent must, on setting, convert the new value to the IDL DOMString value before using it according to the mappings described above. In this example, a script checks to see if a particular element element is declaring a particular property, and if it is, it increments a counter: if (element.itemProp.contains('color')) count += 1; This script iterates over each of the values of an element's itemref p464 attribute, calling a function for each referenced element: for (var index = 0; index < element.itemRef.length; index += 1) process(document.getElementById(element.itemRef[index]));
469
honorific-prefix (inside n p469 ) Gives the honorific prefix of the person. The value p465 must be text. Any number of properties with the name honorific-prefix p470 may be present within the item p464 that forms the value p465 of the n p469 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . honorific-suffix (inside n p469 ) Gives the honorific suffix of the person. The value p465 must be text. Any number of properties with the name honorific-suffix p470 may be present within the item p464 that forms the value p465 of the n p469 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . nickname Gives the nickname of the person or organization. Note: The nickname is the descriptive name given instead of or in addition to the one belonging to a person, place, or thing. It can also be used to specify a familiar form of a proper name specified by the fn p469 or n p469 properties. The value p465 must be text. Any number of properties with the name nickname p470 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . photo Gives a photograph of the person or organization. The value p465 must be an absolute URL p56 . Any number of properties with the name photo p470 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . bday Gives the birth date of the person or organization. The value p465 must be a valid date string p45 . A single property with the name bday p470 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . adr Gives the delivery address of the person or organization. The value p465 must be an item p464 with zero or more type p470 , post-office-box p471 , extended-address p471 , and street-address p471 properties, and optionally a locality p471 property, optionally a region p471 property, optionally a postal-code p471 property, and optionally a country-name p471 property. If no type p470 properties are present within an item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 , then the address type strings p476 intl, postal, parcel, and work are implied. Any number of properties with the name adr p470 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . type (inside adr p470 ) Gives the type of delivery address. The value p465 must be text that, when compared in a case-sensitive p36 manner, is equal to one of the address type strings p476 . Within each item p464 with the type http://microformats.org/profile/hcard p469 , there must be no more than one adr p470 property item p464 with a type p470 property whose value is pref p476 . Any number of properties with the name type p470 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 , but within each such adr p470 property item p464 there must only be one type p470 property per distinct value.
470
post-office-box (inside adr p470 ) Gives the post office box component of the delivery address of the person or organization. The value p465 must be text. Any number of properties with the name post-office-box p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . extended-address (inside adr p470 ) Gives an additional component of the delivery address of the person or organization. The value p465 must be text. Any number of properties with the name extended-address p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . street-address (inside adr p470 ) Gives the street address component of the delivery address of the person or organization. The value p465 must be text. Any number of properties with the name street-address p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . locality (inside adr p470 ) Gives the locality component (e.g. city) of the delivery address of the person or organization. The value p465 must be text. A single property with the name locality p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 . region (inside adr p470 ) Gives the region component (e.g. state or province) of the delivery address of the person or organization. The value p465 must be text. A single property with the name region p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 . postal-code (inside adr p470 ) Gives the postal code component of the delivery address of the person or organization. The value p465 must be text. A single property with the name postal-code p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 . country-name (inside adr p470 ) Gives the country name component of the delivery address of the person or organization. The value p465 must be text. A single property with the name country-name p471 may be present within the item p464 that forms the value p465 of an adr p470 property of an item p464 with the type http://microformats.org/profile/hcard p469 . label Gives the formatted text corresponding to the delivery address of the person or organization. The value p465 must be either text or an item p464 with zero or more type p472 properties and exactly one value p472 property. If no type p472 properties are present within an item p464 that forms the value p465 of a label p471 property of an item p464 with the type http://microformats.org/profile/hcard p469 , or if the value p465 of such a label p471 property is text, then the address type strings p476 intl, postal, parcel, and work are implied. Any number of properties with the name label p471 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 .
471
type (inside label p471 ) Gives the type of delivery address. The value p465 must be text that, when compared in a case-sensitive p36 manner, is equal to one of the address type strings p476 . Within each item p464 with the type http://microformats.org/profile/hcard p469 , there must be no more than one label p471 property item p464 with a type p472 property whose value is pref p476 . Any number of properties with the name type p472 may be present within the item p464 that forms the value p465 of a label p471 property of an item p464 with the type http://microformats.org/profile/hcard p469 , but within each such label p471 property item p464 there must only be one type p472 property per distinct value. value (inside label p471 ) Gives the actual formatted text corresponding to the delivery address of the person or organization. The value p465 must be text. Exactly one property with the name value p472 must be present within the item p464 that forms the value p465 of a label p471 property of an item p464 with the type http://microformats.org/profile/hcard p469 . tel Gives the telephone number of the person or organization. The value p465 must be either text that can be interpreted as a telephone number as defined in the CCITT specifications E.163 and X.121, or an item p464 with zero or more type p472 properties and exactly one value p472 property. [E163] p782 [X121] p786 If no type p472 properties are present within an item p464 that forms the value p465 of a tel p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 , or if the value p465 of such a tel p472 property is text, then the telephone type string p476 voice is implied. Any number of properties with the name tel p472 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . type (inside tel p472 ) Gives the type of telephone number. The value p465 must be text that, when compared in a case-sensitive p36 manner, is equal to one of the telephone type strings p476 . Within each item p464 with the type http://microformats.org/profile/hcard p469 , there must be no more than one tel p472 property item p464 with a type p472 property whose value is pref p477 . Any number of properties with the name type p472 may be present within the item p464 that forms the value p465 of a tel p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 , but within each such tel p472 property item p464 there must only be one type p472 property per distinct value. value (inside tel p472 ) Gives the actual telephone number of the person or organization. The value p465 must be text that can be interpreted as a telephone number as defined in the CCITT specifications E.163 and X.121. [E163] p782 [X121] p786 Exactly one property with the name value p472 must be present within the item p464 that forms the value p465 of a tel p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 . email Gives the e-mail address of the person or organization. The value p465 must be either text or an item p464 with zero or more type p472 properties and exactly one value p473 property. If no type p472 properties are present within an item p464 that forms the value p465 of an email p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 , or if the value p465 of such an email p472 property is text, then the e-mail type string p477 internet is implied. Any number of properties with the name email p472 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . type (inside email p472 ) Gives the type of e-mail address.
472
The value p465 must be text that, when compared in a case-sensitive p36 manner, is equal to one of the e-mail type strings p477 . Within each item p464 with the type http://microformats.org/profile/hcard p469 , there must be no more than one email p472 property item p464 with a type p472 property whose value is pref p477 . Any number of properties with the name type p472 may be present within the item p464 that forms the value p465 of an email p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 , but within each such email p472 property item p464 there must only be one type p472 property per distinct value. value (inside email p472 ) Gives the actual e-mail address of the person or organization. The value p465 must be text. Exactly one property with the name value p473 must be present within the item p464 that forms the value p465 of an email p472 property of an item p464 with the type http://microformats.org/profile/hcard p469 . mailer Gives the name of the e-mail software used by the person or organization. The value p465 must be text. Any number of properties with the name mailer p473 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . tz Gives the time zone of the person or organization. The value p465 must be text and must match the following syntax: 1. 2. Either a U+002B PLUS SIGN character (+) or a U+002D HYPHEN-MINUS character (-). A valid non-negative integer p39 that is exactly two digits long and that represents a number in the range 00..23. A U+003A COLON character (:). A valid non-negative integer p39 that is exactly two digits long and that represents a number in the range 00..59.
3. 4.
Any number of properties with the name tz p473 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . geo Gives the geographical position of the person or organization. The value p465 must be text and must match the following syntax: 1. 2. 3. Optionally, either a U+002B PLUS SIGN character (+) or a U+002D HYPHEN-MINUS character (-). One or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally*, a U+002E FULL STOP character (.) followed by one or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A U+003B SEMICOLON character (;). Optionally, either a U+002B PLUS SIGN character (+) or a U+002D HYPHEN-MINUS character (-). One or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally*, a U+002E FULL STOP character (.) followed by one or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
4. 5. 6. 7.
The optional components marked with an asterisk (*) should be included, and should have six digits each. Note: The value specifies latitude and longitude, in that order (i.e., "LAT LON" ordering), in decimal degrees. The longitude represents the location east and west of the prime meridian as a positive or negative real number, respectively. The latitude represents the location north and south of the equator as a positive or negative real number, respectively. Any number of properties with the name geo p473 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 .
473
title Gives the job title, functional position or function of the person or organization. The value p465 must be text. Any number of properties with the name title p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . role Gives the role, occupation, or business category of the person or organization. The value p465 must be text. Any number of properties with the name role p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . logo Gives the logo of the person or organization. The value p465 must be an absolute URL p56 . Any number of properties with the name logo p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . agent Gives the contact information of another person who will act on behalf of the person or organization. The value p465 must be either an item p464 with the type http://microformats.org/profile/hcard p469 , or an absolute URL p56 , or text. Any number of properties with the name agent p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . org Gives the name and units of the organization. The value p465 must be either text or an item p464 with one organization-name p474 property and zero or more organization-unit properties. Any number of properties with the name org p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . organization-name (inside org p474 ) Gives the name of the organization. The value p465 must be text. Exactly one property with the name organization-name p474 must be present within the item p464 that forms the value p465 of an org p474 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . organization-unit (inside org p474 ) Gives the name of the organization unit. The value p465 must be text. Any number of properties with the name organization-unit p474 may be present within the item p464 that forms the value p465 of the org p474 property of an item p464 with the type http://microformats.org/profile/ hcard p469 . categories Gives the name of a category or tag that the person or organization could be classified as. The value p465 must be text. Any number of properties with the name categories p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . note Gives supplemental information or a comment about the person or organization. The value p465 must be text.
474
Any number of properties with the name note p474 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . rev Gives the revision date and time of the contact information. The value p465 must be text that is a valid global date and time string p47 . Note: The value distinguishes the current revision of the information for other renditions of the information. Any number of properties with the name rev p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . sort-string Gives the string to be used for sorting the person or organization. The value p465 must be text. Any number of properties with the name sort-string p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . sound Gives a sound file relating to the person or organization. The value p465 must be an absolute URL p56 . Any number of properties with the name sound p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . url Gives a URL p55 relating to the person or organization. The value p465 must be an absolute URL p56 . Any number of properties with the name url p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . class Gives the access classification of the information regarding the person or organization. The value p465 must be text with one of the following values: public private confidential
Warning! This is merely advisory and cannot be considered a confidentiality measure. Any number of properties with the name class p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . impp Gives a URL p55 for instant messaging and presence protocol communications with the person or organization. The value p465 must be either an absolute URL p56 or an item p464 with zero or more type p475 properties and exactly one value p476 property. If no type p475 properties are present within an item p464 that forms the value p465 of an impp p475 property of an item p464 with the type http://microformats.org/profile/hcard p469 , or if the value p465 of such an impp p475 property is an absolute URL p56 , then no IMPP type strings p477 are implied. Any number of properties with the name impp p475 may be present within each item p464 with the type http://microformats.org/profile/hcard p469 . type (inside impp p475 ) Gives the intended use of the IMPP URL p55 . The value p465 must be text that, when compared in a case-sensitive p36 manner, is equal to one of the IMPP type strings p477 . Within each item p464 with the type http://microformats.org/profile/hcard p469 , there must be no more than one impp p475 property item p464 with a type p475 property whose value is pref p477 .
475
Any number of properties with the name type p475 may be present within the item p464 that forms the value p465 of an impp p475 property of an item p464 with the type http://microformats.org/profile/hcard p469 , but within each such impp p475 property item p464 there must only be one type p475 property per distinct value. value (inside impp p475 ) Gives the actual URL p55 for instant messaging and presence protocol communications with the person or organization. The value p465 must be an absolute URL p56 . Exactly one property with the name value p476 must be present within the item p464 that forms the value p465 of an impp p475 property of an item p464 with the type http://microformats.org/profile/hcard p469 . The address type strings are: dom Indicates a domestic delivery address. intl Indicates an international delivery address. postal Indicates a postal delivery address. parcel Indicates a parcel delivery address. home Indicates a residential delivery address. work Indicates a delivery address for a place of work. pref Indicates the preferred delivery address when multiple addresses are specified. The telephone type strings are: home Indicates a residential number. msg Indicates a telephone number with voice messaging support. work Indicates a telephone number for a place of work. voice Indicates a voice telephone number. fax Indicates a facsimile telephone number. cell Indicates a cellular telephone number. video Indicates a video conferencing telephone number. pager Indicates a paging device telephone number. bbs Indicates a bulletin board system telephone number. modem Indicates a MODEM-connected telephone number. car Indicates a car-phone telephone number.
476
isdn Indicates an ISDN service telephone number. pcs Indicates a personal communication services telephone number. pref Indicates the preferred telephone number when multiple telephone numbers are specified. The e-mail type strings are: internet Indicates an Internet e-mail address. x400 Indicates a X.400 addressing type. pref Indicates the preferred e-mail address when multiple e-mail addresses are specified. The IMPP type strings are: personal business Indicates the type of communication for which this IMPP URL p55 is appropriate. home work mobile Indicates the location of a device associated with this IMPP URL p55 . pref Indicates the preferred address when multiple IMPP URL p55 s are specified.
5.4.1.1 Conversion to vCard Given a list of nodes nodes in a Document p33 , a user agent must run the following algorithm to extract any vCard data represented by those nodes (only the first vCard is returned): 1. If none of the nodes in nodes are items p464 with the item type p464 http://microformats.org/profile/ hcard p469 , then there is no vCard. Abort the algorithm, returning nothing. Let node be the first node in nodes that is an item p464 with the item type p464 http://microformats.org/profile/hcard p469 . Let output be an empty string. Add a vCard line p479 with the type "BEGIN" and the value "VCARD" to output. Add a vCard line p479 with the type "PROFILE" and the value "VCARD" to output. Add a vCard line p479 with the type "VERSION" and the value "3.0" to output. Add a vCard line p479 with the type "SOURCE" and the result of escaping the vCard text string p480 that is the document's current address p77 as the value to output. If the title element p82 is not null, add a vCard line p479 with the type "NAME" and with the result of escaping the vCard text string p480 obtained from the textContent p33 of the title element p82 as the value to output. If node has a global identifier p464 , add a vCard line p479 with the type "UID" and with the result of escaping the vCard text string p480 of that global identifier p464 as the value to output. For each element element that is a property of the item p466 node: for each name name in element's property names p465 , run the following substeps: 1. 2. Let parameters be an empty set of name-value pairs. Run the appropriate set of substeps from the following list. The steps will set a variable value, which is used in the next step.
2.
3. 4. 5. 6. 7.
8.
9.
10.
477
If the property's value p465 is an item p464 subitem and name is n p469 1. 2. Let value be the empty string. Append to value the result of collecting the first vCard subproperty p480 named family-name p469 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named given-name p469 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named additional-name p469 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named honorific-prefix p470 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named honorific-suffix p470 in subitem.
3. 4.
5. 6.
7. 8.
9. 10.
If the property's value p465 is an item p464 subitem and name is adr p470 1. 2. Let value be the empty string. Append to value the result of collecting vCard subproperties p480 named postoffice-box p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting vCard subproperties p480 named extended-address p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting vCard subproperties p480 named street-address p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named locality p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named region p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named postal-code p471 in subitem. Append a U+003B SEMICOLON character (;) to value. Append to value the result of collecting the first vCard subproperty p480 named country-name p471 in subitem. If there is a property named type p470 in subitem, and the first such property has a value p465 that is not an item p464 and whose value consists only of alphanumeric ASCII characters p37 , then add a parameter named "TYPE" whose value is the value p465 of that property to parameters.
3. 4.
5. 6.
7. 8.
9. 10.
11. 12.
13. 14.
15.
If the property's value p465 is an item p464 subitem and name is org p474 1. 2. Let value be the empty string. Append to value the result of collecting the first vCard subproperty p480 named organization-name p474 in subitem.
478
3.
For each property named organization-unit p474 in subitem, run the following steps: 1. 2. 3. If the value p465 of the property is an item p464 , then skip this property. Append a U+003B SEMICOLON character (;) to value. Append the result of escaping the vCard text string p480 given by the value p465 of the property to value.
If the property's value p465 is an item p464 subitem with the item type p464 http://microformats.org/profile/hcard p469 and name is agent p474 1. Let value be the result of escaping the vCard text string p480 obtained from extracting a vCard p477 from the element that represents subitem. Add a parameter named "VALUE" whose value is "VCARD" to parameters.
2.
If the property's value p465 is an item p464 and name is none of the above 1. Let value be the result of collecting the first vCard subproperty p480 named value in subitem. If there is a property named type in subitem, and the first such property has a value p465 that is not an item p464 and whose value consists only of alphanumeric ASCII characters p37 , then add a parameter named "TYPE" whose value is the value p465 of that property to parameters.
2.
Otherwise (the property's value p465 is not an item p464 ) 1. 2. Let value be the property's value p465 . If element is one of the URL property elements p466 , add a parameter with the name "VALUE" and the value "URI" to parameters. Otherwise, if element is a time p182 element and the value is a valid date string p45 , add a parameter with the name "VALUE" and the value "DATE" to parameters. Otherwise, if element is a time p182 element and the value is a valid global date and time string p47 , add a parameter with the name "VALUE" and the value "DATE-TIME" to parameters. Prefix every U+005C REVERSE SOLIDUS character (\) in value with another U+005C REVERSE SOLIDUS character (\). Prefix every U+002C COMMA character (,) in value with a U+005C REVERSE SOLIDUS character (\). Unless name is geo p473 , prefix every U+003B SEMICOLON character (;) in value with a U+005C REVERSE SOLIDUS character (\). Replace every U+000D CARRIAGE RETURN U+000A LINE FEED character pair (CRLF) in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n). Replace every remaining U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) character in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n).
3.
4.
5.
6.
7.
8.
9.
3.
Add a vCard line p479 with the type name, the parameters parameters, and the value value to output.
11.
Add a vCard line p479 with the type "END" and the value "VCARD" to output.
When the above algorithm says that the user agent is to add a vCard line consisting of a type type, optionally some parameters, and a value value to a string output, it must run the following steps: 1. 2. 3. Let line be an empty string. Append type, converted to ASCII uppercase p36 , to line. If there are any parameters, then for each parameter, in the order that they were added, run these substeps: 1. Append a U+003B SEMICOLON character (;) to line.
479
2. 3. 4. 4. 5. 6. 7.
Append the parameter's name to line. Append a U+003D EQUALS SIGN character (=) to line. Append the parameter's value to line.
Append a U+003A COLON character (:) to line. Append value to line. Let maximum length be 75. If and while line is longer than maximum length Unicode code points long, run the following substeps: 1. 2. 3. 4. 5. 6. Append the first maximum length Unicode code points of line to output. Remove the first maximum length Unicode code points from line. Append a U+000D CARRIAGE RETURN character (CR) to output. Append a U+000A LINE FEED character (LF) to output. Append a U+0020 SPACE character to output. Let maximum length be 74.
8. 9. 10.
Append (what remains of) line to output. Append a U+000D CARRIAGE RETURN character (CR) to output. Append a U+000A LINE FEED character (LF) to output.
When the steps above require the user agent to obtain the result of collecting vCard subproperties named subname in subitem, the user agent must run the following steps: 1. 2. Let value be the empty string. For each property named subname in the item subitem, run the following substeps: 1. 2. If the value p465 of the property is itself an item p464 , then skip this property. If this is not the first property named subname in subitem (ignoring any that were skipped by the previous step), then append a U+002C COMMA character (,) to value. Append the result of escaping the vCard text string p480 given by the value p465 of the property to value.
3.
3.
Return value.
When the steps above require the user agent to obtain the result of collecting the first vCard subproperty named subname in subitem, the user agent must run the following steps: 1. If there are no properties named subname in subitem, then abort these substeps, returning the empty string. If the value p465 of the first property named subname in subitem is an item p464 , then abort these substeps, returning the empty string. Return the result of escaping the vCard text string p480 given by the value p465 of the first property named subname in subitem.
2.
3.
When the above algorithms say the user agent is to escape the vCard text string value, the user agent must use the following steps: 1. Prefix every U+005C REVERSE SOLIDUS character (\) in value with another U+005C REVERSE SOLIDUS character (\). Prefix every U+002C COMMA character (,) in value with a U+005C REVERSE SOLIDUS character (\). Prefix every U+003B SEMICOLON character (;) in value with a U+005C REVERSE SOLIDUS character (\). Replace every U+000D CARRIAGE RETURN U+000A LINE FEED character pair (CRLF) in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n). Replace every remaining U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) character in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n).
2. 3. 4.
5.
480
6.
Note: This algorithm can generate invalid vCard output, if the input does not conform to the rules described for the http://microformats.org/profile/hcard p469 item type p464 and defined property names p465 .
5.4.1.2 Examples This section is non-normative. Here is a long example vCard for a fictional character called "Jack Bauer": <section id="jack" itemscope itemtype="http://microformats.org/profile/hcard"> <h1 itemprop="fn"> <span itemprop="n" itemscope> <span itemprop="given-name">Jack</span> <span itemprop="family-name">Bauer</span> </span> </h1> <img itemprop="photo" alt="" src="jack-bauer.jpg"> <p itemprop="org" itemscope> <span itemprop="organization-name">Counter-Terrorist Unit</span> (<span itemprop="organization-unit">Los Angeles Division</span>) </p> <p> <span itemprop="adr" itemscope> <span itemprop="street-address">10201 W. Pico Blvd.</span><br> <span itemprop="locality">Los Angeles</span>, <span itemprop="region">CA</span> <span itemprop="postal-code">90064</span><br> <span itemprop="country-name">United States</span><br> </span> <span itemprop="geo">34.052339;-118.410623</span> </p> <h2>Assorted Contact Methods</h2> <ul> <li itemprop="tel" itemscope> <span itemprop="value">+1 (310) 597 3781</span> <span itemprop="type">work</span> <meta itemprop="type" content="pref"> </li> <li><a itemprop="url" href="http://en.wikipedia.org/wiki/Jack_Bauer">I'm on Wikipedia</a> so you can leave a message on my user talk page.</li> <li><a itemprop="url" href="http://www.jackbauerfacts.com/">Jack Bauer Facts</a></li> <li itemprop="email"><a href="mailto:[email protected]">[email protected]</a></li> <li itemprop="tel" itemscope> <span itemprop="value">+1 (310) 555 3781</span> <span> <meta itemprop="type" content="cell">mobile phone</span> </li> </ul> <p itemprop="note">If I'm out in the field, you may be better off contacting <span itemprop="agent" itemscope itemtype="http://microformats.org/profile/hcard"><a itemprop="email" href="mailto:[email protected]"><span itemprop="fn"><span itemprop="n" itemscope><span itemprop="given-name">Chloe</span> <span itemprop="family-name">O'Brian</span></span></span></a></span> if it's about work, or ask <span itemprop="agent">Tony Almeida</span> if you're interested in the CTU five-a-side football team we're trying to get going.</p> <ins datetime="2008-07-20T21:00:00+01:00"> <span itemprop="rev" itemscope> <meta itemprop="type" content="date-time"> <meta itemprop="value" content="2008-07-20T21:00:00+01:00"> </span> <p itemprop="tel" itemscope><strong>Update!</strong> My new <span itemprop="type">home</span> phone number is <span itemprop="value">01632 960 123</span>.</p> </ins> </section>
481
The odd line wrapping is needed because newlines are meaningful in microdata: newlines would be preserved in a conversion to, for example, the vCard format. This example shows a site's contact details (using the address p154 element) containing an address with two street components: <address itemscope itemtype="http://microformats.org/profile/hcard"> <strong itemprop="fn"><span itemprop="n" itemscope><span itemprop="given-name">Alfred</span> <span itemprop="family-name">Person</span></span></strong> <br> <span itemprop="adr" itemscope> <span itemprop="street-address">1600 Amphitheatre Parkway</span> <br> <span itemprop="street-address">Building 43, Second Floor</span> <br> <span itemprop="locality">Mountain View</span>, <span itemprop="region">CA</span> <span itemprop="postal-code">94043</span> </span> </address> The vCard vocabulary can be used to just mark up people's names: <span itemscope itemtype="http://microformats.org/profile/hcard" ><span itemprop=fn><span itemprop="n" itemscope><span itemprop="given-name" >George</span> <span itemprop="family-name">Washington</span></span ></span></span> This creates a single item with a two name-value pairs, one with the name "fn" and the value "George Washington", and the other with the name "n" and a second item as its value, the second item having the two name-value pairs "given-name" and "family-name" with the values "George" and "Washington" respectively. This is defined to map to the following vCard: BEGIN:VCARD PROFILE:VCARD VERSION:3.0 SOURCE:document's address FN:George Washington N:Washington;George;;; END:VCARD
5.4.2 vEvent
An item with the item type p464 http://microformats.org/profile/hcalendar#vevent represents an event. This vocabulary supports global identifiers for items p464 . The following are the type's defined property names p465 . They are based on the vocabulary defined in the iCalendar specification, where more information on how to interpret the values can be found. [RFC2445] p784 Note: Only the parts of the iCalendar vocabulary relating to events are used here; this vocabulary cannot express a complete iCalendar instance. attach Gives the address of an associated document for the event. The value p465 must be an absolute URL p56 . Any number of properties with the name attach p482 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . categories Gives the name of a category or tag that the event could be classified as. The value p465 must be text. Any number of properties with the name categories p482 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . class Gives the access classification of the information regarding the event. The value p465 must be text with one of the following values: public
482
private confidential
Warning! This is merely advisory and cannot be considered a confidentiality measure. A single property with the name class p482 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . comment Gives a comment regarding the event. The value p465 must be text. Any number of properties with the name comment p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . description Gives a detailed description of the event. The value p465 must be text. A single property with the name description p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . geo Gives the geographical position of the event. The value p465 must be text and must match the following syntax: 1. 2. 3. Optionally, either a U+002B PLUS SIGN character (+) or a U+002D HYPHEN-MINUS character (-). One or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally*, a U+002E FULL STOP character (.) followed by one or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). A U+003B SEMICOLON character (;). Optionally, either a U+002B PLUS SIGN character (+) or a U+002D HYPHEN-MINUS character (-). One or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). Optionally*, a U+002E FULL STOP character (.) followed by one or more digits in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
4. 5. 6. 7.
The optional components marked with an asterisk (*) should be included, and should have six digits each. Note: The value specifies latitude and longitude, in that order (i.e., "LAT LON" ordering), in decimal degrees. The longitude represents the location east and west of the prime meridian as a positive or negative real number, respectively. The latitude represents the location north and south of the equator as a positive or negative real number, respectively. A single property with the name geo p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . location Gives the location of the event. The value p465 must be text. A single property with the name location p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . resources Gives a resource that will be needed for the event. The value p465 must be text. Any number of properties with the name resources p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . status Gives the confirmation status of the event.
483
The value p465 must be text with one of the following values: tentative confirmed cancelled
A single property with the name status p483 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . summary Gives a short summary of the event. The value p465 must be text. User agents should replace U+000A LINE FEED (LF) characters in the value p465 by U+0020 SPACE characters when using the value. A single property with the name summary p484 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . dtend Gives the date and time by which the event ends. If the property with the name dtend p484 is present within an item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 that has a property with the name dtstart p484 whose value is a valid date string p45 , then the value p465 of the property with the name dtend p484 must be text that is a valid date string p45 also. Otherwise, the value p465 of the property must be text that is a valid global date and time string p47 . In either case, the value p465 be later in time than the value of the dtstart property of the same item p464 . Note: The time given by the dtend p484 property is not inclusive. For day-long events, therefore, the dtend p484 property's value p465 will be the day after the end of the event. A single property with the name dtend p484 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 , so long as that http://microformats.org/ profile/hcalendar#vevent p482 does not have a property with the name duration p484 . dtstart Gives the date and time at which the event starts. The value p465 must be text that is either a valid date string p45 or a valid global date and time string p47 . Exactly one property with the name dtstart p484 must be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . duration Gives the duration of the event. The value p465 must be text that is a valid vevent duration string p486 . The duration represented is the sum of all the durations represented by integers in the value. A single property with the name duration p484 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 , so long as that http://microformats.org/ profile/hcalendar#vevent p482 does not have a property with the name dtend p484 . transp Gives whether the event is to be considered as consuming time on a calendar, for the purpose of free-busy time searches. The value p465 must be text with one of the following values: opaque transparent
A single property with the name transp p484 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . contact Gives the contact information for the event. The value p465 must be text.
484
Any number of properties with the name contact p484 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . url Gives a URL p55 for the event. The value p465 must be an absolute URL p56 . A single property with the name url p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . exdate Gives a date and time at which the event does not occur despite the recurrence rules. The value p465 must be text that is either a valid date string p45 or a valid global date and time string p47 . Any number of properties with the name exdate p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . exrule Gives a rule for finding dates and times at which the event does not occur despite the recurrence rules. The value p465 must be text that matches the RECUR value type defined in the iCalendar specification. [RFC2445] p784 Any number of properties with the name exrule p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . rdate Gives a date and time at which the event recurs. The value p465 must be text that is one of the following: A valid date string p45 . A valid global date and time string p47 . A valid global date and time string p47 followed by a U+002F SOLIDUS character (/) followed by a second valid global date and time string p47 representing a later time. A valid global date and time string p47 followed by a U+002F SOLIDUS character (/) followed by a valid vevent duration string p486 .
Any number of properties with the name rdate p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . rrule Gives a rule for finding dates and times at which the event occurs. The value p465 must be text that matches the RECUR value type defined in the iCalendar specification. [RFC2445] p784 Any number of properties with the name rrule p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . created Gives the date and time at which the event information was first created in a calendaring system. The value p465 must be text that is a valid global date and time string p47 . A single property with the name created p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . last-modified Gives the date and time at which the event information was last modified in a calendaring system. The value p465 must be text that is a valid global date and time string p47 . A single property with the name last-modified p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . sequence Gives a revision number for the event information.
485
The value p465 must be text that is a valid non-negative integer p39 . A single property with the name sequence p485 may be present within each item p464 with the type http://microformats.org/profile/hcalendar#vevent p482 . A string is a valid vevent duration string if it matches the following pattern: 1. 2. A U+0050 LATIN CAPITAL LETTER P character (P). One of the following: A valid non-negative integer p39 followed by a U+0057 LATIN CAPITAL LETTER W character (W). The integer represents a duration of that number of weeks. At least one, and possible both in this order, of the following: 1. A valid non-negative integer p39 followed by a U+0044 LATIN CAPITAL LETTER D character (D). The integer represents a duration of that number of days. 2. A U+0054 LATIN CAPITAL LETTER T character (T) followed by any one of the following, or the first and second of the following in that order, or the second and third of the following in that order, or all three of the following in this order: 1. A valid non-negative integer p39 followed by a U+0048 LATIN CAPITAL LETTER H character (H). The integer represents a duration of that number of hours. 2. A valid non-negative integer p39 followed by a U+004D LATIN CAPITAL LETTER M character (M). The integer represents a duration of that number of minutes. 3. A valid non-negative integer p39 followed by a U+0053 LATIN CAPITAL LETTER S character (S). The integer represents a duration of that number of seconds.
5.4.2.1 Conversion to iCalendar Given a list of nodes nodes in a Document p33 , a user agent must run the following algorithm to extract any vEvent data represented by those nodes: 1. If none of the nodes in nodes are items p464 with the type http://microformats.org/profile/ hcalendar#vevent p482 , then there is no vEvent data. Abort the algorithm, returning nothing. Let output be an empty string. Add an iCalendar line p487 with the type "BEGIN" and the value "VCALENDAR" to output. Add an iCalendar line p487 with the type "PRODID" and the value equal to a user-agent-specific string representing the user agent to output. Add an iCalendar line p487 with the type "VERSION" and the value "2.0" to output. For each node node in nodes that is an item p464 with the type http://microformats.org/profile/ hcalendar#vevent p482 , run the following steps: 1. 2. Add an iCalendar line p487 with the type "BEGIN" and the value "VEVENT" to output. Add an iCalendar line p487 with the type "DTSTAMP" and a value consisting of an iCalendar DATETIME string representing the current date and time, with the annotation "VALUE=DATE-TIME", to output. [RFC2445] p784 If the item p464 has a global identifier p464 , add an iCalendar line p487 with the type "UID" and that global identifier p464 as the value to output. For each element element that is a property of the item p466 node: for each name name in element's property names p465 , run the appropriate set of substeps from the following list: If the property's value p465 is an item p464 Skip the property. If element is a time p182 element Let value be the result of stripping all U+002D HYPHEN-MINUS (-) and U+003A COLON (:) characters from the property's value p465 . If the property's value p465 is a valid date string p45 then add an iCalendar line p487 with the type name and the value value to output, with the annotation "VALUE=DATE". Otherwise, if the property's value p465 is a valid global date and time string p47 then add an iCalendar line p487 with the type name and the value value to output, with the annotation "VALUE=DATE-TIME".
2. 3. 4.
5. 6.
3.
4.
486
Otherwise skip the property. Otherwise Add an iCalendar line p487 with the type name and the property's value p465 to output. 5. 7. Add an iCalendar line p487 with the type "END" and the value "VEVENT" to output.
Add an iCalendar line p487 with the type "END" and the value "VCALENDAR" to output.
When the above algorithm says that the user agent is to add an iCalendar line consisting of a type type, a value value, and optionally an annotation, to a string output, it must run the following steps: 1. 2. 3. Let line be an empty string. Append type, converted to ASCII uppercase p36 , to line. If there is an annotation: 1. 2. 4. 5. Append a U+003B SEMICOLON character (;) to line. Append the annotation to line.
Append a U+003A COLON character (:) to line. Prefix every U+005C REVERSE SOLIDUS character (\) in value with another U+005C REVERSE SOLIDUS character (\). Prefix every U+002C COMMA character (,) in value with a U+005C REVERSE SOLIDUS character (\). Prefix every U+003B SEMICOLON character (;) in value with a U+005C REVERSE SOLIDUS character (\). Replace every U+000D CARRIAGE RETURN U+000A LINE FEED character pair (CRLF) in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n). Replace every remaining U+000D CARRIAGE RETURN (CR) or U+000A LINE FEED (LF) character in value with a U+005C REVERSE SOLIDUS character (\) followed by a U+006E LATIN SMALL LETTER N character (n). Append value to line. Let maximum length be 75. If and while line is longer than maximum length Unicode code points long, run the following substeps: 1. 2. 3. 4. 5. 6. Append the first maximum length Unicode code points of line to output. Remove the first maximum length Unicode code points from line. Append a U+000D CARRIAGE RETURN character (CR) to output. Append a U+000A LINE FEED character (LF) to output. Append a U+0020 SPACE character to output. Let maximum length be 74.
6. 7. 8.
9.
Append (what remains of) line to output. Append a U+000D CARRIAGE RETURN character (CR) to output. Append a U+000A LINE FEED character (LF) to output.
Note: This algorithm can generate invalid iCalendar output, if the input does not conform to the rules described for the http://microformats.org/profile/hcalendar#vevent p482 item type p464 and defined property names p465 .
5.4.2.2 Examples This section is non-normative. Here is an example of a page that uses the vEvent vocabulary to mark up an event: <body itemscope itemtype="http://microformats.org/profile/hcalendar#vevent"> ... <h1 itemprop="summary">Bluesday Tuesday: Money Road</h1> ... <time itemprop="dtstart" datetime="2009-05-05T19:00:00Z">May 5th @ 7pm</time>
487
(until <time itemprop="dtend" datetime="2009-05-05T21:00:00Z">9pm</time>) ... <a href="http://livebrum.co.uk/2009/05/05/bluesday-tuesday-money-road" rel="bookmark" itemprop="url">Link to this page</a> ... <p>Location: <span itemprop="location">The RoadHouse</span></p> ... <p><input type=button value="Add to Calendar" onclick="location = getCalendar(this)"></p> ... <meta itemprop="description" content="via livebrum.co.uk"> </body> The "getCalendar()" method could look like this: function getCalendar(node) { // This function assumes the content is valid. // It is not a compliant implementation of the algorithm for extracting vEvent data. while (node && (!node.itemScope || !node.itemType == 'http://microformats.org/ profile/hcalendar#vevent')) node = node.parentNode; if (!node) { alert('No event data found.'); return; } var stamp = new Date(); var stampString = '' + stamp.getUTCFullYear() + (stamp.getUTCMonth() + 1) + stamp.getUTCDate() + 'T' + stamp.getUTCHours() + stamp.getUTCMinutes() + stamp.getUTCSeconds() + 'Z'; var calendar = 'BEGIN:VCALENDAR\r\nPRODID:HTML\r\nVERSION:2.0\r\nBEGIN:VEVENT\r\nDTSTAMP:' + stampString + '\r\n'; if (node.itemId) calendar += 'UID:' + node.itemId + '\r\n'; for (var propIndex = 0; propIndex < node.properties.length; propIndex += 1) { var prop = node.properties[propIndex]; var value = prop.itemValue; var parameters = ''; if (prop.localName == 'time') { value = value.replace(/[:-]/g, ''); if (value.match(/T/)) parameters = ';VALUE=DATE'; else parameters = ';VALUE=DATE-TIME'; } else { value = value.replace(/\\/g, '\\n'); value = value.replace(/;/g, '\\;'); value = value.replace(/,/g, '\\,'); value = value.replace(/\n/g, '\\n'); } for (var nameIndex = 0; nameIndex < prop.itemProp.length; nameIndex += 1) { var name = prop.itemProp[nameIndex]; if (!name.match(/:/) && !name.match(/\./)) calendar += name.toUpperCase() + parameters + ':' + value + '\r\n'; } } calendar += 'END:VEVENT\r\nEND:VCALENDAR\r\n'; return 'data:text/calendar;component=vevent,' + encodeURI(calendar); } The same page could offer some markup, such as the following, for copy-and-pasting into blogs: <div itemscope itemtype="http://microformats.org/profile/hcalendar#vevent"> <p>I'm going to <strong itemprop="summary">Bluesday Tuesday: Money Road</strong>, <time itemprop="dtstart" datetime="2009-05-05T19:00:00Z">May 5th at 7pm</time> to <time itemprop="dtend" content="2009-05-05T21:00:00Z">9pm</time>, at <span itemprop="location">The RoadHouse</span>!</p> <p><a href="http://livebrum.co.uk/2009/05/05/bluesday-tuesday-money-road" itemprop="url">See this event on livebrum.co.uk</a>.</p>
488
5.4.3.1 Conversion to RDF For the purposes of RDF processors, the triples obtained from the following Turtle must be applied: <http://www.w3.org/1999/xhtml/microdata#https%3A%2F%2Ffanyv88.com%3A443%2Fhttp%2Fn.whatwg.org%2Fwork%23%3Awork> <http://www.w3.org/2002/07/owl#equivalentProperty> <http://www.w3.org/2002/07/owl#sameAs> . <http://www.w3.org/1999/xhtml/microdata#https%3A%2F%2Ffanyv88.com%3A443%2Fhttp%2Fn.whatwg.org%2Fwork%23%3Atitle> <http://www.w3.org/2002/07/owl#equivalentProperty> <http://purl.org/dc/terms/title> . <http://www.w3.org/1999/xhtml/microdata#https%3A%2F%2Ffanyv88.com%3A443%2Fhttp%2Fn.whatwg.org%2Fwork%23%3Aauthor> <http://www.w3.org/2002/07/owl#equivalentProperty> <http://creativecommons.org/ns#attributionName> . <http://www.w3.org/1999/xhtml/microdata#https%3A%2F%2Ffanyv88.com%3A443%2Fhttp%2Fn.whatwg.org%2Fwork%23%3Alicense> <http://www.w3.org/2002/07/owl#equivalentProperty> <http://www.w3.org/1999/xhtml/vocab#license> . Note: The subjects of the statements above are the predicates that result from converting to RDF p490 an HTML page containing microdata with an item whose type p464 is "http://n.whatwg.org/work p489 ".
5.4.3.2 Examples This section is non-normative. This example shows an embedded image entitled My Pond, licensed under the Creative Commons Attribution-Share Alike 3.0 United States License and the MIT license simultaneously. <figure itemscope itemtype="http://n.whatwg.org/work"> <img itemprop="work" src="mypond.jpeg">
489
<figcaption> <p><cite itemprop="title">My Pond</cite></p> <p><small>Licensed under the <a itemprop="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a> and the <a itemprop="license" href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</small> </figcaption> </figure>
4. 5.
When the user agent is to get the object for an item item, it must run the following substeps: 1. 2. Let result be an empty object. If the item has an item type p464 , add an entry to result called "type" whose value is the item type p464 of item. If the item has an global identifier p464 , add an entry to result called "id" whose value is the global identifier p464 of item. Let properties be an empty object. For each element element that has one or more property names p465 and is one of the properties of the item p466 item, in the order those elements are given by the algorithm that returns the properties of an item p466 , run the following substeps: 1. 2. Let value be the property value p465 of element. If value is an item p464 , then get the object p490 for value, and then replace value with the object returned from those steps. For each name name in element's property names p465 , run the following substeps: 1. If there is no entry named name in properties, then add an entry named name to properties whose value is an empty array. Append value to the entry named name in properties.
3.
4. 5.
3.
2. 6. 7.
Add an entry to result called "properties" whose value is the object properties. Return result.
5.5.2 RDF
To convert a Document to RDF, a user agent must run the following algorithm: 1. If the title element p82 is not null, then generate the following triple: subject : the document's current address p77 predicate : http://purl.org/dc/terms/title object : the concatenation of the data of all the child text nodes p29 of the title element p82 , in tree order p29 , as a plain literal, with the language information set from the language p93 of the title element p82 , if it is not unknown.
490
2.
For each a p173 , area p314 , and link p119 element in the Document p33 , run these substeps: 1. 2. 3. If the element does not have a rel attribute, then skip this element. If the element does not have an href attribute, then skip this element. If resolving p55 the element's href attribute relative to the element is not successful, then skip this element. Otherwise, split the value of the element's rel attribute on spaces p53 , obtaining list of tokens. Convert each token in list of tokens that does not contain a U+003A COLON characters (:) to ASCII lowercase p36 . If list of tokens contains more than one instance of the token up p448 , then remove all such tokens. Coalesce duplicate tokens in list of tokens. If list of tokens contains both the tokens alternate p443 and stylesheet p447 , then remove them both and replace them with the single (uppercase) token ALTERNATE-STYLESHEET. For each token token in list of tokens that contains no U+003A COLON characters (:), generate the following triple: subject : the document's current address p77 predicate : the concatenation of the string "http://www.w3.org/1999/xhtml/vocab#" and token, with any characters in token that are not valid in the <ifragment> production of the IRI syntax being %-escaped [RFC3987] p784 object : the absolute URL p56 that results from resolving p55 the value of the element's href attribute relative to the element For each token token in list of tokens that is an absolute URL p56 , generate the following triple: subject : the document's current address p77 predicate : token object : the absolute URL p56 that results from resolving p55 the value of the element's href attribute relative to the element
4. 5.
6.
7. 8.
9.
3.
For each meta p122 element in the Document p33 that has a name p123 attribute and a content p123 attribute, if the value of the name p123 attribute contains no U+003A COLON characters (:), generate the following triple: subject : the document's current address p77 predicate : the concatenation of the string "http://www.w3.org/1999/xhtml/vocab#" and the value of the element's name p123 attribute, converted to ASCII lowercase p36 , with any characters in the value that are not valid in the <ifragment> production of the IRI syntax being %-escaped [RFC3987] p784 object : the value of the element's content p123 attribute, as a plain literal, with the language information set from the language p93 of the element, if it is not unknown For each meta p122 element in the Document p33 that has a name p123 attribute and a content p123 attribute, if the value of the name p123 attribute is an absolute URL p56 , generate the following triple: subject : the document's current address p77 predicate : the value of the element's name p123 attribute object : the value of the element's content p123 attribute, as a plain literal, with the language information set from the language p93 of the element, if it is not unknown
4.
For each blockquote p163 and q p179 element in the Document p33 that has a cite attribute that resolves p55 successfully relative to the element, generate the following triple: subject : the document's current address p77 predicate : http://purl.org/dc/terms/source object : the absolute URL p56 that results from resolving p55 the value of the element's cite attribute relative to the element
5. 6.
Let memory be a mapping of items to subjects, initially empty. For each element that is also a top-level microdata item p466 , run the following steps: 1. Generate the triples for the item p492 . Pass a reference to memory as the item/subject list. Let result be the subject returned. Generate the following triple:
2.
491
subject : the document's current address p77 predicate : http://www.w3.org/1999/xhtml/microdata#item object : result When the user agent is to generate the triples for an item item, given a reference to an item/subject list memory, and optionally given a fallback type fallback type and property name fallback name, it must follow the following steps: 1. If there is an entry for item in memory, then let subject be the subject of that entry. Otherwise, if item has a global identifier p464 and that global identifier p464 is an absolute URL p56 , let subject be that global identifier p464 . Otherwise, let subject be a new blank node. Add a mapping from item to subject in memory, if there isn't one already. If item has an item type p464 and that item type p464 is an absolute URL p56 , let type be that item type p464 . Otherwise, let type be the empty string. If type is not the empty string, run the following steps: 1. Generate the following triple: subject : subject predicate : http://www.w3.org/1999/02/22-rdf-syntax-ns#type object : type 2. If type does not contain a U+0023 NUMBER SIGN character (#), then append a U+0023 NUMBER SIGN character (#) to type. If type does not have a U+003A COLON character (:) after its U+0023 NUMBER SIGN character (#), append a U+003A COLON character (:) to type.
2. 3.
4.
3.
5.
If type is the empty string, but fallback type is not, run the following substeps: 1. 2. Let type have the value of fallback type. If type does not contain a U+0023 NUMBER SIGN character (#), then append a U+0023 NUMBER SIGN character (#) to type. If type does not have a U+003A COLON character (:) after its U+0023 NUMBER SIGN character (#), append a U+003A COLON character (:) to type. If the last character of type is not a U+003A COLON character (:), append a U+0025 PERCENT SIGN character (%), a U+0032 DIGIT TWO character (2), and a U+0030 DIGIT ZERO character (0) to type. Append the value of fallback name to type, with any characters in fallback name that are not valid in the <ifragment> production of the IRI syntax being %-escaped. [RFC3987] p784
3.
4.
5.
6.
For each element element that has one or more property names p465 and is one of the properties of the item p466 item, in the order those elements are given by the algorithm that returns the properties of an item p466 , run the following substep: 1. For each name name in element's property names p465 , run the following substeps: 1. If type is the empty string and name is not an absolute URL p56 , then abort these substeps. Let value be the property value p465 of element. If value is an item p464 , then generate the triples p492 for value. Pass a reference to memory as the item/subject list, and pass type as the fallback type and name as the fallback property name. Replace value by the subject returned from those steps. Otherwise, if element is not one of the URL property elements p466 , let value be a plain literal, with the language information set from the language p93 of the element, if it is not unknown. If name is an absolute URL p56 Let predicate be name. If name contains no U+003A COLON characters (:) 1. Let s be type.
2. 3.
4.
5.
492
2.
If the last character of s is not a U+003A COLON character (:), append a U+0025 PERCENT SIGN character (%), a U+0032 DIGIT TWO character (2), and a U+0030 DIGIT ZERO character (0) to s. Append the value of name to s, with any characters in name that are not valid in the <ifragment> production of the IRI syntax being %escaped. [RFC3987] p784 Let predicate be the concatenation of the string "http://www.w3.org/1999/xhtml/microdata#" and s, with any characters in s that are not valid in the <ifragment> production of the IRI syntax being %-escaped, but without double-escaping existing %-escapes. [RFC3987] p784 For example if the string s is "http://example.com/ a#:q%20r", the resulting predicate would be "http://www.w3.org/1999/xhtml/ microdata#http://example.com/a%23:q%20r".
3.
4.
6.
Generate the following triple: subject : subject predicate : predicate object : value
7.
Return subject.
5.5.2.1 Examples This section is non-normative. Here is an example of some HTML using Microdata to express RDF statements: <dl itemscope itemtype="http://purl.org/vocab/frbr/core#Work" itemid="http://purl.oreilly.com/works/45U8QJGZSQKDH8N"> <dt>Title</dt> <dd><cite itemprop="http://purl.org/dc/terms/title">Just a Geek</cite></dd> <dt>By</dt> <dd><span itemprop="http://purl.org/dc/elements/1.1/creator">Wil Wheaton</span></dd> <dt>Format</dt> <dd itemprop="http://purl.org/vocab/frbr/core#realization" itemscope itemtype="http://purl.org/vocab/frbr/core#Expression" itemid="http://purl.oreilly.com/products/9780596007683.BOOK"> <link itemprop="http://purl.org/dc/terms/type" href="http://purl.oreilly.com/ product-types/BOOK"> Print </dd> <dd itemprop="http://purl.org/vocab/frbr/core#realization" itemscope itemtype="http://purl.org/vocab/frbr/core#Expression" itemid="http://purl.oreilly.com/products/9780596802189.EBOOK"> <link itemprop="http://purl.org/dc/terms/type" href="http://purl.oreilly.com/ product-types/EBOOK"> Ebook </dd> </dl> This is equivalent to the following Turtle: @prefix dct: <http://purl.org/dc/terms/> . @prefix dce: <http://purl.org/dc/elements/1.1/> . @prefix frbr: <http://purl.org/vocab/frbr/core#> . <http://purl.oreilly.com/works/45U8QJGZSQKDH8N> a frbr:Work ; dce:creator "Wil Wheaton"@en ; dct:title "Just a Geek"@en ; frbr:realization <http://purl.oreilly.com/products/9780596007683.BOOK>, <http://purl.oreilly.com/products/9780596802189.EBOOK> . <http://purl.oreilly.com/products/9780596007683.BOOK> a frbr:Expression ; dct:type <http://purl.oreilly.com/product-types/BOOK> .
493
<http://purl.oreilly.com/products/9780596802189.EBOOK> a frbr:Expression ; dct:type <http://purl.oreilly.com/product-types/EBOOK> . The following snippet of HTML has microdata for two people with the same address: <p> Both <span itemscope itemtype="http://microformats.org/profile/hcard" itemref="home"><span itemprop="fn" ><span itemprop="n" itemscope><span itemprop="given-name">Princeton</span></span></span></span> and <span itemscope itemtype="http://microformats.org/profile/hcard" itemref="home"><span itemprop="fn" ><span itemprop="n" itemscope><span itemprop="given-name">Trekkie</span></span></span></span> live at <span id="home" itemprop="adr" itemscope><span itemprop="street-address">Avenue Q</span>.</span> </p> It generates these triples expressed in Turtle (including a triple that in this case is expressed twice, though that is not meaningful in RDF): @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix dct: <http://purl.org/dc/terms/> . @prefix hcard: <http://www.w3.org/1999/xhtml/microdata#http://microformats.org/profile/ hcard%23:> . <> <http://www.w3.org/1999/xhtml/microdata#item> _:n0 ; <http://www.w3.org/1999/xhtml/microdata#item> _:n1 . _:n0 rdf:type <http://microformats.org/profile/hcard> ; hcard:fn "Princeton" ; hcard:n _:n0a hcard:adr _:n2 . _:n0a hcard:n%20given-name "Princeton" . _:n1 rdf:type <http://microformats.org/profile/hcard> ; hcard:fn "Trekkie" ; hcard:n _:n1a hcard:adr _:n2 . _:n1a hcard:n%20given-name "Trekkie" . _:n2 hcard:adr%20street-address "Avenue Q" ; hcard:adr%20street-address "Avenue Q" .
5.5.3 Atom
Given a Document p33 source, a user agent may run the following algorithm to extract an Atom feed. This is not the only algorithm that can be used for this purpose; for instance, a user agent might instead use the hAtom algorithm. [HATOM] p782 1. If the Document p33 source does not contain any article p147 elements, then return nothing and abort these steps. This algorithm can only be used with documents that contain distinct articles. Let R be an empty XML p77 Document p33 object whose address p77 is user-agent defined. Append a feed element in the Atom namespace p498 to R. For each meta p122 element with a name p123 attribute and a content p123 attribute and whose name p123 attribute's value is author p124 , run the following substeps: 1. 2. Append an author element in the Atom namespace p498 to the root element of R. Append a name element in the Atom namespace p498 to the element created in the previous step. Append a text node whose data is the value of the meta p122 element's content p123 attribute to the element created in the previous step.
2. 3. 4.
3.
5.
If there is a link p119 element whose rel p120 attribute's value includes the keyword icon p445 , and that element also has an href p120 attribute whose value successfully resolves p55 relative to the link p119 element, then append an icon element in the Atom namespace p498 to the root element of R whose
494
contents is a text node with its data set to the absolute URL p56 resulting from resolving p55 the value of the href p120 attribute. 6. Append an id element in the Atom namespace p498 to the root element of R whose contents is a text node with its data set to the document's current address p77 . Optionally: Let x be a link element in the Atom namespace p498 . Add a rel attribute whose value is the string "self" to x. Append a text node with its data set to the (user-agent-defined) address p77 of R to x. Append x to the root element of R. Note: This step would be skipped when the document R has no convenient address p77 . The presence of the rel="self" link is a "should"-level requirement in the Atom specification. 8. Let x be a link element in the Atom namespace p498 . Add a rel attribute whose value is the string "alternate" to x. If the document being converted is an HTML document p77 , add a type attribute whose value is the string "text/html p757 " to x. Otherwise, the document being converted is an XML document p77 ; add a type attribute whose value is the string "application/xhtml+xml p759 " to x. Add an href attribute whose value is the document's current address p77 to x. Append x to the root element of R. Let subheading content be an empty list. Let heading be the first element of heading content p100 whose nearest ancestor of sectioning content p100 is the body element p83 , if any, or null if there is none. Take the appropriate action from the following list, as determined by the type of the heading element: If heading is null Let heading content be the descendants the title element p82 , if there is one, or an empty list otherwise. If heading is a hgroup p151 element If heading contains no child h1 p150 h6 p150 elements, let heading content be an empty list. Otherwise, let headings list be a list of all the h1 p150 h6 p150 element children of heading, sorted first by descending rank p151 and then in tree order p29 (so h1 p150 s first, then h2 p150 s, etc, with each group in the order they appear in the document). Then, let heading content be the descendants of the first entry in headings list, and if there are multiple entries, let subheading content be the descendants of the second entry in headings list. If heading is an h1 p150 h6 p150 element Let heading content be the descendants of heading. 12. Clone the nodes in heading content and their descendants into an environment that has scripting disabled p550 , has no plugins p29 , and fails any attempt to fetch p59 any resources. Let cloned heading content be a new DocumentFragment p33 containing the resulting cloned nodes, preserving their relative order. If the document being converted is an HTML document p77 , then: Let x be a title element in the Atom namespace p498 . Add a type attribute whose value is the string "html" to x. Append a text node with its data set to the result of running the HTML fragment serialization algorithm p694 on cloned heading content to x. Append x to the root element of R. Otherwise, the document being converted is an XML document p77 : Let x be a title element in the Atom namespace p498 . Add a type attribute whose value is the string "xhtml" to x. Append a div p172 element to x. Move all the child nodes of the cloned heading content node to that div p172 element, preserving their relative order. Append x to the root element of R. 14. If subheading content is not an empty list, run these substeps: 1. Clone the nodes in subheading content and their descendants into an environment that has scripting disabled p550 , has no plugins p29 , and fails any attempt to fetch p59 any resources. Let cloned subheading content be a new DocumentFragment p33 containing the resulting cloned nodes, preserving their relative order. If the document being converted is an HTML document p77 , then: Let x be a subtitle element in the Atom namespace p498 . Add a type attribute whose value is the string "html" to x. Append a text node with its data set to the result of running the HTML fragment serialization algorithm p694 on cloned subheading content to x. Append x to the root element of R. Otherwise, the document being converted is an XML document p77 : Let x be a subtitle element in the Atom namespace p498 . Add a type attribute whose value is the string "xhtml" to
7.
9. 10.
11.
13.
2.
495
x. Append a div p172 element to x. Move all the child nodes of the cloned subheading content node to that div p172 element, preserving their relative order. Append x to the root element of R. 15. 16. Let global update date have no value. For each article p147 element article that does not have an ancestor article p147 element, run the following steps: 1. 2. Let E be an entry element in the Atom namespace p498 , and append E to the root element of R. Set the xml:base p93 attribute of E to the base URI of the element article, as defined by the XML Base specification, with the base URI of the document entity being defined as the document base URL p56 of the Document p33 source. [XMLBASE] p786 For the purposes of the XML Base specification, user agents must act as if all Document p33 objects represented XML documents. 3. Let heading be the first element of heading content p100 whose nearest ancestor of sectioning content p100 is article, if any, or null if there is none. Take the appropriate action from the following list, as determined by the type of the heading element: If heading is null Let heading content be an empty list. If heading is a hgroup p151 element If heading contains no child h1 p150 h6 p150 elements, let heading content be an empty list. Otherwise, let headings list be a list of all the h1 p150 h6 p150 element children of heading, sorted first by descending rank p151 and then in tree order p29 (so h1 p150 s first, then h2 p150 s, etc, with each group in the order they appear in the document). Then, let heading content be the descendants of the first entry in headings list. If heading is an h1 p150 h6 p150 element Let heading content be the descendants of heading. 5. Clone the nodes in heading content and their descendants into an environment that has scripting disabled p550 , has no plugins p29 , and fails any attempt to fetch p59 any resources. Let cloned heading content be a new DocumentFragment p33 containing the resulting cloned nodes, preserving their relative order. If the document being converted is an HTML document p77 , then: Let x be a title element in the Atom namespace p498 . Add a type attribute whose value is the string "html" to x. Append a text node with its data set to the result of running the HTML fragment serialization algorithm p694 on cloned heading content to x. Append x to E. Otherwise, the document being converted is an XML document p77 : Let x be a title element in the Atom namespace p498 . Add a type attribute whose value is the string "xhtml" to x. Append a div p172 element to x. Move all the child nodes of the cloned heading content node to that div p172 element, preserving their relative order. Append x to E. 7. Clone article and its descendants into an environment that has scripting disabled p550 , has no plugins p29 , and fails any attempt to fetch p59 any resources. Let cloned article be the resulting clone article p147 element. Remove from the subtree rooted at cloned article any article p147 elements other than the cloned article itself, any header p152 , footer p153 , or nav p145 elements whose nearest ancestor of sectioning content p100 is the cloned article, and the first element of heading content p100 whose nearest ancestor of sectioning content p100 is the cloned article, if any. If cloned article contains any ins p196 or del p197 elements with datetime p198 attributes whose values parse as global date and time strings p48 without errors, then let update date be the value of the datetime p198 attribute that parses to the newest global date and time p47 . Otherwise, let update date have no value. Note: This value is used below; it is calculated here because in certain cases the next step mutates the cloned article.
4.
6.
8.
9.
496
Note: Any ins p196 or del p197 elements whose datetime p198 attributes have values that are just valid date strings p45 (i.e. that have no time component) are ignored for the purposes of finding the update time of an entry. 10. If the document being converted is an HTML document p77 , then: Let x be a content element in the Atom namespace p498 . Add a type attribute whose value is the string "html" to x. Append a text node with its data set to the result of running the HTML fragment serialization algorithm p694 on cloned article to x. Append x to E. Otherwise, the document being converted is an XML document p77 : Let x be a content element in the Atom namespace p498 . Add a type attribute whose value is the string "xhtml" to x. Append a div p172 element to x. Move all the child nodes of the cloned article node to that div p172 element, preserving their relative order. Append x to E. 11. Establish the value of id and has-alternate from the first of the following to apply: If the article node has a descendant a p173 or area p314 element with an href p440 attribute that successfully resolves p55 relative to that descendant and a rel p440 attribute whose value includes the bookmark p444 keyword Let id be the absolute URL p56 resulting from resolving p55 the value of the href p440 attribute of the first such a p173 or area p314 element, relative to the element. Let hasalternate be true. If the article node has an id p92 attribute Let id be the document's current address p77 , with the fragment identifier (if any) removed, and with a new fragment identifier specified, consisting of the value of the article element's id p92 attribute. Let has-alternate be false. Otherwise Let id be a user-agent-defined undereferenceable yet globally unique valid p55 absolute URL p56 . The same absolute URL p56 should be generated for each run of this algorithm when given the same input. Let has-alternate be false. 12. Append an id element in the Atom namespace p498 to E whose contents is a text node with its data set to id. If has-alternate is true: Let x be a link element in the Atom namespace p498 . Add a rel attribute whose value is the string "alternate" to x. Add an href attribute whose value is id to x. Append x to E. If article has a time p182 element descendant that has a pubdate p182 attribute and whose nearest ancestor article p147 element is article, and the first such element's date p183 is not unknown, then run the following substeps, with e being the first such element: 1. Let datetime be a global date and time p47 whose date component is the date p183 of e. If e's time p183 and time-zone offset p183 are not unknown, then let datetime's time and time-zone offset components be the time p183 and time-zone offset p183 of e. Otherwise, let them be midnight and no offset respectively ("00:00Z"). Let publication date be the best representation of the global date and time string p48 datetime.
13.
14.
2.
3.
Otherwise, let publication date have no value. 15. If update date has no value but publication date does, then let update date have the value of publication date. Otherwise, if publication date has no value but update date does, then let publication date have the value of update date. 16. If update date has a value, and global update date has no value or is less recent than update date, then let global update date have the value of update date. If publication date and update date both still have no value, then let them both value a value that is a valid global date and time string p47 representing the global date and time p47 of the moment that this algorithm was invoked. Append an published element in the Atom namespace p498 to E whose contents is a text node with its data set to publication date.
17.
18.
497
19.
Append an updated element in the Atom namespace p498 to E whose contents is a text node with its data set to update date.
17.
If global update date has no value, then let it have a value that is a valid global date and time string p47 representing the global date and time p47 of the date and time of the Document p33 's source file's last modification, if it is known, or else of the moment that this algorithm was invoked. Insert an updated element in the Atom namespace p498 into the root element of R before the first entry in the Atom namespace p498 whose contents is a text node with its data set to global update date. Return the Atom document R.
18.
19.
Note: The above algorithm does not guarantee that the output will be a conforming Atom feed. In particular, if insufficient information is provided in the document (e.g. if the document does not have any <meta name="author" content="..."> elements), then the output will not be conforming. The Atom namespace is: http://www.w3.org/2005/Atom
498
A browsing context p499 can have a creator browsing context, the browsing context p499 that was responsible for its creation. If a browsing context p499 has a parent browsing context p499 , then that is its creator browsing context p499 . Otherwise, if the browsing context p499 has an opener browsing context p501 , then that is its creator browsing context p499 . Otherwise, the browsing context p499 has no creator browsing context p499 . If a browsing context p499 A has a creator browsing context p499 , then the Document p33 that was the active document p499 of that creator browsing context p499 at the time A was created is the creator Document. When a browsing context p499 is first created, it must be created with a single Document p33 in its session history, whose address p77 is about:blank p60 , which is marked as being an HTML document p77 , and whose character encoding p81 is UTF-8. The Document p33 must have a single child html p116 node, which itself has a single child body p142 node. Note: If the browsing context p499 is created specifically to be immediately navigated, then that initial navigation will have replacement enabled p528 . The origin p510 of the about:blank p60 Document p33 is set when the Document p33 is created. If the new browsing context p499 has a creator browsing context p499 , then the origin p510 of the about:blank p60 Document p33 is the origin p510 of the creator Document p499 . Otherwise, the origin p510 of the about:blank p60 Document p33 is a globally unique identifier assigned when the new browsing context p499 is created.
499
The transitive closure of parent browsing contexts p499 for a nested browsing context p499 gives the list of ancestor browsing contexts p499 . The list of the descendant browsing contexts of a Document p33 d is the (ordered) list returned by the following algorithm: 1. 2. Let list be an empty list. For each child browsing context p499 of d that is nested through p499 an element that is in the Document p29 d, in the tree order p29 of the elements nesting those browsing contexts p499 , run these substeps: 1. 2. Append that child browsing context p499 to the list list. Append the list of the descendant browsing contexts p500 of the active document p499 of that child browsing context p499 to the list list.
3.
A Document p33 is said to be fully active when it is the active document p499 of its browsing context p499 , and either its browsing context is a top-level browsing context p499 , or it has a parent browsing context p499 and the Document p33 through which p499 it is nested p499 is itself fully active p500 . Because they are nested through an element, child browsing contexts p499 are always tied to a specific Document p33 in their parent browsing context p499 . User agents must not allow the user to interact with child browsing contexts p499 of elements that are in Document p33 s that are not themselves fully active p500 . A nested browsing context p499 can have a seamless browsing context flag p218 set, if it is embedded through an iframe p213 element with a seamless p218 attribute. Note: A nested browsing context p499 can in some cases be taken out of its parent browsing context p499 (e.g. if an iframe p213 element is removed from its Document p33 ). In such a situation, the nested browsing context p499 has no parent browsing context p499 , but it still has the same browsing context container p499 and is still nested through p499 that element's Document p33 . Such a nested browsing context p499 is not a top-level browsing context p499 , and cannot contain Document p33 s that are fully active p500 . Furthermore, if a browsing context container p499 (such as an iframe p213 ) is moved to another Document p33 , then the parent browsing context p499 of its nested browsing context p499 will change.
6.1.1.1 Navigating nested browsing contexts in the DOM This box is non-normative. Implementation requirements are given below this box. window . top
p500
Returns the WindowProxy p510 for the top-level browsing context p499 . window . parent p500 Returns the WindowProxy p510 for the parent browsing context p499 . window . frameElement p500 Returns the Element p33 for the browsing context container p499 . Returns null if there isn't one. Throws a SECURITY_ERR p75 exception in cross-origin situations.
The top IDL attribute on the Window p503 object of a Document p33 in a browsing context p499 b must return the WindowProxy p510 object of its top-level browsing context p499 (which would be its own WindowProxy p510 object if it was a top-level browsing context p499 itself), if it has one, or its own WindowProxy p510 object otherwise (e.g. if it was a detached nested browsing context p499 ). The parent IDL attribute on the Window p503 object of a Document p33 in a browsing context p499 b must return the WindowProxy p510 object of the parent browsing context p499 , if there is one (i.e. if b is a child browsing context p499 ), or the WindowProxy p510 object of the browsing context p499 b itself, otherwise (i.e. if it is a top-level browsing context p499 or a detached nested browsing context p499 ). The frameElement IDL attribute on the Window p503 object of a Document p33 d, on getting, must run the following algorithm: 1. If d is not a Document p33 in a nested browsing context p499 , return null and abort these steps.
500
2.
If the browsing context container p499 's Document p33 does not have the same p512 effective script origin p510 as the entry script p502 , then throw a SECURITY_ERR p75 exception. Otherwise, return the browsing context container p499 for b.
3.
6.1.2.1 Navigating auxiliary browsing contexts in the DOM The opener IDL attribute on the Window p503 object must return the WindowProxy p510 object of the browsing context p499 from which the current browsing context p499 was created (its opener browsing context p501 ), if there is one and it is still available.
6.1.4 Security
A browsing context p499 A is allowed to navigate a second browsing context p499 B if one of the following conditions is true: Either the origin p510 of the active document p499 of A is the same p512 as the origin p510 of the active document p499 of B, or The browsing context A is a nested browsing context p499 with a top-level browsing context p499 , and its top-level browsing context p499 is B, or The browsing context B is an auxiliary browsing context p501 and A is allowed to navigate p501 B's opener browsing context p501 , or The browsing context B is not a top-level browsing context p499 , but there exists an ancestor browsing context p499 of B whose active document p499 has the same p512 origin p510 as the active document p499 of A (possibly in fact being A itself).
An element has a browsing context scope origin if its Document p33 's browsing context p499 is a top-level browsing context p499 or if all of its Document p33 's ancestor browsing contexts p499 all have active documents p499 whose origin p510 are the same origin p512 as the element's Document p33 's origin p510 . If an element has a browsing context scope origin p501 , then its value is the origin p510 of the element's Document p33 .
The transitive closure of all the browsing contexts p499 that are directly reachable browsing contexts p501 forms a unit of related browsing contexts. Each unit of related browsing contexts p501 is then further divided into the smallest number of groups such that every member of each group has an active document p499 with an effective script origin p510 that, through
501
appropriate manipulation of the document.domain p513 attribute, could be made to be the same as other members of the group, but could not be made the same as members of any other group. Each such group is a unit of related similar-origin browsing contexts. Each unit of related similar-origin browsing contexts p502 can have a entry script which is used to obtain, amongst other things, the script's base URL p551 to resolve p55 relative URLs p55 used in scripts running in that unit of related similar-origin browsing contexts p502 . Initially, there is no entry script p502 . It is changed by the jump to a code entrypoint p551 algorithm. Note: There is at most one event loop p552 per unit of related similar-origin browsing contexts p502 .
3.
4.
502
Note: If it is immediately navigated p520 , then the navigation will be done with replacement enabled p528 . If the user agent has been configured such that in this instance it will create a new browsing context, and the noreferrer p447 keyword doesn't apply A new auxiliary browsing context p501 must be created, with the opener browsing context p501 being the current one. If the given browsing context name is not _blank, then the new auxiliary browsing context's name must be the given browsing context name (otherwise, it has no name). The chosen browsing context must be this new browsing context. Note: If it is immediately navigated p520 , then the navigation will be done with replacement enabled p528 . If the user agent has been configured such that in this instance it will reuse the current browsing context The chosen browsing context is the current browsing context. If the user agent has been configured such that in this instance it will not find a browsing context There must not be a chosen browsing context. User agent implementors are encouraged to provide a way for users to configure the user agent to always reuse the current browsing context.
// other browsing contexts [Replaceable] readonly attribute WindowProxy frames; [Replaceable] readonly attribute unsigned long length; readonly attribute WindowProxy top; [Replaceable] readonly attribute WindowProxy opener; readonly attribute WindowProxy parent; readonly attribute Element frameElement; WindowProxy open(in optional DOMString url, in optional DOMString target, in optional DOMString features, in optional DOMString replace); getter WindowProxy (in unsigned long index); getter any (in DOMString name); // the user agent readonly attribute Navigator navigator; readonly attribute ApplicationCache applicationCache; // user prompts
503
void alert(in DOMString message); boolean confirm(in DOMString message); DOMString prompt(in DOMString message, in optional DOMString default); void print(); any showModalDialog(in DOMString url, in optional any argument); // cross-document messaging void postMessage(in any message, in DOMString targetOrigin, in optional MessagePortArray ports); // event handler IDL attributes attribute Function onabort; attribute Function onafterprint; attribute Function onbeforeprint; attribute Function onbeforeunload; attribute Function onblur; attribute Function oncanplay; attribute Function oncanplaythrough; attribute Function onchange; attribute Function onclick; attribute Function oncontextmenu; attribute Function oncuechange; attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function ondblclick; ondrag; ondragend; ondragenter; ondragleave; ondragover; ondragstart; ondrop; ondurationchange; onemptied; onended; onerror; onfocus; onformchange; onforminput; onhashchange; oninput; oninvalid; onkeydown; onkeypress; onkeyup; onload; onloadeddata; onloadedmetadata; onloadstart; onmessage; onmousedown; onmousemove; onmouseout; onmouseover; onmouseup; onmousewheel; onoffline; ononline; onpause; onplay; onplaying; onpagehide; onpageshow; onpopstate; onprogress; onratechange; onreadystatechange;
504
attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute attribute
Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function Function
onredo; onreset; onresize; onscroll; onseeked; onseeking; onselect; onshow; onstalled; onstorage; onsubmit; onsuspend; ontimeupdate; onundo; onunload; onvolumechange; onwaiting;
}; Window implements EventTarget; This box is non-normative. Implementation requirements are given below this box. window . window p505 window . frames p505 window . self p505 These attributes all return window. window . document p505 Returns the active document p499 . document . defaultView p505 Returns the Window p503 object of the active document p499 .
The window, frames, and self IDL attributes must all return the Window p503 object's browsing context p499 's WindowProxy p510 object. The document IDL attribute must return the Document p33 object of the Window p503 object's Document p33 's browsing context p499 's active document p499 . The defaultView IDL attribute of the HTMLDocument p77 interface must return the Document p33 's browsing context p499 's WindowProxy p510 object, if there is one, or null otherwise.
6.2.1 Security
User agents must raise a SECURITY_ERR p75 exception whenever any of the members of a Window p503 object are accessed by scripts whose effective script origin p510 is not the same as the Window p503 object's Document p33 's effective script origin p510 , with the following exceptions: The location p518 object The postMessage() p608 method The frames p505 attribute The dynamic nested browsing context properties p507
When a script whose effective script origin p510 is not the same as the Window p503 object's Document p33 's effective script origin p510 attempts to access that Window p503 object's methods or attributes, the user agent must act as if any changes to the Window p503 object's properties, getters, setters, etc, were not present. For members that return objects (including function objects), each distinct effective script origin p510 that is not the same as the Window p503 object's Document p33 's effective script origin p510 must be provided with a separate set of objects. These objects must have the prototype chain appropriate for the script for which the objects are created (not those that would be appropriate for scripts whose script's global object p550 is the Window p503 object in question).
505
For instance, if two frames containing Document p33 s from different origins p510 access the same Window p503 object's postMessage() p608 method, they will get distinct objects that are not equal.
The open() method on Window p503 objects provides a mechanism for navigating p520 an existing browsing context p499 or opening and navigating an auxiliary browsing context p501 . The method has four arguments, though they are all optional. The first argument, url, must be a valid non-empty URL p55 for a page to load in the browsing context. If no arguments are provided, or if the first argument is the empty string, then the url argument defaults to "about:blank p60 ". The argument must be resolved p55 to an absolute URL p56 (or an error), relative to the entry script p502 's base URL p551 , when the method is invoked. The second argument, target, specifies the name p502 of the browsing context that is to be navigated. It must be a valid browsing context name or keyword p502 . If fewer than two arguments are provided, then the target argument defaults to the value "_blank". The third argument, features, has no defined effect and is mentioned for historical reasons only. User agents may interpret this argument as instructions to set the size and position of the browsing context, but are encouraged to instead ignore the argument entirely. The fourth argument, replace, specifies whether or not the new page will replace p528 the page currently loaded in the browsing context, when target identifies an existing browsing context (as opposed to leaving the current page in the browsing context's session history p513 ). When three or fewer arguments are provided, replace defaults to false. When the method is invoked, the user agent must first select a browsing context p499 to navigate by applying the rules for choosing a browsing context given a browsing context name p502 using the target argument as the name and the browsing context p499 of the script as the context in which the algorithm is executed, unless the user has indicated a preference, in which case the browsing context to navigate may instead be the one indicated by the user. For example, suppose there is a user agent that supports control-clicking a link to open it in a new tab. If a user clicks in that user agent on an element whose onclick p557 handler uses the window.open() p506 API to open a page in an iframe, but, while doing so, holds the control key down, the user agent could override the selection of the target browsing context to instead target a new tab. Then, the user agent must navigate p520 the selected browsing context p499 to the absolute URL p56 (or error) obtained from resolving p55 url earlier. If the replace is true or if the browsing context p499 was just created as part of the rules for choosing a browsing context given a browsing context name p502 , then replacement must be enabled p528 . The navigation must be done with the browsing context p551 of the entry script p502 as the source browsing context p520 . The method must return the WindowProxy p510 object of the browsing context p499 that was navigated, or null if no browsing context was navigated.
506
The name attribute of the Window p503 object must, on getting, return the current name of the browsing context p499 , and, on setting, set the name of the browsing context p499 to the new value. Note: The name gets reset p528 when the browsing context is navigated to another domain.
The close() method on Window p503 objects should, if the corresponding browsing context p499 A is an auxiliary browsing context p501 that was created by a script (as opposed to by an action of the user), and if the browsing context p551 of the script p550 that invokes the method is allowed to navigate p501 the browsing context p499 A, close the browsing context p499 A (and may discard p508 it too). The stop() method on Window p503 objects should, if there is an existing attempt to navigate p520 the browsing context p499 and that attempt is not currently running the unload a document p530 algorithm, cancel that navigation p520 and any associated instances of the fetch algorithm p59 . Otherwise, it must do nothing.
Returns the number of child browsing contexts p499 . window[index] Returns the indicated child browsing context p499 .
The length IDL attribute on the Window p503 interface must return the number of child browsing contexts p499 that are nested through p499 elements that are in the Document p29 that is the active document p499 of that Window p503 object, if that Window p503 's browsing context p499 shares the same event loop p552 as the script's browsing context p551 of the entry script p502 accessing the IDL attribute; otherwise, it must return zero. The supported property indices p34 on the Window p503 object at any instant are the numbers in the range 0 .. n-1, where n is the number returned by the length p507 IDL attribute. If n is zero then there are no supported property indices p34 . To determine the value of an indexed property index of a Window p503 object, the user agent must return the WindowProxy p510 object of the indexth child browsing context p499 of the Document p33 that is nested through an element that is in the Document p29 , sorted in the tree order p29 of the elements nesting those browsing contexts p499 . These properties are the dynamic nested browsing context properties.
The Window p503 interface supports named properties. The supported property names p34 at any moment consist of: the value of the name content attribute for all a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , and object p222 elements in the active document p499 that have a name content attribute, and the value of the id p92 content attribute of any HTML element p28 in the active document p499 with an id p92 content attribute.
When the Window object is indexed for property retrieval using a name name, then the user agent must return the value obtained using the following steps: 1. Let elements be the list of named elements p508 with the name name in the active document p499 . Note: There will be at least one such element, by definition.
507
2.
If elements contains an iframe p213 element, then return the WindowProxy p510 object of the nested browsing context p499 represented by the first such iframe p213 element in tree order p29 , and abort these steps. Otherwise, if elements has only one element, return that element and abort these steps. Otherwise return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only named elements p508 with the name name.
3. 4.
Named elements with the name name, for the purposes of the above algorithm, are those that are either: a p173 , applet p744 , area p314 , embed p220 , form p347 , frame p747 , frameset p747 , iframe p213 , img p199 , or object p222 elements that have a name content attribute whose value is name, or HTML elements p28 elements that have an id p92 content attribute whose value is name.
3.
4. 5.
Note: Whenever a Document p33 object is discarded p508 , it is also removed from the list of the worker's Document p33 s of each worker whose list contains that Document p33 . When a browsing context is discarded, the strong reference from the user agent itself to the browsing context p499 must be severed, and all the Document p33 objects for all the entries in the browsing context p499 's session history must be discarded p508 as well. User agents may discard p508 top-level browsing contexts p499 at any time (typically, in response to user requests, e.g. when a user closes a window containing one or more top-level browsing contexts p499 ). Other browsing contexts p499 must be discarded once their WindowProxy p510 object is eligible for garbage collection.
508
window . locationbar p509 . visible p509 Returns true if the location bar is visible; otherwise, returns false. window . menubar p509 . visible p509 Returns true if the menu bar is visible; otherwise, returns false. window . personalbar p509 . visible p509 Returns true if the personal bar is visible; otherwise, returns false. window . scrollbars p509 . visible p509 Returns true if the scroll bars are visible; otherwise, returns false. window . statusbar p509 . visible p509 Returns true if the status bar is visible; otherwise, returns false. window . toolbar p509 . visible p509 Returns true if the toolbar is visible; otherwise, returns false.
The visible attribute, on getting, must return either true or a value determined by the user agent to most accurately represent the visibility state of the user interface element that the object represents, as described below. On setting, the new value must be discarded. The following BarProp p508 objects exist for each Document p33 object in a browsing context p499 . Some of the user interface elements represented by these objects might have no equivalent in some user agents; for those user agents, except when otherwise specified, the object must act as if it was present and visible (i.e. its visible p509 attribute must return true). The location bar BarProp object Represents the user interface element that contains a control that displays the URL p55 of the active document p499 , or some similar interface concept. The menu bar BarProp object Represents the user interface element that contains a list of commands in menu form, or some similar interface concept. The personal bar BarProp object Represents the user interface element that contains links to the user's favorite pages, or some similar interface concept. The scrollbar BarProp object Represents the user interface element that contains a scrolling mechanism, or some similar interface concept. The status bar BarProp object Represents a user interface element found immediately below or after the document, as appropriate for the user's media. If the user agent has no such user interface element, then the object may act as if the corresponding user interface element was absent (i.e. its visible p509 attribute may return false). The toolbar BarProp object Represents the user interface element found immediately above or before the document, as appropriate for the user's media. If the user agent has no such user interface element, then the object may act as if the corresponding user interface element was absent (i.e. its visible p509 attribute may return false). The locationbar attribute must return the location bar BarProp object p509 . The menubar attribute must return the menu bar BarProp object p509 . The personalbar attribute must return the personal bar BarProp object p509 . The scrollbars attribute must return the scrollbar BarProp object p509 . The statusbar attribute must return the status bar BarProp object p509 . The toolbar attribute must return the toolbar BarProp object p509 .
509
6.3 Origin
The origin of a resource and the effective script origin of a resource are both either opaque identifiers or tuples consisting of a scheme component, a host component, a port component, and optionally extra data. Note: The extra data could include the certificate of the site when using encrypted connections, to ensure that if the site's secure certificate changes, the origin is considered to change as well. These characteristics are defined as follows: For URLs The origin p510 and effective script origin p510 of the URL p55 is whatever is returned by the following algorithm: 1. 2. 3. Let url be the URL p55 for which the origin p510 is being determined. Parse p55 url. If url identifies a resource that is its own trust domain (e.g. it identifies an e-mail on an IMAP server or a post on an NNTP server) then return a globally unique identifier specific to the resource identified by url, so that if this algorithm is invoked again for URLs p55 that identify the same resource, the same identifier will be returned. If url does not use a server-based naming authority, or if parsing url failed, or if url is not an absolute URL p56 , then return a new globally unique identifier. Let scheme be the <scheme> p55 component of url, converted to ASCII lowercase p36 . If the UA doesn't support the protocol given by scheme, then return a new globally unique identifier. If scheme is "file", then the user agent may return a UA-specific value. Let host be the <host> p55 component of url. Apply the IDNA ToASCII algorithm to host, with both the AllowUnassigned and UseSTD3ASCIIRules flags set. Let host be the result of the ToASCII algorithm. If ToASCII fails to convert one of the components of the string, e.g. because it is too long or because it contains invalid characters, then return a new globally unique identifier. [RFC3490] p784 10. 11. Let host be the result of converting host to ASCII lowercase p36 . If there is no <port> p55 component, then let port be the default port for the protocol given by scheme. Otherwise, let port be the <port> p55 component of url. Return the tuple (scheme, host, port).
4.
5. 6.
7. 8. 9.
12.
In addition, if the URL p55 is in fact associated with a Document p33 object that was created by parsing the resource obtained from fetching URL p55 , and this was done over a secure connection, then the server's secure certificate may be added to the origin as additional data.
510
For scripts The origin p510 and effective script origin p510 of a script are determined from another resource, called the owner:
p133 element If a script is in a script The owner is the Document p33 to which the script p133 element belongs. p556 If a script is in an event handler content attribute The owner is the Document p33 to which the attribute node belongs.
If a script is a function or other code reference created by another script The owner is the script that created it.
p554 that was returned as the location of an HTTP redirect (or If a script is a javascript: URL equivalent p61 in other protocols) The owner is the URL p55 that redirected to the javascript: URL p554 . p554 in an attribute If a script is a javascript: URL The owner is the Document p33 of the element on which the attribute is found. p554 in a style sheet If a script is a javascript: URL The owner is the URL p55 of the style sheet. p554 to which a browsing context p499 is being navigated p520 , the If a script is a javascript: URL URL having been provided by the user (e.g. by using a bookmarklet) The owner is the Document p33 of the browsing context p499 's active document p499 . p554 to which a browsing context p499 is being navigated p520 , the If a script is a javascript: URL URL having been declared in markup The owner is the Document p33 of the element (e.g. an a p173 or area p314 element) that declared the URL. p554 to which a browsing context p499 is being navigated p520 , the If a script is a javascript: URL URL having been provided by script The owner is the script that provided the URL.
The origin p510 of the script is then equal to the origin p510 of the owner, and the effective script origin p510 of the script is equal to the effective script origin p510 of the owner. For Document p33 objects and images
p33 is in a browsing context p499 whose sandboxed origin browsing context flag p217 If a Document was set when the Document p33 was created p33 was generated from a resource labeled as text/html-sandboxed p758 If a Document p510 The origin is a globally unique identifier assigned when the Document p33 is created. p33 or image was generated from a javascript: URL p554 If a Document The origin p510 is equal to the origin p510 of the script of that javascript: URL p554 . p33 or image was served over the network and has an address that uses a URL If a Document scheme with a server-based naming authority The origin p510 is the origin p510 of the address p77 of the Document p33 or the URL p55 of the image, as appropriate. p33 or image was generated from a data: URL p28 that was returned as the location If a Document of an HTTP redirect (or equivalent p61 in other protocols) The origin p510 is the origin p510 of the URL p55 that redirected to the data: URL p28 . p33 or image was generated from a data: URL p28 found in another Document p33 or in If a Document a script The origin p510 is the origin p510 of the Document p33 or script that initiated the navigation p520 to that URL p55 . p33 has the address p77 "about:blank p60 " If a Document p510 The origin of the Document p33 is the origin it was assigned when its browsing context was created p499 . p33 is an iframe srcdoc document p214 If a Document The origin p510 of the Document p33 is the origin p510 of the Document p33 's browsing context p499 's browsing context container p499 's Document p33 . p33 or image was obtained in some other manner (e.g. a data: URL p28 typed in by If a Document the user, a Document p33 created using the createDocument() p33 API, etc) The origin p510 is a globally unique identifier assigned when the Document p33 or image is created.
When a Document p33 is created, its effective script origin p510 is initialized to the origin p510 of the Document p33 . However, the document.domain p513 attribute can be used to change it. For audio p231 and video p228 elements If value of the media element p235 's currentSrc p237 attribute is the empty string, the origin p510 is the same as the origin p510 of the element's Document p33 's origin p510 .
511
Otherwise, the origin p510 is equal to the origin p510 of the absolute URL p56 given by the media element p235 's currentSrc p237 attribute. Other specifications can override the above definitions by themselves specifying the origin of a particular URL, script, Document p33 , or image. The Unicode serialization of an origin is the string obtained by applying the following algorithm to the given origin p510 : 1. If the origin p510 in question is not a scheme/host/port tuple, then return the literal string "null" and abort these steps. Otherwise, let result be the scheme part of the origin p510 tuple. Append the string "://" to result. Apply the IDNA ToUnicode algorithm to each component of the host part of the origin p510 tuple, and append the results each component, in the same order, separated by U+002E FULL STOP characters (.) to result. [RFC3490] p784 If the port part of the origin p510 tuple gives a port that is different from the default port for the protocol given by the scheme part of the origin p510 tuple, then append a U+003A COLON character (:) and the given port, in base ten, to result. Return result.
2. 3. 4.
5.
6.
The ASCII serialization of an origin is the string obtained by applying the following algorithm to the given origin p510 : 1. If the origin p510 in question is not a scheme/host/port tuple, then return the literal string "null" and abort these steps. Otherwise, let result be the scheme part of the origin p510 tuple. Append the string "://" to result. Apply the IDNA ToASCII algorithm the host part of the origin p510 tuple, with both the AllowUnassigned and UseSTD3ASCIIRules flags set, and append the results result. If ToASCII fails to convert one of the components of the string, e.g. because it is too long or because it contains invalid characters, then return the empty string and abort these steps. [RFC3490] p784 5. If the port part of the origin p510 tuple gives a port that is different from the default port for the protocol given by the scheme part of the origin p510 tuple, then append a U+003A COLON character (:) and the given port, in base ten, to result. Return result.
2. 3. 4.
6.
Two origins p510 are said to be the same origin if the following algorithm returns true: 1. 2. 3. 4. 5. 6. 7. 8. Let A be the first origin p510 being compared, and B be the second origin p510 being compared. If A and B are both opaque identifiers, and their value is equal, then return true. Otherwise, if either A or B or both are opaque identifiers, return false. If A and B have scheme components that are not identical, return false. If A and B have host components that are not identical, return false. If A and B have port components that are not identical, return false. If either A or B have additional data, but that data is not identical for both, return false. Return true.
[ = domain ]
512
Can be set to a value that removes subdomains, to change the effective script origin p510 to allow pages on other subdomains of the same domain (if they do the same thing) to access each other.
The domain attribute on Document p33 objects must be initialized to the document's domain p513 , if it has one, and the empty string otherwise. If the value is an IPv6 address, then the square brackets from the host portion of the <host> p55 component must be omitted from the attribute's value. On getting, the attribute must return its current value, unless the Document p33 has no browsing context p499 , in which case it must return the empty string. On setting, the user agent must run the following algorithm: 1. If the Document p33 has no browsing context p499 , throw a SECURITY_ERR p75 exception and abort these steps. If the new value is an IP address, let new value be the new value. Otherwise, apply the IDNA ToASCII algorithm to the new value, with both the AllowUnassigned and UseSTD3ASCIIRules flags set, and let new value be the result of the ToASCII algorithm. If ToASCII fails to convert one of the components of the string, e.g. because it is too long or because it contains invalid characters, then throw a SECURITY_ERR p75 exception and abort these steps. [RFC3490] p784 3. If new value is not exactly equal to the current value of the document.domain p513 attribute, then run these substeps: 1. 2. If the current value is an IP address, throw a SECURITY_ERR p75 exception and abort these steps. If new value, prefixed by a U+002E FULL STOP (.), does not exactly match the end of the current value, throw a SECURITY_ERR p75 exception and abort these steps. If new value matches a suffix in the Public Suffix List, or, if new value, prefixed by a U+002E FULL STOP (.), matches the end of a suffix in the Public Suffix List, then throw a SECURITY_ERR p75 exception and abort these steps. [PSL] p783 Suffixes must be compared after applying the IDNA ToASCII algorithm to them, with both the AllowUnassigned and UseSTD3ASCIIRules flags set, in an ASCII case-insensitive p36 manner. [RFC3490] p784 4. 5. 6. 7. Release the storage mutex p553 . Set the attribute's value to new value. Set the host part of the effective script origin p510 tuple of the Document p33 to new value. Set the port part of the effective script origin p510 tuple of the Document p33 to "manual override" (a value that, for the purposes of comparing origins p512 , is identical to "manual override" but not identical to any other value).
2.
3.
The domain of a Document p33 is the host part of the document's origin p510 , if that is a scheme/host/port tuple. If it isn't, then the document does not have a domain. Note: The domain p513 attribute is used to enable pages on different hosts of a domain to access each others' DOMs. Warning! Do not use the document.domain p513 attribute when using shared hosting. If an untrusted third party is able to host an HTTP server at the same IP address but on a different port, then the same-origin protection that normally protects two different sites on the same host will fail, as the ports are ignored when comparing origins after the document.domain p513 attribute has been used.
513
Each Document p33 object in a browsing context p499 's session history p513 is associated with a unique instance of the History p515 object, although they all must model the same underlying session history p513 . The history attribute of the Window p503 interface must return the object implementing the History p515 interface for that Window p503 object's Document p33 . History p515 objects represent their browsing context p499 's session history as a flat list of session history entries p514 . Each session history entry consists of either a URL p55 or a state object p514 , or both, and may in addition have a title, a Document p33 object, form data, a scroll position, and other information associated with it. Note: This does not imply that the user interface need be linear. See the notes below p520 . Note: Titles associated with session history entries p514 need not have any relation with the current title p117 of the Document p33 . The title of a session history entry p514 is intended to explain the state of the document at that point, so that the user can navigate the document's history. URLs without associated state objects p514 are added to the session history as the user (or script) navigates from page to page. A state object is an object representing a user interface state. Pages can add p516 state objects p514 between their entry in the session history and the next ("forward") entry. These are then returned to the script p529 when the user (or script) goes back in the history, thus enabling authors to use the "navigation" metaphor even in one-page applications. State objects p514 are intended to be used for two main purposes: first, storing a preparsed description of the state in the URL p55 so that in the simple case an author doesn't have to do the parsing (though one would still need the parsing for handling URLs p55 passed around by users, so it's only a minor optimization), and second, so that the author can store state that one wouldn't store in the URL because it only applies to the current Document p33 instance and it would have to be reconstructed if a new Document p33 were opened. An example of the latter would be something like keeping track of the precise coordinate from which a popup div p172 was made to animate, so that if the user goes back, it can be made to animate to the same location. Or alternatively, it could be used to keep a pointer into a cache of data that would be fetched from the server based on the information in the URL p55 , so that when going back and forward, the information doesn't have to be fetched again.
At any point, one of the entries in the session history is the current entry. This is the entry representing the active document p499 of the browsing context p499 . The current entry p514 is usually an entry for the location p519 of the Document p33 . However, it can also be one of the entries for state objects p514 added to the history by that document. An entry with persisted user state is one that also has user-agent defined state. This specification does not specify what kind of state can be stored. For example, some user agents might want to persist the scroll position, or the values of form controls. Entries that consist of state objects p514 share the same Document p33 as the entry for the page that was active when they were added. Contiguous entries that differ just by fragment identifier also share the same Document p33 . Note: All entries that share the same Document p33 (and that are therefore merely different states of one particular document) are contiguous by definition. User agents may discard p508 the Document p33 objects of entries other than the current entry p514 that are not referenced from any script, reloading the pages afresh when the user or script navigates back to such pages. This specification does not specify when user agents should discard Document p33 objects and when they should cache them. Entries that have had their Document p33 objects discarded must, for the purposes of the algorithms given below, act as if they had not. When the user or script navigates back or forwards to a page which has no in-memory DOM objects, any other entries that shared the same Document p33 object with it must share the new object as well.
514
. length p515
Returns the number of entries in the joint session history p515 . window . history p514 . go p515 ( [ delta ] ) Goes back or forward the specified number of steps in the joint session history p515 . A zero delta will reload the current page. If the delta is out of range, does nothing. window . history p514 . back p515 () Goes back one step in the joint session history p515 . If there is no previous page, does nothing. window . history p514 . forward p515 () Goes forward one step in the joint session history p515 . If there is no next page, does nothing. window . history p514 . pushState p516 (data, title [, url ] ) Pushes the given data onto the session history, with the given title, and, if provided, the given URL. window . history p514 . replaceState p516 (data, title [, url ] ) Updates the current entry in the session history to have the given data, title, and, if provided, URL.
The joint session history of a History p515 object is the union of all the session histories p513 of all browsing contexts p499 of all the fully active p500 Document p33 objects that share the History p515 object's top-level browsing context p499 , with all the entries that are current entries p514 in their respective session histories p513 removed except for the current entry of the joint session history p515 . The current entry of the joint session history is the entry that most recently became a current entry p514 in its session history p513 . Entries in the joint session history p515 are ordered chronologically by the time they were added to their respective session histories p513 . (Since all these browsing contexts p499 by definition share an event loop p552 , there is always a well-defined sequential order in which their session histories p513 had their entries added.) Each entry has an index; the earliest entry has index 0, and the subsequent entries are numbered with consecutively increasing integers (1, 2, 3, etc). The length attribute of the History p515 interface must return the number of entries in the joint session history p515 . The actual entries are not accessible from script. When the go(delta) method is invoked, if the argument to the method was omitted or has the value zero, the user agent must act as if the location.reload() p519 method was called instead. Otherwise, the user agent must traverse the history by a delta p515 whose value is the value of the method's argument. When the back() method is invoked, the user agent must traverse the history by a delta p515 1. When the forward()method is invoked, the user agent must traverse the history by a delta p515 +1. To traverse the history by a delta delta, the user agent must queue a task p553 to run the following steps. The task source p553 for the queued task is the history traversal task source p554 . 1. Let delta be the argument to the method.
515
2.
If the index of the current entry of the joint session history p515 plus delta is less than zero or greater than or equal to the number of items in the joint session history p515 , then abort these steps. Let specified entry be the entry in the joint session history p515 whose index is the sum of delta and the index of the current entry of the joint session history p515 . Let specified browsing context be the browsing context p499 of the specified entry. If the specified browsing context's active document p499 is not the same Document p33 as the Document p33 of the specified entry, then run these substeps: 1. Prompt to unload p530 the active document p499 of the specified browsing context. If the user refused to allow the document to be unloaded p530 , then abort these steps. Unload p530 the active document p499 of the specified browsing context with the recycle parameter set to false.
3.
4. 5.
2.
6.
Traverse the history p527 of the specified browsing context to the specified entry.
When the user navigates through a browsing context p499 , e.g. using a browser's back and forward buttons, the user agent must traverse the history by a delta p515 equivalent to the action specified by the user. The pushState(data, title, url) method adds a state object entry to the history. The replaceState(data, title, url) method updates the state object, title, and optionally the URL p55 of the current entry p514 in the history. When either of these methods is invoked, the user agent must run the following steps: 1. Let clone data be a structured clone p72 of the specified data. If this throws an exception, then rethrow that exception and abort these steps. If a third argument is specified, run these substeps: 1. 2. 3. Resolve p55 the value of the third argument, relative to the entry script p502 's base URL p551 . If that fails, raise a SECURITY_ERR p75 exception and abort these steps. Compare the resulting absolute URL p56 to the document's address p77 . If any part of these two URLs p55 differ other than the <path> p55 , <query> p55 , and <fragment> p55 components, then raise a SECURITY_ERR p75 exception and abort these steps. If the origin p510 of the resulting absolute URL p56 is not the same as the origin p510 of the entry script p502 's document p551 , and either the <path> p55 or <query> p55 components of the two URLs p55 compared in the previous step differ, raise a SECURITY_ERR p75 exception and abort these steps. (This prevents sandboxed content from spoofing other pages on the same origin.)
2.
4.
For the purposes of the comparisons in the above substeps, the <path> p55 and <query> p55 components can only be the same if the URLs are both hierarchical URLs p56 . 3. If the method invoked was the pushState() p516 method: 1. Remove all the entries in the browsing context p499 's session history p513 after the current entry p514 . If the current entry p514 is the last entry in the session history, then no entries are removed. Note: This doesn't necessarily have to affect p520 the user agent's user interface. 2. 3. Remove any tasks p553 queued by the history traversal task source p554 . If appropriate, update the current entry p514 to reflect any state that the user agent wishes to persist. The entry is then said to be an entry with persisted user state p514 . Add a state object entry to the session history, after the current entry p514 , with cloned data as the state object, the given title as the title, and, if the third argument is present, the absolute URL p56 that was found earlier in this algorithm as the URL p55 of the entry. Update the current entry p514 to be the this newly added entry.
4.
5.
516
1.
Update the current entry p514 in the session history so that cloned data is the entry's new state object, the given title is the new title, and, if the third argument is present, the absolute URL p56 that was found earlier in this algorithm is the entry's new URL p55 .
4.
If the third argument is present, set the document's current address p77 to the absolute URL p56 that was found earlier in this algorithm. Note: Since this is neither a navigation p520 of the browsing context p499 nor a history traversal p527 , it does not cause a hashchange p529 event to be fired.
5.
If the current document readiness p82 is not yet set to the string "complete", let the Document p33 's pending state object p529 be another structured clone p72 of the specified data. (If there was already a pending state object p529 , the previous one is discarded.) Note: This ensures that the popstate p529 event that will be fired when the document finally loads will accurately reflect the pushed or replaced state object.
Note: The title is purely advisory. User agents might use the title in the user interface. User agents may limit the number of state objects added to the session history per page. If a page hits the UAdefined limit, user agents must remove the entry immediately after the first entry for that Document p33 object in the session history after having added the new entry. (Thus the state history acts as a FIFO buffer for eviction, but as a LIFO buffer for navigation.) Consider a game where the user can navigate along a line, such that the user is always at some coordinate, and such that the user can bookmark the page corresponding to a particular coordinate, to return to it later. A static page implementing the x=5 position in such a game could look like the following: <!DOCTYPE HTML> <!-- this is http://example.com/line?x=5 --> <title>Line Game - 5</title> <p>You are at coordinate 5 on the line.</p> <p> <a href="?x=6">Advance to 6</a> or <a href="?x=4">retreat to 4</a>? </p> The problem with such a system is that each time the user clicks, the whole page has to be reloaded. Here instead is another way of doing it, using script: <!DOCTYPE HTML> <!-- this starts off as http://example.com/line?x=5 --> <title>Line Game - 5</title> <p>You are at coordinate <span id="coord">5</span> on the line.</p> <p> <a href="?x=6" onclick="go(1); return false;">Advance to 6</a> or <a href="?x=4" onclick="go(-1); return false;">retreat to 4</a>? </p> <script> var currentPage = 5; // prefilled by server function go(d) { setupPage(currentPage + d); history.pushState(currentPage, document.title, '?x=' + currentPage); } onpopstate = function(event) { setupPage(event.state); } function setupPage(page) { currentPage = page; document.title = 'Line Game - ' + currentPage; document.getElementById('coord').textContent = currentPage; document.links[0].href = '?x=' + (currentPage+1); document.links[0].textContent = 'Advance to ' + (currentPage+1); document.links[1].href = '?x=' + (currentPage-1); document.links[1].textContent = 'retreat to ' + (currentPage-1); } </script>
517
In systems without script, this still works like the previous example. However, users that do have script support can now navigate much faster, since there is no network access for the same experience. Furthermore, contrary to the experience the user would have with just a nave script-based approach, bookmarking and navigating the session history still work. In the example above, the data argument to the pushState() p516 method is the same information as would be sent to the server, but in a more convenient form, so that the script doesn't have to parse the URL each time the user navigates. Applications might not use the same title for a session history entry p514 as the value of the document's title p117 element at that time. For example, here is a simple page that shows a block in the title p117 element. Clearly, when navigating backwards to a previous state the user does not go back in time, and therefore it would be inappropriate to put the time in the session history title. <!DOCTYPE HTML> <TITLE>Line</TITLE> <SCRIPT> setInterval(function () { document.title = 'Line - ' + new Date(); }, 1000); var i = 1; function inc() { set(i+1); history.pushState(i, 'Line - ' + i); } function set(newI) { i = newI; document.forms.F.I.value = newI; } </SCRIPT> <BODY ONPOPSTATE="recover(event.state)"> <FORM NAME=F> State: <OUTPUT NAME=I>1</OUTPUT> <INPUT VALUE="Increment" TYPE=BUTTON ONCLICK="inc()"> </FORM>
The location attribute of the HTMLDocument p77 interface must return the Location p518 object for that Document p33 object, if it is in a browsing context p499 , and null otherwise. The location attribute of the Window p503 interface must return the Location p518 object for that Window p503 object's Document p33 . Location p518 objects provide a representation of their document's current address p77 , and allow the current entry p514 of the browsing context p499 's session history to be changed, by adding or replacing entries in the history p514 object. interface Location { stringifier attribute DOMString href; void assign(in DOMString url); void replace(in DOMString url); void reload(); // URL decomposition IDL attributes attribute DOMString protocol; attribute DOMString host; attribute DOMString hostname; attribute DOMString port; attribute DOMString pathname;
518
attribute DOMString search; attribute DOMString hash; // resolving relative URLs DOMString resolveURL(in DOMString url); }; This box is non-normative. Implementation requirements are given below this box. location . href
p519
[ = value ]
Returns the current page's location. Can be set, to navigate to another page. location . assign p519 (url) Navigates to the given page. location . replace p519 (url) Removes the current page from the session history and navigates to the given page. location . reload p519 () Reloads the current page. url = location . resolveURL p520 (url) Resolves the given relative URL to an absolute URL.
The href attribute must return the current address p77 of the associated Document p33 object, as an absolute URL p56 . On setting, if the Location p518 object's associated Document p33 object has completely loaded p687 , then the user agent must act as if the assign() p519 method had been called with the new value as its argument. Otherwise, the user agent must act as if the replace() p519 method had been called with the new value as its argument. When the assign(url) method is invoked, the UA must resolve p55 the argument, relative to the entry script p502 's base URL p551 , and if that is successful, must navigate p520 the browsing context p499 to the specified url. If the browsing context p499 's session history p513 contains only one Document p33 , and that was the about:blank p60 Document p33 created when the browsing context p499 was created, then the navigation must be done with replacement enabled p528 . When the replace(url) method is invoked, the UA must resolve p55 the argument, relative to the entry script p502 's base URL p551 , and if that is successful, navigate p520 the browsing context p499 to the specified url with replacement enabled p528 . Navigation for the assign() p519 and replace() p519 methods must be done with the browsing context p551 of the script that invoked the method as the source browsing context p520 . If the resolving p55 step of the assign() p519 and replace() p519 methods is not successful, then the user agent must instead throw a SYNTAX_ERR p75 exception. When the reload() method is invoked, the user agent must run the appropriate steps from the following list:
p553 is the dispatch of a resize event in response to the user If the currently executing task resizing the browsing context p499
Reprocess the iframe attributes p214 of the browsing context p499 's browsing context container p499 .
p499 's active document p499 has its reload override flag p77 set If the browsing context
Perform an overridden reload p77 . Otherwise Navigate p520 the browsing context p499 to the document's current address p77 with replacement enabled p528 . The source browsing context p520 must be the browsing context p499 being navigated. When a user requests that the current page of a browsing context p499 be reloaded through a user interface element, the user agent should navigate p520 the browsing context p499 to the same resource as Document p33 , with replacement enabled p528 . In the case of non-idempotent methods (e.g. HTTP POST), the user agent should prompt the user to confirm the operation first, since otherwise transactions (e.g. purchases or database modifications)
519
could be repeated. User agents may allow the user to explicitly override any caches when reloading. If browsing context p499 's active document p499 's reload override flag p77 is set, then the user agent may instead perform an overridden reload p77 rather than the navigation described in this paragraph. The Location p518 interface also has the complement of URL decomposition IDL attributes p57 , protocol, host, port, hostname, pathname, search, and hash. These must follow the rules given for URL decomposition IDL attributes p57 , with the input p58 being the current address p77 of the associated Document p33 object, as an absolute URL p56 (same as the href p519 attribute), and the common setter action p58 being the same as setting the href p519 attribute to the new output value. The resolveURL(url) method must resolve p55 its url argument, relative to the entry script p502 's base URL p551 , and if that succeeds, return the resulting absolute URL p56 . If it fails, it must throw a SYNTAX_ERR p75 exception instead.
6.4.3.1 Security User agents must raise a SECURITY_ERR p75 exception whenever any of the members of a Location p518 object are accessed by scripts whose effective script origin p510 is not the same p512 as the Location p518 object's associated Document p33 's effective script origin p510 , with the following exceptions: The href p519 setter, if the script is running in a browsing context p499 that is allowed to navigate p501 the browsing context with which the Location p518 object is associated The replace() p519 method, if the script is running in a browsing context p499 that is allowed to navigate p501 the browsing context with which the Location p518 object is associated
520
being navigated, and the browsing context p499 being navigated is not both a top-level browsing context p499 and one of the ancestor browsing contexts p499 of the source browsing context p520 , and the source browsing context p520 had its sandboxed navigation browsing context flag p217 set when its active document p499 was created, then abort these steps. Otherwise, if the browsing context p499 being navigated is a top-level browsing context p499 , and is one of the ancestor browsing contexts p499 of the source browsing context p520 , and the source browsing context p520 had its sandboxed top-level navigation browsing context flag p217 set when its active document p499 was created, then abort these steps. In both cases, the user agent may additionally offer to open the new resource in a new top-level browsing context p499 or in the top-level browsing context p499 of the source browsing context p520 , at the user's option, in which case the user agent must navigate p520 that designated top-level browsing context p499 to the new resource as if the user had requested it independently. 3. If the source browsing context p520 is the same as the browsing context p499 being navigated, and this browsing context has its seamless browsing context flag p218 set, and the browsing context p499 being navigated was not chosen using an explicit self-navigation override p502 , then find the nearest ancestor browsing context p499 that does not have its seamless browsing context flag p218 set, and continue these steps as if that browsing context p499 was the one that was going to be navigated p520 instead. If there is a preexisting attempt to navigate the browsing context p499 , and the source browsing context p520 is the same as the browsing context p499 being navigated, and that attempt is currently running the unload a document p530 algorithm, and the origin p510 of the URL p55 of the resource being loaded in that navigation is not the same origin p512 as the origin p510 of the URL p55 of the resource being loaded in this navigation, then abort these steps without affecting the preexisting attempt to navigate the browsing context p499 . If a task p553 queued by the traverse the history by a delta p515 algorithm is running the unload a document p530 algorithm for the active document p499 of the browsing context p499 being navigated, then abort these steps without affecting the unload a document p530 algorithm or the aforementioned history traversal task. If there is a preexisting attempt to navigate the browsing context p499 , and either that attempt has not yet matured p524 (i.e. it has not passed the point of making its Document p33 the active document p499 ), or that navigation's resource is not to be fetched using HTTP GET or equivalent p61 , or its resource's absolute URL p56 differs from this attempt's by more than the presence, absence, or value of the <fragment> p55 component, then cancel that preexisting attempt to navigate the browsing context p499 . Fragment identifiers: If the absolute URL p56 of the new resource is the same as the address p77 of the active document p499 of the browsing context p499 being navigated, ignoring any <fragment> p55 components of those URLs p55 , and the new resource is to be fetched using HTTP GET or equivalent p61 , and the absolute URL p56 of the new resource has a <fragment> p55 component (even if it is empty), then navigate to that fragment identifier p526 and abort these steps. Cancel any preexisting attempt to navigate the browsing context p499 . Abort p531 the active document p499 of the browsing context p499 . If the new resource is to be handled using a mechanism that does not affect the browsing context, e.g. ignoring the navigation request altogether because the specified scheme is not one of the supported protocols, then abort these steps and proceed with that mechanism instead. Prompt to unload p530 the Document p33 object. If the user refused to allow the document to be unloaded p530 , then these steps must be aborted. If the new resource is to be handled by displaying some sort of inline content, e.g. an error message because the specified scheme is not one of the supported protocols, or an inline prompt to allow the user to select a registered handler p567 for the given scheme, then display the inline content p526 and abort these steps. Note: In the case of a registered handler being used, the algorithm will be reinvoked with a new URL to handle the request. 13. If the new resource is to be fetched using HTTP GET or equivalent p61 , then check if there are any relevant application caches p534 that are identified by a URL with the same origin p512 as the URL in question, and that have this URL as one of their entries, excluding entries marked as foreign p533 . If so, then the user agent must then get the resource from the most appropriate application cache p534 of those that match.
4.
5.
6.
7.
8. 9. 10.
11.
12.
521
For example, imagine an HTML page with an associated application cache displaying an image and a form, where the image is also used by several other application caches. If the user rightclicks on the image and chooses "View Image", then the user agent could decide to show the image from any of those caches, but it is likely that the most useful cache for the user would be the one that was used for the aforementioned HTML page. On the other hand, if the user submits the form, and the form does a POST submission, then the user agent will not use an application cache at all; the submission will be made to the network. Otherwise, unless it has already been obtained, fetch p59 the new resource, with the manual redirect flag set. If the resource is being fetched using a method other than one equivalent to p61 HTTP's GET, or, if the navigation algorithm p520 was invoked as a result of the form submission algorithm p417 , then the fetching algorithm p59 must be invoked from the origin p510 of the active document p499 of the source browsing context p520 , if any. If the browsing context p499 being navigated is a child browsing context p499 for an iframe p213 or object p222 element, then the fetching algorithm p59 must be invoked from the iframe p213 or object p222 element's browsing context scope origin p501 , if it has one. The fetch p59 algorithm must delay the load event p687 of the browsing context p499 . 14. At this point, unless this step has already been reached once before in the execution of this instance of the algorithm, the user agents must return to whatever algorithm invoked the navigation steps and must continue these steps asynchronously. If fetching the resource results in a redirect, and either the URL p55 of the target of the redirect has the same origin p512 as the original resource, or the resource is being obtained using the POST method or a safe method (in HTTP terms), return to the step labeled "fragment identifiers" p521 with the new resource. Otherwise, if fetching the resource results in a redirect but the URL p55 of the target of the redirect does not have the same origin p512 as the original resource and the resource is being obtained using a method that is neither the POST method nor a safe method (in HTTP terms), then abort these steps. The user agent may indicate to the user that the navigation has been aborted for security reasons. 16. Wait for one or more bytes to be available or for the user agent to establish that the resource in question is empty. During this time, the user agent may allow the user to cancel this navigation attempt or start other navigation attempts. If the resource was not fetched from an application cache p533 , and was to be fetched using HTTP GET or equivalent p61 , and its URL matches the fallback namespace p534 of one or more relevant application caches p534 , and the user didn't cancel the navigation attempt during the previous step, and the navigation attempt failed (e.g. the server returned a 4xx or 5xx status code or equivalent p61 , or there was a DNS error), then: Let candidate be the fallback resource p533 specified for the fallback namespace p533 in question. If multiple application caches match, the user agent must use the fallback of the most appropriate application cache p534 of those that match. If candidate is not marked as foreign p533 , then the user agent must discard the failed load and instead continue along these steps using candidate as the resource. The document's address p77 , if appropriate, will still be the originally requested URL, not the fallback URL, but the user agent may indicate to the user that the original page load failed, that the page used was a fallback resource, and what the URL of the fallback resource actually is. 18. If the document's out-of-band metadata (e.g. HTTP headers), not counting any type information p61 (such as the Content-Type HTTP header), requires some sort of processing that will not affect the browsing context, then perform that processing and abort these steps. Such processing might be triggered by, amongst other things, the following: HTTP status codes (e.g. 204 No Content or 205 Reset Content) HTTP Content-Disposition headers Network errors
15.
17.
HTTP 401 responses that do not include a challenge recognized by the user agent must be processed as if they had no challenge, e.g. rendering the entity body as if the response had been 200 OK. User agents may show the entity body of an HTTP 401 response even when the response do include a recognized challenge, with the option to login being included in a non-modal fashion, to enable the information provided by the server to be used by the user before authenticating. Similarly, user agents should allow the user to authenticate (in a non-modal fashion) against authentication challenges
522
included in other responses such as HTTP 200 OK responses, effectively allowing resources to present HTTP login forms without requiring their use. 19. 20. Let type be the sniffed type of the resource p61 . If the user agent has been configured to process resources of the given type using some mechanism other than rendering the content in a browsing context p499 , then skip this step. Otherwise, if the type is one of the following types, jump to the appropriate entry in the following list, and process the resource as described there:
p757 " "text/html p758 " "text/html-sandboxed
Follow the steps given in the HTML document p524 section, and abort these steps. Any type ending in "+xml" "application/xml" "text/xml" Follow the steps given in the XML document p525 section. If that section determines that the content is not to be displayed as a generic XML document, then proceed to the next step in this overall set of steps. Otherwise, abort these steps. "text/plain" Follow the steps given in the plain text file p525 section, and abort these steps. A supported image type Follow the steps given in the image p526 section, and abort these steps. A type that will use an external application to render the content in the browsing context p499 Follow the steps given in the plugin p526 section, and abort these steps. Setting the document's address: If there is no override URL, then any Document p33 created by these steps must have its address p77 set to the URL p55 that was originally to be fetched p59 , ignoring any other data that was used to obtain the resource (e.g. the entity body in the case of a POST submission is not part of the document's address p77 , nor is the URL of the fallback resource in the case of the original load having failed and that URL having been found to match a fallback namespace p533 ). However, if there is an override URL p523 , then any Document p33 created by these steps must have its address p77 set to that URL p55 instead. Note: An override URL p523 is set when dereferencing a javascript: URL p554 . Creating a new Document object: When a Document p33 is created as part of the above steps, a new Window p503 object must be created and associated with the Document p33 , with one exception: if the browsing context p499 's only entry in its session history p513 is the about:blank p60 Document p33 that was added when the browsing context p499 was created, and navigation is occurring with replacement enabled p528 , and that Document p33 has the same origin p512 as the new Document p33 , then the Window p503 object of that Document p33 must be used instead, and the document p505 attribute of the Window p503 object must be changed to point to the new Document p33 instead. 21. Non-document content: If, given type, the new resource is to be handled by displaying some sort of inline content, e.g. a native rendering of the content, an error message because the specified type is not supported, or an inline prompt to allow the user to select a registered handler p567 for the given type, then display the inline content p526 and abort these steps. Note: In the case of a registered handler being used, the algorithm will be reinvoked with a new URL to handle the request. 22. Otherwise, the document's type is such that the resource will not affect the browsing context, e.g. because the resource is to be handed to an external application. Process the resource appropriately.
Some of the sections below, to which the above algorithm defers in certain cases, require the user agent to update the session history with the new page. When a user agent is required to do this, it must queue a task p553 (associated with the Document p33 object of the current entry p514 , not the new one) to run the following steps: 1. Unload p530 the Document p33 object of the current entry p514 , with the recycle parameter set to false.
523
2.
If the navigation was initiated for entry update of an entry 1. Replace the Document p33 of the entry being updated, and any other entries that referenced the same document as that entry, with the new Document p33 . Traverse the history p527 to the new entry.
2.
Note: This can only happen if the entry being updated is no the current entry p514 , and can never happen with replacement enabled p528 . (It happens when the user tried to traverse to a session history entry that no longer had a Document p33 object.) Otherwise 1. Remove all the entries in the browsing context p499 's session history p513 after the current entry p514 . If the current entry p514 is the last entry in the session history, then no entries are removed. Note: This doesn't necessarily have to affect p520 the user agent's user interface. 2. 3. Remove any tasks p553 queued by the history traversal task source p554 . Append a new entry at the end of the History p515 object representing the new resource and its Document p33 object and related state. Traverse the history p527 to the new entry. If the navigation was initiated with replacement enabled p528 , then the traversal must itself be initiated with replacement enabled p528 .
4.
3. 4.
The navigation algorithm p520 has now matured. Fragment identifier loop: Spin the event loop p554 for a user-agent-defined amount of time, as desired by the user agent implementor. (This is intended to allow the user agent to optimize the user experience in the face of performance concerns.) If the Document p33 object has no parser, or its parser has stopped parsing p687 , or the user agent has reason to believe the user is no longer interested in scrolling to the fragment identifier, then abort these steps. Scroll to the fragment identifier p527 given in the document's current address p77 . If this fails to find an indicated part of the document p527 , then return to the fragment identifier loop step.
5.
6.
The task source p553 for this task p553 is the networking task source p554 .
524
525
6.5.6 Page load processing model for content that uses plugins
When a resource that requires an external resource to be rendered is to be loaded in a browsing context p499 , the user agent should create a Document object p523 , mark it as being an HTML document p77 , append an html p116 element to the Document p33 , append a head p116 element and a body p142 element to the html p116 element, append an embed p220 to the body p142 element, and set the src p220 attribute of the embed p220 element to the address of the resource. Then, the user agent must act as if it had stopped parsing p687 . Upon creation of the Document p33 object, the user agent must run the application cache selection algorithm p545 with no manifest, and passing in the newly-created Document p33 . After creating the Document p33 object, but potentially before the page has finished fully loading, the user agent must update the session history with the new page p523 . User agents may add content to the head p116 element of the Document p33 , or attributes to the embed p220 element, e.g. to link to a style sheet or an XBL binding, or to give the document a title p117 . Note: If the sandboxed plugins browsing context flag p217 was set on the browsing context p499 when the Document p33 was created, the synthesized embed p220 element will fail to render the content p220 .
6.5.7 Page load processing model for inline content that doesn't have a DOM
When the user agent is to display a user agent page inline in a browsing context p499 , the user agent should create a Document object p523 , mark it as being an HTML document p77 , and then either associate that Document p33 with a custom rendering that is not rendered using the normal Document p33 rendering rules, or mutate that Document p33 until it represents the content the user agent wants to render. Once the page has been set up, the user agent must act as if it had stopped parsing p687 . Upon creation of the Document p33 object, the user agent must run the application cache selection algorithm p545 with no manifest, passing in the newly-created Document p33 . After creating the Document p33 object, but potentially before the page has been completely set up, the user agent must update the session history with the new page p523 .
526
3.
Append a new entry at the end of the History p515 object representing the new resource and its Document p33 object and related state. Its URL p55 must be set to the address to which the user agent was navigating p520 . The title must be left unset. Traverse the history p527 to the new entry. This will scroll to the fragment identifier p527 given in what is now the document's current address p77 .
4.
Note: If the scrolling fails because the relevant ID p92 has not yet been parsed, then the original navigation p520 algorithm will take care of the scrolling instead, as the last few steps of its update the session history with the new page p523 algorithm.
When the user agent is required to scroll to the fragment identifier, it must change the scrolling position of the document using the scroll an element into view algorithm defined in the CSSOM View specification, or perform some other action, such that the indicated part of the document p527 is brought to the user's attention. If there is no indicated part, then the user agent must not scroll anywhere. [CSSOMVIEW] p782 The indicated part of the document is the one that the fragment identifier, if any, identifies. The semantics of the fragment identifier in terms of mapping it to a specific DOM Node is defined by the specification that defines the MIME type p28 used by the Document p33 (for example, the processing of fragment identifiers for XML MIME types p29 is the responsibility of RFC3023). [RFC3023] p784 For HTML documents (and HTML MIME types p28 ), the following processing model must be followed to determine what the indicated part of the document p527 is. 1. 2. Parse p55 the URL p55 , and let fragid be the <fragment> p55 component of the URL. If fragid is the empty string, then the indicated part of the document p527 is the top of the document; stop the algorithm here. Let decoded fragid be the result of expanding any sequences of percent-encoded octets in fragid that are valid UTF-8 sequences into Unicode characters as defined by UTF-8. If any percent-encoded octets in that string are not valid UTF-8 sequences, then skip this step and the next one. If this step was not skipped and there is an element in the DOM that has an ID p92 exactly equal to decoded fragid, then the first such element in tree order is the indicated part of the document p527 ; stop the algorithm here. If there is an a p173 element in the DOM that has a name p741 attribute whose value is exactly equal to fragid (not decoded fragid), then the first such element in tree order is the indicated part of the document p527 ; stop the algorithm here. If fragid is an ASCII case-insensitive p36 match for the string top, then the indicated part of the document p527 is the top of the document; stop the algorithm here. Otherwise, there is no indicated part of the document p527 .
3.
4.
5.
6.
7.
For the purposes of the interaction of HTML with Selectors' :target pseudo-class, the target element is the indicated part of the document p527 , if that is an element; otherwise there is no target element p527 . [SELECTORS] p785
2.
3.
527
4.
If the specified entry has a different Document p33 object than the current entry p514 then the user agent must run the following substeps: 1. If the browsing context is a top-level browsing context p499 , but not an auxiliary browsing context p501 , and the origin p510 of the Document p33 of the specified entry is not the same p512 as the origin p510 of the Document p33 of the current entry p514 , then the following sub-sub-steps must be run: 1. The current browsing context name p502 must be stored with all the entries in the history that are associated with Document p33 objects with the same origin p512 as the active document p499 and that are contiguous with the current entry p514 . 2. The browsing context's browsing context name p502 must be unset. The user agent must make the specified entry's Document p33 object the active document p499 of the browsing context p499 . If the specified entry has a browsing context name p502 stored with it, then the following subsub-steps must be run: 1. The browsing context's browsing context name p502 must be set to the name stored with the specified entry. 2. Any browsing context name p502 stored with the entries in the history that are associated with Document p33 objects with the same origin p512 as the new active document p499 , and that are contiguous with the specified entry, must be cleared. If the specified entry's Document p33 has any input p353 elements whose resulting autocompletion state p376 is off, invoke the reset algorithm p423 of each of those elements. If the current document readiness p82 of the specified entry's Document p33 is "complete", queue a task p553 to fire a pageshow p529 event at the Window p503 object of that Document p33 , but with its target p33 set to the Document p33 object (and the currentTarget set to the Window p503 object), using the PageTransitionEvent p529 interface, with the persisted p530 attribute set to true. This event must not bubble, must not be cancelable, and has no default action.
2.
3.
4.
5.
5. 6.
Set the document's current address p77 to the URL of the specified entry. If the specified entry has a URL whose fragment identifier differs from that of the current entry p514 's when compared in a case-sensitive p36 manner, and the two share the same Document p33 object, then let hash changed be true, and let old URL be the URL of the current entry p514 and new URL be the URL of the specified entry. Otherwise, let hash changed be false. If the traversal was initiated with replacement enabled, remove the entry immediately before the specified entry in the session history. If the specified entry is not an entry with persisted user state p514 , but its URL has a fragment identifier, scroll to the fragment identifier p527 . If the entry is an entry with persisted user state p514 , the user agent may update aspects of the document and its rendering, for instance the scroll position or values of form fields, that it had previously recorded. If the entry is a state object p514 entry, let state be a structured clone p72 of that state object. Otherwise, let state be null. Run the appropriate steps according to the conditions described:
p82 is set to the string "complete" If the current document readiness
7.
8.
9.
10.
11.
Queue a task p553 to fire a popstate p529 event at the Window p503 object of the Document p33 , using the PopStateEvent p529 interface, with the state p529 attribute set to the value of state. This event must bubble but not be cancelable and has no default action. Otherwise Let the Document p33 's pending state object p529 be state. (If there was already a pending state object p529 , the previous one is discarded.) Note: The event will then be fired just after the load event. 12. If hash changed is true, then queue a task p553 to fire a hashchange p529 event at the browsing context p499 's Window p503 object, using the HashChangeEvent p529 interface, with the oldURL p529 attribute set to old URL and the newURL p529 attribute set to new URL. This event must bubble but not be cancelable and has no default action. The current entry p514 is now the specified entry.
13.
528
The pending state object is used to keep track of what state object to use in the inital popstate p529 event fired by the parser once it stops parsing p687 . The pending state object p529 must be initially null. The task source p553 for the tasks mentioned above is the DOM manipulation task source p554 .
6.5.9.1 Event definitions The popstate event is fired in certain cases when navigating to a session history entry p514 . interface PopStateEvent : Event { readonly attribute any state; void initPopStateEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in any stateArg); }; This box is non-normative. Implementation requirements are given below this box. event . state p529 Returns a copy of the information that was provided to pushState() p516 or replaceState() p516 .
The initPopStateEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces. [DOMEVENTS] p782 The state attribute represents the context information for the event, or null, if the state represented is the initial state of the Document p33 . The hashchange event is fired when navigating to a session history entry p514 whose URL p55 differs from that of the previous one only in the fragment identifier. interface HashChangeEvent : Event { readonly attribute DOMString oldURL; readonly attribute DOMString newURL; void initHashChangeEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString oldURLArg, in DOMString newURLArg); }; This box is non-normative. Implementation requirements are given below this box. event . oldURL
p529
Returns the URL p55 of the session history entry p514 that was previously current. event . newURL p529 Returns the URL p55 of the session history entry p514 that is now current.
The initHashChangeEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces. [DOMEVENTS] p782 The oldURL attribute represents context information for the event, specifically the URL of the session history entry p514 that was traversed from. The newURL attribute represents context information for the event, specifically the URL of the session history entry p514 that was traversed to. The pageshow event is fired when traversing to a session history entry p514 . The pagehide event is fired when traversing from a session history entry p514 . interface PageTransitionEvent : Event { readonly attribute boolean persisted; void initPageTransitionEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in boolean persistedArg); };
529
This box is non-normative. Implementation requirements are given below this box. event . persisted
p530
Returns false if the page is newly being loaded (and the load event will fire). Otherwise, returns true.
The initPageTransitionEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces. [DOMEVENTS] p782 The persisted attribute represents the context information for the event.
2. 3. 4.
5.
7. 8.
2.
When a user agent is to unload a document, it must run the following steps. These steps are passed an argument, recycle, which is either true or false, indicating whether the Document p33 object is going to be re-used. (This is set by the document.open() p109 method.) 1. Fire a pagehide p529 event at the Window p503 object of the Document p33 , but with its target p33 set to the Document p33 object (and the currentTarget set to the Window p503 object), using the PageTransitionEvent p529 interface, with the persisted p530 attribute set to true. This event must not bubble, must not be cancelable, and has no default action. Unload event: Fire a simple event p559 named unload at the Document p33 's Window p503 object. Release the storage mutex p553 . If any event listeners were triggered by the earlier unload event step, then set the Document p33 object's salvageable state to false. Run any unloading document cleanup steps p531 for Document p33 that are defined by this specification and other applicable specifications p36 .
2. 3. 4.
5.
530
6.
If this algorithm was invoked by another instance of the "unload a document" algorithm (i.e. through the steps below that invoke this algorithm for all descendant browsing contexts), then abort these steps here. Let descendants be the list of the descendant browsing contexts p500 of the Document p33 . If descendants is not an empty list, then for each browsing context p499 b in descendants run the following substeps: 1. Unload p530 the active document p499 of the browsing context p499 b with the recycle parameter set to false. If salvageable state of the active document p499 of the browsing context p499 b is false, then set the salvageable state of this document to false also.
7. 8.
2.
9.
If salvageable and recycle are both false, then the Document p33 's browsing context p499 must discard the Document p508 .
This specification defines the following unloading document cleanup steps. Other specifications can define more. 1. Close the WebSocket connection of any WebSocket objects that were created by the WebSocket() constructor visible on the Document p33 's Window p503 object. If this affected any WebSocket objects, the set Document p33 's salvageable state to false. [WEBSOCKET] p785 If the Document p33 's salvageable state is false, empty the Document p33 's Window p503 's list of active timeouts p560 and its list of active intervals p560 .
2.
6.5.10.1 Event definition interface BeforeUnloadEvent : Event { attribute DOMString returnValue; }; This box is non-normative. Implementation requirements are given below this box. event . returnValue
p531
[ = value ]
Returns the current return value of the event (the message to show the user). Can be set, to update the message.
Note: There are no BeforeUnloadEvent p531 -specific initialization methods. The returnValue attribute represents the message to show the user. When the event is created, the attribute must be set to the empty string. On getting, it must return the last value it was set to. On setting, the attribute must be set to the new value.
3.
User agents may allow users to explicitly invoke the abort a document p531 algorithm for a Document p33 . If the user does so, then, if that Document p33 is an active document p499 , the user agent should queue a task p553 to fire a simple event p559 named abort at that Document p33 's Window p503 object before invoking the abort p531 algorithm.
531
In order to enable users to continue interacting with Web applications and documents even when their network connection is unavailable for instance, because they are traveling outside of their ISP's coverage area authors can provide a manifest which lists the files that are needed for the Web application to work offline and which causes the user's browser to keep a copy of the files for use offline. To illustrate this, consider a simple clock applet consisting of an HTML page "clock.html", a CSS style sheet "clock.css", and a JavaScript script "clock.js". Before adding the manifest, these three files might look like this: <!-- clock.html --> <!DOCTYPE HTML> <html> <head> <title>Clock</title> <script src="clock.js"></script> <link rel="stylesheet" href="clock.css"> </head> <body> <p>The time is: <output id="clock"></output></p> </body> </html> /* clock.css */ output { font: 2em sans-serif; } /* clock.js */ setTimeout(function () { document.getElementById('clock').value = new Date(); }, 1000); If the user tries to open the "clock.html" page while offline, though, the user agent (unless it happens to have it still in the local cache) will fail with an error. The author can instead provide a manifest of the three files: CACHE MANIFEST clock.html clock.css clock.js With a small change to the HTML file, the manifest (served as text/cache-manifest p760 ) is linked to the application: <!-- clock.html --> <!DOCTYPE HTML> <html manifest="clock.manifest"> <head> <title>Clock</title> <script src="clock.js"></script> <link rel="stylesheet" href="clock.css"> </head> <body> <p>The time is: <output id="clock"></output></p> </body> </html> Now, if the user goes to the page, the browser will cache the files and make them available even when the user is offline. Note: Authors are encouraged to include the main page in the manifest also, but in practice the page that referenced the manifest is automatically cached even if it isn't explicitly mentioned. Note: HTTP cache headers and restrictions on caching pages served over TLS (encrypted, using https:) are overridden by manifests. Thus, pages will not expire from an application cache before the user agent has updated it, and even applications served over TLS can be made to work offline.
532
When the user visits a page that declares a manifest, the browser will try to update the cache. It does this by fetching a copy of the manifest and, if the manifest has changed since the user agent last saw it, redownloading all the resources it mentions and caching them anew. As this is going on, a number of events get fired on the ApplicationCache p546 object to keep the script updated as to the state of the cache update, so that the user can be notified appropriately. The events are as follows:
Event name checking Interface Event p33 Dispatched when... The user agent is checking for an update, or attempting to download the manifest for the first time. This is always the first event in the sequence. The manifest hadn't changed. The user agent has found an update and is fetching it, or is downloading the resources listed by the manifest for the first time. Next events noupdate p533 , downloading p533 , obsolete p533 , error p533 Last event in sequence. progress p533 , error p533 , cached p533 , updateready p533 progress p533 , error p533 , cached p533 , updateready p533 Last event in sequence. Last event in sequence. Last event in sequence. Last event in sequence.
noupdate
Event p33
ProgressEvent The user agent is downloading resources listed by the manifest. Event p33 The resources listed in the manifest have been downloaded, and the application is now cached. The resources listed in the manifest have been newly redownloaded, and the script can use swapCache() p548 to switch to the new cache. The manifest was found to have become a 404 or 410 page, so the application cache is being deleted. The manifest was a 404 or 410 page, so the attempt to cache the application has been aborted. The manifest hadn't changed, but the page referencing the manifest failed to download properly. A fatal error occurred while fetching the resources listed in the manifest. The manifest changed while the update was being run.
The user agent will try fetching the files again momentarily.
533
Each application cache p533 has a completeness flag, which is either complete or incomplete. An application cache group is a group of application caches p533 , identified by the absolute URL p56 of a resource manifest p533 which is used to populate the caches in the group. An application cache p533 is newer than another if it was created after the other (in other words, application caches p533 in an application cache group p534 have a chronological order). Only the newest application cache p533 in an application cache group p534 can have its completeness flag p534 set to incomplete; the others are always all complete. Each application cache group p534 has an update status, which is one of the following: idle, checking, downloading. A relevant application cache is an application cache p533 that is the newest p534 in its group p534 to be complete. Each application cache group p534 has a list of pending master entries. Each entry in this list consists of a resource and a corresponding Document p33 object. It is used during the application cache download process p539 to ensure that new master entries are cached even if the application cache download process p539 was already running for their application cache group p534 when they were loaded. An application cache group p534 can be marked as obsolete, meaning that it must be ignored when looking at what application cache groups p534 exist. A cache host is a Document p33 or a SharedWorkerGlobalScope object. A cache host p534 can be associated with an application cache p533 . [WEBWORKERS] p786 A Document p33 initially is not associated with an application cache p533 , but can become associated with one early during the page load process, when steps in the parser p662 and in the navigation p520 sections cause cache selection p545 to occur. A SharedWorkerGlobalScope can be associated with an application cache p533 when it is created. [WEBWORKERS] p786 Each cache host p534 has an associated ApplicationCache p546 object. Multiple application caches p533 in different application cache groups p534 can contain the same resource, e.g. if the manifests all reference that resource. If the user agent is to select an application cache from a list of relevant application caches p534 that contain a resource, the user agent must use the application cache that the user most likely wants to see the resource from, taking into account the following: which application cache was most recently updated, which application cache was being used to display the resource from which the user decided to look at the new resource, and which application cache the user prefers.
A URL matches a fallback namespace if there exists a relevant application cache p534 whose manifest p533 's URL has the same origin p512 as the URL in question, and that has a fallback namespace p533 that is a prefix match p36 for the URL being examined. If multiple fallback namespaces match the same URL, the longest one is the one that matches. A URL looking for a fallback namespace can match more than one application cache at a time, but only matches one namespace in each cache. If a manifest http://example.com/app1/manifest declares that http://example.com/resources/images is a fallback namespace, and the user navigates to HTTP://EXAMPLE.COM:80/resources/images/cat.png, then the user agent will decide that the application cache identified by http://example.com/app1/ manifest contains a namespace with a match for that URL.
534
# there can be as many of these anywhere in the file # they are all ignored # comments can have spaces before them # but must be alone on the line # blank lines are ignored too # these are files that need to be cached they can either be listed # first, or a "CACHE:" header could be put before them, as is done # lower down. images/sound-icon.png images/background.png # note that each file has to be put on its own line # here is a file for the online whitelist -- it isn't cached, and # references to this file will bypass the cache, always hitting the # network (or trying to, if the user is offline). NETWORK: comm.cgi # here is another set of files to cache, this time just the CSS file. CACHE: style/default.css It could equally well be written as follows: CACHE MANIFEST NETWORK: comm.cgi CACHE: style/default.css images/sound-icon.png images/background.png Offline application cache manifests can use absolute paths or even absolute URLs: CACHE MANIFEST /main/home /main/app.js /settings/home /settings/app.js http://img.example.com/logo.png http://img.example.com/check.png http://img.example.com/cross.png The following manifest defines a catch-all error page that is displayed for any page on the site while the user is offline. It also specifies that the online whitelist wildcard flag p533 is open, meaning that accesses to resources on other sites will not be blocked. (Resources on the same site are already not blocked because of the catch-all fallback namespace.) So long as all pages on the site reference this manifest, they will get cached locally as they are fetched, so that subsequent hits to the same page will load the page immediately from the cache. Until the manifest is changed, those pages will not be fetched from the server again. When the manifest changes, then all the files will be redownloaded. Subresources, such as style sheets, images, etc, would only be cached using the regular HTTP caching semantics, however. CACHE MANIFEST FALLBACK: / /offline.html NETWORK: *
6.6.3.2 Writing cache manifests Manifests must be served using the text/cache-manifest p760 MIME type p28 . All resources served using the text/ cache-manifest p760 MIME type p28 must follow the syntax of application cache manifests, as described in this section.
535
An application cache manifest is a text file, whose text is encoded using UTF-8. Data in application cache manifests is line-based. Newlines must be represented by U+000A LINE FEED (LF) characters, U+000D CARRIAGE RETURN (CR) characters, or U+000D CARRIAGE RETURN (CR) U+000A LINE FEED (LF) pairs. [RFC3629] p784 Note: This is a willful violation p18 of RFC 2046, which requires all text/* types to only allow CRLF line breaks. This requirement, however, is outdated; the use of CR, LF, and CRLF line breaks is commonly supported and indeed sometimes CRLF is not supported by text editors. [RFC2046] p784 The first line of an application cache manifest must consist of the string "CACHE", a single U+0020 SPACE character, the string "MANIFEST", and either a U+0020 SPACE character, a U+0009 CHARACTER TABULATION (tab) character, a U+000A LINE FEED (LF) character, or a U+000D CARRIAGE RETURN (CR) character. The first line may optionally be preceded by a U+FEFF BYTE ORDER MARK (BOM) character. If any other text is found on the first line, it is ignored. Subsequent lines, if any, must all be one of the following: A blank line Blank lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters only. A comment Comment lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, followed by a single U+0023 NUMBER SIGN character (#), followed by zero or more characters other than U+000A LINE FEED (LF) and U+000D CARRIAGE RETURN (CR) characters. Note: Comments must be on a line on their own. If they were to be included on a line with a URL, the "#" would be mistaken for part of a fragment identifier. A section header Section headers change the current section. There are three possible section headers: CACHE: Switches to the explicit section. FALLBACK: Switches to the fallback section. NETWORK: Switches to the online whitelist section. Section header lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, followed by one of the names above (including the U+003A COLON character (:)) followed by zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters. Ironically, by default, the current section is the explicit section p536 . Data for the current section The format that data lines must take depends on the current section. When the current section is the explicit section p536 , data lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, a valid URL p55 identifying a resource other than the manifest itself, and then zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters. When the current section is the fallback section p536 , data lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, a valid URL p55 identifying a resource other than the manifest itself, one or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, another valid URL p55 identifying a resource other than the manifest itself, and then zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters. When the current section is the online whitelist section p536 , data lines must consist of zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters, either a single U+002A ASTERISK character (*) or a valid URL p55 identifying a resource other than the manifest itself, and then zero or more U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters. Manifests may contain sections more than once. Sections may be empty. If the manifest's <scheme> p55 is https: or another scheme intended for encrypted data transfer, then all URLs in explicit sections p536 must have the same origin p512 as the manifest itself. URLs that are to be fallback pages associated with fallback namespaces p533 , and those namespaces themselves, must be given in fallback sections p536 , with the namespace being the first URL of the data line, and the
536
corresponding fallback page being the second URL. All the other pages to be cached must be listed in explicit sections p536 . Fallback namespaces p533 and fallback entries p533 must have the same origin p512 as the manifest itself. A fallback namespace p533 must not be listed more than once. Namespaces that the user agent is to put into the online whitelist p533 must all be specified in online whitelist sections p536 . (This is needed for any URL that the page is intending to use to communicate back to the server.) To specify that all URLs are automatically whitelisted in this way, a U+002A ASTERISK character (*) may be specified as one of the URLs. Authors should not include namespaces in the online whitelist p533 for which another namespace in the online whitelist p533 is a prefix match p36 . Relative URLs must be given relative to the manifest's own URL. All URLs in the manifest must have the same <scheme> p55 as the manifest itself (either explicitly or implicitly, through the use of relative URLs). URLs in manifests must not have fragment identifiers (i.e. the U+0023 NUMBER SIGN character isn't allowed in URLs in manifests). Fallback namespaces p533 and namespaces in the online whitelist p533 are matched by prefix match p36 .
6.6.3.3 Parsing cache manifests When a user agent is to parse a manifest, it means that the user agent must run the following steps: 1. The user agent must decode the byte stream corresponding with the manifest to be parsed as UTF-8, with error handling p36 . Let base URL be the absolute URL p56 representing the manifest. Let explicit URLs be an initially empty list of absolute URLs p56 for explicit entries p533 . Let fallback URLs be an initially empty mapping of fallback namespaces p533 to absolute URLs p56 for fallback entries p533 . Let online whitelist namespaces be an initially empty list of absolute URLs p56 for an online whitelist p533 . Let online whitelist wildcard flag be blocking. Let input be the decoded text of the manifest's byte stream. Let position be a pointer into input, initially pointing at the first character. If position is pointing at a U+FEFF BYTE ORDER MARK (BOM) character, then advance position to the next character. If the characters starting from position are "CACHE", followed by a U+0020 SPACE character, followed by "MANIFEST", then advance position to the next character after those. Otherwise, this isn't a cache manifest; abort this algorithm with a failure while checking for the magic signature. If the character at position is neither a U+0020 SPACE character, a U+0009 CHARACTER TABULATION (tab) character, U+000A LINE FEED (LF) character, nor a U+000D CARRIAGE RETURN (CR) character, then this isn't a cache manifest; abort this algorithm with a failure while checking for the magic signature. This is a cache manifest. The algorithm cannot fail beyond this point (though bogus lines can get ignored). Collect a sequence of characters p37 that are not U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters, and ignore those characters. (Extra text on the first line, after the signature, is ignored.) Let mode be "explicit". Start of line: If position is past the end of input, then jump to the last step. Otherwise, collect a sequence of characters p37 that are U+000A LINE FEED (LF), U+000D CARRIAGE RETURN (CR), U+0020 SPACE, or U+0009 CHARACTER TABULATION (tab) characters. Now, collect a sequence of characters p37 that are not U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters, and let the result be line. Drop any trailing U+0020 SPACE and U+0009 CHARACTER TABULATION (tab) characters at the end of line.
2. 3. 4.
5. 6. 7. 8. 9.
10.
11.
12.
13.
14. 15.
16.
17.
537
18. 19.
If line is the empty string, then jump back to the step labeled "start of line". If the first character in line is a U+0023 NUMBER SIGN character (#), then jump back to the step labeled "start of line". If line equals "CACHE:" (the word "CACHE" followed by a U+003A COLON character (:)), then set mode to "explicit" and jump back to the step labeled "start of line". If line equals "FALLBACK:" (the word "FALLBACK" followed by a U+003A COLON character (:)), then set mode to "fallback" and jump back to the step labeled "start of line". If line equals "NETWORK:" (the word "NETWORK" followed by a U+003A COLON character (:)), then set mode to "online whitelist" and jump back to the step labeled "start of line". If line ends with a U+003A COLON character (:), then set mode to "unknown" and jump back to the step labeled "start of line". This is either a data line or it is syntactically incorrect. Let position be a pointer into line, initially pointing at the start of the string. Let tokens be a list of strings, initially empty. While position doesn't point past the end of line: 1. 2. Let current token be an empty string. While position doesn't point past the end of line and the character at position is neither a U+0020 SPACE nor a U+0009 CHARACTER TABULATION (tab) character, add the character at position to current token and advance position to the next character in input. Add current token to the tokens list. While position doesn't point past the end of line and the character at position is either a U+0020 SPACE or a U+0009 CHARACTER TABULATION (tab) character, advance position to the next character in input.
20.
21.
22.
23.
3. 4.
28.
Process tokens as follows: If mode is "explicit" Resolve p55 the first item in tokens, relative to base URL; ignore the rest. If this fails, then jump back to the step labeled "start of line". If the resulting absolute URL p56 has a different <scheme> p55 component than the manifest's URL (compared in an ASCII case-insensitive p36 manner), then jump back to the step labeled "start of line". If the manifest's <scheme> p55 is https: or another scheme intended for encrypted data transfer, and the resulting absolute URL p56 does not have the same origin p512 as the manifest's URL, then jump back to the step labeled "start of line". Drop the <fragment> p55 component of the resulting absolute URL p56 , if it has one. Add the resulting absolute URL p56 to the explicit URLs. If mode is "fallback" Let part one be the first token in tokens, and let part two be the second token in tokens. Resolve p55 part one and part two, relative to base URL. If either fails, then jump back to the step labeled "start of line". If the absolute URL p56 corresponding to either part one or part two does not have the same origin p512 as the manifest's URL, then jump back to the step labeled "start of line". Drop any <fragment> p55 components of the resulting absolute URLs p56 . If the absolute URL p56 corresponding to part one is already in the fallback URLs mapping as a fallback namespace p533 , then jump back to the step labeled "start of line". Otherwise, add the absolute URL p56 corresponding to part one to the fallback URLs mapping as a fallback namespace p533 , mapped to the absolute URL p56 corresponding to part two as the fallback entry p533 . If mode is "online whitelist" If the first item in tokens is a U+002A ASTERISK character (*), then set online whitelist wildcard flag to open and jump back to the step labeled "start of line".
538
Otherwise, resolve p55 the first item in tokens, relative to base URL; ignore the rest. If this fails, then jump back to the step labeled "start of line". If the resulting absolute URL p56 has a different <scheme> p55 component than the manifest's URL (compared in an ASCII case-insensitive p36 manner), then jump back to the step labeled "start of line". Drop the <fragment> p55 component of the resulting absolute URL p56 , if it has one. Add the resulting absolute URL p56 to the online whitelist namespaces. If mode is "unknown" Do nothing. The line is ignored. 29. Jump back to the step labeled "start of line". (That step jumps to the next, and last, step when the end of the file is reached.) Return the explicit URLs list, the fallback URLs mapping, the online whitelist namespaces, and the online whitelist wildcard flag.
30.
If a resource is listed in the explicit section p536 or as a fallback entry p533 in the fallback section p536 , the resource will always be taken from the cache, regardless of any other matching entries in the fallback namespaces p533 or online whitelist namespaces p533 . When a fallback namespace p533 and an online whitelist namespace p533 overlap, the online whitelist namespace p533 has priority. The online whitelist wildcard flag p533 is applied last, only for URLs that match neither the online whitelist namespace p533 nor the fallback namespace p533 and that are not listed in the explicit section p536 .
2.
Let manifest URL be that absolute URL p56 . If there is no application cache group p534 identified by manifest URL, then create a new application cache group p534 identified by manifest URL. Initially, it has no application caches p533 . One will be created later in this algorithm.
539
Let manifest URL be the absolute URL p56 of the manifest p533 used to identify the application cache group p534 to be updated. If that application cache group p534 is obsolete p534 , then abort this instance of the application cache download process p539 . This can happen if another instance of this algorithm found the manifest to be 404 or 410 while this algorithm was waiting in the first step above. 2. 3. Let cache group be the application cache group p534 identified by manifest URL. If these steps were invoked with a master p533 resource, then add the resource, along with the resource's Document p33 , to cache group's list of pending master entries p534 . If these steps were invoked with a cache host p534 , and the status p534 of cache group is checking or downloading, then queue a post-load task p545 to fire a simple event p559 named checking p533 that is cancelable at the ApplicationCache p546 singleton of that cache host p534 . The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent is checking to see if it can download the application. If these steps were invoked with a cache host p534 , and the status p534 of cache group is downloading, then also queue a post-load task p545 to fire a simple event p559 named downloading p533 that is cancelable at the ApplicationCache p546 singleton of that cache host p534 . The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user the application is being downloaded. If the status p534 of the cache group is either checking or downloading, then abort this instance of the application cache download process p539 , as an update is already in progress. Set the status p534 of cache group to checking. For each cache host p534 associated with an application cache p533 in cache group, queue a postload task p545 to fire a simple event p559 that is cancelable named checking p533 at the ApplicationCache p546 singleton of the cache host p534 . The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent is checking for the availability of updates.
4.
5.
6.
7. 8.
Note: The remainder of the steps run asynchronously. If cache group already has an application cache p533 in it, then this is an upgrade attempt. Otherwise, this is a cache attempt. 3. If this is a cache attempt p540 , then this algorithm was invoked with a cache host p534 ; queue a post-load task p545 to fire a simple event p559 named checking p533 that is cancelable at the ApplicationCache p546 singleton of that cache host p534 . The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent is checking for the availability of updates. Fetching the manifest: Fetch p59 the resource from manifest URL with the synchronous flag set, and let manifest be that resource. If the resource is labeled with the MIME type p28 text/cache-manifest p760 , parse manifest according to the rules for parsing manifests p537 , obtaining a list of explicit entries p533 , fallback entries p533 and the fallback namespaces p533 that map to them, entries for the online whitelist p533 , and a value for the online whitelist wildcard flag p533 . 5. If fetching the manifest fails due to a 404 or 410 response or equivalent p61 , then run these substeps: 1. Mark cache group as obsolete p534 . This cache group no longer exists for any purpose other than the processing of Document p33 objects already associated with an application cache p533 in the cache group. Let task list be an empty list of tasks p553 . For each cache host p534 associated with an application cache p533 in cache group, create a task p553 to fire a simple event p559 named obsolete p533 that is cancelable at the ApplicationCache p546 singleton of the cache host p534 , and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the application is no longer available for offline use.
4.
2. 3.
540
4.
For each entry in cache group's list of pending master entries p534 , create a task p553 to fire a simple event p559 that is cancelable named error p533 (not obsolete p533 !) at the ApplicationCache p546 singleton of the cache host p534 the Document p33 for this entry, if there still is one, and append it to task list. The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent failed to save the application for offline use. If cache group has an application cache p533 whose completeness flag p534 is incomplete, then discard that application cache p533 . If appropriate, remove any user interface indicating that an update for this cache is in progress. Let the status p534 of cache group be idle. For each task p553 in task list, queue that task as a post-load task p545 . Abort the application cache download process p539 .
5.
6.
7. 8. 9. 6.
Otherwise, if fetching the manifest fails in some other way (e.g. the server returns another 4xx or 5xx response or equivalent p61 , or there is a DNS error, or the connection times out, or the user cancels the download, or the parser for manifests fails when checking the magic signature), or if the server returned a redirect, or if the resource is labeled with a MIME type p28 other than text/cache-manifest p760 , then run the cache failure steps p544 . If this is an upgrade attempt p540 and the newly downloaded manifest is byte-for-byte identical to the manifest found in the newest p534 application cache p533 in cache group, or the server reported it as "304 Not Modified" or equivalent p61 , then run these substeps: 1. 2. 3. Let cache be the newest p534 application cache p533 in cache group. Let task list be an empty list of tasks p553 . For each entry in cache group's list of pending master entries p534 , wait for the resource for this entry to have either completely downloaded or failed. If the download failed (e.g. the connection times out, or the user cancels the download), then create a task p553 to fire a simple event p559 that is cancelable named error p533 at the ApplicationCache p546 singleton of the cache host p534 the Document p33 for this entry, if there still is one, and append it to task list. The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent failed to save the application for offline use. Otherwise, associate the Document p33 for this entry with cache; store the resource for this entry in cache, if it isn't already there, and categorize its entry as a master entry p533 . If the resource's URL p55 has a <fragment> p55 component, it must be removed from the entry in cache (application caches never include fragment identifiers). Note: HTTP caching rules, such as Cache-Control: no-store, are ignored for the purposes of the application cache download process p539 . 4. For each cache host p534 associated with an application cache p533 in cache group, create a task p553 to fire a simple event p559 that is cancelable named noupdate p533 at the ApplicationCache p546 singleton of the cache host p534 , and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the application is up to date. Empty cache group's list of pending master entries p534 . If appropriate, remove any user interface indicating that an update for this cache is in progress. Let the status p534 of cache group be idle. For each task p553 in task list, queue that task as a post-load task p545 . Abort the application cache download process p539 .
7.
5. 6.
7. 8. 9. 8.
Let new cache be a newly created application cache p533 in cache group. Set its completeness flag p534 to incomplete. For each entry in cache group's list of pending master entries p534 , associate the Document p33 for this entry with new cache.
9.
541
10. 11.
Set the status p534 of cache group to downloading. For each cache host p534 associated with an application cache p533 in cache group, queue a post-load task p545 to fire a simple event p559 that is cancelable named downloading p533 at the ApplicationCache p546 singleton of the cache host p534 . The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that a new version is being downloaded. Let file list be an empty list of URLs with flags. Add all the URLs in the list of explicit entries p533 obtained by parsing manifest to file list, each flagged with "explicit entry". Add all the URLs in the list of fallback entries p533 obtained by parsing manifest to file list, each flagged with "fallback entry". If this is an upgrade attempt p540 , then add all the URLs of master entries p533 in the newest p534 application cache p533 in cache group whose completeness flag p534 is complete to file list, each flagged with "master entry". If any URL is in file list more than once, then merge the entries into one entry for that URL, that entry having all the flags that the original entries had. For each URL in file list, run the following steps. These steps may be run in parallel for two or more of the URLs at a time. 1. If the resource URL being processed was flagged as neither an "explicit entry" nor or a "fallback entry", then the user agent may skip this URL. Note: This is intended to allow user agents to expire resources not listed in the manifest from the cache. Generally, implementors are urged to use an approach that expires lesser-used resources first. 2. For each cache host p534 associated with an application cache p533 in cache group, queue a postload task p545 to fire an event with the name progress p533 , which does not bubble, which is cancelable, and which uses the ProgressEvent interface, at the ApplicationCache p546 singleton of the cache host p534 . The lengthComputable attribute must be set to true, the total attribute must be set to the number of files in file list, and the loaded attribute must be set to the number of number of files in file list that have been either downloaded or skipped so far. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that a file is being downloaded in preparation for updating the application. [PROGRESS] p783 Fetch p59 the resource, from the origin p510 of the URL p55 manifest URL, with the synchronous flag set and the manual redirect flag set. If this is an upgrade attempt p540 , then use the newest p534 application cache p533 in cache group as an HTTP cache, and honor HTTP caching semantics (such as expiration, ETags, and so forth) with respect to that cache. User agents may also have other caches in place that are also honored. Note: If the resource in question is already being downloaded for other reasons then the existing download process can sometimes be used for the purposes of this step, as defined by the fetching p59 algorithm. An example of a resource that might already be being downloaded is a large image on a Web page that is being seen for the first time. The image would get downloaded to satisfy the img p199 element on the page, as well as being listed in the cache manifest. According to the rules for fetching p59 that image only need be downloaded once, and it can be used both for the cache and for the rendered Web page. 4. If the previous step fails (e.g. the server returns a 4xx or 5xx response or equivalent p61 , or there is a DNS error, or the connection times out, or the user cancels the download), or if the server returned a redirect, then run the first appropriate step from the following list: If the URL being processed was flagged as an "explicit entry" or a "fallback entry" Run the cache failure steps p544 . Note: Redirects are fatal because they are either indicative of a network problem (e.g. a captive portal); or would allow resources to be added to the cache under URLs that differ from any URL that the networking model will allow access to, leaving orphan entries; or
12. 13.
14.
15.
16.
17.
3.
542
would allow resources to be stored under URLs different than their true URLs. All of these situations are bad.
p61 If the error was a 404 or 410 HTTP response or equivalent
Skip this resource. It is dropped from the cache. Otherwise Copy the resource and its metadata from the newest p534 application cache p533 in cache group whose completeness flag p534 is complete, and act as if that was the fetched resource, ignoring the resource obtained from the network. User agents may warn the user of these errors as an aid to development. Note: These rules make errors for resources listed in the manifest fatal, while making it possible for other resources to be removed from caches when they are removed from the server, without errors, and making nonmanifest resources survive server-side errors. 5. Otherwise, the fetching succeeded. Store the resource in the new cache. If the user agent is not able to store the resource (e.g. because of quota restrictions), the user agent may prompt the user or try to resolve the problem in some other manner (e.g. automatically pruning content in other caches). If the problem cannot be resolved, the user agent must run the cache failure steps p544 . 6. If the URL being processed was flagged as an "explicit entry" in file list, then categorize the entry as an explicit entry p533 . If the URL being processed was flagged as a "fallback entry" in file list, then categorize the entry as a fallback entry p533 . If the URL being processed was flagged as an "master entry" in file list, then categorize the entry as a master entry p533 . As an optimization, if the resource is an HTML or XML file whose root element is an html p116 element with a manifest p116 attribute whose value doesn't match the manifest URL of the application cache being processed, then the user agent should mark the entry as being foreign p533 .
7.
8.
9.
18.
For each cache host p534 associated with an application cache p533 in cache group, queue a post-load task p545 to fire an event with the name progress p533 , which does not bubble, which is cancelable, and which uses the ProgressEvent interface, at the ApplicationCache p546 singleton of the cache host p534 . The lengthComputable attribute must be set to true, the total and the loaded attributes must be set to the number of number of files in file list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that all the files have been downloaded. [PROGRESS] p783 Store the list of fallback namespaces p533 , and the URLs of the fallback entries p533 that they map to, in new cache. Store the URLs that form the new online whitelist p533 in new cache. Store the value of the new online whitelist wildcard flag p533 in new cache. For each entry in cache group's list of pending master entries p534 , wait for the resource for this entry to have either completely downloaded or failed. If the download failed (e.g. the connection times out, or the user cancels the download), then run these substeps: 1. 2. Unassociate the Document p33 for this entry from new cache. Queue a post-load task p545 to fire a simple event p559 that is cancelable named error p533 at the ApplicationCache p546 singleton of the Document p33 for this entry, if there still is one. The default action of this event must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent failed to save the application for offline use. If this is a cache attempt p540 and this entry is the last entry in cache group's list of pending master entries p534 , then run these further substeps: 1. Discard cache group and its only application cache p533 , new cache.
19.
3.
543
2.
If appropriate, remove any user interface indicating that an update for this cache is in progress. Abort the application cache download process p539 .
3. 4.
Otherwise, remove this entry from cache group's list of pending master entries p534 .
Otherwise, store the resource for this entry in new cache, if it isn't already there, and categorize its entry as a master entry p533 . 23. Fetch p59 the resource from manifest URL again, with the synchronous flag set, and let second manifest be that resource. If the previous step failed for any reason, or if the fetching attempt involved a redirect, or if second manifest and manifest are not byte-for-byte identical, then schedule a rerun of the entire algorithm with the same parameters after a short delay, and run the cache failure steps p544 . Otherwise, store manifest in new cache, if it's not there already, and categorize its entry as the manifest p533 . Set the completeness flag p534 of new cache to complete. Let task list be an empty list of tasks p553 . If this is a cache attempt p540 , then for each cache host p534 associated with an application cache p533 in cache group, create a task p553 to fire a simple event p559 that is cancelable named cached p533 at the ApplicationCache p546 singleton of the cache host p534 , and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the application has been cached and that they can now use it offline. Otherwise, it is an upgrade attempt p540 . For each cache host p534 associated with an application cache p533 in cache group, create a task p553 to fire a simple event p559 that is cancelable named updateready p533 at the ApplicationCache p546 singleton of the cache host p534 , and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that a new version is available and that they can activate it by reloading the page. 29. 30. 31. If appropriate, remove any user interface indicating that an update for this cache is in progress. Set the update status p534 of cache group to idle. For each task p553 in task list, queue that task as a post-load task p545 .
24.
25.
The cache failure steps are as follows: 1. 2. Let task list be an empty list of tasks p553 . For each entry in cache group's list of pending master entries p534 , run the following further substeps. These steps may be run in parallel for two or more entries at a time. 1. 2. 3. Wait for the resource for this entry to have either completely downloaded or failed. Unassociate the Document p33 for this entry from its application cache p533 , if it has one. Create a task p553 to fire a simple event p559 that is cancelable named error p533 at the ApplicationCache p546 singleton of the Document p33 for this entry, if there still is one, and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent failed to save the application for offline use.
3.
For each cache host p534 still associated with an application cache p533 in cache group, create a task p553 to fire a simple event p559 that is cancelable named error p533 at the ApplicationCache p546 singleton of the cache host p534 , and append it to task list. The default action of these events must be, if the user agent shows caching progress p539 , the display of some sort of user interface indicating to the user that the user agent failed to save the application for offline use. Empty cache group's list of pending master entries p534 . If cache group has an application cache p533 whose completeness flag p534 is incomplete, then discard that application cache p533 . If appropriate, remove any user interface indicating that an update for this cache is in progress. Let the status p534 of cache group be idle.
4. 5.
6. 7.
544
8. 9. 10.
If this was a cache attempt p540 , discard cache group altogether. For each task p553 in task list, queue that task as a post-load task p545 . Abort the application cache download process p539 .
Attempts to fetch p59 resources as part of the application cache download process p539 may be done with cachedefeating semantics, to avoid problems with stale or inconsistent intermediary caches. User agents may invoke the application cache download process p539 , in the background, for any application cache p533 , at any time (with no cache host p534 ). This allows user agents to keep caches primed and to update caches even before the user visits a site. Each Document p33 has a list of pending application cache download process tasks that is used to delay events fired by the algorithm above until the document's load event has fired. When the Document p33 is created, the list must be empty. When the steps above say to queue a post-load task task, where task is a task p553 that dispatches an event on a target ApplicationCache p546 object target, the user agent must run the appropriate steps from the following list: If target's Document p33 is ready for post-load tasks p687 Queue p553 the task task. Otherwise Add task to target's Document p33 's list of pending application cache download process tasks p545 . The task source p553 for these tasks p553 is the networking task source p554 .
Mark the entry for the resource from which document was taken in the application cache p533 from which it was loaded as foreign p533 . Restart the current navigation from the top of the navigation algorithm p520 , undoing any changes that were made as part of the initial load (changes can be avoided by ensuring that the step to update the session history with the new page p523 is only ever completed after this application cache selection algorithm p545 is run, though this is not required). Note: The navigation will not result in the same resource being loaded, because "foreign" entries are never picked during navigation. User agents may notify the user of the inconsistency between the cache manifest and the document's own metadata, to aid in application development.
p533 , and that application cache p533 still exists (it If document was loaded from an application cache p534 is not now obsolete )
Associate document with the application cache p533 from which it was loaded. Invoke, in the background, the application cache download process p539 for that application cache p533 's application cache group p534 , with document as the cache host p534 .
p61 If document was loaded using HTTP GET or equivalent , and, there is a manifest URL, and manifest URL has the same origin p512 as document
Invoke, in the background, the application cache download process p539 for manifest URL, with document as the cache host p534 and with the resource from which document was parsed as the master p533 resource. Otherwise The Document p33 is not associated with any application cache p533 . If there was a manifest URL, the user agent may report to the user that it was ignored, to aid in application development.
545
2.
3.
4.
6.
Note: The above algorithm ensures that so long as the online whitelist wildcard flag p533 is blocking, resources that are not present in the manifest p533 will always fail to load (at least, after the application cache p533 has been primed the first time), making the testing of offline applications simpler.
546
const unsigned short UNCACHED = 0; const unsigned short IDLE = 1; const unsigned short CHECKING = 2; const unsigned short DOWNLOADING = 3; const unsigned short UPDATEREADY = 4; const unsigned short OBSOLETE = 5; readonly attribute unsigned short status; // updates void update(); void swapCache(); // events attribute attribute attribute attribute attribute attribute attribute attribute Function Function Function Function Function Function Function Function onchecking; onerror; onnoupdate; ondownloading; onprogress; onupdateready; oncached; onobsolete;
}; ApplicationCache implements EventTarget; This box is non-normative. Implementation requirements are given below this box. cache = window . applicationCache p547 (In a window.) Returns the ApplicationCache p546 object that applies to the active document p499 of that Window p503 . cache = self . applicationCache p547 (In a shared worker.) Returns the ApplicationCache p546 object that applies to the current shared worker. [WEBWORKERS] p786 cache . status p547 Returns the current status of the application cache, as given by the constants defined below. cache . update p548 () Invokes the application cache download process p539 . Throws an INVALID_STATE_ERR p75 exception if there is no application cache to update. cache . swapCache p548 () Switches to the most recent application cache, if there is a newer one. If there isn't, throws an INVALID_STATE_ERR p75 exception. This does not cause previously-loaded resources to be reloaded; for example, images do not suddenly get reloaded and style sheets and scripts do not get reparsed or reevaluated. The only change is that subsequent requests for cached resources will obtain the newer copies.
There is a one-to-one mapping from cache hosts p534 to ApplicationCache p546 objects. The applicationCache attribute on Window p503 objects must return the ApplicationCache p546 object associated with the Window p503 object's active document p499 . The applicationCache attribute on SharedWorkerGlobalScope objects must return the ApplicationCache p546 object associated with the worker. [WEBWORKERS] p786 Note: A Window p503 or SharedWorkerGlobalScope object has an associated ApplicationCache p546 object even if that cache host p534 has no actual application cache p533 .
The status attribute, on getting, must return the current state of the application cache p533 that the ApplicationCache p546 object's cache host p534 is associated with, if any. This must be the appropriate value from the following list: UNCACHED (numeric value 0) The ApplicationCache p546 object's cache host p534 is not associated with an application cache p533 at this time.
547
IDLE (numeric value 1) The ApplicationCache p546 object's cache host p534 is associated with an application cache p533 whose application cache group p534 's update status p534 is idle, and that application cache p533 is the newest p534 cache in its application cache group p534 , and the application cache group p534 is not marked as obsolete p534 . CHECKING (numeric value 2) The ApplicationCache p546 object's cache host p534 is associated with an application cache p533 whose application cache group p534 's update status p534 is checking. DOWNLOADING (numeric value 3) The ApplicationCache p546 object's cache host p534 is associated with an application cache p533 whose application cache group p534 's update status p534 is downloading. UPDATEREADY (numeric value 4) The ApplicationCache p546 object's cache host p534 is associated with an application cache p533 whose application cache group p534 's update status p534 is idle, and whose application cache group p534 is not marked as obsolete p534 , but that application cache p533 is not the newest p534 cache in its group. OBSOLETE (numeric value 5) The ApplicationCache p546 object's cache host p534 is associated with an application cache p533 whose application cache group p534 is marked as obsolete p534 . If the update() method is invoked, the user agent must invoke the application cache download process p539 , in the background, for the application cache p533 with which the ApplicationCache p546 object's cache host p534 is associated, but without giving that cache host p534 to the algorithm. If there is no such application cache p533 , or if it is marked as obsolete p534 , then the method must raise an INVALID_STATE_ERR p75 exception instead. If the swapCache() method is invoked, the user agent must run the following steps: 1. Check that ApplicationCache p546 object's cache host p534 is associated with an application cache p533 . If it is not, then raise an INVALID_STATE_ERR p75 exception and abort these steps. Let cache be the application cache p533 with which the ApplicationCache p546 object's cache host p534 is associated. (By definition, this is the same as the one that was found in the previous step.) If cache's application cache group p534 is marked as obsolete p534 , then unassociate the ApplicationCache p546 object's cache host p534 from cache and abort these steps. (Resources will now load from the network instead of the cache.) Check that there is an application cache in the same application cache group p534 as cache whose completeness flag p534 is complete and that is newer p534 than cache. If there is not, then raise an INVALID_STATE_ERR p75 exception and abort these steps. Let new cache be the newest p534 application cache p533 in the same application cache group p534 as cache whose completeness flag p534 is complete. Unassociate the ApplicationCache p546 object's cache host p534 from cache and instead associate it with new cache.
2.
3.
4.
5.
6.
The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported, as IDL attributes, by all objects implementing the ApplicationCache p546 interface:
Event handler p555 Event handler event type p556 onchecking onerror onnoupdate ondownloading onprogress onupdateready oncached onobsolete checking p533 error p533 noupdate p533 downloading p533 progress p533 updateready p533 cached p533 obsolete p533
548
window . navigator p565 . onLine p549 Returns false if the user agent is definitely offline (disconnected from the network). Returns true if the user agent might be online. The events online p549 and offline p549 are fired when the value of this attribute changes.
The navigator.onLine attribute must return false if the user agent will not contact the network when the user follows links or when a script requests a remote page (or knows that such an attempt would fail), and must return true otherwise. When the value that would be returned by the navigator.onLine p549 attribute of the Window p503 changes from true to false, the user agent must queue a task p553 to fire a simple event p559 named offline at the Window p503 object. On the other hand, when the value that would be returned by the navigator.onLine p549 attribute of the Window p503 changes from false to true, the user agent must queue a task p553 to fire a simple event p559 named online at the Window p503 object. The task source p553 for these tasks p553 is the networking task source p554 . Note: This attribute is inherently unreliable. A computer can be connected to a network without having Internet access. In this example, an indicator is updated as the browser goes online and offline. <!DOCTYPE HTML> <html> <head> <title>Online status</title> <script> function updateIndicator() { document.getElementById('indicator').textContext = navigator.onLine ? 'online' : 'offline'; } </script> </head> <body onload="updateIndicator()" ononline="updateIndicator()" onoffline="updateIndicator()"> <p>The network is: <span id="indicator">(state unknown)</span> </body> </html>
549
Scripting is disabled in a browsing context p499 when any of the above conditions are false (i.e. when scripting is not enabled p550 ). Scripting is enabled for a node if the Document p33 object of the node (the node itself, if it is itself a Document p33 object) has an associated browsing context p499 , and scripting is enabled p550 in that browsing context p499 . Scripting is disabled for a node if there is no such browsing context p499 , or if scripting is disabled p550 in that browsing context p499 .
550
Note: When a script's global object p550 is an empty object, it can't do anything that interacts with the environment. If the script's global object p550 is a Window p503 object, then in JavaScript, the ThisBinding of the global execution context for this script must be the Window p503 object's WindowProxy p510 object, rather than the global object. [ECMA262] p782 Note: This is a willful violation p18 of the JavaScript specification current at the time of writing (ECMAScript edition 5, as defined in section 10.4.1.1 Initial Global Execution Context, step 3). The JavaScript specification requires that the this keyword in the global scope return the global object, but this is not compatible with the security design prevalent in implementations as specified herein. [ECMA262] p782 A relationship with the script's browsing context A browsing context p499 that is assigned responsibility for actions taken by the script. When a script creates and navigates p520 a new top-level browsing context p499 , the opener p501 attribute of the new browsing context p499 's Window p503 object will be set to the script's browsing context p551 's WindowProxy p510 object. A relationship with the script's document A Document p33 that is assigned responsibility for actions taken by the script. When a script fetches p59 a resource, the current address p77 of the script's document p551 will be used to set the Referer (sic) header. A URL character encoding A character encoding, set when the script is created, used to encode URLs. If the character encoding is set from another source, e.g. a document's character encoding p81 , then the script's URL character encoding p551 must follow the source, so that if the source's changes, so does the script's. A base URL A URL p55 , set when the script is created, used to resolve relative URLs. If the base URL is set from another source, e.g. a document base URL p56 , then the script's base URL p551 must follow the source, so that if the source's changes, so does the script's.
7.1.3.2 Calling scripts When a user agent is to jump to a code entry-point for a script p550 , for example to invoke an event listener defined in that script p550 , the user agent must run the following steps: 1. If the script's global object p550 is a Window p503 object whose Document p33 object is not fully active p500 , then abort these steps without doing anything. The callback is not fired. Set the entry script p502 to be the script p550 being invoked. Make the script execution environment p550 for the script p550 execute the code for the given code entrypoint. Set the entry script p502 back to whatever it was when this algorithm started.
2. 3.
4.
7.1.3.3 Creating scripts When the specification says that a script p550 is to be created, given some script source, its scripting language, a global object, a browsing context, a URL character encoding, and a base URL, the user agent must run the following steps: 1. If scripting is disabled p550 for browsing context p499 passed to this algorithm, then abort these steps, as if the script did nothing but return void. Set up a script execution environment p550 as appropriate for the scripting language. Parse/compile/initialize the source of the script using the script execution environment p550 , as appropriate for the scripting language, and thus obtain the list of code entry-points p550 for the script. If the semantics of the scripting language and the given source code are such that there is executable code to be immediately run, then the initial code entry-point p550 is the entry-point for that code.
2. 3.
551
4.
Set up the script's global object p550 , the script's browsing context p551 , the script's document p551 , the script's URL character encoding p551 , and the script's base URL p551 from the settings passed to this algorithm. Jump p551 to the script p550 's initial code entry-point p550 .
5.
When the user agent is to create an impotent script, given some script source, its scripting language, and a browsing context, the user agent must create a script p551 , using the given script source and scripting language, using a new empty object as the global object, and using the given browsing context as the browsing context. The URL character encoding and base URL for the resulting script p550 are not important as no APIs are exposed to the script. When the specification says that a script p550 is to be created from a node node, given some script source and its scripting language, the user agent must create a script p551 , using the given script source and scripting language, and using the script settings determined from the node p552 node. The script settings determined from the node node are computed as follows: 1. 2. 3. 4. Let document be the Document p33 of node (or node itself if it is a Document p33 ). The browsing context is the browsing context p499 of document. The global object is the Window p503 object of document. The URL character encoding is the character encoding p81 of document. (This is a reference, not a copy p551 .) The base URL is the base URL p56 of document. (This is a reference, not a copy p551 .)
5.
7.1.3.4 Killing scripts User agents may impose resource limitations on scripts, for example CPU quotas, memory limits, total execution time limits, or bandwidth limitations. When a script exceeds a limit, the user agent may either throw a QUOTA_EXCEEDED_ERR p75 exception, abort the script without an exception, prompt the user, or throttle script execution. For example, the following script never terminates. A user agent could, after waiting for a few seconds, prompt the user to either terminate the script or let it continue. <script> while (true) { /* loop */ } </script> User agents are encouraged to allow users to disable scripting whenever the user is prompted either by a script (e.g. using the window.alert() p563 API) or because of a script's actions (e.g. because it has exceeded a time limit). If scripting is disabled while a script is executing, the script should be terminated immediately.
552
An event loop p552 has one or more task queues. A task queue p553 is an ordered list of tasks, which can be: Events Asynchronously dispatching an Event p33 object at a particular EventTarget p33 object is a task. Note: Not all events are dispatched using the task queue p553 , many are dispatched synchronously during other tasks. Parsing The HTML parser p620 tokenizing one or more bytes, and then processing any resulting tokens, is typically a task. Callbacks Calling a callback asynchronously is a task. Using a resource When an algorithm fetches p59 a resource, if the fetching occurs asynchronously then the processing of the resource once some or all of the resource is available is a task. Reacting to DOM manipulation Some elements have tasks that trigger in response to DOM manipulation, e.g. when that element is inserted into the document p29 . When a user agent is to queue a task, it must add the given task to one of the task queues p553 of the relevant event loop p552 . All the tasks from one particular task source (e.g. the callbacks generated by timers, the events dispatched for mouse movements, the tasks queued for the parser) must always be added to the same task queue p553 , but tasks from different task sources p553 may be placed in different task queues p553 . For example, a user agent could have one task queue p553 for mouse and key events (the user interaction task source p554 ), and another for everything else. The user agent could then give keyboard and mouse events preference over other tasks three quarters of the time, keeping the interface responsive but not starving other task queues, and never processing events from any one task source p553 out of order. Each task p553 that is queued p553 onto a task queue p553 of an event loop p552 defined by this specification is associated with a Document p33 ; if the task was queued in the context of an element, then it is the element's Document p33 ; if the task was queued in the context of a browsing context p499 , then it is the browsing context p499 's active document p499 at the time the task was queued; if the task was queued by or for a script p550 then the document is the script's document p551 . A user agent is required to have one storage mutex. This mutex is used to control access to shared state like cookies. At any one point, the storage mutex p553 is either free, or owned by a particular event loop p552 or instance of the fetching p59 algorithm. Whenever a script p550 calls into a plugin p29 , and whenever a plugin p29 calls into a script p550 , the user agent must release the storage mutex p553 .
7.1.4.2 Processing model An event loop p552 must continually run through the following steps for as long as it exists: 1. Run the oldest task p553 on one of the event loop p552 's task queues p553 , ignoring tasks whose associated Document p33 s are not fully active p500 . The user agent may pick any task queue p553 . If the storage mutex p553 is now owned by the event loop p552 , release it so that it is once again free. Remove that task from its task queue p553 . If any asynchronously-running algorithms are awaiting a stable state, then run their synchronous section and then resume running their asynchronous algorithm. Note: A synchronous section p553 never mutates the DOM, runs any script, or has any other side-effects. Note: Steps in synchronous sections p553 are marked with ?. 5. If necessary, update the rendering or user interface of any Document p33 or browsing context p499 to reflect the current state. Return to the first step of the event loop p552 .
2. 3. 4.
6.
553
When an algorithm says to spin the event loop until a condition goal is met, the user agent must run the following steps: 1. 2. Let task source be the task source p553 of the currently running task p553 . Stop the currently running task p553 , allowing the event loop p552 to resume, but continue these steps asynchronously. Note: This causes the event loop p552 to move on to the second step of its processing model (defined above). 3. 4. Wait until the condition goal is met. Queue a task p553 to continue running these steps, using the task source p553 task source. Wait until this task runs before continuing these steps. Return to the caller.
5.
Some of the algorithms in this specification, for historical reasons, require the user agent to pause while running a task p553 until a condition goal is met. This means running the following steps: 1. If any asynchronously-running algorithms are awaiting a stable state p553 , then run their synchronous section p553 and then resume running their asynchronous algorithm. (See the event loop p552 processing model definition above for details.) If necessary, update the rendering or user interface of any Document p33 or browsing context p499 to reflect the current state. Wait until the condition goal is met. While a user agent has a paused task p553 , the corresponding event loop p552 must not run further tasks p553 , and any script in the currently running task p553 must block. User agents should remain responsive to user input while paused, however, albeit in a reduced capacity since the event loop p552 will not be doing anything.
2.
3.
When a user agent is to obtain the storage mutex as part of running a task p553 , it must run through the following steps: 1. 2. 3. If the storage mutex p553 is already owned by this task p553 's event loop p552 , then abort these steps. Otherwise, pause p554 until the storage mutex p553 can be taken by the event loop p552 . Take ownership of the storage mutex p553 .
7.1.4.3 Generic task sources The following task sources p553 are used by a number of mostly unrelated features in this and other specifications. The DOM manipulation task source This task source p553 is used for features that react to DOM manipulations, such as things that happen asynchronously when an element is inserted into the document p29 . The user interaction task source This task source p553 is used for features that react to user interaction, for example keyboard or mouse input. Asynchronous events sent in response to user input (e.g. click p33 events) must be dispatched using tasks p553 queued p553 with the user interaction task source p554 . [DOMEVENTS] p782 The networking task source This task source p553 is used for features that trigger in response to network activity. The history traversal task source This task source p553 is used to queue calls to history.back() p515 and similar APIs.
2.
554
If a browsing context p499 is being navigated p520 to a javascript: URL, and the source browsing context p520 for that navigation, if any, has scripting disabled p550 Let result be void. If a browsing context p499 is being navigated p520 to a javascript: URL, and the active document p499 of that browsing context has the same origin p512 as the script given by that URL Let address be the address p77 of the active document p499 of the browsing context p499 being navigated. If address is about:blank p60 , and the browsing context p499 being navigated has a creator browsing context p499 , then let address be the address p77 of the creator Document p499 instead. Create a script p552 from the Document p33 node of the active document p499 , using the aforementioned script source, and assuming the scripting language is JavaScript. Let result be the return value of the initial code entry-point p550 of this script p550 . If an exception was raised, let result be void instead. (The result will be void also if scripting is disabled p550 .) When it comes time to set the document's address p523 in the navigation algorithm p520 , use address as the override URL p523 . If the Document p33 object of the element, attribute, or style sheet from which the javascript: URL was reached has an associated browsing context p499 Create an impotent script p552 using the aforementioned script source, with the scripting language set to JavaScript, and with the Document p33 's object's browsing context p499 as the browsing context. Let result be the return value of the initial code entry-point p550 of this script p550 . If an exception was raised, let result be void instead. (The result will be void also if scripting is disabled p550 .) Otherwise Let result be void. 3. If the result of executing the script is void (there is no return value), then the URL must be treated in a manner equivalent to an HTTP resource with an HTTP 204 No Content response. Otherwise, the URL must be treated in a manner equivalent to an HTTP resource with a 200 OK response whose Content-Type metadata p61 is text/html p757 and whose response body is the return value converted to a string value. Note: Certain contexts, in particular img p199 elements, ignore the Content-Type metadata p61 . So for example a javascript: URL for a src p200 attribute of an img p199 element would be evaluated in the context of an empty object as soon as the attribute is set; it would then be sniffed to determine the image type and decoded as an image. A javascript: URL in an href p440 attribute of an a p173 element would only be evaluated when the link was followed p441 . The src p214 attribute of an iframe p213 element would be evaluated in the context of the iframe p213 's own browsing context p499 ; once evaluated, its return value (if it was not void) would replace that browsing context p499 's document, thus changing the variables visible in that browsing context p499 .
7.1.6 Events
7.1.6.1 Event handlers Many objects can have event handlers specified. These act as bubbling event listeners for the object on which they are specified. An event handler p555 can either have the value null or be set to a Function p557 object. Initially, event handlers must be set to null. Event handlers are exposed in one or two ways. The first way, common to all event handlers, is as an event handler IDL attribute p556 . The second way is as an event handler content attribute p556 . Event handlers on HTML elements p28 and some of the event handlers on Window p503 objects are exposed in this way.
555
Event handler IDL attributes, on setting, must set the corresponding event handler to their new value, and on getting, must return whatever the current value of the corresponding event handler is (possibly null). If an event handler IDL attribute p556 exposes an event handler p555 of an object that doesn't exist, it must always return null on getting and must do nothing on setting. Note: This can happen in particular for event handler IDL attribute p556 on body p142 elements that do not have corresponding Window p503 objects. Note: Certain event handler IDL attributes have additional requirements, in particular the onmessage p611 attribute of MessagePort p610 objects.
Event handler content attributes, when specified, must contain valid JavaScript code matching the FunctionBody production. [ECMA262] p782 When an event handler content attribute p556 is set, if the element is owned by a Document p33 that is in a browsing context p499 , and scripting is enabled p550 for that browsing context p499 , the user agent must run the following steps to create a script p550 after setting the content attribute to its new value: 1. 2. Set up a script execution environment p550 for JavaScript. Using this script execution environment, create a function object (as defined in ECMAScript edition 5 section 13.2 Creating Function Objects), with: Parameter list FormalParameterList
p559 attribute of the Window p503 object If the attribute is the onerror Let the function have three arguments, named event, source, and fileno.
Otherwise Let the function have a single argument called event. Function body FunctionBody The event handler content attribute p556 's new value. Lexical Environment Scope 1. Let Scope be the result of NewObjectEnvironment(the element's Document p33 , the global environment). If the element has a form owner p407 , let Scope be the result of NewObjectEnvironment(the element's form owner p407 , Scope). Let Scope be the result of NewObjectEnvironment(the element's object, Scope).
2.
3.
Note: NewObjectEnvironment() is defined in ECMAScript edition 5 section 10.2.2.3 NewObjectEnvironment (O, E). [ECMA262] p782 Boolean flag Strict False. Let this new function be the only entry in the script's list of code entry-points p550 . 3. If the previous steps failed to compile the script, then set the corresponding event handler p555 to null and abort these steps. Set up the script's global object p550 , the script's browsing context p551 , the script's document p551 , the script's URL character encoding p551 , and the script's base URL p551 from the script settings determined from the node p552 on which the attribute is being set. Set the corresponding event handler p555 to the aforementioned function.
4.
5.
When an event handler content attribute is removed, the user agent must set the corresponding event handler p555 to null. Note: When an event handler content attribute p556 is set on an element owned by a Document p33 that is not in a browsing context p499 , the corresponding event handler is not changed.
All event handlers p555 on an object, whether an element or some other object, and whether set to null or to a Function p557 object, must be registered as event listeners on the object when it is created, as if the addEventListener() method on the object's EventTarget p33 interface had been invoked, with the event type (type argument) equal to the type corresponding to the event handler (the event handler event type), the
556
listener set to be a target and bubbling phase listener (useCapture argument set to false), and the event listener itself (listener argument) set to do nothing while the event handler's value is not a Function p557 object, and set to invoke the call() p557 callback of the Function p557 object associated with the event handler otherwise. Note: Event handlers p555 therefore always fire before event listeners attached using addEventListener(). Note: The listener argument is emphatically not the event handler p555 itself. Note: The interfaces implemented by the event object do not influence whether an event handler p555 is triggered or not. When an event handler p555 's Function p557 object is invoked, its call() p557 callback must be invoked with one argument, set to the Event p33 object of the event in question. The handler's return value must then be processed as follows: If the event type is mouseover If the return value is a boolean with the value true, then the event must be canceled.
p531 object If the event object is a BeforeUnloadEvent
If the return value is a string, and the event object's returnValue p531 attribute's value is the empty string, then set the returnValue p531 attribute's value to the return value. Otherwise If the return value is a boolean with the value false, then the event must be canceled. The Function p557 interface represents a function in the scripting language being used. It is represented in IDL as follows: [Callback=FunctionOnly, NoInterfaceObject] interface Function { any call(in any... arguments); }; The call(...) method is the object's callback. Note: In JavaScript, any Function object implements this interface. If the Function p557 object is a JavaScript Function, then when it is invoked by the user agent, the user agent must set the thisArg (as defined by ECMAScript edition 5 section 10.4.3 Entering Function Code) to the event handler p555 's object. [ECMA262] p782 For example, the following document fragment: <body onload="alert(this)" onclick="alert(this)"> ...leads to an alert saying "[object Window]" when the document is loaded, and an alert saying "[object HTMLBodyElement]" whenever the user clicks something in the page. The return value of the function affects whether the event is canceled or not: as described above, if the return value is false, the event is canceled (except for mouseover events, where the return value has to be true to cancel the event). With beforeunload events, the value is instead used to determine the message to show the user.
7.1.6.2 Event handlers on elements, Document p33 objects, and Window p503 objects The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported by all HTML elements p28 , as both content attributes and IDL attributes, and on Document p33 and Window p503 objects, as IDL attributes.
Event handler p555 onabort oncanplay oncanplaythrough onchange onclick oncontextmenu oncuechange Event handler event type p556 abort canplay p284 canplaythrough p284 change click p33 contextmenu cuechange
557
Event handler p555 ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onformchange onforminput oninput oninvalid onkeydown onkeypress onkeyup onloadeddata onloadedmetadata onloadstart onmousedown onmousemove onmouseout onmouseover onmouseup onmousewheel onpause onplay onplaying onprogress onratechange
Event handler event type p556 dblclick drag p595 dragend p595 dragenter p595 dragleave p595 dragover p595 dragstart p595 drop p595 durationchange p285 emptied p284 ended p284 formchange forminput input invalid keydown keypress keyup loadeddata p284 loadedmetadata p284 loadstart p283 mousedown mousemove mouseout mouseover mouseup mousewheel pause p284 play p284 playing p284 progress p284 ratechange p284
onreadystatechange readystatechange p82 onreset onseeked onseeking onselect onshow onstalled onsubmit onsuspend ontimeupdate onvolumechange onwaiting reset seeked p284 seeking p284 select show stalled p284 submit suspend p284 timeupdate p284 volumechange p285 waiting p284
The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported by all HTML elements p28 other than body p142 , as both content attributes and IDL attributes, and on Document p33 objects, as IDL attributes:
Event handler p555 Event handler event type p556 onblur onerror onfocus onload onscroll blur error focus load scroll
The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported by Window p503 objects, as IDL attributes on the Window p503 object, and with corresponding content attributes and IDL attributes exposed on the body p142 and frameset p747 elements:
558
Event handler p555 Event handler event type p556 onafterprint onbeforeprint onbeforeunload onblur onerror onfocus onhashchange onload onmessage onoffline ononline onpagehide onpageshow onpopstate onredo onresize onscroll onstorage onundo onunload afterprint beforeprint beforeunload blur error focus hashchange p529 load message p606 offline p549 online p549 pagehide p529 pageshow p529 popstate p529 redo p600 resize scroll storage undo p600 unload
Note: The onerror p559 handler is also used for reporting script errors p559 .
7.1.6.3 Event firing Certain operations and methods are defined as firing events on elements. For example, the click() p571 method on the HTMLElement p88 interface is defined as firing a click p33 event on the element. [DOMEVENTS] p782 Firing a simple event named e means that an event with the name e, which does not bubble (except where otherwise stated) and is not cancelable (except where otherwise stated), and which uses the Event p33 interface, must be dispatched at the given target. Firing a synthetic mouse event named e means that an event with the name e, which does not bubble (except where otherwise stated) and is not cancelable (except where otherwise stated), and which uses the MouseEvent interface, must be dispatched at the given target. The event object must have its screenX, screenY, clientX, clientY, and button attributes set to 0, its ctrlKey, shiftKey, altKey, and metaKey attributes set according to the current state of the key input device, if any (false for any keys that are not available), its detail attribute set to 1, and its relatedTarget attribute set to null. The getModifierState() method on the object must return values appropriately describing the state of the key input device at the time the event is created. Firing a click event means firing a synthetic mouse event named click p559 , which bubbles and is cancelable. The default action of these events is to do nothing except where otherwise stated.
7.1.6.4 Events and the Window p503 object When an event is dispatched at a DOM node in a Document p33 in a browsing context p499 , if the event is not a load event, the user agent must also dispatch the event to the Window p503 , as follows: 1. In the capture phase, the event must propagate to the Window p503 object before propagating to any of the nodes, as if the Window p503 object was the parent of the Document p33 in the dispatch chain. In the bubble phase, the event must propagate up to the Window p503 object at the end of the phase, unless bubbling has been prevented, again as if the Window p503 object was the parent of the Document p33 in the dispatch chain.
2.
7.1.6.5 Runtime script errors This section only applies to user agents that support scripting in general and JavaScript in particular. Whenever an uncaught runtime script error occurs in one of the scripts associated with a Document p33 , the user agent must report the error p560 using the onerror p559 event handler p555 of the script's global object p550 . If the error is still not handled p560 after this, then the error may be reported to the user.
559
When the user agent is required to report an error error using the event handler p555 onerror, it must run these steps, after which the error is either handled or not handled:
p557 If the value of onerror is a Function
The function must be invoked with three arguments. The three arguments passed to the function are all DOMStrings; the first must give the message that the UA is considering reporting, the second must give the absolute URL p56 of the resource in which the error occurred, and the third must give the line number in that resource on which the error occurred. If the function returns false, then the error is handled p560 . Otherwise, the error is not handled p560 . Any uncaught exceptions thrown or errors caused by this function may be reported to the user immediately after the error that the function was called for; the report an error p560 algorithm must not be used to handle exceptions thrown or errors caused by this function. Otherwise The error is not handled p560 .
7.2 Timers
The setTimeout() p560 and setInterval() p561 methods allow authors to schedule timer-based callbacks. [Supplemental, NoInterfaceObject] interface WindowTimers { long setTimeout(in any handler, in optional any timeout, in any... args); void clearTimeout(in long handle); long setInterval(in any handler, in optional any timeout, in any... args); void clearInterval(in long handle); }; Window implements WindowTimers; This box is non-normative. Implementation requirements are given below this box. handle = window . setTimeout p560 ( handler [, timeout [, arguments ] ] ) Schedules a timeout to run handler after timeout milliseconds. Any arguments are passed straight through to the handler. handle = window . setTimeout p560 ( code [, timeout ] ) Schedules a timeout to compile and run code after timeout milliseconds. window . clearTimeout p561 ( handle ) Cancels the timeout set with setTimeout() p560 identified by handle. handle = window . setInterval p561 ( handler [, timeout [, arguments ] ] ) Schedules a timeout to run handler every timeout milliseconds. Any arguments are passed straight through to the handler. handle = window . setInterval p561 ( code [, timeout ] ) Schedules a timeout to compile and run code every timeout milliseconds. window . clearInterval p562 ( handle ) Cancels the timeout set with setInterval() p561 identified by handle.
Note: This API does not guarantee that timers will fire exactly on schedule. Delays due to CPU load, other tasks, etc, are to be expected. Note: The WindowTimers p560 interface adds to the Window p503 interface and the WorkerUtils interface (part of Web Workers). Each object that implements the WindowTimers p560 interface has a list of active timeouts and a list of active intervals. Each entry in these lists is identified by a number, which must be unique within its list for the lifetime of the object that implements the WindowTimers p560 interface. The setTimeout() method must run the following steps:
560
1.
Let handle be a user-agent-defined integer that is greater than zero that will identify the timeout to be set by this call. Add an entry to the list of active timeouts p560 for handle. Get the timed task p562 handle in the list of active timeouts p560 , and let task be the result. Get the timeout p562 , and let timeout be the result. If the currently running task p553 is a task that was created by the setTimeout() p560 method, and timeout is less than 4, then increase timeout to 4. Return handle, and then continue running this algorithm asynchronously. If the method context p562 is a Window p503 object, wait until the Document p33 associated with the method context p562 has been fully active p500 for a further timeout milliseconds (not necessarily consecutively). Otherwise, if the method context p562 is a WorkerUtils object, wait until timeout milliseconds have passed with the worker not suspended (not necessarily consecutively). Otherwise, act as described in the specification that defines that the WindowTimers p560 interface is implemented by some other object.
2. 3. 4. 5.
6. 7.
8.
Wait until any invocations of this algorithm started before this one whose timeout is equal to or less than this one's have completed. Optionally, wait a further user-agent defined length of time. Note: This is intended to allow user agents to pad timeouts as needed to optimise the power usage of the device. For example, some processors have a low-power mode where the granularity of timers is reduced; on such platforms, user agents can slow timers down to fit this schedule instead of requiring the processor to use the more accurate mode with its associated higher power usage.
9.
10.
The clearTimeout() method must clear the entry identified as handle from the list of active timeouts p560 of the WindowTimers p560 object on which the method was invoked, where handle is the argument passed to the method, if any. (If handle does not identify an entry in the list of active timeouts p560 of the WindowTimers p560 object on which the method was invoked, the method does nothing.) The setInterval() method must run the following steps: 1. Let handle be a user-agent-defined integer that is greater than zero that will identify the interval to be set by this call. Add an entry to the list of active intervals p560 for handle. Get the timed task p562 handle in the list of active intervals p560 , and let task be the result. Get the timeout p562 , and let timeout be the result. If timeout is less than 10, then increase timeout to 10. Return handle, and then continue running this algorithm asynchronously. Wait: If the method context p562 is a Window p503 object, wait until the Document p33 associated with the method context p562 has been fully active p500 for a further interval milliseconds (not necessarily consecutively). Otherwise, if the method context p562 is a WorkerUtils object, wait until interval milliseconds have passed with the worker not suspended (not necessarily consecutively). Otherwise, act as described in the specification that defines that the WindowTimers p560 interface is implemented by some other object. 8. Optionally, wait a further user-agent defined length of time. Note: This is intended to allow user agents to pad timeouts as needed to optimise the power usage of the device. For example, some processors have a low-power mode where the granularity of timers is reduced; on such platforms, user agents can slow timers down to fit this schedule instead of requiring the processor to use the more accurate mode with its associated higher power usage.
2. 3. 4. 5. 6. 7.
561
9. 10.
Queue p553 the task task p553 . Return to the step labeled wait.
The clearInterval() method must clear the entry identified as handle from the list of active intervals p560 of the WindowTimers p560 object on which the method was invoked, where handle is the argument passed to the method, if any. (If handle does not identify an entry in the list of active intervals p560 of the WindowTimers p560 object on which the method was invoked, the method does nothing.) The method context, when referenced by the algorithms in this section, is the object on which the method for which the algorithm is running is implemented (a Window p503 or WorkerUtils object). When the above methods are invoked and try to get the timed task handle in list list, they must run the following steps: 1. If the first argument to the invoked method is an object that has an internal [[Call]] method, then return a task p553 that checks if the entry for handle in list has been cleared, and if it has not, calls the aforementioned [[Call]] method with as its arguments the third and subsequent arguments to the invoked method (if any), and abort these steps. Otherwise, continue with the remaining steps. 2. Apply the ToString() abstract operation to the first argument to the method, and let script source be the result. [ECMA262] p782 Let script language be JavaScript. If the method context p562 is a Window p503 object, let global object be the method context p562 , let browsing context be the browsing context p499 with which global object is associated, let character encoding be the character encoding p81 of the Document p33 associated with global object (this is a reference, not a copy p551 ), and let base URL be the base URL p56 of the Document p33 associated with global object (this is a reference, not a copy p551 ). Otherwise, if the method context p562 is a WorkerUtils object, let global object, browsing context, document, character encoding, and base URL be the script's global object p550 , script's browsing context p551 , script's document p551 , script's URL character encoding p551 , and script's base URL p551 (respectively) of the script p550 that the run a worker algorithm created when it created the method context p562 . Otherwise, act as described in the specification that defines that the WindowTimers p560 interface is implemented by some other object. 5. Return a task p553 that checks if the entry for handle in list has been cleared, and if it has not, creates a script p551 using script source as the script source, scripting language as the scripting language, global object as the global object, browsing context as the browsing context, document as the document, character encoding as the URL character encoding, and base URL as the base URL.
3. 4.
When the above methods are to get the timeout, they must run the following steps: 1. 2. 3. 4. 5. 6. Let timeout be the second argument to the method, or zero if the argument was omitted. Apply the ToString() abstract operation to timeout, and let timeout be the result. [ECMA262] p782 Apply the ToNumber() abstract operation to timeout, and let timeout be the result. [ECMA262] p782 If timeout is an Infinity value, a Not-a-Number (NaN) value, or negative, let timeout be zero. Round timeout down to the nearest integer, and let timeout be the result. Return timeout.
The task source p553 for these tasks p553 is the timer task source.
562
window . alert p563 (message) Displays a modal alert with the given message, and waits for the user to dismiss it. A call to the navigator.yieldForStorageUpdates() p570 method is implied when this method is invoked. result = window . confirm p563 (message) Displays a modal OK/Cancel prompt with the given message, waits for the user to dismiss it, and returns true if the user clicks OK and false if the user clicks Cancel. A call to the navigator.yieldForStorageUpdates() p570 method is implied when this method is invoked. result = window . prompt p563 (message [, default] ) Displays a modal text field prompt with the given message, waits for the user to dismiss it, and returns the value that the user entered. If the user cancels the prompt, then returns null instead. If the second argument is present, then the given value is used as a default. A call to the navigator.yieldForStorageUpdates() p570 method is implied when this method is invoked.
The alert(message) method, when invoked, must release the storage mutex p553 and show the given message to the user. The user agent may make the method wait for the user to acknowledge the message before returning; if so, the user agent must pause p554 while the method is waiting. The confirm(message) method, when invoked, must release the storage mutex p553 and show the given message to the user, and ask the user to respond with a positive or negative response. The user agent must then pause p554 as the method waits for the user's response. If the user responds positively, the method must return true, and if the user responds negatively, the method must return false. The prompt(message, default) method, when invoked, must release the storage mutex p553 , show the given message to the user, and ask the user to either respond with a string value or abort. The user agent must then pause p554 as the method waits for the user's response. The second argument is optional. If the second argument (default) is present, then the response must be defaulted to the value given by default. If the user aborts, then the method must return null; otherwise, the method must return the string that the user responded with.
7.3.2 Printing
This box is non-normative. Implementation requirements are given below this box. window . print
p563
()
Prompts the user to print the page. A call to the navigator.yieldForStorageUpdates() p570 method is implied when this method is invoked.
The print() method, when invoked, must run the printing steps p563 . User agents should also run the printing steps p563 whenever the user asks for the opportunity to obtain a physical form p738 (e.g. printed copy), or the representation of a physical form (e.g. PDF copy), of a document. The printing steps are as follows: 1. The user agent may display a message to the user and/or may abort these steps. For instance, a kiosk browser could silently ignore any invocations of the print() p563 method. For instance, a browser on a mobile device could detect that there are no printers in the vicinity and display a message saying so before continuing to offer a "save to PDF" option. 2. The user agent must fire a simple event p559 named beforeprint at the Window p503 object of the Document p33 that is being printed, as well as any nested browsing contexts p499 in it. The beforeprint event can be used to annotate the printed copy, for instance adding the time at which the document was printed. 3. The user agent must release the storage mutex p553 .
563
4.
The user agent should offer the user the opportunity to obtain a physical form p738 (or the representation of a physical form) of the document. The user agent may wait for the user to either accept or decline before returning; if so, the user agent must pause p554 while the method is waiting. Even if the user agent doesn't wait at this point, the user agent must use the state of the relevant documents as they are at this point in the algorithm if and when it eventually creates the alternate form. The user agent must fire a simple event p559 named afterprint at the Window p503 object of the Document p33 that is being printed, as well as any nested browsing contexts p499 in it. The afterprint event can be used to revert annotations added in the earlier event, as well as showing post-printing UI. For instance, if a page is walking the user through the steps of applying for a home loan, the script could automatically advance to the next step after having printed a form or other.
5.
The showModalDialog(url, argument) method, when invoked, must cause the user agent to run the following steps: 1. Resolve p55 url relative to the entry script p502 's base URL p551 . If this fails, then throw a SYNTAX_ERR p75 exception and abort these steps. 2. 3. Release the storage mutex p553 . If the user agent is configured such that this invocation of showModalDialog() p564 is somehow disabled, then return the empty string and abort these steps. Note: User agents are expected to disable this method in certain cases to avoid user annoyance (e.g. as part of their popup blocker feature). For instance, a user agent could require that a site be white-listed before enabling this method, or the user agent could be configured to only allow one modal dialog at a time. 4. Let the list of background browsing contexts be a list of all the browsing contexts that: are part of the same unit of related browsing contexts p501 as the browsing context of the Window p503 object on which the showModalDialog() p564 method was called, and that have an active document p499 whose origin p510 is the same p512 as the origin p510 of the script p550 that called the showModalDialog() p564 method at the time the method was called,
...as well as any browsing contexts that are nested inside any of the browsing contexts matching those conditions. 5. Disable the user interface for all the browsing contexts in the list of background browsing contexts. This should prevent the user from navigating those browsing contexts, causing events to be sent to those browsing context, or editing any content in those browsing contexts. However, it does not prevent those browsing contexts from receiving events from sources other than the user, from running scripts, from running animations, and so forth. Create a new auxiliary browsing context p501 , with the opener browsing context p501 being the browsing context of the Window p503 object on which the showModalDialog() p564 method was called. The new auxiliary browsing context has no name. Note: This browsing context p499 's Document p33 s' Window p503 objects all implement the WindowModal p565 interface. 7. Let the dialog arguments p565 of the new browsing context be set to the value of argument, or the 'undefined' value if the argument was omitted. Let the dialog arguments' origin p565 be the origin p510 of the script p550 that called the showModalDialog() p564 method.
6.
8.
564
9.
Navigate p520 the new browsing context p499 to the absolute URL p56 that resulted from resolving p55 url earlier, with replacement enabled p528 , and with the browsing context p551 of the script p550 that invoked the method as the source browsing context p520 . Spin the event loop p554 until the new browsing context p499 is closed. (The user agent must allow the user to indicate that the browsing context p499 is to be closed.) Reenable the user interface for all the browsing contexts in the list of background browsing contexts. Return the auxiliary browsing context p501 's return value p565 .
10.
11. 12.
The Window p503 objects of Document p33 s hosted by browsing contexts p499 created by the above algorithm must all have the WindowModal p565 interface added to their Window p503 interface: [Supplemental, NoInterfaceObject] interface WindowModal { readonly attribute any dialogArguments; attribute DOMString returnValue; }; This box is non-normative. Implementation requirements are given below this box. window . dialogArguments p565 Returns the argument argument that was passed to the showModalDialog() p564 method. window . returnValue p565 [ = value ] Returns the current return value for the window. Can be set, to change the value that will be returned by the showModalDialog() p564 method.
Such browsing contexts have associated dialog arguments, which are stored along with the dialog arguments' origin. These values are set by the showModalDialog() p564 method in the algorithm above, when the browsing context is created, based on the arguments provided to the method. The dialogArguments IDL attribute, on getting, must check whether its browsing context's active document p499 's origin p510 is the same p512 as the dialog arguments' origin p565 . If it is, then the browsing context's dialog arguments p565 must be returned unchanged. Otherwise, if the dialog arguments p565 are an object, then the empty string must be returned, and if the dialog arguments p565 are not an object, then the stringification of the dialog arguments p565 must be returned. These browsing contexts also have an associated return value. The return value p565 of a browsing context must be initialized to the empty string when the browsing context is created. The returnValue IDL attribute, on getting, must return the return value p565 of its browsing context, and on setting, must set the return value p565 to the given new value. Note: The window.close() p507 method can be used to close the browsing context.
565
[Supplemental, NoInterfaceObject] interface NavigatorOnLine { readonly attribute boolean onLine; }; [Supplemental, NoInterfaceObject] interface NavigatorAbilities { // content handler registration void registerProtocolHandler(in DOMString scheme, in DOMString url, in DOMString title); void registerContentHandler(in DOMString mimeType, in DOMString url, in DOMString title); void yieldForStorageUpdates(); }; These interfaces are defined separately so that other specifications can re-use parts of the Navigator p565 interface.
. appName p566
Returns the name of the browser. window . navigator p565 . appVersion p566 Returns the version of the browser. window . navigator p565 . platform p566 Returns the name of the platform. window . navigator p565 . userAgent p566 Returns the complete User-Agent header.
appName Must return either the string "Netscape" or the full name of the browser, e.g. "Mellblom Browsernator". appVersion Must return either the string "4.0" or a string representing the version of the browser in detail, e.g. "1.0 (VMS; en-US) Mellblomenator/9000". platform Must return either the empty string or a string representing the platform on which the browser is executing, e.g. "MacIntel", "Win32", "FreeBSD i386", "WebTV OS". userAgent Must return the string used for the value of the "User-Agent" header in HTTP requests, or the empty string if no such header is ever sent. Warning! Any information in this API that varies from user to user can be used to profile the user. In fact, if enough such information is available, a user can actually be uniquely identified. For this reason, user agent implementors are strongly urged to include as little information in this API as possible.
566
User agents may, within the constraints described in this section, do whatever they like when the methods are called. A UA could, for instance, prompt the user and offer the user the opportunity to add the site to a shortlist of handlers, or make the handlers his default, or cancel the request. UAs could provide such a UI through modal UI or through a non-modal transient notification interface. UAs could also simply silently collect the information, providing it only when relevant to the user. User agents should keep track of which sites have registered handlers (even if the user has declined such registrations) so that the user is not repeatedly prompted with the same request. The arguments to the methods have the following meanings and corresponding implementation requirements: protocol (registerProtocolHandler() p567 only) A scheme, such as ftp or sms. The scheme must be compared in an ASCII case-insensitive p36 manner by user agents for the purposes of comparing with the scheme part of URLs that they consider against the list of registered handlers. The scheme value, if it contains a colon (as in "ftp:"), will never match anything, since schemes don't contain colons. Note: This feature is not intended to be used with non-standard protocols. mimeType (registerContentHandler() p567 only) A MIME type p28 , such as model/vnd.flatland.3dml or application/vnd.google-earth.kml+xml. The MIME type p28 must be compared in an ASCII case-insensitive p36 manner by user agents for the purposes of comparing with MIME types of documents that they consider against the list of registered handlers. User agents must compare the given values only to the MIME type/subtype parts of content types, not to the complete type including parameters. Thus, if mimeType values passed to this method include characters such as commas or whitespace, or include MIME parameters, then the handler being registered will never be used. Note: The type is compared to the MIME type p28 used by the user agent after the sniffing algorithms have been applied. url A string used to build the URL p55 of the page that will handle the requests. When the user agent uses this URL, it must replace the first occurrence of the exact literal string "%s" with an escaped version of the absolute URL p56 of the content in question (as defined below), then resolve p55 the resulting URL, relative to the base URL p551 of the entry script p502 at the time the registerContentHandler() p567 or registerProtocolHandler() p567 methods were invoked, and then navigate p520 an appropriate browsing context p499 to the resulting URL using the GET method (or equivalent p61 for non-HTTP URLs).
567
To get the escaped version of the absolute URL p56 of the content in question, the user agent must replace every character in that absolute URL p56 that doesn't match the <query> production defined in RFC 3986 by the percent-encoded form of that character. [RFC3986] p784 If the user had visited a site at http://example.com/ that made the following call: navigator.registerContentHandler('application/x-soup', 'soup?url=%s', 'SoupWeb') ...and then, much later, while visiting http://www.example.net/, clicked on a link such as: <a href="chickenkwi.soup">Download our Chicken Kwi soup!</a> ...then, assuming this chickenkwi.soup file was served with the MIME type p28 application/x-soup, the UA might navigate to the following URL: http://example.com/soup?url=http://www.example.net/chickenk%C3%AFwi.soup This site could then fetch the chickenkwi.soup file and do whatever it is that it does with soup (synthesize it and ship it to the user, or whatever). title A descriptive title of the handler, which the UA might use to remind the user what the site in question is. User agents should raise SECURITY_ERR p75 exceptions if the methods are called with scheme or mimeType values that the UA deems to be "privileged". For example, a site attempting to register a handler for http URLs or text/ html p757 content in a Web browser would likely cause an exception to be raised. User agents must raise a SYNTAX_ERR p75 exception if the url argument passed to one of these methods does not contain the exact literal string "%s", or if resolving p55 the url argument with the first occurrence of the string "%s" removed, relative to the entry script p502 's base URL p551 , is not successful. User agents must not raise any other exceptions (other than binding-specific exceptions, such as for an incorrect number of arguments in an JavaScript implementation). This section does not define how the pages registered by these methods are used, beyond the requirements on how to process the url value (see above). To some extent, the processing model for navigating across documents p520 defines some cases where these methods are relevant, but in general UAs may use this information wherever they would otherwise consider handing content to native plugins or helper applications. UAs must not use registered content handlers to handle content that was returned as part of a non-GET transaction (or rather, as part of any non-idempotent transaction), as the remote site would not be able to fetch the same data.
7.4.2.1 Security and privacy These mechanisms can introduce a number of concerns, in particular privacy concerns. Hijacking all Web usage. User agents should not allow schemes that are key to its normal operation, such as http or https, to be rerouted through third-party sites. This would allow a user's activities to be trivially tracked, and would allow user information, even in secure connections, to be collected. Hijacking defaults. It is strongly recommended that user agents do not automatically change any defaults, as this could lead the user to send data to remote hosts that the user is not expecting. New handlers registering themselves should never automatically cause those sites to be used. Registration spamming. User agents should consider the possibility that a site will attempt to register a large number of handlers, possibly from multiple domains (e.g. by redirecting through a series of pages each on a different domain, and each registering a handler for video/mpeg analogous practices abusing other Web browser features have been used by pornography Web sites for many years). User agents should gracefully handle such hostile attempts, protecting the user. Misleading titles. User agents should not rely wholly on the title argument to the methods when presenting the registered handlers to the user, since sites could easily lie. For example, a site hostile.example.net could claim that it was registering the "Cuddly Bear Happy Content Handler". User agents should therefore use the handler's domain in any UI along with any title. Hostile handler metadata. User agents should protect against typical attacks against strings embedded in their interface, for example ensuring that markup or escape characters in such strings are not executed, that null bytes are properly handled, that over-long strings do not cause crashes or buffer overruns, and so forth. Leaking Intranet URLs. The mechanism described in this section can result in secret Intranet URLs being leaked, in the following manner: 1. 2. The user registers a third-party content handler as the default handler for a content type. The user then browses his corporate Intranet site and accesses a document that uses that content type.
568
3.
The user agent contacts the third party and hands the third party the URL to the Intranet content.
No actual confidential file data is leaked in this manner, but the URLs themselves could contain confidential information. For example, the URL could be http://www.corp.example.com/upcoming-aquisitions/thesample-company.egf, which might tell the third party that Example Corporation is intending to merge with The Sample Company. Implementors might wish to consider allowing administrators to disable this feature for certain subdomains, content types, or schemes. Leaking secure URLs. User agents should not send HTTPS URLs to third-party sites registered as content handlers, in the same way that user agents do not send Referer (sic) HTTP headers from secure sites to thirdparty sites. Leaking credentials. User agents must never send username or password information in the URLs that are escaped and included sent to the handler sites. User agents may even avoid attempting to pass to Web-based handlers the URLs of resources that are known to require authentication to access, as such sites would be unable to access the resources in question without prompting the user for credentials themselves (a practice that would require the user to know whether to trust the third-party handler, a decision many users are unable to make or even understand).
7.4.2.2 Sample user interface This section is non-normative. A simple implementation of this feature for a desktop Web browser might work as follows. The registerContentHandler() p567 method could display a modal dialog box:
In this dialog box, "Kittens at work" is the title of the page that invoked the method, "http://kittens.example.org/" is the URL of that page, "application/x-meowmeow" is the string that was passed to the registerContentHandler() p567 method as its first argument (mimeType), "http://kittens.example.org/?show=%s" was the second argument (url), and "Kittens-at-work displayer" was the third argument (title). If the user clicks the Cancel button, then nothing further happens. If the user clicks the "Trust" button, then the handler is remembered. When the user then attempts to fetch a URL that uses the "application/x-meowmeow" MIME type p28 , then it might display a dialog as follows:
569
In this dialog, the third option is the one that was primed by the site registering itself earlier. If the user does select that option, then the browser, in accordance with the requirements described in the previous two sections, will redirect the user to "http://kittens.example.org/?show=data%3Aapplication/xmeowmeow;base64,S2l0dGVucyBhcmUgdGhlIGN1dGVzdCE%253D". The registerProtocolHandler() p567 method would work equivalently, but for schemes instead of unknown content types.
. yieldForStorageUpdates p570 ()
If a script uses the document.cookie p80 API, or the localStorage API, the browser will block other scripts from accessing cookies or storage until the first script finishes. [WEBSTORAGE] p785 Calling the navigator.yieldForStorageUpdates() p570 method tells the user agent to unblock any other scripts that may be blocked, even though the script hasn't returned. Values of cookies and items in the Storage objects of localStorage attributes can change after calling this method, whence its name. [WEBSTORAGE] p785
The yieldForStorageUpdates() method, when invoked, must, if the storage mutex p553 is owned by the event loop p552 of the task p553 that resulted in the method being called, release the storage mutex p553 so that it is once again free. Otherwise, it must do nothing.
570
8 User interaction
8.1 The hidden attribute
All HTML elements p28 may have the hidden p571 content attribute set. The hidden p571 attribute is a boolean attribute p38 . When specified on an element, it indicates that the element is not yet, or is no longer, relevant. User agents should not render elements that have the hidden p571 attribute specified. In the following skeletal example, the attribute is used to hide the Web game's main screen until the user logs in: <h1>The Example Game</h1> <section id="login"> <h2>Login</h2> <form> ... <!-- calls login() once the user's credentials have been checked --> </form> <script> function login() { // switch screens document.getElementById('login').hidden = true; document.getElementById('game').hidden = false; } </script> </section> <section id="game" hidden> ... </section> The hidden p571 attribute must not be used to hide content that could legitimately be shown in another presentation. For example, it is incorrect to use hidden p571 to hide panels in a tabbed dialog, because the tabbed interface is merely a kind of overflow presentation one could equally well just show all the form controls in one big page with a scrollbar. It is similarly incorrect to use this attribute to hide content just from one presentation if something is marked hidden p571 , it is hidden from all presentations, including, for instance, screen readers. Elements that are not hidden p571 should not link to or refer to elements that are hidden p571 . For example, it would be incorrect to use the href p440 attribute to link to a section marked with the hidden p571 attribute. If the content is not applicable or relevant, then there is no reason to link to it. It would similarly be incorrect to use the ARIA aria-describedby attribute to refer to descriptions that are themselves hidden p571 . Hiding a section means that it is not applicable or relevant to anyone at the current time, so clearly it cannot be a valid description of content the user can interact with. Elements in a section hidden by the hidden p571 attribute are still active, e.g. scripts and form controls in such sections still execute and submit respectively. Only their presentation to the user changes. The hidden IDL attribute must reflect p62 the content attribute of the same name.
8.2 Activation
This box is non-normative. Implementation requirements are given below this box. element . click
p571
()
Each element has a click in progress flag, initially set to false. The click() method must run these steps: 1. 2. 3. If the element's click in progress flag is set to true, then abort these steps. Set the click in progress flag on the element to true. If the element has a defined activation behavior p102 , run synthetic click activation steps p101 on the element. Otherwise, fire a click event p559 at the element. Set the click in progress flag on the element to false.
4.
571
8.3 Focus
When an element is focused, key events received by the document must be targeted at that element. There may be no element focused; when no element is focused, key events received by the document must be targeted at the body element p83 . User agents may track focus for each browsing context p499 or Document p33 individually, or may support only one focused element per top-level browsing context p499 user agents should follow platform conventions in this regard. Which elements within a top-level browsing context p499 currently have focus must be independent of whether or not the top-level browsing context p499 itself has the system focus. Note: When an element is focused, the element matches the CSS :focus pseudo-class.
An element is specially focusable if the tabindex p572 attribute's definition above defines the element to be focusable. An element that is specially focusable p572 but does not otherwise have an activation behavior p102 defined has an activation behavior p102 that does nothing.
572
Note: This means that an element that is only focusable because of its tabindex p572 attribute will fire a click p33 event in response to a non-mouse activation (e.g. hitting the "enter" key while the element is focused). The tabIndex IDL attribute must reflect p62 the value of the tabindex p572 content attribute. Its default value is 0 for elements that are focusable and 1 for elements that are not focusable.
In addition, each shape that is generated for an area p314 element should be focusable p573 , unless platform conventions dictate otherwise. (A single area p314 element can correspond to multiple shapes, since image maps can be reused with multiple images on a page.) The user agent may also make part of a details p423 element's rendering focusable, to enable the element to be opened or closed using keyboard input. However, this is distinct from the details p423 or summary p426 element being focusable. The focusing steps are as follows: 1. If the element is not in a Document p29 , or if the element's Document p33 has no browsing context p499 , or if the element's Document p33 ' browsing context p499 has no top-level browsing context p499 , then abort these steps. If focusing the element will remove the focus from another element, then run the unfocusing steps p573 for that element. Make the element the currently focused element in its top-level browsing context p499 . Some elements, most notably area p314 , can correspond to more than one distinct focusable area. If a particular area was indicated when the element was focused, then that is the area that must get focus; otherwise, e.g. when using the focus() p575 method, the first such region in tree order is the one that must be focused. 4. Fire a simple event p559 named focus at the element.
2.
3.
User agents must synchronously run the focusing steps p573 for an element whenever the user moves the focus to a focusable p573 element. The unfocusing steps are as follows: 1. If the element is an input p353 element, and the change p385 event applies to the element, and the element does not have a defined activation behavior p102 , and the user has changed the element's value p409 or its list of selected files p372 while the control was focused without committing that change, then fire a simple event p559 that bubbles named change at the element, then broadcast formchange events p423 at the element's form owner p407 . Unfocus the element.
2.
573
3.
When an element that is focused stops being a focusable p573 element, or stops being focused without another element being explicitly focused in its stead, the user agent should synchronously run the focusing steps p573 for the body element p83 , if there is one; if there is not, then the user agent should synchronously run the unfocusing steps p573 for the affected element only. For example, this might happen because the element is removed from its Document p33 , or has a hidden p571 attribute added. It would also happen to an input p353 element when the element gets disabled p409 .
The activeElement attribute on HTMLDocument p77 objects must return the element in the document that is focused. If no element in the Document p33 is focused, this must return the body element p83 . The hasFocus() method on HTMLDocument p77 objects must return true if the Document p33 's browsing context p499 is focused, and all its ancestor browsing contexts p499 are also focused, and the top-level browsing context p499 has the system focus. If the Document p33 has no browsing context p499 or if its browsing context p499 has no top-level browsing context p499 , then the method will always return false. The focus() method on the Window p503 object, when invoked, provides a hint to the user agent that the script believes the user might be interested in the contents of the browsing context p499 of the Window p503 object on which the method was invoked. User agents are encouraged to have this focus() p574 method trigger some kind of notification. The blur() method on the Window p503 object, when invoked, provides a hint to the user agent that the script believes the user probably is not currently interested in the contents of the browsing context p499 of the Window p503 object on which the method was invoked, but that the contents might become interesting again in the future. User agents are encouraged to ignore calls to this blur() p574 method entirely. Note: Historically the focus() p574 and blur() p574 methods actually affected the system focus, but hostile sites widely abuse this behavior to the user's detriment.
()
Focuses the element. element . blur p575 () Unfocuses the element. Use of this method is discouraged. Focus another element instead. Do not use this method to hide the focus ring if you find the focus ring unsightly. Instead, use a CSS rule to override the 'outline' property. For example, to hide the outline from links, you could use:
574
The focus() method, when invoked, must run the following algorithm: 1. 2. 3. 4. 5. If the element is marked as locked for focus p575 , then abort these steps. If the element is not focusable p573 , then abort these steps. Mark the element as locked for focus. If the element is not already focused, run the focusing steps p573 for the element. Unmark the element as locked for focus p575 .
The blur() method, when invoked, should run the focusing steps p573 for the body element p83 , if there is one; if there is not, then it should run the unfocusing steps p573 for the element on which the method was called instead. User agents may selectively or uniformly ignore calls to this method for usability reasons. For example, if the blur() p575 method is unwisely being used to remove the focus ring for aesthetics reasons, the page would become unusable by keyboard users. Ignoring calls to this method would thus allow keyboard users to interact with the page.
575
In the following example, the search field is given two possible access keys, "s" and "0" (in that order). A user agent on a device with a full keyboard might pick Ctrl+Alt+S as the shortcut key, while a user agent on a small device with just a numeric keypad might pick just the plain unadorned key 0: <form action="/search"> <label>Search: <input type="search" name="q" accesskey="s 0"></label> <input type="submit"> </form> In the following example, a button has possible access keys described. A script then tries to update the button's label to advertise the key combination the user agent selected. <input type=submit accesskey="N @ 1" value="Compose"> ... <script> function labelButton(button) { if (button.accessKeyLabel) button.value += ' (' + button.accessKeyLabel + ')'; } var inputs = document.getElementsByTagName('input'); for (var i = 0; i < inputs.length; i += 1) { if (inputs[i].type == "submit") labelButton(inputs[i]); } </script> On one user agent, the button's label might become "Compose (N)". On another, it might become "Compose (Alt++1)". If the user agent doesn't assign a key, it will be just "Compose". The exact string depends on what the assigned access key p576 is, and on how the user agent represents that key combination.
3.
2.
3.
4.
Fallback: Optionally, the user agent may assign a key combination of its choosing as the element's assigned access key p576 and then abort these steps. If this step is reached, the element has no assigned access key p576 .
5.
Once a user agent has selected and assigned an access key for an element, the user agent should not change the element's assigned access key p576 unless the accesskey p575 content attribute is changed or the element is moved to another Document p33 . When the user presses the key combination corresponding to the assigned access key p576 for an element, if the element defines a command p432 , and the command's Hidden State p432 facet is false (visible), and the command's Disabled State p432 facet is also false (enabled), then the user agent must trigger the Action p432 of the command. User agents may expose elements that have an accesskey p575 attribute in other ways as well, e.g. in a menu displayed in response to a specific key combination. The accessKey IDL attribute must reflect p62 the accesskey p575 content attribute.
576
The accessKeyLabel IDL attribute must return a string that represents the element's assigned access key p576 , if any. If the element does not have one, then the IDL attribute must return the empty string.
The contentEditable IDL attribute, on getting, must return the string "true" if the content attribute is set to the true state, "false" if the content attribute is set to the false state, and "inherit" otherwise. On setting, if the new value is an ASCII case-insensitive p36 match for the string "inherit" then the content attribute must be removed, if the new value is an ASCII case-insensitive p36 match for the string "true" then the content attribute must be set to the string "true", if the new value is an ASCII case-insensitive p36 match for the string "false" then the content attribute must be set to the string "false", and otherwise the attribute setter must raise a SYNTAX_ERR p75 exception. The isContentEditable IDL attribute, on getting, must return true if the element is editable p577 , and false otherwise. If an element is editable p577 and its parent element is not, or if an element is editable p577 and it has no parent element, then the element is an editing host. Editable elements can be nested. Editing hosts are typically focusable and typically form part of the tab order p572 . An editing host can contain non-editable sections, these are handled as described below. An editing host can contain non-editable sections that contain further editing hosts. When an editing host has focus, it must have a caret position that specifies where the current editing position is. It may also have a selection. Note: How the caret and selection are represented depends entirely on the UA.
577
Change the selection User agents must allow users to change the selection within an editing host, even into nested editable elements. User agents may prevent selections from being made in ways that cross from editable elements into non-editable elements (e.g. by making each non-editable descendant atomically selectable, but not allowing text selection within them). This could be triggered as the default action of keydown events with various key identifiers and as the default action of mousedown events. Insert text This action must be triggered as the default action of a textInput event, and may be triggered by other commands as well. It must cause the user agent to insert the specified text (given by the event object's data attribute in the case of the textInput event) at the caret. If the caret is positioned somewhere where phrasing content p100 is not allowed (e.g. inside an empty ol p164 element), then the user agent must not insert the text directly at the caret position. In such cases the behavior is UA-dependent, but user agents must not, in response to a request to insert text, generate a DOM that is less conformant than the DOM prior to the request. User agents should allow users to insert new paragraphs into elements that contains only content other than paragraphs. For example, given the markup: <section> <dl> <dt> Ben </dt> <dd> Goat </dd> </dl> </section> ...the user agent should allow the user to insert p p160 elements before and after the dl p168 element, as children of the section p144 element. Break block UAs should offer a way for the user to request that the current paragraph be broken at the caret, e.g. as the default action of a keydown event whose identifier is the "Enter" key and that has no modifiers set. The exact behavior is UA-dependent, but user agents must not, in response to a request to break a paragraph, generate a DOM that is less conformant than the DOM prior to the request. Insert a line separator UAs should offer a way for the user to request an explicit line break at the caret position without breaking the paragraph, e.g. as the default action of a keydown event whose identifier is the "Enter" key and that has a shift modifier set. Line separators are typically found within a poem verse or an address. To insert a line break, the user agent must insert a br p194 element. If the caret is positioned somewhere where phrasing content p100 is not allowed (e.g. in an empty ol p164 element), then the user agent must not insert the br p194 element directly at the caret position. In such cases the behavior is UA-dependent, but user agents must not, in response to a request to insert a line separator, generate a DOM that is less conformant than the DOM prior to the request. Delete UAs should offer a way for the user to delete text and elements, including non-editable descendants, e.g. as the default action of keydown events whose identifiers are "U+0008" or "U+007F". Five edge cases in particular need to be considered carefully when implementing this feature: backspacing at the start of an element, backspacing when the caret is immediately after an element, forward-deleting at the end of an element, forward-deleting when the caret is immediately before an element, and deleting a selection whose start and end points do not share a common parent node. In any case, the exact behavior is UA-dependent, but user agents must not, in response to a request to delete text or an element, generate a DOM that is less conformant than the DOM prior to the request. Insert, and wrap text in, semantic elements UAs should offer the user the ability to mark text and paragraphs with semantics that HTML can express. UAs should similarly offer a way for the user to insert empty semantic elements to subsequently fill by entering text manually. UAs should also offer a way to remove those semantics from marked up text, and to remove empty semantic element that have been inserted. In response to a request from a user to mark text up in italics, user agents should use the i p187 element to represent the semantic. The em p175 element should be used only if the user agent is sure that the user means to indicate stress emphasis.
578
In response to a request from a user to mark text up in bold, user agents should use the b p188 element to represent the semantic. The strong p176 element should be used only if the user agent is sure that the user means to indicate importance. The exact behavior is UA-dependent, but user agents must not, in response to a request to wrap semantics around some text or to insert or remove a semantic element, generate a DOM that is less conformant than the DOM prior to the request. Select and move non-editable elements nested inside editing hosts UAs should offer a way for the user to move images and other non-editable parts around the content within an editing host. This may be done using the drag and drop p581 mechanism. User agents must not, in response to a request to move non-editable elements nested inside editing hosts, generate a DOM that is less conformant than the DOM prior to the request. Edit form controls nested inside editing hosts When an editable p577 form control is edited, the changes must be reflected in both its current value and its default value. For input p353 elements this means updating the defaultValue p358 IDL attribute as well as the value p383 IDL attribute; for select p387 elements it means updating the option p393 elements' defaultSelected p394 IDL attribute as well as the selected p394 IDL attribute; for textarea p395 elements this means updating the defaultValue p397 IDL attribute as well as the value p397 IDL attribute. (Updating the default* IDL attributes causes content attributes to be updated as well.) User agents may perform several commands per user request; for example if the user selects a block of text and hits Enter, the UA might interpret that as a request to delete the content of the selection followed by a request to break the paragraph at that position. User agents may add DOM changes p598 entries to the undo transaction history p598 of the editing host p577 's Document p33 object each time an action is triggered. All of the actions defined above, whether triggered by the user or programmatically (e.g. by execCommand() p601 commands), must fire mutation events as appropriate.
The designMode p579 IDL attribute on the Document p33 object takes two values, "on" and "off". When it is set, the new value must be compared in an ASCII case-insensitive p36 manner to these two values. If it matches the "on" value, then designMode p579 must be enabled, and if it matches the "off" value, then designMode p579 must be disabled. Other values must be ignored. When designMode p579 is enabled, the IDL attribute must return the value "on", and when it is disabled, it must return the value "off". The last state set must persist until the document is destroyed or the state is changed. Initially, documents must have their designMode p579 disabled.
579
inherit-by-default The element's default behavior is the same as its parent element's. Elements that have no parent element cannot have this as their default behavior. The spellcheck attribute is an enumerated attribute p38 whose keywords are the empty string, true and false. The empty string and the true keyword map to the true state. The false keyword maps to the false state. In addition, there is a third state, the default state, which is the missing value default (and the invalid value default). The true state indicates that the element is to have its spelling and grammar checked. The default state indicates that the element is to act according to a default behavior, possibly based on the parent element's own spellcheck p580 state. The false state indicates that the element is not to be checked. This box is non-normative. Implementation requirements are given below this box. element . spellcheck
p580
[ = value ]
Returns true if the element is to have its spelling and grammar checked; otherwise, returns false. Can be set, to override the default and set the spellcheck p580 content attribute.
The spellcheck IDL attribute, on getting, must return true if the element's spellcheck p580 content attribute is in the true state, or if the element's spellcheck p580 content attribute is in the default state and the element's default behavior p579 is true-by-default p579 , or if the element's spellcheck p580 content attribute is in the default state and the element's default behavior p579 is inherit-by-default p580 and the element's parent element's spellcheck p580 IDL attribute would return true; otherwise, if none of those conditions applies, then the attribute must instead return false. Note: The spellcheck p580 IDL attribute is not affected by user preferences that override the spellcheck p580 content attribute, and therefore might not reflect the actual spellchecking state. On setting, if the new value is true, then the element's spellcheck p580 content attribute must be set to the literal string "true", otherwise it must be set to the literal string "false". User agents must only consider the following pieces of text as checkable for the purposes of this feature: The value of input p353 elements to which the readonly p378 attribute applies, whose type p355 attributes are not in the Password p362 state, and that are not immutable p357 (i.e. that do not have the readonly p378 attribute specified and that are not disabled p409 ). The value of textarea p395 elements that do not have a readonly p396 attribute and that are not disabled p409 . Text in text nodes p29 that are children of editable p577 elements. Text in attributes of editable p577 elements.
For text that is part of a text node p29 , the element with which the text is associated is the element that is the immediate parent of the first character of the word, sentence, or other piece of text. For text in attributes, it is the attribute's element. For the values of input p353 and textarea p395 elements, it is the element itself. To determine if a word, sentence, or other piece of text in an applicable element (as defined above) is to have spelling- and/or grammar-checking enabled, the UA must use the following algorithm: 1. 2. If the user has disabled the checking for this text, then the checking is disabled. Otherwise, if the user has forced the checking for this text to always be enabled, then the checking is enabled. Otherwise, if the element with which the text is associated has a spellcheck p580 content attribute, then: if that attribute is in the true state, then checking is enabled; otherwise, if that attribute is in the false state, then checking is disabled. Otherwise, if there is an ancestor element with a spellcheck p580 content attribute that is not in the default state, then: if the nearest such ancestor's spellcheck p580 content attribute is in the true state, then checking is enabled; otherwise, checking is disabled. Otherwise, if the element's default behavior p579 is true-by-default p579 , then checking is enabled. Otherwise, if the element's default behavior p579 is false-by-default p579 , then checking is disabled.
3.
4.
5. 6.
580
7. 8.
Otherwise, if the element's parent element has its checking enabled, then checking is enabled. Otherwise, checking is disabled.
If the checking is enabled for a word/sentence/text, the user agent should indicate spelling and/or grammar errors in that text. User agents should take into account the other semantics given in the document when suggesting spelling and grammar corrections. User agents may use the language of the element to determine what spelling and grammar rules to use, or may use the user's preferred language settings. UAs should use input p353 element attributes such as pattern p380 to ensure that the resulting value is valid, where possible. If checking is disabled, the user agent should not indicate spelling or grammar errors for that text. The element with ID "a" in the following example would be the one used to determine if the word "Hello" is checked for spelling errors. In this example, it would not be. <div contenteditable="true"> <span spellcheck="false" id="a">Hell</span><em>o!</em> </div> The element with ID "b" in the following example would have checking enabled (the leading space character in the attribute's value on the input p353 element causes the attribute to be ignored, so the ancestor's value is used instead, regardless of the default). <p spellcheck="true"> <label>Name: <input spellcheck=" false" id="b"></label> </p> Note: This specification does not define the user interface for spelling and grammar checkers. A user agent could offer on-demand checking, could perform continuous checking while the checking is enabled, or could use other interfaces.
8.7.1 Introduction
This section is non-normative. To make an element draggable is simple: give the element a draggable p595 attribute, and set an event listener for dragstart p595 that stores the data being dragged. The event handler typically needs to check that it's not a text selection that is being dragged, and then needs to store data into the DataTransfer p583 object and set the allowed effects (copy, move, link, or some combination). For example: <p>What fruits do you like?</p> <ol ondragstart="dragStartHandler(event)"> <li draggable="true" data-value="fruit-apple">Apples</li> <li draggable="true" data-value="fruit-orange">Oranges</li> <li draggable="true" data-value="fruit-pear">Pears</li> </ol> <script> var internalDNDType = 'text/x-example'; // set this to something specific to your site function dragStartHandler(event) {
581
if (event.target instanceof HTMLLIElement) { // use the element's data-value="" attribute as the value to be moving: event.dataTransfer.setData(internalDNDType, event.target.dataset.value); event.dataTransfer.effectAllowed = 'move'; // only allow moves } else { event.preventDefault(); // don't allow selection to be dragged } } </script> To accept a drop, the drop target has to listen to at least three events. First, the dragenter p595 event, which is used to determine whether or not the drop target is to accept the drop. If the drop is to be accepted, then this event has to be canceled. Second, the dragover p595 event, which is used to determine what feedback is to be shown to the user. If the event is canceled, then the feedback (typically the cursor) is updated based on the dropEffect p584 attribute's value, as set by the event handler; otherwise, the default behavior (typically to do nothing) is used instead. Finally, the drop p595 event, which allows the actual drop to be performed. This event also needs to be canceled, so that the dropEffect p584 attribute's value can be used by the source (otherwise it's reset). For example: <p>Drop your favorite fruits below:</p> <ol class="dropzone" ondragenter="dragEnterHandler(event)" ondragover="dragOverHandler(event)" ondrop="dropHandler(event)"> </ol> <script> var internalDNDType = 'text/x-example'; // set this to something specific to your site function dragEnterHandler(event) { // cancel the event if the drag contains data of our type if (event.dataTransfer.types.contains(internalDNDType)) event.preventDefault(); } function dragOverHandler(event) { event.dataTransfer.dropEffect = 'move'; event.preventDefault(); // override default drag feedback } function dropHandler(event) { // drop the data var li = document.createElement('li'); var data = event.dataTransfer.getData(internalDNDType); if (data == 'fruit-apple') { li.textContent = 'Apples'; } else if (data == 'fruit-orange') { li.textContent = 'Oranges'; } else if (data == 'fruit-pear') { li.textContent = 'Pears'; } else { li.textContent = 'Unknown Fruit'; } event.target.appendChild(li); } </script> To remove the original element (the one that was dragged) from the display, the dragend p595 event can be used. For our example here, that means updating the original markup to handle that event: <p>What fruits do you like?</p> <ol ondragstart="dragStartHandler(event)" ondragend="dragEndHandler(event)"> ...as before... </ol> <script> function dragStartHandler(event) { // ...as before... } function dragEndHandler(event) { // remove the dragged element event.target.parentNode.removeChild(event.target); } </script>
582
A drag data store mode, which is one of the following: Read/write mode For the dragstart p595 event. New data can be added to the drag data store p583 . Read-only mode For the drop p595 event. The list of items representing dragged data can be read, including the data. No new data can be added. Protected mode For all other events. The formats and kinds in the drag data store p583 list of items representing dragged data can be enumerated, but the data itself is unavailable and no new data can be added.
When a drag data store p583 is created, it must be initialized such that its drag data store item list p583 is empty, it has no drag data store default feedback p583 , its drag data store elements list p583 is empty, it has no drag data store bitmap p583 / drag data store hot spot coordinate p583 , its drag data store mode p583 is protected mode p583 , and its drag data store allowed effects state p583 is the string "uninitialized".
583
attribute DOMString effectAllowed; readonly attribute DOMStringList types; void clearData(in optional DOMString format); void setData(in DOMString format, in DOMString data); DOMString getData(in DOMString format); readonly attribute FileList files; void setDragImage(in Element image, in long x, in long y); void addElement(in Element element); }; This box is non-normative. Implementation requirements are given below this box. dataTransfer . dropEffect p584 [ = value ] Returns the kind of operation that is currently selected. If the kind of operation isn't one of those that is allowed by the effectAllowed p584 attribute, then the operation will fail. Can be set, to change the selected operation. The possible values are "none", "copy", "link", and "move". dataTransfer . effectAllowed p584 [ = value ] Returns the kinds of operations that are to be allowed. Can be set, to change the allowed operations. The possible values are "none", "copy", "copyLink", "copyMove", "link", "linkMove", "move", "all", and "uninitialized", dataTransfer . types p585 Returns a DOMStringList listing the formats that were set in the dragstart p595 event. In addition, if any files are being dragged, then one of the types will be the string "Files". dataTransfer . clearData p585 ( [ format ] ) Removes the data of the specified formats. Removes all data if the argument is omitted. dataTransfer . setData p585 (format, data) Adds the specified data. data = dataTransfer . getData p585 (format) Returns the specified data. If there is no such data, returns the empty string. dataTransfer . files p586 Returns a FileList of the files being dragged, if any. dataTransfer . setDragImage p586 (element, x, y) Uses the given element to update the drag feedback, replacing any previously specified feedback. dataTransfer . addElement p586 (element) Adds the given element to the list of elements used to render the drag feedback.
DataTransfer p583 objects are used during the drag-and-drop events p595 , and are only valid while those events are being dispatched. A DataTransfer p583 object is associated with a drag data store p583 while it is valid. The dropEffect attribute controls the drag-and-drop feedback that the user is given during a drag-and-drop operation. When the DataTransfer p583 object is created, the dropEffect p584 attribute is set to a string value. On getting, it must return its current value. On setting, if the new value is one of "none", "copy", "link", or "move", then the attribute's current value must be set to the new value. Other values must be ignored. The effectAllowed attribute is used in the drag-and-drop processing model to initialize the dropEffect p584 attribute during the dragenter p595 and dragover p595 events. When the DataTransfer p583 object is created, the effectAllowed p584 attribute is set to a string value. On getting, it must return its current value. On setting, if the new value is one of "none", "copy", "copyLink", "copyMove", "link", "linkMove", "move", "all", or "uninitialized", then the attribute's current value must be set to the new value. Other values must be ignored.
584
The types attribute must return a live p29 DOMStringList giving the strings that the following steps would produce. The same object must be returned each time. 1. 2. Start with an empty list L. If the DataTransfer p583 object is no longer associated with a drag data store p583 , the DOMStringList is empty. Abort these steps; return the empty list L. For each item in the drag data store item list p583 whose kind p583 is Plain Unicode string, add an entry to the list L consisting of the item's type string p583 . If there are any items in the drag data store item list p583 whose kind p583 is File, then add an entry to the list L consisting of the string "Files". (This value can be distinguished from the other values because it is not lowercase.) The strings produced by these steps are those in the list L.
3.
4.
5.
The clearData() method must run the following steps: 1. If the DataTransfer p583 object is no longer associated with a drag data store p583 , abort these steps. Nothing happens. If the drag data store p583 's mode p583 is not the read/write mode p583 , abort these steps. Nothing happens. If the method was called with no arguments, remove each item in the drag data store item list p583 whose kind p583 is Plain Unicode string, and abort these steps. Let format be the first argument, converted to ASCII lowercase p36 . If format equals "text", change it to "text/plain". If format equals "url", change it to "text/uri-list". 6. Remove the item in the drag data store item list p583 whose kind p583 is Plain Unicode string and whose type string p583 is equal to format, if there is one.
2. 3.
4. 5.
Note: The clearData() p585 method does not affect whether any files were included in the drag, so the types p585 attribute's list might still not be empty after calling clearData() p585 (it would still contain the "Files" string if any files were included in the drag). The setData(format, data) method must run the following steps: 1. If the DataTransfer p583 object is no longer associated with a drag data store p583 , abort these steps. Nothing happens. If the drag data store p583 's mode p583 is not the read/write mode p583 , abort these steps. Nothing happens. Let format be the first argument, converted to ASCII lowercase p36 . If format equals "text", change it to "text/plain". If format equals "url", change it to "text/uri-list". 5. Remove the item in the drag data store item list p583 whose kind p583 is Plain Unicode string and whose type string p583 is equal to format, if there is one. Add an item to the drag data store item list p583 whose kind p583 is Plain Unicode string, whose type string p583 is equal to format, and whose data is the string given by the method's second argument.
2. 3. 4.
6.
The getData(format, data) method must run the following steps: 1. If the DataTransfer p583 object is no longer associated with a drag data store p583 , abort these steps. Nothing happens. If the drag data store p583 's mode p583 is in the protected mode p583 , abort these steps. Nothing happens. Let format be the first argument, converted to ASCII lowercase p36 . Let convert-to-URL be false. If format equals "text", change it to "text/plain". If format equals "url", change it to "text/uri-list" and set convert-to-URL to true. If there is no item in the drag data store item list p583 whose kind p583 is Plain Unicode string and whose type string p583 is equal to format, return the empty string and abort these steps.
2. 3. 4. 5. 6. 7.
585
8.
Let result be the data of the item in the drag data store item list p583 whose kind p583 is Plain Unicode string and whose type string p583 is equal to format. If convert-to-URL is true, then parse result as appropriate for text/uri-list data, and then set result to the first URL from the list, if any, or the empty string otherwise. [RFC2483] p784 Return result.
9.
10.
The files attribute must return a live p29 FileList sequence consisting of File objects representing the files found by the following steps. The same object must be returned each time. Furthermore, for a given FileList object and a given underlying file, the same File object must be used each time. 1. 2. Start with an empty list L. If the DataTransfer p583 object is no longer associated with a drag data store p583 , the FileList is empty. Abort these steps; return the empty list L. If the drag data store p583 's mode p583 is in the protected mode p583 , abort these steps; return the empty list L. For each item in the drag data store item list p583 whose kind p583 is File , add the item's data (the file, in particular its name and contents, as well as its type p583 ) to the list L. The files found by these steps are those in the list L.
3.
4.
5.
Note: This version of the API does not expose the types of the files during the drag. The items attribute must return a DataTransferItems p586 object associated with the DataTransfer p583 object. The same object must be returned each time. The setDragImage(element, x, y) method must run the following steps: 1. If the DataTransfer p583 object is no longer associated with a drag data store p583 , abort these steps. Nothing happens. If the drag data store p583 's mode p583 is not in the read/write mode p583 , abort these steps. Nothing happens. If the element argument is an img p199 element, then set the drag data store bitmap p583 to the element's image (at its intrinsic size); otherwise, set the drag data store bitmap p583 to an image generated from the given element (the exact mechanism for doing so is not currently specified). Set the drag data store hot spot coordinate p583 to the given x, y coordinate.
2.
3.
4.
The addElement(element) method is an alternative way of specifying how the user agent is to render the drag feedback p592 . The method must run the following steps: 1. If the DataTransfer p583 object is no longer associated with a drag data store p583 , abort these steps. Nothing happens. If the drag data store p583 's mode p583 is not in the read/write mode p583 , abort these steps. Nothing happens. Add the given element to the element's drag data store elements list p583 .
2.
3.
Note: The difference between setDragImage() p586 and addElement() p586 is that the latter automatically generates the image based on the current rendering of the elements added (potentially keeping it updated as the drag continues, e.g. if the elements include an actively playing video), whereas the former uses the exact specified image at the time the method is invoked.
8.7.3.1 The DataTransferItems p586 interface Each DataTransfer p583 object is associated with a DataTransferItems p586 object. interface DataTransferItems { readonly attribute unsigned long length; getter DataTransferItem (in unsigned long index); deleter void (in unsigned long index); void clear(); DataTransferItem add(in DOMString data, in DOMString type);
586
DataTransferItem add(in File data); }; This box is non-normative. Implementation requirements are given below this box. items . length
p587
Returns the number of items in the drag data store p583 . items[index] Returns the DataTransferItem p588 object representing the indexth entry in the drag data store p583 . delete items[index] Removes the indexth entry in the drag data store p583 . items . clear p587 () Removes all the entries in the drag data store p583 . items . add p587 (data) items . add p587 (data, type) Adds a new entry for the given data to the drag data store p583 . If the data is plain text then a type string has to be provided also.
While the DataTransferItems p586 object's DataTransfer p583 object is associated with a drag data store p583 , the DataTransferItems p586 object's mode is the same as the drag data store mode p583 . When the DataTransferItems p586 object's DataTransfer p583 object is not associated with a drag data store p583 , the DataTransferItems p586 object's mode is the disabled mode. The drag data store p583 referenced in this section (which is used only when the DataTransferItems p586 object is not in the disabled mode) is the drag data store p583 with which the DataTransferItems p586 object's DataTransfer p583 object is associated. The length attribute must return zero if the object is in the disabled mode; otherwise it must return the number of items in the drag data store item list p583 . When a DataTransferItems p586 object is not in the disabled mode, its supported property indices p34 are the numbers in the range 0 .. n-1, where n is the number of items in the drag data store item list p583 . To determine the value of an indexed property i of a DataTransferItems p586 object, the user agent must return a DataTransferItem p588 object representing the ith item in the drag data store p583 . The same object must be returned each time a particular item is obtained from this DataTransferItems p586 object. The DataTransferItem p588 object must be associated with the same DataTransfer p583 object as the DataTransferItems p586 object when it is first created. To delete an existing indexed property i of a DataTransferItems p586 object, the user agent must run these steps: 1. If the DataTransferItems p586 object is not in the read/write mode p583 , throw an INVALID_STATE_ERR p75 exception and abort these steps. Remove the ith item from the drag data store p583 .
2.
The clear method, if the DataTransferItems p586 object is in the read/write mode p583 , must remove all the items from the drag data store p583 . Otherwise, it must do nothing. The add() method must run the following steps: 1. 2. If the DataTransferItems p586 object is not in the read/write mode p583 , return null and abort these steps. Jump to the appropriate set of steps from the following list: If the first argument to the method is a string If there is already an item in the drag data store item list p583 whose kind p583 is Plain Unicode string and whose type string p583 is equal to the value of the method's second argument, converted to ASCII lowercase p36 , then throw a NOT_SUPPORTED_ERR p75 exception and abort these steps. Otherwise, add an item to the drag data store item list p583 whose kind p583 is Plain Unicode string, whose type string p583 is equal to the value of the method's second argument, converted to ASCII lowercase p36 , and whose data is the string given by the method's first argument.
587
If the first argument to the method is a File Add an item to the drag data store item list p583 whose kind p583 is File, whose type string p583 is the type of the File, converted to ASCII lowercase p36 , and whose data is the same as the File's data. 3. Determine the value of the indexed property p587 corresponding to the newly added item, and return that value (a newly created DataTransferItem p588 object).
8.7.3.2 The DataTransferItem p588 interface Each DataTransferItem p588 object is associated with a DataTransfer p583 object. interface DataTransferItem { readonly attribute DOMString kind; readonly attribute DOMString type; void getAsString(in FunctionStringCallback callback); File getAsFile(); }; [Callback=FunctionOnly, NoInterfaceObject] interface FunctionStringCallback { void handleEvent(in DOMString data); }; This box is non-normative. Implementation requirements are given below this box. item . kind
p588
Returns the drag data item kind p583 , one of: "string", "file". item . type p588 Returns the drag data item type string p583 . item . getAsString p588 (callback) Invokes the callback with the string data as the argument, if the drag data item kind p583 is Plain Unicode string. file = item . getAsFile p589 () Returns a File object, if the drag data item kind p583 is File.
While the DataTransferItem p588 object's DataTransfer p583 object is associated with a drag data store p583 and that drag data store p583 's drag data store item list p583 still contains the item that the DataTransferItem p588 object represents, the DataTransferItem p588 object's mode is the same as the drag data store mode p583 . When the DataTransferItem p588 object's DataTransfer p583 object is not associated with a drag data store p583 , or if the item that the DataTransferItem p588 object represents has been removed from the relevant drag data store item list p583 , the DataTransferItem p588 object's mode is the disabled mode. The drag data store p583 referenced in this section (which is used only when the DataTransferItem p588 object is not in the disabled mode) is the drag data store p583 with which the DataTransferItem p588 object's DataTransfer p583 object is associated. The kind attribute must return the empty string if the DataTransferItem p588 object is in the disabled mode; otherwise it must return the string given in the cell from the second column of the following table from the row whose cell in the first column contains the drag data item kind p583 of the item represented by the DataTransferItem p588 object:
Kind String
The type attribute must return the empty string if the DataTransferItem p588 object is in the disabled mode; otherwise it must return the drag data item type string p583 of the item represented by the DataTransferItem p588 object. The getAsString(callback) method must run the following steps: 1. 2. If the callback is null, abort these steps. If the DataTransferItem p588 object is not in the read/write mode p583 or the read-only mode p583 , abort these steps. The callback is never invoked.
588
3.
If the drag data item kind p583 is not Plain Unicode string, abort these steps. The callback is never invoked. Otherwise, queue a task p553 to invoke callback, passing the actual data of the item represented by the DataTransferItem p588 object as the argument.
4.
The getAsFile() method must run the following steps: 1. If the DataTransferItem p588 object is not in the read/write mode p583 or the read-only mode p583 , return null and abort these steps. If the drag data item kind p583 is not File, then return null and abort these steps. Return a new File object representing the actual data of the item represented by the DataTransferItem p588 object.
2. 3.
The initDragEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces, except that the dummyArg argument must be ignored. [DOMEVENTS] p782 The dataTransfer attribute of the DragEvent p589 interface represents the context information for the event. When a user agent is required to fire a DND event named e at an element, using a particular drag data store p583 , the user agent must run the following steps: 1. If e is dragstart p595 , set the drag data store mode p583 to the read/write mode p583 . If e is drop p595 , set the drag data store mode p583 to the read-only mode p583 . 2. Let dataTransfer be a newly created DataTransfer p583 object associated with the given drag data store p583 . Set the effectAllowed p584 attribute to the drag data store p583 's drag data store allowed effects state p583 . Set the dropEffect p584 attribute to "none" if e is dragstart p595 , drag p595 , or dragleave p595 ; to the value corresponding to the current drag operation p592 if e is drop p595 or dragend p595 ; and to a value based on the effectAllowed p584 attribute's value and to the drag-and-drop source, as given by the following table, otherwise (i.e. if e is dragenter p595 or dragover p595 ):
effectAllowed p584 "none" "copy", "copyLink", "copyMove", "all" "link", "linkMove" "move" "uninitialized" when what is being dragged is a selection from a text field "uninitialized" when what is being dragged is a selection dropEffect p584 "none" "copy" "link" "move" "move" "copy"
3. 4.
"uninitialized" when what is being dragged is an a p173 element with an href attribute "link" Any other case "copy"
589
5.
Create a DragEvent p589 object and initialize it to have the given name e, to bubble, to be cancelable unless e is dragleave p595 or dragend p595 , and to have the detail attribute set to zero, the mouse and key attributes set according to the state of the input devices as they would be for user interaction events, the relatedTarget attribute set to null, and the dataTransfer p589 attribute set to dataTransfer, the DataTransfer p583 object created above. If there is no relevant pointing device, the object must have its screenX, screenY, clientX, clientY, and button attributes set to 0.
6. 7.
Dispatch the newly created DragEvent p589 object at the specified target element. Set the drag data store allowed effects state p583 to the current value of dataTransfer's effectAllowed p584 attribute. Set the drag data store mode p583 back to the protected mode p583 if it was changed in the first step. Break the association between dataTransfer and the drag data store p583 .
8. 9.
3.
590
The drag data item kind p583 Plain Unicode string The actual data The text of the selection Otherwise, if any files are being dragged, then add one item per file to the drag data store item list p583 , with their properties set as follows: The drag data item type string p583 The MIME type of the file, if known, or "application/octet-stream" otherwise. The drag data item kind p583 File The actual data The file's contents and name. Note: Dragging files can currently only happen from outside a browsing context p499 , for example from a file system manager application. If the drag initiated outside of the application, the user agent must add items to the drag data store item list p583 as appropriate for the data being dragged, honoring platform conventions where appropriate; however, if the platform conventions do not use MIME types p28 to label dragged data, the user agent must make a best-effort attempt to map the types to MIME types, and, in any case, all the drag data item type strings p583 must be converted to ASCII lowercase p36 . 6. If the list of dragged nodes p590 is not empty, then extract the microdata from those nodes into a JSON form p490 , and add one item to the drag data store item list p583 , with its properties set as follows: The drag data item type string p583 application/microdata+json p762 The drag data item kind p583 Plain Unicode string The actual data The resulting JSON string. 7. Run the following substeps: 1. 2. Let urls be an empty list of absolute URLs p56 . For each node in the list of dragged nodes p590 : If the node is an a p173 element with an href p440 attribute Add to urls the result of resolving p55 the element's href p440 content attribute relative to the element. If the node is an img p199 element with an src p200 attribute Add to urls the result of resolving p55 the element's src p200 content attribute relative to the element. 3. 4. If urls is still empty, abort these substeps. Let url string be the result of concatenating the strings in urls, in the order they were added, separated by a U+000D CARRIAGE RETURN U+000A LINE FEED character pair (CRLF). Add one item to the drag data store item list p583 , with its properties set as follows: The drag data item type string p583 text/uri-list The drag data item kind p583 Plain Unicode string The actual data url string 8. If it is an element that is being dragged, then set the drag data store elements list p583 to contain just the source node p590 . Otherwise, update the drag data store default feedback p583 as appropriate for the user agent (if the user is dragging the selection, then the selection would likely be the basis for this feedback; if the drag began
5.
591
outside the user agent, then the platform conventions for determining the drag feedback should be used). Note: Script can use the addElement() p586 method to add further elements to the list of what is being dragged. (This list is only used for rendering the drag feedback.) 9. Fire a DND event p589 named dragstart p595 at the source node p590 . If the event is canceled, then the drag-and-drop operation should not occur; abort these steps. Note: Since events with no event listeners registered are, almost by definition, never canceled, drag-and-drop is always available to the user if the author does not specifically prevent it. 10. Initiate the drag-and-drop operation p592 in a manner consistent with platform conventions, and as described below. The drag-and-drop feedback must be generated from the first of the following sources that is available: 1. The drag data store bitmap p583 , if any. In this case, the drag data store hot spot coordinate p583 should be used as hints for where to put the cursor relative to the resulting image. The values are expressed as distances in CSS pixels from the left side and from the top side of the image respectively. [CSS] p781 The elements in the drag data store elements list p583 , if any. The drag data store default feedback p583 .
2. 3.
From the moment that the user agent is to initiate the drag-and-drop operation, until the end of the drag-anddrop operation, device input events (e.g. mouse and keyboard events) must be suppressed. In addition, the user agent must track all DOM changes made during the drag-and-drop operation, and add them to its undo transaction history p598 as one atomic operation once the drag-and-drop operation has ended. During the drag operation, the element directly indicated by the user as the drop target is called the immediate user selection. (Only elements can be selected by the user; other nodes must not be made available as drop targets.) However, the immediate user selection p592 is not necessarily the current target element, which is the element currently selected for the drop part of the drag-and-drop operation. The immediate user selection p592 changes as the user selects different elements (either by pointing at them with a pointing device, or by selecting them in some other way). The current target element p592 changes when the immediate user selection p592 changes, based on the results of event listeners in the document, as described below. Both the current target element p592 and the immediate user selection p592 can be null, which means no target element is selected. They can also both be elements in other (DOM-based) documents, or other (non-Web) programs altogether. (For example, a user could drag text to a word-processor.) The current target element p592 is initially null. In addition, there is also a current drag operation, which can take on the values "none", "copy", "link", and "move". Initially, it has the value "none". It is updated by the user agent as described in the steps below. User agents must, as soon as the drag operation is initiated p592 and every 350ms (200ms) thereafter for as long as the drag operation is ongoing, queue a task p553 to perform the following steps in sequence: 1. If the user agent is still performing the previous iteration of the sequence (if any) when the next iteration becomes due, abort these steps for this iteration (effectively "skipping missed frames" of the drag-anddrop operation). Fire a DND event p589 named drag p595 event at the source node p590 . If this event is canceled, the user agent must set the current drag operation p592 to "none" (no drag operation). If the drag p595 event was not canceled and the user has not ended the drag-and-drop operation, check the state of the drag-and-drop operation, as follows: 1. If the user is indicating a different immediate user selection p592 than during the last iteration (or if this is the first iteration), and if this immediate user selection p592 is not the same as the current target element p592 , then update the current target element p592 as follows:
p592 is null If the new immediate user selection
2.
3.
Set the current target element p592 to the immediate user selection p592 .
592
Otherwise Fire a DND event p589 named dragenter p595 at the immediate user selection p592 . If the event is canceled, then set the current target element p592 to the immediate user selection p592 . Otherwise, run the appropriate step from the following list:
p592 is a text field (e.g. textarea p395 , or an If the current target element p353 p355 input element whose type attribute is in the Text p358 state) or an p577 editable element, and the drag data store item list p583 has an item with the drag data item type string p583 "text/plain" and the drag data item kind p583 Plain Unicode string Set the current target element p592 to the immediate user selection p592 anyway. p592 is an element with a dropzone p596 If the current target element attribute that matches p596 the drag data store p583 Set the current target element p592 to the immediate user selection p592 anyway. p592 is the body element p83 If the current target element Leave the current target element p592 unchanged.
Otherwise Fire a DND event p589 named dragenter p595 at the body element p83 , and set the current target element p592 to the body element p83 , regardless of whether that event was canceled or not. Note: If the body element p83 is null, then the event will be fired at the Document p33 object (as required by the definition of the body element p83 ), but the current target element p592 would be set to null, not the Document p33 object. 2. If the previous step caused the current target element p592 to change, and if the previous target element was not null or a part of a non-DOM document, then fire a DND event p589 named dragleave p595 at the previous target element. If the current target element p592 is a DOM element, then fire a DND event p589 named dragover p595 at this current target element p592 . If the dragover p595 event is not canceled, run the appropriate step from the following list:
p592 is a text field (e.g. textarea p395 , or an input p353 If the current target element element whose type p355 attribute is in the Text p358 state) or an editable p577 element, and the drag data store item list p583 has an item with the drag data item type string p583 "text/plain" and the drag data item kind p583 Plain Unicode string
3.
Set the current drag operation p592 to either "copy" or "move", as appropriate given the platform conventions.
p592 is an element with a dropzone p596 attribute that If the current target element matches p596 the drag data store p583 and specifies an operation p596
Set the current drag operation p592 to the operation specified p596 by the dropzone p596 attribute of the current target element p592 .
p592 is an element with a dropzone p596 attribute that If the current target element p596 p583 matches the drag data store and does not specify an operation p596
Set the current drag operation p592 to "copy". Otherwise Reset the current drag operation p592 to "none". Otherwise (if the dragover p595 event is canceled), set the current drag operation p592 based on the values of the effectAllowed p584 and dropEffect p584 attributes of the DragEvent p589 object's dataTransfer p589 object as they stood after the event dispatch finished, as per the following table:
effectAllowed p584 dropEffect p584 Drag operation "copy"
593
effectAllowed p584
"uninitialized", "link", "copyLink", "linkMove", or "all" "link" "uninitialized", "move", "copyMove", "linkMove", or "all" "move" Any other case
4.
Otherwise, if the current target element p592 is not a DOM element, use platform-specific mechanisms to determine what drag operation is being performed (none, copy, link, or move), and set the current drag operation p592 accordingly. Update the drag feedback (e.g. the mouse cursor) to match the current drag operation p592 , as follows:
Drag operation "copy" "link" "move" "none" Feedback Data will be copied if dropped here. Data will be linked if dropped here. Data will be moved if dropped here. No operation allowed, dropping here will cancel the drag-and-drop operation.
5.
4.
Otherwise, if the user ended the drag-and-drop operation (e.g. by releasing the mouse button in a mouse-driven drag-and-drop interface), or if the drag p595 event was canceled, then this will be the last iteration. Run the following steps, then stop the drag-and-drop operation: 1. If the current drag operation p592 is "none" (no drag operation), or, if the user ended the dragand-drop operation by canceling it (e.g. by hitting the Escape key), or if the current target element p592 is null, then the drag operation failed. Run these substeps: 1. 2. Let dropped be false. If the current target element p592 is a DOM element, fire a DND event p589 named dragleave p595 at it; otherwise, if it is not null, use platform-specific conventions for drag cancellation.
Otherwise, the drag operation was as success; run these substeps: 1. 2. Let dropped be true. If the current target element p592 is a DOM element, fire a DND event p589 named drop p595 at it; otherwise, use platform-specific conventions for indicating a drop. If the event is canceled, set the current drag operation p592 to the value of the dropEffect p584 attribute of the DragEvent p589 object's dataTransfer p589 object as it stood after the event dispatch finished. Otherwise, the event is not canceled; perform the event's default action, which depends on the exact target as follows:
p592 is a text field (e.g. textarea p395 , or an If the current target element p353 p355 input element whose type attribute is in the Text p358 state) or an p577 editable element, and the drag data store item list p583 has an item with the drag data item type string p583 "text/plain" and the drag data item kind p583 Plain Unicode string
3.
Insert the actual data of the first item in the drag data store item list p583 to have a drag data item type string p583 of "text/plain" and a drag data item kind p583 that is Plain Unicode string into the text field or editable p577 element in a manner consistent with platform-specific conventions (e.g. inserting it at the current mouse cursor position, or inserting it at the end of the field). Otherwise Reset the current drag operation p592 to "none". 2. 3. Fire a DND event p589 named dragend p595 at the source node p590 . Run the appropriate steps from the following list as the default action of the dragend p595 event:
p592 is a text field (e.g. textarea p395 , or an input p353 If the current target element element whose type p355 attribute is in the Text p358 state), and dropped is true, and the current drag operation p592 is "move", and the source of the drag-anddrop operation is a selection in the DOM
The user agent should delete the range representing the dragged selection from the DOM.
594
p592 is a text field (e.g. textarea p395 , or an input p353 If the current target element p355 element whose type attribute is in the Text p358 state), and dropped is true, and the current drag operation p592 is "move", and the source of the drag-anddrop operation is a selection in a text field
The user agent should delete the dragged selection from the relevant text field. Otherwise The event has no default action. Note: User agents are encouraged to consider how to react to drags near the edge of scrollable regions. For example, if a user drags a link to the bottom of the viewport on a long page, it might make sense to scroll the page so that the user can drop the link lower on the page. Note: This model is independent of which Document p33 object the nodes involved are from; the events are fired as described above and the rest of the processing model runs as described above, irrespective of how many documents are involved in the operation.
Cancelable Read/write mode p583 Cancelable Protected mode p583 Cancelable Protected mode p583 Protected mode p583
"none" "none" Based on effectAllowed value p589 "none" Based on effectAllowed value p589 Current drag operation p592 Current drag operation p592
Initiate the drag-and-drop operation Continue the drag-and-drop operation Reject immediate user selection p592 as potential target element p592 None Reset the current drag operation p592 to "none" Varies Varies
dragenter Immediate user selection p592 or the body element p83 dragleave Previous target element p592 dragover Current target element p592
Cancelable Protected mode p583 Cancelable Read-only mode p583 Protected mode p583
drop dragend
Not shown in the above table: all these events bubble, and the effectAllowed p584 attribute always has the value it had after the previous event was fired, defaulting to "uninitialized" in the dragstart p595 event.
[ = value ]
Returns true if the element is draggable; otherwise, returns false. Can be set, to override the default and set the draggable p595 content attribute.
The draggable IDL attribute, whose value depends on the content attribute's in the way described below, controls whether or not the element is draggable. Generally, only text selections are draggable, but elements whose draggable p595 IDL attribute is true become draggable as well.
595
If an element's draggable p595 content attribute has the state true, the draggable p595 IDL attribute must return true. Otherwise, if the element's draggable p595 content attribute has the state false, the draggable p595 IDL attribute must return false. Otherwise, the element's draggable p595 content attribute has the state auto. If the element is an img p199 element, or, if the element is an a p173 element with an href p440 content attribute, the draggable p595 IDL attribute must return true. Otherwise, the draggable p595 DOM must return false. If the draggable p595 IDL attribute is set to the value false, the draggable p595 content attribute must be set to the literal value false. If the draggable p595 IDL attribute is set to the value true, the draggable p595 content attribute must be set to the literal value true.
596
3.
If keyword is shorter than three characters in length, then skip to the step labeled end of keyword below. If the second character in keyword is not a U+003A COLON character (:), then skip to the step labeled end of keyword below. Let kind code be the first character in keyword, converted to ASCII lowercase p36 . Jump to the appropriate step from the list below, based on the value of kind code: If kind code is a U+0073 LATIN SMALL LETTER S character Let kind be Plain Unicode string. If kind code is a U+0066 LATIN SMALL LETTER F character Let kind be File. Otherwise Skip to the step labeled end of keyword below.
4.
5. 6.
7.
Let type be the string consisting of all but the first two characters of keyword, converted to ASCII lowercase p36 . If there exist any items in the drag data store item list p583 whose drag data item kind p583 is the kind given in kind and whose drag data item type is type, then let matched be true. End of keyword: Go on to the next keyword, if any, or the next step in the overall algorithm, if there are no more.
8.
9.
6.
The algorithm results in a match if matched is true, and does not otherwise. The algorithm results in a specified operation if operation is not unspecified. The specified operation, if one is specified, is the one given by operation.
The dropzone attribute must reflect p62 the content attribute of the same name. In this example, a div p172 element is made into a drop target for image files using the dropzone p596 attribute. Images dropped into the target are then displayed. <div dropzone="copy f:image/png f:image/gif f:image/jpeg" ondrop="receive(event, this)"> <p>Drop an image here to have it displayed.</p> </div> <script> function receive(event, element) { var data = event.dataTransfer.items; for (var i = 0; i < data.length; i += 1) { if ((data[i].kind == 'file') && (data[i].type.match('^image/'))) { var img = new Image(); img.src = window.createObjectURL(data[i].getAsFile()); element.appendChild(img); } } } </script>
597
Undo object entries consist of objects representing state that scripts running in the document are managing. For example, a Web mail application could use an undo object p598 to keep track of the fact that a user has moved an email to a particular folder, so that the user can undo the action and have the e-mail return to its former location. Broadly speaking, DOM changes p598 entries are handled by the UA in response to user edits of form controls and editing hosts p577 on the page, and undo object p598 entries are handled by script in response to higher-level user actions (such as interactions with server-side state, or in the implementation of a drawing tool).
Returns the UndoManager p598 object. undoManager . length p599 Returns the number of entries in the undo history. data = undoManager . item p599 (index) undoManager[index] Returns the entry with index index in the undo history. Returns null if index is out of range. undoManager . position p599 Returns the number of the current entry in the undo history. (Entries at and past this point are redo entries.) undoManager . add p599 (data, title) Adds the specified entry to the undo history. undoManager . remove p599 (index) Removes the specified entry to the undo history. Throws an INDEX_SIZE_ERR p75 exception if the given index is out of range. undoManager . clearUndo p599 () Removes all entries before the current position in the undo history.
598
undoManager . clearRedo p599 () Removes all entries at and after the current position in the undo history.
The undoManager attribute of the Window p503 interface must return the object implementing the UndoManager p598 interface for that Window p503 object's associated Document p33 object. UndoManager p598 objects represent their document's undo transaction history p598 . Only undo object p598 entries are visible with this API, but this does not mean that DOM changes p598 entries are absent from the undo transaction history p598 . The length attribute must return the number of undo object p598 entries in the undo transaction history p598 . This is the length p599 . The object's supported property indices p34 are the numbers in the range zero to length p599 -1, unless the length p599 is zero, in which case there are no supported property indices p34 . The item(n) method must return the nth undo object p598 entry in the undo transaction history p598 , if there is one, or null otherwise. The undo transaction history p598 has an undo position. This is the position between two entries in the undo transaction history p598 's list where the previous entry represents what needs to happen if the user invokes the "undo" command (the "undo" side, lower numbers), and the next entry represents what needs to happen if the user invokes the "redo" command (the "redo" side, higher numbers). The position attribute must return the index of the undo object p598 entry nearest to the undo position p599 , on the "redo" side. If there are no undo object p598 entries on the "redo" side, then the attribute must return the same as the length p599 attribute. If there are no undo object p598 entries on the "undo" side of the undo position p599 , the position p599 attribute returns zero. Note: Since the undo transaction history p598 contains both undo object p598 entries and DOM changes p598 entries, but the position p599 attribute only returns indices relative to undo object p598 entries, it is possible for several "undo" or "redo" actions to be performed without the value of the position p599 attribute changing. The add(data, title) method's behavior depends on the current state. Normally, it must insert the data object passed as an argument into the undo transaction history p598 immediately before the undo position p599 , optionally remembering the given title to use in the UI. If the method is called during an undo operation p599 , however, the object must instead be added immediately after the undo position p599 . If the method is called and there is neither an undo operation in progress p599 nor a redo operation in progress p600 then any entries in the undo transaction history p598 after the undo position p599 must be removed (as if clearRedo() p599 had been called). The remove(index) method must remove the undo object p598 entry with the specified index. If the index is less than zero or greater than or equal to length p599 then the method must raise an INDEX_SIZE_ERR p75 exception. DOM changes p598 entries are unaffected by this method. The clearUndo() method must remove all entries in the undo transaction history p598 before the undo position p599 , be they DOM changes p598 entries or undo object p598 entries. The clearRedo() method must remove all entries in the undo transaction history p598 after the undo position p599 , be they DOM changes p598 entries or undo object p598 entries.
599
If the entry immediately before the undo position p599 is an undo object p598 entry, then the user agent must first remove that undo object p598 entry from the undo transaction history p598 , and then must fire an undo p600 event at the Window p503 object, using the undo object p598 entry's associated undo object as the event's data. Any calls to add() p599 while the event is being handled will be used to populate the redo history, and will then be used if the user invokes the "redo" command to undo his undo.
8.8.5 The UndoManagerEvent p600 interface and the undo p600 and redo p600 events
interface UndoManagerEvent : Event { readonly attribute any data; void initUndoManagerEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in any dataArg); }; This box is non-normative. Implementation requirements are given below this box. event . data
p600
Returns the data that was passed to the add() p599 method.
The initUndoManagerEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces. [DOMEVENTS] p782 The data attribute represents the undo object p598 for the event. The undo and redo events do not bubble, cannot be canceled, and have no default action. When the user agent fires one of these events it must use the UndoManagerEvent p600 interface, with the data p600 field containing the relevant undo object p598 .
600
The execCommand(commandId, showUI, value) method on the HTMLDocument p77 interface allows scripts to perform actions on the current selection or at the current caret position. Generally, these commands would be used to implement editor UI, for example having a "delete" button on a toolbar. There are three variants to this method, with one, two, and three arguments respectively. The showUI and value parameters, even if specified, are ignored except where otherwise stated. When execCommand() p601 is invoked, the user agent must follow the following steps: 1. If the given commandId maps to an entry in the list below whose "Enabled When" entry has a condition that is currently false, do nothing; abort these steps. Otherwise, execute the "Action" listed below for the given commandId.
2.
A document is ready for editing host commands if it has a selection that is entirely within an editing host p577 , or if it has no selection but its caret is inside an editing host p577 . The queryCommandEnabled(commandId) method, when invoked, must return true if the condition listed below under "Enabled When" for the given commandId is true, and false otherwise. The queryCommandIndeterm(commandId) method, when invoked, must return true if the condition listed below under "Indeterminate When" for the given commandId is true, and false otherwise. The queryCommandState(commandId) method, when invoked, must return the value expressed below under "State" for the given commandId. The queryCommandSupported(commandId) method, when invoked, must return true if the given commandId is in the list below, and false otherwise. The queryCommandValue(commandId) method, when invoked, must return the value expressed below under "Value" for the given commandId. The possible values for commandId, and their corresponding meanings, are as follows. These values must be compared to the argument in an ASCII case-insensitive p36 manner. bold Summary: Toggles whether the selection is bold. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the b p188 element (or, again, unwrapped, or have that semantic inserted or removed, as defined by the UA). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: True if the selection, or the caret, if there is no selection, is, or is contained within, a b p188 element. False otherwise. Value: The string "true" if the expression given for the "State" above is true, the string "false" otherwise.
601
createLink Summary: Toggles whether the selection is a link or not. If the second argument is true, and a link is to be added, the user agent will ask the user for the address. Otherwise, the third argument will be used as the address. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the a p173 element (or, again, unwrapped, or have that semantic inserted or removed, as defined by the UA). If the user agent creates an a p173 element or modifies an existing a p173 element, then if the showUI argument is present and has the value false, then the value of the value argument must be used as the URL p55 of the link. Otherwise, the user agent should prompt the user for the URL of the link. Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". delete Summary: Deletes the selection or the character before the cursor. Action: The user agent must act as if the user had performed a backspace operation p578 . Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". formatBlock Summary: Wraps the selection in the element given by the third argument. If the third argument doesn't specify an element that is a formatBlock candidate, does nothing. Action: The user agent must run the following steps: 1. 2. If the value argument wasn't specified, abort these steps without doing anything. If the value argument has a leading U+003C LESS-THAN SIGN character (<) and a trailing U+003E GREATER-THAN SIGN character (>), then remove the first and last characters from value. If value is (now) an ASCII case-insensitive p36 match for the tag name of an element defined by this specification that is defined to be a formatBlock candidate p602 , then, for every position in the selection, take the nearest formatBlock candidate p602 ancestor element of that position that contains only phrasing content p100 , and, if that element is editable p577 , is not an editing host p577 , and has a parent element whose content model allows that parent to contain any flow content p100 , replace it with an element in the HTML namespace whose name is value, and move all the children that were in it to the new element, and copy all the attributes that were on it to the new element. If there is no selection, then, where in the description above refers to the selection, the user agent must act as if the selection was an empty range (with just one position) at the caret position. Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". forwardDelete Summary: Deletes the selection or the character after the cursor. Action: The user agent must act as if the user had performed a forward delete operation p578 . Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertImage Summary: Toggles whether the selection is an image or not. If the second argument is true, and an image is to be added, the user agent will ask the user for the address. Otherwise, the third argument will be used as the address. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the img p199 element (or, again, unwrapped, or have that semantic inserted or removed, as defined by the UA). If the user agent creates an img p199 element or modifies an existing img p199 element, then if the showUI argument is present and has the value false, then the value of the value argument must be used as the URL p55 of the image. Otherwise, the user agent should prompt the user for the URL of the image. Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertHTML Summary: Replaces the selection with the value of the third argument parsed as HTML.
3.
602
Action: The user agent must run the following steps: 1. If the document is an XML document p77 , then throw an INVALID_ACCESS_ERR p75 exception and abort these steps. If the value argument wasn't specified, abort these steps without doing anything. If there is a selection, act as if the user had requested that the selection be deleted p578 . Invoke the HTML fragment parsing algorithm p696 with an arbitrary orphan body p142 element owned by the same Document p33 as the context element and with the value argument as input. Insert the nodes returned by the previous step into the document at the location of the caret, firing any mutation events as appropriate.
2. 3. 4.
5.
Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertLineBreak Summary: Inserts a line break. Action: The user agent must act as if the user had requested a line separator p578 . Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertOrderedList Summary: Toggles whether the selection is an ordered list. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the ol p164 element (or unwrapped, or, if there is no selection, have that semantic inserted or removed the exact behavior is UA-defined). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertUnorderedList Summary: Toggles whether the selection is an unordered list. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the ul p166 element (or unwrapped, or, if there is no selection, have that semantic inserted or removed the exact behavior is UA-defined). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertParagraph Summary: Inserts a paragraph break. Action: The user agent must act as if the user had performed a break block p578 editing action. Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". insertText Summary: Inserts the text given in the third parameter. Action: The user agent must act as if the user had inserted text p578 corresponding to the value parameter. Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: Always false. Value: Always the string "false". italic Summary: Toggles whether the selection is italic. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the i p187 element (or, again, unwrapped, or have that semantic inserted or removed, as defined by the UA). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: True if the selection, or the caret, if there is no selection, is, or is contained within, a i p187 element. False otherwise.
603
Value: The string "true" if the expression given for the "State" above is true, the string "false" otherwise. redo Summary: Acts as if the user had requested a redo. Action: The user agent must move forward one step p600 in its undo transaction history p598 , restoring the associated state. If the undo position p599 is at the end of the undo transaction history p598 , the user agent must do nothing. See the undo history p598 . Enabled When: The undo position p599 is not at the end of the undo transaction history p598 . Indeterminate When: Never. State: Always false. Value: Always the string "false". selectAll Summary: Selects all the editable content. Action: The user agent must change the selection so that all the content in the currently focused editing host p577 is selected. If no editing host p577 is focused, then the content of the entire document must be selected. Enabled When: Always. Indeterminate When: Never. State: Always false. Value: Always the string "false". subscript Summary: Toggles whether the selection is subscripted. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the sub p187 element (or, again, unwrapped, or have that semantic inserted or removed, as defined by the UA). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: True if the selection, or the caret, if there is no selection, is, or is contained within, a sub p187 element. False otherwise. Value: The string "true" if the expression given for the "State" above is true, the string "false" otherwise. superscript Summary: Toggles whether the selection is superscripted. Action: The user agent must act as if the user had requested that the selection be wrapped in the semantics p578 of the sup p187 element (or unwrapped, or, if there is no selection, have that semantic inserted or removed the exact behavior is UA-defined). Enabled When: The document is ready for editing host commands p601 . Indeterminate When: Never. State: True if the selection, or the caret, if there is no selection, is, or is contained within, a sup p187 element. False otherwise. Value: The string "true" if the expression given for the "State" above is true, the string "false" otherwise. undo Summary: Acts as if the user had requested an undo. Action: The user agent must move back one step p599 in its undo transaction history p598 , restoring the associated state. If the undo position p599 is at the start of the undo transaction history p598 , the user agent must do nothing. See the undo history p598 . Enabled When: The undo position p599 is not at the start of the undo transaction history p598 . Indeterminate When: Never. State: Always false. Value: Always the string "false". unlink Summary: Removes all links from the selection. Action: The user agent must remove all a p173 elements that have href p440 attributes and that are partially or completely included in the current selection. Enabled When: The document has a selection that is entirely within an editing host p577 and that contains (either partially or completely) at least one a p173 element that has an href p440 attribute. Indeterminate When: Never. State: Always false. Value: Always the string "false". unselect Summary: Unselects everything. Action: The user agent must change the selection so that nothing is selected. Enabled When: Always. Indeterminate When: Never. State: Always false. Value: Always the string "false".
604
vendorID-customCommandID Action: User agents may implement vendor-specific extensions to this API. Vendor-specific extensions to the list of commands should use the syntax vendorID-customCommandID so as to prevent clashes between extensions from different vendors and future additions to this specification. Enabled When: UA-defined. Indeterminate When: UA-defined. State: UA-defined. Value: UA-defined. Anything else Action: User agents must do nothing. Enabled When: Never. Indeterminate When: Never. State: Always false. Value: Always the string "false".
605
9 Communication
9.1 Event definitions
Messages in server-sent events, Web sockets, cross-document messaging p606 , and channel messaging p609 use the message event. [EVENTSOURCE] p782 [WEBSOCKET] p785 The following interface is defined for this event: interface MessageEvent : Event { readonly attribute any data; readonly attribute DOMString origin; readonly attribute DOMString lastEventId; readonly attribute WindowProxy source; readonly attribute MessagePortArray ports; void initMessageEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in any dataArg, in DOMString originArg, in DOMString lastEventIdArg, in WindowProxy sourceArg, in MessagePortArray portsArg); }; This box is non-normative. Implementation requirements are given below this box. event . data
p606
Returns the data of the message. event . origin p606 Returns the origin of the message, for server-sent events and cross-document messaging p606 . event . lastEventId p606 Returns the last event ID, for server-sent events. event . source p606 Returns the WindowProxy p510 of the source window, for cross-document messaging p606 . event . ports p606 Returns the MessagePortArray p610 sent with the message, for cross-document messaging p606 and channel messaging p609 .
The initMessageEvent() method must initialize the event in a manner analogous to the similarly-named method in the DOM Events interfaces. [DOMEVENTS] p782 The data attribute represents the message being sent. The origin attribute represents, in server-sent events and cross-document messaging p606 , the origin p510 of the document that sent the message (typically the scheme, hostname, and port of the document, but not its path or fragment identifier). The lastEventId attribute represents, in server-sent events, the last event ID string of the event source. The source attribute represents, in cross-document messaging p606 , the WindowProxy p510 of the browsing context p499 of the Window p503 object from which the message came. The ports attribute represents, in cross-document messaging p606 and channel messaging p609 the MessagePortArray p610 being sent, if any. Except where otherwise specified, when the user agent creates and dispatches a message p606 event in the algorithms described in the following sections, the lastEventId p606 attribute must be the empty string, the origin p606 attribute must be the empty string, the source p606 attribute must be null, and the ports p606 attribute must be null.
606
While this is an important security feature, it prevents pages from different domains from communicating even when those pages are not hostile. This section introduces a messaging system that allows documents to communicate with each other regardless of their source domain, in a way designed to not enable cross-site scripting attacks. The task source p553 for the tasks p553 in cross-document messaging p606 is the posted message task source.
9.2.1 Introduction
This section is non-normative. For example, if document A contains an iframe p213 element that contains document B, and script in document A calls postMessage() p608 on the Window p503 object of document B, then a message event will be fired on that object, marked as originating from the Window p503 of document A. The script in document A might look like: var o = document.getElementsByTagName('iframe')[0]; o.contentWindow.postMessage('Hello world', 'http://b.example.org/'); To register an event handler for incoming events, the script would use addEventListener() (or similar mechanisms). For example, the script in document B might look like: window.addEventListener('message', receiver, false); function receiver(e) { if (e.origin == 'http://example.com') { if (e.data == 'Hello world') { e.source.postMessage('Hello', e.origin); } else { alert(e.data); } } } This script first checks the domain is the expected domain, and then looks at the message, which it either displays to the user, or responds to by sending a message back to the document which sent the message in the first place.
9.2.2 Security
9.2.2.1 Authors Warning! Use of this API requires extra care to protect users from hostile entities abusing a site for their own purposes. Authors should check the origin p606 attribute to ensure that messages are only accepted from domains that they expect to receive messages from. Otherwise, bugs in the author's message handling code could be exploited by hostile sites. Furthermore, even after checking the origin p606 attribute, authors should also check that the data in question is of the expected format. Otherwise, if the source of the event has been attacked using a cross-site scripting flaw, further unchecked processing of information sent using the postMessage() p608 method could result in the attack being propagated into the receiver. Authors should not use the wildcard keyword (*) in the targetOrigin argument in messages that contain any confidential information, as otherwise there is no way to guarantee that the message is only delivered to the recipient to which it was intended.
9.2.2.2 User agents The integrity of this API is based on the inability for scripts of one origin p510 to post arbitrary events (using dispatchEvent() or otherwise) to objects in other origins (those that are not the same p512 ). Note: Implementors are urged to take extra care in the implementation of this feature. It allows authors to transmit information from one domain to another domain, which is normally disallowed for security reasons. It also requires that UAs be careful to allow access to certain properties but not others.
607
Note: When posting a message to a Window p503 of a browsing context p499 that has just been navigated to a new Document p33 is likely to result in the message not receiving its intended recipient: the scripts in the target browsing context p499 have to have had time to set up listeners for the messages. Thus, for instance, in situations where a message is to be sent to the Window p503 of newly created child iframe p213 , authors are advised to have the child Document p33 post a message to their parent announcing their readiness to receive messages, and for the parent to wait for this message before beginning posting messages. When a script invokes the postMessage(message, targetOrigin, ports) method (with two or three arguments) on a Window p503 object, the user agent must follow these steps: 1. If the value of the targetOrigin argument is neither a single U+002A ASTERISK character (*), a single U+002F SOLIDUS character (/), nor an absolute URL p56 , then throw a SYNTAX_ERR p75 exception and abort the overall set of steps. Let message clone be the result of obtaining a structured clone p72 of the message argument. If this throws an exception, then throw that exception and abort these steps. If the ports argument is present but either any of the entries in ports are null, or any MessagePort p610 object is listed in ports more than once, or any of the MessagePort p610 objects listed in ports have already been cloned once before, then throw an INVALID_STATE_ERR p75 exception and abort these steps. Let new ports be an empty array. If the ports argument is present, then for each port in ports in turn, obtain a new port by cloning p610 the port with the Window p503 object on which the method was invoked as the owner of the clone, and append the clone to the new ports array. Note: If the original ports argument was omitted or empty, then the new ports array will be empty. 5. 6. Return from the postMessage() p608 method, but asynchronously continue running these steps. If the targetOrigin argument is a single literal U+002F SOLIDUS character (/), and the Document p33 of the Window p503 object on which the method was invoked does not have the same origin p512 as the entry script p502 's document p551 , then abort these steps silently. Otherwise, if the targetOrigin argument is an absolute URL p56 , and the Document p33 of the Window p503 object on which the method was invoked does not have the same origin p512 as targetOrigin, then abort these steps silently. Otherwise, the targetOrigin argument is a single literal U+002A ASTERISK character (*), and no origin check is made. 7. Create an event that uses the MessageEvent p606 interface, with the event name message p606 , which does not bubble, is not cancelable, and has no default action. The data p606 attribute must be set to the value of message clone, the origin p606 attribute must be set to the Unicode serialization p512 of the origin p510 of the script that invoked the method, the source p606 attribute must be set to the script's global object p550 's WindowProxy p510 object, and the ports p606 attribute must be set to the new ports array. Queue a task p553 to dispatch the event created in the previous step at the Window p503 object on which the method was invoked. The task source p553 for this task p553 is the posted message task source p607 .
2.
3.
4.
8.
608
When the MessageChannel() constructor is called, it must run the following algorithm: 1. Create a new MessagePort object p610 owned by the script's global object p550 , and let port1 be that object. Create a new MessagePort object p610 owned by the script's global object p550 , and let port2 be that object. Entangle p610 the port1 and port2 objects. Instantiate a new MessageChannel p609 object, and let channel be that object. Let the port1 p610 attribute of the channel object be port1. Let the port2 p610 attribute of the channel object be port2. Return channel.
2.
3. 4. 5. 6. 7.
609
This constructor must be visible when the script's global object p550 is either a Window p503 object or an object implementing the WorkerUtils interface. The port1 and port2 attributes must return the values they were assigned when the MessageChannel p609 object was created.
Each MessagePort p610 object can be entangled with another (a symmetric relationship). Each MessagePort p610 object also has a task source p553 called the port message queue, initial empty. A port message queue p610 can be enabled or disabled, and is initially disabled. Once enabled, a port can never be disabled again (though messages in the queue can get moved to another queue or removed altogether, which has much the same effect). When the user agent is to create a new MessagePort object owned by a script's global object p550 object owner, it must instantiate a new MessagePort p610 object, and let its owner be owner. When the user agent is to entangle two MessagePort p610 objects, it must run the following steps: 1. If one of the ports is already entangled, then disentangle it and the port that it was entangled with. Note: If those two previously entangled ports were the two ports of a MessageChannel p609 object, then that MessageChannel p609 object no longer represents an actual channel: the two ports in that object are no longer entangled. 2. Associate the two ports to be entangled, so that they form the two parts of a new channel. (There is no MessageChannel p609 object that represents this channel.)
When the user agent is to clone a port original port, with the clone being owned by owner, it must run the following steps, which return a new MessagePort p610 object. These steps must be run atomically. 1. 2. Create a new MessagePort object p610 owned by owner, and let new port be that object. Move all the events in the port message queue p610 of original port to the port message queue p610 of new port, if any, leaving the new port's port message queue p610 in its initial disabled state. If the original port is entangled with another port, then run these substeps: 1. Let the remote port be the port with which the original port is entangled.
3.
610
2.
Entangle p610 the remote port and new port objects. The original port object will be disentangled by this process.
4.
The postMessage() method, when called on a port source port, must cause the user agent to run the following steps: 1. 2. Let target port be the port with which source port is entangled, if any. If the method was called with a second argument ports and that argument isn't null, then, if any of the entries in ports are null, if any MessagePort p610 object is listed in ports more than once, if any of the MessagePort p610 objects listed in ports have already been cloned once before, or if any of the entries in ports are either the source port or the target port (if any), then throw an INVALID_STATE_ERR p75 exception. If there is no target port (i.e. if source port is not entangled), then abort these steps. Create an event that uses the MessageEvent p606 interface, with the name message p606 , which does not bubble, is not cancelable, and has no default action. Let message be the method's first argument. Let message clone be the result of obtaining a structured clone p72 of message. If this throws an exception, then throw that exception and abort these steps. Let the data p606 attribute of the event have the value of message clone. If the method was called with a second argument ports and that argument isn't null, then run the following substeps: 1. Let new ports be an empty array. For each port in ports in turn, obtain a new port by cloning p610 the port with the owner of the target port as the owner of the clone, and append the clone to the new ports array. Note: If the original ports array was empty, then the new ports array will also be empty. 2. 9. Let the ports p606 attribute of the event be the new ports array.
3. 4.
5. 6.
7. 8.
Add the event to the port message queue p610 of target port.
The start() method must enable its port's port message queue p610 , if it is not already enabled. When a port's port message queue p610 is enabled, the event loop p552 must use it as one of its task sources p553 . Note: If the Document p33 of the port's event listeners' global object p550 is not fully active p500 , then the messages are lost.
The close() method, when called on a port local port that is entangled with another port, must cause the user agents to disentangle the two ports. If the method is called on a port that is not entangled, then the method must do nothing. The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported, as IDL attributes, by all objects implementing the MessagePort p610 interface:
Event handler p555 Event handler event type p556 onmessage message p606
The first time a MessagePort p610 object's onmessage p611 IDL attribute is set, the port's port message queue p610 must be enabled, as if the start() p611 method had been called.
9.3.3.1 Ports and garbage collection When a MessagePort p610 object o is entangled, user agents must either act as if o's entangled MessagePort p610 object has a strong reference to o, or as if o's owner has a strong reference to o.
611
Thus, a message port can be received, given an event listener, and then forgotten, and so long as that event listener could receive a message, the channel will be maintained. Of course, if this was to occur on both sides of the channel, then both ports could be garbage collected, since they would not be reachable from live code, despite having a strong reference to each other. Furthermore, a MessagePort p610 object must not be garbage collected while there exists a message in a task queue p553 that is to be dispatched on that MessagePort p610 object, or while the MessagePort p610 object's port message queue p610 is open and there exists a message p606 event in that queue. Note: Authors are strongly encouraged to explicitly close MessagePort p610 objects to disentangle them, so that their resources can be recollected. Creating many MessagePort p610 objects and discarding them without closing them can lead to high memory usage.
612
The various types of content mentioned above are described in the next few sections. In addition, there are some restrictions on how character encoding declarations p129 are to be serialized, as discussed in the section on that topic. Space characters before the root html p116 element, and space characters at the start of the html p116 element and before the head p116 element, will be dropped when the document is parsed; space characters after the root html p116 element will be parsed as if they were at the end of the body p142 element. Thus, space characters around the root element do not round-trip. It is suggested that newlines be inserted after the DOCTYPE, after any comments that are before the root element, after the html p116 element's start tag (if it is not omitted p617 ), and after any comments that are inside the html p116 element but before the head p116 element. Many strings in the HTML syntax (e.g. the names of elements and their attributes) are case-insensitive, but only for characters in the ranges U+0041 to U+005A (LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z) and U+0061 to U+007A (LATIN SMALL LETTER A to LATIN SMALL LETTER Z). For convenience, in this section this is just referred to as "case-insensitive".
For the purposes of HTML generators that cannot output HTML markup with the short DOCTYPE "<!DOCTYPE html>", a DOCTYPE legacy string may be inserted into the DOCTYPE (in the position defined above). This string must consist of:
613
1. 2. 3. 4. 5. 6.
One or more space characters p37 . A string that is an ASCII case-insensitive p36 match for the string "SYSTEM". One or more space characters p37 . A U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (the quote mark). The literal string "about:legacy-compat p56 ". A matching U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (i.e. the same character as in the earlier step labeled quote mark).
Note: In other words, <!DOCTYPE html SYSTEM "about:legacy-compat"> or <!DOCTYPE html SYSTEM 'about:legacy-compat'>, case-insensitively except for the part in single or double quotes. The DOCTYPE legacy string p613 should not be used unless the document is generated from a system that cannot output the shorter string. To help authors transition from HTML4 and XHTML1, an obsolete permitted DOCTYPE string can be inserted into the DOCTYPE (in the position defined above). This string must consist of: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. One or more space characters p37 . A string that is an ASCII case-insensitive p36 match for the string "PUBLIC". One or more space characters p37 . A U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (the first quote mark). The string from one of the cells in the first column of the table below. The row to which this cell belongs is the selected row. A matching U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (i.e. the same character as in the earlier step labeled first quote mark). If the cell in the second column of the selected row is not blank, one or more space characters p37 . If the cell in the second column of the selected row is not blank, a U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (the third quote mark). If the cell in the second column of the selected row is not blank, the string from the cell in the second column of the selected row. If the cell in the second column of the selected row is not blank, a matching U+0022 QUOTATION MARK or U+0027 APOSTROPHE character (i.e. the same character as in the earlier step labeled third quote mark).
Public identifier -//W3C//DTD HTML 4.0//EN -//W3C//DTD HTML 4.0//EN -//W3C//DTD HTML 4.01//EN -//W3C//DTD HTML 4.01//EN http://www.w3.org/TR/html4/strict.dtd http://www.w3.org/TR/REC-html40/strict.dtd System identifier
Allowed values for public and system identifiers in an obsolete permitted DOCTYPE string p614 .
A DOCTYPE p613 containing an obsolete permitted DOCTYPE string p614 is an obsolete permitted DOCTYPE. Authors should not use obsolete permitted DOCTYPEs p614 , as they are unnecessarily long.
10.1.2 Elements
There are five different kinds of elements: void elements p614 , raw text elements p614 , RCDATA elements p614 , foreign elements p614 , and normal elements p614 . Void elements area p314 , base p118 , br p194 , col p328 , command p427 , embed p220 , hr p161 , img p199 , input p353 , keygen p398 , link p119 , meta p122 , param p227 , source p232 , track p234 , wbr p195 Raw text elements script p133 , style p130 RCDATA elements textarea p395 , title p117 Foreign elements Elements from the MathML namespace p75 and the SVG namespace p75 . Normal elements All other allowed HTML elements p28 are normal elements. Tags are used to delimit the start and end of elements in the markup. Raw text p614 , RCDATA p614 , and normal p614 elements have a start tag p615 to indicate where they begin, and an end tag p616 to indicate where they end. The start and end tags of certain normal elements p614 can be omitted p617 , as described later. Those that cannot be omitted must not be omitted. Void elements p614 only have a start tag; end tags must not be specified for void elements p614 . Foreign elements p614 must either have a start tag and an end tag, or a start tag that is marked as self-closing, in which case they must not have an end tag.
614
The contents of the element must be placed between just after the start tag (which might be implied, in certain cases p617 ) and just before the end tag (which again, might be implied in certain cases p617 ). The exact allowed contents of each individual element depend on the content model of that element, as described earlier in this specification. Elements must not contain content that their content model disallows. In addition to the restrictions placed on the contents by those content models, however, the five types of elements have additional syntactic requirements. Void elements p614 can't have any contents (since there's no end tag, no content can be put between the start tag and the end tag). Raw text elements p614 can have text p619 , though it has restrictions p618 described below. RCDATA elements p614 can have text p619 and character references p619 , but the text must not contain an ambiguous ampersand p619 . There are also further restrictions p618 described below. Foreign elements p614 whose start tag is marked as self-closing can't have any contents (since, again, as there's no end tag, no content can be put between the start tag and the end tag). Foreign elements p614 whose start tag is not marked as self-closing can have text p619 , character references p619 , CDATA sections p619 , other elements p614 , and comments p620 , but the text must not contain the character U+003C LESS-THAN SIGN (<) or an ambiguous ampersand p619 . The HTML syntax does not support namespace declarations, even in foreign elements p614 . For instance, consider the following HTML fragment: <p> <svg> <metadata> <!-- this is invalid --> <cdr:license xmlns:cdr="http://www.example.com/cdr/metadata" name="MIT"/> </metadata> </svg> </p> The innermost element, cdr:license, is actually in the SVG namespace, as the "xmlns:cdr" attribute has no effect (unlike in XML). In fact, as the comment in the fragment above says, the fragment is actually non-conforming. This is because the SVG specification does not define any elements called "cdr:license" in the SVG namespace. Normal elements p614 can have text p619 , character references p619 , other elements p614 , and comments p620 , but the text must not contain the character U+003C LESS-THAN SIGN (<) or an ambiguous ampersand p619 . Some normal elements p614 also have yet more restrictions p618 on what content they are allowed to hold, beyond the restrictions imposed by the content model and those described in this paragraph. Those restrictions are described below. Tags contain a tag name, giving the element's name. HTML elements all have names that only use characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z, and U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z. In the HTML syntax, tag names, even those for foreign elements p614 , may be written with any mix of lower- and uppercase letters that, when converted to all-lowercase, matches the element's tag name; tag names are case-insensitive.
10.1.2.1 Start tags Start tags must have the following format: 1. 2. 3. 4. The first character of a start tag must be a U+003C LESS-THAN SIGN character (<). The next few characters of a start tag must be the element's tag name p615 . If there are to be any attributes in the next step, there must first be one or more space characters p37 . Then, the start tag may have a number of attributes, the syntax for which p616 is described below. Attributes must be separated from each other by one or more space characters p37 . After the attributes, or after the tag name p615 if there are no attributes, there may be one or more space characters p37 . (Some attributes are required to be followed by a space. See the attributes section p616 below.) Then, if the element is one of the void elements p614 , or if the element is a foreign element p614 , then there may be a single U+002F SOLIDUS character (/). This character has no effect on void elements p614 , but on foreign elements p614 it marks the start tag as self-closing. Finally, start tags must be closed by a U+003E GREATER-THAN SIGN character (>).
5.
6.
7.
615
10.1.2.2 End tags End tags must have the following format: 1. 2. 3. 4. 5. The first character of an end tag must be a U+003C LESS-THAN SIGN character (<). The second character of an end tag must be a U+002F SOLIDUS character (/). The next few characters of an end tag must be the element's tag name p615 . After the tag name, there may be one or more space characters p37 . Finally, end tags must be closed by a U+003E GREATER-THAN SIGN character (>).
10.1.2.3 Attributes Attributes for an element are expressed inside the element's start tag. Attributes have a name and a value. Attribute names must consist of one or more characters other than the space characters p37 , U+0000 NULL, U+0022 QUOTATION MARK ("), U+0027 APOSTROPHE ('), U+003E GREATERTHAN SIGN (>), U+002F SOLIDUS (/), and U+003D EQUALS SIGN (=) characters, the control characters, and any characters that are not defined by Unicode. In the HTML syntax, attribute names, even those for foreign elements p614 , may be written with any mix of lower- and uppercase letters that are an ASCII case-insensitive p36 match for the attribute's name. Attribute values are a mixture of text p619 and character references p619 , except with the additional restriction that the text cannot contain an ambiguous ampersand p619 . Attributes can be specified in four different ways: Empty attribute syntax Just the attribute name p616 . The value is implicitly the empty string. In the following example, the disabled p409 attribute is given with the empty attribute syntax: <input disabled> If an attribute using the empty attribute syntax is to be followed by another attribute, then there must be a space character p37 separating the two. Unquoted attribute value syntax The attribute name p616 , followed by zero or more space characters p37 , followed by a single U+003D EQUALS SIGN character, followed by zero or more space characters p37 , followed by the attribute value p616 , which, in addition to the requirements given above for attribute values, must not contain any literal space characters p37 , any U+0022 QUOTATION MARK characters ("), U+0027 APOSTROPHE characters ('), U+003D EQUALS SIGN characters (=), U+003C LESS-THAN SIGN characters (<), U+003E GREATER-THAN SIGN characters (>), or U+0060 GRAVE ACCENT characters (`), and must not be the empty string. In the following example, the value p357 attribute is given with the unquoted attribute value syntax: <input value=yes> If an attribute using the unquoted attribute syntax is to be followed by another attribute or by the optional U+002F SOLIDUS character (/) allowed in step 6 of the start tag p615 syntax above, then there must be a space character p37 separating the two. Single-quoted attribute value syntax The attribute name p616 , followed by zero or more space characters p37 , followed by a single U+003D EQUALS SIGN character, followed by zero or more space characters p37 , followed by a single U+0027 APOSTROPHE character ('), followed by the attribute value p616 , which, in addition to the requirements given above for attribute values, must not contain any literal U+0027 APOSTROPHE characters ('), and finally followed by a second single U+0027 APOSTROPHE character ('). In the following example, the type p355 attribute is given with the single-quoted attribute value syntax: <input type='checkbox'> If an attribute using the single-quoted attribute syntax is to be followed by another attribute, then there must be a space character p37 separating the two. Double-quoted attribute value syntax The attribute name p616 , followed by zero or more space characters p37 , followed by a single U+003D EQUALS SIGN character, followed by zero or more space characters p37 , followed by a single U+0022 QUOTATION MARK character ("), followed by the attribute value p616 , which, in addition to the requirements given above for attribute values, must not contain any literal U+0022 QUOTATION MARK characters ("), and finally followed by a second single U+0022 QUOTATION MARK character (").
616
In the following example, the name p408 attribute is given with the double-quoted attribute value syntax: <input name="be evil"> If an attribute using the double-quoted attribute syntax is to be followed by another attribute, then there must be a space character p37 separating the two. There must never be two or more attributes on the same start tag whose names are an ASCII case-insensitive p36 match for each other. When a foreign element p614 has one of the namespaced attributes given by the local name and namespace of the first and second cells of a row from the following table, it must be written using the name given by the third cell from the same row.
Local name actuate arcrole href role show title type base lang space xmlns xlink Namespace XLink namespace
p75
Attribute name xlink:actuate xlink:arcrole xlink:href xlink:role xlink:show xlink:title xlink:type xml:base xml:lang xml:space
XLink namespace p75 XLink namespace p75 XLink namespace p75 XLink namespace p75 XLink namespace XLink namespace
p75 p75
10.1.2.4 Optional tags Certain tags can be omitted. Note: Omitting an element's start tag p615 does not mean the element is not present; it is implied, but it is still there. An HTML document always has a root html p116 element, even if the string <html> doesn't appear anywhere in the markup. An html p116 element's start tag p615 may be omitted if the first thing inside the html p116 element is not a comment p620 . An html p116 element's end tag p616 may be omitted if the html p116 element is not immediately followed by a comment p620 . A head p116 element's start tag p615 may be omitted if the element is empty, or if the first thing inside the head p116 element is an element. A head p116 element's end tag p616 may be omitted if the head p116 element is not immediately followed by a space character p37 or a comment p620 . A body p142 element's start tag p615 may be omitted if the element is empty, or if the first thing inside the body p142 element is not a space character p37 or a comment p620 , except if the first thing inside the body p142 element is a script p133 or style p130 element. A body p142 element's end tag p616 may be omitted if the body p142 element is not immediately followed by a comment p620 . A li p166 element's end tag p616 may be omitted if the li p166 element is immediately followed by another li p166 element or if there is no more content in the parent element. A dt p169 element's end tag p616 may be omitted if the dt p169 element is immediately followed by another dt p169 element or a dd p170 element. A dd p170 element's end tag p616 may be omitted if the dd p170 element is immediately followed by another dd p170 element or a dt p169 element, or if there is no more content in the parent element. A p p160 element's end tag p616 may be omitted if the p p160 element is immediately followed by an address p154 , article p147 , aside p148 , blockquote p163 , dir p740 , div p172 , dl p168 , fieldset p350 , footer p153 , form p347 , h1 p150 , h2 p150 , h3 p150 , h4 p150 , h5 p150 , h6 p150 , header p152 , hgroup p151 , hr p161 , menu p428 , nav p145 , ol p164 , p p160 , pre p162 , section p144 ,
617
table p320 , or ul p166 , element, or if there is no more content in the parent element and the parent element is not an a p173 element. An rt p192 element's end tag p616 may be omitted if the rt p192 element is immediately followed by an rt p192 or rp p192 element, or if there is no more content in the parent element. An rp p192 element's end tag p616 may be omitted if the rp p192 element is immediately followed by an rt p192 or rp p192 element, or if there is no more content in the parent element. An optgroup p392 element's end tag p616 may be omitted if the optgroup p392 element is immediately followed by another optgroup p392 element, or if there is no more content in the parent element. An option p393 element's end tag p616 may be omitted if the option p393 element is immediately followed by another option p393 element, or if it is immediately followed by an optgroup p392 element, or if there is no more content in the parent element. A colgroup p328 element's start tag p615 may be omitted if the first thing inside the colgroup p328 element is a col p328 element, and if the element is not immediately preceded by another colgroup p328 element whose end tag p616 has been omitted. (It can't be omitted if the element is empty.) A colgroup p328 element's end tag p616 may be omitted if the colgroup p328 element is not immediately followed by a space character p37 or a comment p620 . A thead p329 element's end tag p616 may be omitted if the thead p329 element is immediately followed by a tbody p328 or tfoot p330 element. A tbody p328 element's start tag p615 may be omitted if the first thing inside the tbody p328 element is a tr p331 element, and if the element is not immediately preceded by a tbody p328 , thead p329 , or tfoot p330 element whose end tag p616 has been omitted. (It can't be omitted if the element is empty.) A tbody p328 element's end tag p616 may be omitted if the tbody p328 element is immediately followed by a tbody p328 or tfoot p330 element, or if there is no more content in the parent element. A tfoot p330 element's end tag p616 may be omitted if the tfoot p330 element is immediately followed by a tbody p328 element, or if there is no more content in the parent element. A tr p331 element's end tag p616 may be omitted if the tr p331 element is immediately followed by another tr p331 element, or if there is no more content in the parent element. A td p332 element's end tag p616 may be omitted if the td p332 element is immediately followed by a td p332 or th p332 element, or if there is no more content in the parent element. A th p332 element's end tag p616 may be omitted if the th p332 element is immediately followed by a td p332 or th p332 element, or if there is no more content in the parent element. However, a start tag p615 must never be omitted if it has any attributes.
10.1.2.5 Restrictions on content models For historical reasons, certain elements have extra restrictions beyond even the restrictions given by their content model. A table p320 element must not contain tr p331 elements, even though these elements are technically allowed inside table p320 elements according to the content models described in this specification. (If a tr p331 element is put inside a table p320 in the markup, it will in fact imply a tbody p328 start tag before it.) A single newline p619 may be placed immediately after the start tag p615 of pre p162 and textarea p395 elements. This does not affect the processing of the element. The otherwise optional newline p619 must be included if the element's contents themselves start with a newline p619 (because otherwise the leading newline in the contents would be treated like the optional newline, and ignored). The following two pre p162 blocks are equivalent: <pre>Hello</pre> <pre> Hello</pre>
10.1.2.6 Restrictions on the contents of raw text and RCDATA elements The text in raw text p614 and RCDATA elements p614 must not contain any occurrences of the string "</" (U+003C LESS-THAN SIGN, U+002F SOLIDUS) followed by characters that case-insensitively match the tag name of the
618
element followed by one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), U+0020 SPACE, U+003E GREATER-THAN SIGN (>), or U+002F SOLIDUS (/).
10.1.3 Text
Text is allowed inside elements, attribute values, and comments. Text must consist of Unicode characters. Text must not contain U+0000 characters. Text must not contain permanently undefined Unicode characters (noncharacters). Text must not contain control characters other than space characters p37 . Extra constraints are placed on what is and what is not allowed in text based on where the text is to be put, as described in the other sections.
10.1.3.1 Newlines Newlines in HTML may be represented either as U+000D CARRIAGE RETURN (CR) characters, U+000A LINE FEED (LF) characters, or pairs of U+000D CARRIAGE RETURN (CR), U+000A LINE FEED (LF) characters in that order. Where character references p619 are allowed, a character reference of a U+000A LINE FEED (LF) character (but not a U+000D CARRIAGE RETURN (CR) character) also represents a newline p619 .
619
<p>You can add a string to a number, but this stringifies the number:</p> <math> <ms><![CDATA[x<y]]></ms> <mo>+</mo> <mn>3</mn> <mo>=</mo> <ms><![CDATA[x<y3]]></ms> </math>
10.1.6 Comments
Comments must start with the four character sequence U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS (<!--). Following this sequence, the comment may have text p619 , with the additional restriction that the text must not start with a single U+003E GREATER-THAN SIGN character (>), nor start with a U+002D HYPHEN-MINUS character (-) followed by a U+003E GREATER-THAN SIGN (>) character, nor contain two consecutive U+002D HYPHEN-MINUS characters (--), nor end with a U+002D HYPHEN-MINUS character (-). Finally, the comment must be ended by the three character sequence U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN (-->).
620
Note: Implementations that do not support scripting p31 do not have to actually create a DOM Document p33 object, but the DOM tree in such cases is still used as the model for the rest of the specification. In the common case, the data handled by the tokenization stage comes from the network, but it can also come from script p109 running in the user agent, e.g. using the document.write() p112 API.
There is only one set of states for the tokenizer stage and the tree construction stage, but the tree construction stage is reentrant, meaning that while the tree construction stage is handling one token, the tokenizer might be resumed, causing further tokens to be emitted and processed before the first token's processing is complete. In the following example, the tree construction stage will be called upon to handle a "p" start tag token while handling the "script" end tag token: ... <script> document.write('<p>'); </script> ... To handle these cases, parsers have a script nesting level, which must be initially set to zero, and a parser pause flag, which must be initially set to false.
621
Note: For XML documents, the algorithm user agents must use to determine the character encoding is given by the XML specification. This section does not apply to XML documents. [XML] p786
10.2.2.1 Determining the character encoding In some cases, it might be impractical to unambiguously determine the encoding before parsing the document. Because of this, this specification provides for a two-pass mechanism with an optional pre-scan. Implementations are allowed, as described below, to apply a simplified parsing algorithm to whatever bytes they have available before beginning to parse the document. Then, the real parser is started, using a tentative encoding derived from this pre-parse and other out-of-band metadata. If, while the document is being loaded, the user agent discovers an encoding declaration that conflicts with this information, then the parser can get reinvoked to perform a parse of the document with the real encoding. User agents must use the following algorithm (the encoding sniffing algorithm) to determine the character encoding to use when decoding a document in the first pass. This algorithm takes as input any out-of-band metadata available to the user agent (e.g. the Content-Type metadata p61 of the document) and all the bytes available so far, and returns an encoding and a confidence. The confidence is either tentative, certain, or irrelevant. The encoding used, and whether the confidence in that encoding is tentative or certain, is used during the parsing p663 to determine whether to change the encoding p628 . If no encoding is necessary, e.g. because the parser is operating on a stream of Unicode characters and doesn't have to use an encoding at all, then the confidence p622 is irrelevant. 1. If the user has explicitly instructed the user agent to override the document's character encoding with a specific encoding, optionally return that encoding with the confidence p622 certain and abort these steps. If the transport layer specifies an encoding, and it is supported, return that encoding with the confidence p622 certain, and abort these steps. The user agent may wait for more bytes of the resource to be available, either in this step or at any later step in this algorithm. For instance, a user agent might wait 500ms or 512 bytes, whichever came first. In general preparsing the source to find the encoding improves performance, as it reduces the need to throw away the data structures used when parsing upon finding the encoding information. However, if the user agent delays too long to obtain data to determine the encoding, then the cost of the delay could outweigh any performance improvements from the preparse. For each of the rows in the following table, starting with the first one and going down, if there are as many or more bytes available than the number of bytes in the first column, and the first bytes of the file match the bytes given in the first column, then return the encoding given in the cell in the second column of that row, with the confidence p622 certain, and abort these steps:
Bytes in Hexadecimal FE FF FF FE EF BB BF Encoding Big-endian UTF-16 Little-endian UTF-16 UTF-8
2.
3.
4.
Note: This step looks for Unicode Byte Order Marks (BOMs). 5. Otherwise, the user agent will have to search for explicit character encoding information in the file itself. This should proceed as follows: Let position be a pointer to a byte in the input stream, initially pointing at the first byte. If at any point during these substeps the user agent either runs out of bytes or decides that scanning further bytes would not be efficient, then skip to the next step of the overall character encoding detection algorithm. User agents may decide that scanning any bytes is not efficient, in which case these substeps are entirely skipped. Now, repeat the following "two" steps until the algorithm aborts (either because user agent aborts, as described above, or because a character encoding is found): 1. If position points to: A sequence of bytes starting with: 0x3C 0x21 0x2D 0x2D (ASCII '<!--') Advance the position pointer so that it points at the first 0x3E byte which is preceded by two 0x2D bytes (i.e. at the end of an ASCII '-->' sequence) and comes after the 0x3C byte that was found. (The two 0x2D bytes can be the same as the those in the '<!--' sequence.)
622
A sequence of bytes starting with: 0x3C, 0x4D or 0x6D, 0x45 or 0x65, 0x54 or 0x74, 0x41 or 0x61, and finally one of 0x09, 0x0A, 0x0C, 0x0D, 0x20, 0x2F (caseinsensitive ASCII '<meta' followed by a space or slash) 1. Advance the position pointer so that it points at the next 0x09, 0x0A, 0x0C, 0x0D, 0x20, or 0x2F byte (the one in sequence of characters matched above). Let attribute list be an empty list of strings. Let got pragma be false. Let need pragma be null. Let charset be the null value (which, for the purposes of this algorithm, is distinct from an unrecognised encoding or the empty string). Attributes: Get an attribute p624 and its value. If no attribute was sniffed, then jump to the processing step below. If the attribute's name is already in attribute list, then return to the step labeled attributes. Add the attribute's name to attribute list. Run the appropriate step from the following list, if one applies: If the attribute's name is "http-equiv" If the attribute's value is "content-type", then set got pragma to true. If the attribute's name is "content" Apply the algorithm for extracting an encoding from a ContentType p62 , giving the attribute's value as the string to parse. If an encoding is returned, and if charset is still set to null, let charset be the encoding returned, and set need pragma to true. If the attribute's name is "charset" Let charset be the encoding corresponding to the attribute's value, and set need pragma to false. 10. 11. Return to the step labeled attributes. Processing: If need pragma is null, then jump to the second step of the overall "two step" algorithm. If mode is true but got pragma is false, then jump to the second step of the overall "two step" algorithm. If charset is a UTF-16 encoding, change the value of charset to UTF-8. If charset is not a supported character encoding, then jump to the second step of the overall "two step" algorithm. Return the encoding given by charset, with confidence p622 tentative, and abort all these steps.
2. 3. 4. 5.
6.
7.
8. 9.
12.
13. 14.
15.
A sequence of bytes starting with a 0x3C byte (ASCII <), optionally a 0x2F byte (ASCII /), and finally a byte in the range 0x41-0x5A or 0x61-0x7A (an ASCII letter) 1. Advance the position pointer so that it points at the next 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), 0x20 (ASCII space), or 0x3E (ASCII >) byte. Repeatedly get an attribute p624 until no further attributes can be found, then jump to the second step in the overall "two step" algorithm.
2.
A sequence of bytes starting with: 0x3C 0x21 (ASCII '<!') A sequence of bytes starting with: 0x3C 0x2F (ASCII '</') A sequence of bytes starting with: 0x3C 0x3F (ASCII '<?') Advance the position pointer so that it points at the first 0x3E byte (ASCII >) that comes after the 0x3C byte that was found.
623
Any other byte Do nothing with that byte. 2. Move position so it points at the next byte in the input stream, and return to the first step of this "two step" algorithm.
When the above "two step" algorithm says to get an attribute, it means doing this: 1. If the byte at position is one of 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), 0x20 (ASCII space), or 0x2F (ASCII /) then advance position to the next byte and redo this substep. If the byte at position is 0x3E (ASCII >), then abort the "get an attribute" algorithm. There isn't one. Otherwise, the byte at position is the start of the attribute name. Let attribute name and attribute value be the empty string. Attribute name: Process the byte at position as follows: If it is 0x3D (ASCII =), and the attribute name is longer than the empty string Advance position to the next byte and jump to the step below labeled value. If it is 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), or 0x20 (ASCII space) Jump to the step below labeled spaces. If it is 0x2F (ASCII /) or 0x3E (ASCII >) Abort the "get an attribute" algorithm. The attribute's name is the value of attribute name, its value is the empty string. If it is in the range 0x41 (ASCII A) to 0x5A (ASCII Z) Append the Unicode character with code point b+0x20 to attribute name (where b is the value of the byte at position). Anything else Append the Unicode character with the same code point as the value of the byte at position) to attribute name. (It doesn't actually matter how bytes outside the ASCII range are handled here, since only ASCII characters can contribute to the detection of a character encoding.) 5. 6. Advance position to the next byte and return to the previous step. Spaces: If the byte at position is one of 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), or 0x20 (ASCII space) then advance position to the next byte, then, repeat this step. If the byte at position is not 0x3D (ASCII =), abort the "get an attribute" algorithm. The attribute's name is the value of attribute name, its value is the empty string. Advance position past the 0x3D (ASCII =) byte. Value: If the byte at position is one of 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), or 0x20 (ASCII space) then advance position to the next byte, then, repeat this step. Process the byte at position as follows: If it is 0x22 (ASCII ") or 0x27 (ASCII ') 1. 2. 3. Let b be the value of the byte at position. Advance position to the next byte. If the value of the byte at position is the value of b, then advance position to the next byte and abort the "get an attribute" algorithm. The attribute's name is the value of attribute name, and its value is the value of attribute value. Otherwise, if the value of the byte at position is in the range 0x41 (ASCII A) to 0x5A (ASCII Z), then append a Unicode character to attribute value whose code point is 0x20 more than the value of the byte at position. Otherwise, append a Unicode character to attribute value whose code point is the same as the value of the byte at position.
2.
3.
4.
7.
8. 9.
10.
4.
5.
624
6.
If it is 0x3E (ASCII >) Abort the "get an attribute" algorithm. The attribute's name is the value of attribute name, its value is the empty string. If it is in the range 0x41 (ASCII A) to 0x5A (ASCII Z) Append the Unicode character with code point b+0x20 to attribute value (where b is the value of the byte at position). Advance position to the next byte. Anything else Append the Unicode character with the same code point as the value of the byte at position) to attribute value. Advance position to the next byte. 11. Process the byte at position as follows: If it is 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), 0x20 (ASCII space), or 0x3E (ASCII >) Abort the "get an attribute" algorithm. The attribute's name is the value of attribute name and its value is the value of attribute value. If it is in the range 0x41 (ASCII A) to 0x5A (ASCII Z) Append the Unicode character with code point b+0x20 to attribute value (where b is the value of the byte at position). Anything else Append the Unicode character with the same code point as the value of the byte at position) to attribute value. 12. Advance position to the next byte and return to the previous step.
For the sake of interoperability, user agents should not use a pre-scan algorithm that returns different results than the one described above. (But, if you do, please at least let us know, so that we can improve this algorithm and benefit everyone...) 6. If the user agent has information on the likely encoding for this page, e.g. based on the encoding of the page when it was last visited, then return that encoding, with the confidence p622 tentative, and abort these steps. The user agent may attempt to autodetect the character encoding from applying frequency analysis or other algorithms to the data stream. Such algorithms may use information about the resource other than the resource's contents, including the address of the resource. If autodetection succeeds in determining a character encoding, then return that encoding, with the confidence p622 tentative, and abort these steps. [UNIVCHARDET] p785 Note: The UTF-8 encoding has a highly detectable bit pattern. Documents that contain bytes with values greater than 0x7F which match the UTF-8 pattern are very likely to be UTF-8, while documents with byte sequences that do not match it are very likely not. User-agents are therefore encouraged to search for this common encoding. [PPUTF8] p783 [UTF8DET] p785 8. Otherwise, return an implementation-defined or user-specified default character encoding, with the confidence p622 tentative. In controlled environments or in environments where the encoding of documents can be prescribed (for example, for user agents intended for dedicated use in new networks), the comprehensive UTF-8 encoding is suggested. In other environments, the default encoding is typically dependent on the user's locale (an approximation of the languages, and thus often encodings, of the pages that the user is likely to frequent). The following table gives suggested defaults based on the user's locale, for compatibility with legacy content. Locales are identified by BCP 47 language tags. [BCP47] p781
Locale language Suggested default encoding ar be bg cs cy fa he UTF-8 ISO-8859-5 windows-1251 ISO-8859-2 UTF-8 UTF-8 windows-1255
7.
625
Locale language Suggested default encoding hr hu ja kk ko ku lt lv mk or pl ro ru sk sl sr th tr uk vi zh-CN zh-TW All other locales UTF-8 ISO-8859-2 Windows-31J UTF-8 windows-949 windows-1254 windows-1257 ISO-8859-13 UTF-8 UTF-8 ISO-8859-2 UTF-8 windows-1251 windows-1250 ISO-8859-2 UTF-8 windows-874 windows-1254 windows-1251 UTF-8 GB18030 Big5 windows-1252
The document's character encoding p81 must immediately be set to the value returned from this algorithm, at the same time as the user agent uses the returned value to select the decoder to use for the input stream. Note: This algorithm is a willful violation p18 of the HTTP specification, which requires that the encoding be assumed to be ISO-8859-1 in the absence of a character encoding declaration p129 to the contrary, and of RFC 2046, which requires that the encoding be assumed to be US-ASCII in the absence of a character encoding declaration p129 to the contrary. This specification's third approach is motivated by a desire to be maximally compatible with legacy content. [HTTP] p782 [RFC2046] p784
10.2.2.2 Character encodings User agents must at a minimum support the UTF-8 and Windows-1252 encodings, but may support more. [RFC3629] p784 [WIN1252] p786 Note: It is not unusual for Web browsers to support dozens if not upwards of a hundred distinct character encodings. User agents must support the preferred MIME name p30 of every character encoding they support, and should support all the IANA-registered names and aliases of every character encoding they support. [IANACHARSET] p782 When comparing a string specifying a character encoding with the name or alias of a character encoding to determine if they are equal, user agents must remove any leading or trailing space characters p37 in both names, and then perform the comparison in an ASCII case-insensitive p36 manner. When a user agent would otherwise use an encoding given in the first column of the following table to either convert content to Unicode characters or convert Unicode characters to bytes, it must instead use the encoding given in the cell in the second column of the same row. When a byte or sequence of bytes is treated differently due to this encoding aliasing, it is said to have been misinterpreted for compatibility.
Character encoding overrides Input encoding Replacement encoding EUC-KR EUC-JP GB2312 GB_2312-80 ISO-8859-1 ISO-8859-9 ISO-8859-11 windows-949 CP51932 GBK GBK windows-1252 windows-1254 windows-874 References [EUCKR] p782 [WIN949] p786 [EUCJP] p782 [CP51932] p781 [RFC1345] p783 [GBK] p782 [RFC1345] p783 [GBK] p782 [RFC1345] p783 [WIN1252] p786 [RFC1345] p783 [WIN1254] p786 [ISO885911] p783 [WIN874] p786 [RFC1345] p783 [WIN949] p786
KS_C_5601-1987 windows-949
626
Input encoding Replacement encoding Shift_JIS TIS-620 US-ASCII Windows-31J windows-874 windows-1252
References [SHIFTJIS] p785 [WIN31J] p786 [TIS620] p785 [WIN874] p786 [RFC1345] p783 [WIN1252] p786
Note: The requirement to treat certain encodings as other encodings according to the table above is a willful violation p18 of the W3C Character Model specification, motivated by a desire for compatibility with legacy content. [CHARMOD] p781 When a user agent is to use the UTF-16 encoding but no BOM has been found, user agents must default to UTF-16LE. Note: The requirement to default UTF-16 to LE rather than BE is a willful violation p18 of RFC 2781, motivated by a desire for compatibility with legacy content. [RFC2781] p784
User agents must not support the CESU-8, UTF-7, BOCU-1 and SCSU encodings. [CESU8] p781 [UTF7] p785 [BOCU1] p781 [SCSU] p785 Support for encodings based on EBCDIC is not recommended. This encoding is rarely used for publicly-facing Web content. Support for UTF-32 is not recommended. This encoding is rarely used, and frequently implemented incorrectly. Note: This specification does not make any attempt to support EBCDIC-based encodings and UTF-32 in its algorithms; support and use of these encodings can thus lead to unexpected behavior in implementations of this specification.
10.2.2.3 Preprocessing the input stream Given an encoding, the bytes in the input stream must be converted to Unicode characters for the tokenizer, as described by the rules for that encoding, except that the leading U+FEFF BYTE ORDER MARK character, if any, must not be stripped by the encoding layer (it is stripped by the rule below). Bytes or sequences of bytes in the original byte stream that could not be converted to Unicode code points must be converted to U+FFFD REPLACEMENT CHARACTERs. Specifically, if the encoding is UTF-8, the bytes must be decoded with the error handling p36 defined in this specification. Note: Bytes or sequences of bytes in the original byte stream that did not conform to the encoding specification (e.g. invalid UTF-8 byte sequences in a UTF-8 input stream) are errors that conformance checkers are expected to report. Any byte or sequence of bytes in the original byte stream that is misinterpreted for compatibility p626 is a parse error p620 . One leading U+FEFF BYTE ORDER MARK character must be ignored if any are present. Note: The requirement to strip a U+FEFF BYTE ORDER MARK character regardless of whether that character was used to determine the byte order is a willful violation p18 of Unicode, motivated by a desire to increase the resilience of user agents in the face of nave transcoders. Code points in the range U+D800 to U+DFFF in the input must be replaced by U+FFFD REPLACEMENT CHARACTERs. Any occurrences of such characters and code points are parse errors p620 . Any occurrences of any characters in the ranges U+0001 to U+0008, U+000E to U+001F, U+007F to U+009F, U+FDD0 to U+FDEF, and characters U+000B, U+FFFE, U+FFFF, U+1FFFE, U+1FFFF, U+2FFFE, U+2FFFF, U+3FFFE, U+3FFFF, U+4FFFE, U+4FFFF, U+5FFFE, U+5FFFF, U+6FFFE, U+6FFFF, U+7FFFE, U+7FFFF, U+8FFFE, U+8FFFF, U+9FFFE, U+9FFFF, U+AFFFE, U+AFFFF, U+BFFFE, U+BFFFF, U+CFFFE, U+CFFFF, U+DFFFE, U+DFFFF, U+EFFFE, U+EFFFF, U+FFFFE, U+FFFFF, U+10FFFE, and U+10FFFF are parse errors p620 . These are all control characters or permanently undefined Unicode characters (noncharacters). U+000D CARRIAGE RETURN (CR) characters and U+000A LINE FEED (LF) characters are treated specially. Any CR characters that are followed by LF characters must be removed, and any CR characters not followed by LF characters must be converted to LF characters. Thus, newlines in HTML DOMs are represented by LF characters, and there are never any CR characters in the input to the tokenization p632 stage.
627
The next input character is the first character in the input stream that has not yet been consumed. Initially, the next input character p628 is the first character in the input. The current input character is the last character to have been consumed p628 . The insertion point is the position (just before a character or just before the end of the input stream) where content inserted using document.write() p112 is actually inserted. The insertion point is relative to the position of the character immediately after it, it is not an absolute offset into the input stream. Initially, the insertion point is undefined. The "EOF" character in the tables below is a conceptual character representing the end of the input stream p621 . If the parser is a script-created parser p110 , then the end of the input stream p621 is reached when an explicit "EOF" character (inserted by the document.close() p111 method) is consumed. Otherwise, the "EOF" character is not a real character in the stream, but rather the lack of any further characters.
10.2.2.4 Changing the encoding while parsing When the parser requires the user agent to change the encoding, it must run the following steps. This might happen if the encoding sniffing algorithm p622 described above failed to find an encoding, or if it found an encoding that was not the actual encoding of the file. 1. If the new encoding is identical or equivalent to the encoding that is already being used to interpret the input stream, then set the confidence p622 to certain and abort these steps. This happens when the encoding information found in the file matches what the encoding sniffing algorithm p622 determined to be the encoding, and in the second pass through the parser if the first pass found that the encoding sniffing algorithm described in the earlier section failed to find the right encoding. If the encoding that is already being used to interpret the input stream is a UTF-16 encoding, then set the confidence p622 to certain and abort these steps. The new encoding is ignored; if it was anything but the same encoding, then it would be clearly incorrect. If the new encoding is a UTF-16 encoding, change it to UTF-8. If all the bytes up to the last byte converted by the current decoder have the same Unicode interpretations in both the current encoding and the new encoding, and if the user agent supports changing the converter on the fly, then the user agent may change to the new converter for the encoding on the fly. Set the document's character encoding p81 and the encoding used to convert the input stream to the new encoding, set the confidence p622 to certain, and abort these steps. Otherwise, navigate p520 to the document again, with replacement enabled p528 , and using the same source browsing context p520 , but this time skip the encoding sniffing algorithm p622 and instead just set the encoding to the new encoding and the confidence p622 to certain. Whenever possible, this should be done without actually contacting the network layer (the bytes should be re-parsed from memory), even if, e.g., the document is marked as not being cacheable. If this is not possible and contacting the network layer would involve repeating a request that uses a method other than HTTP GET (or equivalent p61 for non-HTTP URLs), then instead set the confidence p622 to certain and ignore the new encoding. The resource will be misinterpreted. User agents may notify the user of the situation, to aid in application development.
2.
3. 4.
5.
628
When the steps below require the UA to reset the insertion mode appropriately, it means the UA must follow these steps: 1. 2. 3. Let last be false. Let node be the last node in the stack of open elements p629 . Loop: If node is the first node in the stack of open elements, then set last to true and set node to the context element. (fragment case p696 ) If node is a select p387 element, then switch the insertion mode p628 to "in select p681 " and abort these steps. (fragment case p696 ) If node is a td p332 or th p332 element and last is false, then switch the insertion mode p628 to "in cell p680 " and abort these steps. If node is a tr p331 element, then switch the insertion mode p628 to "in row p679 " and abort these steps. If node is a tbody p328 , thead p329 , or tfoot p330 element, then switch the insertion mode p628 to "in table body p678 " and abort these steps. If node is a caption p327 element, then switch the insertion mode p628 to "in caption p677 " and abort these steps. If node is a colgroup p328 element, then switch the insertion mode p628 to "in column group p678 " and abort these steps. (fragment case p696 ) If node is a table p320 element, then switch the insertion mode p628 to "in table p676 " and abort these steps. If node is a head p116 element, then switch the insertion mode p628 to "in body p665 " ("in body p665 "! not "in head p662 "!) and abort these steps. (fragment case p696 ) If node is a body p142 element, then switch the insertion mode p628 to "in body p665 " and abort these steps. If node is a frameset p747 element, then switch the insertion mode p628 to "in frameset p685 " and abort these steps. (fragment case p696 ) If node is an html p116 element, then switch the insertion mode p628 to "before head p662 " Then, abort these steps. (fragment case p696 ) If node is an element from the MathML namespace p75 or the SVG namespace p75 , then switch the insertion mode p628 to "in foreign content p682 " and abort these steps. If last is true, then switch the insertion mode p628 to "in body p665 " and abort these steps. (fragment case p696 ) Let node now be the node before node in the stack of open elements p629 . Return to the step labeled loop.
4.
5.
6. 7.
8.
9.
10. 11.
12. 13.
14.
15.
16.
17. 18.
10.2.3.2 The stack of open elements Initially, the stack of open elements is empty. The stack grows downwards; the topmost node on the stack is the first one added to the stack, and the bottommost node of the stack is the most recently added node in the stack (notwithstanding when the stack is manipulated in a random access fashion as part of the handling for misnested tags p669 ). The "before html p661 " insertion mode p628 creates the html p116 root element node, which is then added to the stack. In the fragment case p696 , the stack of open elements p629 is initialized to contain an html p116 element that is created as part of that algorithm p696 . (The fragment case p696 skips the "before html p661 " insertion mode p628 .) The html p116 node, however it is created, is the topmost node of the stack. It only gets popped off the stack when the parser finishes p687 . The current node is the bottommost node in this stack. The current table is the last table p320 element in the stack of open elements p629 , if there is one. If there is no table p320 element in the stack of open elements p629 (fragment case p696 ), then the current table p629 is the first element in the stack of open elements p629 (the html p116 element). Elements in the stack fall into the following categories:
629
Special The following elements have varying levels of special parsing rules: HTML's address p154 , applet p744 , area p314 , article p147 , aside p148 , base p118 , basefont p740 , bgsound p740 , blockquote p163 , body p142 , br p194 , button p385 , caption p327 , center p740 , col p328 , colgroup p328 , command p427 , dd p170 , details p423 , dir p740 , div p172 , dl p168 , dt p169 , embed p220 , fieldset p350 , figcaption p172 , figure p170 , footer p153 , form p347 , frame p747 , frameset p747 , h1 p150 , h2 p150 , h3 p150 , h4 p150 , h5 p150 , h6 p150 , head p116 , header p152 , hgroup p151 , hr p161 , html p116 , iframe p213 , img p199 , input p353 , isindex p740 , li p166 , link p119 , listing p740 , marquee p745 , menu p428 , meta p122 , nav p145 , noembed p740 , noframes p740 , noscript p140 , object p222 , ol p164 , p p160 , param p227 , plaintext p740 , pre p162 , script p133 , section p144 , select p387 , style p130 , summary p426 , table p320 , tbody p328 , td p332 , textarea p395 , tfoot p330 , th p332 , thead p329 , title p117 , tr p331 , ul p166 , wbr p195 , and xmp p740 ; MathML's mi, mo, mn, ms, mtext, and annotation-xml; and SVG's foreignObject, desc, and title. Formatting The following HTML elements are those that end up in the list of active formatting elements p631 : a p173 , b p188 , big p740 , code p184 , em p175 , font p740 , i p187 , nobr p740 , s p177 , small p176 , strike p740 , strong p176 , tt p740 , and u p740 . Ordinary All other elements found while parsing an HTML document. The stack of open elements p629 is said to have an element in a specific scope consisting of a list of element types list when the following algorithm terminates in a match state: 1. 2. 3. 4. Initialize node to be the current node p629 (the bottommost node of the stack). If node is the target node, terminate in a match state. Otherwise, if node is one of the element types in list, terminate in a failure state. Otherwise, set node to the previous entry in the stack of open elements p629 and return to step 2. (This will never fail, since the loop will always terminate in the previous step if the top of the stack an html p116 element is reached.)
The stack of open elements p629 is said to have an element in scope when it has an element in the specific scope p630 consisting of the following element types: applet p744 in the HTML namespace p75 caption p327 in the HTML namespace p75 html p116 in the HTML namespace p75 table p320 in the HTML namespace p75 td p332 in the HTML namespace p75 th p332 in the HTML namespace p75 marquee p745 in the HTML namespace p75 object p222 in the HTML namespace p75 mi in the MathML namespace p75 mo in the MathML namespace p75 mn in the MathML namespace p75 ms in the MathML namespace p75 mtext in the MathML namespace p75 annotation-xml in the MathML namespace p75 foreignObject in the SVG namespace p75 desc in the SVG namespace p75 title in the SVG namespace p75
The stack of open elements p629 is said to have an element in list item scope when it has an element in the specific scope p630 consisting of the following element types: All the element types listed above for the has an element in scope p630 algorithm. ol p164 in the HTML namespace p75 ul p166 in the HTML namespace p75
The stack of open elements p629 is said to have an element in button scope when it has an element in the specific scope p630 consisting of the following element types: All the element types listed above for the has an element in scope p630 algorithm. button p385 in the HTML namespace p75
The stack of open elements p629 is said to have an element in table scope when it has an element in the specific scope p630 consisting of the following element types: html p116 in the HTML namespace p75 table p320 in the HTML namespace p75
The stack of open elements p629 is said to have an element in select scope when it has an element in the specific scope p630 consisting of all element types except the following:
630
optgroup p392 in the HTML namespace p75 option p393 in the HTML namespace p75
Nothing happens if at any time any of the elements in the stack of open elements p629 are moved to a new location in, or removed from, the Document p33 tree. In particular, the stack is not changed in this situation. This can cause, amongst other strange effects, content to be appended to nodes that are no longer in the DOM. Note: In some cases (namely, when closing misnested formatting elements p669 ), the stack is manipulated in a random-access fashion.
10.2.3.3 The list of active formatting elements Initially, the list of active formatting elements is empty. It is used to handle mis-nested formatting element tags p630 . The list contains elements in the formatting p630 category, and scope markers. The scope markers are inserted when entering applet p744 elements, buttons, object p222 elements, marquees, table cells, and table captions, and are used to prevent formatting from "leaking" into applet p744 elements, buttons, object p222 elements, marquees, and tables. Note: The scope markers are unrelated to the concept of an element being in scope p630 . In addition, each element in the list of active formatting elements p631 is associated with the token for which it was created, so that further elements can be created for that token if necessary. When the steps below require the UA to push onto the list of active formatting elements an element element, the UA must perform the following steps: 1. If there are already three elements in the list of active formatting elements p631 after the last list marker, if any, or anywhere in the list if there are no list markers, that have the same tag name, namespace, and attributes as element, then remove the earliest such element from the list of active formatting elements p631 . For these purposes, the attributes must be compared as they were when the elements were created by the parser; two elements have the same attributes if all their parsed attributes can be paired such that the two attributes in each pair have identical names, namespaces, and values (the order of the attributes does not matter). Note: This is the Noah's Ark clause. But with three per family instead of two. 2. Add element to the list of active formatting elements p631 .
When the steps below require the UA to reconstruct the active formatting elements, the UA must perform the following steps: 1. If there are no entries in the list of active formatting elements p631 , then there is nothing to reconstruct; stop this algorithm. If the last (most recently added) entry in the list of active formatting elements p631 is a marker, or if it is an element that is in the stack of open elements p629 , then there is nothing to reconstruct; stop this algorithm. Let entry be the last (most recently added) element in the list of active formatting elements p631 . If there are no entries before entry in the list of active formatting elements p631 , then jump to step 8. Let entry be the entry one earlier than entry in the list of active formatting elements p631 . If entry is neither a marker nor an element that is also in the stack of open elements p629 , go to step 4. Let entry be the element one later than entry in the list of active formatting elements p631 . Create an element for the token p657 for which the element entry was created, to obtain new element. Append new element to the current node p629 and push it onto the stack of open elements p629 so that it is the new current node p629 . Replace the entry for entry in the list with an entry for new element. If the entry for new element in the list of active formatting elements p631 is not the last entry in the list, return to step 7.
2.
3. 4. 5. 6. 7. 8. 9.
10. 11.
This has the effect of reopening all the formatting elements that were opened in the current body, cell, or caption (whichever is youngest) that haven't been explicitly closed.
631
Note: The way this specification is written, the list of active formatting elements p631 always consists of elements in chronological order with the least recently added element first and the most recently added element last (except for while steps 8 to 11 of the above algorithm are being executed, of course). When the steps below require the UA to clear the list of active formatting elements up to the last marker, the UA must perform the following steps: 1. 2. 3. Let entry be the last (most recently added) entry in the list of active formatting elements p631 . Remove entry from the list of active formatting elements p631 . If entry was a marker, then stop the algorithm at this point. The list has been cleared up to the last marker. Go to step 1.
4.
10.2.3.4 The element pointers Initially, the head element pointer and the form element pointer are both null. Once a head p116 element has been parsed (whether implicitly or explicitly) the head element pointer p632 gets set to point to this node. The form element pointer p632 points to the last form p347 element that was opened and whose end tag has not yet been seen. It is used to make form controls associate with forms in the face of dramatically bad markup, for historical reasons.
10.2.3.5 Other parsing state flags The scripting flag is set to "enabled" if scripting was enabled p550 for the Document p33 with which the parser is associated when the parser was created, and "disabled" otherwise. Note: The scripting flag p632 can be enabled even when the parser was originally created for the HTML fragment parsing algorithm p696 , even though script p133 elements don't execute in that case. The frameset-ok flag is set to "ok" when the parser is created. It is set to "not ok" after certain tokens are seen.
10.2.4 Tokenization
Implementations must act as if they used the following state machine to tokenize HTML. The state machine must start in the data state p633 . Most states consume a single character, which may have various side-effects, and either switches the state machine to a new state to reconsume the same character, or switches it to a new state (to consume the next character), or repeats the same state (to consume the next character). Some states have more complicated behavior and can consume several characters before switching to another state. In some cases, the tokenizer state is also changed by the tree construction stage. The exact behavior of certain states depends on the insertion mode p628 and the stack of open elements p629 . Certain states also use a temporary buffer to track progress. The output of the tokenization step is a series of zero or more of the following tokens: DOCTYPE, start tag, end tag, comment, character, end-of-file. DOCTYPE tokens have a name, a public identifier, a system identifier, and a forcequirks flag. When a DOCTYPE token is created, its name, public identifier, and system identifier must be marked as missing (which is a distinct state from the empty string), and the force-quirks flag must be set to off (its other state is on). Start and end tag tokens have a tag name, a self-closing flag, and a list of attributes, each of which has a name and a value. When a start or end tag token is created, its self-closing flag must be unset (its other state is that it be set), and its attributes list must be empty. Comment and character tokens have data. When a token is emitted, it must immediately be handled by the tree construction p656 stage. The tree construction stage can affect the state of the tokenization stage, and can insert additional characters into the stream. (For example, the script p133 element can result in scripts executing and using the dynamic markup insertion p109 APIs to insert characters into the stream being tokenized.) When a start tag token is emitted with its self-closing flag set, if the flag is not acknowledged when it is processed by the tree construction stage, that is a parse error p620 . When an end tag token is emitted with attributes, that is a parse error p620 . When an end tag token is emitted with its self-closing flag set, that is a parse error p620 .
632
An appropriate end tag token is an end tag token whose tag name matches the tag name of the last start tag to have been emitted from this tokenizer, if any. If no start tag has been emitted from this tokenizer, then no end tag token is appropriate. Before each step of the tokenizer, the user agent must first check the parser pause flag p621 . If it is true, then the tokenizer must abort the processing of any nested invocations of the tokenizer, yielding control back to the caller. The tokenizer state machine consists of the states defined in the following subsections.
10.2.4.1 Data state Consume the next input character p628 : U+0026 AMPERSAND (&) Switch to the character reference in data state p633 . U+003C LESS-THAN SIGN (<) Switch to the tag open state p634 . U+0000 NULL Parse error p620 . Emit the current input character p628 as a character token. EOF Emit an end-of-file token. Anything else Emit the current input character p628 as a character token.
10.2.4.2 Character reference in data state Attempt to consume a character reference p654 , with no additional allowed character p654 . If nothing is returned, emit a U+0026 AMPERSAND character (&) token. Otherwise, emit the character token that was returned. Finally, switch to the data state p633 .
10.2.4.3 RCDATA state Consume the next input character p628 : U+0026 AMPERSAND (&) Switch to the character reference in RCDATA state p633 . U+003C LESS-THAN SIGN (<) Switch to the RCDATA less-than sign state p635 . U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Emit an end-of-file token. Anything else Emit the current input character p628 as a character token.
10.2.4.4 Character reference in RCDATA state Attempt to consume a character reference p654 , with no additional allowed character p654 . If nothing is returned, emit a U+0026 AMPERSAND character (&) token. Otherwise, emit the character token that was returned. Finally, switch to the RCDATA state p633 .
633
U+003C LESS-THAN SIGN (<) Switch to the RAWTEXT less-than sign state p636 . U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Emit an end-of-file token. Anything else Emit the current input character p628 as a character token.
10.2.4.6 Script data state Consume the next input character p628 : U+003C LESS-THAN SIGN (<) Switch to the script data less-than sign state p637 . U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Emit an end-of-file token. Anything else Emit the current input character p628 as a character token.
10.2.4.7 PLAINTEXT state Consume the next input character p628 : U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Emit an end-of-file token. Anything else Emit the current input character p628 as a character token.
10.2.4.8 Tag open state Consume the next input character p628 : U+0021 EXCLAMATION MARK (!) Switch to the markup declaration open state p646 . U+002F SOLIDUS (/) Switch to the end tag open state p634 . U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new start tag token, set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point), then switch to the tag name state p635 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new start tag token, set its tag name to the current input character p628 , then switch to the tag name state p635 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+003F QUESTION MARK (?) Parse error p620 . Switch to the bogus comment state p646 . Anything else Parse error p620 . Emit a U+003C LESS-THAN SIGN character token and reconsume the current input character p628 in the data state p633 .
10.2.4.9 End tag open state Consume the next input character p628 :
634
U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new end tag token, set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point), then switch to the tag name state p635 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new end tag token, set its tag name to the current input character p628 , then switch to the tag name state p635 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+003E GREATER-THAN SIGN (>) Parse error p620 . Switch to the data state p633 . EOF Parse error p620 . Emit a U+003C LESS-THAN SIGN character token and a U+002F SOLIDUS character token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Switch to the bogus comment state p646 .
10.2.4.10 Tag name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before attribute name state p642 . U+002F SOLIDUS (/) Switch to the self-closing start tag state p646 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current tag token's tag name. U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current tag token's tag name. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current tag token's tag name.
10.2.4.11 RCDATA less-than sign state Consume the next input character p628 : U+002F SOLIDUS (/) Set the temporary buffer p632 to the empty string. Switch to the RCDATA end tag open state p635 . Anything else Emit a U+003C LESS-THAN SIGN character token and reconsume the current input character p628 in the RCDATA state p633 .
10.2.4.12 RCDATA end tag open state Consume the next input character p628 : U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new end tag token, and set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point). Append the current input character p628 to the temporary buffer p632 . Finally, switch to the RCDATA end tag name state p636 . (Don't emit the token yet; further details will be filled in before it is emitted.)
635
U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new end tag token, and set its tag name to the current input character p628 . Append the current input character p628 to the temporary buffer p632 . Finally, switch to the RCDATA end tag name state p636 . (Don't emit the token yet; further details will be filled in before it is emitted.) Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, and reconsume the current input character p628 in the RCDATA state p633 .
10.2.4.13 RCDATA end tag name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE If the current end tag token is an appropriate end tag token p633 , then switch to the before attribute name state p642 . Otherwise, treat it as per the "anything else" entry below. U+002F SOLIDUS (/) If the current end tag token is an appropriate end tag token p633 , then switch to the self-closing start tag state p646 . Otherwise, treat it as per the "anything else" entry below. U+003E GREATER-THAN SIGN (>) If the current end tag token is an appropriate end tag token p633 , then emit the current tag token and switch to the data state p633 . Otherwise, treat it as per the "anything else" entry below. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, a character token for each of the characters in the temporary buffer p632 (in the order they were added to the buffer), and reconsume the current input character p628 in the RCDATA state p633 .
10.2.4.14 RAWTEXT less-than sign state Consume the next input character p628 : U+002F SOLIDUS (/) Set the temporary buffer p632 to the empty string. Switch to the RAWTEXT end tag open state p636 . Anything else Emit a U+003C LESS-THAN SIGN character token and reconsume the current input character p628 in the RAWTEXT state p633 .
10.2.4.15 RAWTEXT end tag open state Consume the next input character p628 : U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new end tag token, and set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point). Append the current input character p628 to the temporary buffer p632 . Finally, switch to the RAWTEXT end tag name state p637 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new end tag token, and set its tag name to the current input character p628 . Append the current input character p628 to the temporary buffer p632 . Finally, switch to the RAWTEXT end tag name state p637 . (Don't emit the token yet; further details will be filled in before it is emitted.)
636
Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, and reconsume the current input character p628 in the RAWTEXT state p633 .
10.2.4.16 RAWTEXT end tag name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE If the current end tag token is an appropriate end tag token p633 , then switch to the before attribute name state p642 . Otherwise, treat it as per the "anything else" entry below. U+002F SOLIDUS (/) If the current end tag token is an appropriate end tag token p633 , then switch to the self-closing start tag state p646 . Otherwise, treat it as per the "anything else" entry below. U+003E GREATER-THAN SIGN (>) If the current end tag token is an appropriate end tag token p633 , then emit the current tag token and switch to the data state p633 . Otherwise, treat it as per the "anything else" entry below. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, a character token for each of the characters in the temporary buffer p632 (in the order they were added to the buffer), and reconsume the current input character p628 in the RAWTEXT state p633 .
10.2.4.17 Script data less-than sign state Consume the next input character p628 : U+002F SOLIDUS (/) Set the temporary buffer p632 to the empty string. Switch to the script data end tag open state p637 . U+0021 EXCLAMATION MARK (!) Switch to the script data escape start state p638 . Emit a U+003C LESS-THAN SIGN character token and a U+0021 EXCLAMATION MARK character token. Anything else Emit a U+003C LESS-THAN SIGN character token and reconsume the current input character p628 in the script data state p634 .
10.2.4.18 Script data end tag open state Consume the next input character p628 : U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new end tag token, and set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point). Append the current input character p628 to the temporary buffer p632 . Finally, switch to the script data end tag name state p638 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new end tag token, and set its tag name to the current input character p628 . Append the current input character p628 to the temporary buffer p632 . Finally, switch to the script data end tag name state p638 . (Don't emit the token yet; further details will be filled in before it is emitted.) Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, and reconsume the current input character p628 in the script data state p634 .
637
10.2.4.19 Script data end tag name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE If the current end tag token is an appropriate end tag token p633 , then switch to the before attribute name state p642 . Otherwise, treat it as per the "anything else" entry below. U+002F SOLIDUS (/) If the current end tag token is an appropriate end tag token p633 , then switch to the self-closing start tag state p646 . Otherwise, treat it as per the "anything else" entry below. U+003E GREATER-THAN SIGN (>) If the current end tag token is an appropriate end tag token p633 , then emit the current tag token and switch to the data state p633 . Otherwise, treat it as per the "anything else" entry below. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, a character token for each of the characters in the temporary buffer p632 (in the order they were added to the buffer), and reconsume the current input character p628 in the script data state p634 .
10.2.4.20 Script data escape start state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data escape start dash state p638 . Emit a U+002D HYPHEN-MINUS character token. Anything else Reconsume the current input character p628 in the script data state p634 .
10.2.4.21 Script data escape start dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data escaped dash dash state p639 . Emit a U+002D HYPHEN-MINUS character token. Anything else Reconsume the current input character p628 in the script data state p634 .
10.2.4.22 Script data escaped state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data escaped dash state p639 . Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data escaped less-than sign state p639 . U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Emit the current input character p628 as a character token.
638
10.2.4.23 Script data escaped dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data escaped dash dash state p639 . Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data escaped less-than sign state p639 . U+0000 NULL Parse error p620 . Switch to the script data escaped state p638 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Switch to the script data escaped state p638 . Emit the current input character p628 as a character token.
10.2.4.24 Script data escaped dash dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data escaped less-than sign state p639 . U+003E GREATER-THAN SIGN (>) Switch to the script data state p634 . Emit a U+003E GREATER-THAN SIGN character token. U+0000 NULL Parse error p620 . Switch to the script data escaped state p638 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Switch to the script data escaped state p638 . Emit the current input character p628 as a character token.
10.2.4.25 Script data escaped less-than sign state Consume the next input character p628 : U+002F SOLIDUS (/) Set the temporary buffer p632 to the empty string. Switch to the script data escaped end tag open state p639 . U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Set the temporary buffer p632 to the empty string. Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the temporary buffer p632 . Switch to the script data double escape start state p640 . Emit a U+003C LESS-THAN SIGN character token and the current input character p628 as a character token. U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Set the temporary buffer p632 to the empty string. Append the current input character p628 to the temporary buffer p632 . Switch to the script data double escape start state p640 . Emit a U+003C LESS-THAN SIGN character token and the current input character p628 as a character token. Anything else Emit a U+003C LESS-THAN SIGN character token and reconsume the current input character p628 in the script data escaped state p638 .
10.2.4.26 Script data escaped end tag open state Consume the next input character p628 :
639
U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new end tag token, and set its tag name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point). Append the current input character p628 to the temporary buffer p632 . Finally, switch to the script data escaped end tag name state p640 . (Don't emit the token yet; further details will be filled in before it is emitted.) U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Create a new end tag token, and set its tag name to the current input character p628 . Append the current input character p628 to the temporary buffer p632 . Finally, switch to the script data escaped end tag name state p640 . (Don't emit the token yet; further details will be filled in before it is emitted.) Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, and reconsume the current input character p628 in the script data escaped state p638 .
10.2.4.27 Script data escaped end tag name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE If the current end tag token is an appropriate end tag token p633 , then switch to the before attribute name state p642 . Otherwise, treat it as per the "anything else" entry below. U+002F SOLIDUS (/) If the current end tag token is an appropriate end tag token p633 , then switch to the self-closing start tag state p646 . Otherwise, treat it as per the "anything else" entry below. U+003E GREATER-THAN SIGN (>) If the current end tag token is an appropriate end tag token p633 , then emit the current tag token and switch to the data state p633 . Otherwise, treat it as per the "anything else" entry below. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the current tag token's tag name. Append the current input character p628 to the temporary buffer p632 . Anything else Emit a U+003C LESS-THAN SIGN character token, a U+002F SOLIDUS character token, a character token for each of the characters in the temporary buffer p632 (in the order they were added to the buffer), and reconsume the current input character p628 in the script data escaped state p638 .
10.2.4.28 Script data double escape start state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE U+002F SOLIDUS (/) U+003E GREATER-THAN SIGN (>) If the temporary buffer p632 is the string "script", then switch to the script data double escaped state p641 . Otherwise, switch to the script data escaped state p638 . Emit the current input character p628 as a character token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the temporary buffer p632 . Emit the current input character p628 as a character token. U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the temporary buffer p632 . Emit the current input character p628 as a character token.
640
Anything else Reconsume the current input character p628 in the script data escaped state p638 .
10.2.4.29 Script data double escaped state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data double escaped dash state p641 . Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data double escaped less-than sign state p642 . Emit a U+003C LESS-THAN SIGN character token. U+0000 NULL Parse error p620 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Emit the current input character p628 as a character token.
10.2.4.30 Script data double escaped dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the script data double escaped dash dash state p641 . Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data double escaped less-than sign state p642 . Emit a U+003C LESS-THAN SIGN character token. U+0000 NULL Parse error p620 . Switch to the script data double escaped state p641 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Switch to the script data double escaped state p641 . Emit the current input character p628 as a character token.
10.2.4.31 Script data double escaped dash dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Emit a U+002D HYPHEN-MINUS character token. U+003C LESS-THAN SIGN (<) Switch to the script data double escaped less-than sign state p642 . Emit a U+003C LESS-THAN SIGN character token. U+003E GREATER-THAN SIGN (>) Switch to the script data state p634 . Emit a U+003E GREATER-THAN SIGN character token. U+0000 NULL Parse error p620 . Switch to the script data double escaped state p641 . Emit a U+FFFD REPLACEMENT CHARACTER character token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Switch to the script data double escaped state p641 . Emit the current input character p628 as a character token.
641
10.2.4.32 Script data double escaped less-than sign state Consume the next input character p628 : U+002F SOLIDUS (/) Set the temporary buffer p632 to the empty string. Switch to the script data double escape end state p642 . Emit a U+002F SOLIDUS character token. Anything else Reconsume the current input character p628 in the script data double escaped state p641 .
10.2.4.33 Script data double escape end state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE U+002F SOLIDUS (/) U+003E GREATER-THAN SIGN (>) If the temporary buffer p632 is the string "script", then switch to the script data escaped state p638 . Otherwise, switch to the script data double escaped state p641 . Emit the current input character p628 as a character token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the temporary buffer p632 . Emit the current input character p628 as a character token. U+0061 LATIN SMALL LETTER A through to U+007A LATIN SMALL LETTER Z Append the current input character p628 to the temporary buffer p632 . Emit the current input character p628 as a character token. Anything else Reconsume the current input character p628 in the script data double escaped state p641 .
10.2.4.34 Before attribute name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+002F SOLIDUS (/) Switch to the self-closing start tag state p646 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Start a new attribute in the current tag token. Set that attribute's name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point), and its value to the empty string. Switch to the attribute name state p643 . U+0000 NULL Parse error p620 . Start a new attribute in the current tag token. Set that attribute's name to a U+FFFD REPLACEMENT CHARACTER character, and its value to the empty string. Switch to the attribute name state p643 . U+0022 QUOTATION MARK (") U+0027 APOSTROPHE (') U+003C LESS-THAN SIGN (<) U+003D EQUALS SIGN (=) Parse error p620 . Treat it as per the "anything else" entry below. EOF Parse error p620 . Reconsume the EOF character in the data state p633 .
642
Anything else Start a new attribute in the current tag token. Set that attribute's name to the current input character p628 , and its value to the empty string. Switch to the attribute name state p643 .
10.2.4.35 Attribute name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the after attribute name state p643 . U+002F SOLIDUS (/) Switch to the self-closing start tag state p646 . U+003D EQUALS SIGN (=) Switch to the before attribute value state p644 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current attribute's name. U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current attribute's name. U+0022 QUOTATION MARK (") U+0027 APOSTROPHE (') U+003C LESS-THAN SIGN (<) Parse error p620 . Treat it as per the "anything else" entry below. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current attribute's name. When the user agent leaves the attribute name state (and before emitting the tag token, if appropriate), the complete attribute's name must be compared to the other attributes on the same token; if there is already an attribute on the token with the exact same name, then this is a parse error p620 and the new attribute must be dropped, along with the value that gets associated with it (if any).
10.2.4.36 After attribute name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+002F SOLIDUS (/) Switch to the self-closing start tag state p646 . U+003D EQUALS SIGN (=) Switch to the before attribute value state p644 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Start a new attribute in the current tag token. Set that attribute's name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point), and its value to the empty string. Switch to the attribute name state p643 .
643
U+0000 NULL Parse error p620 . Start a new attribute in the current tag token. Set that attribute's name to a U+FFFD REPLACEMENT CHARACTER character, and its value to the empty string. Switch to the attribute name state p643 . U+0022 QUOTATION MARK (") U+0027 APOSTROPHE (') U+003C LESS-THAN SIGN (<) Parse error p620 . Treat it as per the "anything else" entry below. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Start a new attribute in the current tag token. Set that attribute's name to the current input character p628 , and its value to the empty string. Switch to the attribute name state p643 .
10.2.4.37 Before attribute value state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+0022 QUOTATION MARK (") Switch to the attribute value (double-quoted) state p644 . U+0026 AMPERSAND (&) Switch to the attribute value (unquoted) state p645 and reconsume this current input character p628 . U+0027 APOSTROPHE (') Switch to the attribute value (single-quoted) state p645 . U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current attribute's value. Switch to the attribute value (unquoted) state p645 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Switch to the data state p633 . Emit the current tag token. U+003C LESS-THAN SIGN (<) U+003D EQUALS SIGN (=) U+0060 GRAVE ACCENT (`) Parse error p620 . Treat it as per the "anything else" entry below. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current attribute's value. Switch to the attribute value (unquoted) state p645 .
10.2.4.38 Attribute value (double-quoted) state Consume the next input character p628 : U+0022 QUOTATION MARK (") Switch to the after attribute value (quoted) state p645 . U+0026 AMPERSAND (&) Switch to the character reference in attribute value state p645 , with the additional allowed character p654 being U+0022 QUOTATION MARK ("). U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current attribute's value. EOF Parse error p620 . Reconsume the EOF character in the data state p633 .
644
Anything else Append the current input character p628 to the current attribute's value.
10.2.4.39 Attribute value (single-quoted) state Consume the next input character p628 : U+0027 APOSTROPHE (') Switch to the after attribute value (quoted) state p645 . U+0026 AMPERSAND (&) Switch to the character reference in attribute value state p645 , with the additional allowed character p654 being U+0027 APOSTROPHE ('). EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current attribute's value.
10.2.4.40 Attribute value (unquoted) state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before attribute name state p642 . U+0026 AMPERSAND (&) Switch to the character reference in attribute value state p645 , with the additional allowed character p654 being U+003E GREATER-THAN SIGN (>). U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current attribute's value. U+0022 QUOTATION MARK (") U+0027 APOSTROPHE (') U+003C LESS-THAN SIGN (<) U+003D EQUALS SIGN (=) U+0060 GRAVE ACCENT (`) Parse error p620 . Treat it as per the "anything else" entry below. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current attribute's value.
10.2.4.41 Character reference in attribute value state Attempt to consume a character reference p654 . If nothing is returned, append a U+0026 AMPERSAND character (&) to the current attribute's value. Otherwise, append the returned character token to the current attribute's value. Finally, switch back to the attribute value state that switched into this state.
10.2.4.42 After attribute value (quoted) state Consume the next input character p628 :
645
U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before attribute name state p642 . U+002F SOLIDUS (/) Switch to the self-closing start tag state p646 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current tag token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Reconsume the character in the before attribute name state p642 .
10.2.4.43 Self-closing start tag state Consume the next input character p628 : U+003E GREATER-THAN SIGN (>) Set the self-closing flag of the current tag token. Switch to the data state p633 . Emit the current tag token. EOF Parse error p620 . Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Reconsume the character in the before attribute name state p642 .
10.2.4.44 Bogus comment state Consume every character up to and including the first U+003E GREATER-THAN SIGN character (>) or the end of the file (EOF), whichever comes first. Emit a comment token whose data is the concatenation of all the characters starting from and including the character that caused the state machine to switch into the bogus comment state, up to and including the character immediately before the last consumed character (i.e. up to the character just before the U+003E or EOF character), but with any U+0000 NULL characters replaced by U+FFFD REPLACEMENT CHARACTER characters. (If the comment was started by the end of the file (EOF), the token is empty.) Switch to the data state p633 . If the end of the file was reached, reconsume the EOF character.
10.2.4.45 Markup declaration open state If the next two characters are both U+002D HYPHEN-MINUS characters (-), consume those two characters, create a comment token whose data is the empty string, and switch to the comment start state p646 . Otherwise, if the next seven characters are an ASCII case-insensitive p36 match for the word "DOCTYPE", then consume those characters and switch to the DOCTYPE state p648 . Otherwise, if the insertion mode p628 is "in foreign content p682 " and the current node p629 is not an element in the HTML namespace p75 and the next seven characters are an case-sensitive p36 match for the string "[CDATA[" (the five uppercase letters "CDATA" with a U+005B LEFT SQUARE BRACKET character before and after), then consume those characters and switch to the CDATA section state p654 . Otherwise, this is a parse error p620 . Switch to the bogus comment state p646 . The next character that is consumed, if any, is the first character that will be in the comment.
10.2.4.46 Comment start state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the comment start dash state p647 . U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. Switch to the comment state p647 .
646
U+003E GREATER-THAN SIGN (>) Parse error p620 . Switch to the data state p633 . Emit the comment token. EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the comment token's data. Switch to the comment state p647 .
10.2.4.47 Comment start dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the comment end state p647 U+0000 NULL Parse error p620 . Append a U+002D HYPHEN-MINUS character (-) and a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. Switch to the comment state p647 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Switch to the data state p633 . Emit the comment token. EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Append a U+002D HYPHEN-MINUS character (-) and the current input character p628 to the comment token's data. Switch to the comment state p647 .
10.2.4.48 Comment state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the comment end dash state p647 U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the comment token's data.
10.2.4.49 Comment end dash state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Switch to the comment end state p647 U+0000 NULL Parse error p620 . Append a U+002D HYPHEN-MINUS character (-) and a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. Switch to the comment state p647 . EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Append a U+002D HYPHEN-MINUS character (-) and the current input character p628 to the comment token's data. Switch to the comment state p647 .
10.2.4.50 Comment end state Consume the next input character p628 : U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the comment token.
647
U+0000 NULL Parse error p620 . Append two U+002D HYPHEN-MINUS characters (-) and a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. Switch to the comment state p647 . U+0021 EXCLAMATION MARK (!) Parse error p620 . Switch to the comment end bang state p648 . U+002D HYPHEN-MINUS (-) Parse error p620 . Append a U+002D HYPHEN-MINUS character (-) to the comment token's data. EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Append two U+002D HYPHEN-MINUS characters (-) and the current input character p628 to the comment token's data. Switch to the comment state p647 .
10.2.4.51 Comment end bang state Consume the next input character p628 : U+002D HYPHEN-MINUS (-) Append two U+002D HYPHEN-MINUS characters (-) and a U+0021 EXCLAMATION MARK character (!) to the comment token's data. Switch to the comment end dash state p647 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the comment token. U+0000 NULL Parse error p620 . Append two U+002D HYPHEN-MINUS characters (-), a U+0021 EXCLAMATION MARK character (!), and a U+FFFD REPLACEMENT CHARACTER character to the comment token's data. Switch to the comment state p647 . EOF Parse error p620 . Emit the comment token. Reconsume the EOF character in the data state p633 . Anything else Append two U+002D HYPHEN-MINUS characters (-), a U+0021 EXCLAMATION MARK character (!), and the current input character p628 to the comment token's data. Switch to the comment state p647 .
10.2.4.52 DOCTYPE state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before DOCTYPE name state p648 . EOF Parse error p620 . Create a new DOCTYPE token. Set its force-quirks flag to on. Emit the token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Reconsume the character in the before DOCTYPE name state p648 .
10.2.4.53 Before DOCTYPE name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Create a new DOCTYPE token. Set the token's name to the lowercase version of the current input character p628 (add 0x0020 to the character's code point). Switch to the DOCTYPE name state p649 .
648
U+0000 NULL Parse error p620 . Set the token's name to a U+FFFD REPLACEMENT CHARACTER character. Switch to the DOCTYPE name state p649 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Create a new DOCTYPE token. Set its force-quirks flag to on. Switch to the data state p633 . Emit the token. EOF Parse error p620 . Create a new DOCTYPE token. Set its force-quirks flag to on. Emit the token. Reconsume the EOF character in the data state p633 . Anything else Create a new DOCTYPE token. Set the token's name to the current input character p628 . Switch to the DOCTYPE name state p649 .
10.2.4.54 DOCTYPE name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the after DOCTYPE name state p649 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current DOCTYPE token. U+0041 LATIN CAPITAL LETTER A through to U+005A LATIN CAPITAL LETTER Z Append the lowercase version of the current input character p628 (add 0x0020 to the character's code point) to the current DOCTYPE token's name. U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current DOCTYPE token's name. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current DOCTYPE token's name.
10.2.4.55 After DOCTYPE name state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else If the six characters starting from the current input character p628 are an ASCII case-insensitive p36 match for the word "PUBLIC", then consume those characters and switch to the after DOCTYPE public keyword state p650 . Otherwise, if the six characters starting from the current input character p628 are an ASCII caseinsensitive p36 match for the word "SYSTEM", then consume those characters and switch to the after DOCTYPE system keyword state p652 .
649
Otherwise, this is the parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.56 After DOCTYPE public keyword state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before DOCTYPE public identifier state p650 . U+0022 QUOTATION MARK (") Parse error p620 . Set the DOCTYPE token's public identifier to the empty string (not missing), then switch to the DOCTYPE public identifier (double-quoted) state p650 . U+0027 APOSTROPHE (') Parse error p620 . Set the DOCTYPE token's public identifier to the empty string (not missing), then switch to the DOCTYPE public identifier (single-quoted) state p651 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.57 Before DOCTYPE public identifier state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+0022 QUOTATION MARK (") Set the DOCTYPE token's public identifier to the empty string (not missing), then switch to the DOCTYPE public identifier (double-quoted) state p650 . U+0027 APOSTROPHE (') Set the DOCTYPE token's public identifier to the empty string (not missing), then switch to the DOCTYPE public identifier (single-quoted) state p651 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.58 DOCTYPE public identifier (double-quoted) state Consume the next input character p628 : U+0022 QUOTATION MARK (") Switch to the after DOCTYPE public identifier state p651 .
650
U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current DOCTYPE token's public identifier. U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current DOCTYPE token's public identifier.
10.2.4.59 DOCTYPE public identifier (single-quoted) state Consume the next input character p628 : U+0027 APOSTROPHE (') Switch to the after DOCTYPE public identifier state p651 . U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current DOCTYPE token's public identifier. U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current DOCTYPE token's public identifier.
10.2.4.60 After DOCTYPE public identifier state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the between DOCTYPE public and system identifiers state p651 . U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current DOCTYPE token. U+0022 QUOTATION MARK (") Parse error p620 . Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (double-quoted) state p653 . U+0027 APOSTROPHE (') Parse error p620 . Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (single-quoted) state p653 . EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.61 Between DOCTYPE public and system identifiers state Consume the next input character p628 :
651
U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current DOCTYPE token. U+0022 QUOTATION MARK (") Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (double-quoted) state p653 . U+0027 APOSTROPHE (') Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (single-quoted) state p653 . EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.62 After DOCTYPE system keyword state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Switch to the before DOCTYPE system identifier state p652 . U+0022 QUOTATION MARK (") Parse error p620 . Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (double-quoted) state p653 . U+0027 APOSTROPHE (') Parse error p620 . Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (single-quoted) state p653 . U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.63 Before DOCTYPE system identifier state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+0022 QUOTATION MARK (") Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (double-quoted) state p653 . U+0027 APOSTROPHE (') Set the DOCTYPE token's system identifier to the empty string (not missing), then switch to the DOCTYPE system identifier (single-quoted) state p653 .
652
U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the bogus DOCTYPE state p654 .
10.2.4.64 DOCTYPE system identifier (double-quoted) state Consume the next input character p628 : U+0022 QUOTATION MARK (") Switch to the after DOCTYPE system identifier state p653 . U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current DOCTYPE token's system identifier. U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current DOCTYPE token's system identifier.
10.2.4.65 DOCTYPE system identifier (single-quoted) state Consume the next input character p628 : U+0027 APOSTROPHE (') Switch to the after DOCTYPE system identifier state p653 . U+0000 NULL Parse error p620 . Append a U+FFFD REPLACEMENT CHARACTER character to the current DOCTYPE token's system identifier. U+003E GREATER-THAN SIGN (>) Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Switch to the data state p633 . Emit that DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Append the current input character p628 to the current DOCTYPE token's system identifier.
10.2.4.66 After DOCTYPE system identifier state Consume the next input character p628 : U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE Ignore the character. U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the current DOCTYPE token. EOF Parse error p620 . Set the DOCTYPE token's force-quirks flag to on. Emit that DOCTYPE token. Reconsume the EOF character in the data state p633 .
653
Anything else Parse error p620 . Switch to the bogus DOCTYPE state p654 . (This does not set the DOCTYPE token's forcequirks flag to on.)
10.2.4.67 Bogus DOCTYPE state Consume the next input character p628 : U+003E GREATER-THAN SIGN (>) Switch to the data state p633 . Emit the DOCTYPE token. EOF Emit the DOCTYPE token. Reconsume the EOF character in the data state p633 . Anything else Ignore the character.
10.2.4.68 CDATA section state Consume every character up to the next occurrence of the three character sequence U+005D RIGHT SQUARE BRACKET U+005D RIGHT SQUARE BRACKET U+003E GREATER-THAN SIGN (]]>), or the end of the file (EOF), whichever comes first. Emit a series of character tokens consisting of all the characters consumed except the matching three character sequence at the end (if one was found before the end of the file). Switch to the data state p633 . If the end of the file was reached, reconsume the EOF character.
10.2.4.69 Tokenizing character references This section defines how to consume a character reference. This definition is used when parsing character references in text p633 and in attributes p645 . The behavior depends on the identity of the next character (the one immediately after the U+0026 AMPERSAND character): U+0009 CHARACTER TABULATION U+000A LINE FEED (LF) U+000C FORM FEED (FF) U+0020 SPACE U+003C LESS-THAN SIGN U+0026 AMPERSAND EOF The additional allowed character, if there is one Not a character reference. No characters are consumed, and nothing is returned. (This is not an error, either.) U+0023 NUMBER SIGN (#) Consume the U+0023 NUMBER SIGN. The behavior further depends on the character after the U+0023 NUMBER SIGN: U+0078 LATIN SMALL LETTER X U+0058 LATIN CAPITAL LETTER X Consume the X. Follow the steps below, but using the range of characters U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F, and U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F (in other words, 0-9, A-F, a-f). When it comes to interpreting the number, interpret it as a hexadecimal number. Anything else Follow the steps below, but using the range of characters U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). When it comes to interpreting the number, interpret it as a decimal number. Consume as many characters as match the range of characters given above.
654
If no characters match the range, then don't consume any characters (and unconsume the U+0023 NUMBER SIGN character and, if appropriate, the X character). This is a parse error p620 ; nothing is returned. Otherwise, if the next character is a U+003B SEMICOLON, consume that too. If it isn't, there is a parse error p620 . If one or more characters match the range, then take them all and interpret the string of characters as a number (either hexadecimal or decimal as appropriate). If that number is one of the numbers in the first column of the following table, then this is a parse error p620 . Find the row with that number in the first column, and return a character token for the Unicode character given in the second column of that row.
Number 0x00 0x0D 0x80 0x81 0x82 0x83 0x84 0x85 0x86 0x87 0x88 0x89 0x8A 0x8B 0x8C 0x8D 0x8E 0x8F 0x90 0x91 0x92 0x93 0x94 0x95 0x96 0x97 0x98 0x99 0x9A 0x9B 0x9C 0x9D 0x9E 0x9F Unicode character U+FFFD REPLACEMENT CHARACTER U+000D CARRIAGE RETURN (CR) U+20AC EURO SIGN () U+0081 <control> U+201A SINGLE LOW-9 QUOTATION MARK () U+0192 LATIN SMALL LETTER F WITH HOOK () U+201E DOUBLE LOW-9 QUOTATION MARK () U+2026 HORIZONTAL ELLIPSIS () U+2020 DAGGER () U+2021 DOUBLE DAGGER () U+02C6 MODIFIER LETTER CIRCUMFLEX ACCENT () U+2030 PER MILLE SIGN () U+0160 LATIN CAPITAL LETTER S WITH CARON () U+2039 SINGLE LEFT-POINTING ANGLE QUOTATION MARK () U+0152 LATIN CAPITAL LIGATURE OE () U+008D <control> U+017D LATIN CAPITAL LETTER Z WITH CARON () U+008F <control> U+0090 <control> U+2018 LEFT SINGLE QUOTATION MARK () U+2019 RIGHT SINGLE QUOTATION MARK () U+201C LEFT DOUBLE QUOTATION MARK () U+201D RIGHT DOUBLE QUOTATION MARK () U+2022 BULLET () U+2013 EN DASH () U+2014 EM DASH () U+02DC SMALL TILDE () U+2122 TRADE MARK SIGN () U+0161 LATIN SMALL LETTER S WITH CARON () U+203A SINGLE RIGHT-POINTING ANGLE QUOTATION MARK () U+0153 LATIN SMALL LIGATURE OE () U+009D <control> U+017E LATIN SMALL LETTER Z WITH CARON () U+0178 LATIN CAPITAL LETTER Y WITH DIAERESIS ()
Otherwise, if the number is in the range 0xD800 to 0xDFFF or is greater than 0x10FFFF, then this is a parse error p620 . Return a U+FFFD REPLACEMENT CHARACTER. Otherwise, return a character token for the Unicode character whose code point is that number. If the number is in the range 0x0001 to 0x0008, 0x000E to 0x001F, 0x007F to 0x009F, 0xFDD0 to 0xFDEF, or is one of 0x000B, 0xFFFE, 0xFFFF, 0x1FFFE, 0x1FFFF, 0x2FFFE, 0x2FFFF, 0x3FFFE, 0x3FFFF, 0x4FFFE, 0x4FFFF, 0x5FFFE, 0x5FFFF, 0x6FFFE, 0x6FFFF, 0x7FFFE, 0x7FFFF, 0x8FFFE, 0x8FFFF, 0x9FFFE, 0x9FFFF, 0xAFFFE, 0xAFFFF, 0xBFFFE, 0xBFFFF, 0xCFFFE, 0xCFFFF, 0xDFFFE, 0xDFFFF, 0xEFFFE, 0xEFFFF, 0xFFFFE, 0xFFFFF, 0x10FFFE, or 0x10FFFF, then this is a parse error p620 . Anything else Consume the maximum number of characters possible, with the consumed characters matching one of the identifiers in the first column of the named character references p697 table (in a case-sensitive p36 manner). If no match can be made, then no characters are consumed, and nothing is returned. In this case, if the characters after the U+0026 AMPERSAND character (&) consist of a sequence of one or more characters
655
in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z, and U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z, followed by a U+003B SEMICOLON character (;), then this is a parse error p620 . If the character reference is being consumed as part of an attribute p645 , and the last character matched is not a U+003B SEMICOLON character (;), and the next character is either a U+003D EQUALS SIGN character (=) or in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z, or U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z, then, for historical reasons, all the characters that were matched after the U+0026 AMPERSAND character (&) must be unconsumed, and nothing is returned. Otherwise, a character reference is parsed. If the last character matched is not a U+003B SEMICOLON character (;), there is a parse error p620 . Return one or two character tokens for the character(s) corresponding to the character reference name (as given by the second column of the named character references p697 table). If the markup contains (not in an attribute) the string I'm ¬it; I tell you, the character reference is parsed as "not", as in, I'm it; I tell you (and this is a parse error). But if the markup was I'm ∉ I tell you, the character reference would be parsed as "notin;", resulting in I'm I tell you (and no parse error).
Three text nodes; "A" before the script, the script's contents, and "BC" after the script (the parser appends to the text node created by the script).
A<script> Two adjacent text nodes in the document, var text = document.getElementsByTagName('script')[0].firstChild; containing "A" and "BC". text.data = 'B'; document.body.appendChild(text); </script>C A<table>B<tr>C</tr>D</table> One text node before the table, containing "ABCD". (This is caused by foster parenting p659 .) One text node before the table, containing "A B C" (A-space-B-space-C). (This is caused by foster parenting p659 .) One text node before the table, containing "A BC" (A-space-B-C), and one text node inside the table (as a child of a tbody p328 ) with a single space character. (Space characters separated from non-space characters by noncharacter tokens are not affected by foster parenting p659 , even if those other tokens then get ignored.)
DOM mutation events must not fire for changes caused by the UA parsing the document. (Conceptually, the parser is not mutating the DOM, it is constructing it.) This includes the parsing of any content inserted using document.write() p112 and document.writeln() p112 calls. [DOMEVENTS] p782
656
Note: Not all of the tag names mentioned below are conformant tag names in this specification; many are included to handle legacy content. They still form part of the algorithm that implementations are required to implement to claim conformance. Note: The algorithm described below places no limit on the depth of the DOM tree generated, or on the length of tag names, attribute names, attribute values, text nodes, etc. While implementors are encouraged to avoid arbitrary limits, it is recognized that practical concerns p32 will likely force user agents to impose nesting depth constraints.
10.2.5.1 Creating and inserting elements When the steps below require the UA to create an element for a token in a particular namespace, the UA must create a node implementing the interface appropriate for the element type corresponding to the tag name of the token in the given namespace (as given in the specification that defines that element, e.g. for an a p173 element in the HTML namespace p75 , this specification defines it to be the HTMLAnchorElement p173 interface), with the tag name being the name of that element, with the node being in the given namespace, and with the attributes on the node being those given in the given token. The interface appropriate for an element in the HTML namespace p75 that is not defined in this specification (or other applicable specifications p36 ) is HTMLUnknownElement p90 . Element in other namespaces whose interface is not defined by that namespace's specification must use the interface Element p33 . When a resettable element p347 is created in this manner, its reset algorithm p423 must be invoked once the attributes are set. (This initializes the element's value p409 and checkedness p409 based on the element's attributes.) When the steps below require the UA to insert an HTML element for a token, the UA must first create an element for the token p657 in the HTML namespace p75 , and then append this node to the current node p629 , and push it onto the stack of open elements p629 so that it is the new current node p629 . The steps below may also require that the UA insert an HTML element in a particular place, in which case the UA must follow the same steps except that it must insert or append the new node in the location specified instead of appending it to the current node p629 . (This happens in particular during the parsing of tables with invalid content.) If an element created by the insert an HTML element p657 algorithm is a form-associated element p347 , and the form element pointer p632 is not null, and the newly created element doesn't have a form p407 attribute, the user agent must associate p407 the newly created element with the form p347 element pointed to by the form element pointer p632 when the element is inserted, instead of running the reset the form owner p408 algorithm. When the steps below require the UA to insert a foreign element for a token, the UA must first create an element for the token p657 in the given namespace, and then append this node to the current node p629 , and push it onto the stack of open elements p629 so that it is the new current node p629 . If the newly created element has an xmlns attribute in the XMLNS namespace p76 whose value is not exactly the same as the element's namespace, that is a parse error p620 . Similarly, if the newly created element has an xmlns:xlink attribute in the XMLNS namespace p76 whose value is not the XLink Namespace p75 , that is a parse error p620 . When the steps below require the user agent to adjust MathML attributes for a token, then, if the token has an attribute named definitionurl, change its name to definitionURL (note the case difference). When the steps below require the user agent to adjust SVG attributes for a token, then, for each attribute on the token whose attribute name is one of the ones in the first column of the following table, change the attribute's name to the name given in the corresponding cell in the second column. (This fixes the case of SVG attributes that are not all lowercase.)
Attribute name on token attributename attributetype basefrequency baseprofile calcmode clippathunits contentscripttype contentstyletype diffuseconstant edgemode Attribute name on element attributeName attributeType baseFrequency baseProfile calcMode clipPathUnits contentScriptType contentStyleType diffuseConstant edgeMode
657
Attribute name on token glyphref gradienttransform gradientunits kernelmatrix kernelunitlength keypoints keysplines keytimes lengthadjust limitingconeangle markerheight markerunits markerwidth maskcontentunits maskunits numoctaves pathlength patterncontentunits patterntransform patternunits pointsatx pointsaty pointsatz preservealpha preserveaspectratio primitiveunits refx refy repeatcount repeatdur requiredextensions requiredfeatures specularconstant specularexponent spreadmethod startoffset stddeviation stitchtiles surfacescale systemlanguage tablevalues targetx targety textlength viewbox viewtarget xchannelselector ychannelselector zoomandpan
Attribute name on element glyphRef gradientTransform gradientUnits kernelMatrix kernelUnitLength keyPoints keySplines keyTimes lengthAdjust limitingConeAngle markerHeight markerUnits markerWidth maskContentUnits maskUnits numOctaves pathLength patternContentUnits patternTransform patternUnits pointsAtX pointsAtY pointsAtZ preserveAlpha preserveAspectRatio primitiveUnits refX refY repeatCount repeatDur requiredExtensions requiredFeatures specularConstant specularExponent spreadMethod startOffset stdDeviation stitchTiles surfaceScale systemLanguage tableValues targetX targetY textLength viewBox viewTarget xChannelSelector yChannelSelector zoomAndPan
When the steps below require the user agent to adjust foreign attributes for a token, then, if any of the attributes on the token match the strings given in the first column of the following table, let the attribute be a namespaced attribute, with the prefix being the string given in the corresponding cell in the second column, the local name being the string given in the corresponding cell in the third column, and the namespace being the namespace given in the corresponding cell in the fourth column. (This fixes the use of namespaced attributes, in particular lang attributes in the XML namespace p92 .)
Attribute name Prefix Local name xlink:actuate xlink:arcrole xlink:href xlink:role xlink actuate xlink arcrole xlink href xlink role Namespace XLink namespace p75 XLink namespace p75 XLink namespace p75 XLink namespace p75
658
Attribute name Prefix Local name xlink:show xlink:title xlink:type xml:base xml:lang xml:space xmlns xmlns:xlink xlink show xlink title xlink type xml xml xml base lang space
Namespace XLink namespace p75 XLink namespace p75 XLink namespace p75 XML namespace p75 XML namespace p75 XML namespace p75 XMLNS namespace p76 XMLNS namespace p76
The generic raw text element parsing algorithm and the generic RCDATA element parsing algorithm consist of the following steps. These algorithms are always invoked in response to a start tag token. 1. 2. Insert an HTML element p657 for the token. If the algorithm that was invoked is the generic raw text element parsing algorithm p659 , switch the tokenizer to the RAWTEXT state p633 ; otherwise the algorithm invoked was the generic RCDATA element parsing algorithm p659 , switch the tokenizer to the RCDATA state p633 . Let the original insertion mode p628 be the current insertion mode p628 . Then, switch the insertion mode p628 to "text p674 ".
3. 4.
10.2.5.2 Closing elements that have implied end tags When the steps below require the UA to generate implied end tags, then, while the current node p629 is a dd p170 element, a dt p169 element, an li p166 element, an option p393 element, an optgroup p392 element, a p p160 element, an rp p192 element, or an rt p192 element, the UA must pop the current node p629 off the stack of open elements p629 . If a step requires the UA to generate implied end tags but lists an element to exclude from the process, then the UA must perform the above steps as if that element was not in the above list.
10.2.5.3 Foster parenting Foster parenting happens when content is misnested in tables. When a node node is to be foster parented, the node node must be inserted into the foster parent element p659 . The foster parent element is the parent element of the last table p320 element in the stack of open elements p629 , if there is a table p320 element and it has such a parent element. Note: It might have no parent or some other kind parent if a script manipulated the DOM after the element was inserted by the parser. If there is no table p320 element in the stack of open elements p629 (fragment case p696 ), then the foster parent element p659 is the first element in the stack of open elements p629 (the html p116 element). Otherwise, if there is a table p320 element in the stack of open elements p629 , but the last table p320 element in the stack of open elements p629 has no parent, or its parent node is not an element, then the foster parent element p659 is the element before the last table p320 element in the stack of open elements p629 . If the foster parent element p659 is the parent element of the last table p320 element in the stack of open elements p629 , then node must be inserted into the foster parent element p659 , immediately before the last table p320 element in the stack of open elements p629 ; otherwise, node must be appended to the foster parent element p659 .
10.2.5.4 The "initial" insertion mode When the insertion mode p628 is "initial p659 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Ignore the token. A comment token Append a Comment p33 node to the Document p33 object with the data attribute set to the data given in the comment token.
659
A DOCTYPE token If the DOCTYPE token's name is not a case-sensitive p36 match for the string "html", or the token's public identifier is not missing, or the token's system identifier is neither missing nor a case-sensitive p36 match for the string "about:legacy-compat p56 ", and none of the sets of conditions in the following list are matched, then there is a parse error p620 . The DOCTYPE token's name is a case-sensitive p36 match for the string "html", the token's public identifier is the case-sensitive p36 string "-//W3C//DTD HTML 4.0//EN", and the token's system identifier is either missing or the case-sensitive p36 string "http://www.w3.org/TR/ REC-html40/strict.dtd". The DOCTYPE token's name is a case-sensitive p36 match for the string "html", the token's public identifier is the case-sensitive p36 string "-//W3C//DTD HTML 4.01//EN", and the token's system identifier is either missing or the case-sensitive p36 string "http://www.w3.org/TR/ html4/strict.dtd". The DOCTYPE token's name is a case-sensitive p36 match for the string "html", the token's public identifier is the case-sensitive p36 string "-//W3C//DTD XHTML 1.0 Strict//EN", and the token's system identifier is the case-sensitive p36 string "http://www.w3.org/TR/xhtml1/DTD/ xhtml1-strict.dtd". The DOCTYPE token's name is a case-sensitive p36 match for the string "html", the token's public identifier is the case-sensitive p36 string "-//W3C//DTD XHTML 1.1//EN", and the token's system identifier is the case-sensitive p36 string "http://www.w3.org/TR/xhtml11/DTD/ xhtml11.dtd".
Conformance checkers may, based on the values (including presence or lack thereof) of the DOCTYPE token's name, public identifier, or system identifier, switch to a conformance checking mode for another language (e.g. based on the DOCTYPE token a conformance checker could recognize that the document is an HTML4-era document, and defer to an HTML4 conformance checker.) Append a DocumentType p33 node to the Document p33 node, with the name attribute set to the name given in the DOCTYPE token, or the empty string if the name was missing; the publicId attribute set to the public identifier given in the DOCTYPE token, or the empty string if the public identifier was missing; the systemId attribute set to the system identifier given in the DOCTYPE token, or the empty string if the system identifier was missing; and the other attributes specific to DocumentType p33 objects set to null and empty lists as appropriate. Associate the DocumentType p33 node with the Document p33 object so that it is returned as the value of the doctype attribute of the Document p33 object. Then, if the DOCTYPE token matches one of the conditions in the following list, then set the Document p33 to quirks mode p81 : The force-quirks flag is set to on. The name is set to anything other than "html" (compared case-sensitively p36 ). The public identifier starts with: "+//Silmaril//dtd html Pro v0r11 19970101//" The public identifier starts with: "-//AdvaSoft Ltd//DTD HTML 3.0 asWedit + extensions//" The public identifier starts with: "-//AS//DTD HTML 3.0 asWedit + extensions//" The public identifier starts with: "-//IETF//DTD HTML 2.0 Level 1//" The public identifier starts with: "-//IETF//DTD HTML 2.0 Level 2//" The public identifier starts with: "-//IETF//DTD HTML 2.0 Strict Level 1//" The public identifier starts with: "-//IETF//DTD HTML 2.0 Strict Level 2//" The public identifier starts with: "-//IETF//DTD HTML 2.0 Strict//" The public identifier starts with: "-//IETF//DTD HTML 2.0//" The public identifier starts with: "-//IETF//DTD HTML 2.1E//" The public identifier starts with: "-//IETF//DTD HTML 3.0//" The public identifier starts with: "-//IETF//DTD HTML 3.2 Final//" The public identifier starts with: "-//IETF//DTD HTML 3.2//" The public identifier starts with: "-//IETF//DTD HTML 3//" The public identifier starts with: "-//IETF//DTD HTML Level 0//" The public identifier starts with: "-//IETF//DTD HTML Level 1//" The public identifier starts with: "-//IETF//DTD HTML Level 2//" The public identifier starts with: "-//IETF//DTD HTML Level 3//" The public identifier starts with: "-//IETF//DTD HTML Strict Level 0//" The public identifier starts with: "-//IETF//DTD HTML Strict Level 1//" The public identifier starts with: "-//IETF//DTD HTML Strict Level 2//" The public identifier starts with: "-//IETF//DTD HTML Strict Level 3//" The public identifier starts with: "-//IETF//DTD HTML Strict//" The public identifier starts with: "-//IETF//DTD HTML//" The public identifier starts with: "-//Metrius//DTD Metrius Presentational//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 2.0 HTML Strict//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 2.0 HTML//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 2.0 Tables//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 3.0 HTML Strict//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 3.0 HTML//" The public identifier starts with: "-//Microsoft//DTD Internet Explorer 3.0 Tables//"
660
The public identifier starts with: "-//Netscape Comm. Corp.//DTD HTML//" The public identifier starts with: "-//Netscape Comm. Corp.//DTD Strict HTML//" The public identifier starts with: "-//O'Reilly and Associates//DTD HTML 2.0//" The public identifier starts with: "-//O'Reilly and Associates//DTD HTML Extended 1.0//" The public identifier starts with: "-//O'Reilly and Associates//DTD HTML Extended Relaxed 1.0//" The public identifier starts with: "-//SoftQuad Software//DTD HoTMetaL PRO 6.0::19990601::extensions to HTML 4.0//" The public identifier starts with: "-//SoftQuad//DTD HoTMetaL PRO 4.0::19971010::extensions to HTML 4.0//" The public identifier starts with: "-//Spyglass//DTD HTML 2.0 Extended//" The public identifier starts with: "-//SQ//DTD HTML 2.0 HoTMetaL + extensions//" The public identifier starts with: "-//Sun Microsystems Corp.//DTD HotJava HTML//" The public identifier starts with: "-//Sun Microsystems Corp.//DTD HotJava Strict HTML//" The public identifier starts with: "-//W3C//DTD HTML 3 1995-03-24//" The public identifier starts with: "-//W3C//DTD HTML 3.2 Draft//" The public identifier starts with: "-//W3C//DTD HTML 3.2 Final//" The public identifier starts with: "-//W3C//DTD HTML 3.2//" The public identifier starts with: "-//W3C//DTD HTML 3.2S Draft//" The public identifier starts with: "-//W3C//DTD HTML 4.0 Frameset//" The public identifier starts with: "-//W3C//DTD HTML 4.0 Transitional//" The public identifier starts with: "-//W3C//DTD HTML Experimental 19960712//" The public identifier starts with: "-//W3C//DTD HTML Experimental 970421//" The public identifier starts with: "-//W3C//DTD W3 HTML//" The public identifier starts with: "-//W3O//DTD W3 HTML 3.0//" The public identifier is set to: "-//W3O//DTD W3 HTML Strict 3.0//EN//" The public identifier starts with: "-//WebTechs//DTD Mozilla HTML 2.0//" The public identifier starts with: "-//WebTechs//DTD Mozilla HTML//" The public identifier is set to: "-/W3C/DTD HTML 4.0 Transitional/EN" The public identifier is set to: "HTML" The system identifier is set to: "http://www.ibm.com/data/dtd/v11/ ibmxhtml1-transitional.dtd" The system identifier is missing and the public identifier starts with: "-//W3C//DTD HTML 4.01 Frameset//" The system identifier is missing and the public identifier starts with: "-//W3C//DTD HTML 4.01 Transitional//"
Otherwise, if the DOCTYPE token matches one of the conditions in the following list, then set the Document p33 to limited-quirks mode p81 : The public identifier starts with: "-//W3C//DTD XHTML 1.0 Frameset//" The public identifier starts with: "-//W3C//DTD XHTML 1.0 Transitional//" The system identifier is not missing and the public identifier starts with: "-//W3C//DTD HTML 4.01 Frameset//" The system identifier is not missing and the public identifier starts with: "-//W3C//DTD HTML 4.01 Transitional//"
The system identifier and public identifier strings must be compared to the values given in the lists above in an ASCII case-insensitive p36 manner. A system identifier whose value is the empty string is not considered missing for the purposes of the conditions above. Then, switch the insertion mode p628 to "before html p661 ". Anything else If the document is not an iframe srcdoc document p214 , then this is a parse error p620 ; set the Document p33 to quirks mode p81 . In any case, switch the insertion mode p628 to "before html p661 ", then reprocess the current token.
10.2.5.5 The "before html" insertion mode When the insertion mode p628 is "before html p661 ", tokens must be handled as follows: A DOCTYPE token Parse error p620 . Ignore the token. A comment token Append a Comment p33 node to the Document p33 object with the data attribute set to the data given in the comment token. A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Ignore the token. A start tag whose tag name is "html" Create an element for the token p657 in the HTML namespace p75 . Append it to the Document p33 object. Put this element in the stack of open elements p629 .
661
If the Document p33 is being loaded as part of navigation p520 of a browsing context p499 , then: if the newly created element has a manifest p116 attribute whose value is not the empty string, then resolve p55 the value of that attribute to an absolute URL p56 , relative to the newly created element, and if that is successful, run the application cache selection algorithm p545 with the resulting absolute URL p56 with any <fragment> p55 component removed; otherwise, if there is no such attribute, or its value is the empty string, or resolving its value fails, run the application cache selection algorithm p545 with no manifest. The algorithm must be passed the Document p33 object. Switch the insertion mode p628 to "before head p662 ". An end tag whose tag name is one of: "head", "body", "html", "br" Act as described in the "anything else" entry below. Any other end tag Parse error p620 . Ignore the token. Anything else Create an html p116 element. Append it to the Document p33 object. Put this element in the stack of open elements p629 . If the Document p33 is being loaded as part of navigation p520 of a browsing context p499 , then: run the application cache selection algorithm p545 with no manifest, passing it the Document p33 object. Switch the insertion mode p628 to "before head p662 ", then reprocess the current token. The root element can end up being removed from the Document p33 object, e.g. by scripts; nothing in particular happens in such cases, content continues being appended to the nodes as described in the next section.
10.2.5.6 The "before head" insertion mode When the insertion mode p628 is "before head p662 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Ignore the token. A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is "head" Insert an HTML element p657 for the token. Set the head element pointer p632 to the newly created head p116 element. Switch the insertion mode p628 to "in head p662 ". An end tag whose tag name is one of: "head", "body", "html", "br" Act as if a start tag token with the tag name "head" and no attributes had been seen, then reprocess the current token. Any other end tag Parse error p620 . Ignore the token. Anything else Act as if a start tag token with the tag name "head" and no attributes had been seen, then reprocess the current token.
10.2.5.7 The "in head" insertion mode When the insertion mode p628 is "in head p662 ", tokens must be handled as follows:
662
A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is one of: "base", "basefont", "bgsound", "command", "link" Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. A start tag whose tag name is "meta" Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. If the element has a charset p123 attribute, and its value is either a supported ASCII-compatible character encoding p30 or a UTF-16 encoding, and the confidence p622 is currently tentative, then change the encoding p628 to the encoding given by the value of the charset p123 attribute. Otherwise, if the element has an http-equiv p125 attribute whose value is an ASCII case-insensitive p36 match for the string "Content-Type", and the element has a content p123 attribute, and applying the algorithm for extracting an encoding from a Content-Type p62 to that attribute's value returns a supported ASCII-compatible character encoding p30 or a UTF-16 encoding, and the confidence p622 is currently tentative, then change the encoding p628 to the extracted encoding. A start tag whose tag name is "title" Follow the generic RCDATA element parsing algorithm p659 .
p632 is enabled A start tag whose tag name is "noscript", if the scripting flag
A start tag whose tag name is one of: "noframes", "style" Follow the generic raw text element parsing algorithm p659 .
p632 is disabled A start tag whose tag name is "noscript", if the scripting flag
Insert an HTML element p657 for the token. Switch the insertion mode p628 to "in head noscript p664 ". A start tag whose tag name is "script" Run these steps: 1. 2. Create an element for the token p657 in the HTML namespace p75 . Mark the element as being "parser-inserted" p134 . Note: This ensures that, if the script is external, any document.write() p112 calls in the script will execute in-line, instead of blowing the document away, as would happen in most other cases. It also prevents the script from executing until the end tag is seen. 3. If the parser was originally created for the HTML fragment parsing algorithm p696 , then mark the script p133 element as "already started" p134 . (fragment case p696 ) Append the new element to the current node p629 and push it onto the stack of open elements p629 . Switch the tokenizer to the script data state p634 . Let the original insertion mode p628 be the current insertion mode p628 . Switch the insertion mode p628 to "text p674 ".
4.
5. 6. 7.
663
An end tag whose tag name is "head" Pop the current node p629 (which will be the head p116 element) off the stack of open elements p629 . Switch the insertion mode p628 to "after head p664 ". An end tag whose tag name is one of: "body", "html", "br" Act as described in the "anything else" entry below. A start tag whose tag name is "head" Any other end tag Parse error p620 . Ignore the token. Anything else Act as if an end tag token with the tag name "head" had been seen, and reprocess the current token.
10.2.5.8 The "in head noscript" insertion mode When the insertion mode p628 is "in head noscript p664 ", tokens must be handled as follows: A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . An end tag whose tag name is "noscript" Pop the current node p629 (which will be a noscript p140 element) from the stack of open elements p629 ; the new current node p629 will be a head p116 element. Switch the insertion mode p628 to "in head p662 ". A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE A comment token A start tag whose tag name is one of: "basefont", "bgsound", "link", "meta", "noframes", "style" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . An end tag whose tag name is "br" Act as described in the "anything else" entry below. A start tag whose tag name is one of: "head", "noscript" Any other end tag Parse error p620 . Ignore the token. Anything else Parse error p620 . Act as if an end tag with the tag name "noscript" had been seen and reprocess the current token.
10.2.5.9 The "after head" insertion mode When the insertion mode p628 is "after head p664 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is "body" Insert an HTML element p657 for the token.
664
Set the frameset-ok flag p632 to "not ok". Switch the insertion mode p628 to "in body p665 ". A start tag whose tag name is "frameset" Insert an HTML element p657 for the token. Switch the insertion mode p628 to "in frameset p685 ". A start tag token whose tag name is one of: "base", "basefont", "bgsound", "link", "meta", "noframes", "script", "style", "title" Parse error p620 . Push the node pointed to by the head element pointer p632 onto the stack of open elements p629 . Process the token using the rules for p628 the "in head p662 " insertion mode p628 . Remove the node pointed to by the head element pointer p632 from the stack of open elements p629 . Note: The head element pointer p632 cannot be null at this point. An end tag whose tag name is one of: "body", "html", "br" Act as described in the "anything else" entry below. A start tag whose tag name is "head" Any other end tag Parse error p620 . Ignore the token. Anything else Act as if a start tag token with the tag name "body" and no attributes had been seen, then set the frameset-ok flag p632 back to "ok", and then reprocess the current token.
10.2.5.10 The "in body" insertion mode When the insertion mode p628 is "in body p665 ", tokens must be handled as follows: A character token that is U+0000 NULL Parse error p620 . Ignore the token. A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Reconstruct the active formatting elements p631 , if any. Insert the token's character p656 into the current node p629 . Any other character token Reconstruct the active formatting elements p631 , if any. Insert the token's character p656 into the current node p629 . Set the frameset-ok flag p632 to "not ok". A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Parse error p620 . For each attribute on the token, check to see if the attribute is already present on the top element of the stack of open elements p629 . If it is not, add the attribute and its corresponding value to that element. A start tag token whose tag name is one of: "base", "basefont", "bgsound", "command", "link", "meta", "noframes", "script", "style", "title" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . A start tag whose tag name is "body" Parse error p620 .
665
If the second element on the stack of open elements p629 is not a body p142 element, or, if the stack of open elements p629 has only one node on it, then ignore the token. (fragment case p696 ) Otherwise, set the frameset-ok flag p632 to "not ok"; then, for each attribute on the token, check to see if the attribute is already present on the body p142 element (the second element) on the stack of open elements p629 , and if it is not, add the attribute and its corresponding value to that element. A start tag whose tag name is "frameset" Parse error p620 . If the second element on the stack of open elements p629 is not a body p142 element, or, if the stack of open elements p629 has only one node on it, then ignore the token. (fragment case p696 ) If the frameset-ok flag p632 is set to "not ok", ignore the token. Otherwise, run the following steps: 1. Remove the second element on the stack of open elements p629 from its parent node, if it has one. Pop all the nodes from the bottom of the stack of open elements p629 , from the current node p629 up to, but not including, the root html p116 element. Insert an HTML element p657 for the token. Switch the insertion mode p628 to "in frameset p685 ".
2.
3. 4.
An end-of-file token If there is a node in the stack of open elements p629 that is not either a dd p170 element, a dt p169 element, an li p166 element, a p p160 element, a tbody p328 element, a td p332 element, a tfoot p330 element, a th p332 element, a thead p329 element, a tr p331 element, the body p142 element, or the html p116 element, then this is a parse error p620 . Stop parsing p687 . An end tag whose tag name is "body" If the stack of open elements p629 does not have a body element in scope p630 , this is a parse error p620 ; ignore the token. Otherwise, if there is a node in the stack of open elements p629 that is not either a dd p170 element, a dt p169 element, an li p166 element, an optgroup p392 element, an option p393 element, a p p160 element, an rp p192 element, an rt p192 element, a tbody p328 element, a td p332 element, a tfoot p330 element, a th p332 element, a thead p329 element, a tr p331 element, the body p142 element, or the html p116 element, then this is a parse error p620 . Switch the insertion mode p628 to "after body p684 ". An end tag whose tag name is "html" Act as if an end tag with tag name "body" had been seen, then, if that token wasn't ignored, reprocess the current token. A start tag whose tag name is one of: "address", "article", "aside", "blockquote", "center", "details", "dir", "div", "dl", "fieldset", "figcaption", "figure", "footer", "header", "hgroup", "menu", "nav", "ol", "p", "section", "summary", "ul" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token. A start tag whose tag name is one of: "h1", "h2", "h3", "h4", "h5", "h6" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. If the current node p629 is an element whose tag name is one of "h1", "h2", "h3", "h4", "h5", or "h6", then this is a parse error p620 ; pop the current node p629 off the stack of open elements p629 . Insert an HTML element p657 for the token. A start tag whose tag name is one of: "pre", "listing" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token.
666
If the next token is a U+000A LINE FEED (LF) character token, then ignore that token and move on to the next one. (Newlines at the start of pre p162 blocks are ignored as an authoring convenience.) Set the frameset-ok flag p632 to "not ok". A start tag whose tag name is "form" If the form element pointer p632 is not null, then this is a parse error p620 ; ignore the token. Otherwise: If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token, and set the form element pointer p632 to point to the element created. A start tag whose tag name is "li" Run these steps: 1. 2. 3. Set the frameset-ok flag p632 to "not ok". Initialize node to be the current node p629 (the bottommost node of the stack). Loop: If node is an li p166 element, then act as if an end tag with the tag name "li" had been seen, then jump to the last step. If node is in the special p630 category, but is not an address p154 , div p172 , or p p160 element, then jump to the last step. Otherwise, set node to the previous entry in the stack of open elements p629 and return to the step labeled loop. This is the last step. If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Finally, insert an HTML element p657 for the token. A start tag whose tag name is one of: "dd", "dt" Run these steps: 1. 2. 3. Set the frameset-ok flag p632 to "not ok". Initialize node to be the current node p629 (the bottommost node of the stack). Loop: If node is a dd p170 or dt p169 element, then act as if an end tag with the same tag name as node had been seen, then jump to the last step. If node is in the special p630 category, but is not an address p154 , div p172 , or p p160 element, then jump to the last step. Otherwise, set node to the previous entry in the stack of open elements p629 and return to the step labeled loop. This is the last step. If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Finally, insert an HTML element p657 for the token. A start tag whose tag name is "plaintext" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token. Switch the tokenizer to the PLAINTEXT state p634 . Note: Once a start tag with the tag name "plaintext" has been seen, that will be the last token ever seen other than character tokens (and the end-of-file token), because there is no way to switch out of the PLAINTEXT state p634 .
4.
5.
6.
4.
5.
6.
667
A start tag whose tag name is "button" If the stack of open elements p629 has a button element in scope p630 , then this is a parse error p620 ; act as if an end tag with the tag name "button" had been seen, then reprocess the token. Otherwise: Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Set the frameset-ok flag p632 to "not ok". An end tag whose tag name is one of: "address", "article", "aside", "blockquote", "button", "center", "details", "dir", "div", "dl", "fieldset", "figcaption", "figure", "footer", "header", "hgroup", "listing", "menu", "nav", "ol", "pre", "section", "summary", "ul" If the stack of open elements p629 does not have an element in scope p630 with the same tag name as that of the token, then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 . If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element with the same tag name as the token has been popped from the stack.
3.
An end tag whose tag name is "form" Let node be the element that the form element pointer p632 is set to. Set the form element pointer p632 to null. If node is null or the stack of open elements p629 does not have node in scope p630 , then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. 3. Generate implied end tags p659 . If the current node p629 is not node, then this is a parse error p620 . Remove node from the stack of open elements p629 .
An end tag whose tag name is "p" If the stack of open elements p629 does not have an element in button scope p630 with the same tag name as that of the token, then this is a parse error p620 ; act as if a start tag with the tag name "p" had been seen, then reprocess the current token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 , except for elements with the same tag name as the token. If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element with the same tag name as the token has been popped from the stack.
3.
An end tag whose tag name is "li" If the stack of open elements p629 does not have an element in list item scope p630 with the same tag name as that of the token, then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 , except for elements with the same tag name as the token. If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element with the same tag name as the token has been popped from the stack.
3.
668
An end tag whose tag name is one of: "dd", "dt" If the stack of open elements p629 does not have an element in scope p630 with the same tag name as that of the token, then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 , except for elements with the same tag name as the token. If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element with the same tag name as the token has been popped from the stack.
3.
An end tag whose tag name is one of: "h1", "h2", "h3", "h4", "h5", "h6" If the stack of open elements p629 does not have an element in scope p630 whose tag name is one of "h1", "h2", "h3", "h4", "h5", or "h6", then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 . If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element whose tag name is one of "h1", "h2", "h3", "h4", "h5", or "h6" has been popped from the stack.
3.
An end tag whose tag name is "sarcasm" Take a deep breath, then act as described in the "any other end tag" entry below. A start tag whose tag name is "a" If the list of active formatting elements p631 contains an element whose tag name is "a" between the end of the list and the last marker on the list (or the start of the list if there is no marker on the list), then this is a parse error p620 ; act as if an end tag with the tag name "a" had been seen, then remove that element from the list of active formatting elements p631 and the stack of open elements p629 if the end tag didn't already remove it (it might not have if the element is not in table scope p630 ). In the non-conforming stream <a href="a">a<table><a href="b">b</table>x, the first a p173 element would be closed upon seeing the second one, and the "x" character would be inside a link to "b", not to "a". This is despite the fact that the outer a p173 element is not in table scope (meaning that a regular </a> end tag at the start of the table wouldn't close the outer a p173 element). The result is that the two a p173 elements are indirectly nested inside each other nonconforming markup will often result in non-conforming DOMs when parsed. Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Push onto the list of active formatting elements p631 that element. A start tag whose tag name is one of: "b", "big", "code", "em", "font", "i", "s", "small", "strike", "strong", "tt", "u" Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Push onto the list of active formatting elements p631 that element. A start tag whose tag name is "nobr" Reconstruct the active formatting elements p631 , if any. If the stack of open elements p629 has a nobr element in scope p630 , then this is a parse error p620 ; act as if an end tag with the tag name "nobr" had been seen, then once again reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Push onto the list of active formatting elements p631 that element. An end tag whose tag name is one of: "a", "b", "big", "code", "em", "font", "i", "nobr", "s", "small", "strike", "strong", "tt", "u" Run these steps: 1. Let outer loop counter be zero.
669
2. 3. 4.
Outer loop: If outer loop counter is greater than or equal to eight, then abort these steps. Increment outer loop counter by one. Let the formatting element be the last element in the list of active formatting elements p631 that: is between the end of the list and the last scope marker in the list, if any, or the start of the list otherwise, and has the same tag name as the token.
If there is no such node, then abort these steps and instead act as described in the "any other end tag" entry below. Otherwise, if there is such a node, but that node is not in the stack of open elements p629 , then this is a parse error p620 ; remove the element from the list, and abort these steps. Otherwise, if there is such a node, and that node is also in the stack of open elements p629 , but the element is not in scope p630 , then this is a parse error p620 ; ignore the token, and abort these steps. Otherwise, there is a formatting element and that element is in the stack p629 and is in scope p630 . If the element is not the current node p629 , this is a parse error p620 . In any case, proceed with the algorithm as written in the following steps. 5. Let the furthest block be the topmost node in the stack of open elements p629 that is lower in the stack than the formatting element, and is an element in the special p630 category. There might not be one. If there is no furthest block, then the UA must skip the subsequent steps and instead just pop all the nodes from the bottom of the stack of open elements p629 , from the current node p629 up to and including the formatting element, and remove the formatting element from the list of active formatting elements p631 . Let the common ancestor be the element immediately above the formatting element in the stack of open elements p629 . Let a bookmark note the position of the formatting element in the list of active formatting elements p631 relative to the elements on either side of it in the list. Let node and last node be the furthest block. Follow these steps: 1. 2. Let inner loop counter be zero. Inner loop: If inner loop counter is greater than or equal to three, then abort these steps. Increment inner loop counter by one. Let node be the element immediately above node in the stack of open elements p629 , or if node is no longer in the stack of open elements p629 (e.g. because it got removed by the next step), the element that was immediately above node in the stack of open elements p629 before node was removed. If node is not in the list of active formatting elements p631 , then remove node from the stack of open elements p629 and then go back to the step labeled inner loop. Otherwise, if node is the formatting element, then go to the next step in the overall algorithm. Create an element for the token p657 for which the element node was created, replace the entry for node in the list of active formatting elements p631 with an entry for the new element, replace the entry for node in the stack of open elements p629 with an entry for the new element, and let node be the new element. If last node is the furthest block, then move the aforementioned bookmark to be immediately after the new node in the list of active formatting elements p631 . Insert last node into node, first removing it from its previous parent node if any. Let last node be node. Return to the step labeled inner loop.
6.
7.
8.
9.
3. 4.
5.
6.
7.
8.
9. 10. 11.
670
10.
If the common ancestor node is a table p320 , tbody p328 , tfoot p330 , thead p329 , or tr p331 element, then, foster parent p659 whatever last node ended up being in the previous step, first removing it from its previous parent node if any. Otherwise, append whatever last node ended up being in the previous step to the common ancestor node, first removing it from its previous parent node if any.
11. 12.
Create an element for the token p657 for which the formatting element was created. Take all of the child nodes of the furthest block and append them to the element created in the last step. Append that new element to the furthest block. Remove the formatting element from the list of active formatting elements p631 , and insert the new element into the list of active formatting elements p631 at the position of the aforementioned bookmark. Remove the formatting element from the stack of open elements p629 , and insert the new element into the stack of open elements p629 immediately below the position of the furthest block in that stack. Jump back to the step labeled outer loop.
13. 14.
15.
16.
Note: Because of the way this algorithm causes elements to change parents, it has been dubbed the "adoption agency algorithm" (in contrast with other possible algorithms for dealing with misnested content, which included the "incest algorithm", the "secret affair algorithm", and the "Heisenberg algorithm"). A start tag token whose tag name is one of: "applet", "marquee", "object" Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Insert a marker at the end of the list of active formatting elements p631 . Set the frameset-ok flag p632 to "not ok". An end tag token whose tag name is one of: "applet", "marquee", "object" If the stack of open elements p629 does not have an element in scope p630 with the same tag name as that of the token, then this is a parse error p620 ; ignore the token. Otherwise, run these steps: 1. 2. Generate implied end tags p659 . If the current node p629 is not an element with the same tag name as that of the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 until an element with the same tag name as the token has been popped from the stack. Clear the list of active formatting elements up to the last marker p632 .
3.
4.
A start tag whose tag name is "table" If the Document p33 is not set to quirks mode p81 , and the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token. Set the frameset-ok flag p632 to "not ok". Switch the insertion mode p628 to "in table p676 ". A start tag whose tag name is one of: "area", "br", "embed", "img", "keygen", "wbr" Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. Set the frameset-ok flag p632 to "not ok".
671
A start tag whose tag name is "input" Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. If the token does not have an attribute with the name "type", or if it does, but that attribute's value is not an ASCII case-insensitive p36 match for the string "hidden", then: set the frameset-ok flag p632 to "not ok". A start tag whose tag name is one of: "param", "source", "track" Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. A start tag whose tag name is "hr" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. Set the frameset-ok flag p632 to "not ok". A start tag whose tag name is "image" Parse error p620 . Change the token's tag name to "img" and reprocess it. (Don't ask.) A start tag whose tag name is "isindex" Parse error p620 . If the form element pointer p632 is not null, then ignore the token. Otherwise: Acknowledge the token's self-closing flag p632 , if it is set. Act as if a start tag token with the tag name "form" had been seen. If the token has an attribute called "action", set the action p410 attribute on the resulting form p347 element to the value of the "action" attribute of the token. Act as if a start tag token with the tag name "hr" had been seen. Act as if a start tag token with the tag name "label" had been seen. Act as if a stream of character tokens had been seen (see below for what they should say). Act as if a start tag token with the tag name "input" had been seen, with all the attributes from the "isindex" token except "name", "action", and "prompt". Set the name p408 attribute of the resulting input p353 element to the value "isindex p409 ". Act as if a stream of character tokens had been seen (see below for what they should say). Act as if an end tag token with the tag name "label" had been seen. Act as if a start tag token with the tag name "hr" had been seen. Act as if an end tag token with the tag name "form" had been seen. If the token has an attribute with the name "prompt", then the first stream of characters must be the same string as given in that attribute, and the second stream of characters must be empty. Otherwise, the two streams of character tokens together should, together with the input p353 element, express the equivalent of "This is a searchable index. Enter search keywords: (input field)" in the user's preferred language. A start tag whose tag name is "textarea" Run these steps: 1. Insert an HTML element p657 for the token.
672
2.
If the next token is a U+000A LINE FEED (LF) character token, then ignore that token and move on to the next one. (Newlines at the start of textarea p395 elements are ignored as an authoring convenience.) Switch the tokenizer to the RCDATA state p633 . Let the original insertion mode p628 be the current insertion mode p628 . Set the frameset-ok flag p632 to "not ok". Switch the insertion mode p628 to "text p674 ".
3. 4. 5. 6.
A start tag whose tag name is "xmp" If the stack of open elements p629 has a p element in button scope p630 , then act as if an end tag with the tag name "p" had been seen. Reconstruct the active formatting elements p631 , if any. Set the frameset-ok flag p632 to "not ok". Follow the generic raw text element parsing algorithm p659 . A start tag whose tag name is "iframe" Set the frameset-ok flag p632 to "not ok". Follow the generic raw text element parsing algorithm p659 . A start tag whose tag name is "noembed"
p632 is enabled A start tag whose tag name is "noscript", if the scripting flag
Follow the generic raw text element parsing algorithm p659 . A start tag whose tag name is "select" Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Set the frameset-ok flag p632 to "not ok". If the insertion mode p628 is one of "in table p676 ", "in caption p677 ", "in table body p678 ", "in row p679 ", or "in cell p680 ", then switch the insertion mode p628 to "in select in table p682 ". Otherwise, switch the insertion mode p628 to "in select p681 ". A start tag whose tag name is one of: "optgroup", "option" If the current node p629 is an option p393 element, then act as if an end tag with the tag name "option" had been seen. Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. A start tag whose tag name is one of: "rp", "rt" If the stack of open elements p629 has a ruby element in scope p630 , then generate implied end tags p659 . If the current node p629 is not then a ruby p191 element, this is a parse error p620 ; pop all the nodes from the current node p629 up to the node immediately before the bottommost ruby p191 element on the stack of open elements p629 . Insert an HTML element p657 for the token. An end tag whose tag name is "br" Parse error p620 . Act as if a start tag token with the tag name "br" had been seen. Ignore the end tag token. A start tag whose tag name is "math" Reconstruct the active formatting elements p631 , if any. Adjust MathML attributes p657 for the token. (This fixes the case of MathML attributes that are not all lowercase.) Adjust foreign attributes p658 for the token. (This fixes the use of namespaced attributes, in particular XLink.) Insert a foreign element p657 for the token, in the MathML namespace p75 .
673
If the token has its self-closing flag set, pop the current node p629 off the stack of open elements p629 and acknowledge the token's self-closing flag p632 . Otherwise, if the insertion mode p628 is not already "in foreign content p682 ", switch the insertion mode p628 to "in foreign content p682 ". A start tag whose tag name is "svg" Reconstruct the active formatting elements p631 , if any. Adjust SVG attributes p657 for the token. (This fixes the case of SVG attributes that are not all lowercase.) Adjust foreign attributes p658 for the token. (This fixes the use of namespaced attributes, in particular XLink in SVG.) Insert a foreign element p657 for the token, in the SVG namespace p75 . If the token has its self-closing flag set, pop the current node p629 off the stack of open elements p629 and acknowledge the token's self-closing flag p632 . Otherwise, if the insertion mode p628 is not already "in foreign content p682 ", switch the insertion mode p628 to "in foreign content p682 ". A start tag whose tag name is one of: "caption", "col", "colgroup", "frame", "head", "tbody", "td", "tfoot", "th", "thead", "tr" Parse error p620 . Ignore the token. Any other start tag Reconstruct the active formatting elements p631 , if any. Insert an HTML element p657 for the token. Note: This element will be a ordinary p630 element. Any other end tag Run these steps: 1. 2. Initialize node to be the current node p629 (the bottommost node of the stack). Loop: If node has the same tag name as the token, then: 1. Generate implied end tags p659 , except for elements with the same tag name as the token. If the tag name of the end tag token does not match the tag name of the current node p629 , this is a parse error p620 . Pop all the nodes from the current node p629 up to node, including node, then stop these steps.
2.
3.
3.
Otherwise, if node is in the special p630 category, then this is a parse error p620 ; ignore the token, and abort these steps. Set node to the previous entry in the stack of open elements p629 . Return to the step labeld loop.
4. 5.
10.2.5.11 The "text" insertion mode When the insertion mode p628 is "text p674 ", tokens must be handled as follows: A character token Insert the token's character p656 into the current node p629 . Note: This can never be a U+0000 NULL character; the tokenizer converts those to U+FFFD REPLACEMENT CHARACTER characters. An end-of-file token Parse error p620 . If the current node p629 is a script p133 element, mark the script p133 element as "already started" p134 . Pop the current node p629 off the stack of open elements p629 .
674
Switch the insertion mode p628 to the original insertion mode p628 and reprocess the current token. An end tag whose tag name is "script" Let script be the current node p629 (which will be a script p133 element). Pop the current node p629 off the stack of open elements p629 . Switch the insertion mode p628 to the original insertion mode p628 . Let the old insertion point have the same value as the current insertion point p628 . Let the insertion point p628 be just before the next input character p628 . Increment the parser's script nesting level p621 by one. Run p134 the script. This might cause some script to execute, which might cause new characters to be inserted into the tokenizer p112 , and might cause the tokenizer to output more tokens, resulting in a reentrant invocation of the parser p621 . Decrement the parser's script nesting level p621 by one. If the parser's script nesting level p621 is zero, then set the parser pause flag p621 to false. Let the insertion point p628 have the value of the old insertion point. (In other words, restore the insertion point p628 to its previous value. This value might be the "undefined" value.) At this stage, if there is a pending parsing-blocking script p136 , then:
p621 is not zero: If the script nesting level Set the parser pause flag p621 to true, and abort the processing of any nested invocations of the tokenizer, yielding control back to the caller. (Tokenization will resume when the caller returns to the "outer" tree construction stage.)
Note: The tree construction stage of this particular parser is being called reentrantly p621 , say from a call to document.write() p112 . Otherwise: Run these steps: 1. Let the script be the pending parsing-blocking script p136 . There is no longer a pending parsing-blocking script p136 . Block the tokenizer p632 for this instance of the HTML parser p620 , such that the event loop p552 will not run tasks p553 that invoke the tokenizer p632 . If the parser's Document p33 has a style sheet that is blocking scripts p132 or the script's "ready to be parser-executed" p134 flag is not set: spin the event loop p554 until the parser's Document p33 has no style sheet that is blocking scripts p132 and the script's "ready to be parser-executed" p134 flag is set. Unblock the tokenizer p632 for this instance of the HTML parser p620 , such that tasks p553 that invoke the tokenizer p632 can again be run. Let the insertion point p628 be just before the next input character p628 . Increment the parser's script nesting level p621 by one (it should be zero before this step, so this sets it to one). Execute p136 the script. Decrement the parser's script nesting level p621 by one. If the parser's script nesting level p621 is zero (which it always should be at this point), then set the parser pause flag p621 to false. Let the insertion point p628 be undefined again. If there is once again a pending parsing-blocking script p136 , then repeat these steps from step 1.
2.
3.
4.
5. 6.
7. 8.
9. 10.
Any other end tag Pop the current node p629 off the stack of open elements p629 . Switch the insertion mode p628 to the original insertion mode p628 .
675
10.2.5.12 The "in table" insertion mode When the insertion mode p628 is "in table p676 ", tokens must be handled as follows: A character token Let the pending table character tokens be an empty list of tokens. Let the original insertion mode p628 be the current insertion mode p628 . Switch the insertion mode p628 to "in table text p677 " and reprocess the token. A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "caption" Clear the stack back to a table context p677 . (See below.) Insert a marker at the end of the list of active formatting elements p631 . Insert an HTML element p657 for the token, then switch the insertion mode p628 to "in caption p677 ". A start tag whose tag name is "colgroup" Clear the stack back to a table context p677 . (See below.) Insert an HTML element p657 for the token, then switch the insertion mode p628 to "in column group p678 ". A start tag whose tag name is "col" Act as if a start tag token with the tag name "colgroup" had been seen, then reprocess the current token. A start tag whose tag name is one of: "tbody", "tfoot", "thead" Clear the stack back to a table context p677 . (See below.) Insert an HTML element p657 for the token, then switch the insertion mode p628 to "in table body p678 ". A start tag whose tag name is one of: "td", "th", "tr" Act as if a start tag token with the tag name "tbody" had been seen, then reprocess the current token. A start tag whose tag name is "table" Parse error p620 . Act as if an end tag token with the tag name "table" had been seen, then, if that token wasn't ignored, reprocess the current token. Note: The fake end tag token here can only be ignored in the fragment case p696 . An end tag whose tag name is "table" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. (fragment case p696 ) Otherwise: Pop elements from this stack until a table p320 element has been popped from the stack. Reset the insertion mode appropriately p629 . An end tag whose tag name is one of: "body", "caption", "col", "colgroup", "html", "tbody", "td", "tfoot", "th", "thead", "tr" Parse error p620 . Ignore the token. A start tag whose tag name is one of: "style", "script" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . A start tag whose tag name is "input" If the token does not have an attribute with the name "type", or if it does, but that attribute's value is not an ASCII case-insensitive p36 match for the string "hidden", then: act as described in the "anything else" entry below. Otherwise: Parse error p620 .
676
Insert an HTML element p657 for the token. Pop that input p353 element off the stack of open elements p629 . A start tag whose tag name is "form" Parse error p620 . If the form element pointer p632 is not null, ignore the token. Otherwise: Insert an HTML element p657 for the token, and set the form element pointer p632 to point to the element created. Pop that form p347 element off the stack of open elements p629 . An end-of-file token If the current node p629 is not the root html p116 element, then this is a parse error p620 . Note: It can only be the current node p629 in the fragment case p696 . Stop parsing p687 . Anything else Parse error p620 . Process the token using the rules for p628 the "in body p665 " insertion mode p628 , except that if the current node p629 is a table p320 , tbody p328 , tfoot p330 , thead p329 , or tr p331 element, then, whenever a node would be inserted into the current node p629 , it must instead be foster parented p659 . When the steps above require the UA to clear the stack back to a table context, it means that the UA must, while the current node p629 is not a table p320 element or an html p116 element, pop elements from the stack of open elements p629 . Note: The current node p629 being an html p116 element after this process is a fragment case p696 .
10.2.5.13 The "in table text" insertion mode When the insertion mode p628 is "in table text p677 ", tokens must be handled as follows: A character token that is U+0000 NULL Parse error p620 . Ignore the token. Any other character token Append the character token to the pending table character tokens p676 list. Anything else If any of the tokens in the pending table character tokens p676 list are character tokens that are not one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE, then reprocess those character tokens using the rules given in the "anything else" entry in the in table p676 " insertion mode. Otherwise, insert the characters p656 given by the pending table character tokens p676 list into the current node p629 . Switch the insertion mode p628 to the original insertion mode p628 and reprocess the token.
10.2.5.14 The "in caption" insertion mode When the insertion mode p628 is "in caption p677 ", tokens must be handled as follows: An end tag whose tag name is "caption" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. (fragment case p696 ) Otherwise: Generate implied end tags p659 . Now, if the current node p629 is not a caption p327 element, then this is a parse error p620 . Pop elements from this stack until a caption p327 element has been popped from the stack.
677
Clear the list of active formatting elements up to the last marker p632 . Switch the insertion mode p628 to "in table p676 ". A start tag whose tag name is one of: "caption", "col", "colgroup", "tbody", "td", "tfoot", "th", "thead", "tr" An end tag whose tag name is "table" Parse error p620 . Act as if an end tag with the tag name "caption" had been seen, then, if that token wasn't ignored, reprocess the current token. Note: The fake end tag token here can only be ignored in the fragment case p696 . An end tag whose tag name is one of: "body", "col", "colgroup", "html", "tbody", "td", "tfoot", "th", "thead", "tr" Parse error p620 . Ignore the token. Anything else Process the token using the rules for p628 the "in body p665 " insertion mode p628 .
10.2.5.15 The "in column group" insertion mode When the insertion mode p628 is "in column group p678 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is "col" Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. An end tag whose tag name is "colgroup" If the current node p629 is the root html p116 element, then this is a parse error p620 ; ignore the token. (fragment case p696 ) Otherwise, pop the current node p629 (which will be a colgroup p328 element) from the stack of open elements p629 . Switch the insertion mode p628 to "in table p676 ". An end tag whose tag name is "col" Parse error p620 . Ignore the token. An end-of-file token If the current node p629 is the root html p116 element, then stop parsing p687 . (fragment case p696 ) Otherwise, act as described in the "anything else" entry below. Anything else Act as if an end tag with the tag name "colgroup" had been seen, and then, if that token wasn't ignored, reprocess the current token. Note: The fake end tag token here can only be ignored in the fragment case p696 .
10.2.5.16 The "in table body" insertion mode When the insertion mode p628 is "in table body p678 ", tokens must be handled as follows:
678
A start tag whose tag name is "tr" Clear the stack back to a table body context p679 . (See below.) Insert an HTML element p657 for the token, then switch the insertion mode p628 to "in row p679 ". A start tag whose tag name is one of: "th", "td" Parse error p620 . Act as if a start tag with the tag name "tr" had been seen, then reprocess the current token. An end tag whose tag name is one of: "tbody", "tfoot", "thead" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. Otherwise: Clear the stack back to a table body context p679 . (See below.) Pop the current node p629 from the stack of open elements p629 . Switch the insertion mode p628 to "in table p676 ". A start tag whose tag name is one of: "caption", "col", "colgroup", "tbody", "tfoot", "thead" An end tag whose tag name is "table" If the stack of open elements p629 does not have a tbody, thead, or tfoot element in table scope p630 , this is a parse error p620 . Ignore the token. (fragment case p696 ) Otherwise: Clear the stack back to a table body context p679 . (See below.) Act as if an end tag with the same tag name as the current node p629 ("tbody", "tfoot", or "thead") had been seen, then reprocess the current token. An end tag whose tag name is one of: "body", "caption", "col", "colgroup", "html", "td", "th", "tr" Parse error p620 . Ignore the token. Anything else Process the token using the rules for p628 the "in table p676 " insertion mode p628 . When the steps above require the UA to clear the stack back to a table body context, it means that the UA must, while the current node p629 is not a tbody p328 , tfoot p330 , thead p329 , or html p116 element, pop elements from the stack of open elements p629 . Note: The current node p629 being an html p116 element after this process is a fragment case p696 .
10.2.5.17 The "in row" insertion mode When the insertion mode p628 is "in row p679 ", tokens must be handled as follows: A start tag whose tag name is one of: "th", "td" Clear the stack back to a table row context p680 . (See below.) Insert an HTML element p657 for the token, then switch the insertion mode p628 to "in cell p680 ". Insert a marker at the end of the list of active formatting elements p631 . An end tag whose tag name is "tr" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. (fragment case p696 ) Otherwise: Clear the stack back to a table row context p680 . (See below.) Pop the current node p629 (which will be a tr p331 element) from the stack of open elements p629 . Switch the insertion mode p628 to "in table body p678 ". A start tag whose tag name is one of: "caption", "col", "colgroup", "tbody", "tfoot", "thead", "tr" An end tag whose tag name is "table" Act as if an end tag with the tag name "tr" had been seen, then, if that token wasn't ignored, reprocess the current token.
679
Note: The fake end tag token here can only be ignored in the fragment case p696 . An end tag whose tag name is one of: "tbody", "tfoot", "thead" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. Otherwise, act as if an end tag with the tag name "tr" had been seen, then reprocess the current token. An end tag whose tag name is one of: "body", "caption", "col", "colgroup", "html", "td", "th" Parse error p620 . Ignore the token. Anything else Process the token using the rules for p628 the "in table p676 " insertion mode p628 . When the steps above require the UA to clear the stack back to a table row context, it means that the UA must, while the current node p629 is not a tr p331 element or an html p116 element, pop elements from the stack of open elements p629 . Note: The current node p629 being an html p116 element after this process is a fragment case p696 .
10.2.5.18 The "in cell" insertion mode When the insertion mode p628 is "in cell p680 ", tokens must be handled as follows: An end tag whose tag name is one of: "td", "th" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as that of the token, then this is a parse error p620 and the token must be ignored. Otherwise: Generate implied end tags p659 . Now, if the current node p629 is not an element with the same tag name as the token, then this is a parse error p620 . Pop elements from the stack of open elements p629 stack until an element with the same tag name as the token has been popped from the stack. Clear the list of active formatting elements up to the last marker p632 . Switch the insertion mode p628 to "in row p679 ". A start tag whose tag name is one of: "caption", "col", "colgroup", "tbody", "td", "tfoot", "th", "thead", "tr" If the stack of open elements p629 does not have a td or th element in table scope p630 , then this is a parse error p620 ; ignore the token. (fragment case p696 ) Otherwise, close the cell p680 (see below) and reprocess the current token. An end tag whose tag name is one of: "body", "caption", "col", "colgroup", "html" Parse error p620 . Ignore the token. An end tag whose tag name is one of: "table", "tbody", "tfoot", "thead", "tr" If the stack of open elements p629 does not have an element in table scope p630 with the same tag name as that of the token (which can only happen for "tbody", "tfoot" and "thead", or in the fragment case p696 ), then this is a parse error p620 and the token must be ignored. Otherwise, close the cell p680 (see below) and reprocess the current token. Anything else Process the token using the rules for p628 the "in body p665 " insertion mode p628 . Where the steps above say to close the cell, they mean to run the following algorithm: 1. If the stack of open elements p629 has a td element in table scope p630 , then act as if an end tag token with the tag name "td" had been seen. Otherwise, the stack of open elements p629 will have a th element in table scope p630 ; act as if an end tag token with the tag name "th" had been seen.
2.
680
Note: The stack of open elements p629 cannot have both a td p332 and a th p332 element in table scope p630 at the same time, nor can it have neither when the close the cell p680 algorithm is invoked.
10.2.5.19 The "in select" insertion mode When the insertion mode p628 is "in select p681 ", tokens must be handled as follows: A character token that is U+0000 NULL Parse error p620 . Ignore the token. Any other character token Insert the token's character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is "option" If the current node p629 is an option p393 element, act as if an end tag with the tag name "option" had been seen. Insert an HTML element p657 for the token. A start tag whose tag name is "optgroup" If the current node p629 is an option p393 element, act as if an end tag with the tag name "option" had been seen. If the current node p629 is an optgroup p392 element, act as if an end tag with the tag name "optgroup" had been seen. Insert an HTML element p657 for the token. An end tag whose tag name is "optgroup" First, if the current node p629 is an option p393 element, and the node immediately before it in the stack of open elements p629 is an optgroup p392 element, then act as if an end tag with the tag name "option" had been seen. If the current node p629 is an optgroup p392 element, then pop that node from the stack of open elements p629 . Otherwise, this is a parse error p620 ; ignore the token. An end tag whose tag name is "option" If the current node p629 is an option p393 element, then pop that node from the stack of open elements p629 . Otherwise, this is a parse error p620 ; ignore the token. An end tag whose tag name is "select" If the stack of open elements p629 does not have an element in select scope p630 with the same tag name as the token, this is a parse error p620 . Ignore the token. (fragment case p696 ) Otherwise: Pop elements from the stack of open elements p629 until a select p387 element has been popped from the stack. Reset the insertion mode appropriately p629 . A start tag whose tag name is "select" Parse error p620 . Act as if the token had been an end tag with the tag name "select" instead. A start tag whose tag name is one of: "input", "keygen", "textarea" Parse error p620 . If the stack of open elements p629 does not have a select element in select scope p630 , ignore the token. (fragment case p696 )
681
Otherwise, act as if an end tag with the tag name "select" had been seen, and reprocess the token. A start tag token whose tag name is "script" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . An end-of-file token If the current node p629 is not the root html p116 element, then this is a parse error p620 . Note: It can only be the current node p629 in the fragment case p696 . Stop parsing p687 . Anything else Parse error p620 . Ignore the token.
10.2.5.20 The "in select in table" insertion mode When the insertion mode p628 is "in select in table p682 ", tokens must be handled as follows: A start tag whose tag name is one of: "caption", "table", "tbody", "tfoot", "thead", "tr", "td", "th" Parse error p620 . Act as if an end tag with the tag name "select" had been seen, and reprocess the token. An end tag whose tag name is one of: "caption", "table", "tbody", "tfoot", "thead", "tr", "td", "th" Parse error p620 . If the stack of open elements p629 has an element in table scope p630 with the same tag name as that of the token, then act as if an end tag with the tag name "select" had been seen, and reprocess the token. Otherwise, ignore the token. Anything else Process the token using the rules for p628 the "in select p681 " insertion mode p628 .
10.2.5.21 The "in foreign content" insertion mode When the insertion mode p628 is "in foreign content p682 ", tokens must be handled as follows:
p629 is an element in the HTML namespace p75 Any token, if the current node p629 is a A start tag whose tag name is neither "mglyph" nor "malignmark", if the current node p684 MathML text integration point p629 is an annotation-xml element in the A start tag whose tag name is "svg", if the current node p75 MathML namespace p629 is an HTML integration point p684 A start tag, if the current node p629 is an HTML integration point p684 A character token, if the current node
An end-of-file token 1. Process the token using the rules for p628 the "in body p665 " insertion mode p628 , except that if those rules say to reprocess the token, these steps must be finished first (i.e. the insertion mode is reset by the following step before the token is reprocessed). If, after doing so, the insertion mode p628 is still "in foreign content p682 ", reset the insertion mode appropriately p629 .
2.
A character token that is U+0000 NULL Parse error p620 . Insert a U+FFFD REPLACEMENT CHARACTER character p656 into the current node p629 . A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the token's character p656 into the current node p629 . Any other character token Insert the token's character p656 into the current node p629 . Set the frameset-ok flag p632 to "not ok". A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token.
682
A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is one of: "b", "big", "blockquote", "body", "br", "center", "code", "dd", "div", "dl", "dt", "em", "embed", "h1", "h2", "h3", "h4", "h5", "h6", "head", "hr", "i", "img", "li", "listing", "menu", "meta", "nobr", "ol", "p", "pre", "ruby", "s", "small", "span", "strong", "strike", "sub", "sup", "table", "tt", "u", "ul", "var" A start tag whose tag name is "font", if the token has any attributes named "color", "face", or "size" Parse error p620 . Pop an element from the stack of open elements p629 , and then keep popping more elements from the stack of open elements p629 until the current node p629 is a MathML text integration point p684 , an HTML integration point p684 , or an element in the HTML namespace p75 . Then, reset the insertion mode appropriately p629 and reprocess the token. Any other start tag If the current node p629 is an element in the MathML namespace p75 , adjust MathML attributes p657 for the token. (This fixes the case of MathML attributes that are not all lowercase.) If the current node p629 is an element in the SVG namespace p75 , and the token's tag name is one of the ones in the first column of the following table, change the tag name to the name given in the corresponding cell in the second column. (This fixes the case of SVG elements that are not all lowercase.)
Tag name altglyph altglyphdef altglyphitem animatecolor animatemotion animatetransform clippath feblend fecolormatrix Element name altGlyph altGlyphDef altGlyphItem animateColor animateMotion animateTransform clipPath feBlend feColorMatrix
fecomponenttransfer feComponentTransfer fecomposite feconvolvematrix fediffuselighting fedisplacementmap fedistantlight feflood fefunca fefuncb fefuncg fefuncr fegaussianblur feimage femerge femergenode femorphology feoffset fepointlight fespecularlighting fespotlight fetile feturbulence foreignobject glyphref lineargradient radialgradient textpath feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur feImage feMerge feMergeNode feMorphology feOffset fePointLight feSpecularLighting feSpotLight feTile feTurbulence foreignObject glyphRef linearGradient radialGradient textPath
If the current node p629 is an element in the SVG namespace p75 , adjust SVG attributes p657 for the token. (This fixes the case of SVG attributes that are not all lowercase.)
683
Adjust foreign attributes p658 for the token. (This fixes the use of namespaced attributes, in particular XLink in SVG.) Insert a foreign element p657 for the token, in the same namespace as the current node p629 . If the token has its self-closing flag set, pop the current node p629 off the stack of open elements p629 and acknowledge the token's self-closing flag p632 .
p629 is a script element in the SVG An end tag whose tag name is "script", if the current node p75 namespace
Pop the current node p629 off the stack of open elements p629 . Let the old insertion point have the same value as the current insertion point p628 . Let the insertion point p628 be just before the next input character p628 . Increment the parser's script nesting level p621 by one. Set the parser pause flag p621 to true. Process the script element according to the SVG rules, if the user agent supports SVG. [SVG] p785 Note: Even if this causes new characters to be inserted into the tokenizer p112 , the parser will not be executed reentrantly, since the parser pause flag p621 is true. Decrement the parser's script nesting level p621 by one. If the parser's script nesting level p621 is zero, then set the parser pause flag p621 to false. Let the insertion point p628 have the value of the old insertion point. (In other words, restore the insertion point p628 to its previous value. This value might be the "undefined" value.) Any other end tag Run these steps: 1. 2. 3. Initialize node to be the current node p629 (the bottommost node of the stack). If node is not an element with the same tag name as the token, then this is a parse error p620 . Loop: If node's tag name, converted to ASCII lowercase p36 , is the same as as the tag name of the token, pop elements from the stack of open elements p629 until node has been popped from the stack, and then jump to the last step of this list of steps. Set node to the previous entry in the stack of open elements p629 . If node is not an element in the HTML namespace p75 , return to the step labeled loop. Otherwise, process the token using the rules for p628 the "in body p665 " insertion mode p628 , except that if those rules say to reprocess the token, these steps must be finished first (i.e. the insertion mode is reset by the following step before the token is reprocessed). If the insertion mode p628 is still "in foreign content p682 ", reset the insertion mode appropriately p629 .
4. 5. 6.
7.
The current node p629 is a MathML text integration point if it is one of the following elements: An An An An An mi element in the MathML namespace p75 mo element in the MathML namespace p75 mn element in the MathML namespace p75 ms element in the MathML namespace p75 mtext element in the MathML namespace p75
The current node p629 is an HTML integration point if it is one of the following elements: An annotation-xml element in the MathML namespace p75 whose start tag token had an attribute with the name "encoding" whose value was an ASCII case-insensitive p36 match for the string "text/html" An annotation-xml element in the MathML namespace p75 whose start tag token had an attribute with the name "encoding" whose value was an ASCII case-insensitive p36 match for the string "application/ xhtml+xml" A foreignObject element in the SVG namespace p75 A desc element in the SVG namespace p75 A title element in the SVG namespace p75
10.2.5.22 The "after body" insertion mode When the insertion mode p628 is "after body p684 ", tokens must be handled as follows:
684
A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A comment token Append a Comment p33 node to the first element in the stack of open elements p629 (the html p116 element), with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . An end tag whose tag name is "html" If the parser was originally created as part of the HTML fragment parsing algorithm p696 , this is a parse error p620 ; ignore the token. (fragment case p696 ) Otherwise, switch the insertion mode p628 to "after after body p686 ". An end-of-file token Stop parsing p687 . Anything else Parse error p620 . Switch the insertion mode p628 to "in body p665 " and reprocess the token.
10.2.5.23 The "in frameset" insertion mode When the insertion mode p628 is "in frameset p685 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . A start tag whose tag name is "frameset" Insert an HTML element p657 for the token. An end tag whose tag name is "frameset" If the current node p629 is the root html p116 element, then this is a parse error p620 ; ignore the token. (fragment case p696 ) Otherwise, pop the current node p629 from the stack of open elements p629 . If the parser was not originally created as part of the HTML fragment parsing algorithm p696 (fragment case p696 ), and the current node p629 is no longer a frameset p747 element, then switch the insertion mode p628 to "after frameset p686 ". A start tag whose tag name is "frame" Insert an HTML element p657 for the token. Immediately pop the current node p629 off the stack of open elements p629 . Acknowledge the token's self-closing flag p632 , if it is set. A start tag whose tag name is "noframes" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . An end-of-file token If the current node p629 is not the root html p116 element, then this is a parse error p620 . Note: It can only be the current node p629 in the fragment case p696 .
685
Stop parsing p687 . Anything else Parse error p620 . Ignore the token.
10.2.5.24 The "after frameset" insertion mode When the insertion mode p628 is "after frameset p686 ", tokens must be handled as follows: A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE Insert the character p656 into the current node p629 . A comment token Append a Comment p33 node to the current node p629 with the data attribute set to the data given in the comment token. A DOCTYPE token Parse error p620 . Ignore the token. A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . An end tag whose tag name is "html" Switch the insertion mode p628 to "after after frameset p686 ". A start tag whose tag name is "noframes" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . An end-of-file token Stop parsing p687 . Anything else Parse error p620 . Ignore the token.
10.2.5.25 The "after after body" insertion mode When the insertion mode p628 is "after after body p686 ", tokens must be handled as follows: A comment token Append a Comment p33 node to the Document p33 object with the data attribute set to the data given in the comment token. A DOCTYPE token A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 . An end-of-file token Stop parsing p687 . Anything else Parse error p620 . Switch the insertion mode p628 to "in body p665 " and reprocess the token.
10.2.5.26 The "after after frameset" insertion mode When the insertion mode p628 is "after after frameset p686 ", tokens must be handled as follows: A comment token Append a Comment p33 node to the Document p33 object with the data attribute set to the data given in the comment token. A DOCTYPE token A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE A start tag whose tag name is "html" Process the token using the rules for p628 the "in body p665 " insertion mode p628 .
686
An end-of-file token Stop parsing p687 . A start tag whose tag name is "noframes" Process the token using the rules for p628 the "in head p662 " insertion mode p628 . Anything else Parse error p620 . Ignore the token.
2.
3.
4.
4. 5. 6. 7. 8.
Queue a task p553 to fire a simple event p559 that bubbles named DOMContentLoaded at the Document p33 . Spin the event loop p554 until the set of scripts that will execute as soon as possible p136 is empty. Spin the event loop p554 until there is nothing that delays the load event in the Document p33 . Queue a task p553 to set the current document readiness p82 to "complete". If the Document p33 is in a browsing context p499 , then queue a task p553 to fire a simple event p559 named load at the Document p33 's Window p503 object, but with its target p33 set to the Document p33 object (and the currentTarget set to the Window p503 object). If the Document p33 is in a browsing context p499 , then queue a task p553 to fire a pageshow p529 event at the Window p503 object of the Document p33 , but with its target p33 set to the Document p33 object (and the currentTarget set to the Window p503 object), using the PageTransitionEvent p529 interface, with the persisted p530 attribute set to false. This event must not bubble, must not be cancelable, and has no default action. If the Document p33 is in a browsing context p499 , then queue a task p553 to fire a popstate p529 event at the Document p33 's Window p503 object using the PopStateEvent p529 interface, with the state p529 attribute set to the current value of the pending state object p529 . This event must bubble but not be cancelable and has no default action. If the Document p33 has any pending application cache download process tasks p545 , then queue p553 each such task p553 in the order they were added to the list of pending application cache download process tasks p545 , and then empty the list of pending application cache download process tasks p545 . The task source p553 for these tasks p553 is the networking task source p554 . The Document p33 is now ready for post-load tasks. Queue a task p553 to mark the Document p33 as completely loaded.
9.
10.
11.
12. 13.
When the user agent is to abort a parser, it must run the following steps: 1. Throw away any pending content in the input stream p621 , and discard any future content that would have been added to it. Pop all the nodes off the stack of open elements p629 .
2.
687
Except where otherwise specified, the task source p553 for the tasks p553 mentioned in this section is the DOM manipulation task source p554 .
Note: The mutations allowed by this section apply after the HTML parser p620 's rules have been applied. For example, a <a::> start tag will be closed by a </a::> end tag, and never by a </aU00003AU00003A> end tag, even if the user agent is using the rules above to then generate an actual element in the DOM with the name aU00003AU00003A for that start tag.
688
The most-often discussed example of erroneous markup is as follows: <p>1<b>2<i>3</b>4</i>5</p> The parsing of this markup is straightforward up to the "3". At this point, the DOM looks like this: html p116 head p116 body p142 p p160 #text: 1 b p188 #text: 2 i p187 #text: 3 Here, the stack of open elements p629 has five elements on it: html p116 , body p142 , p p160 , b p188 , and i p187 . The list of active formatting elements p631 just has two: b p188 and i p187 . The insertion mode p628 is "in body p665 ". Upon receiving the end tag token with the tag name "b", the "adoption agency algorithm p669 " is invoked. This is a simple case, in that the formatting element is the b p188 element, and there is no furthest block. Thus, the stack of open elements p629 ends up with just three elements: html p116 , body p142 , and p p160 , while the list of active formatting elements p631 has just one: i p187 . The DOM tree is unmodified at this point. The next token is a character ("4"), triggers the reconstruction of the active formatting elements p631 , in this case just the i p187 element. A new i p187 element is thus created for the "4" text node. After the end tag token for the "i" is also received, and the "5" text node is inserted, the DOM looks as follows: html p116 head p116 body p142 p p160 #text: 1 b p188 #text: 2 i p187 #text: 3 i p187 #text: 4 #text: 5
10.2.8.2 Misnested tags: <b><p></b></p> This section is non-normative. A case similar to the previous one is the following: <b>1<p>2</b>3</p> Up to the "2" the parsing here is straightforward: html p116 head p116 body p142 b p188 #text: 1 p p160 #text: 2 The interesting part is when the end tag token with the tag name "b" is parsed. Before that token is seen, the stack of open elements p629 has four elements on it: html p116 , body p142 , b p188 , and p p160 . The list of active formatting elements p631 just has the one: b p188 . The insertion mode p628 is "in body p665 ". Upon receiving the end tag token with the tag name "b", the "adoption agency algorithm p669 " is invoked, as in the previous example. However, in this case, there is a furthest block, namely the p p160 element. Thus, this time the adoption agency algorithm isn't skipped over. The common ancestor is the body p142 element. A conceptual "bookmark" marks the position of the b p188 in the list of active formatting elements p631 , but since that list has only one element in it, it won't have much effect.
689
As the algorithm progresses, node ends up set to the formatting element (b p188 ), and last node ends up set to the furthest block (p p160 ). The last node gets appended (moved) to the common ancestor, so that the DOM looks like: html p116 head p116 body p142 b p188 #text: 1 p p160 #text: 2 A new b p188 element is created, and the children of the p p160 element are moved to it: html p116 head p116 body p142 b p188 #text: 1 p p160 b p188 #text: 2 Finally, the new b p188 element is appended to the p p160 element, so that the DOM looks like: html p116 head p116 body p142 b p188 #text: 1 p p160 b p188 #text: 2 The b p188 element is removed from the list of active formatting elements p631 and the stack of open elements p629 , so that when the "3" is parsed, it is appended to the p p160 element: html p116 head p116 body p142 b p188 #text: 1 p p160 b p188 #text: 2 #text: 3
10.2.8.3 Unexpected markup in tables This section is non-normative. Error handling in tables is, for historical reasons, especially strange. For example, consider the following markup: <table><b><tr><td>aaa</td></tr>bbb</table>ccc The highlighted b p188 element start tag is not allowed directly inside a table like that, and the parser handles this case by placing the element before the table. (This is called foster parenting p659 .) This can be seen by examining the DOM tree as it stands just after the table p320 element's start tag has been seen: html p116 head p116 body p142 table p320 ...and then immediately after the b p188 element start tag has been seen: html p116 head p116 body p142 b p188 table p320
690
At this point, the stack of open elements p629 has on it the elements html p116 , body p142 , table p320 , and b p188 (in that order, despite the resulting DOM tree); the list of active formatting elements p631 just has the b p188 element in it; and the insertion mode p628 is "in table p676 ". The tr p331 start tag causes the b p188 element to be popped off the stack and a tbody p328 start tag to be implied; the tbody p328 and tr p331 elements are then handled in a rather straight-forward manner, taking the parser through the "in table body p678 " and "in row p679 " insertion modes, after which the DOM looks as follows: html p116 head p116 body p142 b p188 table p320 tbody p328 tr p331 Here, the stack of open elements p629 has on it the elements html p116 , body p142 , table p320 , tbody p328 , and tr p331 ; the list of active formatting elements p631 still has the b p188 element in it; and the insertion mode p628 is "in row p679 ". The td p332 element start tag token, after putting a td p332 element on the tree, puts a marker on the list of active formatting elements p631 (it also switches to the "in cell p680 " insertion mode p628 ). html p116 head p116 body p142 b p188 table p320 tbody p328 tr p331 td p332 The marker means that when the "aaa" character tokens are seen, no b p188 element is created to hold the resulting text node: html p116 head p116 body p142 b p188 table p320 tbody p328 tr p331 td p332 #text: aaa The end tags are handled in a straight-forward manner; after handling them, the stack of open elements p629 has on it the elements html p116 , body p142 , table p320 , and tbody p328 ; the list of active formatting elements p631 still has the b p188 element in it (the marker having been removed by the "td" end tag token); and the insertion mode p628 is "in table body p678 ". Thus it is that the "bbb" character tokens are found. These trigger the "in table text p677 " insertion mode to be used (with the original insertion mode p628 set to "in table body p678 "). The character tokens are collected, and when the next token (the table p320 element end tag) is seen, they are processed as a group. Since they are not all spaces, they are handled as per the "anything else" rules in the "in table p676 " insertion mode, which defer to the "in body p665 " insertion mode but with foster parenting p659 . When the active formatting elements are reconstructed p631 , a b p188 element is created and foster parented p659 , and then the "bbb" text node is appended to it: html p116 head p116 body p142 b p188 b p188 #text: bbb table p320 tbody p328 tr p331 td p332 #text: aaa
691
The stack of open elements p629 has on it the elements html p116 , body p142 , table p320 , tbody p328 , and the new b p188 (again, note that this doesn't match the resulting tree!); the list of active formatting elements p631 has the new b p188 element in it; and the insertion mode p628 is still "in table body p678 ". Had the character tokens been only space characters p37 instead of "bbb", then those space characters p37 would just be appended to the tbody p328 element. Finally, the table p320 is closed by a "table" end tag. This pops all the nodes from the stack of open elements p629 up to and including the table p320 element, but it doesn't affect the list of active formatting elements p631 , so the "ccc" character tokens after the table result in yet another b p188 element being created, this time after the table: html p116 head p116 body p142 b p188 b p188 #text: bbb table p320 tbody p328 tr p331 td p332 #text: aaa b p188 #text: ccc
10.2.8.4 Scripts that modify the page as it is being parsed This section is non-normative. Consider the following markup, which for this example we will assume is the document with URL p55 http://example.com/inner, being rendered as the content of an iframe p213 in another document with the URL p55 http://example.com/outer: <div id=a> <script> var div = document.getElementById('a'); parent.document.body.appendChild(div); </script> <script> alert(document.URL); </script> </div> <script> alert(document.URL); </script> Up to the first "script" end tag, before the script is parsed, the result is relatively straightforward: html p116 head p116 body p142 div p172 id="a p173 " #text: script p133 #text: var div = document.getElementById('a'); ? parent.document.body.appendChild(div); After the script is parsed, though, the div p172 element and its child script p133 element are gone: html p116 head p116 body p142 They are, at this point, in the Document p33 of the aforementioned outer browsing context p499 . However, the stack of open elements p629 still contains the div p172 element. Thus, when the second script p133 element is parsed, it is inserted into the outer Document p33 object. This also means that the script's global object p550 is the outer browsing context p499 's Window p503 object, not the Window p503 object inside the iframe p213 .
692
Note: This isn't a security problem since the script that moves the div p172 into the outer Document p33 can only do so because the two Document p33 object have the same origin p510 . Thus, the first alert says "http://example.com/outer". Once the div p172 element's end tag is parsed, the div p172 element is popped off the stack, and so the next script p133 element is in the inner Document p33 : html p116 head p116 body p142 script p133 #text: alert(document.URL); This second alert will say "http://example.com/inner".
10.2.8.5 Unclosed formatting elements This section is non-normative. The following markup shows how nested formatting elements (such as b p188 ) get collected and continue to be applied even as the elements they are contained in are closed, but that excessive duplicates are thrown away. <!DOCTYPE html> <p><b class=x><b class=x><b><b class=x><b class=x><b>X <p>X <p><b><b class=x><b>X <p></b></b></b></b></b></b>X The resulting DOM tree is as follows: DOCTYPE: html p116 html p116 head p116 body p142 p p160 b p188 class="x" b p188 class="x" b p188 b p188 class="x" b p188 class="x" b p188 #text: X? p p160 b p188 class="x" b p188 b p188 class="x" b p188 class="x" b p188 #text: X? p p160 b p188 class="x" b p188 b p188 class="x" b p188 class="x" b p188 b p188 b p188 class="x" b p188 #text: X? p p160 #text: X? Note how the second p p160 element in the markup has no explicit b p188 elements, but in the resulting DOM, up to three of each kind of formatting element (in this case three b p188 elements with the class attribute, and two unadorned b p188 elements) get reconstructed before the element's "X". Also note how this means that in the final paragraph only six b p188 end tags are needed to completely clear the list of formatting elements, even though nine b p188 start tags have been seen up to this point.
693
If the attribute is in some other namespace The attribute's serialized name is the attribute's qualified name. While the exact order of attributes is UA-defined, and may depend on factors such as the order that the attributes were given in the original markup, the sort order must be stable, such that consecutive invocations of this algorithm serialize an element's attributes in the same order. Append a U+003E GREATER-THAN SIGN character (>). If current node is an area p314 , base p118 , basefont p740 , bgsound p740 , br p194 , col p328 , command p427 , embed p220 , frame p747 , hr p161 , img p199 , input p353 , keygen p398 , link p119 ,
694
meta p122 , param p227 , source p232 , track p234 or wbr p195 element, then continue on to the next child node at this point. If current node is a pre p162 , textarea p395 , or listing p740 element, append a U+000A LINE FEED (LF) character. Append the value of running the HTML fragment serialization algorithm p694 on the current node element (thus recursing into this algorithm for that element), followed by a U+003C LESS-THAN SIGN character (<), a U+002F SOLIDUS character (/), tagname again, and finally a U+003E GREATER-THAN SIGN character (>). If current node is a Text or CDATASection node If the parent of current node is a style p130 , script p133 , xmp p740 , iframe p213 , noembed p740 , noframes p740 , or plaintext p740 element, or if the parent of current node is noscript p140 element and scripting is enabled p550 for the node, then append the value of current node's data IDL attribute literally. Otherwise, append the value of current node's data IDL attribute, escaped as described below p695 . If current node is a Comment Append the literal string <!-- (U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS), followed by the value of current node's data IDL attribute, followed by the literal string --> (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN). If current node is a ProcessingInstruction Append the literal string <? (U+003C LESS-THAN SIGN, U+003F QUESTION MARK), followed by the value of current node's target IDL attribute, followed by a single U+0020 SPACE character, followed by the value of current node's data IDL attribute, followed by a single U+003E GREATER-THAN SIGN character (>). If current node is a DocumentType Append the literal string <!DOCTYPE (U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+0044 LATIN CAPITAL LETTER D, U+004F LATIN CAPITAL LETTER O, U+0043 LATIN CAPITAL LETTER C, U+0054 LATIN CAPITAL LETTER T, U+0059 LATIN CAPITAL LETTER Y, U+0050 LATIN CAPITAL LETTER P, U+0045 LATIN CAPITAL LETTER E), followed by a space (U+0020 SPACE), followed by the value of current node's name IDL attribute, followed by the literal string > (U+003E GREATERTHAN SIGN). Other node types (e.g. Attr) cannot occur as children of elements. If, despite this, they somehow do occur, this algorithm must raise an INVALID_STATE_ERR p75 exception. 3. The result of the algorithm is the string s.
Escaping a string (for the purposes of the algorithm above) consists of replacing any occurrences of the "&" character by the string "&", any occurrences of the U+00A0 NO-BREAK SPACE character by the string " ", and, if the algorithm was invoked in the attribute mode, any occurrences of the """ character by the string """, or if it was not, any occurrences of the "<" character by the string "<", any occurrences of the ">" character by the string ">". Note: Entity reference nodes are assumed to be expanded p33 by the user agent, and are therefore not covered in the algorithm above. Note: It is possible that the output of this algorithm, if parsed with an HTML parser p620 , will not return the original tree structure. For instance, if a textarea p395 element to which a Comment node has been appended is serialized and the output is then reparsed, the comment will end up being displayed in the text field. Similarly, if, as a result of DOM manipulation, an element contains a comment that contains the literal string "-->", then when the result of serializing the element is parsed, the comment will be truncated at that point and the rest of the comment will be interpreted as markup. More examples would be making a script p133 element contain a text node with the text string "</script>", or having a p p160 element that contains a ul p166 element (as the ul p166 element's start tag p615 would imply the end tag for the p p160 ).
695
3. 4.
If the scripting flag p632 is enabled, switch the tokenizer to the RAWTEXT state p633 . Otherwise, leave the tokenizer in the data state p633 .
p740 element If it is a plaintext
Switch the tokenizer to the PLAINTEXT state p634 . Otherwise Leave the tokenizer in the data state p633 . Note: For performance reasons, an implementation that does not report errors and that uses the actual state machine described in this specification directly could use the PLAINTEXT state instead of the RAWTEXT and script data states where those are mentioned in the list above. Except for rules regarding parse errors, they are equivalent, since there is no appropriate end tag token p633 in the fragment case, yet they involve far fewer state transitions. 2. 3. 4. 5. Let root be a new html p116 element with no attributes. Append the element root to the Document p33 node created above. Set up the parser's stack of open elements p629 so that it contains just the single element root. Reset the parser's insertion mode appropriately p629 . Note: The parser will reference the context element as part of that algorithm. 6. Set the parser's form element pointer p632 to the nearest node to the context element that is a form p347 element (going straight up the ancestor chain, and including the element itself, if it is a form p347 element), or, if there is no such form p347 element, to null.
5.
Place into the input stream p621 for the HTML parser p620 just created the input. The encoding confidence p622 is irrelevant. Start the parser and let it run until it has consumed all the characters just inserted into the input stream.
6.
696
7.
If there is a context element, return the child nodes of root, in tree order p29 . Otherwise, return the children of the Document p33 object, in tree order p29 .
Character(s) U+000C6 U+00026 U+000C1 U+00102 U+000C2 U+00410 U+1D504 U+000C0 U+00391 U+00100 U+02A53 U+00104 U+1D538 U+02061 U+000C5 U+1D49C U+02254 U+000C3 U+000C4 U+02216 U+02AE7 U+02306 U+00411 U+02235 U+0212C U+00392 U+1D505 U+1D539 U+002D8 U+0212C U+0224E U+00427 U+000A9 U+00106 U+022D2 U+02145 U+0212D U+0010C U+000C7 U+00108 U+02230 U+0010A U+000B8 U+000B7 U+0212D U+003A7 U+02299 U+02296 U+02295 U+02297 U+02232 U+0201D U+02019 U+02237 U+02A74 U+02261 U+0222F U+0222E U+02102 U+02210 U+02233 U+02A2F U+1D49E U+022D3 U+0224D U+02145 U+02911 U+00402 U+00405 U+0040F U+02021 U+021A1 U+02AE4 U+0010E U+00414 U+02207 U+00394 U+1D507 U+000B4 U+002D9 U+002DD U+00060 U+002DC U+022C4 U+02146 U+1D53B
Name
Character(s) U+000A8 U+020DC U+02250 U+0222F U+000A8 U+021D3 U+021D0 U+021D4 U+02AE4 U+027F8 U+027FA U+027F9 U+021D2 U+022A8 U+021D1 U+021D5 U+02225 U+02193 U+02913 U+021F5 U+00311 U+02950 U+0295E U+021BD U+02956 U+0295F U+021C1 U+02957 U+022A4 U+021A7 U+021D3 U+1D49F U+00110 U+0014A U+000D0 U+000C9 U+0011A U+000CA U+0042D U+00116 U+1D508 U+000C8 U+02208 U+00112 U+025FB U+025AB U+00118 U+1D53C U+00395 U+02A75 U+02242 U+021CC U+02130 U+02A73 U+00397 U+000CB U+02203 U+02147 U+00424 U+1D509 U+025FC U+025AA U+1D53D U+02200 U+02131 U+02131 U+00403 U+0003E U+00393 U+003DC U+0011E U+00122 U+0011C U+00413 U+00120 U+1D50A U+022D9 U+1D53E U+02265 U+022DB U+02267 U+02AA2 U+02277 U+02A7E U+02273 U+1D4A2
Name
Character(s) U+0226B U+0042A U+002C7 U+0005E U+00124 U+0210C U+0210B U+0210D U+02500 U+0210B U+00126 U+0224E U+0224F U+00415 U+00132 U+00401 U+000CD U+000CE U+00418 U+00130 U+02111 U+000CC U+02111 U+0012A U+02148 U+021D2 U+0222C U+0222B U+022C2 U+02063 U+02062 U+0012E U+1D540 U+00399 U+02110 U+00128 U+00406 U+000CF U+00134 U+00419 U+1D50D U+1D541 U+1D4A5 U+00408 U+00404 U+00425 U+0040C U+0039A U+00136 U+0041A U+1D50E U+1D542 U+1D4A6 U+00409 U+0003C U+00139 U+0039B U+027EA U+02112 U+0219E U+0013D U+0013B U+0041B U+027E8 U+02190 U+021E4 U+021C6 U+02308 U+027E6 U+02961 U+021C3 U+02959 U+0230A U+02194 U+0294E U+022A3 U+021A4 U+0295A U+022B2 U+029CF U+022B4 U+02951 U+02960 U+021BF U+02958 U+021BC
Glyph ^
DoubleContourIntegral; DoubleDot; DoubleDownArrow; DoubleLeftArrow; DoubleLeftRightArrow; DoubleLeftTee; DoubleLongLeftArrow; DoubleLongLeftRightArrow; DoubleLongRightArrow; DoubleRightArrow; DoubleRightTee;
HilbertSpace; Hopf; HorizontalLine; Hscr; Hstrok; HumpDownHump; HumpEqual; IEcy; IJlig; IOcy; Iacute; Icirc; Icy; Idot; Ifr; Igrave; Im; Imacr; ImaginaryI; Implies; Int; Integral; Intersection; InvisibleComma; InvisibleTimes; Iogon; Iopf; Iota; Iscr; Itilde; Iukcy; Iuml; Jcirc; Jcy; Jfr; Jopf; Jscr; Jsercy; Jukcy; KHcy; KJcy; Kappa; Kcedil; Kcy; Kfr; Kopf; Kscr; LJcy; LT; Lacute; Lambda; Lang; Laplacetrf; Larr; Lcaron; Lcedil; Lcy; LeftAngleBracket; LeftArrow; LeftArrowBar; LeftArrowRightArrow; LeftCeiling; LeftDoubleBracket; LeftDownTeeVector; LeftDownVector; LeftDownVectorBar; LeftFloor; LeftRightArrow; LeftRightVector; LeftTee; LeftTeeArrow; LeftTeeVector; LeftTriangle; LeftTriangleBar; LeftTriangleEqual; LeftUpDownVector; LeftUpTeeVector; LeftUpVector; LeftUpVectorBar; LeftVector;
? ? ? ? ? ? ? ? ? ? `
DoubleUpArrow; DoubleUpDownArrow; DoubleVerticalBar; DownArrow; DownArrowBar; DownArrowUpArrow; DownBreve; DownLeftRightVector; DownLeftTeeVector; DownLeftVector; DownLeftVectorBar; DownRightTeeVector; DownRightVector; DownRightVectorBar; DownTee; DownTeeArrow; Downarrow; Dscr; Dstrok; ENG; ETH; Eacute; Ecaron; Ecirc; Ecy; Edot; Efr; Egrave; Element; Emacr; EmptySmallSquare; EmptyVerySmallSquare; Eogon; Eopf; Epsilon; Equal; EqualTilde; Equilibrium; Escr; Esim; Eta; Euml; Exists; ExponentialE; Fcy; Ffr; FilledSmallSquare; FilledVerySmallSquare; Fopf; ForAll; Fouriertrf; Fscr; GJcy; GT; Gamma; Gammad; Gbreve; Gcedil; Gcirc; Gcy; Gdot; Gfr; Gg; Gopf; GreaterEqual; GreaterEqualLess; GreaterFullEqual; GreaterGreater; GreaterLess; GreaterSlantEqual; GreaterTilde; Gscr;
? ? ? ? < ? ? ? ? ? ? ? ?
Cross; Cscr; Cup; CupCap; DD; DDotrahd; DJcy; DScy; DZcy; Dagger; Darr; Dashv; Dcaron; Dcy; Del; Delta; Dfr; DiacriticalAcute; DiacriticalDot; DiacriticalDoubleAcute; DiacriticalGrave; DiacriticalTilde; Diamond; DifferentialD; Dopf;
697
Name LeftVectorBar; Leftarrow; Leftrightarrow; LessEqualGreater; LessFullEqual; LessGreater; LessLess; LessSlantEqual; LessTilde; Lfr; Ll; Lleftarrow; Lmidot; LongLeftArrow; LongLeftRightArrow; LongRightArrow; Longleftarrow; Longleftrightarrow; Longrightarrow; Lopf; LowerLeftArrow; LowerRightArrow; Lscr; Lsh; Lstrok; Lt; Map; Mcy; MediumSpace; Mellintrf; Mfr; MinusPlus; Mopf; Mscr; Mu; NJcy; Nacute; Ncaron; Ncedil; Ncy; NegativeMediumSpace; NegativeThickSpace; NegativeThinSpace; NegativeVeryThinSpace; NestedGreaterGreater; NestedLessLess; NewLine; Nfr; NoBreak; NonBreakingSpace; Nopf; Not; NotCongruent; NotCupCap; NotDoubleVerticalBar; NotElement; NotEqual; NotEqualTilde; NotExists; NotGreater; NotGreaterEqual; NotGreaterFullEqual; NotGreaterGreater; NotGreaterLess; NotGreaterSlantEqual; NotGreaterTilde; NotHumpDownHump; NotHumpEqual; NotLeftTriangle; NotLeftTriangleBar; NotLeftTriangleEqual; NotLess; NotLessEqual; NotLessGreater; NotLessLess; NotLessSlantEqual; NotLessTilde; NotNestedGreaterGreater; NotNestedLessLess; NotPrecedes; NotPrecedesEqual; NotPrecedesSlantEqual; NotReverseElement; NotRightTriangle; NotRightTriangleBar; NotRightTriangleEqual; NotSquareSubset; NotSquareSubsetEqual; NotSquareSuperset; NotSquareSupersetEqual; NotSubset; NotSubsetEqual; NotSucceeds; NotSucceedsEqual; NotSucceedsSlantEqual; NotSucceedsTilde; NotSuperset; NotSupersetEqual; NotTilde; NotTildeEqual;
Character(s) U+02952 U+021D0 U+021D4 U+022DA U+02266 U+02276 U+02AA1 U+02A7D U+02272 U+1D50F U+022D8 U+021DA U+0013F U+027F5 U+027F7 U+027F6 U+027F8 U+027FA U+027F9 U+1D543 U+02199 U+02198 U+02112 U+021B0 U+00141 U+0226A U+02905 U+0041C U+0205F U+02133 U+1D510 U+02213 U+1D544 U+02133 U+0039C U+0040A U+00143 U+00147 U+00145 U+0041D U+0200B U+0200B U+0200B U+0200B U+0226B U+0226A U+0000A U+1D511 U+02060 U+000A0 U+02115 U+02AEC U+02262 U+0226D U+02226 U+02209 U+02260 U+02242 U+00338 U+02204 U+0226F U+02271 U+02267 U+00338 U+0226B U+00338 U+02279 U+02A7E U+00338 U+02275 U+0224E U+00338 U+0224F U+00338 U+022EA U+029CF U+00338 U+022EC U+0226E U+02270 U+02278 U+0226A U+00338 U+02A7D U+00338 U+02274 U+02AA2 U+00338 U+02AA1 U+00338 U+02280 U+02AAF U+00338 U+022E0 U+0220C U+022EB U+029D0 U+00338 U+022ED U+0228F U+00338 U+022E2 U+02290 U+00338 U+022E3 U+02282 U+020D2 U+02288 U+02281 U+02AB0 U+00338 U+022E1 U+0227F U+00338 U+02283 U+020D2 U+02289 U+02241 U+02244
Glyph ? ? ? ?
Name NotTildeFullEqual; NotTildeTilde; NotVerticalBar; Nscr; Ntilde; Nu; OElig; Oacute; Ocirc; Ocy; Odblac; Ofr; Ograve; Omacr; Omega; Omicron; Oopf; OpenCurlyDoubleQuote; OpenCurlyQuote; Or; Oscr; Oslash; Otilde; Otimes; Ouml; OverBar; OverBrace; OverBracket; OverParenthesis;
Character(s) U+02247 U+02249 U+02224 U+1D4A9 U+000D1 U+0039D U+00152 U+000D3 U+000D4 U+0041E U+00150 U+1D512 U+000D2 U+0014C U+003A9 U+0039F U+1D546 U+0201C U+02018 U+02A54 U+1D4AA U+000D8 U+000D5 U+02A37 U+000D6 U+0203E U+023DE U+023B4 U+023DC U+02202 U+0041F U+1D513 U+003A6 U+003A0 U+000B1 U+0210C U+02119 U+02ABB U+0227A U+02AAF U+0227C U+0227E U+02033 U+0220F U+02237 U+0221D U+1D4AB U+003A8 U+00022 U+1D514 U+0211A U+1D4AC U+02910 U+000AE U+00154 U+027EB U+021A0 U+02916 U+00158 U+00156 U+00420 U+0211C U+0220B U+021CB U+0296F U+0211C U+003A1 U+027E9 U+02192 U+021E5 U+021C4 U+02309 U+027E7 U+0295D U+021C2 U+02955 U+0230B U+022A2 U+021A6 U+0295B U+022B3 U+029D0 U+022B5 U+0294F U+0295C U+021BE U+02954 U+021C0 U+02953 U+021D2 U+0211D U+02970 U+021DB U+0211B U+021B1 U+029F4 U+00429 U+00428 U+0042C U+0015A
Name
Character(s) U+02ABC U+00160 U+0015E U+0015C U+00421 U+1D516 U+02193 U+02190 U+02192 U+02191 U+003A3 U+02218 U+1D54A U+0221A U+025A1 U+02293 U+0228F U+02291 U+02290 U+02292 U+02294 U+1D4AE U+022C6 U+022D0 U+022D0 U+02286 U+0227B U+02AB0 U+0227D U+0227F U+0220B U+02211 U+022D1 U+02283 U+02287 U+022D1 U+000DE U+02122 U+0040B U+00426 U+00009 U+003A4 U+00164 U+00162 U+00422 U+1D517 U+02234 U+00398 U+0205F U+0200A U+02009 U+0223C U+02243 U+02245 U+02248 U+1D54B U+020DB U+1D4AF U+00166 U+000DA U+0219F U+02949 U+0040E U+0016C U+000DB U+00423 U+00170 U+1D518 U+000D9 U+0016A U+0005F U+023DF U+023B5 U+023DD U+022C3 U+0228E U+00172 U+1D54C U+02191 U+02912 U+021C5 U+02195 U+0296E U+022A5 U+021A5 U+021D1 U+021D5 U+02196 U+02197 U+003D2 U+003A5 U+0016E U+1D4B0 U+00168 U+000DC U+022AB U+02AEB U+00412 U+022A9 U+02AE6 U+022C1
Glyph ? ? ? ? ? ? ? ? ?
ShortDownArrow; ShortLeftArrow; ShortRightArrow; ShortUpArrow; Sigma; SmallCircle; Sopf; Sqrt; Square; SquareIntersection; SquareSubset; SquareSubsetEqual; SquareSuperset; SquareSupersetEqual; SquareUnion; Sscr; Star; Sub; Subset; SubsetEqual; Succeeds; SucceedsEqual; SucceedsSlantEqual; SucceedsTilde; SuchThat; Sum; Sup; Superset; SupersetEqual; Supset; THORN; TRADE; TSHcy; TScy; Tab; Tau; Tcaron; Tcedil; Tcy; Tfr; Therefore; Theta; ThickSpace; ThinSpace; Tilde; TildeEqual; TildeFullEqual; TildeTilde; Topf; TripleDot; Tscr; Tstrok; Uacute; Uarr; Uarrocir; Ubrcy; Ubreve; Ucirc; Ucy; Udblac; Ufr; Ugrave; Umacr; UnderBar; UnderBrace; UnderBracket; UnderParenthesis; Union; UnionPlus; Uogon; Uopf; UpArrow; UpArrowBar; UpArrowDownArrow; UpDownArrow; UpEquilibrium; UpTee; UpTeeArrow; Uparrow; Updownarrow; UpperLeftArrow; UpperRightArrow; Upsi; Upsilon; Uring; Uscr; Utilde; Uuml; VDash; Vbar; Vcy; Vdash; Vdashl; Vee;
PartialD; Pcy; Pfr; Phi; Pi; PlusMinus; Poincareplane; Popf; Pr; Precedes; PrecedesEqual; PrecedesSlantEqual; PrecedesTilde; Prime; Product;
? ?
? ? ? ? ?
Qopf; Qscr; RBarr; REG; Racute; Rang; Rarr; Rarrtl; Rcaron; Rcedil; Rcy; Re; ReverseElement; ReverseEquilibrium; ReverseUpEquilibrium; Rfr; Rho; RightAngleBracket; RightArrow; RightArrowBar; RightArrowLeftArrow; RightCeiling; RightDoubleBracket; RightDownTeeVector; RightDownVector; RightDownVectorBar; RightFloor; RightTee; RightTeeArrow; RightTeeVector; RightTriangle; RightTriangleBar; RightTriangleEqual; RightUpDownVector; RightUpTeeVector; RightUpVector; RightUpVectorBar; RightVector; RightVectorBar; Rightarrow; Ropf; RoundImplies; Rrightarrow; Rscr; Rsh; RuleDelayed; SHCHcy; SHcy; SOFTcy; Sacute;
? ? ? ? _ ? ? ? ? ? ? ? ?
698
Name Verbar; Vert; VerticalBar; VerticalLine; VerticalSeparator; VerticalTilde; VeryThinSpace; Vfr; Vopf; Vscr; Vvdash; Wcirc; Wedge; Wfr; Wopf; Wscr; Xfr; Xi; Xopf; Xscr; YAcy; YIcy; YUcy; Yacute; Ycirc; Ycy; Yfr; Yopf; Yscr; Yuml; ZHcy; Zacute; Zcaron; Zcy; Zdot; ZeroWidthSpace; Zeta; Zfr; Zopf; Zscr; aacute; abreve; ac; acE; acd; acirc; acute; acy; aelig; af; afr; agrave; alefsym; aleph; alpha; amacr; amalg; amp; and; andand; andd; andslope; andv; ang; ange; angle; angmsd; angmsdaa; angmsdab; angmsdac; angmsdad; angmsdae; angmsdaf; angmsdag; angmsdah; angrt; angrtvb; angrtvbd; angsph; angst; angzarr; aogon; aopf; ap; apE; apacir; ape; apid; apos; approx; approxeq; aring; ascr; ast; asymp; asympeq; atilde; auml; awconint; awint;
Character(s) U+02016 U+02016 U+02223 U+0007C U+02758 U+02240 U+0200A U+1D519 U+1D54D U+1D4B1 U+022AA U+00174 U+022C0 U+1D51A U+1D54E U+1D4B2 U+1D51B U+0039E U+1D54F U+1D4B3 U+0042F U+00407 U+0042E U+000DD U+00176 U+0042B U+1D51C U+1D550 U+1D4B4 U+00178 U+00416 U+00179 U+0017D U+00417 U+0017B U+0200B U+00396 U+02128 U+02124 U+1D4B5 U+000E1 U+00103 U+0223E U+0223E U+00333 U+0223F U+000E2 U+000B4 U+00430 U+000E6 U+02061 U+1D51E U+000E0 U+02135 U+02135 U+003B1 U+00101 U+02A3F U+00026 U+02227 U+02A55 U+02A5C U+02A58 U+02A5A U+02220 U+029A4 U+02220 U+02221 U+029A8 U+029A9 U+029AA U+029AB U+029AC U+029AD U+029AE U+029AF U+0221F U+022BE U+0299D U+02222 U+000C5 U+0237C U+00105 U+1D552 U+02248 U+02A70 U+02A6F U+0224A U+0224B U+00027 U+02248 U+0224A U+000E5 U+1D4B6 U+0002A U+02248 U+0224D U+000E3 U+000E4 U+02233 U+02A11
Name
Character(s) U+02AED U+0224C U+003F6 U+02035 U+0223D U+022CD U+022BD U+02305 U+02305 U+023B5 U+023B6 U+0224C U+00431 U+0201E U+02235 U+02235 U+029B0 U+003F6 U+0212C U+003B2 U+02136 U+0226C U+1D51F U+022C2 U+025EF U+022C3 U+02A00 U+02A01 U+02A02 U+02A06 U+02605 U+025BD U+025B3 U+02A04 U+022C1 U+022C0 U+0290D U+029EB U+025AA U+025B4 U+025BE U+025C2 U+025B8 U+02423 U+02592 U+02591 U+02593 U+02588 U+0003D U+020E5 U+02261 U+020E5 U+02310 U+1D553 U+022A5 U+022A5 U+022C8 U+02557 U+02554 U+02556 U+02553 U+02550 U+02566 U+02569 U+02564 U+02567 U+0255D U+0255A U+0255C U+02559 U+02551 U+0256C U+02563 U+02560 U+0256B U+02562 U+0255F U+029C9 U+02555 U+02552 U+02510 U+0250C U+02500 U+02565 U+02568 U+0252C U+02534 U+0229F U+0229E U+022A0 U+0255B U+02558 U+02518 U+02514 U+02502 U+0256A U+02561 U+0255E U+0253C U+02524 U+0251C U+02035
Glyph ? ? ? ? ? ? ? ? =? ? ? breve; brvbar; bscr; bsemi; bsim; bsime; bsol; bsolb; bsolhsub; bull; bullet; bump; bumpE; bumpe; bumpeq; cacute; cap; capand; capbrcup; capcap; capcup; capdot; caps; caret; caron; ccaps; ccaron; ccedil; ccirc; ccups; ccupssm; cdot; cedil; cemptyv; cent;
Name
Character(s) U+002D8 U+000A6 U+1D4B7 U+0204F U+0223D U+022CD U+0005C U+029C5 U+027C8 U+02022 U+02022 U+0224E U+02AAE U+0224F U+0224F U+00107 U+02229 U+02A44 U+02A49 U+02A4B U+02A47 U+02A40 U+02229 U+0FE00 U+02041 U+002C7 U+02A4D U+0010D U+000E7 U+00109 U+02A4C U+02A50 U+0010B U+000B8 U+029B2 U+000A2 U+000B7 U+1D520 U+00447 U+02713 U+02713 U+003C7 U+025CB U+029C3 U+002C6 U+02257 U+021BA U+021BB U+000AE U+024C8 U+0229B U+0229A U+0229D U+02257 U+02A10 U+02AEF U+029C2 U+02663 U+02663 U+0003A U+02254 U+02254 U+0002C U+00040 U+02201 U+02218 U+02201 U+02102 U+02245 U+02A6D U+0222E U+1D554 U+02210 U+000A9 U+02117 U+021B5 U+02717 U+1D4B8 U+02ACF U+02AD1 U+02AD0 U+02AD2 U+022EF U+02938 U+02935 U+022DE U+022DF U+021B6 U+0293D U+0222A U+02A48 U+02A46 U+02A4A U+0228D U+02A45 U+0222A U+0FE00 U+021B7 U+0293C U+022DE U+022DF U+022CE
Glyph ? \ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? : , @ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? ? ? ? ?
barwed; barwedge; bbrk; bbrktbrk; bcong; bcy; bdquo; becaus; because; bemptyv; bepsi; bernou; beta; beth; between; bfr; bigcap; bigcirc; bigcup; bigodot; bigoplus; bigotimes; bigsqcup; bigstar; bigtriangledown; bigtriangleup; biguplus; bigvee; bigwedge;
centerdot; cfr; chcy; check; checkmark; chi; cir; cirE; circ; circeq; circlearrowleft; circlearrowright; circledR; circledS; circledast; circledcirc; circleddash; cire; cirfnint; cirmid; cirscir; clubs; clubsuit; colon; colone; coloneq; comma; commat; comp; compfn; complement; complexes; cong; congdot; conint; copf; coprod; copy; copysr; crarr; cross; cscr; csub; csube; csup; csupe; ctdot; cudarrl; cudarrr; cuepr; cuesc; cularr; cularrp; cup; cupbrcap; cupcap; cupcup; cupdot; cupor; cups; curarr; curarrm; curlyeqprec; curlyeqsucc; curlyvee;
bkarow; blacklozenge; blacksquare; blacktriangle; blacktriangledown; blacktriangleleft; blacktriangleright; blank; blk12; blk14; blk34; block; bne; bnequiv;
? ? & ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ' ? *
bnot; bopf; bot; bottom; bowtie; boxDL; boxDR; boxDl; boxDr; boxH; boxHD; boxHU; boxHd; boxHu; boxUL; boxUR; boxUl; boxUr; boxV; boxVH; boxVL; boxVR; boxVh; boxVl; boxVr; boxbox; boxdL; boxdR; boxdl; boxdr; boxh; boxhD; boxhU; boxhd; boxhu; boxminus; boxplus; boxtimes; boxuL; boxuR; boxul; boxur; boxv; boxvH; boxvL; boxvR; boxvh; boxvl; boxvr; bprime;
699
Name curlywedge; curren; curvearrowleft; curvearrowright; cuvee; cuwed; cwconint; cwint; cylcty; dArr; dHar; dagger; daleth; darr; dash; dashv; dbkarow; dblac; dcaron; dcy; dd; ddagger; ddarr; ddotseq; deg; delta; demptyv; dfisht; dfr; dharl; dharr; diam; diamond; diamondsuit; diams; die; digamma; disin; div; divide; divideontimes; divonx; djcy; dlcorn; dlcrop; dollar; dopf; dot; doteq; doteqdot; dotminus; dotplus; dotsquare; doublebarwedge; downarrow; downdownarrows; downharpoonleft; downharpoonright; drbkarow; drcorn; drcrop; dscr; dscy; dsol; dstrok; dtdot; dtri; dtrif; duarr; duhar; dwangle; dzcy; dzigrarr; eDDot; eDot; eacute; easter; ecaron; ecir; ecirc; ecolon; ecy; edot; ee; efDot; efr; eg; egrave; egs; egsdot; el; elinters; ell; els; elsdot; emacr; empty; emptyset; emptyv; emsp;
Character(s) U+022CF U+000A4 U+021B6 U+021B7 U+022CE U+022CF U+02232 U+02231 U+0232D U+021D3 U+02965 U+02020 U+02138 U+02193 U+02010 U+022A3 U+0290F U+002DD U+0010F U+00434 U+02146 U+02021 U+021CA U+02A77 U+000B0 U+003B4 U+029B1 U+0297F U+1D521 U+021C3 U+021C2 U+022C4 U+022C4 U+02666 U+02666 U+000A8 U+003DD U+022F2 U+000F7 U+000F7 U+022C7 U+022C7 U+00452 U+0231E U+0230D U+00024 U+1D555 U+002D9 U+02250 U+02251 U+02238 U+02214 U+022A1 U+02306 U+02193 U+021CA U+021C3 U+021C2 U+02910 U+0231F U+0230C U+1D4B9 U+00455 U+029F6 U+00111 U+022F1 U+025BF U+025BE U+021F5 U+0296F U+029A6 U+0045F U+027FF U+02A77 U+02251 U+000E9 U+02A6E U+0011B U+02256 U+000EA U+02255 U+0044D U+00117 U+02147 U+02252 U+1D522 U+02A9A U+000E8 U+02A96 U+02A98 U+02A99 U+023E7 U+02113 U+02A95 U+02A97 U+00113 U+02205 U+02205 U+02205 U+02003
Glyph ? ? ? ? ? ? ? ? ? ? ? ? $ ? ? ? ? ? ? ? ? ? emsp13; emsp14; eng; ensp; eogon; eopf; epar; eparsl; eplus; epsi; epsilon; epsiv; eqcirc; eqcolon; eqsim;
Name
Character(s) U+02004 U+02005 U+0014B U+02002 U+00119 U+1D556 U+022D5 U+029E3 U+02A71 U+003B5 U+003B5 U+003F5 U+02256 U+02255 U+02242 U+02A96 U+02A95 U+0003D U+0225F U+02261 U+02A78 U+029E5 U+02253 U+02971 U+0212F U+02250 U+02242 U+003B7 U+000F0 U+000EB U+020AC U+00021 U+02203 U+02130 U+02147 U+02252 U+00444 U+02640 U+0FB03 U+0FB00 U+0FB04 U+1D523 U+0FB01 U+00066 U+0006A U+0266D U+0FB02 U+025B1 U+00192 U+1D557 U+02200 U+022D4 U+02AD9 U+02A0D U+000BD U+02153 U+000BC U+02155 U+02159 U+0215B U+02154 U+02156 U+000BE U+02157 U+0215C U+02158 U+0215A U+0215D U+0215E U+02044 U+02322 U+1D4BB U+02267 U+02A8C U+001F5 U+003B3 U+003DD U+02A86 U+0011F U+0011D U+00433 U+00121 U+02265 U+022DB U+02265 U+02267 U+02A7E U+02A7E U+02AA9 U+02A80 U+02A82 U+02A84 U+022DB U+0FE00 U+02A94 U+1D524 U+0226B U+022D9 U+02137 U+00453 U+02277 U+02A92
Glyph gla; glj; gnE; gnap; ? ? ? = ? ? ? ! ffi ff ffl ? fi fj fl ? ? ? ? ? ? gnapprox; gne; gneq; gneqq; gnsim; gopf; grave; gscr; gsim; gsime; gsiml; gt; gtcc; gtcir; gtdot; gtlPar; gtquest;
Name
Character(s) U+02AA5 U+02AA4 U+02269 U+02A8A U+02A8A U+02A88 U+02A88 U+02269 U+022E7 U+1D558 U+00060 U+0210A U+02273 U+02A8E U+02A90 U+0003E U+02AA7 U+02A7A U+022D7 U+02995 U+02A7C U+02A86 U+02978 U+022D7 U+022DB U+02A8C U+02277 U+02273 U+02269 U+0FE00 U+02269 U+0FE00 U+021D4 U+0200A U+000BD U+0210B U+0044A U+02194 U+02948 U+021AD U+0210F U+00125 U+02665 U+02665 U+02026 U+022B9 U+1D525 U+02925 U+02926 U+021FF U+0223B U+021A9 U+021AA U+1D559 U+02015 U+1D4BD U+0210F U+00127 U+02043 U+02010 U+000ED U+02063 U+000EE U+00438 U+00435 U+000A1 U+021D4 U+1D526 U+000EC U+02148 U+02A0C U+0222D U+029DC U+02129 U+00133 U+0012B U+02111 U+02110 U+02111 U+00131 U+022B7 U+001B5 U+02208 U+02105 U+0221E U+029DD U+00131 U+0222B U+022BA U+02124 U+022BA U+02A17 U+02A3C U+00451 U+0012F U+1D55A U+003B9 U+02A3C U+000BF U+1D4BE U+02208 U+022F9
Glyph ? ? ` g > ? ? ? ? ?
eqslantgtr; eqslantless; equals; equest; equiv; equivDD; eqvparsl; erDot; erarr; escr; esdot; esim; eta; eth; euml; euro; excl; exist; expectation; exponentiale; fallingdotseq; fcy; female; ffilig; fflig; ffllig; ffr; filig; fjlig; flat; fllig; fltns; fnof; fopf; forall; fork; forkv; fpartint; frac12; frac13; frac14; frac15; frac16; frac18; frac23; frac25; frac34; frac35; frac38; frac45; frac56; frac58; frac78; frasl; frown; fscr; gE; gEl; gacute; gamma; gammad; gap; gbreve; gcirc; gcy; gdot; ge; gel; geq; geqq; geqslant; ges; gescc; gesdot; gesdoto; gesdotol; gesl; gesles; gfr; gg; ggg; gimel; gjcy; gl; glE;
gtrapprox; gtrarr; gtrdot; gtreqless; gtreqqless; gtrless; gtrsim; gvertneqq; gvnE; hArr; hairsp; half; hamilt; hardcy; harr; harrcir; harrw; hbar; hcirc; hearts; heartsuit; hellip; hercon; hfr; hksearow; hkswarow; hoarr; homtht; hookleftarrow; hookrightarrow; hopf; horbar; hscr; hslash; hstrok; hybull; hyphen; iacute; ic; icirc; icy; iecy; iexcl; iff; ifr; igrave; ii; iiiint; iiint; iinfin; iiota; ijlig; imacr; image; imagline; imagpart; imath; imof; imped; in; incare; infin; infintie; inodot; int; intcal; integers; intercal; intlarhk; intprod; iocy; iogon; iopf; iota; iprod; iquest; iscr; isin; isinE;
? ? ? ? ? ? ? ? ? ? ?
700
Name isindot; isins; isinsv; isinv; it; itilde; iukcy; iuml; jcirc; jcy; jfr; jmath; jopf; jscr; jsercy; jukcy; kappa; kappav; kcedil; kcy; kfr; kgreen; khcy; kjcy; kopf; kscr; lAarr; lArr; lAtail; lBarr; lE; lEg; lHar; lacute; laemptyv; lagran; lambda; lang; langd; langle; lap; laquo; larr; larrb; larrbfs; larrfs; larrhk; larrlp; larrpl; larrsim; larrtl; lat; latail; late; lates; lbarr; lbbrk; lbrace; lbrack; lbrke; lbrksld; lbrkslu; lcaron; lcedil; lceil; lcub; lcy; ldca; ldquo; ldquor; ldrdhar; ldrushar; ldsh; le; leftarrow; leftarrowtail; leftharpoondown; leftharpoonup; leftleftarrows; leftrightarrow; leftrightarrows; leftrightharpoons; leftrightsquigarrow; leftthreetimes; leg; leq; leqq; leqslant; les; lescc; lesdot; lesdoto; lesdotor; lesg; lesges; lessapprox; lessdot; lesseqgtr; lesseqqgtr; lessgtr;
Character(s) U+022F5 U+022F4 U+022F3 U+02208 U+02062 U+00129 U+00456 U+000EF U+00135 U+00439 U+1D527 U+00237 U+1D55B U+1D4BF U+00458 U+00454 U+003BA U+003F0 U+00137 U+0043A U+1D528 U+00138 U+00445 U+0045C U+1D55C U+1D4C0 U+021DA U+021D0 U+0291B U+0290E U+02266 U+02A8B U+02962 U+0013A U+029B4 U+02112 U+003BB U+027E8 U+02991 U+027E8 U+02A85 U+000AB U+02190 U+021E4 U+0291F U+0291D U+021A9 U+021AB U+02939 U+02973 U+021A2 U+02AAB U+02919 U+02AAD U+02AAD U+0FE00 U+0290C U+02772 U+0007B U+0005B U+0298B U+0298F U+0298D U+0013E U+0013C U+02308 U+0007B U+0043B U+02936 U+0201C U+0201E U+02967 U+0294B U+021B2 U+02264 U+02190 U+021A2 U+021BD U+021BC U+021C7 U+02194 U+021C6 U+021CB U+021AD U+022CB U+022DA U+02264 U+02266 U+02A7D U+02A7D U+02AA8 U+02A7F U+02A81 U+02A83 U+022DA U+0FE00 U+02A93 U+02A85 U+022D6 U+022DA U+02A8B U+02276
Glyph lesssim; lfisht; lfloor; lfr; lg; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? { [ ? ? ? { ? ? ? ? lgE; lhard; lharu; lharul; lhblk; ljcy; ll; llarr; llcorner; llhard; lltri; lmidot; lmoust;
Name
Character(s) U+02272 U+0297C U+0230A U+1D529 U+02276 U+02A91 U+021BD U+021BC U+0296A U+02584 U+00459 U+0226A U+021C7 U+0231E U+0296B U+025FA U+00140 U+023B0 U+023B0 U+02268 U+02A89 U+02A89 U+02A87 U+02A87 U+02268 U+022E6 U+027EC U+021FD U+027E6 U+027F5 U+027F7 U+027FC U+027F6 U+021AB U+021AC U+02985 U+1D55D U+02A2D U+02A34 U+02217 U+0005F U+025CA U+025CA U+029EB U+00028 U+02993 U+021C6 U+0231F U+021CB U+0296D U+0200E U+022BF U+02039 U+1D4C1 U+021B0 U+02272 U+02A8D U+02A8F U+0005B U+02018 U+0201A U+00142 U+0003C U+02AA6 U+02A79 U+022D6 U+022CB U+022C9 U+02976 U+02A7B U+02996 U+025C3 U+022B4 U+025C2 U+0294A U+02966 U+02268 U+0FE00 U+02268 U+0FE00 U+0223A U+000AF U+02642 U+02720 U+02720 U+021A6 U+021A6 U+021A7 U+021A4 U+021A5 U+025AE U+02A29 U+0043C U+02014 U+02221 U+1D52A U+02127 U+000B5 U+02223 U+0002A U+02AF0 U+000B7
Glyph ? ? ? ? ? ? ? ? ? ? _ ( ? ? ? [ < ? ? ? ? ? ? ? ? ? * ? minus; minusb; minusd; minusdu; mlcp; mldr; mnplus; models; mopf; mp; mscr; mstpos; mu; multimap; mumap; nGg; nGt; nGtv;
Name
Character(s) U+02212 U+0229F U+02238 U+02A2A U+02ADB U+02026 U+02213 U+022A7 U+1D55E U+02213 U+1D4C2 U+0223E U+003BC U+022B8 U+022B8 U+022D9 U+00338 U+0226B U+020D2 U+0226B U+00338 U+021CD U+021CE U+022D8 U+00338 U+0226A U+020D2 U+0226A U+00338 U+021CF U+022AF U+022AE U+02207 U+00144 U+02220 U+020D2 U+02249 U+02A70 U+00338 U+0224B U+00338 U+00149 U+02249 U+0266E U+0266E U+02115 U+000A0 U+0224E U+00338 U+0224F U+00338 U+02A43 U+00148 U+00146 U+02247 U+02A6D U+00338 U+02A42 U+0043D U+02013 U+02260 U+021D7 U+02924 U+02197 U+02197 U+02250 U+00338 U+02262 U+02928 U+02242 U+00338 U+02204 U+02204 U+1D52B U+02267 U+00338 U+02271 U+02271 U+02267 U+00338 U+02A7E U+00338 U+02A7E U+00338 U+02275 U+0226F U+0226F U+021CE U+021AE U+02AF2 U+0220B U+022FC U+022FA U+0220B U+0045A U+021CD U+02266 U+00338 U+0219A U+02025 U+02270 U+0219A U+021AE U+02270 U+02266 U+00338 U+02A7D U+00338 U+02A7D U+00338 U+0226E U+02274 U+0226E U+022EA U+022EC U+02224 U+1D55F U+000AC U+02209 U+022F9 U+00338 U+022F5 U+00338 U+02209
Glyph ? ? ? ? ? ? ?
lmoustache; lnE; lnap; lnapprox; lne; lneq; lneqq; lnsim; loang; loarr; lobrk; longleftarrow; longleftrightarrow; longmapsto; longrightarrow; looparrowleft; looparrowright; lopar; lopf; loplus; lotimes; lowast; lowbar; loz; lozenge; lozf; lpar; lparlt; lrarr; lrcorner; lrhar; lrhard; lrm; lrtri; lsaquo; lscr; lsh; lsim; lsime; lsimg; lsqb; lsquo; lsquor; lstrok; lt; ltcc; ltcir; ltdot; lthree; ltimes; ltlarr; ltquest; ltrPar; ltri; ltrie; ltrif; lurdshar; luruhar; lvertneqq; lvnE; mDDot; macr; male; malt; maltese; map; mapsto; mapstodown; mapstoleft; mapstoup; marker; mcomma; mcy; mdash; measuredangle; mfr; mho; micro; mid; midast; midcir; middot;
nLeftarrow; nLeftrightarrow; nLl; nLt; nLtv; nRightarrow; nVDash; nVdash; nabla; nacute; nang; nap; napE; napid; napos; napprox; natur; natural; naturals; nbsp; nbump; nbumpe; ncap; ncaron; ncedil; ncong; ncongdot; ncup; ncy; ndash; ne; neArr; nearhk; nearr; nearrow; nedot; nequiv; nesear; nesim; nexist; nexists; nfr; ngE; nge; ngeq; ngeqq; ngeqslant; nges; ngsim; ngt; ngtr; nhArr; nharr; nhpar; ni; nis; nisd; niv; njcy; nlArr; nlE; nlarr; nldr; nle; nleftarrow; nleftrightarrow; nleq; nleqq; nleqslant; nles; nless; nlsim; nlt; nltri; nltrie; nmid; nopf; not; notin; notinE; notindot; notinva;
? ? ? ? ? ? ?
701
Name notinvb; notinvc; notni; notniva; notnivb; notnivc; npar; nparallel; nparsl; npart; npolint; npr; nprcue; npre; nprec; npreceq; nrArr; nrarr; nrarrc; nrarrw; nrightarrow; nrtri; nrtrie; nsc; nsccue; nsce; nscr; nshortmid; nshortparallel; nsim; nsime; nsimeq; nsmid; nspar; nsqsube; nsqsupe; nsub; nsubE; nsube; nsubset; nsubseteq; nsubseteqq; nsucc; nsucceq; nsup; nsupE; nsupe; nsupset; nsupseteq; nsupseteqq; ntgl; ntilde; ntlg; ntriangleleft; ntrianglelefteq; ntriangleright; ntrianglerighteq; nu; num; numero; numsp; nvDash; nvHarr; nvap; nvdash; nvge; nvgt; nvinfin; nvlArr; nvle; nvlt; nvltrie; nvrArr; nvrtrie; nvsim; nwArr; nwarhk; nwarr; nwarrow; nwnear; oS; oacute; oast; ocir; ocirc; ocy; odash; odblac; odiv; odot; odsold; oelig; ofcir; ofr; ogon; ograve; ogt; ohbar; ohm; oint;
Character(s) U+022F7 U+022F6 U+0220C U+0220C U+022FE U+022FD U+02226 U+02226 U+02AFD U+020E5 U+02202 U+00338 U+02A14 U+02280 U+022E0 U+02AAF U+00338 U+02280 U+02AAF U+00338 U+021CF U+0219B U+02933 U+00338 U+0219D U+00338 U+0219B U+022EB U+022ED U+02281 U+022E1 U+02AB0 U+00338 U+1D4C3 U+02224 U+02226 U+02241 U+02244 U+02244 U+02224 U+02226 U+022E2 U+022E3 U+02284 U+02AC5 U+00338 U+02288 U+02282 U+020D2 U+02288 U+02AC5 U+00338 U+02281 U+02AB0 U+00338 U+02285 U+02AC6 U+00338 U+02289 U+02283 U+020D2 U+02289 U+02AC6 U+00338 U+02279 U+000F1 U+02278 U+022EA U+022EC U+022EB U+022ED U+003BD U+00023 U+02116 U+02007 U+022AD U+02904 U+0224D U+020D2 U+022AC U+02265 U+020D2 U+0003E U+020D2 U+029DE U+02902 U+02264 U+020D2 U+0003C U+020D2 U+022B4 U+020D2 U+02903 U+022B5 U+020D2 U+0223C U+020D2 U+021D6 U+02923 U+02196 U+02196 U+02927 U+024C8 U+000F3 U+0229B U+0229A U+000F4 U+0043E U+0229D U+00151 U+02A38 U+02299 U+029BC U+00153 U+029BF U+1D52C U+002DB U+000F2 U+029C1 U+029B5 U+003A9 U+0222E
Glyph ?? ? ? ? ? ? ? ? ? # ? ? ? >? ? ? ? <? ? ? ? ? ? ? ? ? ? ? ? ? ? olarr; olcir; olcross; oline; olt; omacr; omega; omicron; omid; ominus; oopf; opar; operp; oplus; or; orarr; ord; order; orderof; ordf; ordm; origof; oror; orslope; orv; oscr; oslash; osol; otilde; otimes; otimesas; ouml; ovbar; par; para; parallel; parsim; parsl; part; pcy; percnt; period; permil; perp; pertenk; pfr; phi; phiv; phmmat; phone; pi;
Name
Character(s) U+021BA U+029BE U+029BB U+0203E U+029C0 U+0014D U+003C9 U+003BF U+029B6 U+02296 U+1D560 U+029B7 U+029B9 U+02295 U+02228 U+021BB U+02A5D U+02134 U+02134 U+000AA U+000BA U+022B6 U+02A56 U+02A57 U+02A5B U+02134 U+000F8 U+02298 U+000F5 U+02297 U+02A36 U+000F6 U+0233D U+02225 U+000B6 U+02225 U+02AF3 U+02AFD U+02202 U+0043F U+00025 U+0002E U+02030 U+022A5 U+02031 U+1D52D U+003C6 U+003D5 U+02133 U+0260E U+003C0 U+022D4 U+003D6 U+0210F U+0210E U+0210F U+0002B U+02A23 U+0229E U+02A22 U+02214 U+02A25 U+02A72 U+000B1 U+02A26 U+02A27 U+000B1 U+02A15 U+1D561 U+000A3 U+0227A U+02AB3 U+02AB7 U+0227C U+02AAF U+0227A U+02AB7 U+0227C U+02AAF U+02AB9 U+02AB5 U+022E8 U+0227E U+02032 U+02119 U+02AB5 U+02AB9 U+022E8 U+0220F U+0232E U+02312 U+02313 U+0221D U+0221D U+0227E U+022B0 U+1D4C5 U+003C8 U+02008 U+1D52E
Name
Character(s) U+02A0C U+1D562 U+02057 U+1D4C6 U+0210D U+02A16 U+0003F U+0225F U+00022 U+021DB U+021D2 U+0291C U+0290F U+02964 U+0223D U+00331 U+00155 U+0221A U+029B3 U+027E9 U+02992 U+029A5 U+027E9 U+000BB U+02192 U+02975 U+021E5 U+02920 U+02933 U+0291E U+021AA U+021AC U+02945 U+02974 U+021A3 U+0219D U+0291A U+02236 U+0211A U+0290D U+02773 U+0007D U+0005D U+0298C U+0298E U+02990 U+00159 U+00157 U+02309 U+0007D U+00440 U+02937 U+02969 U+0201D U+0201D U+021B3 U+0211C U+0211B U+0211C U+0211D U+025AD U+000AE U+0297D U+0230B U+1D52F U+021C1 U+021C0 U+0296C U+003C1 U+003F1 U+02192 U+021A3 U+021C1 U+021C0 U+021C4 U+021CC U+021C9 U+0219D U+022CC U+002DA U+02253 U+021C4 U+021CC U+0200F U+023B1 U+023B1 U+02AEE U+027ED U+021FE U+027E7 U+02986 U+1D563 U+02A2E U+02A35 U+00029 U+02994 U+02A12 U+021C9 U+0203A U+1D4C7 U+021B1
Glyph ? ? " ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? } ] ? ? ? } ? ? ? ? ? ? ? ? ? ? ? ? ) ? ?
quaternions; quatint; quest; questeq; quot; rAarr; rArr; rAtail; rBarr; rHar; race; racute; radic; raemptyv; rang; rangd; range; rangle; raquo; rarr; rarrap; rarrb; rarrbfs; rarrc; rarrfs; rarrhk; rarrlp; rarrpl; rarrsim; rarrtl; rarrw; ratail; ratio; rationals; rbarr; rbbrk; rbrace; rbrack; rbrke; rbrksld; rbrkslu; rcaron; rcedil; rceil; rcub; rcy; rdca; rdldhar; rdquo; rdquor; rdsh; real; realine; realpart; reals; rect; reg; rfisht; rfloor; rfr; rhard; rharu; rharul; rho; rhov; rightarrow; rightarrowtail; rightharpoondown; rightharpoonup; rightleftarrows; rightleftharpoons; rightrightarrows; rightsquigarrow; rightthreetimes; ring; risingdotseq; rlarr; rlhar; rlm; rmoust; rmoustache; rnmid; roang; roarr; robrk; ropar; ropf; roplus; rotimes; rpar; rpargt; rppolint; rrarr; rsaquo; rscr;
pitchfork; piv; planck; planckh; plankv; plus; plusacir; plusb; pluscir; plusdo; plusdu; pluse; plusmn; plussim; plustwo; pm; pointint; popf; pound; pr; prE; prap; prcue; pre; prec; precapprox; preccurlyeq; preceq; precnapprox; precneqq; precnsim; precsim; prime; primes; prnE; prnap; prnsim; prod; profalar; profline; profsurf; prop; propto; prsim; prurel; pscr; psi; puncsp; qfr;
rsh;
702
Name rsqb; rsquo; rsquor; rthree; rtimes; rtri; rtrie; rtrif; rtriltri; ruluhar; rx; sacute; sbquo; sc; scE; scap; scaron; sccue; sce; scedil; scirc; scnE; scnap; scnsim; scpolint; scsim; scy; sdot; sdotb; sdote; seArr; searhk; searr; searrow; sect; semi; seswar; setminus; setmn; sext; sfr; sfrown; sharp; shchcy; shcy; shortmid; shortparallel; shy; sigma; sigmaf; sigmav; sim; simdot; sime; simeq; simg; simgE; siml; simlE; simne; simplus; simrarr; slarr; smallsetminus; smashp; smeparsl; smid; smile; smt; smte; smtes; softcy; sol; solb; solbar; sopf; spades; spadesuit; spar; sqcap; sqcaps; sqcup; sqcups; sqsub; sqsube; sqsubset; sqsubseteq; sqsup; sqsupe; sqsupset; sqsupseteq; squ; square; squarf; squf; srarr; sscr; ssetmn; ssmile; sstarf;
Character(s) U+0005D U+02019 U+02019 U+022CC U+022CA U+025B9 U+022B5 U+025B8 U+029CE U+02968 U+0211E U+0015B U+0201A U+0227B U+02AB4 U+02AB8 U+00161 U+0227D U+02AB0 U+0015F U+0015D U+02AB6 U+02ABA U+022E9 U+02A13 U+0227F U+00441 U+022C5 U+022A1 U+02A66 U+021D8 U+02925 U+02198 U+02198 U+000A7 U+0003B U+02929 U+02216 U+02216 U+02736 U+1D530 U+02322 U+0266F U+00449 U+00448 U+02223 U+02225 U+000AD U+003C3 U+003C2 U+003C2 U+0223C U+02A6A U+02243 U+02243 U+02A9E U+02AA0 U+02A9D U+02A9F U+02246 U+02A24 U+02972 U+02190 U+02216 U+02A33 U+029E4 U+02223 U+02323 U+02AAA U+02AAC U+02AAC U+0FE00 U+0044C U+0002F U+029C4 U+0233F U+1D564 U+02660 U+02660 U+02225 U+02293 U+02293 U+0FE00 U+02294 U+02294 U+0FE00 U+0228F U+02291 U+0228F U+02291 U+02290 U+02292 U+02290 U+02292 U+025A1 U+025A1 U+025AA U+025AA U+02192 U+1D4C8 U+02216 U+02323 U+022C6
Name
Character(s) U+02606 U+02605 U+003F5 U+003D5 U+000AF U+02282 U+02AC5 U+02ABD U+02286 U+02AC3 U+02AC1 U+02ACB U+0228A U+02ABF U+02979 U+02282 U+02286 U+02AC5 U+0228A U+02ACB U+02AC7 U+02AD5 U+02AD3 U+0227B U+02AB8 U+0227D U+02AB0 U+02ABA U+02AB6 U+022E9 U+0227F U+02211 U+0266A U+02283 U+000B9 U+000B2 U+000B3 U+02AC6 U+02ABE U+02AD8 U+02287 U+02AC4 U+027C9 U+02AD7 U+0297B U+02AC2 U+02ACC U+0228B U+02AC0 U+02283 U+02287 U+02AC6 U+0228B U+02ACC U+02AC8 U+02AD4 U+02AD6 U+021D9 U+02926 U+02199 U+02199 U+0292A U+000DF U+02316 U+003C4 U+023B4 U+00165 U+00163 U+00442 U+020DB U+02315 U+1D531 U+02234 U+02234 U+003B8 U+003D1 U+003D1 U+02248 U+0223C U+02009 U+02248 U+0223C U+000FE U+002DC U+000D7 U+022A0 U+02A31 U+02A30 U+0222D U+02928 U+022A4 U+02336 U+02AF1 U+1D565 U+02ADA U+02929 U+02034 U+02122 U+025B5 U+025BF
Glyph ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
Name triangleleft; trianglelefteq; triangleq; triangleright; trianglerighteq; tridot; trie; triminus; triplus; trisb; tritime; trpezium; tscr; tscy; tshcy; tstrok; twixt; twoheadleftarrow; twoheadrightarrow; uArr; uHar; uacute; uarr; ubrcy; ubreve; ucirc; ucy; udarr; udblac; udhar; ufisht; ufr; ugrave; uharl; uharr; uhblk; ulcorn; ulcorner; ulcrop; ultri; umacr; uml; uogon; uopf; uparrow; updownarrow; upharpoonleft; upharpoonright; uplus; upsi; upsih; upsilon; upuparrows; urcorn; urcorner; urcrop; uring; urtri; uscr; utdot; utilde; utri; utrif; uuarr; uuml; uwangle; vArr; vBar; vBarv; vDash; vangrt; varepsilon; varkappa; varnothing; varphi; varpi; varpropto; varr; varrho; varsigma;
Character(s) U+025C3 U+022B4 U+0225C U+025B9 U+022B5 U+025EC U+0225C U+02A3A U+02A39 U+029CD U+02A3B U+023E2 U+1D4C9 U+00446 U+0045B U+00167 U+0226C U+0219E U+021A0 U+021D1 U+02963 U+000FA U+02191 U+0045E U+0016D U+000FB U+00443 U+021C5 U+00171 U+0296E U+0297E U+1D532 U+000F9 U+021BF U+021BE U+02580 U+0231C U+0231C U+0230F U+025F8 U+0016B U+000A8 U+00173 U+1D566 U+02191 U+02195 U+021BF U+021BE U+0228E U+003C5 U+003D2 U+003C5 U+021C8 U+0231D U+0231D U+0230E U+0016F U+025F9 U+1D4CA U+022F0 U+00169 U+025B5 U+025B4 U+021C8 U+000FC U+029A7 U+021D5 U+02AE8 U+02AE9 U+022A8 U+0299C U+003F5 U+003F0 U+02205 U+003D5 U+003D6 U+0221D U+02195 U+003F1 U+003C2 U+0228A U+0FE00 U+02ACB U+0FE00 U+0228B U+0FE00 U+02ACC U+0FE00 U+003D1 U+022B2 U+022B3 U+00432 U+022A2 U+02228 U+022BB U+0225A U+022EE U+0007C U+0007C U+1D533 U+022B2 U+02282 U+020D2 U+02283 U+020D2 U+1D567
Glyph ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? | | ? ? ?
straightepsilon; straightphi; strns; sub; subE; subdot; sube; subedot; submult; subnE; subne; subplus; subrarr; subset; subseteq; subseteqq; subsetneq; subsetneqq; subsim; subsub; subsup; succ; succapprox; succcurlyeq; succeq; succnapprox; succneqq; succnsim; succsim; sum; sung; sup; sup1; sup2; sup3; supE; supdot; supdsub; supe; supedot; suphsol; suphsub; suplarr; supmult; supnE; supne;
? ? ? ? ? ? ? ? ? / ? ? ? ?
supplus; supset; supseteq; supseteqq; supsetneq; supsetneqq; supsim; supsub; supsup; swArr; swarhk; swarr; swarrow; swnwar; szlig; target; tau; tbrk; tcaron; tcedil; tcy; tdot; telrec; tfr; there4; therefore; theta; thetasym; thetav; thickapprox; thicksim; thinsp; thkap; thksim; thorn; tilde; times; timesb; timesbar; timesd; tint; toea; top; topbot; topcir; topf; topfork; tosa; tprime; trade; triangle; triangledown;
? ? ? ? ? ? ?
varsubsetneq; varsubsetneqq; varsupsetneq; varsupsetneqq; vartheta; vartriangleleft; vartriangleright; vcy; vdash; vee; veebar; veeeq; vellip; verbar; vert; vfr; vltri; vnsub; vnsup; vopf;
703
Name vprop; vrtri; vscr; vsubnE; vsubne; vsupnE; vsupne; vzigzag; wcirc; wedbar; wedge; wedgeq; weierp; wfr; wopf; wp; wr; wreath; wscr; xcap; xcirc; xcup; xdtri; xfr; xhArr; xharr; xi; xlArr; xlarr; xmap; xnis; xodot; xopf; xoplus; xotime; xrArr; xrarr; xscr; xsqcup; xuplus; xutri; xvee; xwedge; yacute; yacy; ycirc; ycy; yen; yfr; yicy; yopf; yscr; yucy; yuml; zacute; zcaron; zcy; zdot;
Character(s) U+0221D U+022B3 U+1D4CB U+02ACB U+0FE00 U+0228A U+0FE00 U+02ACC U+0FE00 U+0228B U+0FE00 U+0299A U+00175 U+02A5F U+02227 U+02259 U+02118 U+1D534 U+1D568 U+02118 U+02240 U+02240 U+1D4CC U+022C2 U+025EF U+022C3 U+025BD U+1D535 U+027FA U+027F7 U+003BE U+027F8 U+027F5 U+027FC U+022FB U+02A00 U+1D569 U+02A01 U+02A02 U+027F9 U+027F6 U+1D4CD U+02A06 U+02A04 U+025B3 U+022C1 U+022C0 U+000FD U+0044F U+00177 U+0044B U+000A5 U+1D536 U+00457 U+1D56A U+1D4CE U+0044E U+000FF U+0017A U+0017E U+00437 U+0017C
Glyph ? ? ? ? ? ? ? ? ? ? ? ? ? zeetrf; zeta; zfr; zhcy; zigrarr; zopf; zscr; zwj; zwnj; AElig AMP Aacute Acirc Agrave Aring Atilde Auml COPY Ccedil ETH Eacute Ecirc Egrave Euml GT Iacute Icirc Igrave Iuml LT Ntilde Oacute Ocirc Ograve Oslash Otilde Ouml QUOT REG THORN Uacute Ucirc Ugrave Uuml Yacute aacute acirc acute aelig agrave amp aring atilde auml brvbar ccedil cedil cent
Name
Character(s) U+02128 U+003B6 U+1D537 U+00436 U+021DD U+1D56B U+1D4CF U+0200D U+0200C U+000C6 U+00026 U+000C1 U+000C2 U+000C0 U+000C5 U+000C3 U+000C4 U+000A9 U+000C7 U+000D0 U+000C9 U+000CA U+000C8 U+000CB U+0003E U+000CD U+000CE U+000CC U+000CF U+0003C U+000D1 U+000D3 U+000D4 U+000D2 U+000D8 U+000D5 U+000D6 U+00022 U+000AE U+000DE U+000DA U+000DB U+000D9 U+000DC U+000DD U+000E1 U+000E2 U+000B4 U+000E6 U+000E0 U+00026 U+000E5 U+000E3 U+000E4 U+000A6 U+000E7 U+000B8 U+000A2
Glyph ? ? & > < " & copy curren deg divide eacute ecirc egrave eth euml frac12 frac14 frac34 gt iacute icirc iexcl igrave iquest iuml laquo lt macr micro middot nbsp not ntilde oacute ocirc ograve ordf ordm oslash otilde ouml para plusmn pound quot raquo reg sect shy sup1 sup2 sup3 szlig thorn times uacute ucirc ugrave uml uuml yacute yen yuml
Name
Character(s) U+000A9 U+000A4 U+000B0 U+000F7 U+000E9 U+000EA U+000E8 U+000F0 U+000EB U+000BD U+000BC U+000BE U+0003E U+000ED U+000EE U+000A1 U+000EC U+000BF U+000EF U+000AB U+0003C U+000AF U+000B5 U+000B7 U+000A0 U+000AC U+000F1 U+000F3 U+000F4 U+000F2 U+000AA U+000BA U+000F8 U+000F5 U+000F6 U+000B6 U+000B1 U+000A3 U+00022 U+000BB U+000AE U+000A7 U+000AD U+000B9 U+000B2 U+000B3 U+000DF U+000FE U+000D7 U+000FA U+000FB U+000F9 U+000A8 U+000FC U+000FD U+000A5 U+000FF
"
The glyphs displayed above are non-normative. Refer to the Unicode specifications for formal definitions of the characters listed above.
704
Furthermore, user agents should attempt to retrieve the above external entity's content when one of the above public identifiers is used, and should not attempt to retrieve any other external entity's content. Note: This is not strictly a violation p18 of the XML specification, but it does contradict the spirit of the XML specification's requirements. This is motivated by a desire for user agents to all handle entities in an interoperable fashion without requiring any network access for handling external subsets. [XML] p786 When an XML parser p705 creates a script p133 element, it must be marked as being "parser-inserted" p134 . If the parser was originally created for the XML fragment parsing algorithm p707 , then the element must be marked as "already started" p134 also. When the element's end tag is parsed, the user agent must run p134 the script p133
705
element. If this causes there to be a pending parsing-blocking script p136 , then the user agent must run the following steps: 1. 2. Block this instance of the XML parser p705 , such that the event loop p552 will not run tasks p553 that invoke it. Spin the event loop p554 until the parser's Document p33 has no style sheet that is blocking scripts p132 and the pending parsing-blocking script p136 's "ready to be parser-executed" p134 flag is set. Unblock this instance of the XML parser p705 , such that tasks p553 that invoke it can again be run. Execute p136 the pending parsing-blocking script p136 . There is no longer a pending parsing-blocking script p136 .
3. 4. 5.
Note: Since the document.write() p112 API is not available for XML documents p77 , much of the complexity in the HTML parser p620 is not needed in the XML parser p705 . Certain algorithms in this specification spoon-feed the parser characters one string at a time. In such cases, the XML parser p705 must act as it would have if faced with a single string consisting of the concatenation of all those characters. When an XML parser p705 reaches the end of its input, it must stop parsing p687 , following the same rules as the HTML parser p620 . An XML parser p705 can also be aborted p687 , which must again by done in the same way as for an HTML parser p620 . For the purposes of conformance checkers, if a resource is determined to be in the XHTML syntax p705 , then it is an XML document p77 .
706
An Element p33 node with two or more attributes with the same local name and namespace. An Attr p33 node, Text p33 node, CDATASection p33 node, Comment p33 node, or ProcessingInstruction p33 node whose data contains characters that are not matched by the XML Char production. [XML] p786 A Comment p33 node whose data contains two adjacent U+002D HYPHEN-MINUS characters (-) or ends with such a character. A ProcessingInstruction p33 node whose target name is an ASCII case-insensitive p36 match for the string "xml". A ProcessingInstruction p33 node whose target name contains a U+003A COLON (:). A ProcessingInstruction p33 node whose data contains the string "?>".
Note: These are the only ways to make a DOM unserializable. The DOM enforces all the other XML constraints; for example, trying to append two elements to a Document p33 node will raise a HIERARCHY_REQUEST_ERR p75 exception.
5.
6.
707
12 Rendering
User agents are not required to present HTML documents in any particular way. However, this section provides a set of suggestions for rendering HTML documents that, if followed, are likely to lead to a user experience that closely resembles the experience intended by the documents' authors. So as to avoid confusion regarding the normativity of this section, RFC2119 terms have not been used. Instead, the term "expected" is used to indicate behavior that will lead to this experience.
12.1 Introduction
In general, user agents are expected to support CSS, and many of the suggestions in this section are expressed in CSS terms. User agents that use other presentation mechanisms can derive their expected behavior by translating from the CSS rules given in this section. In the absence of style-layer rules to the contrary (e.g. author style sheets), user agents are expected to render an element so that it conveys to the user the meaning that the element represents, as described by this specification. The suggestions in this section generally assume a visual output medium with a resolution of 96dpi or greater, but HTML is intended to apply to multiple media (it is a media-independent language). User agents are encouraged to adapt the suggestions in this section to their target media. An element is being rendered if it is in a Document p29 , either its parent node is itself being rendered p708 or it is the Document p33 node, and it is not explicitly excluded from the rendering using either: the CSS 'display' property's 'none' value, or the 'visibility' property's 'collapse' value unless it is being treated as equivalent to the 'hidden' value, or some equivalent in other styling languages.
Note: Just being off-screen does not mean the element is not being rendered p708 . The presence of the hidden p571 attribute normally means the element is not being rendered p708 , though this might be overridden by the style sheets.
12.2 The CSS user agent style sheet and presentational hints
12.2.1 Introduction
The CSS rules given in these subsections are, except where otherwise specified, expected to be used as part of the user-agent level style sheet defaults for all documents that contain HTML elements p28 . Some rules are intended for the author-level zero-specificity presentational hints part of the CSS cascade; these are explicitly called out as presentational hints. Some of the rules regarding left and right margins are given here as appropriate for elements whose 'direction' property is 'ltr', and are expected to be flipped around on elements whose 'direction' property is 'rtl'. These are marked "LTR-specific". Similarly, for the purpose of the rules marked "case-insensitive", user agents are expected to use ASCII caseinsensitive p36 matching of attribute values rather than case-sensitive matching, even for attributes in XHTML documents. Note: These markings only affect the handling of attribute values, not attribute names or element names.
When the text below says that an attribute attribute on an element element maps to the pixel length property (or properties) properties, it means that if element has an attribute attribute set, and parsing that attribute's value using the rules for parsing non-negative integers p39 doesn't generate an error, then the user agent is expected to use the parsed value as a pixel length for a presentational hint p708 for properties. When the text below says that an attribute attribute on an element element maps to the dimension property (or properties) properties, it means that if element has an attribute attribute set, and parsing that attribute's value using the rules for parsing dimension values p41 doesn't generate an error, then the user agent is expected to use the parsed dimension as the value for a presentational hint p708 for properties, with the value given as a pixel length if the dimension was an integer, and with the value given as a percentage if the dimension was a percentage.
708
709
ul dir, ul dl, ul menu, ul ol, ul ul { margin-top: 0; margin-bottom: 0; } h1 h2 h3 h4 h5 h6 { { { { { { margin-top: margin-top: margin-top: margin-top: margin-top: margin-top: 0.67em; 0.83em; 1.00em; 1.33em; 1.67em; 2.33em; margin-bottom; margin-bottom; margin-bottom; margin-bottom; margin-bottom; margin-bottom; 0.67em; 0.83em; 1.00em; 1.33em; 1.67em; 2.33em; } } } } } }
dd { margin-left: 40px; } /* LTR-specific: use 'margin-right' for rtl elements */ dir, menu, ol, ul { padding-left: 40px; } /* LTR-specific: use 'padding-right' for rtl elements */ blockquote, figure { margin-left: 40px; margin-right: 40px; } table { border-spacing: 2px; border-collapse: separate; } td, th { padding: 1px; } The article p147 , aside p148 , nav p145 , and section p144 elements are expected to affect the margins of h1 p150 elements, based on the nesting depth. If x is a selector that matches elements that are either article p147 , aside p148 , nav p145 , or section p144 elements, then the following rules capture what is expected: @namespace url(http://www.w3.org/1999/xhtml); x x x x x h1 { margin-top: 0.83em; margin-bottom: 0.83em; } x h1 { margin-top: 1.00em; margin-bottom: 1.00em; } x x h1 { margin-top: 1.33em; margin-bottom: 1.33em; } x x x h1 { margin-top: 1.67em; margin-bottom: 1.67em; } x x x x h1 { margin-top: 2.33em; margin-bottom: 2.33em; }
For each property in the table below, given a body p142 element, the first attribute that exists maps to the pixel length property p708 on the body p142 element. If none of the attributes for a property are found, or if the value of the attribute that was found cannot be parsed successfully, then a default value of 8px is expected to be used for that property instead.
Property 'margin-top' body
p142
attribute
The body p142 element's container frame element p710 's marginheight p743 attribute body p142 element's topmargin attribute 'margin-right' body p142 element's marginwidth p743 attribute The body p142 element's container frame element p710 's marginwidth p743 attribute body p142 element's rightmargin attribute 'margin-bottom' body p142 element's marginheight p743 attribute The body p142 element's container frame element p710 's marginheight p743 attribute body p142 element's bottommargin attribute 'margin-left' body p142 element's marginwidth p743 attribute The body p142 element's container frame element p710 's marginwidth p743 attribute body p142 element's leftmargin attribute
If the body p142 element's Document p33 's browsing context p499 is a nested browsing context p499 , and the browsing context container p499 of that nested browsing context p499 is a frame p747 or iframe p213 element, then the container frame element of the body p142 element is that frame p747 or iframe p213 element. Otherwise, there is no container frame element p710 . Warning! The above requirements imply that a page can change the margins of another page (including one from another origin p510 ) using, for example, an iframe p213 . This is potentially a security risk, as it might in some cases allow an attack to contrive a situation in which a page is rendered not as the author intended, possibly for the purposes of phishing or otherwise misleading the user. If the Document p33 has a root element p29 , and the Document p33 's browsing context p499 is a nested browsing context p499 , and the browsing context container p499 of that nested browsing context p499 is a frame p747 or iframe p213 element, and that element has a scrolling attribute, then the user agent is expected to compare the value of the attribute in an ASCII case-insensitive p36 manner to the values in the first column of the following table, and if one of them matches, then the user agent is expected to treat that attribute as a presentational hint p708 for the
710
aforementioned root element's 'overflow' property, setting it to the value given in the corresponding cell on the same row in the second column:
Attribute value 'overflow' value on scroll yes off noscroll no auto 'scroll' 'scroll' 'scroll' 'hidden' 'hidden' 'hidden' 'auto'
The table p320 element's cellspacing p744 attribute maps to the pixel length property p708 'border-spacing' on the element. The table p320 element's cellpadding p743 attribute maps to the pixel length properties p708 'padding-top', 'paddingright', 'padding-bottom', and 'padding-left' of any td p332 and th p332 elements that have corresponding cells p335 in the table p335 corresponding to the table p320 element. The table p320 element's hspace attribute maps to the dimension properties p708 'margin-left' and 'margin-right' on the table p320 element. The table p320 element's vspace attribute maps to the dimension properties p708 'margin-top' and 'margin-bottom' on the table p320 element. The table p320 element's height attribute maps to the dimension property p708 'height' on the table p320 element. The table p320 element's width p744 attribute maps to the dimension property p708 'width' on the table p320 element. The col p328 element's width p743 attribute maps to the dimension property p708 'width' on the col p328 element. The tr p331 element's height attribute maps to the dimension property p708 'height' on the tr p331 element. The td p332 and th p332 elements' height p744 attributes map to the dimension property p708 'height' on the element. The td p332 and th p332 elements' width p744 attributes map to the dimension property p708 'width' on the element. In quirks mode p81 , the following rules are also expected to apply: @namespace url(http://www.w3.org/1999/xhtml); form { margin-bottom: 1em; } When a Document p33 is in quirks mode p81 , margins on HTML elements p28 at the top or bottom of body p142 , td p332 , or th p332 elements are expected to be collapsed to zero.
12.2.4 Alignment
@namespace url(http://www.w3.org/1999/xhtml); thead, tbody, tfoot, table > tr { vertical-align: middle; } tr, td, th { vertical-align: inherit; } sub { vertical-align: sub; } sup { vertical-align: super; }
The following rules are also expected to apply, as presentational hints p708 : @namespace url(http://www.w3.org/1999/xhtml); table[align=left] { float: left; } /* case-insensitive */ table[align=right] { float: right; } /* case-insensitive */ table[align=center], table[align=abscenter], table[align=absmiddle], table[align=middle] { /* case-insensitive */ margin-left: auto; margin-right: auto; } thead[align=absmiddle], tbody[align=absmiddle], tfoot[align=absmiddle], tr[align=absmiddle], td[align=absmiddle], th[align=absmiddle] { /* case-insensitive */
711
text-align: center; } caption[align=bottom] { caption-side: bottom; } /* case-insensitive */ p[align=left], h1[align=left], h2[align=left], h3[align=left], h4[align=left], h5[align=left], h6[align=left] { /* case-insensitive */ text-align: left; } p[align=right], h1[align=right], h2[align=right], h3[align=right], h4[align=right], h5[align=right], h6[align=right] { /* case-insensitive */ text-align: right; } p[align=center], h1[align=center], h2[align=center], h3[align=center], h4[align=center], h5[align=center], h6[align=center] { /* case-insensitive */ text-align: center; } p[align=justify], h1[align=justify], h2[align=justify], h3[align=justify], h4[align=justify], h5[align=justify], h6[align=justify] { /* case-insensitive */ text-align: justify; } thead[valign=top], tbody[valign=top], tfoot[valign=top], tr[valign=top], td[valign=top], th[valign=top] { /* case-insensitive */ vertical-align: top; } thead[valign=middle], tbody[valign=middle], tfoot[valign=middle], tr[valign=middle], td[valign=middle], th[valign=middle] { /* case-insensitive */ vertical-align: middle; } thead[valign=bottom], tbody[valign=bottom], tfoot[valign=bottom], tr[valign=bottom], td[valign=bottom], th[valign=bottom] { /* case-insensitive */ vertical-align: bottom; } thead[valign=baseline], tbody[valign=baseline], tfoot[valign=baseline], tr[valign=baseline], td[valign=baseline], th[valign=baseline] { /* case-insensitive */ vertical-align: baseline; } The center p740 element, the caption p327 element unless specified otherwise below, and the div p172 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , and th p332 elements when they have an align p743 attribute whose value is an ASCII case-insensitive p36 match for either the string "center" or the string "middle", are expected to center text within themselves, as if they had their 'text-align' property set to 'center' in a presentational hint p708 , and to align descendants p712 to the center. The div p172 , caption p327 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , and th p332 elements, when they have an align attribute whose value is an ASCII case-insensitive p36 match for the string "left", are expected to left-align text within themselves, as if they had their 'text-align' property set to 'left' in a presentational hint p708 , and to align descendants p712 to the left. The div p172 , caption p327 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , and th p332 elements, when they have an align attribute whose value is an ASCII case-insensitive p36 match for the string "right", are expected to rightalign text within themselves, as if they had their 'text-align' property set to 'right' in a presentational hint p708 , and to align descendants p712 to the right. The div p172 , caption p327 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , and th p332 elements, when they have an align attribute whose value is an ASCII case-insensitive p36 match for the string "justify", are expected to fulljustify text within themselves, as if they had their 'text-align' property set to 'justify' in a presentational hint p708 , and to align descendants p712 to the left. When a user agent is to align descendants of a node, the user agent is expected to align only those descendants that have both their 'margin-left' and 'margin-right' properties computing to a value other than 'auto', that are over-constrained and that have one of those two margins with a used value forced to a greater value, and that do not themselves have an applicable align attribute. When multiple elements are to align p712 a particular descendant, the most deeply nested such element is expected to override the others. User agents are expected to have a rule in their user agent stylesheet that matches th p332 elements that have a parent node whose computed value for the 'text-align' property is its initial value, whose declaration block consists of just a single declaration that sets the 'text-align' property to the value 'center'.
712
The initial value for the 'color' property is expected to be black. The initial value for the 'background-color' property is expected to be 'transparent'. The canvas's background is expected to be white. The article p147 , aside p148 , nav p145 , and section p144 elements are expected to affect the font size of h1 p150 elements, based on the nesting depth. If x is a selector that matches elements that are either article p147 , aside p148 , nav p145 , or section p144 elements, then the following rules capture what is expected: @namespace url(http://www.w3.org/1999/xhtml); x x x x x h1 { font-size: 1.50em; } x h1 { font-size: 1.17em; } x x h1 { font-size: 1.00em; } x x x h1 { font-size: 0.83em; } x x x x h1 { font-size: 0.67em; }
713
When a body p142 , table p320 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , or th p332 element has a background p744 attribute set to a non-empty value, the new value is expected to be resolved p55 relative to the element, and if this is successful, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'background-image' property to the resulting absolute URL p56 . When a body p142 , table p320 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , or th p332 element has a bgcolor attribute set, the new value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'background-color' property to the resulting color. When a body p142 element has a text p743 attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'color' property to the resulting color. When a body p142 element has a link p743 attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the 'color' property of any element in the Document p33 matching the ':link' pseudoclass to the resulting color. When a body p142 element has a vlink p743 attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the 'color' property of any element in the Document p33 matching the ':visited' pseudo-class to the resulting color. When a body p142 element has a alink p743 attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the 'color' property of any element in the Document p33 matching the ':active' pseudo-class and either the ':link' pseudo-class or the ':visited' pseudo-class to the resulting color. When a table p320 element has a bordercolor attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'border-top-color', 'border-right-color', 'border-bottomcolor', and 'border-right-color' properties to the resulting color. When a font p740 element has a color attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'color' property to the resulting color. When a font p740 element has a face attribute, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'font-family' property to the attribute's value. When a font p740 element has a size attribute, the user agent is expected to use the following steps to treat the attribute as a presentational hint p708 setting the element's 'font-size' property: 1. 2. 3. 4. 5. Let input be the attribute's value. Let position be a pointer into input, initially pointing at the start of the string. Skip whitespace p38 . If position is past the end of input, there is no presentational hint p708 . Abort these steps. If the character at position is a U+002B PLUS SIGN character (+), then let mode be relative-plus, and advance position to the next character. Otherwise, if the character at position is a U+002D HYPHENMINUS character (-), then let mode be relative-minus, and advance position to the next character. Otherwise, let mode be absolute. Collect a sequence of characters p37 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), and let the resulting sequence be digits. If digits is the empty string, there is no presentational hint p708 . Abort these steps. Interpret digits as a base-ten integer. Let value be the resulting number. If mode is relative-plus, then increment value by 3. If mode is relative-minus, then let value be the result of subtracting value from 3. If value is greater than 7, let it be 7. If value is less than 1, let it be 1. Set 'font-size' to the keyword corresponding to the value of value according to the following table:
6.
7. 8. 9.
714
value 'font-size' keyword 1 2 3 4 5 6 7 xx-small small medium large x-large xx-large xxx-large
Notes
see below
The 'xxx-large' value is a non-CSS value used here to indicate a font size one "step" larger than 'xxlarge'.
715
:rtl { direction: rtl; } [dir] { unicode-bidi: embed; } bdo, bdo[dir] { unicode-bidi: bidi-override; } bdi, output { unicode-bidi: isolate; } textarea[dir=auto], pre[dir=auto] { unicode-bidi: plaintext; } /* case-insensitive */ Rules setting the 'quotes' property appropriately for the locales and languages understood by the user are expected to be present. User agents are expected to support the 'clear' property on inline elements (in order to render br p194 elements with clear p743 attributes) in the manner described in the non-normative note to this effect in CSS2.1. The following rules are also expected to apply, as presentational hints p708 : @namespace url(http://www.w3.org/1999/xhtml); td[nowrap], th[nowrap] { white-space: nowrap; } pre[wrap] { white-space: pre-wrap; } br[clear=left] { clear: left; } /* case-insensitive */ br[clear=right] { clear: right; } /* case-insensitive */ br[clear=all], br[clear=both] { clear: both; } /* case-insensitive */ ol[type=1], li[type=1] { list-style-type: decimal; } ol[type=a], li[type=a] { list-style-type: lower-alpha; } ol[type=A], li[type=A] { list-style-type: upper-alpha; } ol[type=i], li[type=i] { list-style-type: lower-roman; } ol[type=I], li[type=I] { list-style-type: upper-roman; } ul[type=disc], li[type=disc] { list-style-type: disc; } /* case-insensitive */ ul[type=circle], li[type=circle] { list-style-type: circle; } /* case-insensitive */ ul[type=square], li[type=square] { list-style-type: square; } /* case-insensitive */ table[rules=none], table[rules=groups], table[rules=rows], table[rules=cols], table[rules=all] { border-style: none; border-collapse: collapse; } table[frame=void] { border-style: hidden hidden hidden hidden; table[frame=above] { border-style: solid hidden hidden hidden; table[frame=below] { border-style: hidden hidden solid hidden; table[frame=hsides] { border-style: solid hidden solid hidden; table[frame=lhs] { border-style: hidden hidden hidden solid; } table[frame=rhs] { border-style: hidden solid hidden hidden; } table[frame=vsides] { border-style: hidden solid hidden solid; table[frame=box], table[frame=border] { border-style: solid solid solid solid; } } } } }
table[rules=none] > tr > td, table[rules=none] > tr > th, table[rules=none] > thead > tr > td, table[rules=none] > thead > tr > th, table[rules=none] > tbody > tr > td, table[rules=none] > tbody > tr > th, table[rules=none] > tfoot > tr > td, table[rules=none] > tfoot > tr > th, table[rules=groups] > tr > td, table[rules=groups] > tr > th, table[rules=groups] > thead > tr > td, table[rules=groups] > thead > tr > th, table[rules=groups] > tbody > tr > td, table[rules=groups] > tbody > tr > th, table[rules=groups] > tfoot > tr > td, table[rules=groups] > tfoot > tr > th, table[rules=rows] > tr > td, table[rules=rows] > tr > th, table[rules=rows] > thead > tr > td, table[rules=rows] > thead > tr > th, table[rules=rows] > tbody > tr > td, table[rules=rows] > tbody > tr > th, table[rules=rows] > tfoot > tr > td, table[rules=rows] > tfoot > tr > th { border-style: none; } table[rules=groups] > colgroup, table[rules=groups] > thead, table[rules=groups] > tbody, table[rules=groups] > tfoot { border-style: solid; } table[rules=rows] > tr, table[rules=rows] > thead > tr,
716
table[rules=rows] > tbody > tr, table[rules=rows] > tfoot > tr { border-style: solid; } table[rules=cols] > tr > td, table[rules=cols] > tr > th, table[rules=cols] > thead > tr > td, table[rules=cols] > thead > tr > th, table[rules=cols] > tbody > tr > td, table[rules=cols] > tbody > tr > th, table[rules=cols] > tfoot > tr > td, table[rules=cols] > tfoot > tr > th { border-style: none solid none solid; } table[rules=all] > tr > td, table[rules=all] > tr > th, table[rules=all] > thead > tr > td, table[rules=all] > thead > tr > th, table[rules=all] > tbody > tr > td, table[rules=all] > tbody > tr > th, table[rules=all] > tfoot > tr > td, table[rules=all] > tfoot > tr > th { border-style: solid; } table[border] > table[border] > table[border] > table[border] > border-width: } tr > td, table[border] > tr > th, thead > tr > td, table[border] > thead > tr > th, tbody > tr > td, table[border] > tbody > tr > th, tfoot > tr > td, table[border] > tfoot > tr > th { 1px;
When rendering li p166 elements, user agents are expected to use the ordinal value p167 of the li p166 element to render the counter in the list item marker. The table p320 element's border p743 attribute maps to the pixel length properties p708 'border-top-width', 'borderright-width', 'border-bottom-width', 'border-left-width' on the element. If the attribute is present but parsing the attribute's value using the rules for parsing non-negative integers p39 generates an error, a default value of 1px is expected to be used for that property instead. The wbr p195 element is expected to override the 'white-space' property and always provide a line-breaking opportunity.
717
The following rules are also expected to apply, as presentational hints p708 : @namespace url(http://www.w3.org/1999/xhtml); hr[align=left] { margin-left: 0; margin-right: auto; } /* case-insensitive */ hr[align=right] { margin-left: auto; margin-right: 0; } /* case-insensitive */ hr[align=center] { margin-left: auto; margin-right: auto; } /* case-insensitive */ hr[color], hr[noshade] { border-style: solid; } If an hr p161 element has either a color p743 attribute or a noshade p743 attribute, and furthermore also has a size p743 attribute, and parsing that attribute's value using the rules for parsing non-negative integers p39 doesn't generate an error, then the user agent is expected to use the parsed value divided by two as a pixel length for presentational hints p708 for the properties 'border-top-width', 'border-right-width', 'border-bottom-width', and 'border-left-width' on the element. Otherwise, if an hr p161 element has neither a color p743 attribute nor a noshade p743 attribute, but does have a size p743 attribute, and parsing that attribute's value using the rules for parsing non-negative integers p39 doesn't generate an error, then: if the parsed value is one, then the user agent is expected to use the attribute as a presentational hint p708 setting the element's 'border-bottom-width' to 0; otherwise, if the parsed value is greater than one, then the user agent is expected to use the parsed value minus two as a pixel length for presentational hints p708 for the 'height' property on the element. The width p743 attribute on an hr p161 element maps to the dimension property p708 'width' on the element. When an hr p161 element has a color p743 attribute, its value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'color' property to the resulting color.
A fieldset p350 element's rendered legend p718 , if any, is expected to be rendered over the top border edge of the fieldset p350 element as a 'block' box (overriding any explicit 'display' value). In the absence of an explicit width, the box should shrink-wrap. If the legend p351 element in question has an align p743 attribute, and its value is an ASCII case-insensitive p36 match for one of the strings in the first column of the following table, then the legend p351 is expected to be rendered horizontally aligned over the border edge in the position given in the corresponding cell on the same row in the second column. If the attribute is absent or has a value that doesn't match any of the cases in the table, then the position is expected to be on the right if the 'direction' property on this element has a computed value of 'rtl', and on the left otherwise.
Attribute value Alignment position left right center On the left On the right In the middle
718
A canvas p286 element that represents p708 embedded content p101 is expected to be treated as a replaced element. Other canvas p286 elements are expected to be treated as ordinary elements in the rendering model. An object p222 element that represents p708 an image, plugin, or nested browsing context p499 is expected to be treated as a replaced element. Other object p222 elements are expected to be treated as ordinary elements in the rendering model. An applet p744 element that represents p708 a plugin p29 is expected to be treated as a replaced element. Other applet p744 elements are expected to be treated as ordinary elements in the rendering model. The audio p231 element, when it is exposing a user interface p282 , is expected to be treated as a replaced element about one line high, as wide as is necessary to expose the user agent's user interface features. When an audio p231 element is not exposing a user interface p282 , the user agent is expected to hide it, irrespective of CSS rules. Whether a video p228 element is exposing a user interface p282 is not expected to affect the size of the rendering; controls are expected to be overlaid with the page content without causing any layout changes, and are expected to disappear when the user does not need them. When a video p228 element represents a poster frame or frame of video, the poster frame or frame of video is expected to be rendered at the largest size that maintains the aspect ratio of that poster frame or frame of video without being taller or wider than the video p228 element itself, and is expected to be centered in the video p228 element. Any subtitles or captions are expected to be overlayed directly on top of their video p228 element, as defined by the relevant rendering rules; for WebVTT p267 , those are the WebVTT cue text rendering rules p719 defined below. When the user agent starts exposing a user interface p282 for a video p228 element, user agents should run the rules for updating the text track rendering p255 of each of the text tracks p254 in the video p228 element's list of text tracks p254 that are showing p255 or showing by default p255 (e.g., for text tracks p254 based on WebVTT p267 , the rules for updating the display of WebVTT text tracks p719 ). Note: Resizing video p228 and canvas p286 elements does not interrupt video playback or clear the canvas.
The following CSS rules are expected to apply: @namespace url(http://www.w3.org/1999/xhtml); iframe:not([seamless]) { border: 2px inset; }
12.3.2.1 WebVTT cue text rendering rules The rules for updating the display of WebVTT text tracks render the text tracks p254 of a media element p235 (specifically, a video p228 element), or of another playback mechanism, by applying the steps below. All the text tracks p254 that use these rules for a given media element p235 , or other playback mechanism, are rendered together, to avoid overlapping subtitles from multiple tracks. The output of the steps below is a set of CSS boxes that covers the rendering area of the media element p235 or other playback mechanism, which user agents are expected to render in a manner suiting the user. The rules are as follows: 1. If the media element p235 is an audio p231 element, or is another playback mechanism with no rendering area, abort these steps. There is nothing to render. Let video be the media element p235 or other playback mechanism. Let output be an empty list of absolutely positioned CSS block boxes. If the user agent is exposing a user interface p282 for video, add to output one or more completely transparent positioned CSS block boxes that cover the same region as the user interface. If the last time these rules were run, the user agent was not exposing a user interface p282 for video, but now it is, let reset be true. Otherwise, let reset be false.
2. 3. 4.
5.
719
6.
Let tracks be the subset of video's list of text tracks p254 that have as their rules for updating the text track rendering p255 these rules for updating the display of WebVTT text tracks p719 , and whose text track mode p255 is showing p255 or showing by default p255 . Let cues be an empty list of text track cues p256 . For each track track in tracks, append to cues all the cues p256 from track's list of cues p255 that have their text track cue active flag p257 set. If reset is false, then, for each text track cue p256 cue in cues: if cue's text track cue display state p257 has a set of CSS boxes, then add those boxes to output, and remove cue from cues. For each text track cue p256 cue in cues that has not yet had corresponding CSS boxes added to output, in text track cue order p257 , run the following substeps: 1. Let nodes be the list of WebVTT Node Objects p277 obtained by applying the WebVTT cue text parsing rules p277 to the cue's text track cue text p256 . Apply the Unicode Bidirectional Algorithm's Paragraph Level steps to nodes using the following constraints, to determine the paragraph embedding level of the cue: [BIDI] p0 nodes represents a single paragraph. The paragraph's text consists of the concatenation of the values of each WebVTT Text Object p277 in nodes, in a pre-order, depth-first traversal, excluding WebVTT Ruby Text Objects p277 and their descendants.
7. 8.
9.
10.
2.
3.
If the paragraph embedding level determined in the previous step is even (the paragraph direction is left-to-right), let direction be 'ltr', otherwise, let it be 'rtl'. If the text track cue writing direction p256 is horizontal p256 , then let block-flow be 'tb'. Otherwise, if the text track cue writing direction p256 is vertical growing left p256 , then let block-flow be 'lr'. Otherwise, the text track cue writing direction p256 is vertical growing right p256 ; let block-flow be 'rl'. Determine the value of maximum size for cue as per the appropriate rules from the following list:
p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is start , and direction is 'ltr' p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is end , and direction is 'rtl' p256 is vertical growing left p256 , and the text If the text track cue writing direction p256 p256 track cue alignment is start p256 is vertical growing right p256 , and the If the text track cue writing direction p256 p256 text track cue alignment is start
4.
5.
Let maximum size be the text track cue text position p256 subtracted from 100.
p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is end , and direction is 'ltr' p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is start , and direction is 'rtl' p256 is vertical growing left p256 , and the text If the text track cue writing direction p256 p256 track cue alignment is end p256 is vertical growing right p256 , and the If the text track cue writing direction text track cue alignment p256 is end p256
Let maximum size be the text track cue text position p256 .
p256 is middle p256 , the text track cue text If the text track cue alignment position p256 is less than or equal to 50
Let maximum size be the text track cue text position p256 multiplied by two.
p256 is middle p256 , the text track cue text If the text track cue alignment p256 position is greater than 50
Let maximum size be the result of subtracting text track cue text position p256 from 100 and then multiplying the result by two. 6. If the text track cue size p256 is less than maximum size, then let size be text track cue size p256 . Otherwise, let size be maximum size.
720
7.
If the text track cue writing direction p256 is horizontal p256 , then let width be 'size vw' and height be 'auto'. Otherwise, let width be 'auto' and height be 'size vh'. (These are CSS values used by the next section to set CSS properties for the rendering; 'vw' and 'vh' are CSS units.) [CSSVALUES] p782 Determine the value of x-position or y-position for cue as per the appropriate rules from the following list:
p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is start , and direction is 'ltr' p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is end , and direction is 'rtl'
8.
Let x-position be the text track cue text position p256 subtracted from 100.
p256 is vertical growing left p256 , and the text If the text track cue writing direction p256 p256 track cue alignment is start p256 is vertical growing right p256 , and the If the text track cue writing direction p256 p256 text track cue alignment is start
Let y-position be the text track cue text position p256 subtracted from 100.
p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is middle , and direction is 'ltr'
Let x-position be the text track cue text position p256 minus half of size.
p256 is horizontal p256 , the text track cue If the text track cue writing direction p256 p256 alignment is middle , and direction is 'rtl'
Let x-position-reverse be the text track cue text position p256 minus half of size. Let x-position be x-position-reverse subtracted from 100.
p256 is vertical growing left p256 , and the text If the text track cue writing direction p256 p256 track cue alignment is middle p256 is vertical growing right p256 , and the If the text track cue writing direction p256 p256 text track cue alignment is middle
Let y-position be the text track cue text position p256 minus half of size. 9. Determine the value of whichever of x-position or y-position is not yet calculated for cue as per the appropriate rules from the following list:
p256 is horizontal p256 , and the text track cue If the text track cue writing direction snap-to-lines flag p256 is set
721
p256 is vertical growing left p256 , and the text If the text track cue writing direction p256 track cue snap-to-lines flag is not set p256 is vertical growing right p256 , and the If the text track cue writing direction p256 text track cue snap-to-lines flag is not set
Let x-position be the text track cue line position p256 . 10. Let left be 'x-position vw' and top be 'y-position vh'. (These again are CSS values used by the next section to set CSS properties for the rendering; 'vw' and 'vh' are CSS units.) [CSSVALUES] p782 Apply the terms of the CSS specifications to nodes within the following constraints, thus obtaining a set of CSS boxes positioned relative to an initial containing block: [CSS] p781 The document tree is the tree of WebVTT Node Objects p277 rooted at nodes. For the purposes of processing by the CSS specification, WebVTT Internal Node Objects p277 are equivalent to elements with the same contents. For the purposes of processing by the CSS specification, WebVTT Text Objects p277 are equivalent to text nodes. No style sheets are associated with nodes. (The nodes are subsequently restyled using style sheets after their boxes are generated, as described below.) The children of the nodes must be wrapped in an anonymous box whose 'display' property has the value 'inline'. This is the WebVTT cue background box. Runs of children of WebVTT Ruby Objects p277 that are not WebVTT Ruby Text Objects p277 must be wrapped in anonymous boxes whose 'display' property has the value 'ruby-base'. [CSSRUBY] p782 Properties on WebVTT Node Objects p277 have their values set as defined in the next section. (That section uses some of the variables whose values were calculated earlier in this algorithm.) Text runs must be wrapped at the edge of their containing blocks, regardless of the value of the 'white-space' property, even if doing so requires splitting a word where there is no line breaking opportunity. The viewport (and initial containing block) is video's rendering area.
11.
Let boxes be the boxes generated as descendants of the initial containing block, along with their positions. 12. If there are no line boxes in boxes, skip the remainder of these substeps for cue. The cue is ignored. Adjust the positions of boxes according to the appropriate steps from the following list:
p256 is set If cue's text track cue snap-to-lines flag
13.
Many of the steps in this algorithm vary according to the text track cue writing direction p256 . Steps labeled "Horizontal" must be followed only when the text track cue writing direction p256 is horizontal p256 , steps labeled "Vertical" must be followed when the text track cue writing direction p256 is either vertical growing left p256 or vertical growing right p256 , steps labeled "Vertical Growing Left" must be followed only when the text track cue writing direction p256 is vertical growing left p256 , and steps labeled "Vertical Growing Right" must be followed only when the text track cue writing direction p256 is vertical growing right p256 . 1. Horizontal: Let step be the height of the first line box in boxes. Vertical: Let step be the width of the first line box in boxes. 2. 3. 4. 5. 6. If step is zero, then jump to the step labeled done positioning below. Let line position be the text track cue line position p256 . Vertical Growing Left: Add one to line position then negate it. Let position be the result of multiplying step and line position. Vertical Growing Left: Decrease position by the width of the bounding box of the boxes in boxes, then increase position by step.
722
7.
Horizontal: If line position is less than zero then increase position by the height of the video's rendering area, and negate step (so its value is now minus the height of the first line box in boxes). Vertical: If line position is less than zero then increase position by the width of the video's rendering area, and negate step.
8.
Horizontal: Move all the boxes in boxes down by the distance given by position. Vertical: Move all the boxes in boxes right by the distance given by position.
9.
Default: Remember the position of all the boxes in boxes as their default position. Let switched be false. Step loop: If none of the boxes in boxes would overlap any of the boxes in output, and all the boxes in output are within the video's rendering area, then jump to the step labeled done positioning below. Horizontal: If step is negative and the top of the first line box in boxes is now above the top of the video's rendering area, or if step is positive and the bottom of the first line box in boxes is now below the bottom of the video's rendering area, jump to the step labeled switch direction. Vertical: If step is negative and the left edge of the first line box in boxes is now to the left of the left edge of the video's rendering area, or if step is positive and the right edge of the first line box in boxes is now to the right of the right edge of the video's rendering area, jump to the step labeled switch direction.
10. 11.
12.
13.
Horizontal: Move all the boxes in boxes down by the distance given by step. (If step is negative, then this will actually result in an upwards movement of the boxes in absolute terms.) Vertical: Move all the boxes in boxes right by the distance given by step. (If step is negative, then this will actually result in a leftwards movement of the boxes in absolute terms.)
14. 15.
Jump back to the step labeled step loop. Switch direction: Move all the boxes in boxes back to their default position as determined in the step above labeled default. If switched is true, jump to the step labeled done positioning below. Negate step. Set switched to true. Jump back to the step labeled step loop.
1.
723
p256 is vertical growing If the text track cue writing direction p256 right Let x be a percentage given by the text track cue line position p256 , and let y be a percentage given by the text track cue text position p256 .
2.
Position the boxes in boxes such that the point x% along the width of the bounding box of the boxes in boxes is x% of the way across the width of the video's rendering area, and the point y% along the height of the bounding box of the boxes in boxes is y% of the way across the height of the video's rendering area, while maintaining the relative positions of the boxes in boxes to each other. If none of the boxes in boxes would overlap any of the boxes in output, and all the boxes in output are within the video's rendering area, then jump to the step labeled done positioning below. If there is a position to which the boxes in boxes can be moved while maintaining the relative positions of the boxes in boxes to each other such that none of the boxes in boxes would overlap any of the boxes in output, and all the boxes in output would be within the video's rendering area, then move the boxes in boxes to the closest such position to their current position, and then jump to the step labeled done positioning below. If there are multiple such positions that are equidistant from their current position, use the highest one amongst them; if there are several at that height, then use the leftmost one amongst them. Otherwise, jump to the step labeled done positioning below. (The boxes will unfortunately overlap.)
3.
4.
5.
14.
Done positioning: If there are any line boxes in the (possibly now repositioned) boxes that do not completely fit inside video's rendering area, remove those offending line boxes from boxes. Let cue's text track cue display state p257 have the CSS boxes in boxes. Add the CSS boxes in boxes to output.
Return output.
12.3.2.2 Applying CSS properties to WebVTT Node Objects p277 When following the rules for updating the display of WebVTT text tracks p719 , user agents must set properties of WebVTT Node Objects p277 as defined in this section. [CSS] p781 On the (root) List of WebVTT Node Objects p277 , the 'position' property must be set to 'absolute', the 'direction' property must be set to direction, the 'block-flow' property must be set to block-flow, the 'top' property must be set to top, the 'left' property must be set to left, the 'width' property must be set to width, and the 'height' property must be set to height, where direction, block-flow, top, left, width, and height are the values with those names determined by the rules for updating the display of WebVTT text tracks p719 for the text track cue p256 from whose text p256 the List of WebVTT Node Objects p277 was constructed. The 'font' shorthand property on the (root) List of WebVTT Node Objects p277 must be set to '0.1vh sans-serif'. [CSSRUBY] p782 [CSSVALUES] p782 The 'color' property on the (root) List of WebVTT Node Objects p277 must be set to 'rgba(255,255,255,0)'. [CSSCOLOR] p781 The 'background' shorthand property on the WebVTT cue background box p722 must be set to 'rgba(0,0,0,0.8)'. [CSSCOLOR] p781 A text outline or stroke may also be set on the (root) List of WebVTT Node Objects p277 , if supported. The 'font-style' property on WebVTT Italic Objects p277 must be set to 'italic'. The 'font-weight' property on WebVTT Bold Objects p277 must be set to 'bold'. The 'display' property on WebVTT Ruby Objects p277 must be set to 'ruby'. [CSSRUBY] p782 The 'display' property on WebVTT Ruby Text Objects p277 must be set to 'ruby-text'. [CSSRUBY] p782 If there are style sheets that apply to the media element p235 or other playback mechanism, then they must be interpreted as defined in the next section.
724
All other non-inherited properties must be set to their initial values; inherited properties on the root List of WebVTT Node Objects p277 must inherit their values from the media element p235 for which the text track cue p256 is being rendered, if any. If there is no media element p235 (i.e. if the text track p254 is being rendered for another media playback mechanism), then inherited properties on the root List of WebVTT Node Objects p277 must take their initial values.
12.3.2.3 CSS extensions When a user agent is rendering one or more text track cues p256 according to the WebVTT cue text rendering rules p719 , WebVTT Node Objects p277 in the list of WebVTT Node Objects p277 used in the rendering can be matched by certain pseudo-selectors as defined below. These selectors can begin or stop matching individual WebVTT Node Objects p277 while a cue p256 is being rendered, even in between applications of the WebVTT cue text rendering rules p719 (which are only run when the set of active cues changes). User agents that support the pseudo-element described below must dynamically update renderings accordingly. Pseudo-elements apply to elements that are matched by selectors. For the purpose of this section, that element is the matched element. The pseudo-elements defined in the following sections affect the styling of parts of text track cues p256 that are being rendered for the matched element. Note: If the matched element is not a video p228 element, the pseudo-elements defined below won't have any effect according to this specification. A CSS user agent that implements the text tracks p254 model must implement the '::cue' and '::cue(selector)' pseudo-elements, and the ':past' and ':future' pseudo-classes.
12.3.2.3.1 The '::cue' pseudo-element The '::cue' pseudo-element (with no argument) matches any List of WebVTT Node Objects p277 constructed for the matched element, with the exception that the properties corresponding to the 'background' shorthand must be applied to the WebVTT cue background box p722 rather than the List of WebVTT Node Objects p277 . The following properties apply to the '::cue' pseudo-element with no argument; other properties set on the pseudo-element must be ignored: 'color' 'text-shadow' 'text-outline' the properties corresponding to the 'background' shorthand the properties corresponding to the 'outline' shorthand the properties corresponding to the 'font' shorthand, including 'line-height'
The '::cue(selector)' pseudo-element with an argument must have an argument that consists of a group of selectors. It matches any WebVTT Internal Node Object p277 constructed for the matched element that also matches the given group of selectors, with the nodes being treated as follows: The document tree against which the selectors are matched is the tree of WebVTT Node Objects p277 rooted at the list of WebVTT Node Objects p277 for the cue. WebVTT Internal Node Objects p277 are elements in the tree. WebVTT Leaf Node Objects p277 cannot be matched. For the purposes of element type selectors, the names of WebVTT Internal Node Objects p277 are as given by the following table, where objects having the concrete class given in a cell in the first column have the name given by the second column of the same row:
Concrete class WebVTT Class Objects p277 WebVTT Italic Objects p277 WebVTT Bold Objects p277 WebVTT Ruby Objects
p277
Name c i b ruby rt v
Other elements (specifically, Lists of WebVTT Node Objects p277 ) No explicit name.
For the purposes of element type and universal selectors, WebVTT Internal Node Objects p277 are considered as being in the namespace expressed as the empty string.
725
For the purposes of attribute selector matching, WebVTT Internal Node Objects p277 have no attributes, except for WebVTT Voice Objects p277 , which have a single attribute named "voice" whose value is the value of the WebVTT Voice Object p277 . For the purposes of class selector matching, WebVTT Internal Node Objects p277 have the classes described as the WebVTT Node Object's applicable classes p277 .
The following properties apply to the '::cue()' pseudo-element with an argument: 'color' 'text-shadow' 'text-outline' the properties corresponding to the 'background' shorthand the properties corresponding to the 'outline' shorthand properties relating to the transition and animation features
The following properties apply to the '::cue()' pseudo-element with an argument when the selector does not contain the ':past' and ':future' pseudo-classes: the properties corresponding to the 'font' shorthand, including 'line-height'
Properties that do not apply must be ignored. As a special exception, the properties corresponding to the 'background' shorthand, when they would have been applied to the List of WebVTT Node Objects p277 , must instead be applied to the WebVTT cue background box p722 .
12.3.2.3.2 The ':past' and ':future' pseudo-classes The ':past' and ':future' pseudo-classes only match WebVTT Node Objects p277 . The ':past' pseudo-class only matches WebVTT Node Objects p277 that are in the past p726 . A WebVTT Node Object p277 c is in the past if, in a pre-order, depth-first traversal of the text track cue p256 's List of WebVTT Node Objects p277 , there exists a WebVTT Timestamp Object p277 whose value is less than the current playback position p247 of the media element p235 that is the matched element, entirely after the WebVTT Node Object p277 c. The ':future' pseudo-class only matches WebVTT Node Objects p277 that are in the future p726 . A WebVTT Node Object p277 c is in the future if, in a pre-order, depth-first traversal of the text track cue p256 's List of WebVTT Node Objects p277 , there exists a WebVTT Timestamp Object p277 whose value is greater than the current playback position p247 of the media element p235 that is the matched element, entirely before the WebVTT Node Object p277 c.
12.3.3 Images
When an img p199 element or an input p353 element when its type p355 attribute is in the Image Button p373 state represents p708 an image, it is expected to be treated as a replaced element. When an img p199 element or an input p353 element when its type p355 attribute is in the Image Button p373 state does not represent p708 an image, but the element already has intrinsic dimensions (e.g. from the dimension attributes p320 or CSS rules), and either the user agent has reason to believe that the image will become available and be rendered in due course or the Document p33 is in quirks mode p81 , the element is expected to be treated as a replaced element whose content is the text that the element represents, if any, optionally alongside an icon indicating that the image is being obtained. For input p353 elements, the text is expected to appear button-like to indicate that the element is a button p347 . When an img p199 element represents p708 some text and the user agent does not expect this to change, the element is expected to be treated as an inline element whose content is the text, optionally with an icon indicating that an image is missing. When an img p199 element represents p708 nothing and the user agent does not expect this to change, the element is expected to not be rendered at all. When an img p199 element might be a key part of the content, but neither the image nor any kind of alternative text is available, and the user agent does not expect this to change, the element is expected to be treated as an inline element whose content is an icon indicating that an image is missing. When an input p353 element whose type p355 attribute is in the Image Button p373 state does not represent p708 an image and the user agent does not expect this to change, the element is expected to be treated as a replaced element consisting of a button whose content is the element's alternative text. The intrinsic dimensions of the button are expected to be about one line in height and whatever width is necessary to render the text on one line.
726
The icons mentioned above are expected to be relatively small so as not to disrupt most text but be easily clickable. In a visual environment, for instance, icons could be 16 pixels by 16 pixels square, or 1em by 1em if the images are scalable. In an audio environment, the icon could be a short bleep. The icons are intended to indicate to the user that they can be used to get to whatever options the UA provides for images, and, where appropriate, are expected to provide access to the context menu that would have come up if the user interacted with the actual image. All animated images with the same absolute URL p56 and the same image data are expected to be rendered synchronised to the same timeline as a group, with the timeline starting at the time of the most recent addition to the group. Note: In other words, the animation loop of an animated image is restarted each time another image with the same absolute URL p56 and image data begins to animate, e.g. after being inserted into the document.
The following CSS rules are expected to apply when the Document p33 is in quirks mode p81 : @namespace url(http://www.w3.org/1999/xhtml); img[align=left] { margin-right: 3px; } /* case-insensitive */ img[align=right] { margin-left: 3px; } /* case-insensitive */
727
} applet[align=bottom], embed[align=bottom], iframe[align=bottom], img[align=bottom], input[type=image][align=bottom], object[align=bottom] { /* case-insensitive */ vertical-align: bottom; } When an applet p744 , embed p220 , iframe p213 , img p199 , or object p222 element, or an input p353 element whose type p355 attribute is in the Image Button p373 state, has an align attribute whose value is an ASCII case-insensitive p36 match for the string "center" or the string "middle", the user agent is expected to act as if the element's 'vertical-align' property was set to a value that aligns the vertical middle of the element with the parent element's baseline. The hspace attribute of applet p744 , embed p220 , iframe p213 , img p199 , or object p222 elements, and input p353 elements with a type p355 attribute in the Image Button p373 state, maps to the dimension properties p708 'margin-left' and 'margin-right' on the element. The vspace attribute of applet p744 , embed p220 , iframe p213 , img p199 , or object p222 elements, and input p353 elements with a type p355 attribute in the Image Button p373 state, maps to the dimension properties p708 'margin-top' and 'margin-bottom' on the element. When an img p199 element, object p222 element, or input p353 element with a type p355 attribute in the Image Button p373 state is contained within a hyperlink p440 and has a border attribute whose value, when parsed using the rules for parsing non-negative integers p39 , is found to be a number greater than zero, the user agent is expected to use the parsed value for eight presentational hints p708 : four setting the parsed value as a pixel length for the element's 'border-top-width', 'border-right-width', 'border-bottom-width', and 'border-left-width' properties, and four setting the element's 'border-top-style', 'border-right-style', 'border-bottom-style', and 'border-left-style' properties to the value 'solid'. The width p320 and height p320 attributes on applet p744 , embed p220 , iframe p213 , img p199 , object p222 or video p228 elements, and input p353 elements with a type p355 attribute in the Image Button p373 state, map to the dimension properties p708 'width' and 'height' on the element respectively.
12.3.6 Toolbars
When a menu p428 element's type p429 attribute is in the toolbar p429 state, the element is expected to be treated as a replaced element with a height about two lines high and a width derived from the contents of the element. The element is expected to have, by default, the appearance of a toolbar on the user agent's platform. It is expected to contain the menu that is built p430 from the element.
12.4 Bindings
12.4.1 Introduction
A number of elements have their rendering defined in terms of the 'binding' property. [BECSS] p781 The CSS snippets below set the 'binding' property to a user-agent-defined value, represented below by keywords like button. The rules then described for these bindings are only expected to apply if the element's 'binding' property has not been overridden (e.g. by the author) to have another value. Exactly how the bindings are implemented is not specified by this specification. User agents are encouraged to make their bindings set the 'appearance' CSS property appropriately to achieve platform-native appearances for
728
widgets, and are expected to implement any relevant animations, etc, that are appropriate for the platform. [CSSUI] p782
729
input[type=datetime] { binding: input-datetime; } /* case-insensitive */ input[type=date] { binding: input-date; } /* case-insensitive */ input[type=month] { binding: input-month; } /* case-insensitive */ input[type=week] { binding: input-week; } /* case-insensitive */ input[type=time] { binding: input-time; } /* case-insensitive */ input[type=datetime-local] { binding: input-datetime-local; } /* case-insensitive */ input[type=number] { binding: input-number; } /* case-insensitive */ When the input-datetime binding applies to an input p353 element whose type p355 attribute is in the Date and Time p362 state, the element is expected to render as an 'inline-block' box depicting a Date and Time control. When the input-date binding applies to an input p353 element whose type p355 attribute is in the Date p363 state, the element is expected to render as an 'inline-block' box depicting a Date control. When the input-month binding applies to an input p353 element whose type p355 attribute is in the Month p364 state, the element is expected to render as an 'inline-block' box depicting a Month control. When the input-week binding applies to an input p353 element whose type p355 attribute is in the Week p365 state, the element is expected to render as an 'inline-block' box depicting a Week control. When the input-time binding applies to an input p353 element whose type p355 attribute is in the Time p366 state, the element is expected to render as an 'inline-block' box depicting a Time control. When the input-datetime-local binding applies to an input p353 element whose type p355 attribute is in the Local Date and Time p366 state, the element is expected to render as an 'inline-block' box depicting a Local Date and Time control. When the input-number binding applies to an input p353 element whose type p355 attribute is in the Number p368 state, the element is expected to render as an 'inline-block' box depicting a Number control. These controls are all expected to be about one line high, and about as wide as necessary to show the widest possible value.
12.4.8 The input p353 element as a checkbox and radio button widgets
@namespace url(http://www.w3.org/1999/xhtml);
730
input[type=checkbox] { binding: input-checkbox; } /* case-insensitive */ input[type=radio] { binding: input-radio; } /* case-insensitive */ When the input-checkbox binding applies to an input p353 element whose type p355 attribute is in the Checkbox p370 state, the element is expected to render as an 'inline-block' box containing a single checkbox control, with no label. When the input-radio binding applies to an input p353 element whose type p355 attribute is in the Radio Button p371 state, the element is expected to render as an 'inline-block' box containing a single radio button control, with no label.
731
Once the animation has ended, the user agent is expected to increment the marquee current loop index p746 . If the element is still turned on p745 after this, then the user agent is expected to restart the animation. If the element's behavior p745 attribute is in the alternate p745 state When the marquee current loop index p746 is even (or zero), slide the contents of the element in the direction described by the direction p745 attribute as defined below, such that it begins flush with the start side of the marquee p745 , and ends flush with the end side of the marquee p745 . When the marquee current loop index p746 is odd, slide the contents of the element in the opposite direction than that described by the direction p745 attribute as defined below, such that it begins flush with the end side of the marquee p745 , and ends flush with the start side of the marquee p745 . For example, if the direction p745 attribute is left p745 (the default), then the contents would with their right edge flush with the right inner edge of the marquee p745 's content area, and the contents would then slide up to the point where the left edge of the contents are flush with the left inner edge of the marquee p745 's content area. Once the animation has ended, the user agent is expected to increment the marquee current loop index p746 . If the element is still turned on p745 after this, then the user agent is expected to continue the animation. The direction p745 attribute has the meanings described in the following table:
direction p745 attribute state Direction of animation Start edge End edge left
p745
Opposite direction Left to Right Right to left Down (Top to Bottom) Up (Bottom to Top)
In any case, the animation should proceed such that there is a delay given by the marquee scroll interval p746 between each frame, and such that the content moves at most the distance given by the marquee scroll distance p746 with each frame. When a marquee p745 element has a bgcolor attribute set, the value is expected to be parsed using the rules for parsing a legacy color value p52 , and if that does not return an error, the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'background-color' property to the resulting color. The width and height attributes on a marquee p745 element map to the dimension properties p708 'width' and 'height' on the element respectively. The intrinsic height of a marquee p745 element with its direction p745 attribute in the up p746 or down p746 states is 200 CSS pixels. The vspace attribute of a marquee p745 element maps to the dimension properties p708 'margin-top' and 'marginbottom' on the element. The hspace attribute of a marquee p745 element maps to the dimension properties p708 'margin-left' and 'margin-right' on the element. The 'overflow' property on the marquee p745 element is expected to be ignored; overflow is expected to always be hidden.
732
733
When the textarea binding applies to a textarea p395 element, the element is expected to render as an 'inlineblock' box rendered as a multiline text field. If the element has a cols p396 attribute, and parsing that attribute's value using the rules for parsing non-negative integers p39 doesn't generate an error, then the user agent is expected to use the attribute as a presentational hint p708 for the 'width' property on the element, with the value being the textarea effective width p734 (as defined below). Otherwise, the user agent is expected to act as if it had a user-agent-level style sheet rule setting the 'width' property on the element to the textarea effective width p734 . The textarea effective width of a textarea p395 element is sizeavg + sbw, where size is the element's character width p396 , avg is the average character width of the primary font of the element, in CSS pixels, and sbw is the width of a scroll bar, in CSS pixels. (The element's 'letter-spacing' property does not affect the result.) If the element has a rows p396 attribute, and parsing that attribute's value using the rules for parsing non-negative integers p39 doesn't generate an error, then the user agent is expected to use the attribute as a presentational hint p708 for the 'height' property on the element, with the value being the textarea effective height p734 (as defined below). Otherwise, the user agent is expected to act as if it had a user-agent-level style sheet rule setting the 'height' property on the element to the textarea effective height p734 . The textarea effective height of a textarea p395 element is the height in CSS pixels of the number of lines specified the element's character height p396 , plus the height of a scrollbar in CSS pixels. User agents are expected to apply the 'white-space' CSS property to textarea p395 elements. For historical reasons, if the element has a wrap p396 attribute whose value is an ASCII case-insensitive p36 match for the string "off", then the user agent is expected to treat the attribute as a presentational hint p708 setting the element's 'white-space' property to 'pre'.
3.
734
If rows has no entries, then add a single entry consisting of the value 1 and the unit relative to rows. 4. Invoke the algorithm defined below to convert a list of dimensions to a list of pixel values p735 using cols as the input list, and the width of the surface that the frameset p747 is being rendered into, in CSS pixels, as the input dimension. Let sized cols be the resulting list. Invoke the algorithm defined below to convert a list of dimensions to a list of pixel values p735 using rows as the input list, and the height of the surface that the frameset p747 is being rendered into, in CSS pixels, as the input dimension. Let sized rows be the resulting list. 5. Split the surface into a grid of wh rectangles, where w is the number of entries in sized cols and h is the number of entries in sized rows. Size the columns so that each column in the grid is as many CSS pixels wide as the corresponding entry in the sized cols list. Size the rows so that each row in the grid is as many CSS pixels high as the corresponding entry in the sized rows list. 6. Let children be the list of frame p747 and frameset p747 elements that are children of the frameset p747 element for which the algorithm was invoked. For each row of the grid of rectangles created in the previous step, from top to bottom, run these substeps: 1. For each rectangle in the row, from left to right, run these substeps: 1. If there are any elements left in children, take the first element in the list, and assign it to the rectangle. If this is a frameset p747 element, then recurse the entire frameset p747 layout algorithm for that frameset p747 element, with the rectangle as the surface. Otherwise, it is a frame p747 element; create a nested browsing context p499 sized to fit the rectangle. 2. 8. If there are any elements left in children, remove the first element from children.
7.
If the frameset p747 element has a border p735 , draw an outer set of borders around the rectangles, using the element's frame border color p735 . For each rectangle, if there is an element assigned to that rectangle, and that element has a border p735 , draw an inner set of borders around that rectangle, using the element's frame border color p735 . For each (visible) border that does not abut a rectangle that is assigned a frame p747 element with a noresize attribute (including rectangles in further nested frameset p747 elements), the user agent is expected to allow the user to move the border, resizing the rectangles within, keeping the proportions of any nested frameset p747 grids. A frameset p747 or frame p747 element has a border if the following algorithm returns true: 1. If the element has a frameborder attribute whose value is not the empty string and whose first character is either a U+0031 DIGIT ONE (1) character, a U+0079 LATIN SMALL LETTER Y character (y), or a U+0059 LATIN CAPITAL LETTER Y character (Y), then return true. Otherwise, if the element has a frameborder attribute, return false. Otherwise, if the element has a parent element that is a frameset p747 element, then return true if that element has a border p735 , and false if it does not. Otherwise, return true.
2. 3.
4.
The frame border color of a frameset p747 or frame p747 element is the color obtained from the following algorithm: 1. If the element has a bordercolor attribute, and applying the rules for parsing a legacy color value p52 to that attribute's value does not result in an error, then return the color so obtained. Otherwise, if the element has a parent element that is a frameset p747 element, then the frame border color p735 of that element. Otherwise, return gray.
2.
3.
The algorithm to convert a list of dimensions to a list of pixel values consists of the following steps: 1. Let input list be the list of numbers and units passed to the algorithm.
735
Let output list be a list of numbers the same length as input list, all zero. Entries in output list correspond to the entries in input list that have the same position. 2. 3. Let input dimension be the size passed to the algorithm. Let count percentage be the number of entries in input list whose unit is percentage. Let total percentage be the sum of all the numbers in input list whose unit is percentage. Let count relative be the number of entries in input list whose unit is relative. Let total relative be the sum of all the numbers in input list whose unit is relative. Let count absolute be the number of entries in input list whose unit is absolute. Let total absolute be the sum of all the numbers in input list whose unit is absolute. Let remaining space be the value of input dimension. 4. If total absolute is greater than remaining space, then for each entry in input list whose unit is absolute, set the corresponding value in output list to the number of the entry in input list multiplied by remaining space and divided by total absolute. Then, set remaining space to zero. Otherwise, for each entry in input list whose unit is absolute, set the corresponding value in output list to the number of the entry in input list. Then, decrement remaining space by total absolute. 5. If total percentage multiplied by the input dimension and divided by 100 is greater than remaining space, then for each entry in input list whose unit is percentage, set the corresponding value in output list to the number of the entry in input list multiplied by remaining space and divided by total percentage. Then, set remaining space to zero. Otherwise, for each entry in input list whose unit is percentage, set the corresponding value in output list to the number of the entry in input list multiplied by the input dimension and divided by 100. Then, decrement remaining space by total percentage multiplied by the input dimension and divided by 100. 6. For each entry in input list whose unit is relative, set the corresponding value in output list to the number of the entry in input list multiplied by remaining space and divided by total relative. Return output list.
7.
User agents working with integer values for frame widths (as opposed to user agents that can lay frames out with subpixel accuracy) are expected to distribute the remainder first to the last entry whose unit is relative, then equally (not proportionally) to each entry whose unit is percentage, then equally (not proportionally) to each entry whose unit is absolute, and finally, failing all else, to the last entry.
736
A string provided by a script (e.g. the argument to window.alert() p563 ) is expected to be treated as an independent set of one or more bidirectional algorithm paragraphs when displayed, as defined by the bidirectional algorithm, including, for instance, supporting the paragraph-breaking behaviour of U+000A LINE FEED (LF) characters. For the purposes of determining the paragraph level of such text in the bidirectional algorithm, this specification does not provide a higher-level override of rules P2 and P3. [BIDI] p781 When necessary, authors can enforce a particular direction for a given paragraph by starting it with the Unicode U+200E LEFT-TO-RIGHT MARK or U+200F RIGHT-TO-LEFT MARK characters. Thus, the following script:
737
alert('\u05DC\u05DE\u05D3 HTML \u05D4\u05D9\u05D5\u05DD!') ...would always result in a message reading " LMTH ( "!not " HTML ,)"!regardless of the language of the user agent interface or the direction of the page or any of its elements. For a more complex example, consider the following script: /* Warning: this script does not handle right-to-left scripts correctly */ var s; if (s = prompt('What is your name?')) { alert(s + '! Ok, Fred, ' + s + ', and Wilma will get the car.'); } When the user enters "Kitty", the user agent would alert "Kitty! Ok, Fred, Kitty, and Wilma will get the car.". However, if the user enters " ," then the bidirectional algorithm will determine that the direction of the paragraph is right-to-left, and so the output will be the following unintended mess: " ! derF ,kO, , rac eht teg lliw amliW dna." To force an alert that starts with user-provided text (or other text of unknown directionality) to render left-toright, the string can be prefixed with a U+200E LEFT-TO-RIGHT MARK character: var s; if (s = prompt('What is your name?')) { alert('\u200E' + s + '! Ok, Fred, ' + s + ', and Wilma will get the car.'); }
738
13 Obsolete features
13.1 Obsolete but conforming features
Features listed in this section will trigger warnings in conformance checkers. Authors should not specify an http-equiv p125 attribute in the Content Language p126 state on a meta p122 element. The lang p92 attribute should be used instead. Authors should not specify a border p743 attribute on an img p199 element. If the attribute is present, its value must be the string "0". CSS should be used instead. Authors should not specify a language p742 attribute on a script p133 element. If the attribute is present, its value must be an ASCII case-insensitive p36 match for the string "JavaScript" and either the type p133 attribute must be omitted or its value must be an ASCII case-insensitive p36 match for the string "text/javascript". The attribute should be entirely omitted instead (with the value "JavaScript", it has no effect), or replaced with use of the type p133 attribute. Authors should not specify the name p741 attribute on a p173 elements. If the attribute is present, its value must not be the empty string and must neither be equal to the value of any of the IDs p92 in the element's home subtree p29 other than the element's own ID p92 , if any, nor be equal to the value of any of the other name p741 attributes on a p173 elements in the element's home subtree p29 . If this attribute is present and the element has an ID p92 , then the attribute's value must be equal to the element's ID p92 . In earlier versions of the language, this attribute was intended as a way to specify possible targets for fragment identifiers in URLs p55 . The id p92 attribute should be used instead. Note: In the HTML syntax p613 , specifying a DOCTYPE p613 that is an obsolete permitted DOCTYPE p614 will also trigger a warning. Note: The summary p324 attribute, defined in the table p320 section, will also trigger a warning.
Conformance checkers must distinguish between pages that have no conformance errors and have none of these obsolete features, and pages that have no conformance errors but do have some of these obsolete features. For example, a validator could report some pages as "Valid HTML" and others as "Valid HTML with warnings".
739
acronym Use abbr p180 instead. bgsound Use audio p231 instead. dir Use ul p166 instead. frame p747 frameset p747 noframes Either use iframe p213 and CSS instead, or use server-side includes to generate complete pages with the various invariant parts merged in. isindex Use an explicit form p347 and text field p358 combination instead. listing xmp Use pre p162 and code p184 instead. nextid Use GUIDs instead. noembed Use object p222 instead of embed p220 when fallback is necessary. plaintext Use the "text/plain" MIME type p28 instead. rb Providing the ruby base directly inside the ruby p191 element is sufficient; the rb p740 element is unnecessary. Omit it altogether. strike Use del p197 instead if the element is marking an edit, otherwise use s p177 instead. basefont big blink center font marquee p745 multicol nobr spacer tt u Use appropriate elements and/or CSS instead. Where the tt p740 element would have been used for marking up keyboard input, consider the kbd p186 element; for variables, consider the var p185 element; for computer code, consider the code p184 element; and for computer output, consider the samp p186 element. Similarly, if the u p740 element is being used to indicate emphasis, consider using the em p175 element; if it is being used for marking up keywords, consider the b p188 element; and if it is being used for highlighting text for reference purposes, consider the mark p189 element. See also the text-level semantics usage summary p195 for more suggestions with examples. The following attributes are obsolete (though the elements are still part of the language), and must not be used by authors: charset on a p173 elements charset on link p119 elements Use an HTTP Content-Type header on the linked resource instead.
740
coords on a p173 elements shape on a p173 elements Use area p314 instead of a p173 for image maps. methods on a p173 elements methods on link p119 elements Use the HTTP OPTIONS feature instead. name on a p173 elements (except as noted in the previous section) name on embed p220 elements name on img p199 elements name on option p393 elements Use the id p92 attribute instead. rev on a p173 elements rev on link p119 elements Use the rel p440 attribute instead, with an opposite term. (For example, instead of rev="made", use rel="author".) urn on a p173 elements urn on link p119 elements Specify the preferred persistent identifier using the href p440 attribute instead. nohref on area p314 elements Omitting the href p440 attribute is sufficient; the nohref p741 attribute is unnecessary. Omit it altogether. profile on head p116 elements When used for declaring which meta p122 terms are used in the document, unnecessary; omit it altogether, and register the names p124 . When used for triggering specific user agent behaviors: use a link p119 element instead. version on html p116 elements Unnecessary. Omit it altogether. usemap on input p353 elements Use img p199 instead of input p353 for image maps. longdesc on iframe p213 elements longdesc on img p199 elements Use a regular a p173 element to link to the description, or (in the case of images) use an image map p317 to provide a link from the image to the image's description. lowsrc on img p199 elements Use a progressive JPEG image (given in the src p200 attribute), instead of using two separate images. target on link p119 elements Unnecessary. Omit it altogether. scheme on meta p122 elements Use only one scheme per field, or make the scheme declaration part of the value. archive on object p222 elements classid on object p222 elements code on object p222 elements codebase on object p222 elements codetype on object p222 elements Use the data p223 and type p223 attributes to invoke plugins p29 . To set parameters with these names in particular, the param p227 element can be used. declare on object p222 elements Repeat the object p222 element completely each time the resource is to be reused. standby on object p222 elements Optimize the linked resource so that it loads quickly or, at least, incrementally.
741
type on param p227 elements valuetype on param p227 elements Use the name p228 and value p228 attributes without declaring value types. language on script p133 elements (except as noted in the previous section) Use the type p133 attribute instead. event on script p133 elements for on script p133 elements Use DOM Events mechanisms to register event listeners. [DOMEVENTS] p782 datapagesize on table p320 elements Unnecessary. Omit it altogether. abbr on td p332 and th p332 elements Use text that begins in an unambiguous and terse manner, and include any more elaborate text after that. The title p92 attribute can also be useful in including more detailed text, so that the cell's contents can be made terse. axis on td p332 and th p332 elements Use the scope p333 attribute on the relevant th p332 . datasrc on a p173 , applet p744 , button p385 , div p172 , frame p747 , iframe p213 , img p199 , input p353 , label p352 , legend p351 , marquee p745 , object p222 , option p393 , select p387 , span p194 , table p320 , and textarea p395 elements datafld on a p173 , applet p744 , button p385 , div p172 , fieldset p350 , frame p747 , iframe p213 , img p199 , input p353 , label p352 , legend p351 , marquee p745 , object p222 , param p227 , select p387 , span p194 , and textarea p395 elements dataformatas on button p385 , div p172 , input p353 , label p352 , legend p351 , marquee p745 , object p222 , option p393 , select p387 , span p194 , and table p320 elements Use script and a mechanism such as XMLHttpRequest to populate the page dynamically. [XHR] p786
742
alink on body p142 elements bgcolor on body p142 elements link on body p142 elements marginbottom on body p142 elements marginheight on body p142 elements marginleft on body p142 elements marginright on body p142 elements margintop on body p142 elements marginwidth on body p142 elements text on body p142 elements vlink on body p142 elements clear on br p194 elements align on caption p327 elements align on col p328 elements char on col p328 elements charoff on col p328 elements valign on col p328 elements width on col p328 elements align on div p172 elements compact on dl p168 elements align on embed p220 elements hspace on embed p220 elements vspace on embed p220 elements align on hr p161 elements color on hr p161 elements noshade on hr p161 elements size on hr p161 elements width on hr p161 elements align on h1 p150 h6 p150 elements align on iframe p213 elements allowtransparency on iframe p213 elements frameborder on iframe p213 elements hspace on iframe p213 elements marginheight on iframe p213 elements marginwidth on iframe p213 elements scrolling on iframe p213 elements vspace on iframe p213 elements align on input p353 elements hspace on input p353 elements vspace on input p353 elements align on img p199 elements border on img p199 elements (except as noted in the previous section) hspace on img p199 elements vspace on img p199 elements align on legend p351 elements type on li p166 elements compact on menu p428 elements align on object p222 elements border on object p222 elements hspace on object p222 elements vspace on object p222 elements compact on ol p164 elements align on p p160 elements width on pre p162 elements align on table p320 elements bgcolor on table p320 elements border on table p320 elements cellpadding on table p320 elements
743
cellspacing on table p320 elements frame on table p320 elements rules on table p320 elements width on table p320 elements align on tbody p328 , thead p329 , and tfoot p330 elements char on tbody p328 , thead p329 , and tfoot p330 elements charoff on tbody p328 , thead p329 , and tfoot p330 elements valign on tbody p328 , thead p329 , and tfoot p330 elements align on td p332 and th p332 elements bgcolor on td p332 and th p332 elements char on td p332 and th p332 elements charoff on td p332 and th p332 elements height on td p332 and th p332 elements nowrap on td p332 and th p332 elements valign on td p332 and th p332 elements width on td p332 and th p332 elements align on tr p331 elements bgcolor on tr p331 elements char on tr p331 elements charoff on tr p331 elements valign on tr p331 elements compact on ul p166 elements type on ul p166 elements background on body p142 , table p320 , thead p329 , tbody p328 , tfoot p330 , tr p331 , td p332 , and th p332 elements Use CSS instead.
744
DOMString name; DOMString _object; // the underscore is not part of the identifier unsigned long vspace; DOMString width;
The align, alt, archive, code, height, hspace, name, object, vspace, and width IDL attributes must reflect p62 the respective content attributes of the same name. For the purposes of reflection, the applet p744 element's object content attribute is defined as containing a URL p55 . The codeBase IDL attribute must reflect p62 the codebase content attribute, which for the purposes of reflection is defined as containing a URL p55 .
alternate alternate
The missing value default is the scroll p745 state. The direction content attribute on marquee p745 elements is an enumerated attribute p38 with the following keywords (all non-conforming):
Keyword State left right left right
745
The missing value default is the left p745 state. The truespeed content attribute on marquee p745 elements is a boolean attribute p38 . A marquee p745 element has a marquee scroll interval, which is obtained as follows: 1. If the element has a scrolldelay attribute, and parsing its value using the rules for parsing nonnegative integers p39 does not return an error, then let delay be the parsed value. Otherwise, let delay be 85. If the element does not have a truespeed p746 attribute, and the delay value is less than 60, then let delay be 60 instead. The marquee scroll interval p746 is delay, interpreted in milliseconds.
2.
3.
A marquee p745 element has a marquee scroll distance, which, if the element has a scrollamount attribute, and parsing its value using the rules for parsing non-negative integers p39 does not return an error, is the parsed value interpreted in CSS pixels, and otherwise is 6 CSS pixels. A marquee p745 element has a marquee loop count, which, if the element has a loop attribute, and parsing its value using the rules for parsing integers p39 does not return an error or a number less than 1, is the parsed value, and otherwise is 1. The loop IDL attribute, on getting, must return the element's marquee loop count p746 ; and on setting, if the new value is different than the element's marquee loop count p746 and either greater than zero or equal to 1, must set the element's loop content attribute (adding it if necessary) to the valid integer p39 that represents the new value. (Other values are ignored.) A marquee p745 element also has a marquee current loop index, which is zero when the element is created. The rendering layer will occasionally increment the marquee current loop index, which must cause the following steps to be run: 1. 2. 3. If the marquee loop count p746 is 1, then abort these steps. Increment the marquee current loop index p746 by one. If the marquee current loop index p746 is now equal to or greater than the element's marquee loop count p746 , turn off p745 the marquee p745 element and queue a task p553 to fire a simple event p559 named finish at the marquee p745 element. Otherwise, if the behavior p745 attribute is in the alternate p745 state, then queue a task p553 to fire a simple event p559 named bounce at the marquee p745 element. Otherwise, queue a task p553 to fire a simple event p559 named start at the marquee p745 element. The following are the event handlers p555 (and their corresponding event handler event types p556 ) that must be supported, as content and IDL attributes, by marquee p745 elements:
Event handler p555 Event handler event type p556 onbounce onfinish onstart bounce finish start
The behavior, direction, height, hspace, vspace, and width IDL attributes must reflect p62 the respective content attributes of the same name. The bgColor IDL attribute must reflect p62 the bgcolor content attribute. The scrollAmount IDL attribute must reflect p62 the scrollamount content attribute. The default value is 6. The scrollDelay IDL attribute must reflect p62 the scrolldelay content attribute. The default value is 85. The trueSpeed IDL attribute must reflect p62 the truespeed p746 content attribute.
746
13.3.3 Frames
The frameset element acts as the body element p83 in documents that use frames. The frameset p747 element must implement the HTMLFrameSetElement p747 interface. interface HTMLFrameSetElement : HTMLElement { attribute DOMString cols; attribute DOMString rows; attribute Function onafterprint; attribute Function onbeforeprint; attribute Function onbeforeunload; attribute Function onblur; attribute Function onerror; attribute Function onfocus; attribute Function onhashchange; attribute Function onload; attribute Function onmessage; attribute Function onoffline; attribute Function ononline; attribute Function onpagehide; attribute Function onpageshow; attribute Function onpopstate; attribute Function onredo; attribute Function onresize; attribute Function onscroll; attribute Function onstorage; attribute Function onundo; attribute Function onunload; }; The cols and rows IDL attributes of the frameset p747 element must reflect p62 the respective content attributes of the same name. The frameset p747 element must support the following event handler content attributes p556 exposing the event handlers p555 of the Window p503 object: onafterprint p559 onbeforeprint p559 onbeforeunload p559 onblur p559 onerror p559 onfocus p559 onhashchange p559 onload p559 onmessage p559 onoffline p559 ononline p559 onpagehide p559 onpageshow p559 onpopstate p559 onredo p559 onresize p559 onscroll p559 onstorage p559 onundo p559 onunload p559
The DOM interface also exposes event handler IDL attributes p556 that mirror those on the Window p503 element. The onblur p559 , onerror p559 , onfocus p559 , onload p559 , and onscroll p559 event handler IDL attributes p556 of the Window p503 object, exposed on the frameset p747 element, shadow the generic event handler IDL attributes p556 with the same names normally supported by HTML elements p28 . The frame element defines a nested browsing context p499 similar to the iframe p213 element, but rendered within a frameset p747 element. When the browsing context is created, if a src attribute is present, the user agent must resolve p55 the value of that attribute, relative to the element, and if that is successful, must then navigate p520 the element's browsing context to the resulting absolute URL p56 , with replacement enabled p528 , and with the frame p747 element's document's browsing context p499 as the source browsing context p520 .
747
Whenever the src attribute is set, the user agent must resolve p55 the value of that attribute, relative to the element, and if that is successful, the nested browsing context p499 must be navigated p520 to the resulting absolute URL p56 , with the frame p747 element's document's browsing context p499 as the source browsing context p520 . When the browsing context is created, if a name attribute is present, the browsing context name p502 must be set to the value of this attribute; otherwise, the browsing context name p502 must be set to the empty string. Whenever the name attribute is set, the nested browsing context p499 's name p502 must be changed to the new value. If the attribute is removed, the browsing context name p502 must be set to the empty string. When content loads in a frame p747 , after any load events are fired within the content itself, the user agent must queue a task p553 to fire a simple event p559 named load at the frame p747 element. When content fails to load (e.g. due to a network error), then the user agent must queue a task p553 to fire a simple event p559 named error at the element instead. The task source p553 for the tasks p553 above is the DOM manipulation task source p554 . When there is an active parser p82 in the frame p747 , and when anything in the frame p747 is delaying the load event p687 of the frame p747 's browsing context p499 's active document p499 , the frame p747 must delay the load event p687 of its document. The frame p747 element must implement the HTMLFrameElement p748 interface. interface HTMLFrameElement : HTMLElement { attribute DOMString frameBorder; attribute DOMString longDesc; attribute DOMString marginHeight; attribute DOMString marginWidth; attribute DOMString name; attribute boolean noResize; attribute DOMString scrolling; attribute DOMString src; readonly attribute Document contentDocument; readonly attribute WindowProxy contentWindow; }; The name, scrolling, and src IDL attributes of the frame p747 element must reflect p62 the respective content attributes of the same name. The frameBorder IDL attribute of the frame p747 element must reflect p62 the element's frameborder content attribute. The longDesc IDL attribute of the frame p747 element must reflect p62 the element's longdesc content attribute, which for the purposes of reflection is defined as containing a URL p55 . The marginHeight IDL attribute of the frame p747 element must reflect p62 the element's marginheight content attribute. The marginWidth IDL attribute of the frame p747 element must reflect p62 the element's marginwidth content attribute. The noResize IDL attribute of the frame p747 element must reflect p62 the element's noresize content attribute. The contentDocument IDL attribute of the frame p747 element must return the Document p33 object of the active document p499 of the frame p747 element's nested browsing context p499 . The contentWindow IDL attribute must return the WindowProxy p510 object of the frame p747 element's nested browsing context p499 .
[Supplemental] interface HTMLAnchorElement { attribute DOMString attribute DOMString attribute DOMString attribute DOMString
748
attribute DOMString shape; }; The coords, charset, name, rev, and shape IDL attributes of the a p173 element must reflect p62 the respective content attributes of the same name.
[Supplemental] interface HTMLAreaElement { attribute boolean noHref; }; The noHref IDL attribute of the area p314 element must reflect p62 the element's nohref p741 content attribute. The basefont p740 element must implement the HTMLBaseFontElement p749 interface. interface HTMLBaseFontElement : HTMLElement { attribute DOMString color; attribute DOMString face; attribute long size; }; The color, face, and size IDL attributes of the basefont p740 element must reflect p62 the respective content attributes of the same name.
[Supplemental] interface HTMLBodyElement { attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString };
The text IDL attribute of the body p142 element must reflect p62 the element's text p743 content attribute. The bgColor IDL attribute of the body p142 element must reflect p62 the element's bgcolor p743 content attribute. The background IDL attribute of the body p142 element must reflect p62 the element's background p744 content attribute. (The background p744 content is not defined to contain a URL p55 , despite rules regarding its handling in the rendering section above.) The link IDL attribute of the body p142 element must reflect p62 the element's link p743 content attribute. The aLink IDL attribute of the body p142 element must reflect p62 the element's alink p743 content attribute. The vLink IDL attribute of the body p142 element must reflect p62 the element's vlink p743 content attribute.
[Supplemental] interface HTMLBRElement { attribute DOMString clear; }; The clear IDL attribute of the br p194 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLTableCaptionElement { attribute DOMString align; }; The align IDL attribute of the caption p327 element must reflect p62 the content attribute of the same name.
749
The align and width IDL attributes of the col p328 element must reflect p62 the respective content attributes of the same name. The ch IDL attribute of the col p328 element must reflect p62 the element's char p743 content attribute. The chOff IDL attribute of the col p328 element must reflect p62 the element's charoff p743 content attribute. The vAlign IDL attribute of the col p328 element must reflect p62 the element's valign p743 content attribute. User agents must treat dir p740 elements in a manner equivalent to ul p166 elements in terms of semantics and for purposes of rendering. The dir p740 element must implement the HTMLDirectoryElement p750 interface. interface HTMLDirectoryElement : HTMLElement { attribute boolean compact; }; The compact IDL attribute of the dir p740 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLDivElement { attribute DOMString align; }; The align IDL attribute of the div p172 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLDListElement { attribute boolean compact; }; The compact IDL attribute of the dl p168 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLEmbedElement { attribute DOMString align; attribute DOMString name; }; The name and align IDL attributes of the embed p220 element must reflect p62 the respective content attributes of the same name. The font p740 element must implement the HTMLFontElement p750 interface. interface HTMLFontElement : HTMLElement { attribute DOMString color; attribute DOMString face; attribute DOMString size; }; The color, face, and size IDL attributes of the font p740 element must reflect p62 the respective content attributes of the same name.
750
attribute DOMString align; }; The align IDL attribute of the h1 p150 h6 p150 elements must reflect p62 the content attribute of the same name.
Note: The profile IDL attribute on head p116 elements (with the HTMLHeadElement p117 interface) is intentionally omitted. Unless so required by another applicable specification p36 , implementations would therefore not support this attribute. (It is mentioned here as it was defined in a previous version of the DOM specifications.)
[Supplemental] interface HTMLHRElement { attribute DOMString align; attribute DOMString color; attribute boolean noShade; attribute DOMString size; attribute DOMString width; }; The align, color, size, and width IDL attributes of the hr p161 element must reflect p62 the respective content attributes of the same name. The noShade IDL attribute of the hr p161 element must reflect p62 the element's noshade content attribute.
[Supplemental] interface HTMLHtmlElement { attribute DOMString version; }; The version IDL attribute of the html p116 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLIFrameElement { attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString };
The align and scrolling IDL attributes of the iframe p213 element must reflect p62 the respective content attributes of the same name. The frameBorder IDL attribute of the iframe p213 element must reflect p62 the element's frameborder p743 content attribute. The longDesc IDL attribute of the iframe p213 element must reflect p62 the element's longdesc p741 content attribute, which for the purposes of reflection is defined as containing a URL p55 . The marginHeight IDL attribute of the iframe p213 element must reflect p62 the element's marginheight p743 content attribute. The marginWidth IDL attribute of the iframe p213 element must reflect p62 the element's marginwidth p743 content attribute.
[Supplemental] interface HTMLImageElement { attribute DOMString name; attribute DOMString align; attribute DOMString border; attribute unsigned long hspace; attribute DOMString longDesc;
751
attribute unsigned long vspace; }; The name, align, border, hspace, and vspace IDL attributes of the img p199 element must reflect p62 the respective content attributes of the same name. The longDesc IDL attribute of the img p199 element must reflect p62 the element's longdesc p741 content attribute, which for the purposes of reflection is defined as containing a URL p55 .
[Supplemental] interface HTMLInputElement { attribute DOMString align; attribute DOMString useMap; }; The align IDL attribute of the input p353 element must reflect p62 the content attribute of the same name. The useMap IDL attribute of the input p353 element must reflect p62 the element's usemap p741 content attribute.
[Supplemental] interface HTMLLegendElement { attribute DOMString align; }; The align IDL attribute of the legend p351 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLLIElement { attribute DOMString type; }; The type IDL attribute of the li p166 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLLinkElement { attribute DOMString charset; attribute DOMString rev; attribute DOMString target; }; The charset, rev, and target IDL attributes of the link p119 element must reflect p62 the respective content attributes of the same name. User agents must treat listing p740 elements in a manner equivalent to pre p162 elements in terms of semantics and for purposes of rendering.
[Supplemental] interface HTMLMenuElement { attribute boolean compact; }; The compact IDL attribute of the menu p428 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLMetaElement { attribute DOMString scheme; }; User agents may treat the scheme p741 content attribute on the meta p122 element as an extension of the element's name p123 content attribute when processing a meta p122 element with a name p123 attribute whose value is one that the user agent recognizes as supporting the scheme p741 attribute.
752
User agents are encouraged to ignore the scheme p741 attribute and instead process the value given to the metadata name as if it had been specified for each expected value of the scheme p741 attribute. For example, if the user agent acts on meta p122 elements with name p123 attributes having the value "eGMS.subject.keyword", and knows that the scheme p741 attribute is used with this metadata name, then it could take the scheme p741 attribute into account, acting as if it was an extension of the name p123 attribute. Thus the following two meta p122 elements could be treated as two elements giving values for two different metadata names, one consisting of a combination of "eGMS.subject.keyword" and "LGCL", and the other consisting of a combination of "eGMS.subject.keyword" and "ORLY": <!-- this markup is invalid --> <meta name="eGMS.subject.keyword" scheme="LGCL" content="Abandoned vehicles"> <meta name="eGMS.subject.keyword" scheme="ORLY" content="Mah car: kthxbye"> The recommended processing of this markup, however, would be equivalent to the following: <meta name="eGMS.subject.keyword" content="Abandoned vehicles"> <meta name="eGMS.subject.keyword" content="Mah car: kthxbye"> The scheme IDL attribute of the meta p122 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLObjectElement { attribute DOMString align; attribute DOMString archive; attribute DOMString border; attribute DOMString code; attribute DOMString codeBase; attribute DOMString codeType; attribute boolean declare; attribute unsigned long hspace; attribute DOMString standby; attribute unsigned long vspace; }; The align, archive, border, code, declare, hspace, standby, and vspace IDL attributes of the object p222 element must reflect p62 the respective content attributes of the same name. The codeBase IDL attribute of the object p222 element must reflect p62 the element's codebase p741 content attribute, which for the purposes of reflection is defined as containing a URL p55 . The codeType IDL attribute of the object p222 element must reflect p62 the element's codetype p741 content attribute.
[Supplemental] interface HTMLOListElement { attribute boolean compact; }; The compact IDL attribute of the ol p164 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLParagraphElement { attribute DOMString align; }; The align IDL attribute of the p p160 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLParamElement { attribute DOMString type; attribute DOMString valueType; }; The type IDL attribute of the param p227 element must reflect p62 the content attribute of the same name.
753
The valueType IDL attribute of the param p227 element must reflect p62 the element's valuetype p742 content attribute. User agents must treat plaintext p740 elements in a manner equivalent to pre p162 elements in terms of semantics and for purposes of rendering.
[Supplemental] interface HTMLPreElement { attribute unsigned long width; }; The width IDL attribute of the pre p162 element must reflect p62 the content attribute of the same name.
[Supplemental] interface HTMLScriptElement { attribute DOMString event; attribute DOMString htmlFor; }; The event and htmlFor IDL attributes of the script p133 element must return the empty string on getting, and do nothing on setting.
[Supplemental] interface HTMLTableElement { attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString attribute DOMString };
The align, border, frame, rules, and width, IDL attributes of the table p320 element must reflect p62 the respective content attributes of the same name. The bgColor IDL attribute of the table p320 element must reflect p62 the element's bgcolor p743 content attribute. The cellPadding IDL attribute of the table p320 element must reflect p62 the element's cellpadding p743 content attribute. The cellSpacing IDL attribute of the table p320 element must reflect p62 the element's cellspacing p744 content attribute.
[Supplemental] interface HTMLTableSectionElement { attribute DOMString align; attribute DOMString ch; attribute DOMString chOff; attribute DOMString vAlign; }; The align IDL attribute of the tbody p328 , thead p329 , and tfoot p330 elements must reflect p62 the content attribute of the same name. The ch IDL attribute of the tbody p328 , thead p329 , and tfoot p330 elements must reflect p62 the elements' char p744 content attributes. The chOff IDL attribute of the tbody p328 , thead p329 , and tfoot p330 elements must reflect p62 the elements' charoff p744 content attributes. The vAlign IDL attribute of the tbody p328 , thead p329 , and tfoot p330 element must reflect p62 the elements' valign p744 content attributes.
754
[Supplemental] interface HTMLTableCellElement { attribute DOMString abbr; attribute DOMString align; attribute DOMString axis; attribute DOMString bgColor; attribute DOMString ch; attribute DOMString chOff; attribute DOMString height; attribute boolean noWrap; attribute DOMString vAlign; attribute DOMString width; }; The abbr, align, axis, height, and width IDL attributes of the td p332 and th p332 elements must reflect p62 the respective content attributes of the same name. The bgColor IDL attribute of the td p332 and th p332 elements must reflect p62 the elements' bgcolor p744 content attributes. The ch IDL attribute of the td p332 and th p332 elements must reflect p62 the elements' char p744 content attributes. The chOff IDL attribute of the td p332 and th p332 elements must reflect p62 the elements' charoff p744 content attributes. The noWrap IDL attribute of the td p332 and th p332 elements must reflect p62 the elements' nowrap p744 content attributes. The vAlign IDL attribute of the td p332 and th p332 element must reflect p62 the elements' valign p744 content attributes.
[Supplemental] interface HTMLTableRowElement { attribute DOMString align; attribute DOMString bgColor; attribute DOMString ch; attribute DOMString chOff; attribute DOMString vAlign; }; The align IDL attribute of the tr p331 element must reflect p62 the content attribute of the same name. The bgColor IDL attribute of the tr p331 element must reflect p62 the element's bgcolor p744 content attribute. The ch IDL attribute of the tr p331 element must reflect p62 the element's char p744 content attribute. The chOff IDL attribute of the tr p331 element must reflect p62 the element's charoff p744 content attribute. The vAlign IDL attribute of the tr p331 element must reflect p62 the element's valign p744 content attribute.
[Supplemental] interface HTMLUListElement { attribute boolean compact; attribute DOMString type; }; The compact and type IDL attributes of the ul p166 element must reflect p62 the respective content attributes of the same name. User agents must treat xmp p740 elements in a manner equivalent to pre p162 elements in terms of semantics and for purposes of rendering. The bgsound p740 , isindex p740 , multicol p740 , nextid p740 , rb p740 , and spacer p740 elements must use the HTMLUnknownElement p90 interface.
755
readonly attribute HTMLCollection anchors; readonly attribute HTMLCollection applets; void clear(); readonly attribute HTMLAllCollection all; }; The attributes of the Document p33 object listed in the first column of the following table must reflect p62 the content attribute on the body element p83 with the name given in the corresponding cell in the second column on the same row, if the body element p83 is a body p142 element (as opposed to a frameset p747 element). When there is no body element p83 or if it is a frameset p747 element, the attributes must instead return the empty string on getting and do nothing on setting.
IDL attribute Content attribute fgColor bgColor linkColor vlinkColor alinkColor text p743 bgcolor p743 link p743 vlink p743 alink p743
The anchors attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only a p173 elements with name p741 attributes. The applets attribute must return an HTMLCollection p64 rooted at the Document p33 node, whose filter matches only applet p744 elements. The clear() method must do nothing. The all attribute must return an HTMLAllCollection p65 rooted at the Document p33 node, whose filter matches all elements. The object returned for all p756 has several unusual behaviors: The user agent must act as if the ToBoolean() operator in JavaScript converts the object returned for all p756 to the false value. The user agent must act as if, for the purposes of the == and != operators in JavaScript, the object returned for all p756 is equal to the undefined value. The user agent must act such that the typeof operator in JavaScript returns the string undefined when applied to the object returned for all p756 .
Note: These requirements are a willful violation p18 of the JavaScript specification current at the time of writing (ECMAScript edition 3). The JavaScript specification requires that the ToBoolean() operator convert all objects to the true value, and does not have provisions for objects acting as if they were undefined for the purposes of certain operators. This violation is motivated by a desire for compatibility with two classes of legacy content: one that uses the presence of document.all p756 as a way to detect legacy user agents, and one that only supports those legacy user agents and uses the document.all p756 object without testing for its presence first. [ECMA262] p782
756
14 IANA considerations
14.1 text/html
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: text Subtype name: html Required parameters: No required parameters Optional parameters: charset The charset parameter may be provided to definitively specify the document's character encoding p81 , overriding any character encoding declarations p129 in the document. The parameter's value must be the name of the character encoding used to serialize the file, must be a valid character encoding name, and must be an ASCII case-insensitive p36 match for the preferred MIME name p30 for that encoding. [IANACHARSET] p782 Encoding considerations: See the section on character encoding declarations p129 . Security considerations: Entire novels have been written about the security considerations that apply to HTML documents. Many are listed in this document, to which the reader is referred for more details. Some general concerns bear mentioning here, however: HTML is scripted language, and has a large number of APIs (some of which are described in this document). Script can expose the user to potential risks of information leakage, credential leakage, cross-site scripting attacks, cross-site request forgeries, and a host of other problems. While the designs in this specification are intended to be safe if implemented correctly, a full implementation is a massive undertaking and, as with any software, user agents are likely to have security bugs. Even without scripting, there are specific features in HTML which, for historical reasons, are required for broad compatibility with legacy content but that expose the user to unfortunate security problems. In particular, the img p199 element can be used in conjunction with some other features as a way to effect a port scan from the user's location on the Internet. This can expose local network topologies that the attacker would otherwise not be able to determine. HTML relies on a compartmentalization scheme sometimes known as the same-origin policy. An origin p510 in most cases consists of all the pages served from the same host, on the same port, using the same protocol. It is critical, therefore, to ensure that any untrusted content that forms part of a site be hosted on a different origin p510 than any sensitive content on that site. Untrusted content can easily spoof any other page on the same origin, read data from that origin, cause scripts in that origin to execute, submit forms to and from that origin even if they are protected from cross-site request forgery attacks by unique tokens, and make use of any third-party resources exposed to or rights granted to that origin. Interoperability considerations: Rules for processing both conforming and non-conforming content are defined in this specification. Published specification: This document is the relevant specification. Labeling a resource with the text/html p757 type asserts that the resource is an HTML document p77 using the HTML syntax p613 . Applications that use this media type: Web browsers, tools for processing Web content, HTML authoring tools, search engines, validators. Additional information: Magic number(s): No sequence of bytes can uniquely identify an HTML document. More information on detecting HTML documents is available in the Media Type Sniffing specification. [MIMESNIFF] p783 File extension(s): "html" and "htm" are commonly, but certainly not exclusively, used as the extension for HTML documents. Macintosh file type code(s): TEXT
757
Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers used with text/html p757 resources refer to the indicated part of the document p527 .
14.2 text/html-sandboxed
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: text Subtype name: html-sandboxed Required parameters: No required parameters Optional parameters: Same as for text/html p757 Encoding considerations: Same as for text/html p757 Security considerations: The purpose of the text/html-sandboxed p758 MIME type is to provide a way for content providers to indicate that they want the file to be interpreted in a manner that does not give the file's contents access to the rest of the site. This is achieved by assigning the Document p33 objects generated from resources labeled as text/ html-sandboxed p758 unique origins. To avoid having legacy user agents treating resources labeled as text/html-sandboxed p758 as regular text/ html p757 files, authors should avoid using the .html or .htm extensions for resources labeled as text/htmlsandboxed p758 . Furthermore, since the text/html-sandboxed p758 MIME type impacts the origin security model, authors should be careful to prevent tampering with the MIME type labeling mechanism itself when documents are labeled as text/html-sandboxed p758 . If an attacker can cause a file to be served as text/html p757 instead of text/html-sandboxed p758 , then the sandboxing will not take effect and a cross-site scripting attack will become possible. Beyond this, the type is identical to text/html p757 , and the same considerations apply. Interoperability considerations: Same as for text/html p757 Published specification: This document is the relevant specification. Labeling a resource with the text/html-sandboxed p758 type asserts that the resource is an HTML document p77 using the HTML syntax p613 . Applications that use this media type: Same as for text/html p757 Additional information: Magic number(s): Documents labeled as text/html-sandboxed p758 are heuristically indistinguishable from those labeled as text/html p757 . File extension(s): "sandboxed"
758
Macintosh file type code(s): TEXT Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers used with text/html-sandboxed p758 resources refer to the indicated part of the document p527 .
14.3 application/xhtml+xml
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: application Subtype name: xhtml+xml Required parameters: Same as for application/xml [RFC3023] p784 Optional parameters: Same as for application/xml [RFC3023] p784 Encoding considerations: Same as for application/xml [RFC3023] p784 Security considerations: Same as for application/xml [RFC3023] p784 Interoperability considerations: Same as for application/xml [RFC3023] p784 Published specification: Labeling a resource with the application/xhtml+xml p759 type asserts that the resource is an XML document that likely has a root element from the HTML namespace p75 . As such, the relevant specifications are the XML specification, the Namespaces in XML specification, and this specification. [XML] p786 [XMLNS] p786 Applications that use this media type: Same as for application/xml [RFC3023] p784 Additional information: Magic number(s): Same as for application/xml [RFC3023] p784 File extension(s): "xhtml" and "xht" are sometimes used as extensions for XML resources that have a root element from the HTML namespace p75 . Macintosh file type code(s): TEXT Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]>
759
Change controller: W3C Fragment identifiers used with application/xhtml+xml p759 resources have the same semantics as with any XML MIME type p29 . [RFC3023] p784
14.4 text/cache-manifest
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: text Subtype name: cache-manifest Required parameters: No parameters Optional parameters: No parameters Encoding considerations: Always UTF-8. Security considerations: Cache manifests themselves pose no immediate risk unless sensitive information is included within the manifest. Implementations, however, are required to follow specific rules when populating a cache based on a cache manifest, to ensure that certain origin-based restrictions are honored. Failure to correctly implement these rules can result in information leakage, cross-site scripting attacks, and the like. Interoperability considerations: Rules for processing both conforming and non-conforming content are defined in this specification. Published specification: This document is the relevant specification. Applications that use this media type: Web browsers. Additional information: Magic number(s): Cache manifests begin with the string "CACHE MANIFEST", followed by either a U+0020 SPACE character, a U+0009 CHARACTER TABULATION (tab) character, a U+000A LINE FEED (LF) character, or a U+000D CARRIAGE RETURN (CR) character. File extension(s): "manifest" Macintosh file type code(s): No specific Macintosh file type codes are recommended for this type. Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers have no meaning with text/cache-manifest p760 resources.
760
14.5 text/ping
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: text Subtype name: ping Required parameters: No parameters Optional parameters: No parameters Encoding considerations: Not applicable. Security considerations: If used exclusively in the fashion described in the context of hyperlink auditing p441 , this type introduces no new security concerns. Interoperability considerations: Rules applicable to this type are defined in this specification. Published specification: This document is the relevant specification. Applications that use this media type: Web browsers. Additional information: Magic number(s): text/ping p761 resources always consist of the four bytes 0x50 0x49 0x4E 0x47 (ASCII 'PING'). File extension(s): No specific file extension is recommended for this type. Macintosh file type code(s): No specific Macintosh file type codes are recommended for this type. Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: Only intended for use with HTTP POST requests generated as part of a Web browser's processing of the ping p440 attribute. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers have no meaning with text/ping p761 resources.
14.6 text/vtt
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: text Subtype name: vtt Required parameters: No parameters
761
Optional parameters: No parameters Encoding considerations: Must always be UTF-8. Security considerations: Text track files themselves pose no immediate risk unless sensitive information is included within the data. Implementations, however, are required to follow specific rules when processing text tracks, to ensure that certain origin-based restrictions are honored. Failure to correctly implement these rules can result in information leakage, cross-site scripting attacks, and the like. Interoperability considerations: Rules for processing both conforming and non-conforming content are defined in this specification. Some legacy files violate the requirement to use UTF-8. Published specification: This document is the relevant specification. Applications that use this media type: Web browsers and other video players. Additional information: Magic number(s): WebVTT files all begin with one of the following byte sequences: EF BB BF 57 45 42 56 54 54 20 46 49 4C EF BB BF 57 45 42 56 54 54 20 46 49 4C EF BB BF 57 45 42 56 54 54 20 46 49 4C EF BB BF 57 45 42 56 54 54 20 46 49 4C 57 45 42 56 54 54 20 46 49 4C 45 0A 57 45 42 56 54 54 20 46 49 4C 45 0D 57 45 42 56 54 54 20 46 49 4C 45 20 57 45 42 56 54 54 20 46 49 4C 45 09 45 45 45 45 0A 0D 20 09
Note: (An optional UTF-8 BOM, the ASCII string "WEBVTT FILE", and finally a space, tab, or line break.) File extension(s): "vtt" Macintosh file type code(s): No specific Macintosh file type codes are recommended for this type. Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers have no meaning with text/vtt p761 resources.
14.7 application/microdata+json
This registration is for community review and will be submitted to the IESG for review, approval, and registration with IANA. Type name: application Subtype name: microdata+json Required parameters: Same as for application/json [JSON] p783
762
Optional parameters: Same as for application/json [JSON] p783 Encoding considerations: Always UTF-8. Security considerations: Same as for application/json [JSON] p783 Interoperability considerations: Same as for application/json [JSON] p783 Published specification: Labeling a resource with the application/microdata+json p762 type asserts that the resource is a JSON text that consists of an object with a single entry called "items" consisting of an array of entries, each of which consists of an object with two entries, one called "type" whose value is an array of strings, and one called "properties" whose value is an object whose entries each have a value consisting of an array of either objects or strings, the objects being of the same form as the objects in the aforementioned "items" entry. As such, the relevant specifications are the JSON specification and this specification. [JSON] p783 Applications that use this media type: Same as for application/json [JSON] p783 Additional information: Magic number(s): Same as for application/json [JSON] p783 File extension(s): Same as for application/json [JSON] p783 Macintosh file type code(s): Same as for application/json [JSON] p783 Person & email address to contact for further information: Ian Hickson <[email protected]> Intended usage: Common Restrictions on usage: No restrictions apply. Author: Ian Hickson <[email protected]> Change controller: W3C Fragment identifiers used with application/microdata+json p762 resources have the same semantics as when used with application/json. [JSON] p783
14.8 Ping-From
This section describes a header field for registration in the Permanent Message Header Field Registry. [RFC3864] p784 Header field name Ping-From Applicable protocol http Status standard Author/Change controller W3C Specification document(s) This document is the relevant specification. Related information None.
763
14.9 Ping-To
This section describes a header field for registration in the Permanent Message Header Field Registry. [RFC3864] p784 Header field name Ping-To Applicable protocol http Status standard Author/Change controller W3C Specification document(s) This document is the relevant specification. Related information None.
764
Index
The following sections only cover conforming elements and features.
Elements
This section is non-normative.
List of elements Element a
p173
Description Hyperlink
Parents phrasing
p100
Children transparent
p102
Attributes *
p90 p440
Interface
globals ; href ; HTMLAnchorElement p173 target p440 ; ping p440 ; rel p440 ; media p440 ; hreflang p440 ; type p440 globals p90 globals p90 HTMLElement p88 HTMLElement p88
Abbreviation Contact information for a page or section Hyperlink or dead area on an image map
flow p100 ; phrasing p100 flow p100 ; formatBlock candidate p602 flow p100 ; phrasing p100
area p314
phrasing p100 *
empty
globals p90 ; alt p315 ; HTMLAreaElement p315 coords p316 ; shape p316 ; href p440 ; target p440 ; ping p440 ; rel p440 ; media p440 ; hreflang p440 ; type p440 globals p90 HTMLElement p88
article p147
Selfcontained syndicatable or reusable composition Sidebar for tangentially related content Audio player
flow p100 ; sectioning p100 ; formatBlock candidate p602 flow p100 ; sectioning p100 ; formatBlock candidate p602 flow p100 ; phrasing p100 ; embedded p101 ; interactive p101 flow p100 ; phrasing p100
flow p100
flow p100
aside p148
flow p100
flow p100
globals p90
HTMLElement p88
audio p231
phrasing p100
globals p90 ; src p237 ; preload p245 ; autoplay p249 ; loop p248 ; controls p281 globals p90 globals p90 ; href p118 ; target p119
HTMLAudioElement p231
Keywords
Base URL and metadata p99 default target browsing context p499 for hyperlinks p440 and forms p411 Text directionality isolation Text directionality formatting flow p100 ; phrasing p100 flow p100 ; phrasing p100 flow p100 ; sectioning root p155 ; formatBlock candidate p602 sectioning root p155
bdi p193
phrasing p100
phrasing p100
globals p90
HTMLElement p88
bdo p193
phrasing p100
phrasing p100
globals p90
HTMLElement p88
blockquote p163 A section quoted from another source body p142 Document body
flow p100
flow p100
HTMLQuoteElement p163
html p116
flow p100
globals p90 ; HTMLBodyElement p143 p559 onafterprint ; onbeforeprint p559 ; p559 onbeforeunload ; onblur p559 ; onerror p559 ; onfocus p559 ; onhashchange p559 ; onload p559 ; onmessage p559 ; onoffline p559 ; ononline p559 ; onpagehide p559 ; onpageshow p559 ;
765
Element
Description
Categories
Parents
Children
Attributes onpopstate p559 ; onredo p559 ; onresize p559 ; onscroll p559 ; onstorage p559 ; onundo p559 ; onunload p559
Interface
br p194
phrasing p100
empty
globals p90
HTMLBRElement p194
button p385
Button control flow p100 ; phrasing p100 phrasing p100 ; interactive p101 ; listed p347 ; labelable p347 ; submittable p347 ; formassociated p347
phrasing p100 *
globals p90 ; HTMLButtonElement p386 autofocus p409 ; disabled p409 ; form p407 ; formaction p410 ; formenctype p410 ; formmethod p410 ; formnovalidate p411 ; formtarget p411 ; name p408 ; type p386 ; value p387 globals p90 ; width p287 ; height p287 globals p90 HTMLCanvasElement p286
canvas p286
phrasing p100
transparent p102
HTMLTableCaptionElement p327 HTMLElement p88 HTMLElement p88 HTMLTableColElement p328 HTMLTableColElement p328
Title of a work flow p100 ; phrasing p100 Computer code Table column
p328
globals
p90
; span
p328
command p427
empty
globals p90 ; type p427 ; label p427 ; icon p427 ; disabled p427 ; checked p428 ; radiogroup p428 globals p90
HTMLCommandElement p427
datalist p391
phrasing p100
HTMLDataListElement p391
dd p170
Content for none corresponding p169 dt element(s) A removal from the document Disclosure control for hiding details Defining instance Generic flow container flow p100 ; phrasing p100 * flow p100 ; sectioning root p155 ; interactive p101 flow p100 ; phrasing p100 flow p100 ; formatBlock candidate p602
dl p168
flow p100
globals p90
HTMLElement p88
del p197
phrasing p100
transparent p102
globals p90 ; cite p198 ; datetime p198 globals p90 ; open p423
HTMLModElement p198
details p423
flow p100
HTMLDetailsElement p423
dl p168
Association flow p100 list consisting of zero or more namevalue groups Legend for none corresponding dd p170 element(s) Stress emphasis Plugin p29 flow p100 ; phrasing p100 flow p100 ; phrasing p100 ; embedded p101 ; interactive p101
flow p100
dt p169 *; dd p170 *
globals p90
HTMLDListElement p168
dt p169
dl p168
phrasing p100
globals p90
HTMLElement p88
globals p90 globals p90 ; src p220 ; type p220 ; width p320 ; height p320 ; any*
766
Description
Categories
Parents
Group of form flow p100 ; flow p100 controls sectioning root p155 ; listed p347 ; formassociated p347 none flow p100 ; sectioning root p155 flow p100 ; formatBlock candidate p602 flow p100 figure p170 flow p100
figcaption p172 Caption for figure p170 figure p170 Figure with optional caption Footer for a page or section Usersubmittable form
flow p100
globals p90
figcaption p172 *; globals p90 flow p100 flow p100 * globals p90
footer p153
flow p100
HTMLElement p88
form p347
flow p100
flow p100 *
globals p90 ; accept- HTMLFormElement p347 charset p348 ; action p410 ; autocomplete p348 ; enctype p410 ; method p410 ; name p348 ; novalidate p411 ; target p411 globals p90 HTMLHeadingElement p150
Section heading
phrasing p100
Container for document metadata Introductory or navigational aids for a page or section heading group
html p116
globals p90
HTMLHeadElement p117
header p152
flow p100
globals p90
HTMLElement p88
hgroup p151
flow p100 ; heading p100 ; formatBlock candidate p602 flow p100 none flow p100 ; phrasing p100 flow p100 ; phrasing p100 ; embedded p101 ; interactive p101
flow p100
One or more h1 p150 , h2 p150 , h3 p150 , h4 p150 , h5 p150 , and/or h6 p150 empty head p116 *; body p142 * phrasing p100 text*
globals p90
HTMLElement p88
Thematic break Root element Alternate voice Nested browsing context p499
globals p90 ; src p214 ; HTMLIFrameElement p214 srcdoc p214 ; name p216 ; sandbox p216 ; seamless p218 ; width p320 ; height p320 globals p90 ; alt p200 ; HTMLImageElement p200 src p200 ; usemap p317 ; ismap p203 ; width p320 ; height p320 globals p90 ; HTMLInputElement p354 accept p372 ; alt p374 ; autocomplete p376 ; autofocus p409 ; checked p357 ; dirname p376 ; disabled p409 ; form p407 ; formaction p410 ; formenctype p410 ; formmethod p410 ; formnovalidate p411 ; formtarget p411 ; height p320 ; list p377 ; max p381 ; maxlength p380 ; min p381 ; multiple p379 ; name p408 ; pattern p380 ; placeholder p382 ;
img p199
Image
phrasing p100
empty
input p353
Form control
flow p100 ; phrasing p100 phrasing p100 ; interactive p101 *; listed p347 ; labelable p347 ; submittable p347 ; resettable p347 ; formassociated p347
empty
767
Element
Description
Categories
Parents
Children
Attributes readonly p378 ; required p379 ; size p379 ; src p374 ; step p381 ; type p355 ; value p357 ; width p320
Interface
An addition to flow p100 ; the document phrasing p100 * User input Cryptographic key-pair generator form control flow p100 ; phrasing p100
globals p90 ; cite p198 ; datetime p198 globals p90 globals p90 ; autofocus p409 ; challenge p399 ; disabled p409 ; form p407 ; keytype p399 ; name p408
flow p100 ; phrasing p100 phrasing p100 ; interactive p101 ; listed p347 ; labelable p347 ; submittable p347 ; resettable p347 ; formassociated p347 flow p100 ; phrasing p100 ; interactive p101 ; formassociated p347 none none metadata p99 ; flow p100 *; phrasing p100 * flow p100 ; phrasing p100 * flow p100 ; phrasing p100 flow p100 ; interactive p101 * metadata p99 ; flow p100 *; phrasing p100 * flow p100 ; phrasing p100 ; labelable p347 ; formassociated p347 flow p100 ; sectioning p100 ; formatBlock candidate p602 metadata p99 ; flow p100 ; phrasing p100 phrasing p100
label p352
phrasing p100 *
HTMLLabelElement p352
globals p90 globals p90 ; value p167 * globals p90 ; href p120 ; rel p120 ; media p121 ; hreflang p121 ; type p121 ; sizes p445 globals p90 ; name p314 globals p90 globals p90 ; type p429 ; label p429 globals p90 ; name p123 ; http-equiv p125 ; content p123 ; charset p123 globals p90 ; value p404 ; min p404 ; max p404 ; low p404 ; high p404 ; optimum p404 ; form p407 globals p90
empty head p116 ; noscript p140 *; phrasing p100 * phrasing p100 phrasing p100 flow p100 transparent p102 ; area p314 * phrasing p100 li p166 *; flow p100
empty head p116 ; noscript p140 *; phrasing p100 * phrasing p100 phrasing p100 *
meter p403
Gauge
HTMLMeterElement p404
nav p145
flow p100
flow p100
HTMLElement p88
noscript p140
varies*
globals p90
HTMLElement p88
object p222
Image, flow p100 ; phrasing p100 p100 nested phrasing ; browsing embedded p101 ; p499 p101 context , or interactive *; plugin p29 listed p347 ; submittable p347 ; formassociated p347 Ordered list flow p100 flow p100
globals p90 ; data p223 ; HTMLObjectElement p223 type p223 ; name p223 ; usemap p317 ; form p407 ; width p320 ; height p320
ol p164
li p166
globals p90 ; reversed p165 ; start p165 globals p90 ; disabled p392 ; label p392 globals p90 ; disabled p393 ; label p393 ; selected p393 ; value p393
HTMLOListElement p165
optgroup p392
Group of options in a list box Option in a list box or combo box control
none
select p387
option p393
HTMLOptGroupElement p392
option p393
none
text p101
HTMLOptionElement p393
768
Categories flow p100 ; phrasing p100 ; listed p347 ; labelable p347 ; resettable p347 ; formassociated p347 flow p100 ; formatBlock candidate p602
p p160
Paragraph
flow p100
phrasing p100
globals p90
HTMLParagraphElement p160
Parameter for none object p222 Block of preformatted text Progress bar flow p100 ; formatBlock candidate p602 flow p100 ; phrasing p100 ; labelable p347 ; formassociated p347 flow p100 ; phrasing p100 none
progress p402
phrasing p100
phrasing p100 *
HTMLProgressElement p402
q p179 rp p192
Quotation Parenthesis for ruby annotation text Ruby annotation text Ruby annotation(s) Inaccurate text Computer output Embedded script
rt p192
none
ruby p191
phrasing p100
globals p90
HTMLElement p88
ruby p191
flow p100 ; phrasing p100 flow p100 ; phrasing p100 flow p100 ; phrasing p100 metadata p99 ; flow p100 ; phrasing p100 flow p100 ; sectioning p100 ; formatBlock candidate p602
phrasing p100
phrasing p100 ; rt p192 element; rp p192 element* phrasing p100 phrasing p100 script, data, or script documentation* flow p100
globals p90
HTMLElement p88
globals p90 ; src p133 ; HTMLScriptElement p133 async p134 ; defer p134 ; type p133 ; charset p134 globals p90 HTMLElement p88
section p144
flow p100
select p387
flow p100 ; phrasing p100 phrasing p100 ; interactive p101 ; listed p347 ; labelable p347 ; submittable p347 ; resettable p347 ; formassociated p347 flow p100 ; phrasing p100 none phrasing p100 video p228 ; audio p231 phrasing p100
globals p90 ; autofocus p409 ; disabled p409 ; form p407 ; multiple p388 ; name p408 ; required p388 ; size p388 globals p90 globals p90 ; src p232 ; type p233 ; media p233 globals p90
HTMLSelectElement p388
Side comment Media source for video p228 or audio p231 Generic phrasing container Importance Embedded styling information Subscript Caption for details p423 Superscript
span p194
flow p100 ; phrasing p100 flow p100 ; phrasing p100 metadata p99 ; flow p100 flow p100 ; phrasing p100 none flow p100 ; phrasing p100
phrasing p100
HTMLSpanElement p194
phrasing p100
phrasing p100
globals p90 globals p90 ; media p130 ; type p130 ; scoped p130 globals p90 globals p90 globals p90
varies* head p116 ; noscript p140 *; flow p100 * phrasing p100 details p423 phrasing p100 phrasing p100 phrasing p100 phrasing p100
769
Description Table
Children caption p327 *; colgroup p328 *; thead p329 *; tbody p328 *; tfoot p330 *; tr p331 * tr p331 flow p100
globals p90 globals p90 ; colspan p334 ; rowspan p334 ; headers p334 globals p90 ; autofocus p409 ; cols p396 ; disabled p409 ; form p407 ; maxlength p397 ; name p408 ; placeholder p397 ; readonly p396 ; required p397 ; rows p396 ; wrap p396 globals p90
textarea p395
flow p100 ; phrasing p100 phrasing p100 ; interactive p101 ; listed p347 ; labelable p347 ; submittable p347 ; resettable p347 ; formassociated p347
text p101
HTMLTextAreaElement p395
tfoot p330
table p320
tr p331
HTMLTableSectionElement p329
th p332
tr p331
phrasing p100
globals p90 ; colspan p334 ; rowspan p334 ; headers p334 ; scope p333 globals p90
HTMLTableHeaderCellElement p333
thead p329
Group of heading rows in a table Date and/or time Document title Table row
none
table p320
tr p331
HTMLTableSectionElement p329
time p182
phrasing p100
phrasing p100 *
globals p90 ; datetime p182 ; pubdate p182 globals p90 globals p90
HTMLTimeElement p182
head p116 table p320 ; thead p329 ; tbody p328 ; tfoot p330 audio p231 ; video p228
track p234
none
empty
globals p90 ; default p235 ; kind p234 ; label p235 ; src p234 ; srclang p235 globals p90
p100
HTMLTrackElement p234
ul p166 var
p185
flow p100 flow ; phrasing p100 flow p100 ; phrasing p100 ; embedded p101 ; interactive p101
p100
li p166 phrasing
globals
p90
video p228
phrasing p100
globals p90 ; src p237 ; poster p229 ; preload p245 ; autoplay p249 ; loop p248 ; controls p281 ; width p320 ; height p320 globals p90
wbr p195
phrasing p100
empty
HTMLElement p88
An asterisk (*) in a cell indicates that the actual rules are more complicated than indicated in the table above.
Elements ; link
p119
; meta
p122
; noscript
; script
p133
; style
p130
770
Elements a p173 ; abbr p180 ; address p154 ; article p147 ; aside p148 ; audio p231 ; b p188 ; bdi p193 ; bdo p193 ; blockquote p163 ; br p194 ; button p385 ; canvas p286 ; cite p178 ; code p184 ; command p427 ; datalist p391 ; del p197 ; details p423 ; dfn p180 ; div p172 ; dl p168 ; em p175 ; embed p220 ; fieldset p350 ; figure p170 ; footer p153 ; form p347 ; h1 p150 ; h2 p150 ; h3 p150 ; h4 p150 ; h5 p150 ; h6 p150 ; header p152 ; hgroup p151 ; hr p161 ; i p187 ; iframe p213 ; img p199 ; input p353 ; ins p196 ; kbd p186 ; keygen p398 ; label p352 ; map p313 ; mark p189 ; math p319 ; menu p428 ; meter p403 ; nav p145 ; noscript p140 ; object p222 ; ol p164 ; output p400 ; p p160 ; pre p162 ; progress p402 ; q p179 ; ruby p191 ; s p177 ; samp p186 ; script p133 ; section p144 ; select p387 ; small p176 ; span p194 ; strong p176 ; sub p187 ; sup p187 ; svg p320 ; table p320 ; textarea p395 ; time p182 ; ul p166 ; var p185 ; video p228 ; wbr p195 ; Text p101 article p147 ; aside p148 ; nav p145 ; section p144 h1 p150 ; h2 p150 ; h3 p150 ; h4 p150 ; h5 p150 ; h6 p150 ; hgroup p151 abbr p180 ; audio p231 ; b p188 ; bdi p193 ; bdo p193 ; br p194 ; button p385 ; canvas p286 ; cite p178 ; code p184 ; command p427 ; datalist p391 ; dfn p180 ; em p175 ; embed p220 ; i p187 ; iframe p213 ; img p199 ; input p353 ; kbd p186 ; keygen p398 ; label p352 ; mark p189 ; math p319 ; meter p403 ; noscript p140 ; object p222 ; output p400 ; progress p402 ; q p179 ; ruby p191 ; s p177 ; samp p186 ; script p133 ; select p387 ; small p176 ; span p194 ; strong p176 ; sub p187 ; sup p187 ; svg p320 ; textarea p395 ; time p182 ; var p185 ; video p228 ; wbr p195 ; Text p101
Elements with exceptions area p314 (if it is a descendant of a map p313 element); link p119 (if the itemprop p464 attribute is present); meta p122 (if the itemprop p464 attribute is present); style p130 (if the scoped p130 attribute is present)
a p173 (if it contains only phrasing content p100 ); area p314 (if it is a descendant of a map p313 element); del p197 (if it contains only phrasing content p100 ); ins p196 (if it contains only phrasing content p100 ); link p119 (if the itemprop p464 attribute is present); map p313 (if it contains only phrasing content p100 ); meta p122 (if the itemprop p464 attribute is present) audio p231 (if the controls p281 attribute is present); img p199 (if the usemap p317 attribute is present); input p353 (if the type p355 attribute is not in the Hidden p358 state); menu p428 (if the type p429 attribute is in the toolbar p429 state); object p222 (if the usemap p317 attribute is present); video p228 (if the controls p281 attribute is present)
audio p231 canvas p286 embed p220 iframe p213 img p199 math p319 object p222 svg p320 video p228 a p173 ; button p385 ; details p423 ; embed p220 ; iframe p213 ; keygen p398 ; label p352 ; select p387 ; textarea p395 ;
Sectioning roots p155 Formassociated elements p347 Listed elements p347 Labelable elements p347 Submittable elements p347 Resettable elements p347
blockquote p163 ; body p142 ; details p423 ; fieldset p350 ; figure p170 ; td p332 button p385 ; fieldset p350 ; input p353 ; keygen p398 ; label p352 ; meter p403 ; object p222 ; output p400 ; progress p402 ; select p387 ; textarea p395
button p385 ; fieldset p350 ; input p353 ; keygen p398 ; object p222 ; output p400 ; select p387 ; textarea p395 button p385 ; input p353 ; keygen p398 ; meter p403 ; output p400 ; progress p402 ; select p387 ; textarea p395 button p385 ; input p353 ; keygen p398 ; object p222 ; select p387 ; textarea p395 input p353 ; keygen p398 ; output p400 ; select p387 ; textarea p395
formatBlock section p144 ; nav p145 ; article p147 ; aside p148 ; h1 p150 ; h2 p150 ; h3 p150 ; h4 p150 ; h5 p150 ; candidates p602 h6 p150 ; hgroup p151 ; header p152 ; footer p153 ; address p154 ; p p160 ; pre p162 ; blockquote p163 ; div p172
Attributes
This section is non-normative.
List of attributes (excluding event handler content attributes) Attribute accept input
p372
Element(s)
Description Hint for expected file type in file upload controls p372
Value Set of comma-separated tokens p54 * consisting of valid MIME types with no parameters p28 or audio/*, video/*, or image/* Ordered set of unique space-separated tokens p53 , ASCII case-insensitive p36 , consisting of preferred MIME names p30 of ASCII-compatible character encodings p30 * Ordered set of unique space-separated tokens p53 , case-sensitive p36 , consisting of one Unicode code point in length Valid URL potentially surrounded by spaces p55
accept-charset
form p348
accesskey
Keyboard shortcut to activate or focus element URL p55 to use for form submission p416
action
form p410
771
Element(s) area p315 ; img p200 ; input p374 script p134 form p348 ; input p376
Description Replacement text for use when images are not available Execute script asynchronously Prevent the user agent from providing autocompletions for the form control(s) Automatically focus the form control when the page is loaded Hint that the media resource p236 can be started automatically when the page is loaded Text p98 *
Value
autofocus autoplay
button p409 ; input p409 ; keygen p409 ; select p409 ; textarea p409 audio p249 ; video p249
keygen p399 meta p123 script p134 command p428 ; input p357 blockquote p163 ; del p198 ; ins p198 ; q p179 HTML elements p95 textarea p396 td p334 ; th p334 meta p123
p577
String to package with the Text p98 generated and signed public key Character encoding declaration p129 Character encoding of the external script resource Preferred MIME name p30 of an encoding* Preferred MIME name p30 of an encoding*
Whether the command or control Boolean attribute p38 is checked Link to the source of the quotation or more information about the edit Classes to which the element belongs Maximum number of characters per line Number of columns that the cell is to span Value of the element Whether the element is editable p577 The element's context menu Show user agent controls Coordinates for the shape to be created in an image map p317 Address of the resource Valid URL potentially surrounded by spaces p55 Set of space-separated tokens p53 Valid non-negative integer p39 greater than zero Valid non-negative integer p39 greater than zero Text p98 * "true"; "false" ID p92 * Boolean attribute p38 Valid list of integers p42 * Valid non-empty URL potentially surrounded by spaces p55
contenteditable HTML elements contextmenu controls coords data datetime datetime default defer dir dirname
; video
p281
p316
Date and (optionally) time of the Valid date string with optional time p50 change Value of the element Enable the track if no other text track p254 is more suitable. Defer script execution
p93
Valid date or time string p50 * Boolean attribute p38 Boolean attribute p38
p94
of the
Name of form field to use for sending the element's directionality p94 in form submission p416 Whether the form control is disabled
disabled
button p409 ; command p427 ; fieldset p350 ; input p409 ; keygen p409 ; optgroup p392 ; option p393 ; select p409 ; textarea p409 HTML elements p595 HTML elements p596
draggable dropzone
"true"; "false" Unordered set of unique space-separated tokens p53 , ASCII case-insensitive p36 , consisting of accepted types and drag feedback* "application/x-www-form-urlencoded p410 "; "multipart/form-data p411 "; "text/ plain p411 " ID p92 *
enctype
form p410
Form data set encoding type to use for form submission p416 Associate the label with form control
for for
Specifies controls from which the Unordered set of unique space-separated output was calculated tokens p53 , case-sensitive p36 , consisting of IDs* Associates the control with a form p347 element ID p92 *
form
button p407 ; fieldset p407 ; input p407 ; keygen p407 ; label p407 ; meter p407 ; object p407 ; output p407 ;
772
Attribute
Description
Value
formaction formenctype
URL p55 to use for form submission p416 Form data set encoding type to use for form submission p416 HTTP method to use for form submission p416 Bypass form control validation for form submission p416 Browsing context p499 for form submission p416 The header cells for this cell
Valid URL potentially surrounded by spaces p55 "application/x-www-form-urlencoded p410 "; "multipart/form-data p411 "; "text/ plain p411 " "GET"; "POST" Boolean attribute p38 Valid browsing context name or keyword p502 Unordered set of unique space-separated tokens p53 , case-sensitive p36 , consisting of IDs* Valid non-negative integer p39
button p410 ; input p410 button p411 ; input p411 button p411 ; input p411 td p334 ; th p334
height
canvas p287 ; embed p320 ; iframe p320 ; img p320 ; input p320 ; object p320 ; video p320 HTML elements p571 meter a
p440 p404 p440
Vertical dimension
hidden high href href href hreflang http-equiv icon id ismap itemid itemprop
Whether the element is relevant Low limit of high range Address of the hyperlink
p440
Boolean attribute p38 Valid floating point number p40 * Valid URL potentially surrounded by spaces p55 Valid non-empty URL potentially surrounded by spaces p55 Valid URL potentially surrounded by spaces p55 Valid BCP 47 language tag Text p98 * Valid non-empty URL potentially surrounded by spaces p55 Text p98 * Boolean attribute p38 Valid URL potentially surrounded by spaces p55 Unordered set of unique space-separated tokens p53 , case-sensitive p36 , consisting of valid absolute URLs p56 , defined property names p465 , or text* Unordered set of unique space-separated tokens p53 , case-sensitive p36 , consisting of IDs* Boolean attribute p38 Valid absolute URL p56 *
; area
link p120 base p118 a p440 ; area p440 ; link p121 meta p125 command p427 HTML elements p92 img
p203
Address of the hyperlink p440 Document base URL p56 Language of the linked resource Pragma directive Icon for the command The element's ID p92 Whether the image is a serverside image map Global identifier p464 for a microdata item Property names p465 of a microdata item
itemref
Referenced elements
HTML elements p464 HTML elements p464 keygen p399 track p234
The type of cryptographic key to Text p98 * generate The type of text track "subtitles p234 "; "captions p234 "; "descriptions p234 "; "chapters p234 "; "metadata p234 " Text p98 Valid BCP 47 language tag or the empty string ID p92 * Boolean attribute p38 Valid floating point number p40 *
p533
label lang list loop low manifest max max maxlength media method
command p427 ; menu p429 ; optgroup p392 ; option p393 ; track p235 HTML elements p92 input p377 audio
p248
; video
p248
Whether to loop the media resource p236 High limit of low range Application cache manifest Maximum value Upper bound of range Maximum length of value Applicable media HTTP method to use for form submission p416
Valid non-empty URL potentially surrounded by spaces p55 varies* Valid floating point number p40 * Valid non-negative integer p39 Valid media query p55 "GET"; "POST"
; textarea
p397
a p440 ; area p440 ; link p121 ; source p233 ; style p130 form p410
773
Attribute min min multiple name input p381 meter p404 input
p379
Element(s)
Value
; select
p388
Whether to allow multiple values Boolean attribute p38 Name of form control to use for form submission p416 and in the form.elements p349 API Name of form to use in the document.forms p83 API Name of nested browsing context p499 Name of image map p317 to reference from the usemap p317 attribute Metadata name Name of parameter Bypass form control validation for form submission p416 Whether the details are visible Optimum value in gauge Pattern to be matched by the form control's value URLs p55 to ping User-visible label to be placed within the form control Poster frame to show prior to video playback Hints how much buffering the media resource p236 will likely need Text p98 *
button p408 ; fieldset p408 ; input p408 ; keygen p408 ; output p408 ; select p408 ; textarea p408 form p348 iframe p216 ; object p223 map p314
Text p98 * Valid browsing context name or keyword p502 Text p98 *
name name novalidate open optimum pattern ping placeholder poster preload
Text p98 * Text p98 Boolean attribute p38 Boolean attribute p38 Valid floating point number p40 * Regular expression matching the JavaScript Pattern production Set of space-separated tokens p53 consisting of valid non-empty URLs p55 Text p98 * Valid non-empty URL potentially surrounded by spaces p55 "none p245 "; "metadata p245 "; "auto p245 "
p411
a p440 ; area p440 input p382 ; textarea p397 video p229 audio p245 ; video p245
pubdate
time p182
Whether the element's value Boolean attribute p38 represents a publication time for the nearest article p147 or body p142 Name of group of commands to treat as a radio button group Text p98
command p428 input p378 ; textarea p396 a p440 ; area p440 ; link p120
Whether to allow the value to be Boolean attribute p38 edited by the user Relationship between the document containing the hyperlink and the destination resource Whether the control is required for form submission p416 Number the list backwards Set of space-separated tokens p53 *
Boolean attribute p38 Boolean attribute p38 Valid non-negative integer p39 greater than zero Valid non-negative integer p39
Security rules for nested content Unordered set of unique space-separated tokens p53 , ASCII case-insensitive p36 , consisting of "allow-same-origin p217 ", "allow-forms p217 ", and "allow-scripts p217 " Whether the element is to have its spelling and grammar checked Specifies which cells the header cell applies to Whether the styles apply to the entire document or just the parent subtree Whether to apply the document's styles to the nested content Whether the option is selected by default The kind of shape to be created in an image map p317 Size of the control "true"; "false"
spellcheck
scope scoped
"row p333 "; "col p333 "; "rowgroup p333 "; "colgroup p333 " Boolean attribute p38
seamless
iframe p218
Boolean attribute p38 "circle p316 "; "default p316 "; "poly p316 "; "rect p316 " Valid non-negative integer p39 greater than zero
774
Element(s)
Description Sizes of the icons (for rel p120 ="icon p445 ") Number of columns spanned by the element Address of the resource
Value Unordered set of unique space-separated tokens p53 , ASCII case-insensitive p36 , consisting of sizes* Valid non-negative integer p39 greater than zero Valid non-empty URL potentially surrounded by spaces p55 The source of an iframe srcdoc document p214 * Valid BCP 47 language tag
span src
col p328 ; colgroup p328 audio p237 ; embed p220 ; iframe p214 ; img p200 ; input p374 ; script p133 ; source p232 ; track p234 ; video p237 iframe p214 track p235 ol p165 input p381 HTML elements p95 table p324
Ordinal value p167 of the first item Valid integer p39 Granularity to be matched by the form control's value Presentational and formatting instructions Explanatory text for complex tables for users of screen readers Valid floating point number p40 greater than zero, or "any" CSS declarations* Text p98 *
tabindex
Whether the element is Valid integer p39 focusable, and the relative order of the element for the purposes of sequential focus navigation Browsing context p499 for hyperlink p440 navigation p520 Default browsing context p499 for hyperlink p440 navigation p520 and form submission p416 Browsing context p499 for form submission p416 Advisory information for the element Full term or expansion of abbreviation Hint describing the command Title of the link Alternative style sheet set name Hint for the type of the referenced resource Type of button Valid browsing context name or keyword p502 Valid browsing context name or keyword p502
target target
target title title title title title type type type type type type usemap value value value value value width
form p411 HTML elements p92 abbr p181 ; dfn p180 command p427 link
p122
Valid browsing context name or keyword p502 Text p98 Text p98 Text p98 Text p98 Text p98 Valid MIME type p28 "submit p386 "; "reset p386 "; "button p386 " input type keyword p355 "command p427 "; "checkbox p427 "; "radio p427 " Valid MIME type p28 "context p429 "; "toolbar p429 "
link p122 ; style p131 a p440 ; area p440 ; link p121 button p386 button
p386
; input
p355
command
embed ; object ; script source p233 ; style p130 menu p429 img
p317
p220
; object
p387
p317 p393
p317
to use
Valid hash-name reference p54 * Text p98 varies* Valid integer p39 Valid floating point number p40 Text p98 Valid non-negative integer p39
button
; option
Value to be used for form submission p416 Value of the form control Ordinal value
p167
input p357 li
p167 p404 p228 p287 p320 p320
meter param
; progress
p402
canvas ; embed ; iframe img p320 ; input p320 ; object p320 ; video p320 textarea p396
wrap
How the value of the form "soft p396 "; "hard p396 " control is to be wrapped for form submission p416
An asterisk (*) in a cell indicates that the actual rules are more complicated than indicated in the table above.
List of event handler content attributes Attribute onabort onafterprint Element(s) HTML elements p557 body p559 abort event handler afterprint event handler for Window p503 object Description Value Event handler content attribute p556 Event handler content attribute p556
775
Attribute onbeforeprint onbeforeunload onblur onblur oncanplay oncanplaythrough onchange onclick oncontextmenu oncuechange ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onerror onfocus onfocus onformchange onforminput onhashchange oninput oninvalid onkeydown onkeypress onkeyup onload
Element(s) body p559 body p559 body p559 HTML elements p558 HTML elements p557 HTML elements p557 HTML elements p557 HTML elements p557 HTML elements p557 HTML elements p557 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 body p559 HTML elements p558 body p559 HTML elements p558 HTML elements p558 HTML elements p558 body p559 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 body p559
Description beforeprint event handler for Window p503 object beforeunload event handler for Window p503 object blur event handler for Window p503 object blur event handler canplay p284 event handler canplaythrough p284 event handler change event handler click p33 event handler contextmenu event handler cuechange event handler dblclick event handler drag p595 event handler dragend p595 event handler dragenter p595 event handler dragleave p595 event handler dragover p595 event handler dragstart p595 event handler drop p595 event handler durationchange p285 event handler emptied p284 event handler ended p284 event handler error event handler for Window p503 object, and handler for script error notifications p559 error event handler focus event handler for Window p503 object focus event handler formchange event handler forminput event handler hashchange p529 event handler for Window p503 object input event handler invalid event handler keydown event handler keypress event handler keyup event handler load event handler for Window p503 object
Value Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556
776
Attribute onload onloadeddata onloadedmetadata onloadstart onmessage onmousedown onmousemove onmouseout onmouseover onmouseup onmousewheel onoffline ononline onpagehide onpageshow onpause onplay onplaying onpopstate onprogress onratechange
Element(s) HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 body p559 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 body p559 body p559 body p559 body p559 HTML elements p558 HTML elements p558 HTML elements p558 body p559 HTML elements p558 HTML elements p558 load event handler
Description
Value Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556
loadeddata p284 event handler loadedmetadata p284 event handler loadstart p283 event handler message p606 event handler for Window p503 object mousedown event handler mousemove event handler mouseout event handler mouseover event handler mouseup event handler mousewheel event handler offline p549 event handler for Window p503 object online p549 event handler for Window p503 object pagehide p529 event handler for Window p503 object pageshow p529 event handler for Window p503 object pause p284 event handler play p284 event handler playing p284 event handler popstate p529 event handler for Window p503 object progress p284 event handler ratechange p284 event handler readystatechange p82 event handler redo p600 event handler for Window p503 object reset event handler resize event handler for Window p503 object scroll event handler for Window p503 object scroll event handler seeked p284 event handler seeking p284 event handler select event handler show event handler stalled p284 event handler storage event handler for Window p503 object submit event handler
onreadystatechange HTML elements p558 onredo onreset onresize onscroll onscroll onseeked onseeking onselect onshow onstalled onstorage onsubmit body p559 HTML elements p558 body p559 body p559 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 HTML elements p558 body p559 HTML elements p558
777
Element(s) HTML elements p558 HTML elements p558 body p559 body p559 HTML elements p558 HTML elements p558 suspend p284 event handler
Description
Value Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556 Event handler content attribute p556
timeupdate p284 event handler undo p600 event handler for Window p503 object unload event handler for Window p503 object volumechange p285 event handler waiting p284 event handler
Interfaces
This section is non-normative.
List of interfaces for elements Element(s) a
p173 p180
: HTMLElement p88
abbr
HTMLElement p88 HTMLAreaElement p315 : HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLAudioElement p231 : HTMLMediaElement p235 : HTMLElement p88 HTMLElement p88
article
p193 p193
HTMLBodyElement p143 : HTMLElement p88 HTMLBRElement p194 : HTMLElement p88 HTMLButtonElement p386 : HTMLElement p88 HTMLCanvasElement p286 : HTMLElement p88 HTMLTableCaptionElement p327 : HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLTableSectionElement p329 : HTMLElement p88
p328
button canvas
caption cite
p178
colgroup command
HTMLTableColElement p328 : HTMLElement p88 HTMLCommandElement p427 : HTMLElement p88 HTMLDataListElement p391 : HTMLElement p88 HTMLElement p88 HTMLModElement p198 : HTMLElement p88 HTMLDetailsElement p423 : HTMLElement p88 HTMLDivElement p172 : HTMLElement p88 HTMLDListElement p168 : HTMLElement p88 HTMLElement p88 HTMLElement p88
p427 p391
datalist dd
p170 p197
del
embed
fieldset p350
HTMLElement p88 HTMLElement p88 HTMLFormElement p347 : HTMLElement p88 HTMLHeadElement p117 : HTMLElement p88 HTMLHeadingElement p150 : HTMLElement p88 HTMLHeadingElement p150 : HTMLElement p88 HTMLHeadingElement p150 : HTMLElement p88 HTMLHeadingElement p150 : HTMLElement p88 HTMLHeadingElement p150 : HTMLElement p88
p347 p116
p150
h2 p150 h3 h4 h5
p150 p150 p150
778
Interface(s) HTMLHeadingElement p150 : HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLHRElement p161 : HTMLElement p88 HTMLHtmlElement p116 : HTMLElement p88 HTMLElement p88 HTMLIFrameElement p214 : HTMLElement p88 HTMLImageElement p200 : HTMLElement p88 HTMLInputElement p354 : HTMLElement p88 HTMLModElement p198 : HTMLElement p88 HTMLElement p88
iframe img
p199
input
p353
HTMLKeygenElement p398 : HTMLElement p88 HTMLLabelElement p352 : HTMLElement p88 HTMLLegendElement p352 : HTMLElement p88 HTMLLIElement p167 : HTMLElement p88 HTMLLinkElement p119 : HTMLElement p88 HTMLMapElement p314 : HTMLElement p88 HTMLElement p88 HTMLMeterElement p404 : HTMLElement p88 HTMLElement p88
p352 p351
legend li
p166
link
p119
p145 p140
noscript object ol
p164
HTMLElement p88 HTMLObjectElement p223 : HTMLElement p88 HTMLOListElement p165 : HTMLElement p88 HTMLOptGroupElement p392 : HTMLElement p88 HTMLOptionElement p393 : HTMLElement p88 HTMLOutputElement p401 : HTMLElement p88 HTMLParagraphElement p160 : HTMLElement p88
p222
param pre
HTMLParamElement p227 : HTMLElement p88 HTMLPreElement p162 : HTMLElement p88 HTMLProgressElement p402 : HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLElement p88 HTMLElement p88
p162
ruby s
p177
samp
p186
HTMLElement p88 HTMLElement p88 HTMLSelectElement p388 : HTMLElement p88 HTMLElement p88 HTMLSourceElement p232 : HTMLElement p88 HTMLSpanElement p194 : HTMLElement p88 HTMLElement p88 HTMLStyleElement p130 : HTMLElement p88 HTMLElement p88
p426
source span
p194 p176
strong style
p130
HTMLElement p88 HTMLElement p88 HTMLTableElement p321 : HTMLElement p88 HTMLTableSectionElement p329 : HTMLElement p88 HTMLTableDataCellElement p332 : HTMLTableCellElement p334 : HTMLElement p88 HTMLTextAreaElement p395 : HTMLElement p88 HTMLTableSectionElement p329 : HTMLElement p88 HTMLTableHeaderCellElement p333 : HTMLTableCellElement p334 : HTMLElement p88
table tbody td
p332
thead time
HTMLTableSectionElement p329 : HTMLElement p88 HTMLTimeElement p182 : HTMLElement p88 HTMLTitleElement p117 : HTMLElement p88 HTMLTableRowElement p331 : HTMLElement p88 HTMLTrackElement p234 : HTMLElement p88 HTMLUListElement p166 : HTMLElement p88 HTMLElement p88
p182 p117
title tr
p331
779
Events
This section is non-normative.
List of events Event DOMContentLoaded abort afterprint beforeprint beforeunload blur change click p33 contextmenu error focus formchange forminput hashchange p529 input invalid load message p606 offline p549 online
p549 p529
Interface Event
p33
once it and its scripts have loaded, without waiting for other
Fired at the Window p503 when the download was aborted by the user Fired at the Window p503 after printing Fired at the Window p503 before printing Fired at the Window p503 when the page is about to be unloaded, in case the page would like to show a warning prompt Fired at nodes losing focus Fired at controls when the user commits a value change Fired at an element before its activation behavior p102 is run Fired at elements when the user requests their context menu Fired at elements when network and script errors occur Fired at nodes gaining focus Fired at form controls when the user commits a value change to a control on the form Fired at form controls when the user changes the value of a control on the form Fired at the Window p503 when the fragment identifier part of the document's current address p77 changes Fired at controls when the user changes the value Fired at controls during form validation if they do not satisfy their constraints Fired at the Window p503 when the document has finished loading; fired at an element containing a resource (e.g. img p199 , embed p220 ) when its resource has finished loading Fired at an object when the object receives a message Fired at the Window p503 when the network connections fails Fired at the Window p503 when the network connections returns
p529
pagehide
PageTransitionEvent
Fired at the Window p503 when the page's entry in the session history p513 stops being the current entry p514
pageshow p529 popstate p529 readystatechange redo p600 reset show submit undo
p600 p82
PageTransitionEvent p529 Fired at the Window p503 when the page's entry in the session history p513 becomes the current entry p514 PopStateEvent p529 Event
p33
Fired at the Window p503 when the user navigates the session history p513 Fired at the Document p33 when it finishes parsing and again when all its subresources have finished loading Fired at the Window p503 object when the user goes forward in the undo transaction history p600 Fired at a form p347 element when it is reset p422 Fired at a menu p428 element when it is shown as a context menu Fired at a form p347 element when it is submitted p417
p600
Fired at the Window p503 object when the user goes backward in the undo transaction history p599 Fired at the Window p503 object when the page is going away
unload
Note: See also media element events p283 , application cache events p532 , and drag-and-drop events p595 .
780
References
All references are normative unless marked "Non-normative". [ABNF] Augmented BNF for Syntax Specifications: ABNF, D. Crocker, P. Overell. IETF. [ABOUT] The 'about' URI scheme, J. Holsten, L. Hunt. IETF. [ARIA] Accessible Rich Internet Applications (WAI-ARIA), J. Craig, M. Cooper, L. Pappas, R. Schwerdtfeger, L. Seeman. W3C. [ARIAIMPL] WAI-ARIA 1.0 User Agent Implementation Guide, A. Snow-Weaver, M. Cooper. W3C. [ATAG] (Non-normative) Authoring Tool Accessibility Guidelines (ATAG) 2.0, J. Richards, J. Spellman, J. Treviranus. W3C. [ATOM] (Non-normative) The Atom Syndication Format, M. Nottingham, R. Sayre. IETF. [BCP47] Tags for Identifying Languages; Matching of Language Tags, A. Phillips, M. Davis. IETF. [BECSS] Behavioral Extensions to CSS, I. Hickson. W3C. [BEZIER] Courbes poles, P. de Casteljau. INPI, 1959. [BIDI] UAX #9: Unicode Bidirectional Algorithm, M. Davis. Unicode Consortium. [BOCU1] (Non-normative) UTN #6: BOCU-1: MIME-Compatible Unicode Compression, M. Scherer, M. Davis. Unicode Consortium. [CESU8] (Non-normative) UTR #26: Compatibility Encoding Scheme For UTF-16: 8-BIT (CESU-8), T. Phipps. Unicode Consortium. [CHARMOD] (Non-normative) Character Model for the World Wide Web 1.0: Fundamentals, M. Drst, F. Yergeau, R. Ishida, M. Wolf, T. Texin. W3C. [COMPUTABLE] (Non-normative) On computable numbers, with an application to the Entscheidungsproblem, A. Turing. In Proceedings of the London Mathematical Society, series 2, volume 42, pages 230-265. London Mathematical Society, 1937. [COOKIES] HTTP State Management Mechanism, A. Barth. IETF. [CORS] Cross-Origin Resource Sharing, A. van Kesteren. W3C. [CP51932] CP51932, Y. Naruse. IANA. [CSS] Cascading Style Sheets Level 2 Revision 1, B. Bos, T. elik, I. Hickson, H. Lie. W3C. [CSSATTR] CSS Styling Attribute Syntax, E. Etemad. W3C. [CSSCOLOR] CSS Color Module Level 3, T. elik, C. Lilley, L. Baron. W3C. [CSSFONTS] CSS Fonts Module Level 3, J. Daggett. W3C.
781
[CSSIMAGES] CSS Image Values and Replaced Content Module Level 3, E. Etemad, T. Atkins. W3C. [CSSOM] Cascading Style Sheets Object Model (CSSOM), A. van Kesteren. W3C. [CSSOMVIEW] CSSOM View Module, A. van Kesteren. W3C. [CSSRUBY] CSS3 Ruby Module, R. Ishida. W3C. [CSSUI] CSS3 Basic User Interface Module, T. elik. W3C. [CSSVALUES] CSS3 Values and Units, H. Lie, C. Lilley. W3C. [DOMCORE] Document Object Model (DOM) Level 3 Core Specification, A. Le Hors, P. Le Hegaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrnes. W3C. [DOMEVENTS] Document Object Model (DOM) Level 3 Events Specification, D. Schepers. W3C. [DOMRANGE] Document Object Model (DOM) Level 2 Traversal and Range Specification, J. Kesselman, J. Robie, M. Champion, P. Sharpe, V. Apparao, L. Wood. W3C. [E163] Recommendation E.163 Numbering Plan for The International Telephone Service, CCITT Blue Book, Fascicle II.2, pp. 128-134, November 1988. [ECMA262] ECMAScript Language Specification. ECMA. [ECMA357] (Non-normative) ECMAScript for XML (E4X) Specification. ECMA. [EUCKR] Hangul Unix Environment. Korea Industrial Standards Association. Ref. No. KS C 5861-1992. [EUCJP] Definition and Notes of Japanese EUC. UI-OSF-USLP. In English in the abridged translation of the UI-OSF Application Platform Profile for Japanese Environment, Appendix C. [EVENTSOURCE] Server-Sent Events, I. Hickson. W3C. [FILEAPI] File API, A. Ranganathan. W3C. [GBK] Chinese Internal Code Specification. Chinese IT Standardization Technical Committee. [GRAPHICS] (Non-normative) Computer Graphics: Principles and Practice in C, Second Edition, J. Foley, A. van Dam, S. Feiner, J. Hughes. Addison-Wesley. ISBN 0-201-84840-6. [GREGORIAN] (Non-normative) Inter Gravissimas, A. Lilius, C. Clavius. Gregory XIII Papal Bulls, February 1582. [HATOM] (Non-normative) hAtom, D Janes. Microformats. [HTMLDIFF] (Non-normative) HTML5 differences from HTML4, A. van Kesteren. W3C. [HTTP] Hypertext Transfer Protocol HTTP/1.1, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, T. Berners-Lee. IETF. [IANACHARSET] Character Sets. IANA.
782
[IANAPERMHEADERS] Permanent Message Header Field Names. IANA. [ISO8601] ISO8601: Data elements and interchange formats Information interchange Representation of dates and times. ISO. [ISO885911] ISO-8859-11: Information technology 8-bit single-byte coded graphic character sets Part 11: Latin/Thai alphabet. ISO. [JSON] The application/json Media Type for JavaScript Object Notation (JSON), D. Crockford. IETF. [JSURL] The 'javascript' resource identifier scheme, B. Hhrmann. IETF. [MAILTO] The mailto URL scheme, P. Hoffman, L. Masinter, J. Zawinski. IETF. [MATHML] Mathematical Markup Language (MathML), D. Carlisle, P. Ion, R. Miner, N. Poppelier. W3C. [MIMESNIFF] Media Type Sniffing, A. Barth, I. Hickson. IETF. [MQ] Media Queries, H. Lie, T. elik, D. Glazman, A. van Kesteren. W3C. [NPAPI] (Non-normative) Gecko Plugin API Reference. Mozilla. [OPENSEARCH] Autodiscovery in HTML/XHTML. In OpenSearch 1.1 Draft 4, Section 4.6.2. OpenSearch.org. [ORIGIN] The HTTP Origin Header, A. Barth, C. Jackson, I. Hickson. IETF. [PINGBACK] Pingback 1.0, S. Langridge, I. Hickson. [PNG] Portable Network Graphics (PNG) Specification, D. Duce. W3C. [POLYGLOT] (Non-normative) Polyglot Markup: HTML-Compatible XHTML Documents, E. Graff. W3C. [PORTERDUFF] Compositing Digital Images, T. Porter, T. Duff. In Computer graphics, volume 18, number 3, pp. 253-259. ACM Press, July 1984. [PPUTF8] (Non-normative) The Properties and Promises of UTF-8, M. Drst. University of Zrich. In Proceedings of the 11th International Unicode Conference. [PROGRESS] Progress Events, C. McCathieNevile. W3C. [PSL] Public Suffix List. Mozilla Foundation. [RFC1034] Domain Names - Concepts and Facilities, P. Mockapetris. IETF, November 1987. [RFC1345] Character Mnemonics and Character Sets, K. Simonsen. IETF. [RFC1468] Japanese Character Encoding for Internet Messages, J. Murai, M. Crispin, E. van der Poel. IETF. [RFC1554] ISO-2022-JP-2: Multilingual Extension of ISO-2022-JP, M. Ohta, K. Handa. IETF. [RFC1557] Korean Character Encoding for Internet Messages, U. Choi, K. Chon, H. Park. IETF.
783
[RFC1842] ASCII Printable Characters-Based Chinese Character Encoding for Internet Messages, Y. Wei, Y. Zhang, J. Li, J. Ding, Y. Jiang. IETF. [RFC1922] Chinese Character Encoding for Internet Messages, HF. Zhu, DY. Hu, ZG. Wang, TC. Kao, WCH. Chang, M. Crispin. IETF. [RFC2046] Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types, N. Freed, N. Borenstein. IETF. [RFC2119] Key words for use in RFCs to Indicate Requirement Levels, S. Bradner. IETF. [RFC2237] Japanese Character Encoding for Internet Messages, K. Tamaru. IETF. [RFC2313] PKCS #1: RSA Encryption, B. Kaliski. IETF. [RFC2318] The text/css Media Type, H. Lie, B. Bos, C. Lilley. IETF. [RFC2388] Returning Values from Forms: multipart/form-data, L. Masinter. IETF. [RFC2397] The "data" URL scheme, L. Masinter. IETF. [RFC2425] A MIME Content-Type for Directory Information, T. Howes, M. Smith, F. Dawson. IETF. [RFC2426] vCard MIME Directory Profile, F. Dawson, T. Howes. IETF. [RFC2445] Internet Calendaring and Scheduling Core Object Specification (iCalendar), F. Dawson, D. Stenerson. IETF. [RFC2483] URI Resolution Services Necessary for URN Resolution, M. Mealling, R. Daniel. IETF. [RFC2781] UTF-16, an encoding of ISO 10646, P. Hoffman, F. Yergeau. IETF. [RFC2646] The Text/Plain Format Parameter, R. Gellens. IETF. [RFC3023] XML Media Types, M. Murata, S. St. Laurent, D. Kohn. IETF. [RFC3279] Algorithms and Identifiers for the Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, W. Polk, R. Housley, L. Bassham. IETF. [RFC3490] Internationalizing Domain Names in Applications (IDNA), P. Faltstrom, P. Hoffman, A. Costello. IETF. [RFC3629] UTF-8, a transformation format of ISO 10646, F. Yergeau. IETF. [RFC3864] Registration Procedures for Message Header Fields, G. Klyne, M. Nottingham, J. Mogul. IETF. [RFC3986] Uniform Resource Identifier (URI): Generic Syntax, T. Berners-Lee, R. Fielding, L. Masinter. IETF. [RFC3987] Internationalized Resource Identifiers (IRIs), M. Drst, M. Suignard. IETF. [RFC4281] The Codecs Parameter for "Bucket" Media Types, R. Gellens, D. Singer, P. Frojdh. IETF. [RFC4329] (Non-normative) Scripting Media Types, B. Hhrmann. IETF. [RFC4648] The Base16, Base32, and Base64 Data Encodings, S. Josefsson. IETF.
784
[RFC4770] vCard Extensions for Instant Messaging (IM), C. Jennings, J. Reschke. IETF. [RFC5280] Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, D. Cooper, S. Santesson, S. Farrell, S. Boeyen, R. Housley, W. Polk. IETF. [RFC5322] Internet Message Format, P. Resnick. IETF. [RFC5724] URI Scheme for Global System for Mobile Communications (GSM) Short Message Service (SMS), E. Wilde, A. Vaha-Sipila. IETF. [SCSU] (Non-normative) UTR #6: A Standard Compression Scheme For Unicode, M. Wolf, K. Whistler, C. Wicksteed, M. Davis, A. Freytag, M. Scherer. Unicode Consortium. [SELECTORS] Selectors, T. elik, E. Etemad, D. Glazman, I. Hickson, P. Linss, J. Williams. W3C. [SHIFTJIS] JIS X0208: 7-bit and 8-bit double byte coded KANJI sets for information interchange. Japanese Industrial Standards Committee. [SRGB] IEC 61966-2-1: Multimedia systems and equipment Colour measurement and management Part 2-1: Colour management Default RGB colour space sRGB. IEC. [SVG] Scalable Vector Graphics (SVG) Tiny 1.2 Specification, O. Andersson, R. Berjon, E. Dahlstrm, A. Emmons, J. Ferraiolo, A. Grasso, V. Hardy, S. Hayman, D. Jackson, C. Lilley, C. McCormack, A. Neumann, C. Northway, A. Quint, N. Ramani, D. Schepers, A. Shellshear. W3C. [TIS620] UDC 681.3.04:003.62. Thai Industrial Standards Institute, Ministry of Industry, Royal Thai Government. ISBN 974-606-153-4. [UAAG] (Non-normative) Web Content Accessibility Guidelines (UAAG) 2.0, J. Allan, K. Ford, J. Richards, J. Spellman. W3C. [UNICODE] The Unicode Standard. Unicode Consortium. [UNIVCHARDET] (Non-normative) A composite approach to language/encoding detection, S. Li, K. Momoi. Netscape. In Proceedings of the 19th International Unicode Conference. [UTF7] UTF-7: A Mail-Safe Transformation Format of Unicode, D. Goldsmith, M. Davis. IETF. [UTF8DET] (Non-normative) Multilingual form encoding, M. Drst. W3C. [UTR36] (Non-normative) UTR #36: Unicode Security Considerations, M. Davis, M. Suignard. Unicode Consortium. [WCAG] (Non-normative) Web Content Accessibility Guidelines (WCAG) 2.0, B. Caldwell, M. Cooper, L. Reid, G. Vanderheiden. W3C. [WEBGL] WebGL Specification, C. Marrin. Khronos Group. [WEBIDL] Web IDL, C. McCormack. W3C. [WEBLINK] Web Linking, M. Nottingham. IETF. [WEBSOCKET] The WebSocket API, I. Hickson. W3C. [WEBSTORAGE] Web Storage, I. Hickson. W3C.
785
[WEBWORKERS] Web Workers, I. Hickson. W3C. [WHATWGWIKI] The WHATWG Wiki. WHATWG. [WIN1252] Windows 1252. Microsoft. [WIN1254] Windows 1254. Microsoft. [WIN31J] Windows Codepage 932. Microsoft. [WIN874] Windows 874. Microsoft. [WIN949] Windows Codepage 949. Microsoft. [X121] Recommendation X.121 International Numbering Plan for Public Data Networks, CCITT Blue Book, Fascicle VIII.3, pp. 317-332. [X690] Recommendation X.690 Information Technology ASN.1 Encoding Rules Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER), and Distinguished Encoding Rules (DER). International Telecommunication Union. [XHR] XMLHttpRequest, A. van Kesteren. W3C. [XML] Extensible Markup Language, T. Bray, J. Paoli, C. Sperberg-McQueen, E. Maler, F. Yergeau. W3C. [XMLBASE] XML Base, J. Marsh, R. Tobin. W3C. [XMLNS] Namespaces in XML, T. Bray, D. Hollander, A. Layman, R. Tobin. W3C. [XPATH10] XML Path Language (XPath) Version 1.0, J. Clark, S. DeRose. W3C. [XSLT10] XSL Transformations (XSLT) Version 1.0, J. Clark. W3C.
786
Acknowledgements
Thanks to Aankhen, Aaron Boodman, Aaron Leventhal, Adam Barth, Adam de Boor, Adam Hepton, Adam Roben, Addison Phillips, Adele Peterson, Adrian Bateman, Adrian Sutton, Agustn Fernndez, Ajai Tirumali, Akatsuki Kitamura, Alan Plum, Alastair Campbell, Alejandro G. Castro, Alex Bishop, Alex Nicolaou, Alex Rousskov, Alexander J. Vincent, Alexey Feldgendler, (Alexey Proskuryakov), Alexis Deveria, Allan Clements, Amos Jeffries, Anders Carlsson, Andreas, Andreas Kling, Andrei Popescu, Andr E. Veltstra, Andrew Clover, Andrew Gove, Andrew Grieve, Andrew Oakley, Andrew Sidwell, Andrew Smith, Andrew W. Hagen, Andrey V. Lukyanov, Andy Heydon, Andy Palay, Anne van Kesteren, Anthony Boyd, Anthony Bryan, Anthony Hickson, Anthony Ricaud, Antti Koivisto, Arne Thomassen, Aron Spohr, Arphen Lin, Aryeh Gregor, Asbjrn Ulsberg, Ashley Sheridan, Atsushi Takayama, Aurelien Levy, Ave Wrigley, Ben Boyle, Ben Godfrey, Ben Lerner, Ben Leslie, Ben Meadowcroft, Ben Millard, Benjamin Carl Wiley Sittler, Benjamin Hawkes-Lewis, Bert Bos, Bijan Parsia, Bil Corry, Bill Mason, Bill McCoy, Billy Wong, Bjartur Thorlacius, Bjrn Hhrmann, Blake Frantz, Boris Zbarsky, Brad Fults, Brad Neuberg, Brad Spencer, Brady Eidson, Brendan Eich, Brenton Simpson, Brett Wilson, Brett Zamir, Brian Campbell, Brian Korver, Brian Kuhn, Brian Ryner, Brian Smith, Brian Wilson, Bryan Sullivan, Bruce D'Arcus, Bruce Lawson, Bruce Miller, C. Williams, Cameron McCormack, Cao Yipeng, Carlos Gabriel Cardona, Carlos Perell Marn, Chao Cai, (Channy Yun), Charl van Niekerk, Charles Iliya Krempeaux, Charles McCathieNevile, Chris Apers, Chris Cressman, Chris Evans, Chris Morris, Chris Pearce, Christian Biesinger, Christian Johansen, Christian Schmidt, Christopher Aillon, Chriswa, Clark Buehler, Cole Robison, Colin Fine, Collin Jackson, Corprew Reed, Craig Cockburn, Csaba Gabor, Csaba Marton, Cynthia Shelly, Daniel Barclay, Daniel Bratell, Daniel Brooks, Daniel Brumbaugh Keeney, Daniel Cheng, Daniel Davis, Daniel Glazman, Daniel Peng, Daniel Schattenkirchner, Daniel Spng, Daniel Steinberg, Danny Sullivan, Darin Adler, Darin Fisher, Darxus, Dave Camp, Dave Hodder, Dave Lampton, Dave Singer, Dave Townsend, David Baron, David Bloom, David Bruant, David Carlisle, David E. Cleary, David Egan Evans, David Flanagan, David Gerard, David Hsther, David Hyatt, David I. Lehn, David John Burrowes, David Matja, David Remahl, David Smith, David Woolley, DeWitt Clinton, Dean Edridge, Dean Edwards, Debi Orton, Derek Featherstone, Devdatta, Dimitri Glazkov, Dimitry Golubovsky, Dirk Pranke, Divya Manian, Dmitry Titov, dolphinling, Dominique Hazal-Massieux, Don Brutzman, Doron Rosenberg, Doug Kramer, Doug Simpkinson, Drew Wilson, Edmund Lai, Eduard Pascual, Eduardo Vela, Edward O'Connor, Edward Welbourne, Edward Z. Yang, Eira Monstad, Eitan Adler, Eliot Graff, Elizabeth Castro, Elliott Sprehn, Elliotte Harold, Eric Carlson, Eric Law, Eric Rescorla, Eric Semling, Erik Arvidsson, Erik Rose, Evan Martin, Evan Prodromou, Evert, fantasai, Felix Sasaki, Francesco Schwarz, Francis Brosnan Blazquez, Franck 'Shift' Qulain, Frank Barchard, (Fumitoshi Ukai), Futomi Hatano, Gavin Carothers, Gareth Rees, Garrett Smith, Geoffrey Garen, Geoffrey Sneddon, George Lund, Gianmarco Armellin, Giovanni Campagna, Glenn Adams, Graham Klyne, Greg Botten, Greg Houston, Greg Wilkins, Gregg Tavares, Gregory J. Rosmaita, Grey, Guilherme Johansson Tramontina, Gytis Jakutonis, Hkon Wium Lie, Hallvord Reiar Michaelsen Steen, Hans S. Tmmerhalt, Hans Stimer, Henri Sivonen, Henrik Lied, Henry Mason, Hugh Winkler, Ian Bicking, Ian Davis, Ignacio Javier, Ivan Enderlin, Ivo Emanuel Gonalves, J. King, Jacques Distler, James Craig, James Graham, James Justin Harrell, James M Snell, James Perrett, James Robinson, Jamie Lokier, Jan-Klaas Kollhof, Jason Kersey, Jason Lustig, Jason White, Jasper Bryant-Greene, Jatinder Mann, Jed Hartman, Jeff Balogh, Jeff Cutsinger, Jeff Schiller, Jeff Walden, Jeffrey Zeldman, (Jennifer Braithwaite), Jens Bannmann, Jens Fendler, Jens Lindstrm, Jens Meiert, Jeremy Keith, Jeremy Orlow, Jeroen van der Meer, Jian Li, Jim Jewett, Jim Ley, Jim Meehan, Jjgod Jiang, Joo Eiras, Joe Clark, Joe Gregorio, Joel Spolsky, Johan Herland, John Boyer, John Bussjaeger, John Carpenter, John Fallows, John Foliot, John Harding, John Keiser, John Snyders, John-Mark Bell, Johnny Stenback, Jon Ferraiolo, Jon Gibbins, Jon Perlow, Jonas Sicking, Jonathan Cook, Jonathan Rees, Jonathan Worent, Jonny Axelsson, Jorgen Horstink, Jorunn Danielsen Newth, Joseph Kesselman, Joseph Pecoraro, Josh Aas, Josh Levenberg, Joshua Randall, Jukka K. Korpela, Jules Clment-Ripoche, Julian Reschke, Jrgen Jeka, Justin Lebar, Justin Schuh, Justin Sinclair, Kai Hendry, Kartikaya Gupta, Kathy Walton, Kelly Norton, Kevin Benson, Kornl Pl, Kornel Lesinski, Kristof Zelechovski, Krzysztof Maczyski, (Kurosawa Takeshi), Kyle Hofmann, Lonard Bouchet, Lachlan Hunt, Larry Masinter, Larry Page, Lars Gunther, Lars Solberg, Laura Carlson, Laura Granka, Laura L. Carlson, Laura Wisewell, Laurens Holst, Lee Kowalkowski, Leif Halvard Silli, Lenny Domnitser, Leons Petrazickis, Lobotom Dysmon, Logan, Loune, Luke Kenneth Casson Leighton, Maciej Stachowiak, Magnus Kristiansen, Maik Merten, Malcolm Rowe, Mark Birbeck, Mark Miller, Mark Nottingham, Mark Pilgrim, Mark Rowe, Mark Schenk, Mark Wilton-Jones, Martijn Wargers, Martin Atkins, Martin Drst, Martin Honnen, Martin Janecke, Martin Kutschker, Martin Nilsson, Martin Thomson, Masataka Yakura, Mathieu Henri, Matias Larsson, Matt Schmidt, Matt Wright, Matthew Gregan, Matthew Mastracci, Matthew Raymond, Matthew Thomas, Mattias Waldau, Max Romantschuk, Menno van Slooten, Micah Dubinko, Michael 'Ratt' Iannarelli, Michael A. Nachbaur, Michael A. Puls II, Michael Carter, Michael Daskalov, Michael Enright, Michael Gratton, Michael Nordman, Michael Powers, Michael Rakowski, Michael(tm) Smith, Michal Zalewski, Michel Fortin, Michelangelo De Simone, Michiel van der Blonk, Mihai ucan, Mihai Parparita, Mike Brown, Mike Dierken, Mike Dixon, Mike Schinkel, Mike Shaver, Mikko Rantalainen, Mohamed Zergaoui, Mounir Lamouri, Ms2ger, NARUSE Yui, Neil Deakin, Neil Rashbrook, Neil Soiffer, Nicholas Shanks, Nicholas Stimpson, Nicholas Zakas, Nickolay Ponomarev, Nicolas Gallagher, Noah Mendelsohn, Noah Slater, NoozNooz42, Ojan Vafai, Olaf Hoffmann, Olav Junker Kjr, Oldich Vetenk, Oli Studholme, Oliver Hunt, Oliver Rigby, Olivier Gendrin, Olli Pettay, oSand, Patrick H. Lauke, Paul Norman, Per-Erik Brodin, Perry Smith, Peter Beverloo, Peter Karlsson, Peter Kasting, Peter Stark, Peter-Paul Koch, Phil Pickering, Philip Jgenstedt, Philip Taylor, Philip TAYLOR, Prateek Rungta, Pravir Gupta, Rachid Finge, Rajas Moonka, Ralf Stoltze, Ralph Giles, Raphael Champeimont, Remco, Remy Sharp, Rene Saarsoo, Rene Stach, Ric Hardacre, Rich Doughty, Richard Ishida, Rigo Wenning, Rikkert Koppes, Rimantas Liubertas, Riona Macnamara, Rob Ennals, Rob Jellinghaus, Robert Blaut, Robert Collins, Robert O'Callahan, Robert Sayre, Robin Berjon, Rodger Combs, Roland Steiner, Roman Ivanov, Roy Fielding, Ruud Steltenpool, Ryan King, Ryosuke Niwa, S. Mike Dierken, Salvatore Loreto, Sam Dutton, Sam Kuper, Sam Ruby, Sam Weinig, Sander van Lambalgen, Sarven Capadisli, Scott Gonzlez, Scott Hess, Sean Fraser, Sean Hayes, Sean Hogan, Sean Knapp,
787
Sebastian Markbge, Sebastian Schnitzenbaumer, Seth Call, Shanti Rao, Shaun Inman, Shiki Okasaka, Sierk Bornemann, Sigbjrn Vik, Silvia Pfeiffer, Simon Montagu, Simon Pieters, Simon Spiegel, skeww, Stanton McCandlish, Stefan Haustein, Stefan Santesson, Steffen Meschkat, Stephen Ma, Steve Faulkner, Steve Runyon, Steven Bennett, Steven Garrity, Steven Tate, Stewart Brodie, Stuart Ballard, Stuart Parmenter, Subramanian Peruvemba, Sunava Dutta, Susan Borgrink, Susan Lesch, Sylvain Pasche, T. J. Crowder, Tab Atkins, Tantek elik, (TAMURA Kent), Ted Mielczarek, Terrence Wood, Thomas Broyer, Thomas Koetter, Thomas O'Connor, Tim Altman, Tim Johansson, Toby Inkster, Todd Moody, Tom Baker, Tom Pike, Tommy Thorsen, Travis Leithead, Tyler Close, Vladimir Katardjiev, Vladimir Vukievi, voracity, Wakaba, Wayne Carr, Wayne Pollock, Wellington Fernando de Macedo, Weston Ruter, Will Levine, William Swanson, Wladimir Palant, Wojciech Mach, Wolfram Kriesing, Yang Chen, Ye-Kui Wang, Yehuda Katz, Yi-An Huang, Yngve Nysaeter Pettersen, Yuzo Fujishima, Zhenbin Xu, Zoltan Herczeg, and istein E. Andersen, for their useful comments, both large and small, that have led to changes to this specification over the years. Thanks also to everyone who has ever posted about HTML to their blogs, public mailing lists, or forums, including all the contributors to the various W3C HTML WG lists and the various WHATWG lists. Special thanks to Richard Williamson for creating the first implementation of canvas p286 in Safari, from which the canvas feature was designed. Special thanks also to the Microsoft employees who first implemented the event-based drag-and-drop mechanism, contenteditable p577 , and other features first widely deployed by the Windows Internet Explorer browser. Thanks to the participants of the microdata usability study for allowing us to use their mistakes as a guide for designing the microdata feature. Thanks to the SubRip community, including in particular Zuggy and ai4spam, for their work on the SubRip software program whose SRT file format was used as the basis for the WebVTT text track file format. Special thanks and $10,000 to David Hyatt who came up with a broken implementation of the adoption agency algorithm p669 that the editor had to reverse engineer and fix before using it in the parsing section. Thanks to the many sources that provided inspiration for the examples used in the specification. Thanks also to the Microsoft blogging community for some ideas, to the attendees of the W3C Workshop on Web Applications and Compound Documents for inspiration, to the #mrt crew, the #mrt.no crew, and the #whatwg crew, and to Pillar and Hedral for their ideas and support.
788