CARVIEW |
DOM Parsing and Serialization
DOMParser, XMLSerializer, innerHTML, and similar APIs
More details about this document
- This version:
- https://w3c.github.io/DOM-Parsing/
- Latest published version:
- https://www.w3.org/TR/DOM-Parsing/
- Latest editor's draft:
- https://w3c.github.io/DOM-Parsing/
- History:
- https://www.w3.org/standards/history/DOM-Parsing/
- Editor:
- Travis Leithead (Microsoft)
- Feedback:
- www-dom@w3.org with subject line DOM-Parsing (archives)
- Test Suites
- https://w3c-test.org/domparsing/
- https://w3c-test.org/html/syntax/
- Participate
- We are on Github.
- Bugzilla Bug list.
- Github Issues.
- Commit history.
- Mailing list.
Copyright © 2025 World Wide Web Consortium. W3C® liability, trademark and permissive document license rules apply.
Abstract
This specification defines APIs for the parsing and serializing of HTML and XML-based DOM nodes for web applications.Status of This Document
This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.
This document was published by the Web Applications Working Group as an Editor's Draft.
Publication as an Editor's Draft does not imply endorsement by W3C and its Members.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This document is governed by the 03 November 2023 W3C Process Document.
Conformance
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The IDL fragments in this specification must be interpreted as required for conforming IDL fragments, as described in the Web IDL specification. [WEBIDL]
Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and terminate these steps") are to be interpreted with the meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.
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.
When a method or an attribute is said to call another method or attribute, the user agent must invoke its internal API for that attribute or method so that e.g. the author can't change the behavior by overriding attributes or methods with custom properties or functions in ECMAScript. [ECMA-262]
Unless otherwise stated, string comparisons are done in a case-sensitive manner.
If an algorithm calls into another algorithm, any exception that is thrown by the latter (unless it is explicitly caught), must cause the former to terminate, and the exception to be propagated up to its caller.
Vendor-specific proprietary extensions to this specification are strongly discouraged. Authors must not use such extensions, as doing so reduces interoperability and fragments the user base, allowing only users of specific user agents to access the content in question.
If vendor-specific extensions are needed, the members should be prefixed by vendor-specific strings to prevent clashes with future versions of this specification. Extensions must be defined so that the use of extensions neither contradicts nor causes the non-conformance of functionality defined in the specification.
When vendor-neutral extensions to this specification are needed, either this specification can be updated accordingly, or an extension specification can be written that overrides the requirements in this specification. Such an extension specification becomes an applicable specification for the purposes of conformance requirements in this specification.
A document object model (DOM) is an in-memory representation of various types of Nodes where each Node is connected in a tree. The [HTML5] and [DOM4] specifications describe DOM and its Nodes is greater detail.
Parsing is the term used for converting a string representation of a DOM into an actual DOM, and Serializing is the term used to transform a DOM back into a string. This specification concerns itself with defining various APIs for both parsing and serializing a DOM.
HTMLDivElement (nodeName: "div")
┃
┣━ HTMLSpanElement (nodeName: "span")
┃ ┃
┃ ┗━ Text (data: "some ")
┃
┗━ HTMLElement (nodeName: "em")
┃
┗━ Text (data: "text!")
And the HTMLDivElement
node is stored in a variable myDiv
,
then to serialize myDiv
's children simply get (read) the
Element's innerHTML property (this triggers the serialization):
var serializedChildren = myDiv.innerHTML;
// serializedChildren has the value:
// "<span>some </span><em>text!</em>"
To parse new children for myDiv
from a string (replacing its existing
children), simply set the innerHTML property (this triggers
parsing of the assigned string):
myDiv.innerHTML = "<span>new</span><em>children!</em>";
This specification describes two flavors of parsing and serializing: HTML and XML (with XHTML being a type of XML). Each follows the rules of its respective markup language. The above example shows HTML parsing and serialization. The specific algorithms for HTML parsing and serializing are defined in the [HTML5] specification. This specification contains the algorithm for XML serializing. The grammar for XML parsing is described in the [XML10] specification.
Round-tripping a DOM means to serialize and then immediately parse the serialized string back into a DOM. Ideally, this process does not result in any data loss with respect to the identity and attributes of the Node in the DOM. Round-tripping is especially tricky for an XML serialization, which must be concerned with preserving the Node's namespace identity in the serialization (wereas namespaces are ignored in HTML).
Element (nodeName: "root")
┃
┗━ HTMLScriptElement (nodeName: "script")
┃
┗━ Text (data: "alert('hello world')")
An XML serialization must include the HTMLScriptElement
Node's
namespace in order to preserve the identity of the
script
element, and to allow the serialized string to
round-trip through an XML parser. Assuming that root
is in a variable named root
:
var xmlSerialization = new XMLSerializer().serializeToString(root);
// xmlSerialization has the value:
// "<root><script xmlns="https://www.w3.org/1999/xhtml">alert('hello world')</script></root>"
The term context object means the object on which the API being discussed was called.
The following terms are understood to represent their respective namespaces in this specification (and makes it easier to read):
- The HTML namespace is
https://www.w3.org/1999/xhtml
- The XML namespace is
https://www.w3.org/XML/1998/namespace
- The XMLNS namespace is
https://www.w3.org/2000/xmlns/
The definition of DOMParser
has moved to the HTML Standard.
The definition of XMLSerializer
has moved to the HTML Standard.
The definition of InnerHTML
has moved to the HTML Standard.
2.4 Extensions to the Element
interface
The definition of outerHTML
has moved to the HTML Standard.
The definition of insertAdjacentHTML
has moved to the HTML Standard.
2.5 Extensions to the Range
interface
The definition of createContextualFragment
has moved to the HTML Standard.
The definition of fragment parsing algorithm
has moved to the HTML Standard.
The definition of fragment serializing algorithm
has moved to the HTML Standard.
An XML serialization differs from an HTML serialization in the following ways:
- Elements and attributes will always be serialized such
that their
namespaceURI
is preserved. In some cases this means that an existingprefix
, prefix declaration attribute or default namespace declaration attribute might be dropped, substituted or changed. An HTML serialization does not attempt to preserve thenamespaceURI
. - Elements not in the HTML namespace containing no children, are serialized using the empty-element tag syntax (i.e., according to the XML EmptyElemTag production).
Otherwise, the algorithm for producing an XML serialization is designed to produce a serialization that is compatible with the HTML parser. For example, elements in the HTML namespace that contain no child nodes are serialized with an explicit begin and end tag rather than using the empty-element tag syntax.
Per [DOM4], Attr
objects do not inherit from Node, and
thus cannot be serialized by the XML serialization algorithm. An attempt to serialize an
Attr object will result in an empty string.
To produce an XML serialization of a Node
node given
a flag require well-formed, run the following steps:
- Let namespace be a context namespace with value
null
. The context namespace tracks the XML serialization algorithm's current default namespace. The context namespace is changed when either an Element Node has a default namespace declaration, or the algorithm generates a default namespace declaration for the Element Node to match its own namespace. The algorithm assumes no namespace (null
) to start. - Let prefix map be a new namespace prefix map.
- Add the XML namespace with prefix value "
xml
" to prefix map. - Let prefix index be a generated namespace prefix index with value
1
. The generated namespace prefix index is used to generate a new unique prefix value when no suitable existing namespace prefix is available to serialize a node'snamespaceURI
(or thenamespaceURI
of one of node's attributes). See the generate a prefix algorithm. - Return the result of running the XML serialization algorithm on node
passing the context namespace namespace, namespace prefix map
prefix map, generated namespace prefix index reference to
prefix index, and the flag require well-formed. If an
exception occurs during the execution of the algorithm,
then catch that exception and throw an "
InvalidStateError
"DOMException
.
Each of the following algorithms for producing an XML serialization of a DOM node take as input a node to serialize and the following arguments:
- A context namespace namespace
- A namespace prefix map prefix map
- A generated namespace prefix index prefix index
- The require well-formed flag
The XML serialization algorithm produces an XML serialization of an arbitrary DOM node node based on the node's interface type. Each referenced algorithm is to be passed the arguments as they were recieved by the caller and return their result to the caller. Re-throw any exceptions. If node's interface is:
Element
- Run the algorithm for XML serializing an Element node node.
Document
- Run the algorithm for XML serializing a Document node node.
Comment
- Run the algorithm for XML serializing a Comment node node.
Text
- Run the algorithm for XML serializing a Text node node.
DocumentFragment
- Run the algorithm for XML serializing a DocumentFragment node node.
DocumentType
- Run the algorithm for XML serializing a DocumentType node node.
ProcessingInstruction
- Run the algorithm for XML serializing a ProcessingInstruction node node.
- An
Attr
object - Return an empty string.
- Anything else
- Throw a TypeError. Only Nodes and Attr objects can be serialized by this algorithm.
- If the require well-formed flag is set (its value is
true
), and this node'slocalName
attribute contains the character ":
" (U+003A COLON) or does not match the XML Name production, then throw an exception; the serialization of this node would not be a well-formed element. - Let markup be the string "
<
" (U+003C LESS-THAN SIGN). - Let qualified name be an empty string.
- Let skip end tag be a boolean flag with value
false
. - Let ignore namespace definition attribute be a boolean flag with value
false
. - Given prefix map, copy a namespace prefix map and let map be the result.
- Let local prefixes map be an empty map. The map has unique Node
prefix
strings as its keys, with correspondingnamespaceURI
Node values as the map's key values (in this map, thenull
namespace is represented by the empty string).NoteThis map is local to each element. It is used to ensure there are no conflicting prefixes should a new namespace
prefix
attribute need to be generated. It is also used to enable skipping of duplicate prefix definitions when writing an element's attributes: the map allows the algorithm to distinguish between aprefix
in the namespace prefix map that might be locally-defined (to the current Element) and one that is not. - Let local default namespace be the result of
recording the namespace information for node given map and
local prefixes map.
Note
The above step will update map with any found namespace prefix definitions, add the found prefix definitions to the local prefixes map and return a local default namespace value defined by a default namespace attribute if one exists. Otherwise it returns
null
. - Let inherited ns be a copy of namespace.
- Let ns be the value of node's
namespaceURI
attribute. - If inherited ns is equal to ns, then:
- If local default namespace is not
null
, then set ignore namespace definition attribute totrue
. - If ns is the XML namespace, then append to
qualified name the concatenation of the string "
xml:
" and the value of node'slocalName
. - Otherwise, append to qualified name the value of node's
localName
. The node'sprefix
if it exists, is dropped. - Append the value of qualified name to markup.
- If local default namespace is not
- Otherwise, inherited ns is not equal to ns (the node's
own namespace is different from the context namespace of its parent). Run these sub-steps:
- Let prefix be the value of node's
prefix
attribute. - Let candidate prefix be the result of
retrieving a preferred prefix string prefix from map given
namespace ns.
Note
The above may return
null
if no namespace key ns exists in map. - If the value of prefix matches "
xmlns
", then run the following steps:- If the require well-formed flag is set, then throw an error. An
Element with
prefix
"xmlns
" will not legally round-trip in a conforming XML parser. - Let candidate prefix be the value of prefix.
- If the require well-formed flag is set, then throw an error. An
Element with
- Found a suitable namespace prefix: if candidate prefix is not
null
(a namespace prefix is defined which maps to ns), then:NoteThe following may serialize a different
prefix
than the Element's existingprefix
if it already had one. However, the retrieving a preferred prefix string algorithm already tried to match the existing prefix if possible.- Append to qualified name the concatenation of
candidate prefix, "
:
" (U+003A COLON), and node'slocalName
. There exists on this node or the node's ancestry a namespace prefix definition that defines the node's namespace. - If the local default namespace is not
null
(there exists a locally-defined default namespace declaration attribute) and its value is not the XML namespace, then let inherited ns get the value of local default namespace unless the local default namespace is the empty string in which case let it getnull
(the context namespace is changed to the declared default, rather than this node's own namespace).NoteAny default namespace definitions or namespace prefixes that define the XML namespace are omitted when serializing this node's attributes.
- Append the value of qualified name to markup.
- Append to qualified name the concatenation of
candidate prefix, "
- Otherwise, if prefix is not
null
, then:NoteBy this step, there is no namespace or prefix mapping declaration in this node (or any parent node visited by this algorithm) that defines prefix otherwise the step labelled Found a suitable namespace prefix would have been followed. The sub-steps that follow will create a new namespace prefix declaration for prefix and ensure that prefix does not conflict with an existing namespace prefix declaration of the same
localName
in node's attribute list.- If the local prefixes map contains a key matching prefix, then let prefix be the result of generating a prefix providing as input map, ns, and prefix index.
- Add prefix to map given namespace ns.
- Append to qualified name the concatenation of prefix,
"
:
" (U+003A COLON), and node'slocalName
. - Append the value of qualified name to markup.
- Append the following to markup, in the order listed:
Note
The following serializes a namespace prefix declaration for prefix which was just added to the map.
- "
- The string "
xmlns:
"; - The value of prefix;
- "
="
" (U+003D EQUALS SIGN, U+0022 QUOTATION MARK); - The result of serializing an attribute value given ns and the require well-formed flag as input;
- "
"
" (U+0022 QUOTATION MARK). - If local default namespace is not
null
(there exists a locally-defined default namespace declaration attribute), then let inherited ns get the value of local default namespace unless the local default namespace is the empty string in which case let it getnull
.
- "
- Otherwise, if local default namespace is
null
, or local default namespace is notnull
and its value is not equal to ns, then:NoteAt this point, the namespace for this node still needs to be serialized, but there's no
prefix
(or candidate prefix) availble; the following uses the default namespace declaration to define the namespace--optionally replacing an existing default declaration if present.- Set the ignore namespace definition attribute flag to
true
. - Append to qualified name the value of node's
localName
. - Let the value of inherited ns be ns.
Note
The new default namespace will be used in the serialization to define this node's namespace and act as the context namespace for its children.
- Append the value of qualified name to markup.
- Append the following to markup, in the order listed:
Note
The following serializes the new (or replacement) default namespace definition.
- "
- The string "
xmlns
"; - "
="
" (U+003D EQUALS SIGN, U+0022 QUOTATION MARK); - The result of serializing an attribute value given ns and the require well-formed flag as input;
- "
"
" (U+0022 QUOTATION MARK).
- "
- Set the ignore namespace definition attribute flag to
- Otherwise, the node has a local default namespace that matches
ns. Append to qualified name the value of node's
localName
, let the value of inherited ns be ns, and append the value of qualified name to markup.NoteAll of the combinations where ns is not equal to inherited ns are handled above such that node will be serialized preserving its original
namespaceURI
.
- Let prefix be the value of node's
- Append to markup the result of the XML serialization of node's attributes given map, prefix index, local prefixes map, ignore namespace definition attribute flag, and require well-formed flag.
- If ns is the HTML namespace, and the node's list of
children is empty, and the node's
localName
matches any one of the following void elements: "area
", "base
", "basefont
", "bgsound
", "br
", "col
", "embed
", "frame
", "hr
", "img
", "input
", "keygen
", "link
", "menuitem
", "meta
", "param
", "source
", "track
", "wbr
"; then append the following to markup, in the order listed:- "
- "
/
" (U+002F SOLIDUS).
true
. - "
- If ns is not the HTML namespace, and the node's list of
children is empty, then append "
/
" (U+002F SOLIDUS) to markup and set the skip end tag flag totrue
. - Append "
>
" (U+003E GREATER-THAN SIGN) to markup. - If the value of skip end tag is
true
, then return the value of markup and skip the remaining steps. The node is a leaf-node. - If ns is the HTML namespace, and the node's
localName
matches the string "template
", then this is atemplate
element. Append to markup the result of XML serializing a DocumentFragment node given the template element's template contents (aDocumentFragment
), providing inherited ns, map, prefix index, and the require well-formed flag.NoteThis allows template content to round-trip , given the rules for parsing XHTML documents.
- Otherwise, append to markup the result of running the XML serialization algorithm on each of node's children, in tree order, providing inherited ns, map, prefix index, and the require well-formed flag.
- Append the following to markup, in the order listed:
- "
</
" (U+003C LESS-THAN SIGN, U+002F SOLIDUS); - The value of qualified name;
- "
>
" (U+003E GREATER-THAN SIGN).
- "
- Return the value of markup.
This following algorithm will update the namespace prefix map with any found namespace
prefix definitions, add the found prefix definitions to the local prefixes map,
and return a local default namespace value defined by a default namespace attribute if one
exists. Otherwise it returns null
.
When recording the namespace information for an Element
element, given a namespace prefix map map and a
local prefixes map (initially empty), the user agent must run the following
steps:
- Let default namespace attr value be
null
. - Main: For each attribute attr in element's
attributes
, in the order they are specified in the element's attribute list:NoteThe following conditional steps find namespace prefixes. Only attributes in the XMLNS namespace are considered (e.g., attributes made to look like namespace declarations via
setAttribute("xmlns:pretend-prefix", "pretend-namespace")
are not included).- Let attribute namespace be the value of attr's
namespaceURI
value. - Let attribute prefix be the value of attr's
prefix
. - If the attribute namespace is the XMLNS namespace, then:
- If attribute prefix is
null
, then attr is a default namespace declaration. Set the default namespace attr value to attr'svalue
and stop running these steps, returning to Main to visit the next attribute. - Otherwise, the attribute prefix is not
null
and attr is a namespace prefix definition. Run the following steps:- Let prefix definition be the value of attr's
localName
. - Let namespace definition be the value of attr's
value
. - If namespace definition is the XML namespace, then stop running
these steps, and return to Main to visit the next attribute.
Note
XML namespace definitions in prefixes are completely ignored (in order to avoid unnecessary work when there might be prefix conflicts). XML namespaced elements are always handled uniformly by prefixing (and overriding if necessary) the element's localname with the reserved "
xml
" prefix. - If namespace definition is the empty string (the declarative form of
having no namespace), then let namespace definition be
null
instead. - If prefix definition is found in map given the namespace
namespace definition, then stop running these steps, and return to Main
to visit the next attribute.
Note
This step avoids adding duplicate prefix definitions for the same namespace in the map. This has the side-effect of avoiding later serialization of duplicate namespace prefix declarations in any descendant nodes.
- Add the prefix prefix definition to map given namespace namespace definition.
- Add the value of prefix definition as a new key to the
local prefixes map, with the namespace definition as the
key's value replacing the value of
null
with the empty string if applicable.
- Let prefix definition be the value of attr's
- If attribute prefix is
- Let attribute namespace be the value of attr's
- Return the value of default namespace attr value.
Note
The empty string is a legitimate return value and is not converted to
null
.
A namespace prefix map is a map that associates namespaceURI
and
namespace prefix lists, where namespaceURI
values are the
map's unique keys (which can include the null
value representing no namespace), and
ordered lists of associated prefix
values are the map's key values. The
namespace prefix map will be populated by previously seen namespaceURIs and all their
previously encountered prefix associations for a given node and its ancestors.
Note: the last seen prefix
for a given
namespaceURI
is at the end of its respective list. The list is searched to
find potentially matching prefixes, and if no matches are found for the given
namespaceURI
, then the last prefix
in the list is used. See
copy a namespace prefix map and retrieve a preferred prefix string for additional
details.
To copy a namespace prefix map map means to copy the map's keys into a new empty namespace prefix map, and to copy each of the values in the namespace prefix list associated with each keys' value into a new list which should be associated with the respective key in the new map.
To retrieve a preferred prefix string preferred prefix from the namespace prefix map map given a namespace ns, the user agent should:
- Let candidates list be the result of retrieving a list from map
where there exists a key in map that matches the value of ns or if there
is no such key, then stop running these steps, and return the
null
value. - Otherwise, for each prefix value prefix in candidates list, iterating
from beginning to end:
Note
There will always be at least one prefix value in the list.
- If prefix matches preferred prefix, then stop running these steps and return prefix.
- If prefix is the last item in the candidates list, then stop running these steps and return prefix.
To check if a prefix string prefix is found in a namespace prefix map map given a namespace ns, the user agent should:
- Let candidates list be the result of retrieving a list from map
where there exists a key in map that matches the value of ns or if there
is no such key, then stop running these steps, and return
false
. - If the value of prefix occurs at least once in candidates list, return
true
, otherwise returnfalse
.
To add a prefix string prefix to the namespace prefix map map given a namespace ns, the user agent should:
- Let candidates list be the result of retrieving a list from map
where there exists a key in map that matches the value of ns or if there
is no such key, then let candidates list be
null
. - If candidates list is
null
, then create a new list with prefix as the only item in the list, and associate that list with a new key ns in map. - Otherwise, append prefix to the end of candidates list.
Note
The steps in retrieve a preferred prefix string use the list to track the most recently used (MRU) prefix associated with a given namespace, which will be the prefix at the end of the list. This list may contain duplicates of the same prefix value seen earlier (and that's OK).
The XML serialization of the attributes of an Element
element together with a namespace prefix map map, a
generated namespace prefix index prefix index reference, a
local prefixes map, a ignore namespace definition attribute flag, and a
require well-formed flag, is the result of the following algorithm:
- Let result be the empty string.
- Let localname set be a new empty namespace localname set. This
localname set will contain tuples of unique attribute
namespaceURI
andlocalName
pairs, and is populated as each attr is processed. This set is used to [optionally] enforce the well-formed constraint that an element cannot have two attributes with the samenamespaceURI
andlocalName
. This can occur when two otherwise identical attributes on the same element differ only by their prefix values. - Loop: For each attribute attr in element's
attributes
, in the order they are specified in the element's attribute list:- If the require well-formed flag is set (its value is
true
), and the localname set contains a tuple whose values match those of a new tuple consisting of attr'snamespaceURI
attribute andlocalName
attribute, then throw an exception; the serialization of this attr would fail to produce a well-formed element serialization. - Create a new tuple consisting of attr's
namespaceURI
attribute andlocalName
attribute, and add it to the localname set. - Let attribute namespace be the value of attr's
namespaceURI
value. - Let candidate prefix be
null
. - If attribute namespace is not
null
, then run these sub-steps:- Let candidate prefix be the result of
retrieving a preferred prefix string from map given namespace
attribute namespace with preferred prefix being attr's
prefix
value. - If the value of attribute namespace is the XMLNS namespace, then run
these steps:
- If any of the following are true, then stop running these steps and goto Loop
to visit the next attribute:
- the attr's
value
is the XML namespace;NoteThe XML namespace cannot be redeclared and survive round-tripping (unless it defines the prefix "
xml
"). To avoid this problem, this algorithm always prefixes elements in the XML namespace with "xml
" and drops any related definitions as seen in the above condition. - the attr's
prefix
isnull
and the ignore namespace definition attribute flag istrue
(the Element's default namespace attribute should be skipped); - the attr's
prefix
is notnull
and either- the attr's
localName
is not a key contained in the local prefixes map, or - the attr's
localName
is present in the local prefixes map but the value of the key does not match attr'svalue
localName
(as the prefix to find) is found in the namespace prefix map given the namespace consisting of the attr'svalue
(the current namespace prefix definition was exactly defined previously--on an ancestor element not the current element whose attributes are being processed). - the attr's
- the attr's
- If the require well-formed flag is set (its value is
true
), and the value of attr'svalue
attribute matches the XMLNS namespace, then throw an exception; the serialization of this attribute would produce invalid XML because the XMLNS namespace is reserved and cannot be applied as an element's namespace via XML parsing.NoteDOM APIs do allow creation of elements in the XMLNS namespace but with strict qualifications.
- If the require well-formed flag is set (its value is
true
), and the value of attr'svalue
attribute is the empty string, then throw an exception; namespace prefix declarations cannot be used to undeclare a namespace (use a default namespace declaration instead). - the attr's
prefix
matches the string "xmlns
", then let candidate prefix be the string "xmlns
".
- If any of the following are true, then stop running these steps and goto Loop
to visit the next attribute:
- Otherwise, the attribute namespace in not the XMLNS namespace. Run
these steps:
- Let candidate prefix be the result of generating a prefix providing map, attribute namespace, and prefix index as input.
- Append the following to result, in the order listed:
- "
- The string "
xmlns:
"; - The value of candidate prefix;
- "
="
" (U+003D EQUALS SIGN, U+0022 QUOTATION MARK); - The result of serializing an attribute value given attribute namespace and the require well-formed flag as input;
- "
"
" (U+0022 QUOTATION MARK).
- "
- Let candidate prefix be the result of
retrieving a preferred prefix string from map given namespace
attribute namespace with preferred prefix being attr's
- Append a "
- If candidate prefix is not
null
, then append to result the concatenation of candidate prefix with ":
" (U+003A COLON). - If the require well-formed flag is set (its value is
true
), and this attr'slocalName
attribute contains the character ":
" (U+003A COLON) or does not match the XML Name production or equals "xmlns
" and attribute namespace isnull
, then throw an exception; the serialization of this attr would not be a well-formed attribute. - Append the following strings to result, in the order listed:
- The value of attr's
localName
; - "
="
" (U+003D EQUALS SIGN, U+0022 QUOTATION MARK); - The result of serializing an attribute value given attr's
value
attribute and the require well-formed flag as input; - "
"
" (U+0022 QUOTATION MARK).
- The value of attr's
- If the require well-formed flag is set (its value is
- Return the value of result.
When serializing an attribute value given an attribute value and require well-formed flag, the user agent must run the following steps:
- If the require well-formed flag is set (its value is
true
), and attribute value contains characters that are not matched by the XML Char production, then throw an exception; the serialization of this attribute value would fail to produce a well-formed element serialization. - If attribute value is
null
, then return the empty string. - Otherwise, attribute value is a string. Return the value of
attribute value, first replacing any occurrences of the following:
- "
&
" with "&
" - "
"
" with ""
" - "
<
" with "<
" - "
>
" with ">
"
NoteThis matches behavior present in browsers, and goes above and beyond the grammar requirement in the XML specification's AttValue production by also replacing "
>
" characters. - "
To generate a prefix given a namespace prefix map map, a string new namespace, and a reference to a generated namespace prefix index prefix index, the user agent must run the following steps:
- Let generated prefix be the concatenation of the string "
ns
" and the current numerical value of prefix index. - Let the value of prefix index be incremented by one.
- Add to map the generated prefix given the new namespace namespace.
- Return the value of generated prefix.
If the require well-formed flag is set (its value is true
), and this
node has no documentElement
(the
documentElement
attribute's value is null
), then
throw an exception; the serialization of this node would not be a well-formed
document.
Otherwise, run the following steps:
- Let serialized document be an empty string.
- For each child child of node, in tree order, run the
XML serialization algorithm on the child passing along the provided arguments,
and append the result to serialized document.
Note
This will serialize any number of ProcessingInstruction and Comment nodes both before and after the Document's documentElement node, including at most one DocumentType node. (Text nodes are not allowed as children of the Document.)
- Return the value of serialized document.
If the require well-formed flag is set (its value is true
), and
node's data
contains characters that are not matched by the XML
Char production or contains "--
" (two adjacent U+002D HYPHEN-MINUS
characters) or that ends with a "-
" (U+002D HYPHEN-MINUS) character, then
throw an exception; the serialization of this node's data
would not be well-formed.
Otherwise, return the concatenation of "<!--
", node's
data
, and "-->
".
- If the require well-formed flag is set (its value is
true
), and node'sdata
contains characters that are not matched by the XML Char production, then throw an exception; the serialization of this node'sdata
would not be well-formed. - Let markup be the value of node's
data
. - Replace any occurrences of "
&
" in markup by "&
". - Replace any occurrences of "
<
" in markup by "<
". - Replace any occurrences of "
>
" in markup by ">
". - Return the value of markup.
- Let markup the empty string.
- For each child child of node, in tree order, run the XML serialization algorithm on the child given namespace, prefix map, a reference to prefix index, and flag require well-formed. Concatenate the result to markup.
- Return the value of markup.
- If the require well-formed flag is
true
and the node'spublicId
attribute contains characters that are not matched by the XML PubidChar production, then throw an exception; the serialization of this node would not be a well-formed document type declaration. - If the require well-formed flag is
true
and the node'ssystemId
attribute contains characters that are not matched by the XML Char production or that contains both a ""
" (U+0022 QUOTATION MARK) and a "'
" (U+0027 APOSTROPHE), then throw an exception; the serialization of this node would not be a well-formed document type declaration. - Let markup be an empty string.
- Append the string "
<!DOCTYPE
" to markup. - Append "
- Append the value of the node's
name
attribute to markup. For a node belonging to an HTML document, the value will be all lowercase. - If the node's
publicId
is not the empty string then append the following, in the order listed, to markup:- "
- The string "
PUBLIC
"; - "
- "
"
" (U+0022 QUOTATION MARK); - The value of the node's
publicId
attribute; - "
"
" (U+0022 QUOTATION MARK).
- "
- If the node's
systemId
is not the empty string and the node'spublicId
is set to the empty string, then append the following, in the order listed, to markup:- "
- The string "
SYSTEM
".
- "
- If the node's
systemId
is not the empty string then append the following, in the order listed, to markup:- "
- "
"
" (U+0022 QUOTATION MARK); - The value of the node's
systemId
attribute; - "
"
" (U+0022 QUOTATION MARK).
- "
- Append "
>
" (U+003E GREATER-THAN SIGN) to markup. - Return the value of markup.
- If the require well-formed flag is set (its value is
true
), and node'starget
contains a ":
" (U+003A COLON) character or is an ASCII case-insensitive match for the string "xml
", then throw an exception; the serialization of this node'starget
would not be well-formed. - If the require well-formed flag is set (its value is
true
), and node'sdata
contains characters that are not matched by the XML Char production or contains the string "?>
" (U+003F QUESTION MARK, U+003E GREATER-THAN SIGN), then throw an exception; the serialization of this node'sdata
would not be well-formed. - Let markup be the concatenation of the following, in the order listed:
- Return the value of markup.
- The general concepts: an active document;
- Parsing concepts: the fragment parsing algorithm; HTML parser; parsing XHTML documents; XML parser;
- A document location
- The following elements: meta, noscript, script and template
- void elements
- The template's template contents
- The [CEReactions] IDL extended attribute
- The innerHTML property;
- The outerHTML property;
- The insertAdjacentHTML method;
- The following concepts: case-sensitive and ASCII case-insensitive string comparisons; a node's children, first child, next sibling and parent; the content type and encoding; a HTML document; a local name; a namespace concept; a node document; the append, insert and replace operations; tree order; a range's start node; document URL; a XML document;
- The Attr interface and its attr.localName, attr.namespaceURI, attr.prefix and attr.value attributes
- The CharacterData interface's data attribute
- The Comment interface
- The Document interface and its doctype and documentElement attribute
- The DocumentType interface and its doctype.name, publicId and systemId attributes
- The DocumentFragment interface
- The Element interface and its attributes list, element.localName, element.namespaceURI and element.prefix attributes, setAttribute method
- The Node interface
- The ProcessingInstruction interface and its target attribute
- The Range interface
- The Text interface
- The following DOMExceptions: "InvalidStateError", "NoModificationAllowedError" and "SyntaxError",
- XMLDocument
- The ShadowRoot interface
- The
AttValue
,Char
,EmptyElemTag
,Name
andPubidChar
productions - empty-element tag
- The TypeError exception
- 2016-06 WD - Editorial restructuring of the document; monolithic XML serialization algorithm factored into sections. Dependencies clarified. XML Serialization algorithm updated to get closer to interoperable browser behavior.
- Incorporated non-normative changes from previous Last Call document.
We acknowledge with gratitude the original work of Ms2ger and others at the WHATWG, who created and maintained the original DOM Parsing and Serialization Living Standard upon which this specification is based.
Thanks to C. Scott Ananian, Victor Costan, Aryeh Gregor, Anne van Kesteren, Arkadiusz Michalski, Simon Pieters, Henri Sivonen, Josh Soref and Boris Zbarsky, for their useful comments.
Special thanks to Ian Hickson for first defining the innerHTML and outerHTML attributes, and the insertAdjacentHTML method in [HTML5] and his useful comments.
- [DOM4]
- DOM Standard. Anne van Kesteren. WHATWG. Living Standard. URL: https://dom.spec.whatwg.org/
- [ECMA-262]
- ECMAScript Language Specification. Ecma International. URL: https://tc39.es/ecma262/multipage/
- [HTML5]
- HTML5. Ian Hickson; Robin Berjon; Steve Faulkner; Travis Leithead; Erika Doyle Navara; Theresa O'Connor; Silvia Pfeiffer. W3C. 27 March 2018. W3C Recommendation. URL: https://www.w3.org/TR/html5/
- [WEBIDL]
- Web IDL Standard. Edgar Chen; Timothy Gu. WHATWG. Living Standard. URL: https://webidl.spec.whatwg.org/
- [XML10]
- Extensible Markup Language (XML) 1.0 (Fifth Edition). Tim Bray; Jean Paoli; Michael Sperberg-McQueen; Eve Maler; François Yergeau et al. W3C. 26 November 2008. W3C Recommendation. URL: https://www.w3.org/TR/xml/
Referenced in:
Referenced in:
Referenced in:
Referenced in:
- § 3.2.1 XML Serialization (2) (3)
- § 3.2.1.1 XML serializing an Element node (2) (3) (4) (5) (6) (7)
- § 3.2.1.1.3 Serializing an Element's attributes (2) (3) (4) (5) (6) (7) (8) (9)
- § 3.2.1.2 XML serializing a Document node
- § 3.2.1.3 XML serializing a Comment node
- § 3.2.1.4 XML serializing a Text node
- § 3.2.1.5 XML serializing a DocumentFragment node
- § 3.2.1.6 XML serializing a DocumentType node (2)
- § 3.2.1.7 XML serializing a ProcessingInstruction node (2)
Referenced in:
Referenced in:
Referenced in:
- § 3.2.1.1 XML serializing an Element node
- § 3.2.1.1.3 Serializing an Element's attributes (2) (3)
- § 3.2.1.2 XML serializing a Document node
- § 3.2.1.3 XML serializing a Comment node
- § 3.2.1.4 XML serializing a Text node
- § 3.2.1.6 XML serializing a DocumentType node (2)
- § 3.2.1.7 XML serializing a ProcessingInstruction node (2)
Referenced in:
- § 3.2.1 XML Serialization
- § 3.2.1.1 XML serializing an Element node
- § 3.2.1.2 XML serializing a Document node
- § 3.2.1.3 XML serializing a Comment node
- § 3.2.1.4 XML serializing a Text node
- § 3.2.1.5 XML serializing a DocumentFragment node
- § 3.2.1.6 XML serializing a DocumentType node
- § 3.2.1.7 XML serializing a ProcessingInstruction node
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in: