You can take part in this work. Join the working group's discussion list.
Web designers! We have a FAQ , a forum , and a help mailing list for you!
© Copyright 2004-2008 Apple Computer, Inc., Mozilla Foundation, and Opera Software ASA.
You are granted a license to use, reproduce and create derivative works of this document.
This specification evolves HTML and its related APIs to ease the authoring of Web-based applications. Additions include the context menus, a direct-mode graphics canvas, inline popup windows, and server-sent events. Heavy emphasis is placed on keeping the language backwards compatible with existing legacy user agents and on keeping user agents backwards compatible with existing legacy documents.
This is a work in progress! This document is changing on a daily if not hourly basis in response to comments and as a general part of its development process. Comments are very welcome, please send them to whattf@whattf.org . Thank you.
The current focus is in responding to the outstanding feedback . (There is a chart showing current progress.)
Implementors should be aware that this specification is not stable. Implementors who are not taking part in the discussions are likely to find the specification changing out from under them in incompatible ways. Vendors interested in implementing this specification before it eventually reaches the call for implementations should join the WHATTF mailing list and take part in the discussions.
This specification is also being produced by the W3C HTML WG . The two specifications are identical from the table of contents onwards.
This specification is intended to replace (be the new version of) what was previously the HTML4, XHTML 1.x, and DOM2 HTML specifications.
Different parts of this specification are at different levels of maturity.
Some of the more major known issues are marked
like this. There are many other issues that have been raised as
well; the issues given in this document are not the only known
issues! There are also some spec-wide issues that have not yet been
addressed: case-sensitivity is a very poorly handled topic right
now, and the firing of events needs to be unified (right now some
bubble, some don't, they all use different text to fire events,
etc). It would also be nice to unify the rules on downloading
content when attributes change (e.g. src
attributes) - should they initiate downloads when the element
immediately, is inserted in the document, when active scripts end,
etc. This matters e.g. if an attribute is set twice in a row (does
it hit the network twice).
a elementq elementcite elementem elementstrong elementsmall elementmark elementdfn elementabbr elementtime elementprogress elementmeter elementcode elementvar elementsamp elementkbd elementsub and sup elementsspan elementi elementb elementbdo elementruby elementrt elementrp elementfigure elementimg elementiframe elementembed elementobject elementparam elementvideo element
audio element
source elementcanvas element
canvas elementsmap elementarea elementtable elementcaption elementcolgroup elementcol elementtbody elementthead elementtfoot elementtr elementtd elementth elementtd and th
elementsform elementfieldset elementinput elementbutton elementlabel elementselect elementdatalist elementoptgroup elementoption elementtextarea elementoutput elementdetails elementdatagrid element
datagrid data modeldatagrid elementdatagridcommand elementmenu element
alternate "archives "author "bookmark "external "feed "help "icon "license "nofollow "noreferrer "pingback "prefetch "search "stylesheet "sidebar "tag "irrelevant attributecontenteditable
attribute
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 has 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.
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 does not include documenting
every HTML or DOM feature supported by Web browsers. Browsers
support many features that are considered to be very bad for
accessibility or that are otherwise inappropriate. For example, the
blink element is clearly presentational and authors
wishing to cause text to blink should instead use CSS.
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.
For sophisticated cross-platform applications, there already exist several proprietary solutions (such as Mozilla's XUL, Adobe's Flash, or Microsoft's Silverlight). These solutions are evolving faster than any standards process could follow, and the requirements are evolving even faster. These systems are also significantly more complicated to specify, and are orders of magnitude more difficult to achieve interoperability with, than the solutions described in this document. Platform-specific solutions for such sophisticated applications (for example the MacOS X Core APIs) are even further ahead.
This section is non-normative.
This specification represents a new version of HTML4, along with a new version of the associated DOM2 HTML API. Migration from HTML4 to the format and APIs described in this specification should in most cases be straightforward, as care has been taken to ensure that backwards-compatibility is retained. [HTML4] [DOM2HTML]
This section is non-normative.
This specification is intended to replace XHTML 1.0 as the normative definition of the XML serialization of the HTML vocabulary. [XHTML10]
While this specification updates the semantics and requirements of the vocabulary defined by XHTML Modularization 1.1 and used by XHTML 1.1, it does not attempt to provide a replacement for the modularization scheme defined and used by those (and other) specifications, and therefore cannot be considered a complete replacement for them. [XHTMLMOD] [XHTML11]
Thus, authors and implementors who do not need such a modularization scheme can consider this specification a replacement for XHTML 1.x, but those who do need such a mechanism are encouraged to continue using the XHTML 1.1 line of specifications.
This section is non-normative.
XHTML2 [XHTML2] defines a new HTML vocabulary with better features for hyperlinks, multimedia content, annotating document edits, rich metadata, declarative interactive forms, and describing the semantics of human literary works such as poems and scientific papers.
However, it lacks elements to express the semantics of many of the non-document types of content often seen on the Web. For instance, forum sites, auction sites, search engines, online shops, and the like, do not fit the document metaphor well, and are not covered by XHTML2.
This specification aims to extend HTML so that it is also suitable in these contexts.
XHTML2 and this specification use different namespaces and therefore can both be implemented in the same XML processor.
This section is non-normative.
This specification will eventually supplant Web Forms 2.0. The current Web Forms 2.0 draft can be considered part of this specification for the time being; its features will eventually be merged into this specification. [WF2]
As it stands today, this specification is unrelated and orthognoal to XForms. When the forms features defined in HTML4 and Web Forms 2.0 are merged into this specification, then the relationship to XForms described in the Web Forms 2.0 draft will apply to this specification. [XForms]
This section is non-normative.
This specification is independent of the various proprietary UI languages that various vendors provide. As an open, vendor-neutral language, HTML provides for a solution to the same problems without the risk of vendor lock-in.
This section is non-normative.
This specification defines an abstract language for describing documents and applications, and some APIs for interacting with in-memory representations of resources that use this language.
The in-memory representation is known as "DOM5 HTML", or "the DOM" for short.
There are various concrete syntaxes that can be used to transmit resources that use this abstract language, two of which are defined in this specification.
The first such concrete syntax is "HTML5". This is the format
recommended for most authors. It is compatible with all legacy Web
browsers. If a document is transmitted with the MIME type
text/html , then it will be processed as an
"HTML5" document by Web browsers.
The second concrete syntax uses XML, and is known as "XHTML5".
When a document is transmitted with an XML MIME type, such as
application/xhtml+xml , then it is processed
by an XML processor by Web browsers, and treated as an "XHTML5"
document. Authors are reminded that the processing for XML and HTML
differs; in particular, even minor syntax errors will prevent an
XML document from being rendered fully, whereas they would be
ignored in the "HTML5" syntax.
The "DOM5 HTML", "HTML5", and "XHTML5" representations cannot
all represent the same content. For example, namespaces cannot be
represented using "HTML5", but they are supported in "DOM5 HTML"
and "XHTML5". Similarly, documents that use the noscript feature can be represented using
"HTML5", but cannot be represented with "XHTML5" and "DOM5 HTML".
Comments that contain the string " --> "
can be represented in "DOM5 HTML" but not in "HTML5" and "XHTML5".
And so forth.
This section is non-normative.
This specification is divided into the following major sections:
There are also a couple of appendices, defining rendering rules for Web browsers and listing areas that are out of scope for this specification.
This specification should be read like all other specifications. First, it should be read cover-to-cover, multiple times. Then, it should be read backwards at least once. Then it should be read by picking random sections from the contents list and following all the cross-references.
All diagrams, examples, and notes in this specification are non-normative, as are all sections explicitly marked non-normative. Everything else in this specification is normative.
The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this document are to be interpreted as described in RFC2119. For readability, these words do not appear in all uppercase letters in this specification. [RFC2119]
Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.
This specification describes the conformance criteria for user agents (relevant to implementors) and documents (relevant to authors and authoring tool implementors).
There is no implied relationship between document conformance requirements and implementation conformance requirements. User agents are not free to handle non-conformant documents as they please; the processing model described in this specification applies to implementations regardless of the conformity of the input documents.
User agents fall into several (overlapping) categories with different conformance requirements.
Web browsers that support XHTML must process elements and attributes from the HTML namespace found in XML documents as described in this specification, so that users can interact with them, unless the semantics of those elements have been overridden by other specifications.
A conforming XHTML processor would, upon finding
an XHTML script element in an
XML document, execute the script contained in that element.
However, if the element is found within an XSLT transformation
sheet (assuming the UA also supports XSLT), then the processor
would instead treat the script
element as an opaque element that forms part of the transform.
Web browsers that support HTML must process documents labeled as
text/html as described in this specification, so that
users can interact with them.
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.
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 .
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.
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.
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 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 element is not a
quote, conformance checkers running without the input of human
judgement do not have to check that blockquote elements only contain quoted
material).
Conformance checkers must check that the input document conforms when parsed without a browsing context (meaning that no scripts are run, and that the parser's scripting flag is disabled), and should also check that the input document conforms when parsed with a browsing context 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. [HALTINGPROBLEM] )
The term "HTML5 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:
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.
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 to the semantics of the documents that they process.
A tool that generates document outlines 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 must generate conforming documents. 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.
For example, it is not conforming to use an
address 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.
In terms of conformance checking, an editor is therefore required 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 , b , i , and
span and making liberal use of the
style
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. The former category of requirements are requirements on documents and authoring tools. The second category are requirements on user agents.
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.
For compatibility with existing content and prior specifications, this specification describes two authoring formats: one based on XML (referred to as XHTML5 ), and one using a custom format inspired by SGML (referred to as HTML5 ). Implementations may support only one of these two formats, although supporting both is encouraged.
Such XML documents may contain a DOCTYPE if
desired, but this is not required to conform to this
specification.
According to the XML specification, XML processors
are not guaranteed to process the external DTD subset referenced in
the DOCTYPE. This means, for example, that using entity references
for characters in XHTML documents is unsafe (except for
< , > ,
& , "
and ' ).
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.
This specification relies on several other underlying specifications.
Implementations that support XHTML5 must support some version of XML, as well as its corresponding namespaces specification, because XHTML5 uses an XML serialization with namespaces. [XML] [XMLNAMES]
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. [DOM3CORE]
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. [DOM3CORE] [DOM3EVENTS]
Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification, as this specification uses that specification's terminology. [WebIDL]
Implementations must support some version of the Media Queries language. [MQ]
This specification does not require support of any particular network transport protocols, style sheet language, scripting language, or any of the DOM and WebAPI specifications beyond those described above. However, the language described by this specification is biased towards CSS as the styling language, ECMAScript as the scripting language, and HTTP as the network protocol, and several features assume that those languages and protocols are in use.
This specification might have certain additional requirements on character encodings, image formats, audio formats, and video formats in the respective sections.
this section will be removed at some point
Some elements are defined in terms of their DOM textContent attribute. This is an
attribute defined on the Node interface in DOM3 Core.
[DOM3CORE]
Should textContent be defined differently for dir="" and <bdo> ? Should we come up with an alternative to textContent that handles those and other things, like alt=""?
The interface DOMTimeStamp is defined in DOM3
Core. [DOM3CORE]
The term activation behavior is used as defined in the DOM3 Events specification. [DOM3EVENTS] At the time of writing, DOM3 Events hadn't yet been updated to define that phrase.
The rules for handling alternative style sheets are defined in the CSS object model specification. [CSSOM]
This section will eventually be removed in favour of WebIDL.
A lot of arrays/lists/ collection s in this spec assume zero-based indexes but use the term " index th" liberally. We should define those to be zero-based and be clearer about this.
Unless otherwise specified, if a DOM attribute that is a
floating point number type ( float ) is
assigned an Infinity or Not-a-Number value, a NOT_SUPPORTED_ERR exception must be raised.
Unless otherwise specified, if a method with an argument that is
a floating point number type ( float ) is
passed an Infinity or Not-a-Number value, a NOT_SUPPORTED_ERR exception must be raised.
Unless otherwise specified, if a method is passed fewer
arguments than is defined for that method in its IDL definition, a
NOT_SUPPORTED_ERR exception must be
raised.
Unless otherwise specified, if a method is passed more arguments than is defined for that method in its IDL definition, the excess arguments must be ignored.
This specification refers to both HTML and XML attributes and DOM 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 DOM attributes for those from the DOM. Similarly, the term "properties" is used for both ECMAScript object properties and CSS properties. When these are ambiguous they are qualified as object properties and CSS properties respectively.
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 " elements in the HTML namespace ", or " HTML elements " for short, when used in this
specification, thus refers to both HTML and XHTML elements.
Unless 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 (they are in the per-element partition).
When an XML name, such as an attribute or element name, is
referred to in the form prefix :
localName , as in xml:id or
svg:rect , it refers to a name with the local name
localName and the namespace given by the
prefix, as defined by the following table:
xmlhttp://www.w3.org/XML/1998/namespacehtmlhttp://www.w3.org/1999/xhtmlsvghttp://www.w3.org/2000/svgAttribute names are said to be XML-compatible if they match the Name production defined in XML, they contain no
U+003A COLON (:) characters, and they do not start with three
characters " xml ". [XML]
The term HTML documents is sometimes used in contrast with XML documents to specifically mean documents that were parsed using an HTML parser (as opposed to using an XML parser or created purely through the DOM).
Generally, when the specification states that a feature applies to HTML or XHTML, 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.
The term root element , when not explicitly qualified as referring to the document's root element, means the furthest ancestor element node of whatever node is being discussed, or the node itself if it has no ancestors. When the node is a part of the document, then that is indeed the document's root element; however, if the node is not currently part of the document tree, the root element will be an orphaned node.
An element is said to have been inserted into a document when its root element changes and is now the document's root element .
The term tree order means a
pre-order, depth-first traversal of DOM nodes involved (through the
parentNode / childNodes
relationship).
When it is stated that some element or attribute is ignored , or treated as some other value, or handled as if it was something else, this refers only to the processing of the node after it is in the DOM. A user agent must not mutate the DOM in such situations.
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.
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 ".
A DOM 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 that means that any attributes returning that object must always return the same object (not a new object each time), and 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. [DOM3EVENTS]
The term text node refers to any
Text node, including CDATASection nodes;
specifically, any Node with node type TEXT_NODE (3) or CDATA_SECTION_NODE
(4). [DOM3CORE]
The term plugin is used to mean any content handler, typically a third-party content handler, for Web content types that are not supported by the user agent natively, or for content types that do not expose a DOM, that supports rendering the content as part of the user agent's interface.
One example of a plugin would be a PDF viewer that is instantiated in a browsing context 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.
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. [NPAPI]
Browsers should take extreme care when interacting with external content intended for plugins . 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.
Some of the algorithms in this specification, for historical reasons, require the user agent to pause until some condition has been met. While a user agent is paused, it must ensure that no scripts execute (e.g. no event handlers, no timers, etc). User agents should remain responsive to user input while paused, however, albeit without letting the user interact with Web pages where that would involve invoking any script.
This specification defines the term URL , and defines various algorithms for dealing with URLs, because for historical reasons the rules defined by the URI and IRI specifications are not a complete description of what HTML user agents need to implement to be compatible with Web content.
A URL is a string used to identify a
resource. A URL is always
associated with a Document , either explicitly when
the URL is created or defined; or through a DOM node, in which case
the associated Document is the node's
Document ; or through a script, in which case the
associated Document is the script's script document context .
A URL is a valid URL if at least one of the following conditions holds:
The URL is a valid IRI reference and it has no query component. [RFC3987]
The URL is a valid IRI reference and its query component contains no unescaped non-ASCII characters. [RFC3987]
The URL is a valid IRI reference and the
character encoding of the URL's
Document is UTF-8 or UTF-16. [RFC3987]
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.
To parse a URL url into its component parts, the user agent must use the following steps:
Strip leading and trailing space characters from url .
Parse url in the manner defined by RFC 3986, with the following exceptions:
If url doesn't match the <URI-reference> production, even after the above changes are made to the ABNF definitions, then parsing the URL fails with an error. [RFC3986]
Otherwise, parsing url was successful; the components of the URL are substrings of url defined as follows:
The substring matched by the <scheme> production, if any.
The substring matched by the <host> production, if any.
The substring matched by the <port> production, if any.
If there is a <scheme> component and a <port> component and the port given by the <port> component is different than the default port defined for the protocol given by the <scheme> component, then <hostport> is the substring that starts with the substring matched by the <host> production and ends with the substring matched by the <port> production, and includes the colon in between the two. Otherwise, it is the same as the <host> component.
The substring matched by one of the following productions, if one of them was matched:
The substring matched by the <query> production, if any.
The substring matched by the <fragment> production, if any.
Relative URLs are resolved relative to a base URL. The base URL of a URL is the absolute URL obtained as follows:
The base URL is the document base URL of the script's script document context .
The base URL is the base URI of the element that the
attribute is on, as defined by the XML Base specification, with
the base URI of the document entity being defined as the
document base URL of the
Document that owns the element.
For the purposes of the XML Base specification, user agents must
act as if all Document objects represented XML
documents.
It is possible for xml:base 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 attributes are not allowed in
HTML documents .)
The base URL is the URL of the application cache manifest .
The document base URL of a
Document is the absolute URL
obtained by running these steps:
If there is no base element
that is both a child of the head
element and has an href attribute, then the document base URL is the document's
address .
Otherwise, let url be the value of the
href
attribute of the first such element.
Resolve the
url URL, using the document's
address as the base URL (thus, the
base href attribute isn't
affect by xml:base attributes).
The document base URL is the result of the previous step if it was successful; otherwise it is the document's address .
To resolve a URL to an absolute URL the user agent must use the following steps. Resolving a URL can result in an error, in which case the URL is not resolvable.
Let url be the URL being resolved.
Let document be the Document
associated with url .
Let encoding be the character encoding of document .
If encoding is UTF-16, then change it to UTF-8.
Let base be the base URL for url . (This is an absolute URL .)
Parse url into its component parts.
If parsing url resulted in a <host> component, then replace the matching subtring of url with the string that results from expanding any sequences of percent-encoded octets in that component that are valid UTF-8 sequences into Unicode characters as defined by UTF-8.
If any percent-encoded octets in that component are not valid UTF-8 sequences, then return an error and abort these steps.
Apply the IDNA ToASCII algorithm to the matching substring, with both the AllowUnassigned and UseSTD3ASCIIRules flags set. Replace the matching substring with 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 an error and abort these steps. [RFC3490]
If parsing url resulted in a <path> component, then replace the matching substring of url with the string that results from applying the following steps to each character other than U+0025 PERCENT SIGN (%) that doesn't match the original <path> production defined in RFC 3986:
For instance if url was " //example.com/a^b☺c%FFd%z/?e ", then the <path> component's substring
would be " /a^b☺c%FFd%z/ " and the two
characters that would have to be escaped would be " ^ " and " ☺ ". The result after
this step was applied would therefore be that url now had the value " //example.com/a%5Eb%E2%98%BAc%FFd%z/?e ".
If parsing url resulted in a <query> component, then replace the matching substring of url with the string that results from applying the following steps to each character other than U+0025 PERCENT SIGN (%) that doesn't match the original <query> production defined in RFC 3986:
Apply the algorithm described in RFC 3986 section 5.2 Relative Resolution, using url as the potentially relative URI reference ( R ), and base as the base URI ( Base ). [RFC3986]
Apply any relevant conformance criteria of RFC 3986 and RFC 3987, returning an error and aborting these steps if appropriate. [RFC3986] [RFC3987]
For instance, if an absolute URI that would be
returned by the above algorithm violates the restrictions specific
to its scheme, e.g. a data: URI using the "
// " server-based naming authority syntax,
then user agents are to treat this as an error instead.
Let result be the target URI ( T ) returned by the Relative Resolution algorithm.
If result uses a scheme with a server-based naming authority, replace all U+005C REVERSE SOLIDUS (\) characters in result with U+002F SOLIDUS (/) characters.
Return result .
A URL is an absolute URL if resolving it results in the same URL without an error.
When an xml:base attribute changes, the attribute's
element, and all descendant elements, are affected by a base URL change .
When a document's document base URL changes, all elements in that document are affected by a base URL change .
When an element is moved from one document to another, if the two documents have different base URLs , then that element and all its descendants are affected by a base URL change .
When an element is affected by a base URL change , it must act as described in the following list:
If the absolute URL 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 attribute
should be reresolved
and the UI updated appropriately.
For example, the CSS :link
/ :visited pseudo-classes might have been
affected.
If the hyperlink has a ping attribute and
its absolute URL(s)
are being shown to the user, then the ping attribute's
tokens should be reresolved and the UI updated
appropriately.
blockquote , q , ins , or
del element with a cite attributeIf the absolute URL 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 it should be reresolved and the UI updated
appropriately.
The element is not directly affected.
Changing the base URL doesn't affect the image
displayed by img elements, although
subsequent accesses of the src DOM attribute from script will return a new
absolute URL that might no longer
correspond to the image being shown.
An interface that has a complement of URL decomposition attributes will have seven attributes with the following definitions:
attribute DOMString protocol;
attribute DOMString host;
attribute DOMString hostname;
attribute DOMString port;
attribute DOMString pathname;
attribute DOMString search;
attribute DOMString hash;
The attributes defined to be URL decomposition attributes 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 attributes will define an input , which is a URL 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 attributes have similar requirements.
On getting, if the input 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 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 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 URL with the new value; otherwise, the user agent must let output be equal to the input . Finally, the user agent must invoke the common setter action 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.
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 defined in this specification.
| Attribute | Component | Getter Condition | Prefix | Suffix | Setter Preprocessor | Setter Condition |
|---|---|---|---|---|---|---|
protocol |
<scheme> | — | — | U+003A COLON (" : ") |
Remove all trailing U+003A COLON (" : ")
characters |
The new value is not the empty string |
host |
<hostport> | input is hierarchical and uses a server-based naming authority | — | — | — | — |
hostname |
<host> | input is hierarchical and uses a server-based naming authority | — | — | Remove all leading U+002F SOLIDUS (" / ")
characters |
— |
port |
<port> | input is hierarchical, uses a server-based naming authority, and contained a <port> component (possibly an empty one) | — | — | Remove any characters in the new value that are not in the range U+0030 DIGIT ZERO .. U+0039 DIGIT NINE. If the resulting string is empty, set it to a single U+0030 DIGIT ZERO character ('0'). | — |
pathname |
<path> | input is hierarchical | — | — | If it has no leading U+002F SOLIDUS (" /
") character, prepend a U+002F SOLIDUS (" /
") character to the new value |
— |
search |
<query> | input is hierarchical, and contained a <query> component (possibly an empty one) | U+003F QUESTION MARK (" ? ") |
— | Remove one leading U+003F QUESTION MARK (" ? ") character, if any |
— |
hash |
<fragment> | input contained a <fragment> component (possibly an empty one) | U+0023 NUMBER SIGN (" # ") |
— | Remove one leading U+0023 NUMBER SIGN (" # ") character, if any |
— |
The table below demonstrates how the getter condition for
search
results in different results depending on the exact original syntax
of the URL:
| Input URL | search value |
Explanation |
|---|---|---|
http://example.com/ |
empty string | No <query> component in input URL. |
http://example.com/? |
? |
There is a <query> component, but it is empty. The question mark in the resulting value is the prefix. |
http://example.com/?test |
?test |
The <query>
component has the value " test ". |
http://example.com/?test# |
?test |
The (empty) <fragment> component is not part of the <query> component. |
There are various places in HTML that accept particular data types, such as dates or numbers. This section describes what the conformance criteria for content in those formats is, and how to parse them.
Need to go through the whole spec and make sure all the attribute values are clearly defined either in terms of microsyntaxes or in terms of other specs, or as "Text" or some such.
The space characters , for the purposes of this specification, are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab), U+000A LINE FEED (LF), U+000C FORM FEED (FF), and U+000D CARRIAGE RETURN (CR).
Some of the micro-parsers described below follow the pattern of having an input variable that holds the string being parsed, and having a position variable pointing at the next character to parse in input .
For parsers based on this pattern, a step that requires the user agent to collect a sequence of characters means that the following algorithm must be run, with characters being the set of characters that can be collected:
Let input and position be the same variables as those of the same name in the algorithm that invoked these steps.
Let result be the empty string.
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 .
The step skip whitespace means that the user agent must collect a sequence of characters that are space characters . The step skip Zs characters means that the user agent must collect a sequence of characters that are in the Unicode character class Zs. In both cases, the collected characters are not used. [UNICODE]
A number of attributes in HTML5 are boolean attributes . The presence of a boolean attribute on an element represents the true value, and the absence of the attribute represents the false value.
If the attribute is present, its value must either be the empty string or a value that is a case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace.
A string is a valid non-negative integer if it consists of one of more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
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 either return zero, a positive integer, or an error. Leading spaces are ignored. Trailing spaces and indeed any trailing garbage characters are ignored.
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 0.
If position is past the end of input , return an error.
If the next character is not one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9), then return an error.
If the next character is one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9):
Return value .
A string is a valid integer if it consists of one of 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.
The rules for parsing integers are similar to the rules for non-negative integers, 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 either return an integer or an error. Leading spaces are ignored. Trailing spaces and trailing garbage characters are ignored.
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 0.
Let sign have the value "positive".
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:
If the next character is not one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9), then return an error.
If the next character is one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9):
If sign is "positive", return value , otherwise return 0- value .
A string is a valid floating point number if it consists of one of more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), optionally with a single U+002E FULL STOP (".") character somewhere (either before these numbers, in between two numbers, or after the numbers), all optionally prefixed with a U+002D HYPHEN-MINUS ("-") character.
The rules for parsing floating point number values are as given in the following algorithm. As with the previous algorithms, when this one is invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will either return a number or an error. Leading spaces are ignored. Trailing spaces and garbage characters are ignored.
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 0.
Let sign have the value "positive".
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:
If the next character is not one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9) or U+002E FULL STOP ("."), then return an error.
If the next character is U+002E FULL STOP ("."), but either that is the last character or the character after that one is not one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9), then return an error.
If the next character is one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9):
Otherwise, if the next character is not a U+002E FULL STOP ("."), then if sign is "positive", return value , otherwise return 0- value .
The next character is a U+002E FULL STOP ("."). Advance position to the character after that.
Let divisor be 1.
If the next character is one of U+0030 DIGIT ZERO (0) .. U+0039 DIGIT NINE (9):
Otherwise, if sign is "positive", return value , otherwise return 0- value .
The algorithms described in this section are used
by the progress and
meter elements.
A valid denominator punctuation character is one of the characters from the table below. There is a value associated with each denominator punctuation character , as shown in the table below.
| Denominator Punctuation Character | Value | |
|---|---|---|
| U+0025 PERCENT SIGN | % | 100 |
| U+066A ARABIC PERCENT SIGN | ٪ | 100 |
| U+FE6A SMALL PERCENT SIGN | ﹪ | 100 |
| U+FF05 FULLWIDTH PERCENT SIGN | % | 100 |
| U+2030 PER MILLE SIGN | ‰ | 1000 |
| U+2031 PER TEN THOUSAND SIGN | ‱ | 10000 |
The steps for finding one or two numbers of a ratio in a string are as follows:
The algorithm to find a number is as follows. It is given a string and a starting position, and returns either nothing, a number, or an error condition.
valid positive non-zero integers rules for parsing dimension values (only used by height/width on img, embed, object — lengths in css pixels or percentages)
A valid list of integers is a number of valid integers separated by U+002C COMMA characters, with no other characters (e.g. no space characters ). 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:
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 " - " 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:
Follow these substeps:
Follow these substeps:
Follow these substeps:
1,2,x,4 ".Follow these substeps:
Follow these substeps:
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.
In the algorithms below, the number of days in month month of year year is: 31 if month is 1, 3, 5, 7, 8, 10, or 12; 30 if month is 4, 6, 9, or 11; 29 if month is 2 and year is a number divisible by 400, or if year is a number divisible by 4 but not by 100; and 28 otherwise. This takes into account leap years in the Gregorian calendar. [GREGORIAN]
A string is a valid datetime if it has four digits (representing the year), a literal hyphen, two digits (representing the month), a literal hyphen, two digits (representing the day), optionally some spaces, either a literal T or a space, optionally some more spaces, two digits (for the hour), a colon, two digits (the minutes), optionally the seconds (which, if included, must consist of another colon, two digits (the integer part of the seconds), and optionally a decimal point followed by one or more digits (for the fractional part of the seconds)), optionally some spaces, and finally either a literal Z (indicating the time zone is UTC), or, a plus sign or a minus sign followed by two digits, a colon, and two digits (for the sign, the hours and minutes of the timezone offset respectively); with the month-day combination being a valid date in the given year according to the Gregorian calendar, the hour values ( h ) being in the range 0 ≤ h ≤ 23, the minute values ( m ) in the range 0 ≤ m ≤ 59, and the second value ( s ) being in the range 0 ≤ h < 60. [GREGORIAN]
The digits must be characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), the hyphens must be a U+002D HYPHEN-MINUS characters, the T must be a U+0054 LATIN CAPITAL LETTER T, the colons must be U+003A COLON characters, the decimal point must be a U+002E FULL STOP, the Z must be a U+005A LATIN CAPITAL LETTER Z, the plus sign must be a U+002B PLUS SIGN, and the minus U+002D (same as the hyphen).
The following are some examples of dates written as valid datetimes .
0037-12-13 00:00 Z "1979-10-14T12:00:00.001-04:00 "8592-01-01 T 02:09 +02:09 "Several things are notable about these dates:
Conformance checkers can use the algorithm below to determine if a datetime is a valid datetime or not.
To parse a string as a datetime value , a user agent must apply the following algorithm to the string. This will either return a time in UTC, with associated timezone information for round tripping or display purposes, or nothing, indicating the value is not a valid datetime . If at any point the algorithm says that it "fails", this means that it returns nothing.
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 in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is not exactly four characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the year .
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 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 .
Let maxday be the number of days in month month of year year .
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 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 ≤ month ≤ maxday , then fail.
Collect a sequence of characters that are either U+0054 LATIN CAPITAL LETTER T characters or space characters . If the collected sequence is zero characters long, or if it contains more than one U+0054 LATIN CAPITAL LETTER T character, then fail.
Collect a sequence of characters 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 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 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 .
Let second be a string with the value "0".
If position is beyond the end of input , then fail.
If the character at position is a U+003A COLON, then:
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 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.
Interpret second as a base-ten number (possibly with a fractional part). Let that number be second instead of the string version.
If position is beyond the end of input , then fail.
If the character at position is a U+005A LATIN CAPITAL LETTER Z, then:
Let timezone hours be 0.
Let timezone minutes 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:
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 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 timezone hours .
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 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 timezone minutes .
If position is not beyond the end of input , then fail.
Let time be the moment in time at year year , month month , day day , hours hour , minute minute , second second , subtracting timezone hours hours and timezone minutes minutes. That moment in time is a moment in the UTC timezone.
Let timezone be timezone hours hours and timezone minutes minutes from UTC.
Return time and timezone .
This section defines date or time strings . There are two kinds, date or time strings in content , and date or time strings in attributes . The only difference is in the handling of whitespace characters.
To parse a date or time string , user agents must use the following algorithm. A date or time string is a valid date or time string if the following algorithm, when run on the string, doesn't say the string is invalid.
The algorithm may return nothing (in which case the string will be invalid), or it may return a date, a time, a date and a time, or a date and a time and a timezone. Even if the algorithm returns one or more values, the string can still be invalid.
Let input be the string being parsed.
Let position be a pointer into input , initially pointing at the start of the string.
Let results be the collection of results that are to be returned (one or more of a date, a time, and a timezone), initially empty. If the algorithm aborts at any point, then whatever is currently in results must be returned as the result of the algorithm.
For the "in content" variant: skip Zs characters ; for the "in attributes" variant: skip whitespace .
Collect a sequence of characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is empty, then the string is invalid; abort these steps.
Let the sequence of characters collected in the last step be s .
If position is past the end of input , the string is invalid; abort these steps.
If the character at position is not a U+003A COLON character, then:
If the character at position is not a U+002D HYPHEN-MINUS ("-") character either, then the string is invalid, abort these steps.
If the sequence s is not exactly four digits long, then the string is invalid. (This does not stop the algorithm, however.)
Interpret the sequence of characters collected in step 5 as a base-ten integer, and let that number be year .
Advance position past the U+002D HYPHEN-MINUS ("-") character.
Collect a sequence of characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is empty, then the string is invalid; abort these steps.
If the sequence collected in the last step is not exactly two digits long, then the string is invalid.
Interpret the sequence of characters collected two steps ago as a base-ten integer, and let that number be month .
Let maxday be the number of days in month month of year year .
If position is past the end of input , or if the character at position is not a U+002D HYPHEN-MINUS ("-") character, then the string is invalid, abort these steps. Otherwise, advance position to the next character.
Collect a sequence of characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is empty, then the string is invalid; abort these steps.
If the sequence collected in the last step is not exactly two digits long, then the string is invalid.
Interpret the sequence of characters collected two steps ago as a base-ten integer, and let that number be day .
If day is not a number in the range 1 ≤ day ≤ maxday , then the string is invalid, abort these steps.
Add the date represented by year , month , and day to the results .
For the "in content" variant: skip Zs characters ; for the "in attributes" variant: skip whitespace .
If the character at position is a U+0054 LATIN CAPITAL LETTER T, then move position forwards one character.
For the "in content" variant: skip Zs characters ; for the "in attributes" variant: skip whitespace .
Collect a sequence of characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is empty, then the string is invalid; abort these steps.
Let s be the sequence of characters collected in the last step.
If s is not exactly two digits long, then the string is invalid.
Interpret the sequence of characters collected two steps ago as a base-ten integer, and let that number be hour .
If hour is not a number in the range 0 ≤ hour ≤ 23, then the string is invalid, abort these steps.
If position is past the end of input , or if the character at position is not a U+003A COLON character, then the string is invalid, abort these steps. Otherwise, advance position to the next character.
Collect a sequence of characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9). If the collected sequence is empty, then the string is invalid; abort these steps.
If the sequence collected in the last step is not exactly two digits long, then the string is invalid.
Interpret the sequence of characters collected two steps ago as a base-ten integer, and let that number be minute .
If minute is not a number in the range 0 ≤ minute ≤ 59, then the string is invalid, abort these steps.
Let second be 0. It might be changed to another value in the next step.
If position is not past the end of input and the character at position is a U+003A COLON character, then:
Collect a sequence of characters that are either characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) or are U+002E FULL STOP. If the collected sequence is empty, or contains more than one U+002E FULL STOP character, then the string is invalid; abort these steps.
If the first character in the sequence collected in the last step is not in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then the string is invalid.
Interpret the sequence of characters collected two steps ago as a base-ten number (possibly with a fractional part), and let that number be second .
If second is not a number in the range 0 ≤ minute < 60, then the string is invalid, abort these steps.
Add the time represented by hour , minute , and second to the results .
If results has both a date and a time, then:
For the "in content" variant: skip Zs characters ; for the "in attributes" variant: skip whitespace .
If position is past the end of input , then skip to the next step in the overall set of steps.
Otherwise, if the character at position is a U+005A LATIN CAPITAL LETTER Z, then:
Add the timezone corresponding to UTC (zero offset) to the results .
Advance position to the next character in input .
Skip to the next step in the overall set of steps.
Otherwise, if the character at position is either a U+002B PLUS SIGN ("+") or a U+002D HYPHEN-MINUS ("-"), then:
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 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 the string is invalid.
Interpret the sequence collected in the last step as a base-ten number, and let that number be timezone hours .
If position is beyond the end of input or if the character at position is not a U+003A COLON character, then the string is invalid; abort these steps. Otherwise, move position forwards one character.
Collect a sequence of characters 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 the string is invalid.
Interpret the sequence collected in the last step as a base-ten number, and let that number be timezone minutes .
Add the timezone corresponding to an offset of timezone hours hours and timezone minutes minutes to the results .
Skip to the next step in the overall set of steps.
Otherwise, the string is invalid; abort these steps.
For the "in content" variant: skip Zs characters ; for the "in attributes" variant: skip whitespace .
If position is not past the end of input , then the string is invalid.
Abort these steps (the string is parsed).
valid time offset , rules for parsing time offsets , time offset serialization rules ; in the format "5d4h3m2s1ms" or "3m 9.2s" or "00:00:00.00" or similar.
A set of space-separated tokens is a set of zero or more words separated by one or more space characters , where words consist of any string of one or more characters, none of which are space characters .
A string containing a set of space-separated tokens may have leading or trailing space characters .
An unordered set of unique space-separated tokens is a set of space-separated tokens where none of the words are duplicated.
An ordered set of unique space-separated tokens is a set of space-separated tokens where none of the words are duplicated but where the order of the tokens is meaningful.
Sets of space-separated tokens sometimes have a defined set of allowed values. When a set of allowed values is defined, the tokens must all be from that list of allowed values; other values are non-conforming. If no such set of allowed values is provided, then all values are conforming.
When a user agent has to split a string on spaces , it must use the following algorithm:
Let input be the string being parsed.
Let position be a pointer into input , initially pointing at the start of the string.
Let tokens be a list of tokens, initially empty.
While position is not past the end of input :
Collect a sequence of characters that are not space characters .
Add the string collected in the previous step to tokens .
Return tokens .
When a user agent has to remove a token from a string , it must use the following algorithm:
Let input be the string being modified.
Let token be the token being removed. It will not contain any space characters .
Let output be the output string, initially empty.
Let position be a pointer into input , initially pointing at the start of the string.
If position is beyond the end of input , set the string being modified to output , and abort these steps.
If the character at position is a space character :
Append the character at position to the end of output .
Increment position so it points at the next character in input .
Return to step 5 in the overall set of steps.
Otherwise, the character at position is the first character of a token. Collect a sequence of characters that are not space characters , and let that be s .
If s is exactly equal to token , then:
Skip whitespace (in input ).
Remove any space characters 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 .
Otherwise, append s to the end of output .
Return to step 6 in the overall set of steps.
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.
Some attributes are defined as taking one of a finite set of keywords. Such attributes are called enumerated attributes . The keywords are each defined to map to a particular state (several keywords might map to the same state, in which case some of the keywords are synonyms of each other; additionally, some of the keywords can be said to be non-conforming, and are only in the specification for historical reasons). In addition, two default states can be given. The first is the invalid value default , the second is the missing value default .
If an enumerated attribute is specified, the attribute's value must be one of the given keywords that are not said to be non-conforming, with no leading or trailing whitespace. The keyword may use any mix of uppercase and lowercase letters.
When the attribute is specified, if its value case-insensitively matches one of the given keywords then that keyword's state is the state that the attribute represents. If the attribute value matches none of the given keywords, but the attribute has an invalid value default , then the attribute represents that state. Otherwise, if the attribute value matches none of the keywords but there is a missing value default state defined, then that is the state represented by the attribute. Otherwise, there is no default, and invalid values must be ignored.
When the attribute is not specified, if there is a missing value default state defined, then that is the state represented by the (missing) attribute. Otherwise, the absence of the attribute means that there is no state represented.
The empty string can be one of the keywords in some
cases. For example the contenteditable attribute has two
states: true , matching the true
keyword and the empty string, false , matching
false and all other keywords (it's the
invalid value default ). It could further be thought of as
having a third state inherit , which would be the default
when the attribute is not specified at all (the missing value
default ), but for various reasons that isn't the way this
specification actually defines it.
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 in the document with type
type .
The rules for parsing a hash-name reference to an element of type type are as follows:
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 or
name attribute whose value case-insensitively
matches s .
Some DOM attributes are defined to reflect a particular content attribute . This means that on getting, the DOM attribute returns the current value of the content attribute, and on setting, the DOM attribute changes the value of the content attribute to the given value.
If a reflecting DOM attribute is a DOMString
attribute whose content attribute is defined to contain a URL , then on getting, the DOM attribute must resolve the value of the
content attribute and return the resulting absolute URL if that was successful, or the empty
string otherwise; and on setting, must set the content attribute to
the specified literal value. If the content attribute is absent,
the DOM attribute must return the default value, if the content
attribute has one, or else the empty string.
If a reflecting DOM attribute is a DOMString
attribute whose content attribute is defined to contain one or more
URLs , then on getting, the DOM
attribute must split the
content attribute on spaces and return the concatenation of
resolving each token
URL to an absolute URL , with a single
U+0020 SPACE character between each URL, ignoring any tokens that
did not resolve successfully. If the content attribute is absent,
the DOM attribute must return the default value, if the content
attribute has one, or else the empty string. On setting, the DOM
attribute must set the content attribute to the specified literal
value.
If a reflecting DOM attribute is a DOMString whose
content attribute is an enumerated
attribute , and the DOM attribute is limited
to only known values , then, on getting, the DOM attribute
must return the conforming value 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, if the new value case-insensitively matches one of the
keywords given for that attribute, then the content attribute must
be set to the conforming value associated with the state that the
attribute would be in if set to the given new value, otherwise, if
the new value is the empty string, then the content attribute must
be removed, otherwise, the setter must raise a
SYNTAX_ERR exception.
If a reflecting DOM 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 DOM attribute is a boolean attribute, then on getting the DOM attribute must return true if the attribute is set, and false if it is absent. On setting, the content attribute must be removed if the DOM attribute is set to false, and must be set to have the same value as its name if the DOM attribute is set to true. (This corresponds to the rules for boolean content attributes .)
If a reflecting DOM attribute is a signed integer type (
long ) then, on getting, the content attribute must be
parsed according to the rules for parsing signed
integers , and if that is successful, the resulting value must
be returned. If, on the other hand, it fails, 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 in base ten and then that
string must be used as the new content attribute value.
If a reflecting DOM attribute is an unsigned integer
type ( unsigned long ) then, on getting, the content
attribute must be parsed according to the rules for parsing
unsigned integers , 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 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 in base ten
and then that string must be used as the new content attribute
value.
If a reflecting DOM attribute is an unsigned integer type (
unsigned long ) that is limited to
only positive non-zero numbers , 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 unsigned integers , 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 1 if there is no default value. On setting, if the
value is zero, the user agent must fire an
INDEX_SIZE_ERR exception. Otherwise, the given value
must be converted to the shortest possible string representing the
number as a valid non-negative integer in
base ten and then that string must be used as the new content
attribute value.
If a reflecting DOM attribute is a floating point number type (
float ) and the content attribute is defined to
contain a time offset, then, on getting, the content attribute must
be parsed according to the rules for parsing time
offsets , and if that is successful, the resulting value, in
seconds, must be returned. If that fails, or if the attribute is
absent, the default value must be returned, or the not-a-number
value (NaN) if there is no default value. On setting, the given
value, interpreted as a time offset in seconds, must be converted
to a string using the time offset
serialization rules , and that string must be used as the new
content attribute value.
If a reflecting DOM attribute is a floating point number type (
float ) and it doesn't fall into one of the earlier
categories, then, on getting, the content attribute must be parsed
according to the rules for
parsing floating point number values , 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 shortest possible
string representing the number as a valid
floating point number in base ten and then that string must be
used as the new content attribute value.
If a reflecting DOM attribute is of the type DOMTokenList , then on getting it must
return a DOMTokenList
object whose underlying string is the element's corresponding
content attribute. When the DOMTokenList object mutates its
underlying string, the content attribute must itself be immediately
mutated. When the attribute is absent, then the string represented
by the DOMTokenList
object is the empty string; when the object mutates this empty
string, the user agent must first add the corresponding content
attribute, and then mutate that attribute instead. DOMTokenList attributes are always
read-only. The same DOMTokenList object must be returned
every time for each attribute.
If a reflecting DOM attribute has the type HTMLElement , or an interface that
descends from HTMLElement ,
then, on getting, it must run the following algorithm (stopping at
the first point where a value is returned):
document.getElementById() method would find
if it was passed as its argument the current value of the
corresponding content attribute.On setting, if the given element has an id attribute, then the content
attribute must be set to the value of that id attribute. Otherwise, the DOM
attribute must be set to the empty string.
The HTMLCollection ,
HTMLFormControlsCollection
, and HTMLOptionsCollection
interfaces represent various lists of DOM nodes. Collectively,
objects implementing these interfaces are called collections .
When a collection is created, a filter and a root are associated with the collection.
For example, when the HTMLCollection object for the
document.images attribute is created, it is
associated with a filter that selects only img elements, and rooted at the root of the
document.
The collection then represents a live 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 .
The rows list is not in tree order.
An attribute that returns a collection must return the same object every time it is retrieved.
The HTMLCollection
interface represents a generic collection of elements.
interface HTMLCollection {
readonly attribute unsigned long length;
[IndexGetter] Element item(in unsigned long index);
[NameGetter] Element namedItem(in DOMString name);
};
The length attribute
must return the number of nodes represented
by the collection .
The item( index
) method must return the index th
node in the collection. If there is no index th
node in the collection, then the method must return null.
The namedItem( key ) method must return the first node in
the collection that matches the following requirements:
a , applet , area
, form , img , or
object element with a
name attribute equal to key , or,id attribute equal to key .
(Non-HTML elements, even if they have IDs, are not searched for the
purposes of namedItem() .)If no such elements are found, then the method must return null.
The HTMLFormControlsCollection
interface represents a collection of form controls.
interface HTMLFormControlsCollection {
readonly attribute unsigned long length;
[IndexGetter] HTMLElement item(in unsigned long index);
[NameGetter] Object namedItem(in DOMString name);
};
The length
attribute must return the number of nodes represented by the collection .
The item( index ) method must return the index th node in the collection. If there is no
index th node in the collection, then the
method must return null.
The namedItem(
key ) method must act according to
the following algorithm:
id attribute or a name attribute equal to key
, then return that node and stop the algorithm.id
attribute or a name attribute equal
to key , then return null and stop the
algorithm.NodeList object representing a
live view of the HTMLFormControlsCollection
object, further filtered so that the only nodes in the
NodeList object are those that have either an
id attribute or a
name attribute equal to key . The nodes in the NodeList object must
be sorted in tree order .NodeList object.The HTMLOptionsCollection
interface represents a list of option elements.
interface HTMLOptionsCollection {
attribute unsigned long length;
[IndexGetter] HTMLOptionElement item(in unsigned long index);
[NameGetter] Object namedItem(in DOMString name);
};
On getting, the length
attribute must return the number of nodes represented by the collection .
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 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 elements with no attributes and no child nodes
must be appended to the select element on which the
HTMLOptionsCollection is
rooted, where n is the difference between the
two numbers (new value minus old value). 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).
Setting length never removes or adds any
optgroup elements, and never adds new children to
existing optgroup elements (though it can remove
children from them).
The item( index ) method must return the index th node in the collection. If there is no
index th node in the collection, then the
method must return null.
The namedItem( key ) method must act according to the
following algorithm:
id attribute or a name attribute equal to key
, then return that node and stop the algorithm.id
attribute or a name attribute equal
to key , then return null and stop the
algorithm.NodeList object representing a
live view of the HTMLOptionsCollection object,
further filtered so that the only nodes in the
NodeList object are those that have either an
id attribute or a
name attribute equal to
key . The nodes in the NodeList
object must be sorted in tree order
.NodeList object.We may want to add add() and
remove() methods here too because IE implements
HTMLSelectElement and HTMLOptionsCollection on the same object, and
so people use them almost interchangeably in the wild.
The DOMTokenList
interface represents an interface to an underlying string that
consists of an unordered set of unique
space-separated tokens .
Which string underlies a particular DOMTokenList object is defined when the
object is created. It might be a content attribute (e.g. the string
that underlies the classList object is the class attribute), or it
might be an anonymous string (e.g. when a DOMTokenList object is passed to an
author-implemented callback in the datagrid APIs).
[Stringifies] interface DOMTokenList {
readonly attribute unsigned long length;
[IndexGetter] DOMString item(in unsigned long index);
boolean has(in DOMString token);
void add(in DOMString token);
void remove(in DOMString token);
boolean toggle(in DOMString token);
};
The length attribute must
return the number of unique tokens that result from
splitting the
underlying string on spaces .
The item(
index ) method must split the underlying
string on spaces , sort the resulting list of tokens by Unicode
codepoint , remove exact duplicates, and then return the
index th item in this list. If index is equal to or greater than the number of tokens,
then the method must return null.
The has(
token ) method must run the
following algorithm:
INVALID_CHARACTER_ERR exception and stop the
algorithm.The add(
token ) method must run the
following algorithm:
INVALID_CHARACTER_ERR exception and stop the
algorithm.DOMTokenList object's underlying string
then stop the algorithm.DOMTokenList object's underlying string
is not the empty string and the last character of that string is
not a space character , then append a U+0020
SPACE character to the end of that string.DOMTokenList object's
underlying string.The remove(
token ) method must run the
following algorithm:
INVALID_CHARACTER_ERR exception and stop the
algorithm.The toggle(
token ) method must run the
following algorithm:
INVALID_CHARACTER_ERR exception and stop the
algorithm.DOMTokenList object's underlying string
then remove
the given token from the underlying string
, and stop the algorithm, returning false.DOMTokenList object's underlying string
is not the empty string and the last character of that string is
not a space character , then append a U+0020
SPACE character to the end of that string.DOMTokenList object's
underlying string.Objects implementing the DOMTokenList interface must stringify to the
object's underlying string representation.
The DOMStringMap
interface represents a set of name-value pairs. When a
DOMStringMap object is
instanced, it is associated with three algorithms, one for getting
values from names, one for setting names to certain values, and one
for deleting names.
The names of the methods on this interface are temporary and will be fixed when the Web IDL / "Language Bindings for DOM Specifications" spec is ready to handle this case.
interface DOMStringMap {
[NameGetter] DOMString XXX1(in DOMString name);
[NameSetter] void XXX2(in DOMString name, in DOMString value);
[XXX] boolean XXX3(in DOMString name);
};
The XXX1(
name ) method must call the
algorithm for getting values from names, passing name as the name, and must return the corresponding value,
or null if name has no corresponding value.
The XXX2(
name , value )
method must call the algorithm for setting names to certain values,
passing name as the name and value as the value.
The XXX3(
name ) method must call the
algorithm for deleting names, passing name as
the name, and must return true.
DOM3 Core defines mechanisms for checking for interface support, and for obtaining implementations of interfaces, using feature strings . [DOM3CORE]
A DOM application can use the hasFeature( feature ,
version ) method of the
DOMImplementation interface with parameter values "
HTML " and " 5.0 "
(respectively) to determine whether or not this module is supported
by the implementation. In addition to the feature string "
HTML ", the feature string " XHTML " (with version string " 5.0 ") can be
used to check if the implementation supports XHTML. User agents
should respond with a true value when the hasFeature method is queried with these
values. Authors are cautioned, however, that UAs returning true
might not be perfectly compliant, and that UAs returning false
might well have support for features in this specification; in
general, therefore, use of this method is discouraged.
The values " HTML " and " XHTML " (both with version " 5.0 ") should
also be supported in the context of the getFeature()
and isSupported() methods, as defined by DOM3
Core.
The interfaces defined in this specification are
not always supersets of the interfaces defined in DOM2 HTML; some
features that were formerly deprecated, poorly supported, rarely
used or considered unnecessary have been removed. Therefore it is
not guaranteed that an implementation that supports " HTML " " 5.0 " also supports " HTML " " 2.0 ".
replace all instances of the word 'fetch' or 'download' with a reference to this section, and put something here that talks about caching, that redirects to the offline storage stuff when appropriate, that defines that before fetching a URL you have to resolve the URL, so that every case of fetching doesn't have to independently say to resolve the URL, etc; "once fetched, a resource might have to have its type determined", pointing to the next section but also explicitly saying that it's up to the part of the spec doing the fetching to determine how the type is established
It is imperative that the rules in this section be followed exactly. When a user agent uses different heuristics for content type detection than the server expects, security problems can occur. For example, if a server believes that the client will treat a contributed file as an image (and thus treat it as benign), but a Web browser believes the content to be HTML (and thus execute any scripts contained therein), the end user can be exposed to malicious content, making the user vulnerable to cookie theft attacks and other cross-site scripting attacks.
What explicit Content-Type metadata is associated with the resource (the resource's type information) depends on the protocol that was used to fetch the resource.
For HTTP resources, only the first Content-Type HTTP header, if any, contributes any type information; the explicit type of the resource is then the value of that header, interpreted as described by the HTTP specifications. If the Content-Type HTTP header is present but the value of the first such header cannot be interpreted as described by the HTTP specifications (e.g. because its value doesn't contain a U+002F SOLIDUS ('/') character), then the resource has no type information (even if there are multiple Content-Type HTTP headers and one of the other ones is syntactically correct). [HTTP]
For resources fetched from the file system, user agents should use platform-specific conventions, e.g. operating system extension/type mappings.
Extensions must not be used for determining resource types for resources fetched over HTTP.
For resources fetched over most other protocols, e.g. FTP, there is no type information.
The algorithm for extracting an encoding from a Content-Type , given a string s , is as follows. It either returns an encoding or nothing.
Find the first seven characters in s that are a case-insensitive match for the word 'charset'. If no such match is found, return nothing.
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 ('='), return nothing.
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:
Return the string between this character and the next earliest occurrence of this character.
Return nothing.
Return 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.
The above algorithm is a willful violation of the HTTP specification. [RFC2616]
The sniffed type of a resource must be found as follows:
Let official type be the type given by the Content-Type metadata for the resource (in lowercase, ignoring any parameters). If there is no such type, jump to the unknown type step below.
If the user agent is configured to strictly obey Content-Type headers for this resource, then jump to the last step in this set of steps.
If the resource was fetched over an HTTP protocol and there is an HTTP Content-Type header and the value of the first such header has bytes that exactly match one of the following lines:
| Bytes in Hexadecimal | Textual representation |
|---|---|
| 74 65 78 74 2f 70 6c 61 69 6e | text/plain |
| 74 65 78 74 2f 70 6c 61 69 6e 3b 20 63 68 61 72 73 65 74 3d 49 53 4f 2d 38 38 35 39 2d 31 | text/plain; charset=ISO-8859-1 |
| 74 65 78 74 2f 70 6c 61 69 6e 3b 20 63 68 61 72 73 65 74 3d 69 73 6f 2d 38 38 35 39 2d 31 | text/plain; charset=iso-8859-1 |
| 74 65 78 74 2f 70 6c 61 69 6e 3b 20 63 68 61 72 73 65 74 3d 55 54 46 2d 38 | text/plain; charset=UTF-8 |
...then jump to the text or binary section below.
If official type is "unknown/unknown" or "application/unknown", jump to the unknown type step below.
If official type ends in "+xml", or if it is either "text/xml" or "application/xml", then the sniffed type of the resource is official type ; return that and abort these steps.
If official type is an image type supported by the user agent (e.g. "image/png", "image/gif", "image/jpeg", etc), then jump to the images section below.
If official type is "text/html", then jump to the feed or HTML section below.
The sniffed type of the resource is official type .
The user agent may wait for 512 or more bytes of the resource to be available.
Let n be the smaller of either 512 or the number of bytes already available.
If n is 4 or more, and the first bytes of the file match one of the following byte sets:
| Bytes in Hexadecimal | Description |
|---|---|
| FE FF | UTF-16BE BOM |
| FF FE | UTF-16LE BOM |
| EF BB BF | UTF-8 BOM |
...then the sniffed type of the resource is "text/plain".
Otherwise, if any of the first n bytes of the resource are in one of the following byte ranges:
...then the sniffed type of the resource is "application/octet-stream".
maybe we should invoke the "Content-Type sniffing: image" section now, falling back on "application/octet-stream".
Otherwise, the sniffed type of the resource is "text/plain".
The user agent may wait for 512 or more bytes of the resource to be available.
Let stream length be the smaller of either 512 or the number of bytes already available.
For each row in the table below:
Let index pattern be an index into the mask and pattern byte strings of the row.
Let index stream be an index into the byte stream being examined.
Loop : If index stream points beyond the end of the byte stream, then this row doesn't match, skip this row.
Examine the index stream th byte of the byte stream as follows:
If the "and" operator, applied to the index stream th byte of the stream and the index pattern th byte of the mask, yield a value different that the index pattern th byte of the pattern, then skip this row.
Otherwise, increment index pattern to the next byte in the mask and pattern and index stream to the next byte in the byte stream.
" WS " means "whitespace", and allows insignificant whitespace to be skipped when sniffing for a type signature.
If the index stream th byte of the stream is one of 0x09 (ASCII TAB), 0x0A (ASCII LF), 0x0C (ASCII FF), 0x0D (ASCII CR), or 0x20 (ASCII space), then increment only the index stream to the next byte in the byte stream.
Otherwise, increment only the index pattern to the next byte in the mask and pattern.
If index pattern does not point beyond the end of the mask and pattern byte strings, then jump back to the loop step in this algorithm.
Otherwise, the sniffed type of the resource is the type given in the cell of the third column in that row; abort these steps.
As a last-ditch effort, jump to the text or binary section.
| Bytes in Hexadecimal | Sniffed type | Comment | |
|---|---|---|---|
| Mask | Pattern | ||
| FF FF DF DF DF DF DF DF DF FF DF DF DF DF | 3C 21 44 4F 43 54 59 50 45 20 48 54 4D 4C | text/html | The string " <!DOCTYPE HTML " in
US-ASCII or compatible encodings, case-insensitively. |
| FF FF DF DF DF DF | WS 3C 48 54 4D 4C | text/html | The string " <HTML " in US-ASCII or
compatible encodings, case-insensitively, possibly with leading
spaces. |
| FF FF DF DF DF DF | WS 3C 48 45 41 44 | text/html | The string " <HEAD " in US-ASCII or
compatible encodings, case-insensitively, possibly with leading
spaces. |
| FF FF DF DF DF DF DF DF | WS 3C 53 43 52 49 50 54 | text/html | The string " <SCRIPT " in US-ASCII or
compatible encodings, case-insensitively, possibly with leading
spaces. |
| FF FF FF FF FF | 25 50 44 46 2D | application/pdf | The string " %PDF- ", the PDF
signature. |
| FF FF FF FF FF FF FF FF FF FF FF | 25 21 50 53 2D 41 64 6F 62 65 2D | application/postscript | The string " %!PS-Adobe- ", the
PostScript signature. |
| FF FF FF FF FF FF | 47 49 46 38 37 61 | image/gif | The string " GIF87a ", a GIF
signature. |
| FF FF FF FF FF FF | 47 49 46 38 39 61 | image/gif | The string " GIF89a ", a GIF
signature. |
| FF FF FF FF FF FF FF FF | 89 50 4E 47 0D 0A 1A 0A | image/png | The PNG signature. |
| FF FF FF | FF D8 FF | image/jpeg | A JPEG SOI marker followed by the first byte of another marker. |
| FF FF | 42 4D | image/bmp | The string " BM ", a BMP signature. |
| FF FF FF FF | 00 00 01 00 | image/vnd.microsoft.icon | A 0 word following by a 1 word, a Windows Icon file format signature. |
User agents may support further types if desired, by implicitly adding to the above table. However, user agents should not use any other patterns for types already mentioned in the table above, as this could then be used for privilege escalation (where, e.g., a server uses the above table to determine that content is not HTML and thus safe from XSS attacks, but then a user agent detects it as HTML anyway and allows script to execute).
If the first bytes of the file match one of the byte sequences in the first columns of the following table, then the sniffed type of the resource is the type given in the corresponding cell in the second column on the same row:
| Bytes in Hexadecimal | Sniffed type | Comment |
|---|---|---|
| 47 49 46 38 37 61 | image/gif | The string " GIF87a ", a GIF
signature. |
| 47 49 46 38 39 61 | image/gif | The string " GIF89a ", a GIF
signature. |
| 89 50 4E 47 0D 0A 1A 0A | image/png | The PNG signature. |
| FF D8 FF | image/jpeg | A JPEG SOI marker followed by the first byte of another marker. |
| 42 4D | image/bmp | The string " BM ", a BMP signature. |
| 00 00 01 00 | image/vnd.microsoft.icon | A 0 word following by a 1 word, a Windows Icon file format signature. |
User agents must ignore any rows for image types that they do not support.
Otherwise, the sniffed type of the resource is the same as its official type .
The user agent may wait for 512 or more bytes of the resource to be available.
Let s be the stream of bytes, and let s [ i ] represent the byte in s with position i , treating s as zero-indexed (so the first byte is at i =0 ).
If at any point this algorithm requires the user agent to determine the value of a byte in s which is not yet available, or which is past the first 512 bytes of the resource, or which is beyond the end of the resource, the user agent must stop this algorithm, and assume that the sniffed type of the resource is "text/html".
User agents are allowed, by the first step of this algorithm, to wait until the first 512 bytes of the resource are available.
Initialise pos to 0.
If s [0] is 0xEF, s [1] is 0xBB, and s [2] is 0xBF, then set pos to 3. (This skips over a leading UTF-8 BOM, if any.)
Loop start: Examine s [ pos ] .
< ")If the bytes with positions pos to
pos +2 in s
are exactly equal to 0x21, 0x2D, 0x2D respectively (ASCII for "
!-- "), then:
--> "), then
increase pos by 3 and jump back to the previous
step (the step labeled loop start ) in the overall algorithm
in this section.If s [ pos
] is 0x21 (ASCII " ! "):
If s [ pos
] is 0x3F (ASCII " ? "):
Otherwise, if the bytes in s starting at pos match any of the sequences of bytes in the first column of the following table, then the user agent must follow the steps given in the corresponding cell in the second column of the same row.
| Bytes in Hexadecimal | Requirement | Comment |
|---|---|---|
| 72 73 73 | The sniffed type of the resource is "application/rss+xml"; abort these steps | The three ASCII characters " rss " |
| 66 65 65 64 | The sniffed type of the resource is "application/atom+xml"; abort these steps | The four ASCII characters " feed " |
| 72 64 66 3A 52 44 46 | Continue to the next step in this algorithm | The ASCII characters " rdf:RDF " |
If none of the byte sequences above match the bytes in s starting at pos , then the sniffed type of the resource is "text/html". Abort these steps.
If, before the next "> ", you find two xmlns* attributes with http://www.w3.org/1999/02/22-rdf-syntax-ns# and http://purl.org/rss/1.0/ as the namespaces, then the sniffed type of the resource is "application/rss+xml", abort these steps. (maybe we only need to check for http://purl.org/rss/1.0/ actually)
Otherwise, the sniffed type of the resource is "text/html".
For efficiency reasons, implementations may wish to implement this algorithm and the algorithm for detecting the character encoding of HTML documents in parallel.
This section is non-normative.
An introduction to marking up a document.
Every XML and HTML document in an HTML UA is represented by a
Document object. [DOM3CORE]
Document objects are assumed to be XML documents unless they are flagged as
being HTML documents when they are created.
Whether a document is an HTML document or an XML document affects the behavior of
certain APIs, as well as a few CSS rendering rules. [CSS21]
A Document object created by the
createDocument() API on the
DOMImplementation object is initially an XML document , but can
be made into an HTML
document by calling document.open() on it.
All Document objects (in user agents implementing
this specification) must also implement the HTMLDocument interface, available using
binding-specific methods. (This is the case whether or not the
document in question is an HTML document or indeed whether it contains
any HTML elements at all.)
Document objects must also implement the
document-level interface of any other namespaces found in the
document that the UA supports. For example, if an HTML
implementation also supports SVG, then the Document
object must implement HTMLDocument and
SVGDocument .
Because the HTMLDocument interface is now obtained
using binding-specific casting methods instead of simply being the
primary interface of the document object, it is no longer defined
as inheriting from Document .
interface HTMLDocument {
// resource metadata management
[PutForwards=href] readonly attribute Location location;
readonly attribute DOMString URL;
attribute DOMString domain;
readonly attribute DOMString referrer;
attribute DOMString cookie;
readonly attribute DOMString lastModified;
readonly attribute DOMString compatMode;
attribute DOMString charset;
readonly attribute DOMString characterSet;
readonly attribute DOMString defaultCharset;
readonly attribute DOMString readyState;
// DOM tree accessors
attribute DOMString title;
attribute DOMString dir;
attribute HTMLElement body;
readonly attribute HTMLCollection images;
readonly attribute HTMLCollection embeds;
readonly attribute HTMLCollection plugins;
readonly attribute HTMLCollection links;
readonly attribute HTMLCollection forms;
readonly attribute HTMLCollection anchors;
readonly attribute HTMLCollection scripts;
NodeList getElementsByName(in DOMString elementName);
NodeList getElementsByClassName(in DOMString classNames);
// dynamic markup insertion
attribute DOMString innerHTML;
HTMLDocument open();
HTMLDocument open(in DOMString type);
HTMLDocument open(in DOMString type, in DOMString replace);
Window open(in DOMString url, in DOMString name, in DOMString features);
Window open(in DOMString url, in DOMString name, in DOMString features, in boolean replace);
void close();
void write(in DOMString text);
void writeln(in DOMString text);
// user interaction
Selection getSelection();
readonly attribute Element activeElement;
boolean hasFocus();
attribute boolean 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;
};
Since the HTMLDocument
interface holds methods and attributes related to a number of
disparate features, the members of this interface are described in
various different sections.
User agents must raise a security
exception whenever any of the members of an HTMLDocument object are accessed by
scripts whose effective script origin is
not the same as the
Document 's effective script
origin .
The URL attribute must return
the document's address .
The referrer attribute must
return either the address of the active document of the source
browsing context at the time the navigation was started (that
is, the page which navigated the browsing
context to the current document), 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 with a
noreferrer keyword.
In the case of HTTP, the referrer DOM
attribute will match the Referer (sic) header
that was sent when fetching the current page.
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).
The cookie attribute
represents the cookies of the resource.
On getting, if the sandboxed origin browsing context flag is set on
the browsing context of the document, the
user agent must raise a security exception
. Otherwise, it must return the same string as the value of the
Cookie HTTP header it would include if
fetching the resource indicated by the document's
address over HTTP, as per RFC 2109 section 4.3.4 or later
specifications. [RFC2109] [RFC2965]
On setting, if the sandboxed origin
browsing context flag is set on the browsing context of the document, the user agent
must raise a security exception .
Otherwise, the user agent must act as it would when processing
cookies if it had just attempted to fetch the document's
address over HTTP, and had received a response with a
Set-Cookie header whose value was the specified value,
as per RFC 2109 sections 4.3.1, 4.3.2, and 4.3.3 or later
specifications. [RFC2109] [RFC2965]
Since the cookie
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.
The lastModified
attribute, on getting, must return the date and time of the
Document 's source file's last modification, in the
user's local timezone, in the following format:
All the numeric components above, other than the year, must be given as two digits in the range U+0030 DIGIT ZERO to U+0039 DIGIT NINE representing the number in base ten, zero-padded if necessary.
The Document '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 string 01/01/1970 00:00:00 .
A Document 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 , based on the
presence, absence, or value of the DOCTYPE string.
The compatMode DOM
attribute must return the literal string " CSS1Compat " unless the document has been set to quirks mode by the HTML parser
, in which case it must instead return the literal string "
BackCompat ".
As far as parsing goes, the quirks I know of are:
Documents have an associated character encoding . When a
Document object is created, the document's character encoding must be initialized
to UTF-16. Various algorithms during page loading affect this
value, as does the charset setter. [IANACHARSET]
The charset DOM attribute
must, on getting, return the preferred MIME name of the document's character encoding . On setting, if
the new value is an IANA-registered alias for a character encoding,
the document's character encoding must be
set to that character encoding. (Otherwise, nothing happens.)
The characterSet DOM
attribute must, on getting, return the preferred MIME name of the
document's character encoding .
The defaultCharset DOM
attribute must, on getting, return the preferred MIME name 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.
Each document has a current document
readiness . When a Document object is created,
it must have its current document readiness
set to the string "loading". Various algorithms during page loading
affect this value. When the value is set, the user agent must
fire a simple event called readystatechanged at the
Document object.
The readyState DOM
attribute must, on getting, return the current
document readiness .
The html element of a
document is the document's root element, if there is one and it's
an html element, or null
otherwise.
The head element of a
document is the first head element
that is a child of the html
element , if there is one, or null otherwise.
The title element of a
document is the first title
element in the document (in tree order), if there is one, or null
otherwise.
The title attribute must, on
getting, run the following algorithm:
If the root element is an
svg element in the " http://www.w3.org/2000/svg " namespace, and the user
agent supports SVG, then the getter must return the value that
would have been returned by the DOM attribute of the same name on
the SVGDocument interface.
Otherwise, it must return a concatenation of the data of all the
child text nodes of
the title element , in tree
order, or the empty string if the
title element is null.
On setting, the following algorithm must be run:
If the root element is an
svg 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 DOM attribute of the same name on the SVGDocument
interface. Stop the algorithm here.
title element is
null and the head element is
null, then the attribute must do nothing. Stop the algorithm
here.title element is
null, then a new title element
must be created and appended to the
head element .title
element (if any) must all be removed.Text node whose data is the new value
being assigned must be appended to the
title element .The title attribute on the HTMLDocument interface should shadow the
attribute of the same name on the SVGDocument
interface when the user agent supports both HTML and SVG.
The body element of a document is the
first child of the html
element that is either a body
element or a frameset 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 object.
The body attribute, on getting,
must return the body element of the
document (either a body element,
a frameset element, or null). On setting, the
following algorithm must be run:
body or frameset element, then
raise a HIERARCHY_REQUEST_ERR exception and abort
these steps.replaceChild() method
had been called with the new value and the incumbent body element as its two
arguments respectively, then abort these steps.The images attribute must
return an HTMLCollection rooted at the
Document node, whose filter matches only
img elements.
The embeds attribute must
return an HTMLCollection rooted at the
Document node, whose filter matches only
embed elements.
The plugins attribute must
return the same object as that returned by the embeds
attribute.
The links attribute must return
an HTMLCollection
rooted at the Document node, whose filter matches only
a elements with href attributes
and area elements with
href
attributes.
The forms attribute must return
an HTMLCollection
rooted at the Document node, whose filter matches only
form elements.
The anchors attribute must
return an HTMLCollection rooted at the
Document node, whose filter matches only
a elements with name attributes.
The scripts attribute must
return an HTMLCollection rooted at the
Document node, whose filter matches only
script elements.
The getElementsByName(
name ) method a string name , and must return a live NodeList
containing all the a , applet , button ,
form , iframe ,
img , input ,
map , meta , object , select , and
textarea elements in that document that have a
name attribute whose value is equal to the
name argument.
The getElementsByClassName(
classNames ) method takes a string
that contains an unordered set of unique
space-separated tokens representing classes. When called, the
method must return a live NodeList object containing
all the elements in the document that have all the classes
specified in that argument, having obtained the classes by splitting a string on
spaces . If there are no tokens specified in the argument, then
the method must return an empty NodeList .
The getElementsByClassName()
method on the HTMLElement
interface must return a live NodeList with the nodes
that the HTMLDocument
getElementsByClassName()
method would return when passed the same argument(s), excluding any
elements that are not descendants of the HTMLElement object on which the method
was invoked.
HTML, SVG, and MathML elements define which classes they are in
by having an attribute in the per-element partition 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. UAs must not assume that all attributes of the
name class for elements in any namespace work
in this way, however, and must not assume that such attributes,
when used as global attributes, label other elements 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 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.
The dir attribute on the HTMLDocument interface is defined along
with the dir
content attribute.
Elements, attributes, and attribute values in HTML are defined
(by this specification) to have certain meanings (semantics). For
example, the ol element represents
an ordered list, and the lang attribute represents the language of the
content.
Authors must not use elements, attributes, and attribute values for purposes other than their appropriate intended semantic purpose.
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 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>
This next document fragment, intended to represent the heading of a corporate site, is similarly non-conforming because the second line is not intended to be a heading of a subsection, but merely a 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 header element should be
used in these kinds of situations:
<body> <header> <h1>ABC Company</h1> <h2>Leading the way in widget design since 1432</h2> </header> ...
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 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.
The nodes representing HTML elements in the DOM must implement, and expose to scripts, the interfaces listed for them in the relevant sections of this specification. This includes HTML elements in XML documents , even when those documents are in another context (e.g. inside an XSLT transform).
Elements in the DOM represent things; that is, they have intrinsic meaning , also known as semantics.
For example, an ol element represents an ordered list.
The basic interface, from which all the HTML elements ' interfaces inherit, and which
must be used by elements that have no additional requirements, is
the HTMLElement
interface.
interface HTMLElement : Element { // DOM tree accessors NodeList getElementsByClassName(in DOMString classNames); // dynamic markup insertion attribute DOMString innerHTML; // metadata attributes attribute DOMString id; attribute DOMString title; attribute DOMString lang; attribute DOMString dir; attribute DOMString className; readonly attribute DOMTokenList classList; readonly attribute DOMStringMap dataset; // user interaction attribute boolean irrelevant; void click(); void scrollIntoView(); void scrollIntoView(in boolean top); attribute long tabIndex; void focus(); void blur(); attribute boolean draggable; attribute DOMString contentEditable; readonly attribute DOMString isContentEditable; attribute HTMLMenuElement contextMenu; // styling readonly attribute CSSStyleDeclaration style; // data templates attribute DOMString template; readonly attribute HTMLDataTemplateElement templateElement; attribute DOMString ref; readonly attribute Node refNode; attribute DOMString registrationMark; readonly attribute DocumentFragment originalContent; // event handler DOM attributes attribute EventListener onabort; attribute EventListener onbeforeunload; attribute EventListener onblur; attribute EventListener onchange; attribute EventListener onclick; attribute EventListener oncontextmenu; attribute EventListener ondblclick; attribute EventListener ondrag; attribute EventListener ondragend; attribute EventListener ondragenter; attribute EventListener ondragleave; attribute EventListener ondragover; attribute EventListener ondragstart; attribute EventListener ondrop; attribute EventListener onerror; attribute EventListener onfocus; attribute EventListener onkeydown; attribute EventListener onkeypress; attribute EventListener onkeyup; attribute EventListener onload; attribute EventListener onmessage; attribute EventListener onmousedown; attribute EventListener onmousemove; attribute EventListener onmouseout; attribute EventListener onmouseover; attribute EventListener onmouseup; attribute EventListener onmousewheel; attribute EventListener onresize; attribute EventListener onscroll; attribute EventListener onselect; attribute EventListener onstorage; attribute EventListener onsubmit; attribute EventListener onunload; };
The HTMLElement
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 following attributes are common to and may be specified on all HTML elements (even those not defined in this specification):
classcontenteditablecontextmenudirdraggableidirrelevantlangrefregistrationmarkstyletabindextemplatetitleIn addition, the following event handler content attributes may be specified on any HTML element :
onabortonbeforeunloadonbluronchangeonclickoncontextmenuondblclickondragondragendondragenterondragleaveondragoverondragstartondroponerroronfocusonkeydownonkeypressonkeyuponloadonmessageonmousedownonmousemoveonmouseoutonmouseoveronmouseuponmousewheelonresizeonscrollonselectonstorageonsubmitonunloadAlso, custom
data attributes (e.g. data-foldername or
data-msgid ) can be specified on any
HTML element , to store custom data specific to the
page.
In HTML documents , elements in the
HTML namespace 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 .
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 , the attribute ends
up in no namespace, not the "
http://www.w3.org/2000/xmlns/ " namespace like
namespace declaration attributes in XML do.
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.
id attributeThe id attribute
represents its element's unique identifier. The value must be
unique in the subtree within which the element finds itself and
must contain at least one character. The value must not contain any
space characters .
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 matching within the subtree the
element finds itself (e.g. for selectors in CSS or for the
getElementById() method in the DOM).
Identifiers are opaque strings. Particular meanings should not
be derived from the value of the id 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 in a way that doesn't conflict with the id attribute.
The id DOM
attribute must reflect the id content attribute.
title attributeThe title
attribute represents 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
attribute of the nearest ancestor HTML element with a title 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 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.
Some elements, such as link and
abbr , define additional semantics
for the title
attribute beyond the semantics described above.
The title
DOM attribute must reflect the title content
attribute.
lang (HTML only) and
xml:lang
(XML only) attributesThe lang
attribute 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 RFC 3066 language
code, or the empty string. [RFC3066]
The xml:lang attribute is defined in XML.
[XML]
If these attributes are omitted from an element, then it implies that the language of this element is the same as the language of the parent element. Setting the attribute to the empty string indicates that the primary language is unknown.
The lang
attribute may be used on elements of HTML
documents . Authors must not use the lang attribute in XML documents .
The xml:lang attribute may be used on elements of
XML documents . Authors must not use
the xml:lang attribute in HTML
documents .
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 an xml:lang attribute
set or is an HTML
element and has a lang attribute set. That attribute specifies the
language of the node.
If both the xml:lang attribute and the lang attribute are set on an
element, user agents must use the xml:lang attribute,
and the lang
attribute must be ignored for
the purposes of determining the element's language.
If no explicit language is given for the root element , then language information from a higher-level protocol (such as HTTP), if any, must be used as the final fallback language. In the absence of any language information, the default value is unknown (the empty string).
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 DOM
attribute must reflect the lang content attribute.
xml:base
attribute (XML only)The xml:base attribute is defined in XML Base.
[XMLBASE]
The xml:base attribute may be used on elements of
XML documents . Authors must not use
the xml:base attribute in HTML
documents .
dir attributeThe dir
attribute specifies the element's text directionality. The
attribute is an enumerated attribute with
the keyword ltr mapping to the state
ltr , and the keyword rtl mapping to
the state rtl . The attribute has no defaults.
If the attribute has the state ltr , the element's directionality is left-to-right. If the attribute has the state rtl , the element's directionality is right-to-left. Otherwise, the element's directionality is the same as its parent element, or ltr if there is no parent element.
The processing of this attribute depends on the presentation layer. For example, CSS 2.1 defines a mapping from this attribute to the CSS 'direction' and 'unicode-bidi' properties, and defines rendering in terms of those properties.
The dir DOM
attribute on an element must reflect the
dir content
attribute of that element, limited to only known
values .
The dir DOM attribute on
HTMLDocument objects must
reflect the dir content attribute of the
html element , if any, limited
to only known values . If there is no such element, then the
attribute must return the empty string and do nothing on
setting.
class attributeEvery HTML
element may have a class attribute specified.
The attribute, if specified, must have a value that is an unordered set of unique space-separated tokens representing the various classes that the element belongs to.
The classes that an HTML element has assigned to it consists of all
the classes returned when the value of the class attribute is
split on
spaces .
Assigning classes to an element affects class
matching in selectors in CSS, the getElementsByClassName()
method in the DOM, and other such features.
Authors may use any value in the class attribute, but are
encouraged to use the values that describe the nature of the
content, rather than values that describe the desired presentation
of the content.
The className and classList DOM
attributes must both reflect the
class content
attribute.
style attributeAll elements may have the style content attribute set. If specified, the
attribute must contain only a list of zero or more
semicolon-separated (;) CSS declarations. [CSS21]
The attribute, if specified, must be parsed and treated as the body (the part inside the curly brackets) of a declaration block in a rule whose selector matches just the element on which the attribute is set. For the purposes of the CSS cascade, the attribute must be considered to be a 'style' attribute at the author level.
Documents that use style attributes on any of their elements must
still be comprehensible and usable if those attributes were
removed.
In particular, using the style attribute to hide
and show content, or to convey meaning that is otherwise not
included in the document, is non-conforming.
The style
DOM attribute must return a CSSStyleDeclaration whose
value represents the declarations specified in the attribute, if
present. Mutating the CSSStyleDeclaration object must
create a style 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. [CSSOM]
In the following example, the words that refer to colors are
marked up using the span element
and the style
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>
A custom data attribute is an attribute
whose name starts with the string " data- ", has at least one
character after the hyphen, is XML-compatible , and has no namespace.
Custom data attributes are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements.
Every HTML element may have any number of custom data attributes specified, with any value.
The dataset DOM attribute provides
convenient accessors for all the data-* attributes on an element. On getting,
the dataset
DOM attribute must return a DOMStringMap object, associated with
the following three algorithms, which expose these attributes on
their element:
data- and the name passed to the
algorithm.data- and the name passed to the
algorithm.setAttribute() would have raised an exception
when setting an attribute with the name name ,
then this must raise the same exception.data- and the name passed to the
algorithm.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 attribute along with data-* attributes:
<div class="spaceship" data-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.id].fire()">
Fire
</button>
</div>
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.
All the elements in this specification have a defined content model, which describes what nodes are allowed inside the elements, and thus what the structure of an HTML document or fragment must look like.
As noted in the conformance and terminology
sections, for the purposes of determining if an element matches its
content model or not, CDATASection nodes in the DOM are treated
as equivalent to Text nodes , and entity reference nodes are treated as if they
were expanded in place .
The space characters are always allowed between elements. User agents represent these characters between elements in the source markup as text nodes in the DOM. Empty text nodes and text nodes consisting of just sequences of those characters are considered inter-element whitespace .
Inter-element whitespace , comment nodes, and processing instruction nodes must be ignored when establishing whether an element matches its content model or not, and must be ignored when following algorithms that define document and element semantics.
An element A is said to be preceded or followed by a second element B if A and B have the same parent node and there are no other element nodes or text nodes (other than inter-element whitespace ) between them.
Authors must not use elements in the HTML namespace anywhere except where they are explicitly allowed, as defined for each element, or as explicitly required by other specifications. For XML compound documents, these contexts could be inside elements from other namespaces, if those elements are defined as providing the relevant contexts.
The SVG specification defines the SVG foreignObject
element as allowing foreign namespaces to be included, thus
allowing compound documents to be created by inserting subdocument
content under that element. This specification defines the
XHTML html element as being
allowed where subdocument fragments are allowed in a compound
document. Together, these two definitions mean that placing an
XHTML html element as a child of
an SVG foreignObject element is conforming. [SVG]
The Atom specification defines the Atom content element, when its type
attribute has the value xhtml , as requiring
that it contains a single HTML div
element. Thus, a div element is
allowed in that context, even though this is not explicitly
normatively stated by this specification. [ATOM]
In addition, elements in the HTML namespace may be orphan nodes (i.e. without a parent node).
For example, creating a td
element and storing it in a global variable in a script is
conforming, even though td elements
are otherwise only supposed to be used inside tr elements.
var data = {
name: "Banana",
cell: document.createElement('td'),
};
Each element in HTML falls into zero or more categories that group elements with similar characteristics together. The following categories are used in this specification:
Some elements have unique requirements and do not fit into any particular category.
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.
Elements from other namespaces whose semantics are primarily metadata-related (e.g. RDF) are also metadata content .
Most elements that are used in the body of documents and applications are categorized as flow content .
As a general rule, elements whose content model allows any
flow content should have either at
least one descendant text node that is not inter-element whitespace , or at least one
descendant element node that is embedded
content . For the purposes of this requirement, del elements and their descendants must not be
counted as contributing to the ancestors of the del 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.
Sectioning content is content that defines the scope of headers , footers , and contact information .
Each sectioning content element potentially has a heading. See the section on headings and sections for further details.
Heading content defines the header of a section (whether explicitly marked up using sectioning content elements, or implied by the heading content itself).
Phrasing content is the text of the document, as well as elements that mark up that text at the intra-paragraph level. Runs of phrasing content form paragraphs .
All phrasing content is also flow content . Any content model that expects flow content also expects phrasing content .
As a general rule, elements whose content model allows any
phrasing content should have either at
least one descendant text node that is not inter-element whitespace , or at least one
descendant element node that is embedded
content . For the purposes of this requirement, nodes that are
descendants of del elements must
not be counted as contributing to the ancestors of the
del element.
Most elements that are categorized as phrasing content can only contain elements that are themselves categorized as phrasing content, not any flow content.
Text nodes that are not inter-element whitespace are phrasing content .
Embedded content is content that imports another resource into the document, or content from another vocabulary that is inserted into the document.
All embedded content is also phrasing content (and flow content ). Any content model that expects phrasing content (or flow content ) also expects embedded content .
Elements that are from namespaces other than the HTML namespace and that convey content but not metadata, are embedded content 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.
Parts of this section should eventually be moved to DOM3 Events.
Interactive content is content that is specifically intended for user interaction.
Certain elements in HTML can be activated, for instance
a elements, button
elements, or input elements when their
type attribute is set to radio .
Activation of those elements can happen in various (UA-defined)
ways, for instance via the mouse or keyboard.
When activation is performed via some method other than clicking
the pointing device, the default action of the event that triggers
the activation must, instead of being activating the element
directly, be to fire a click event on the same element.
The default action of this click event, or of the real click event if the element was activated by
clicking a pointing device, must be to fire a further DOMActivate event at the same
element, whose own default action is to go through all the elements
the DOMActivate event
bubbled through (starting at the target node and going towards the
Document node), looking for an element with an
activation behavior ; the first element,
in reverse tree order, to have one, must have its activation
behavior executed.
The above doesn't happen for arbitrary synthetic
events dispatched by author script. However, the click() method can be used
to make it happen programmatically.
For certain form controls, this process is complicated further by changes that must happen around the click event . [WF2]
Most interactive elements have content models that disallow nesting interactive elements.
Some elements are described as transparent ; they have "transparent" as their content model. Some elements are described as semi-transparent ; this means that part of their content model is "transparent" but that is not the only part of the content model that must be satisfied.
When a content model includes a part that is "transparent", those parts must not contain content that would not be conformant if all transparent and semi-transparent elements in the tree were replaced, in their parent element, by the children in the "transparent" part of their content model, retaining order.
When a transparent or semi-transparent element has no parent, then the part of its content model that is "transparent" must instead be treated as accepting any flow content .
A paragraph is typically 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.
Paragraphs in flow content are
defined relative to what the document looks like without the
ins and del elements complicating matters. Let
view be a view of the DOM that replaces all
ins and del elements in the document with their contents.
Then, in view , for each run of phrasing content uninterrupted by other types of
content, in an element that accepts content other than phrasing content , let first
be the first node of the run, and let last be
the last node of the run. For each run, a paragraph exists in the
original DOM from immediately before first to
immediately after last . (Paragraphs can thus
span across ins and del elements.)
A paragraph is also formed by
p elements.
The p 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, there are two paragraphs in a section. There is also a header, which contains phrasing content that is not a paragraph. Note how the comments and intra-element whitespace 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>
The following example takes that markup and puts ins and del
elements around some of the markup to show that the text was
changed (though in this case, the changes don't really make much
sense, admittedly). Notice how this example has exactly the same
paragraphs as the previous one, despite the ins and del
elements.
<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>
For HTML documents , and for HTML elements in HTML documents , certain APIs defined in DOM3 Core become case-insensitive or case-changing, as sometimes defined in DOM3 Core, and as summarized or required below. [DOM3CORE] .
This does not apply to XML documents or to elements that are not in the HTML namespace despite being in HTML documents .
Element.tagName , Node.nodeName , and Node.localNameThese attributes return tag names in all uppercase and attribute names in all lowercase, regardless of the case with which they were created.
Document.createElement()The canonical form of HTML markup is all-lowercase; thus, this method will lowercase the argument before creating the requisite element. Also, the element created must be in the HTML namespace .
This doesn't apply to Document.createElementNS() . Thus, it is possible, by
passing this last method a tag name in the wrong case, to create an
element that claims to have the tag name of an element defined in
this specification, but doesn't support its interfaces, because it
really has another tag name not accessible from the DOM APIs.
Element.setAttributeNode()When an Attr node is set on an HTML element , it must
have its name lowercased before the element is affected.
This doesn't apply to Document.setAttributeNodeNS() .
Element.setAttribute()When an attribute is set on an HTML element , the name argument must be lowercased before the element is affected.
This doesn't apply to Document.setAttributeNS() .
Document.getElementsByTagName() and
Element.getElementsByTagName()These methods (but not their namespaced counterparts) must compare the given argument case-insensitively when looking at HTML elements , and case-sensitively otherwise.
Thus, in an HTML document with nodes in multiple namespaces, these methods will be both case-sensitive and case-insensitive at the same time.
Document.renameNode()If the new namespace is the HTML namespace , then the new qualified name must be lowercased before the rename takes place.
The document.write() family of methods and
the innerHTML family of DOM attributes enable
script authors to dynamically insert markup into the document.
bz argues that innerHTML should be called something else on XML documents and XML elements. Is the sanity worth the migration pain?
Because these APIs interact with the parser, their behavior varies depending on whether they are used with HTML documents (and the HTML parser ) or XHTML in XML documents (and the XML parser ). The following table cross-references the various versions of these APIs.
document.write() |
innerHTML |
|
|---|---|---|
| For documents that are HTML documents | document.write() in
HTML |
innerHTML in HTML |
| For documents that are XML documents | document.write() in
XML |
innerHTML in XML |
Regardless of the parsing mode, the document.writeln(...)
method must call the document.write() method with the same
argument(s), and then call the document.write() method with, as its
argument, a string consisting of a single line feed character
(U+000A).
The open() method comes in
several variants with different numbers of arguments.
When called with two or fewer arguments, the method must act as follows:
Let type be the value of the first argument,
if there is one, or " text/html " otherwise.
Let replace be true if there is a second argument and it has the value "replace" , and false otherwise.
If the document has an active parser that isn't a
script-created parser , and the
insertion point associated with that
parser's input stream 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 object on which the method was invoked.
This basically causes document.open() 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.
onbeforeunload, onunload, reset timers, empty event queue, kill any pending transactions, XMLHttpRequests, etc
If the document has an active parser , then stop that parser, and throw away any pending content in the input stream. what about if it doesn't, because it's either like a text/plain, or Atom, or PDF, or XHTML, or image document, or something?
Remove all child nodes of the document.
Change the document's character encoding to UTF-16.
Create a new HTML parser and associate it
with the document. This is a script-created parser (meaning that it can
be closed by the document.open() and document.close()
methods, and that the tokeniser will wait for an explicit call to
document.close() before emitting an end-of-file
token).
If type does not have the value "
text/html " , then act as if the tokeniser had emitted
a start tag token with the tag name "pre", then set the HTML parser 's tokenisation stage's content model flag to PLAINTEXT .
If replace is false, then:
Document
's History objectDocumentDocument 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() call.)Finally, set the insertion point to point at just before the end of the input stream (which at this point will be empty).
Return the Document on which the method was
invoked.
We shouldn't hard-code text/plain
there. We should do it some other way, e.g. hand off to the section
on content-sniffing and handling of incoming data streams, the part
that defines how this all works when stuff comes over the
network.
When called with three or more arguments, the open() method on the
HTMLDocument object must
call the open()
method on the Window interface
of the object returned by the defaultView attribute of the
DocumentView interface of the HTMLDocument object, with the same
arguments as the original call to the open() method, and
return whatever that method returned. If the defaultView attribute of the
DocumentView interface of the HTMLDocument object is null, then the
method must raise an INVALID_ACCESS_ERR exception.
The close() method must do
nothing if there is no script-created
parser associated with the document. If there is such a parser,
then, when the method is called, the user agent must insert an
explicit "EOF" character at the insertion point of the parser's input stream .
In HTML, the document.write(...)
method must act as follows:
If the insertion point is undefined,
the open() method must be called (with no arguments)
on the document object. The insertion point will point at just before the end
of the (empty) input stream .
The string consisting of the concatenation of all the arguments to the method must be inserted into the input stream just before the insertion point .
If there is a pending external script , then the method must now return without further processing of the input stream .
Otherwise, the tokeniser must process the characters that were
inserted, one at a time, processing resulting tokens as they are
emitted, and stopping when the tokeniser reaches the insertion
point or when the processing of the tokeniser is aborted by the
tree construction stage (this can happen if a script start tag token is emitted by the
tokeniser).
If the document.write() method was called
from script executing inline (i.e. executing because the parser
parsed a set of script tags),
then this is a reentrant invocation of the
parser .
Finally, the method must return.
In HTML, the innerHTML DOM attribute of
all HTMLElement and
HTMLDocument nodes returns
a serialization of the node's children using the HTML
syntax . On setting, it replaces the node's children with
new nodes that result from parsing the given value. The formal
definitions follow.
On getting, the innerHTML DOM attribute must return the
result of running the HTML fragment
serialization algorithm on the node.
On setting, if the node is a document, the innerHTML DOM
attribute must run the following algorithm:
If the document has an active parser , then stop that parser, and throw away any pending content in the input stream. what about if it doesn't, because it's either like a text/plain, or Atom, or PDF, or XHTML, or image document, or something?
Remove the children nodes of the Document whose
innerHTML attribute is being set.
Create a new HTML parser , in its initial
state, and associate it with the Document node.
Place into the input stream for the
HTML parser just created the string being
assigned into the innerHTML attribute.
Start the parser and let it run until it has consumed all the
characters just inserted into the input stream. (The
Document node will have been populated with elements
and a load
event will have fired on its body element .)
Otherwise, if the node is an element, then setting the
innerHTML DOM attribute must cause the
following algorithm to run instead:
Invoke the HTML fragment parsing
algorithm , with the element whose innerHTML
attribute is being set as the context element,
and the string being assigned into the innerHTML
attribute as the input . Let new
children be the result of this algorithm.
Remove the children of the element whose innerHTML
attribute is being set.
Let target document be the ownerDocument of the Element node whose
innerHTML attribute is being set.
Set the ownerDocument of all the nodes in
new children to the target
document .
Append all the new children nodes to the
node whose innerHTML attribute is being set,
preserving their order.
script elements
inserted using innerHTML do not execute when they are
inserted.
In an XML context, the document.write() method
must raise an INVALID_ACCESS_ERR exception.
On the other hand, however, the innerHTML attribute is
indeed usable in an XML context.
In an XML context, the innerHTML DOM attribute on HTMLElement s must return a string in the
form of an internal
general parsed entity , and on HTMLDocument s must return a string in
the form of a document entity .
The string returned must be XML namespace-well-formed and must be
an isomorphic serialization of all of that node's child nodes, in
document order. User agents may adjust prefixes and namespace
declarations in the serialization (and indeed might be forced to do
so in some cases to obtain namespace-well-formed XML). For the
innerHTML attribute on HTMLElement objects, if any of the
elements in the serialization are in no namespace, the default
namespace in scope for those elements must be explicitly declared
as the empty string. (This doesn't apply to the innerHTML
attribute on HTMLDocument
objects.) [XML] [XMLNS]
If any of the following cases are found in the DOM being
serialized, the user agent must raise an
INVALID_STATE_ERR exception:
Document node with no child element nodes.DocumentType node that has an external subset
public identifier or an external subset system identifier that
contains both a U+0022 QUOTATION MARK ('"') and a U+0027 APOSTROPHE
("'").Attr node, Text node,
CDATASection node, Comment node, or
ProcessingInstruction node whose data contains
characters that are not matched by the XML Char production. [XML]CDATASection node whose data contains the string
" ]]> ".Comment node whose data contains two adjacent
U+002D HYPHEN-MINUS (-) characters or ends with such a
character.ProcessingInstruction node whose target name is
the string " xml " (case insensitively)
.ProcessingInstruction node whose target name
contains a U+003A COLON (":").ProcessingInstruction node whose data contains
the string " ?> ".These are the only ways to make a DOM
unserializable. The DOM enforces all the other XML constraints; for
example, trying to set an attribute with a name that contains an
equals sign (=) will raised an INVALID_CHARACTER_ERR
exception.
On setting, in an XML context, the innerHTML DOM
attribute on HTMLElement s
and HTMLDocument s must
run the following algorithm:
The user agent must create a new XML parser .
If the innerHTML attribute is being set on an
element, the user agent must feed the parser just
created the string corresponding to the start tag of that element,
declaring all the namespace prefixes that are in scope on that
element in the DOM, as well as declaring the default namespace (if
any) that is in scope on that element in the DOM.
The user agent must feed the parser just created
the string being assigned into the innerHTML
attribute.
If the innerHTML attribute is being set on an
element, the user agent must feed the parser the
string corresponding to the end tag of that element.
If the parser found a well-formedness error, the attribute's
setter must raise a SYNTAX_ERR exception and abort
these steps.
The user agent must remove the children nodes of the node whose
innerHTML attribute is being set.
If the attribute is being set on a Document node,
let new children be the children of the
document, preserving their order. Otherwise, the attribute is being
set on an Element node; let new
children be the children of the document's root element,
preserving their order.
If the attribute is being set on a Document node,
let target document be that
Document node. Otherwise, the attribute is being set
on an Element node; let target
document be the ownerDocument of that
Element .
Set the ownerDocument of all the nodes in
new children to the target
document .
Append all the new children nodes to the
node whose innerHTML attribute is being set,
preserving their order.
script elements
inserted using innerHTML do not execute when they are
inserted.
html elementhead element followed by a
body element.manifestHTMLElement .The html element represents the
root of an HTML document.
The manifest attribute gives
the address of the document's application
cache manifest , if there is one. If the
attribute is present, the attribute's value must be a valid URL .
The manifest attribute only has an
effect during the early stages of document load. Changing the
attribute dynamically thus has no effect (and thus, no DOM API is
provided for this attribute).
Later base
elements don't affect the resolving of relative URLs in manifest
attributes, as the attributes are processed before those elements
are seen.
head elementhtml element.title element.HTMLElement .The head element collects the
document's metadata.
title elementhead element containing
no other title elements.HTMLElement .The title element represents
the document's title or name. Authors should use titles that
identify their documents even when they are used out of context,
for example in a user's history or bookmarks, or in search results.
The document's title is often different from its first header,
since the first header does not have to stand alone when taken out
of context.
There must be no more than one title element per document.
The title element must not
contain any elements.
Here are some examples of appropriate titles, contrasted with the top-level headers 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 header assumes the reader knowns 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 DOM attribute. User
agents should use the document's title when referring to the
document in their user interface.
base elementhead element containing
no other base elements.hreftarget
interface HTMLBaseElement : HTMLElement {
attribute DOMString href;
attribute DOMString target;
};
The base element allows authors
to specify the document base URL for the
purposes of resolving
relative URLs , and the name of the default browsing context for the purposes of following hyperlinks .
There must be no more than one base element per document.
A base element must have either
an href
attribute, a target attribute, or both.
The href content attribute, if
specified, must contain a valid URL .
A base element, if it has an
href
attribute, must come before any other elements in the tree that
have attributes defined as taking URLs , except the html
element (its manifest attribute isn't affected by
base elements).
If there are multiple base elements with href attributes, all
but the first are ignored.
The target attribute, if
specified, must contain a valid browsing context
name or keyword . User agents use this name when following hyperlinks .
A base element, if it has a
target
attribute, must come before any elements in the tree that represent
hyperlinks .
If there are multiple base elements with target attributes,
all but the first are ignored.
The href and target DOM attributes
must reflect the content attributes of the
same name.
link elementnoscript element that
is a child of a head element.hrefrelmediahreflangtypesizestitle attribute has special semantics on this
element.
interface HTMLLinkElement : HTMLElement {
attribute boolean disabled;
attribute DOMString href;
attribute DOMString rel;
readonly attribute DOMTokenList relList;
attribute DOMString media;
attribute DOMString hreflang;
attribute DOMString type;
attribute DOMString sizes;
};
The LinkStyle interface must also be implemented by
this element, the styling processing model
defines how. [CSSOM]
The link element allows authors
to link their document to other resources.
The destination of the link is given by the href attribute, which
must be present and must contain a valid URL .
If the href attribute is absent, then the element does
not define a link.
The type of link indicated (the relationship) is given by the
value of the rel attribute, which must be
present, and must have a value that is a set of
space-separated tokens . The allowed
values and their meanings are defined in a later section. If
the rel
attribute is absent, or if the value used is not allowed according
to the definitions in this specification, then the element does not
define a link.
Two categories of links can be created using the link element. Links to external resources are
links to resources that are to be used to augment the current
document, and hyperlink
links are links to
other documents . The link types
section defines whether a particular link type is an external
resource or a hyperlink. One 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 attribute. User agents must process the links
on a per-link basis, not a per-element basis.
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. (However, user agents may opt to only fetch such resources when they are needed, instead of pro-actively downloading all the external resources that are not applied.)
HTTP semantics must be followed when fetching external resources. (For example, redirects must be followed and 404 responses must cause the external resource to not be applied.)
Interactive user agents should provide users with a means to
follow the
hyperlinks created using the link element, somewhere within their user
interface. The exact interface is not defined by this
specification, but it should 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 element in
the document:
rel
attribute)title
attribute).href attribute).hreflang
attribute).media
attribute).User agents may also include other information, such as the type
of the resource (as given by the type attribute).
Hyperlinks created with the link element and its rel attribute apply to
the whole page. This contrasts with the rel attribute of
a and area 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 . [MQ]
If the link is a hyperlink then the media attribute is
purely advisory, and describes for which media the document in
question was designed.
However, if the link is an external resource
link , then the media attribute is prescriptive. The user
agent must apply the external resource to views while
their state match the listed media and the other relevant
conditions apply, and must not apply them otherwise.
The default, if the media attribute is
omitted, is all , meaning that by default links apply
to all media.
The hreflang attribute on the
link element has the same
semantics as the hreflang attribute on
hyperlink elements .
The type attribute gives the MIME
type of the linked resource. It is purely advisory. The value must
be a valid MIME type, optionally with parameters. [RFC2046]
For external
resource links , the type attribute is used as a hint to user agents
so that they can avoid downloading resources they do not support.
If the attribute is present, then the user agent must assume that
the resource is of the given type. 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 for the given link
relationship, then the UA should not download the resource; if the
UA does support the given MIME type for the given link
relationship, then the UA should download the resource. If the
attribute is omitted, and the external resource link type does not
have a default type defined, but the user agent would fetch the
resource if the type was known and supported, then the user agent
should fetch the resource under the assumption that it will be
supported.
User agents must not consider the type attribute
authoritative — upon fetching the resource, user agents must not
use the type 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 resource is expected to be an image, user agents may apply the image sniffing rules , with the official type being the type determined from the resource's Content-Type metadata , and use the resulting sniffed type of the resource as if it was the actual type. Otherwise, if the resource is not expected to be an image, or if the user agent opts not to apply those rules, then the user agent must use the resource's Content-Type metadata 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.
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">
...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 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 the two files was returned without a Content-Type metadata, or with a syntactically
incorrect type like Content-Type: "null"
, then the default type for stylesheet 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
attribute defines alternative style sheet
sets .
The title attribute on link elements differs from the global
title
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 attribute is used with the icon link type. The
attribute must not be specified on link elements that do not have a rel attribute that
specifies the icon keyword.
Some versions of HTTP defined a Link:
header, to be processed like a series of link 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.) [RFC2616] [RFC2068]
The DOM attributes href , rel , media , hreflang , and
type , and
sizes
each must reflect the respective content
attributes of the same name.
The DOM attribute relList must reflect the rel content attribute.
The DOM attribute disabled only applies to
style sheet links. When the link
element defines a style sheet link, then the disabled
attribute behaves as defined for the alternative style sheets DOM .
For all other link elements it
always return false and does nothing on setting.
meta elementcharset attribute is present, or if the
element is in the Encoding declaration state
: as the first element in a head
element.http-equiv attribute is present, and the
element is not in the Encoding declaration state
: in a head element.http-equiv attribute is present, and the
element is not in the Encoding declaration state
: in a noscript element that
is a child of a head element.name attribute is present: where metadata content is expected.namehttp-equivcontentcharset ( HTML only)
interface HTMLMetaElement : HTMLElement {
attribute DOMString content;
attribute DOMString name;
attribute DOMString httpEquiv;
};
The meta element represents
various kinds of metadata that cannot be expressed using the
title , base , link ,
style , and script elements.
The meta element can represent
document-level metadata with the name attribute, pragma
directives with the http-equiv attribute, and the file's
character encoding declaration when an
HTML document is serialized to string form (e.g. for transmission
over the network or for disk storage) with the charset
attribute.
Exactly one of the name , http-equiv
, and charset attributes must be specified.
If either name or http-equiv
is specified, then the content attribute must also be specified.
Otherwise, it must be omitted.
The charset attribute specifies
the character encoding used by the document. This is called a
character encoding declaration .
The charset attribute may be specified in
HTML documents only, it must not
be used in XML documents . If
the charset attribute is specified, the element
must be the first element in the
head element of the file.
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 element has a
name
attribute, it sets document metadata. Document metadata is
expressed in terms of name/value pairs, the name attribute on the
meta element giving the name, and
the content 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
element has no content attribute, then the value part of
the metadata name/value pair is the empty string.
If a meta element has the
http-equiv attribute specified, it must
be either in a head element or in
a noscript element that itself
is in a head element. If a
meta element does not have the
http-equiv attribute specified, it must
be in a head element.
The DOM attributes name and content must reflect the respective content attributes of the
same name. The DOM attribute httpEquiv must reflect the content attribute http-equiv
.
This specification defines a few names for the name attribute of the
meta element.
The value must be a short free-form string that giving the name
of the Web application that the page represents. If the page is not
a Web application, the application-name metadata name must
not be used. User agents may use the application name in UI in
preference to the page's title ,
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.
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.
The value must be a free-form string that identifies the software used to generate the document. This value must not be used on hand-authored pages.
Extensions to the predefined set of metadata names may be registered in the WHATTF Wiki MetaExtensions page .
Anyone is free to edit the WHATTF Wiki MetaExtensions page at any time to add a type. These new names must be specified with the following information:
The actual name being defined. The name should not be confusingly similar to any other defined name (e.g. differing only in case).
A short description of what the metadata name's meaning is, including the format the value is required to be in.
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.
One of the following:
If a metadata name is added with the "proposal" status and found to be redundant with existing values, it should be removed and listed as a synonym for the existing value.
Conformance checkers must use the information given on the WHATTF Wiki MetaExtensions page to establish if a value not explicitly defined in this specification is allowed or not. 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 "proposal" status.
This specification does not define how new values will get approved. It is expected that the Wiki will have a community that addresses this.
Metadata names whose values are to be URLs must not be proposed or accepted. Links must be
represented using the link
element, not the meta
element.
When the http-equiv attribute is
specified on a meta element, the
element is a pragma directive.
The http-equiv attribute is
an enumerated attribute . 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.
| State | Keywords |
|---|---|
| Encoding declaration | Content-Type |
| Default style | default-style |
| Refresh | refresh |
When a meta element is
inserted into the document, if its http-equiv
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:
The Encoding declaration
state's user agent requirements are all handled by the parsing
section of the specification. The state is just an alternative form
of setting the charset attribute:
it is a character encoding declaration
.
For meta elements in the
Encoding declaration state
, the content attribute must have a value that is
a case-insensitive match of a string that consists of the literal
string " text/html; ", optionally followed by
any number of space
characters , followed by the literal string " charset= ", followed by the character encoding name of
the character encoding declaration .
If the document contains a meta element in the Encoding declaration state
then that element must be the first element in the document's
head element, and the document
must not contain a meta element
with the charset attribute present.
The Encoding declaration state may be used in HTML documents only, elements in that state must not be used in XML documents .
If another meta element in the
Refresh
state 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 element has no
content 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 attribute.
Let position point at the first character of input .
Collect a sequence of characters in the range U+0030 DIGIT ZERO to U+0039 DIGIT NINE, and parse the resulting string using the rules for parsing non-negative integers . 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 in the range U+0030 DIGIT ZERO to U+0039 DIGIT NINE
and U+002E FULL STOP (" . "). Ignore any
collected characters.
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.
If the character in input pointed to by position is one of U+0055 LATIN CAPITAL LETTER U or U+0075 LATIN SMALL LETTER U, then advance position to the next character. Otherwise, jump to the last step.
If the character in input pointed to by position is one of U+0052 LATIN CAPITAL LETTER R or U+0072 LATIN SMALL LETTER R, then advance position to the next character. Otherwise, jump to the last step.
If the character in input pointed to by position is one of U+004C LATIN CAPITAL LETTER L or U+006C LATIN SMALL LETTER L, 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+003D EQUALS SIGN ("
= "), then advance position to the next character. Otherwise, jump to the
last step.
Let url be equal to the substring of input from the character at position to the end of the string.
Strip any trailing space characters 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 the
url value to an absolute
URL . (For the purposes of determining the base URL , the url value comes
from the value of a content attribute of the meta element.) If this fails, abort these
steps.
Perform one or more of the following steps:
Set a timer so that in time seconds, adjusted to take into account user or user agent preferences, if the user has not canceled the redirect, the user agent navigates the document's browsing context to url , with replacement enabled , and with the document's browsing context as the source browsing context .
Provide the user with an interface that, when selected, navigates a browsing context to url , with the document's browsing context as the source browsing context .
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 elements in the
Refresh
state , the content attribute must have a value
consisting either of:
; ), followed by one
or more space
characters , followed by either a U+0055 LATIN CAPITAL LETTER U
or a U+0075 LATIN SMALL LETTER U, a U+0052 LATIN CAPITAL LETTER R
or a U+0072 LATIN SMALL LETTER R, a U+004C LATIN CAPITAL LETTER L
or a U+006C LATIN SMALL LETTER L, a U+003D EQUALS SIGN (
= ), and then a valid
URL .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 .
There must not be more than one meta element with any particular state in the
document at a time.
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:
If the document does not start with a BOM, and if its encoding
is not explicitly given by Content-Type metadata , then the character
encoding used must be an ASCII-compatible character encoding , and,
in addition, if that encoding isn't US-ASCII itself, then the
encoding must be specified using a meta element with a charset
attribute or a meta element in
the Encoding declaration state
.
If the document contains a meta element with a charset
attribute or a meta element in
the Encoding declaration state
, then the character encoding used must be an ASCII-compatible character encoding .
An ASCII-compatible character encoding is one that is a superset of US-ASCII (specifically, ANSI_X3.4-1968) for bytes in the set 0x09, 0x0A, 0x0C, 0x0D, 0x20 - 0x22, 0x26, 0x27, 0x2C - 0x3F, 0x41 - 0x5A, and 0x61 - 0x7A .
Authors should not use JIS_X0212-1990, x-JIS0208, and encodings based on EBCDIC. Authors should not use UTF-32. Authors must not use the CESU-8, UTF-7, BOCU-1 and SCSU encodings. [CESU8] [UTF7] [BOCU1] [SCSU]
Authors are encouraged to use UTF-8. Conformance checkers may advise against authors using legacy encodings.
In XHTML, the XML declaration should be used for inline character encoding information, if necessary.
style elementscoped attribute is present: flow content .scoped attribute is absent: where metadata content is expected.scoped attribute is absent: in a
noscript element that is a
child of a head element.scoped attribute is present: where flow content is expected, but before any
sibling elements other than style elements and before any text nodes other
than inter-element whitespace .type attribute.mediatypescopedtitle attribute has special semantics on this
element.
interface HTMLStyleElement : HTMLElement {
attribute boolean disabled;
attribute DOMString media;
attribute DOMString type;
attribute boolean scoped;
};
The LinkStyle interface must also be implemented by
this element, the styling processing model
defines how. [CSSOM]
The style element allows
authors to embed style information in their documents. The
style element is one of several
inputs to the styling processing model
.
If the type attribute is given, it
must contain a valid MIME type, optionally with parameters, that
designates a styling language. [RFC2046]
If the attribute is absent, the type defaults to
text/css . [RFC2138]
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 media attribute says which
media the styles apply to. The value must be a valid media query . [MQ] User agents must
apply the styles to views while their state match the
listed media, and must not apply them otherwise. [DOM3VIEWS]
The default, if the media attribute is
omitted, is all , meaning that by default styles apply
to all media.
The scoped attribute is a
boolean attribute . If the attribute is
present, then the user agent must apply the specified style
information only to the style
element's parent element (if any), and that element's child nodes.
Otherwise, the specified styles must, if applied, be applied to the
entire document.
The title attribute on
style elements defines alternative style sheet sets . If the
style element has no
title
attribute, then it has no title; the title attribute of
ancestors does not apply to the style element.
The title attribute on style elements, like the title attribute on
link elements, differs from the
global title
attribute in that a style block
without a title does not inherit the title of the parent element:
it merely has no title.
All descendant elements must be processed, according to their
semantics, before the style
element itself is evaluated. For styling languages that consist of
pure text, user agents must evaluate style elements by passing the concatenation of
the contents of all the text
nodes that are direct children of the style element (not any other nodes such as
comments or elements), in tree order , to
the style system. For XML-based styling languages, user agents must
pass all the children nodes of the style element to the style system.
This specification does not specify a style system, but CSS is expected to be supported by most Web browsers. [CSS21]
The media , type and scoped DOM attributes
must reflect the respective content
attributes of the same name.
The DOM disabled attribute behaves
as defined for
the alternative style sheets DOM .
The link and style 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]
The style and link elements implement the
LinkStyle interface. [CSSOM]
For style 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 elements that do
not represent external
resource links that contribute to the styling processing model
(i.e. that do not have a stylesheet keyword in their rel attribute), and
link elements whose specified
resource has not yet been downloaded, 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 attributes implemented as
follows: [CSSOM]
type DOM attribute)The content type must be the same as the style's specified type.
For style elements, this is the
same as the type content attribute's value, or text/css if that is omitted. For link elements, this is the Content-Type metadata of the
specified resource .
href
DOM attribute)For link elements, the location
must be the result of resolving the URL given by
the element's href content attribute, or the empty string if
that fails. For style elements,
there is no location.
media DOM attribute)The media must be the same as the value of the element's
media content attribute.
title DOM attribute)The title must be the same as the value of the element's
title content attribute. If the attribute is
absent, then the style sheet does not have a title. The title is
used for defining alternative style sheet
sets .
The disabled DOM attribute
on link and style 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.
Some elements, for example address elements, are scoped to their nearest
ancestor sectioning content . For such
elements x , the elements that apply to a
sectioning content element e are all the x elements whose nearest
sectioning content ancestor is
e .
body elementhtml element.
interface
HTMLBodyElement
:
HTMLElement
{};
The body element represents
the main content of the document.
In conforming documents, there is only one body element. The document.body DOM
attribute provides scripts with easy access to a document's
body element.
Some DOM operations (for example, parts of the
drag and drop model) are defined in terms
of " the body element ". This refers to a
particular element in the DOM, as per the definition of the term,
and not any arbitrary body
element.
section elementHTMLElement .The section element
represents a generic document or application section. A section, in
this context, is a thematic grouping of content, typically with a
header, possibly with a footer.
Examples of sections would be chapters, the various tabbed pages in a tabbed dialog box, or the numbered sections of a thesis. A Web site's home page could be split into sections for an introduction, news items, contact information.
nav elementHTMLElement .The nav element represents 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 element —
only sections that consist of primary navigation blocks are
appropriate for the nav element. In
particular, it is common for footers to have a list of links to
various key parts of a site, but the footer element is more appropriate in such
cases.
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>
</header>
<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>
<article>
<p>...page content would be here...</p>
</article>
<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>
article elementHTMLElement .The article element
represents a section of a page that consists of a composition that
forms an independent part of a document, page, or site. This could
be a forum post, a magazine or newspaper article, a Web log entry,
a user-submitted comment, or any other independent item of
content.
An article
element is "independent" in that its contents could stand alone,
for example in syndication. However, the element is still
associated with its ancestors; for instance, contact information
that applies to a parent
body element still covers the
article as well.
When article elements are
nested, the inner article
elements represent articles that are in principle related to the
contents of the outer article. For instance, a Web log entry on a
site that accepts user-submitted comments could represent the
comments as article elements
nested within the article
element for the Web log entry.
Author information associated with an article element (q.v. the address element) does not apply to nested
article elements.
aside elementHTMLElement .The aside element represents a
section of a page that consists of content that is tangentially
related to the content around the aside element, and which could be considered
separate from that content. Such sections are often represented as
sidebars in printed typography.
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> ...
h1 , h2 ,
h3 , h4 , h5 ,
and h6 elementsHTMLElement .These elements define headers for their sections.
The semantics and meaning of these elements are defined in the section on headings and sections .
These elements have a rank given by the
number in their name. The h1 element
is said to have the highest rank, the h6 element has the lowest rank, and two elements
with the same name have equal rank.
header elementheader element descendants,
and no footer element
descendants.HTMLElement .The header element represents
the header of a section. The element is typically used to group a
set of h1 – h6 elements to mark up a page's title with its
subtitle or tagline. However, header elements may contain more than just the
section's headings and subheadings — for example it would be
reasonable for the header to include version history
information.
For the purposes of document summaries, outlines, and the like,
header elements are equivalent
to the highest ranked
h1 – h6 element descendant of the header element (the first such element if
there are multiple elements with that rank
).
Other heading elements in the header element indicate subheadings or
subtitles.
The rank of a header element is the same as for an
h1 element (the highest rank).
The section on headings and sections
defines how header elements are
assigned to individual sections.
Here are some examples of valid headers. In each case, the emphasised text represents the text that would be used as the header in an application extracting header data and ignoring subheadings.
<header> <h1>The reality dysfunction</h1> <h2>Space is not the only void</h2> </header>
<header> <h1>Dr. Strangelove</h1> <h2>Or: How I Learned to Stop Worrying and Love the Bomb</h2> </header>
<header> <p>Welcome to...</p> <h1>Voidwars!</h1> </header>
<header> <h1>Scalable Vector Graphics (SVG) 1.2</h1> <h2>W3C Working Draft 27 October 2004</h2> <dl> <dt>This version:</dt> <dd><a href="http://www.w3.org/TR/2004/WD-SVG12-20041027/">http://www.w3.org/TR/2004/WD-SVG12-20041027/</a></dd> <dt>Previous version:</dt> <dd><a href="http://www.w3.org/TR/2004/WD-SVG12-20040510/">http://www.w3.org/TR/2004/WD-SVG12-20040510/</a></dd> <dt>Latest version of SVG 1.2:</dt> <dd><a href="http://www.w3.org/TR/SVG12/">http://www.w3.org/TR/SVG12/</a></dd> <dt>Latest SVG Recommendation:</dt> <dd><a href="http://www.w3.org/TR/SVG/">http://www.w3.org/TR/SVG/</a></dd> <dt>Editor:</dt> <dd>Dean Jackson, W3C, <a href="mailto:dean@w3.org">dean@w3.org</a></dd> <dt>Authors:</dt> <dd>See <a href="#authors">Author List</a></dd> </dl> <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notic ... </header>
footer elementfooter element descendants.HTMLElement .The footer element represents
the footer for the section it applies
to. A footer typically contains information about its section such
as who wrote it, links to related documents, copyright data, and
the like.
Contact information for the section given in a footer should be marked up using the
address element.
Footers don't necessarily have to appear at the end of a section, though they usually do.
Here is a page with two footers, one at the top and one at the bottom, with the same content:
<body> <footer><a href="../">Back to index...</a></footer> <h1>Lorem ipsum</h1> <p>A dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in 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>
address elementfooter element descendants, and
no address element
descendants.HTMLElement .The address element
represents the contact information for the section it applies to. If it applies to the body element , then it instead
applies to the document as a whole.
For example, a page at the W3C Web site related to HTML might include the following contact information:
<ADDRESS> <A href="../People/Raggett/">Dave Raggett</A>, <A href="../People/Arnaud/">Arnaud Le Hors</A>, contact persons for the <A href="Activity">W3C HTML Activity</A> </ADDRESS>
The address element must not
be used to represent arbitrary addresses (e.g. postal addresses),
unless those addresses are contact information for the section.
(The p element is the appropriate
element for marking up such addresses.)
The address element must not
contain information other than contact information.
For example, the following is non-conforming use of the
address element:
<ADDRESS> Last Modified: 1999/12/24 23:37:50</ADDRESS>
Typically, the address
element would be included with other information in a
footer element.
To determine the contact information for a sectioning content element (such as a document's
body element, which would give
the contact information for the page), UAs must collect all the
address elements that apply to that sectioning content element and its ancestor
sectioning content elements. The contact
information is the collection of all the information given by those
elements.
Contact information for one sectioning content element, e.g. an
aside element, does not apply to
its ancestor elements, e.g. the page's body .
The h1 – h6 elements and the header element are headings.
The first element of heading content in an element of sectioning content gives the header for that section. Subsequent headers of equal or higher rank start new (implied) sections, headers of lower rank start subsections that are part of the previous one.
Sectioning content elements are always considered subsections of their nearest ancestor element of sectioning content , regardless of what implied sections other headings may have created.
Certain elements are said to be sectioning roots , including blockquote and td elements. These elements can have their own
outlines, but the sections and headers inside these elements do not
contribute to the outlines of their ancestors.
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>
...the structure would be:
body
section, containing the "Grunt" paragraph)
section section)Notice how the section ends
the earlier implicit section so that a later paragraph ("Grunt") is
back at the top level.
Sections may contain headers of any rank ,
but authors are strongly encouraged to either use only
h1 elements, or to use elements of
the appropriate rank for the section's nesting
level.
Authors are also encouraged to explicitly wrap sections in elements of sectioning content , instead of relying on the implicit sections generated by having multiple heading in one element of sectioning content .
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 section defines an algorithm for creating an outline for a sectioning content element or a sectioning root 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 element or a sectioning root element consists of a list of
one or more potentially nested sections . 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 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 node (and thus the entire
document):
Section created for body
node.
Associated with heading "A".
Also associated with paragraph "B".
Nested sections:
The algorithm that must be followed during a walk of a DOM subtree rooted at a sectioning content element or a sectioning root element to determine that element's outline is as follows:
Let current outlinee be null. (It holds the element whose outline is being created.)
Let current section be null. (It holds a pointer to a section , 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 , trigger the first relevant step below for each element as you enter and exit it.
The element being exited is a heading content element.
Pop that element from the stack.
Do nothing.
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 for the current outlinee element.
Let there be a new outline for the new current outlinee , initialized with just the new current section as the only section in the outline.
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 of the current outlinee element.
Append the outline of the sectioning content element being exited to the current section . (This does not change which section is the last section in the outline .)
Run these steps:
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 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 of the current current section .
Go back to the substep labeled finding the deepest child .
The current outlinee is the element being exited.
Let current section be the first section in the outline of the current outlinee element.
Skip to the next step in the overall set of steps. (The walk is over.)
Do nothing.
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 equal to or greater than the heading of the last section of the outline of the current outlinee , then create a new section and append it to the outline 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:
Let candidate section be current section .
If the element being entered has a rank lower than the rank of the heading of the candidate section , then create a new section , 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 that contains candidate section in the outline of current outlinee .
Let candidate section be new candidate section .
Return to step 2.
Push the element being entered onto the stack. (This causes the algorithm to skip any descendants of the element.)
Recall that h1 has
the highest rank, and h6
has the lowest rank.
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 current section .
If the current outlinee is null, then there was no sectioning content element or sectioning root element in the DOM. There is no outline . Abort these steps.
Associate any nodes that were not associated a section in the steps above with current outlinee as their section.
Associate all nodes with the heading of the section with which they are associated, if any.
If current outlinee is the body element , then the outline
created for that element is the outline of
the entire document.
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 element, if the section was created for a real element in the original document, or to the relevant heading content element, if the section in the tree was generated for a heading in the above process.
Selecting the first section of the document therefore always
takes the user to the top of the document, regardless of where the
first header in the body is to be
found.
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]
function (root, enter, exit) {
var node = root;
start: do 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;
}
}
}
Given the outline of a document, but
ignoring any sections created for nav and aside
elements, and any of their descendants, if the only root of the
tree is the body element 's
section , and it
has only a single subsection which is created by an article element, then the heading of the body element should be assumed to
be a site-wide heading, and the heading of the article element should be assumed to be the
page's heading.
If a page starts with a heading that is common to the whole
site, the document must be authored such that, in the document's
outline , ignoring any sections created for
nav and aside elements and any of their descendants,
the tree has only one root section , the
body element 's section, its heading is the
site-wide heading, the body
element has just one subsection, that subsection is created by
an article element, and that
article 's heading is the page
heading.
If a page does not contain a site-wide heading, then the page
must be authored such that, in the document's outline , ignoring any sections created for
nav and aside elements and any of their descendants,
either the body element has
no subsections, or it has more than one subsection, or it has a
single subsection but that subsection is not created by an
article element, or there is
more than one section at the root of the outline.
Conceptually, a site is thus a document with many articles — when those articles are split into many pages, the heading of the original single page becomes the heading of the site, repeated on every page.
p elementHTMLElement .The p element represents a
paragraph .
The following examples are conforming HTML fragments:
<p>The little kitten gently seated himself on a piece of carpet. Later in his life, this would be referred to as the time the cat sat on the mat.</p>
<fieldset> <legend>Personal information</legend> <p> <label>Name: <input name="n"></label> <label><input name="anon" type="checkbox"> Hide from other users</label> </p> <p><label>Address: <textarea name="a"></textarea></label></p> </fieldset>
<p>There was once an example from Femley,<br> Whose markup was of dubious quality.<br> The validator complained,<br> So the author was pained,<br> To move the error from the markup to the rhyming.</p>
The p element should not be used
when a more specific element is more appropriate.
The following example is technically correct:
<section> <!-- ... --> <p>Last modified: 2001-04-23</p> <p>Author: fred@example.com</p> </section>
However, it would be better marked-up as:
<section> <!-- ... --> <footer>Last modified: 2001-04-23</footer> <address>Author: fred@example.com</address> </section>
Or:
<section> <!-- ... --> <footer> <p>Last modified: 2001-04-23</p> <address>Author: fred@example.com</address> </footer> </section>
hr elementHTMLElement .The hr element represents a
paragraph -level thematic break, e.g. a
scene change in a story, or a transition to another topic within a
section of a reference book.
br elementHTMLElement .The br element represents a line
break.
br elements must be empty. Any
content inside br elements must not
be considered part of the surrounding text.
br 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 element:
<p>P. Sherman<br> 42 Wallaby Way<br> Sydney</p>
br elements must not be used for
separating thematic groups in a paragraph.
The following examples are non-conforming, as they abuse the
br element:
<p><a ...>34 comments.</a><br> <a ...>Add a comment.<a></p>
<p>Name: <input name="name"><br> Address: <input name="address"></p>
Here are alternatives to the above, which are correct:
<p><a ...>34 comments.</a></p> <p><a ...>Add a comment.<a></p>
<p>Name: <input name="name"></p> <p>Address: <input name="address"></p>
If a paragraph consists of nothing but
a single br element, it represents a
placeholder blank line (e.g. as in a template). Such blank lines
must not be used for presentation purposes.
pre elementHTMLElement .The pre element represents a
block of preformatted text, in which structure is represented by
typographic conventions rather than by elements.
In the HTML
serialization , a leading newline character immediately
following the pre element start tag
is stripped.
Some examples of cases where the pre element could be used:
To represent a block of computer code, the pre element can be used with a code element; to represent a block of computer
output the pre element can be used
with a samp element. Similarly,
the kbd element can be used within
a pre element to indicate text that
the user is to enter.
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>
In the following snippet, samp
and kbd elements are mixed in the
contents of a pre 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 element to preserve its unusual
formatting, which forms an intrinsic part of the poem itself.
<pre> maxling
it is with a heart
heavy
that i admit loss of a feline
so loved
a friend lost to the
unknown
(night)
~cdr
11dec07</pre>
dialog elementdt
element followed by one dd
element.HTMLElement .The dialog element represents
a conversation.
Each part of the conversation must have an explicit talker (or
speaker) given by a dt element, and
a discourse (or quote) given by a dd
element.
This example demonstrates this using an extract from Abbot and Costello's famous sketch, Who's on first :
<dialog> <dt> Costello <dd> Look, you gotta first baseman? <dt> Abbott <dd> Certainly. <dt> Costello <dd> Who's playing first? <dt> Abbott <dd> That's right. <dt> Costello <dd> When you pay off the first baseman every month, who gets the money? <dt> Abbott <dd> Every dollar of it. </dialog>
Text in a dt element
in a dialog element is
implicitly the source of the text given in the following
dd element, and the contents of the
dd element are implicitly a quote
from that speaker. There is thus no need to include cite , q , or
blockquote elements in this
markup. Indeed, a q element inside a
dd element in a conversation would
actually imply the people talking were themselves quoting another
work. See the cite ,
q , and blockquote elements for other ways to cite
or quote.
blockquote elementcite
interface HTMLQuoteElement : HTMLElement {
attribute DOMString cite;
};
The HTMLQuoteElement interface is also
used by the q element.
The blockquote element
represents a section that is quoted from another source.
Content inside a blockquote must be quoted from another
source, whose address, if it has one, should be cited in the
cite
attribute.
If the cite attribute is present, it must be a valid URL . User agents should allow users to follow
such citation links.
If a blockquote element
is preceded or followed by a single
paragraph that contains a single
cite element and that is itself
not preceded or followed by another
blockquote element and does
not itself have a q element
descendant, then, the title of the work given by that
cite element gives the source of
the quotation contained in the blockquote element.
The cite DOM attribute must
reflect the element's cite content attribute.
The best way to represent a conversation is not
with the cite and blockquote elements, but with the
dialog element.
ol elementli elements.reversedstart
interface HTMLOListElement : HTMLElement {
attribute boolean reversed;
attribute long start;
};
The ol element represents 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
element child nodes of the ol
element, in tree order .
The reversed attribute is a
boolean attribute . 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 giving the ordinal
value of the first list item.
If the start attribute is present, user agents must
parse it as an
integer , 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
attribute, and is the number of child li elements otherwise.
The first item in the list has the ordinal value given by the
ol element's start attribute,
unless that li element has a
value
attribute with a value that can be successfully parsed, in which
case it has the ordinal value given by that value attribute.
Each subsequent item in the list has the ordinal value given by
its value
attribute, if it has one, or, if it doesn't, the ordinal value of
the previous item, plus one if the reversed is
absent, or minus one if it is present.
The reversed DOM attribute must
reflect the value of the reversed content
attribute.
The start DOM attribute must reflect the value of the start content
attribute.
The following markup shows a list where the order matters, and
where the ol element is therefore
appropriate. Compare this list to the equivalent list in the
ul section to see an example of the
same items using the ul element.
<p>I have lived in the following countries (given in the order of when I first lived there):</p> <ol> <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>
ul elementli elements.HTMLElement .The ul element represents a list
of items, where the order of the items is not important — that is,
where changing the order would not materially change the meaning of
the document.
The items of the list are the li
element child nodes of the ul
element.
The following markup shows a list where the order does not
matter, and where the ul element is
therefore appropriate. Compare this list to the equivalent list in
the ol section to see an example of
the same items using the ol
element.
<p>I have lived in the following countries:</p> <ul> <li>Norway <li>Switzerland <li>United Kingdom <li>United States </ul>
Note that changing the order of the list does not change the meaning of the document. The items in the snippet above are given in alphabetical order, but in the snippet below they are given in order of the size of their current account balance in 2007, without changing the meaning of the document whatsoever:
<p>I have lived in the following countries:</p> <ul> <li>Switzerland <li>Norway <li>United Kingdom <li>United States </ul>
li elementol elements.ul elements.menu elements.menu element: phrasing
content .ol element: valueol element: None.
interface HTMLLIElement : HTMLElement {
attribute long value;
};
The li element represents a list
item. If its parent element is an ol
, ul , or menu 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 element.
The value attribute, if present,
must be a valid integer giving the ordinal
value of the list item.
If the value attribute is present, user agents must
parse it as an
integer , 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 attribute is processed relative to the
element's parent ol element (q.v.),
if there is one. If there is not, the attribute has no effect.
The value DOM attribute must reflect the value of the value 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 element and its
legend .
<figure> <legend>The top 10 movies of all time</legend> <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 attribute on the ol element:
<figure> <legend>The top 10 movies of all time</legend> <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>
dl elementdt elements followed by one or mode
dd elements.HTMLElement .The dl element introduces an
association list consisting of zero or more name-value groups (a
description list). Each group must consist of one or more names (
dt elements) followed by one or more
values ( dd elements).
Name-value groups may be terms and definitions, metadata topics and values, or any other groups of name-value data.
The values within a group are alternatives; multiple paragraphs
forming part of the same value must all be given within the same
dd element.
The order of the list of groups, and of the names and values within each group, may be significant.
If a dl element is empty, it
contains no groups.
If a dl element contains non-
whitespace text nodes , or elements other than
dt and dd , then those elements or text nodes do not form part of any groups in
that dl .
If a dl element contains only
dt elements, then it consists of one
group with names but no values.
If a dl element contains only
dd elements, then it consists of one
group with values but no names.
If a dl element starts with one
or more dd elements, then the first
group has no associated name.
If a dl element ends with one or
more dt elements, then the last
group has no associated value.
When a dl element
doesn't match its content model, it is often due to accidentally
using dd elements in the place of
dt elements and vice versa.
Conformance checkers can spot such mistakes and might be able to
advise authors how to correctly use the markup.
In the following example, one entry ("Authors") is linked to two values ("John" and "Luke").
<dl> <dt> Authors <dd> John <dd> Luke <dt> Editor <dd> Frank </dl>
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>
The following example illustrates the use of the dl 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> Last modified time </dt> <dd> 2004-12-23T23:33Z </dd> <dt> Recommended update interval </dt> <dd> 60s </dd> <dt> Authors </dt> <dt> Editors </dt> <dd> Robert Rothman </dd> <dd> Daniel Jackson </dd> </dl>
The following example shows the dl 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
element being used as a glossary. Note the use of dfn 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>
The dl element is
inappropriate for marking up dialogue, since dialogue is ordered
(each speaker/line pair comes after the next). For an example of
how to mark up dialogue, see the dialog element.
dt elementdd or dt elements inside dl elements.dd element inside a
dialog element.HTMLElement .The dt element represents the
term, or name, part of a term-description group in a description
list ( dl element), and the talker,
or speaker, part of a talker-discourse pair in a conversation (
dialog element).
The dt element
itself, when used in a dl element,
does not indicate that its contents are a term being defined, but
this can be indicated using the dfn
element.
If the dt element is the child of
a dialog element, and it further
contains a time element, then that
time element represents a
timestamp for when the associated discourse ( dd element) was said, and is not part of the name
of the talker.
The following extract shows how an IM conversation log could be marked up.
<dialog> <dt> <time>14:22</time> egof <dd> I'm not that nerdy, I've only seen 30% of the star trek episodes <dt> <time>14:23</time> kaj <dd> if you know what percentage of the star trek episodes you have seen, you are inarguably nerdy <dt> <time>14:23</time> egof <dd> it's unarguably <dt> <time>14:24</time> kaj <dd> you are not helping your case </dialog>
dd elementdt or dd elements inside dl elements.dt element inside a
dialog element.HTMLElement .The dd element represents the
description, definition, or value, part of a term-description group
in a description list ( dl element),
and the discourse, or quote, part in a conversation (
dialog element).
a elementhreftargetpingrelmediahreflangtype
[Stringifies=href] interface HTMLAnchorElement : HTMLElement {
attribute DOMString href;
attribute DOMString target;
attribute DOMString ping;
attribute DOMString rel;
readonly attribute DOMTokenList relList;
attribute DOMString media;
attribute DOMString hreflang;
attribute DOMString type;
};
The Command interface must also be implemented
by this element.
If the a element has an
href
attribute, then it represents a hyperlink
.
If the a element has no
href
attribute, then the element is a placeholder for where a link might
otherwise have been placed, if it had been relevant.
The target , ping ,
rel ,
media , hreflang
, and type attributes must be omitted if the
href
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 element:
<nav> <ul> <li> <a href="/">Home</a> </li> <li> <a href="/news">News</a> </li> <li> <a>Examples</a> </li> <li> <a href="/legal">Legal</a> </li> </ul> </nav>
Interactive user agents should allow users to follow hyperlinks
created using the a element. The
href
, target and ping attributes
decide how the link is followed. The rel , media ,
hreflang , and type 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 of
a elements that represent
hyperlinks is to run the following steps:
If the DOMActivate event
in question is not trusted (i.e. a click() method call was
the reason for the event being dispatched), and the a element's target
attribute is ... then raise an
INVALID_ACCESS_ERR exception and abort these
steps.
If the target of the DOMActivate event is an img element with an ismap attribute
specified, then server-side image map processing must be performed,
as follows:
DOMActivate event
was dispatched as the result of a real pointing-device-triggered
click event on the img element, then let x be
the distance in CSS pixels from the left edge of the image to the
location of the click, and let y be the
distance in CSS pixels from the top edge of the image to the
location of the click. Otherwise, let x and
y be zero.Finally, the user agent must follow the hyperlink defined by the
a element. If the steps above defined
a hyperlink suffix , then take
that into account when following the hyperlink.
One way that a user agent can enable users to
follow hyperlinks is by allowing a
elements to be clicked, or focussed and activated by the keyboard.
This will cause the
aforementioned activation behavior to be
invoked.
The DOM attributes href , ping , target , rel , media , hreflang , and type , must each reflect the respective content attributes of the
same name.
The DOM attribute relList must reflect the rel content
attribute.
q elementciteq element uses the
HTMLQuoteElement
interface.The q element represents some
phrasing content
quoted from another source.
Quotation punctuation (such as quotation marks), if any, must be
placed inside the q element.
Content inside a q element must be
quoted from another source, whose address, if it has one, should be
cited in the cite attribute.
If the cite attribute is present, it must be a
valid URL . User agents should allow users to
follow such citation links.
If a q element is contained
(directly or indirectly) in a paragraph
that contains a single cite
element and has no other q element
descendants, then, the title of the work given by that
cite element gives the source of
the quotation contained in the q
element.
Here is a simple example of the use of the q element:
<p>The man said <q>"Things that are impossible just take longer"</q>. I disagreed with him.</p>
Here is an example with both an explicit citation link in the
q element, and an explicit citation
outside:
<p>The W3C page <cite>About W3C</cite> says the W3C's mission is <q cite="http://www.w3.org/Consortium/">"To lead the World Wide Web to its full potential by developing protocols and guidelines that ensure long-term growth for the Web"</q>. I disagree with this mission.</p>
In the following example, the quotation itself contains a quotation:
<p>In <cite>Example One</cite>, he writes <q>"The man said <q>'Things that are impossible just take longer'</q>. I disagreed with him"</q>. Well, I disagree even more!</p>
In the following example, there are no quotation marks:
<p> His best argument: <q> I disagree!</q> </p>
cite elementHTMLElement .The cite element represents
the title of a work (e.g. a book, a paper, an essay, a poem, a
score, a song, a script, a film, a TV show, a game, a sculpture, a
painting, a theatre production, a play, an opera, a musical, an
exhibition, etc). This can be a work that is being quoted or
referenced in detail (i.e. a citation), or it can just be a work
that is mentioned in passing.
A person's name is not the title of a work — even if people call
that person a piece of work — and the element must therefore not be
used to mark up people's names. (In some cases, the b element might be appropriate for names; e.g. in a
gossip article where the names of famous people are keywords
rendered with a different style to draw attention to them. In other
cases, if an element is really needed, the span element can be used.)
A ship is similarly not a work, and the element must not be used
to mark up ship names (the i element
can be used for that purpose).
This next example shows a typical use of the cite element:
<p>My favourite book is <cite>The Reality Dysfunction</cite> by Peter F. Hamilton. My favourite comic is <cite>Pearls Before Swine</cite> by Stephan Pastis. My favourite track is <cite>Jive Samba</cite> by the Cannonball Adderley Sextet.</p>
This is correct usage:
<p>According to the Wikipedia article <cite>HTML</cite>, as it stood in mid-February 2008, leaving attribute values unquoted is unsafe. This is obviously an over-simplification.</p>
The following, however, is incorrect usage, as the
cite element here is containing
far more than the title of the work:
<!-- do not copy this example, it is an example of bad usage! --> <p>According to <cite>the Wikipedia article on HTML</cite>, as it stood in mid-February 2008, leaving attribute values unquoted is unsafe. This is obviously an over-simplification.</p>
The cite element is obviously
a key part of any citation in a bibliography, but it is only used
to mark the title:
<p><cite>Universal Declaration of Human Rights</cite>, United Nations, December 1948. Adopted by General Assembly resolution 217 A (III).</p>
A citation is not a quote (for
which the q element is
appropriate).
This is incorrect usage, because cite is not for quotes:
<p> <cite> This is wrong!</cite>, said Ian.</p>
This is also incorrect usage, because a person is not a work:
<p> <q> This is still wrong!</q>, said <cite> Ian</cite>.</p>
The correct usage does not use a cite element:
<p> <q> This is correct</q>, said Ian.</p>
As mentioned above, the b 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>
The cite element
can apply to blockquote and
q elements in certain cases described
in the definitions of those elements.
This next example shows the use of cite alongside blockquote :
<p>His next piece was the aptly named <cite>Sonnet 130</cite>:</p> <blockquote> <p>My mistress' eyes are nothing like the sun,<br> Coral is far more red, than her lips red, ...
em elementHTMLElement .The em element represents stress
emphasis of its contents.
The level of emphasis that a particular piece of content has is
given by its number of ancestor em
elements.
The placement of emphasis changes the meaning of the sentence. The element thus forms an integral part of the content. The precise way in which emphasis is used in this way depends on the language.
These examples show how changing the emphasis changes the meaning. First, a general statement of fact, with no emphasis:
<p> Cats are cute animals.</p>
By emphasizing the first word, the statement implies that the kind of animal under discussion is in question (maybe someone is asserting that dogs are cute):
<p> <em> Cats</em> are cute animals.</p>
Moving the emphasis to the verb, one highlights that the truth of the entire sentence is in question (maybe someone is saying cats are not cute):
<p> Cats <em> are</em> cute animals.</p>
By moving it to the adjective, the exact nature of the cats is reasserted (maybe someone suggested cats were mean animals):
<p> Cats are <em> cute</em> animals.</p>
Similarly, if someone asserted that cats were vegetables, someone correcting this might emphasize the last word:
<p> Cats are cute <em> animals</em>.</p>
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>
strong elementHTMLElement .The strong element represents
strong importance for its contents.
The relative level of importance of a piece of content is given
by its number of ancestor strong
elements; each strong element
increases the importance of its contents.
Changing the importance of a piece of text with the
strong element does not change
the meaning of the sentence.
Here is an example of a warning notice in a game, with the various parts marked up according to how important they are:
<p><strong>Warning.</strong> This dungeon is dangerous. <strong>Avoid the ducks.</strong> Take any gold you find. <strong><strong>Do not take any of the diamonds</strong>, they are explosive and <strong>will destroy anything within ten meters.</strong> </strong> You have been warned.</p>
small elementHTMLElement .The small element represents
small print (part of a document often describing legal
restrictions, such as copyrights or other disadvantages), or other
side comments.
The small element
does not "de-emphasize" or lower the importance of text emphasised
by the em element or marked as
important with the strong
element.
In this example the footer contains contact information and a copyright.
<footer> <address> For more details, contact <a href="mailto:js@example.com">John Smith</a>. </address> <p><small>© copyright 2038 Example Corp.</small></p> </footer>
In this second example, the small element is used for a side comment.
<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>
In this last example, the small element is marked as being
important small print.
<p> <strong> <small> Continued use of this service will result in a kiss.</small> </strong> </p>
mark elementHTMLElement .The mark element represents a
run of text in one document marked or highlighted for reference
purposes, due to its relevance in another context. When used in a
quotation or other block of text referred to from the prose, it
indicates a highlight that was not originally present but which has
been added to bring the reader's attention to a part of the text
that might not have been considered important by the original
author when the block was originally written, but which is now
under previously unexpected scrutiny. When used in the main prose
of a document, it indicates a part of the document that has been
highlighted due to its likely relevance to the user's current
activity.
The rendering section will eventually suggest
that user agents provide a way to let users jump between
mark elements. Suggested rendering
is a neon yellow background highlight, though UAs maybe should
allow this to be toggled.
This example shows how the mark
example can be used to bring attention to a particular part of a
quotation:
<p lang="en-US">Consider the following quote:</p> <blockquote lang="en-GB"> <p>Look around and you will find, no-one's really <mark>colour</mark> blind.</p> </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
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 another example showing the use of mark to highlight a part of quoted text that was
originally not emphasised. In this example, common typographic
conventions have led the author to explicitly style mark elements in quotes to render in
italics.
<article>
<style>
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 element in this example, which is part of the
original text being quoted, and the mark element, which is highlighting a part for
comment.
The following example shows the difference between denoting the
importance of a span of text ( strong ) as opposed to denoting the
relevance of a span of text ( mark ). 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> <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>
dfn elementdfn elements.title attribute has special semantics on this
element.HTMLElement .The dfn element represents the
defining instance of a term. The paragraph , description
list group , or section that is the nearest ancestor of
the dfn element must also contain
the definition(s) for the term given by the dfn element.
Defining term : If the dfn element has a title attribute, then the exact
value of that attribute is the term being defined. Otherwise, if it
contains exactly one element child node and no child text nodes , and that child
element is an abbr element with a
title
attribute, then the exact value of that attribute is the
term being defined. Otherwise, it is the exact textContent of the dfn element that gives the term being
defined.
If the title attribute of the dfn element is present, then it must contain only
the term being defined.
The title attribute of ancestor elements does not
affect dfn elements.
An a element that links to a
dfn element represents an instance
of the term defined by the dfn
element.
In the following fragment, the term "GDO" is first defined in the first paragraph, then used in the second.
<p>The <dfn><abbr title="Garage Door Opener">GDO</abbr></dfn> is a device that allows off-world teams to open the iris.</p> <!-- ... later in the document: --> <p>Teal'c activated his <abbr title="Garage Door Opener">GDO</abbr> and so Hammond ordered the iris to be opened.</p>
With the addition of an a element,
the reference can be made explicit:
<p>The <dfn id=gdo><abbr title="Garage Door Opener">GDO</abbr></dfn> is a device that allows off-world teams to open the iris.</p> <!-- ... later in the document: --> <p>Teal'c activated his <a href=#gdo><abbr title="Garage Door Opener">GDO</abbr></a> and so Hammond ordered the iris to be opened.</p>
abbr elementtitle attribute has special semantics on this
element.HTMLElement .The abbr element represents 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 element. This paragraph
defines the term "Web
Hypertext Application Technology Task Force".
<p>The <dfn id=whattf><abbr title="Web Hypertext Application Technology Task Force">WHATTF</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>
This paragraph has two abbreviations. Notice how only one is
defined; the other, with no expansion associated with it, does not
use the abbr element.
<p>The <abbr title="Web Hypertext Application Technology Working Group"> WHATTF</abbr> started working on HTML5 in 2004.</p>
This paragraph links an abbreviation to its definition.
<p>The <a href="#whattf"><abbr title="Web Hypertext Application Technology Task Force">WHATTF</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> WHATTF</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="Task Force">WG</abbr>s worked on this specification: the <abbr>WHATTF</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="Task Forces">WGs</abbr> worked on this specification: the <abbr>WHATTF</abbr> and the <abbr> HTMLWG</abbr>.</p>
time elementdatetime
interface HTMLTimeElement : HTMLElement {
attribute DOMString dateTime;
readonly attribute DOMTimeStamp date;
readonly attribute DOMTimeStamp time;
readonly attribute DOMTimeStamp timezone;
};
The time element represents a
date and/or a time.
The datetime attribute, if
present, must contain a date or time string
that identifies the date or time being specified.
If the datetime attribute is not present, then the
date or time must be specified in the content of the element, such
that parsing the element's textContent according to the rules for
parsing date or time strings in
content successfully extracts a date or time.
The dateTime DOM attribute must
reflect the datetime
content attribute.
User agents, to obtain the date , time , and timezone represented by a
time element, must follow these
steps:
datetime attribute is present, then parse it
according to the rules for parsing date or time strings in
attributes , and let the result be result
.textContent according to the rules for
parsing date or time strings in
content , and let the result be result
.The date DOM attribute must return
null if the date is
unknown, and otherwise must return the time corresponding to
midnight UTC (i.e. the first second) of the given date .
The time DOM attribute must return
null if the time is
unknown, and otherwise must return the time corresponding to the
given time of
1970-01-01, with the timezone UTC.
The timezone DOM attribute must
return null if the timezone is unknown, and otherwise must
return the time corresponding to 1970-01-01 00:00 UTC in the given
timezone ,
with the timezone set to UTC (i.e. the time corresponding to
1970-01-01 at 00:00 UTC plus the offset corresponding to the
timezone).
In the following snippet:
<p> Our first date was <time datetime="2006-09-23"> a Saturday</time>.</p>
...the time element's
date
attribute would have the value 1,158,969,600,000ms, and the
time and
timezone attributes would return null.
In the following snippet:
<p> We stopped talking at <time datetime="2006-09-24 05:00 -7"> 5am the next morning</time>.</p>
...the time element's
date
attribute would have the value 1,159,056,000,000ms, the
time
attribute would have the value 18,000,000ms, and the timezone
attribute would return −25,200,000ms. To obtain the actual time,
the three attributes can be added together, obtaining
1,159,048,800,000, which is the specified date and time in UTC.
Finally, in the following snippet:
<p> Many people get up at <time> 08:00</time>.</p>
...the time element's
date
attribute would have the value null, the time attribute would
have the value 28,800,000ms, and the timezone
attribute would return null.
These APIs may be suboptimal. Comments on making them more useful to JS authors are welcome. The primary use cases for these elements are for marking up publication dates e.g. in blog entries, and for marking event dates in hCalendar markup. Thus the DOM APIs are likely to be used as ways to generate interactive calendar widgets or some such.
progress elementvaluemax
interface HTMLProgressElement : HTMLElement {
attribute float value;
attribute float max;
readonly attribute float position;
};
The progress element
represents the completion progress of a task. The progress is
either indeterminate, indicating that progress is being made but
that it is not clear how much more work remains to be done before
the task is complete (e.g. because the task is waiting for a remote
host to respond), or the progress is a number in the range zero to
a maximum, giving the fraction of work that has so far been
completed.
There are two attributes that determine the current task completion represented by the element.
The value attribute specifies
how much of the task has been completed, and the max attribute
specifies how much work the task requires in total. The units are
arbitrary and not specified.
Instead of using the attributes, authors are recommended to include the current value and the maximum value inline as text inside the element.
Here is a snippet of a Web application that shows the progress of some automated task:
<section>
<h2>Task Progress</h2>
<p>Progress: <progress><span id="p">0</span>%</progress></p>
<script>
var progressBar = document.getElementById('p');
function updateProgress(newValue) {
progressBar.textContent = newValue;
}
</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.)
Author requirements : The max and value
attributes, when present, must have values that are valid floating point
numbers . The max attribute, if present, must have a value
greater than zero. The value attribute, if present, must have a value
equal to or greater than zero, and less than or equal to the value
of the max attribute, if present.
The progress
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
would be inappropriate. Instead, the meter element is available for such use
cases.
User agent requirements : User agents must
parse the max and value
attributes' values according to the rules for
parsing floating point number values .
If the value attribute is omitted, then user agents
must also parse the textContent of the progress element in question using the
steps for finding one or two numbers of a ratio in
a string . These steps will return nothing, one number, one
number with a denominator punctuation character, or two
numbers.
Using the results of this processing, user agents must determine whether the progress bar is an indeterminate progress bar, or whether it is a determinate progress bar, and in the latter case, what its current and maximum values are, all as follows:
max attribute is omitted, and the value is
omitted, and the results of parsing the textContent was nothing, then the
progress bar is an indeterminate progress bar. Abort these
steps.max attribute is included, then, if a value could
be parsed out of it, then the maximum value is that value.max attribute is absent but the value attribute
is present, or, if the max attribute is present but no value could be
parsed from it, then the maximum is 1.textContent contained one
number with an associated denominator punctuation character, then
the maximum value is the value associated with that
denominator punctuation character ; otherwise, if the
textContent contained two
numbers, the maximum value is the higher of the two values;
otherwise, the maximum value is 1.value attribute is present on the element and
a value could be parsed out of it, that value is the current value
of the progress bar. Otherwise, if the attribute is present but no
value could be parsed from it, the current value is zero.value attribute is absent and the max attribute is
present, then, if the textContent was parsed and found to
contain just one number, with no associated denominator punctuation
character, then the current value is that number. Otherwise, if the
value attribute is absent and the max attribute is
present then the current value is zero.textContent of the
element.UA requirements for showing the progress bar :
When representing a progress
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 relative
to the maximum value.
The max and value DOM attributes
must reflect the elements' content
attributes of the same name. When the relevant content attributes
are absent, the DOM attributes must return zero. The value parsed
from the textContent never
affects the DOM values.
Would be cool to have the value DOM
attribute update the textContent in-line...
If the progress bar is an indeterminate progress bar, then the
position DOM attribute
must return −1. Otherwise, it must return the result of dividing
the current value by the maximum value.
meter elementvalueminlowhighmaxoptimum
interface HTMLMeterElement : HTMLElement {
attribute float value;
attribute float min;
attribute float max;
attribute float low;
attribute float high;
attribute float optimum;
};
The meter element represents 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.
The meter element
should not be used to indicate progress (as in a progress bar). For
that role, HTML provides a separate progress element.
The meter 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 recommended way of giving the value is to include it as contents of the element, either as two numbers (the higher number represents the maximum, the other number the current value, and the minimum is assumed to be zero), or as a percentage or similar (using one of the characters such as "%"), or as a fraction.
The value , min , low , high , max , and optimum
attributes are all optional. When present, they must have values
that are valid floating point numbers ,
and their values must satisfy the following inequalities:
The following examples all represent a measurement of three quarters (of the maximum of whatever is being measured):
<meter>75%</meter> <meter>750‰</meter> <meter>3/4</meter> <meter>6 blocks used (out of 8 total)</meter> <meter>max: 100; current: 75</meter> <meter><object data="graph75.png">0.75</object></meter> <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>12cm</meter> and a height of <meter> 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 element, but the units may be specified
in the title
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 , max , value , low , high , and optimum
attributes using the rules for parsing floating
point number values .
If the value attribute has been omitted, the user
agent must also process the textContent of the element according to
the steps for finding one or two numbers of a
ratio in a string . These steps will return nothing, one
number, one number with a denominator punctuation character, or two
numbers.
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.)
If the min 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.
If the max attribute is specified and a value could be
parsed out of it, the maximum value is that value.
Otherwise, if the max attribute is specified but no value could be
parsed out of it, or if it was not specified, but either or both of
the min or
value
attributes were specified, then the maximum value is
1.
Otherwise, none of the max , min , and value attributes were specified. If the result
of processing the textContent of the element was either
nothing or just one number with no denominator punctuation
character, then the maximum value is 1; if the result was one
number but it had an associated denominator punctuation character,
then the maximum value is the value
associated with that denominator punctuation character ; and
finally, if there were tw