DOM Document Type Definition Module

Modifications to the Document Interface

If an attempt is made to adopt an ElementTypeDefinition or AttributeDefinition node, the adoptNode method MUST raise a NOT_SUPPORTED_ERR exception @@ ref.

The DocumentXDoctype Interface

The DocumentXDoctype interface MUST be implemented as following:

interface DocumentXDoctype {
  DocumentType createDocumentTypeDefinition
    (in DOMString name)
    raises (DOMException);
  ElementTypeDefinition createElementTypeDefinition
    (in DOMString name)
    raises (DOMException);
  AttributeDefinition createAttributeDefinition
    (in DOMString name)
    raises (DOMException);
  Entity createGeneralEntityDefinition
    (in DOMString name)
    raises (DOMException);
  Notation createNotation
    (in DOMString name)
    raises (DOMException);
}

createDocumentTypeDefinition, method

This method creates a DocumentType node with the specified name, belonging to the document.

The name parameter is the name of the document type.

When invoked, the method MUST create and return a DocumentType node with the following attributes:

attributes, parentNode

null.

elementTypes, generalEntities, and notations

Empty NamedNodeMap objects.

entities

The same value as the generalEntities attribute.

childNodes

An empty NodeList object.

internalSubset, publicId, and systemId

Empty strings.

manakaiReadOnly [manakai]

false.

nodeName

name.

ownerDocument

The Document over which the method is invoked.

In addition, the method MUST be marked as containing five general entity declarations: amp, lt, gt, quot, and apos.

createElementTypeDefinition, method

This method creates a ElementTypeDefinition node with the specified name, belonging to the document.

The name parameter is the name of the element type defined by the element type definition.

When invoked, the method MUST create and return an ElementTypeDefinition node with the following attributes:

attributeDefinitions

An empty NamedNodeMap object.

attributes, parentNode

null.

childNodes

An empty NodeList object.

manakaiReadOnly [manakai]

false.

nodeName

name.

ownerDocument

The Document node over which the method is invoked.

ownerDocumentTypeDefinition

null.

@@ Ensure all attributes are defined

createAttributeDefinition, method

This method creates a AttributeDefinition node with the specified name, belonging to the document.

The name parameter is the name of the attribute defined by the attribute definition.

When invoked, the method MUST create and return an AttributeDefinition node with the following attributes:

allowedTokens

An empty DOMStringList object.

attributes, ownerElementTypeDefinition, and parentNode

null.

childNodes

An empty NodeList object.

declaredType

NO_TYPE_ATTR.

defaultType

UNKNOWN_DEFAULT.

manakaiReadOnly [manakai]

false.

nodeName

name.

ownerDocument

The Document node over which the method is invoked.

@@ Ensure all attributes are defined

@@ Should we keep these statements?: However, if the <cfg::cfg|xml-id> configuration parameter is set to true and the name is xml:id, then the [CODE(DOMa)@en[[[declaredType]]]] attribute is set to ID_ATTR. [CODE(DOMa)@en[[[defaultType]]]]?

createGeneralEntity, method

This method creates a Entity node with the specified name, which represents a general entity, belonging to the document.

The name parameter is the name of the general entity.

When invoked, the method MUST create and return an Entity node with the following attributes:

attributes, notationName, ownerDocumentTypeDefinition, and parentNode

null.

childNodes

An empty NodeList object.

manakaiDeclarationBaseURI, manakaiEntityBaseURI, and manakaiEntityURI @@ ref

No explicit value is set.

hasReplacementTree and manakaiReadOnly [manakai]

false.

nodeName

name.

It is not an error for name matching to the name of one of predefined general parsed entities in XML or HTML. For example, name might be amp, resulting in an Entity node with its nodeName attribute set to amp.

ownerDocument

The Document node over which the method is invoked.

publicId, and systemId

null.

@@ publicId and systemId should be empty string?

@@ Ensure all attributes are defined

createNotation, method

This method creates a Notation node with the specified name, belonging to the document.

The name parameter is the name of the notation.

When invoked, the method MUST create and return a Notation node with the following attributes:

attributes, ownerDocumentTypeDefinition, and parentNode

null.

childNodes

An empty NodeList object.

manakaiDeclarationBaseURI

No explicit value is set.

manakaiReadOnly [manakai]

false.

nodeName

name.

ownerDocument

The Document node over which the method is invoked.

publicId and systemId

null.

@@ publicId and systemId should be empty string?

@@ Ensure all attributes are defined

These methods MUST raise an INVALID_CHARACTER_ERR exception @@ ref if name is not a legal Name according to the XML version in use, as specified in the xmlVersion attribute of the Document node.

Modifications to the DocumentType Interface

A DocumentType interface MAY contain zero or more ProcessingInstruction nodes in the NodeList object contained in the childNodes attribute of the DocumentType node.

If the DocumentType node is created during the process to create a DOM from an XML document, the NodeList object in the childNodes object MUST contains the ProcessingInstruction nodes representing the processing instructions in the document type definition of the document processed @@ ref by the XML processor. If the DocumentType node is marked as read‐only, then all the child nodes MUST also be marked as read‐only.

If a DocumentType node is created from a document type declaration information item @@ ref, the NodeList object in the childNodes attribute of the node MUST contain the ProcessingInstruction nodes created from the processing instruction information items in the list in the [children] property of the document type declaration item in the same order.

If a DocumentType node is mapped to a document type declaration information item, the list in the [children] property MUST contain the processng instruction information items created from the ProcessingInstruction nodes in the NodeList object in the childNodes attribute of the DocumentType node.

The implementation of the DocumentType interface MUST be modified as following:

// Modifications to the DocumentType interface
  attribute DOMString publicId;
  attribute DOMString systemId;

  attribute DOMString internalSubset;

The publicId attribute and the systemId attribute of DocumentType, Entity, and Notation interfaces are no longer read‐only.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to the attribute. No normalization, relative reference resolution, or lexical validation is performed. @@ If the new value is null, ...

The internalSubset attribute of the DocumentType interface is no longer read‐only.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to the attribute. No normalization, or lexical validation is performed. @@ If the new value is null, ...

The ElementTypeDefinition Interface

The nodes of type ELEMENT_TYPE_DEFINITION_NODE represents an element type definition. Such a node MUST implement the ElementTypeDefinition interface, which extends the Node interface.

An element type definition represents a definition of the element type. It is corresponding to the element type declaration in DTD. However, an ElementTypeDefinition node does not represent the element type definition in DTD itself. Even if there are more than one element type declarations for an element type in DTD, the result DOM will contain only an ElementTypeDefinition node for that element type. In addition, if there are attribute definition declarations for an element type, even when there is no element type declaration for that element type, the DOM will contain an ElementTypeDefinition node for that element type.

An ElementTypeDefinition node cannot be a child of any node. An ElementTypeDefinition node cannot have any child node.

The ElementTypeDefinition interface MUST be implemented as following:

interface ElementTypeDefinition : Node {
  readonly attribute DocumentType ownerDocumentTypeDefinition;

  readonly attribute NamedNodeMap attributeDefinitions;
  AttributeDefinition getAttributeDefinitionNode
    (in DOMString name);
  void setAttributeDefinitionNode
    (in AttributeDefinition node)
    raises (DOMException);
}

ownerDocumentTypeDefinition of type DocumentType, read‐only

The ownerDocumentTypeDefinition attribute of ElementTypeDefinition, Entity, and Notation interface contains the DocumentType node to which the node is attached.

On getting, the attribute MUST return a DocumentType node. It MUST be such a node that whose elementTypes (for an ElementTypeDefinition node), entities (for an Entity node), or notations (for a Notation node) attribute contains the NamedNodeMap object that contains the node. If there is no such a DocumentType node, then null MUST be returned.

attributeDefinitions of type NamedNodeMap, read‐only

A live NamedNodeMap object that contains all the attribute definitions belonging to the ElementTypeDefinition node.

On getting, the attribute MUST return the NamedNodeMap object that contains all the AttributeDefinition node belonging to the ElementTypeDefinition node. The NamedNodeMap object MUST be read‐only if and only if the node is read‐only. The NamedNodeMap object MUST be live and the same object MUST be returned for any invocation.

If the ElementTypeDefinition node is created during the process to create a DOM from an XML document, the following requirements are applied: The NamedNodeMap object in the attributeDefinitions attribute MUST be so transformed that the object contains the AttributeDefinition node corresponding to the attribute definitions in the attribute definition list declarations processed by the XML processor and associated to the element type represented by the node. If there are more than one attribute definitions for an attribute, then the definitions other than the first one MUST be ignored for the purpose of constructing the NamedNodeMap object.

getAttributeDefinitionNode, method

Return the AttributeDefinition node with the specified name.

The name parameter is the name of the attribute.

When invoked, the method MUST return the AttributeDefinition node, whose nodeName attribute value is equal to name, in the NamedNodeMap in the attributeDefinitions attribute of the node. If there is no such node, it MUST return null.

setAttributeDefinitionNode, method

@@

The AttributeDefinition Interface

The nodes of type ATTRIBUTE_DEFINITION_NODE represents an attribute definition. Such a node MUST implement the AttributeDefinition interface, which extends the Node interface.

An attribute definition represents a definition of the attribute associated to an element type. It is corresponding to the attribute definition in the attribute list declaration in DTD. However, an AttributeDefinition node does not represent the attribute definition in DTD itself. Even if there are more than one attribute definitions for an attribute of an element type in DTD, the result DOM will contain only an AttributeDefinition node for that attribute.

An AttributeDefinition node cannot be a child of any node. An AttributeDefinition node can have zero or more child nodes of same kinds as those allowed for Attr nodes [DOM3].

The AttributeDefinition interface MUST be implemented as following:

interface AttributeDefinition : Node {
  // DeclaredValueType
  const unsigned short NO_TYPE_ATTR = 0;
  const unsigned short CDATA_ATTR = 1;
  const unsigned short ID_ATTR = 2;
  const unsigned short IDREF_ATTR = 3;
  const unsigned short IDREFS_ATTR = 4;
  const unsigned short ENTITY_ATTR = 5;
  const unsigned short ENTITIES_ATTR = 6;
  const unsigned short NMTOKEN_ATTR = 7;
  const unsigned short NMTOKENS_ATTR = 8;
  const unsigned short NOTATION_ATTR = 9;
  const unsigned short ENUMERATION_ATTR = 10;
  const unsigned short UNKNOWN_ATTR = 11;

  // DefaultValueType
  const unsigned short UNKNOWN_DEFAULT = 0;
  const unsigned short FIXED_DEFAULT = 1;
  const unsigned short REQUIRED_DEFAULT = 2;
  const unsigned short IMPLIED_DEFAULT = 3;
  const unsigned short EXPLICIT_DEFAULT = 4;
  
  readonly attribute ElementTypeDefinition ownerElementTypeDefinition;

  readonly attribute unsigned short declaredType;
  readonly attribute DOMStringList allowedTokens;
  readonly attribute unsigned short defaultType;
}

ownerElementTypeDefinition of type ElementTypeDefinition, read‐only

The ElementTypeDefinition to which the AttributeDefinition node belongs.

On getting, the attribute MUST return an ElementTypeDefinition node. It MUST be such a node that whose attributeDefinitions attribute contains the NamedNodeMap object that contains the AttributeDefinition node. If there is no such an ElementTypeDefinition node, then null MUST be returned.

declaredType of type unsigned short

The declared type @@ ref of the attribute. It is expected that this attribute contains a value from the definition group DeclaredValueType.

On getting, the attribute MUST return the value associated to this attribute.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the AttributeDefinition node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to this attribute.

If the AttributeDefinition node is created during the process to create a DOM from an XML document, an appropriate value from the DeclaredValueType constant group MUST be set to the attribute.

The definition group DeclaredValueType contains integers indicating the declared type of attributes. The definition group contains the following constants:

Name	Value	Description
NO_TYPE_ATTR	0	No value [INFOSET].
CDATA_ATTR	1	CDATA [XML].
ID_ATTR	2	ID [XML].
IDREF_ATTR	3	IDREF [XML].
IDREFS_ATTR	4	IDREFS [XML].
ENTITY_ATTR	5	ENTITY [XML].
ENTITIES_ATTR	6	ENTITIES [XML].
NMTOKEN_ATTR	7	NMTOKEN [XML].
NMTOKENS_ATTR	8	NMTOKENS [XML].
NOTATION_ATTR	9	NOTATION [XML].
ENUMERATION_ATTR	10	Enumeration [XML].
UNKNOWN_ATTR	11	Unknown, because no declaration for the attribute has been read but the [all declaration processed] property [INFOSET] would be false.

If no attribute type information is available, or if the source of the information does not distinguish no value and unknown [INFOSET], then the value NO_TYPE_ATTR MUST be used.

An AttributeDefinition node created by the createAttributeDefinition method has its declaredType attribute set to NO_TYPE_ATTR.

If the source of the information does not distinguish no value and/or unknown [INFOSET] and CDATA [XML], then the value CDATA_ATTR MUST be used.

In Perl binding [PERLBINDING], the Attr nodes MUST implement the DeclaredValueType definition group.

allowedTokens of type DOMStringList, read‐only

The list of allowed attribute values.

On getting, the attribute MUST return the DOMStringList object associated to this attribute. The object MAY contain zero or more ordered strings, consist of zero or more characters respectively, possibly with duplications. The object MUST be read‐only if and only if the node is read‐only.

If the AttributeDefinition node is created during the process to create a DOM from an XML document, the object MUST contain the names or name tokens allowed for the attribute defined by the node. If the document is well‐formed, the object will be empty unless the declaredType is ENUMERATION_ATTR or NOTATION_ATTR.

If the declaredType is different from ENUMERATION_ATTR or NOTATION_ATTR, this attribute MUST be ignored for the purpose of serializing into (part of) XML document.

When serializing the node it should be noted that the object might be empty, might contain duplications, and might contain strings that are not names or name tokens.

defaultType of type unsigned short

The type of the default for the attribute. It is expected that this attribute contains a value from the definition group DefaultValueType.

On getting, the attribute MUST return the value associated to this attribute.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the AttributeDefinition node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to this attribute.

If the AttributeDefinition node is created during the process to create a DOM from an XML document, an appropriate value from the DefaultValueType definition group MUST be set to the attribute.

The definition group DefaultValueType contains integers indicating the type of the default for the attribute. The definition group contains the following constans:

Name	Value	Description
UNKNOWN_DEFAULT	0	Unknown.
FIXED_DEFAULT	1	Provided explicitly and fixed @@ ref to that value.
REQUIRED_DEFAULT	2	No default value and the attribute have to be explicitly specified.
IMPLIED_DEFAULT	3	Implied @@ ref.
EXPLICIT_DEFAULT	4	Provided explicitly.

If the source of the default type does not distinguish implied and unknown default types, then the value IMPLIED_DEFAULT MUST be used.

An AttributeDefinition node created by the createAttributeDefinition method has its defaultType attribute set to UNKNOWN_DEFAULT.

Modifications to the Entity Interface

The implementation of the Entity interface MUST be modified as following:

// Modifications to the Entity interface
  attribute DOMString publicId;
  attribute DOMString systemId;
  attribute DOMString notationName;

  // Additions to the Entity interface
  attribute DOMString hasReplacementTree;
  readonly attribute DocumentType ownerDocumentTypeDefinition;

  attribute boolean isExternallyDeclared;

The notationName attribute of the Entity interface is no longer read‐only.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to the attribute. No lexical validation is performed. The new value MAY be null.

hasReplacementTree of type boolean

Whether the structure of the replacement text of the entity is available via the NodeList object in the childNodes attribute of the entity.

On getting, the attribute MUST return the value associated to this attribute.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to this attribute.

The attribute can be set to false even if the Entity node has any child node. If the attribute is set to false, then any child node of the Entity node ought to be ignored, say, for the purpose of serialization.

When an EntityReference node is created by cloning the replacement subtree of the Entity node, if the attribute is set to false, then any descendant of the node MUST be ignored.

If the Entity node is created during the process to create a DOM from an XML document, the following requirements are applied: If the entity is an unparsed entity, then the attribute MUST be set to false. Otherwise, if the entity is an external entity whose replacement text is not available, or whose replacement text is not converted to a replacement tree, then the attribute MUST be set to false. Otherwise, the attribute MUST be set to true.

An Entity node created by the createGeneralEntity method has its hasReplacementTree attribute set to false.

isExternallyDeclared of type boolean

Whether the entity is declared by an external entity declaration or not. If the value is true, the entity is declared in an entity declaration in the external subset entity or in an external parameter entity. If the value is false, the entity is declared in an entity declaration in the internal subset, or the node is created in memory.

On getting, the attribute MUST return the value associated to this attribute.

On setting, the attribute MUST raise a NO_MODIFICATION_ALLOWED_ERR @@ ref exception if the node is read‐only @@ ref. Otherwise, it MUST set the specified value as the value associated to this attribute.

If the Entity node is created during the process to create a DOM from an XML document, the following requirements are applied: If the entity is an unparsed entity, then the attribute MUST be set to false. Otherwise, i.e. the entity is a parsed entity, then the attribute MUST be set to the value of whether the entity is declared by an external markup declaration or not.

Modifications to the Notation Interface

The implementation of the Notation interface MUST be modified as following:

// Modifications to the Notation interface
  attribute DOMString publicId;
  attribute DOMString systemId;

  // Addition to the Notation interface
  readonly attribute DocumentType ownerDocumentTypeDefinition;