<http://suika.fam.cx/www/markup/xml/domdtdef/domdtdef-work><http://suika.fam.cx/www/markup/xml/domdtdef/domdtdef><http://suika.fam.cx/www/markup/xml/domdtdef/domdtdef-work><http://suika.fam.cx/gate/cvs/markup/xml/domdtdef/domdtdef-work.en.html><w@suika.fam.cx>© Wakaba.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License,
Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front‐Cover Texts, and no Back‐Cover
Texts. A copy of the license is
available at <http://www.gnu.org/copyleft/fdl.html>.
This section describes the status of this document at the time of its publication. Other documents might supersede this document.
This document is a working draft, produced as part of the
manakai
project. It might be updated, replaced, or obsoleted by
other documents at any time. It is inappropriate to
cite this document as other than work in progress
.
Comments on this document are welcome and may be sent to the author.
Translations of thie document might be available. The English version of the document is the only normative version.
This section is non‐normative.
This is a work-in-progress specification for DOM Document Type Definition module, as implemented by manakai and partially documented in the SuikaWiki.
The DOM Document Type Definition module is a set of DOM interfaces, including both new interfaces and modifications to existing DOM interfaces, over which DOM applications are able to access to the definitions of the document type.
Interfaces defined in this specification are partially modeled from early drafts of DOM level 1 @@ ref, DOM Abstract Schema level 3 @@ ref, and XML Schema API, but are not compatible with any of them as a whole.
The key words MUST
,
MUST NOT
,
SHOULD
,
SHOULD NOT
, and
MAY
in this
document are to be interpreted as described in
RFC
2119
[KEYWORDS].
All examples and notes in this specification are non‐normative, as are all sections explicitly marked non‐normative. Everything else in this specification is normative.
Algorithm is normative but non-normative. In addition, the order in which errors are raised is undefined.
A object is an object implementing A interface.
@@ ref to DOM Binding Spec
The DOM Document Type Definition module, version 3.0, consists of three interfaces:
In addition, it adds methods, attributes, and/or constants to interfaces
Node,
Entity,
EntityReference, and
Notation.
It modifies semantics of some of methods and attributes in
Node and
ProcessingInstruction
interfaces, for the support of new interfaces.
In a DOM implementation that supports the version 3.0 of
the DOM Document Type Definition module, the
hasFeature method of a DOMImplementation object
MUST return true when the parameters are
set to http://suika.fam.cx/www/2006/feature/XDoctype and
3.0 respectively.
In such an implementation, the getFeature method of a
Document object MUST return the (at least
conceptually) same object implementing the
DocumentXDoctype interface when
the parameters are set to
http://suika.fam.cx/www/2006/feature/XDoctype and
3.0 respectively. Likewise, any method that takes one or more
feature names with or without version number, including the methods
hasFeature and getFeature,
MUST behave in a manner consistent with the
aforementioned cases.
DocumentXDoctype Interfaceinterface 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,
methodThis 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, parentNodenull.elementTypes, generalEntities, and
notationsNamedNodeMap objects.entitiesgeneralEntities attribute.childNodesNodeList object.internalSubset, publicId, and
systemIdmanakaiReadOnly [manakai]false.nodeNameownerDocumentDocument 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,
methodThis 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:
attributeDefinitionsNamedNodeMap object.attributes, parentNodenull.childNodesNodeList object.manakaiReadOnly [manakai]false.nodeNameownerDocumentDocument node over which the method is invoked.ownerDocumentTypeDefinitionnull.createAttributeDefinition,
methodThis 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:
allowedTokensDOMStringList object.attributes,
ownerElementTypeDefinition,
and parentNodenull.childNodesNodeList object.declaredTypeNO_TYPE_ATTR.defaultTypeUNKNOWN_DEFAULT.manakaiReadOnly [manakai]false.nodeNameownerDocumentDocument node over which the method is invoked.@@ 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,
methodThis 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 parentNodenull.childNodesNodeList object.manakaiDeclarationBaseURI,
manakaiEntityBaseURI, and
manakaiEntityURI @@ refmanakaiHasReplacementTree and
manakaiReadOnly [manakai]false.nodeNameownerDocumentDocument node over which the method is invoked.publicId, and systemIdnull.createNotation,
methodThis 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 parentNodenull.childNodesNodeList object.manakaiDeclarationBaseURImanakaiReadOnly [manakai]false.nodeNameownerDocumentDocument node over which the method is invoked.publicId and systemIdnull.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.
Non‐XML case is intentionally left unspecified for now,
since DOM3 specification @@ ref does not
define it for Document methods.
name does not have to be a namespace qualified name.
If the strictErrorChecking attribute of the
Document node is false, the methods are
not required to raise the exception [DOM3].
DocumentTypeDefinition Interfaceinterface DocumentTypeDefinition {
readonly attribute NamedNodeMap elementTypes;
readonly attribute NamedNodeMap generalEntities;
readonly attribute NamedNodeMap notations;
more members come here...
}[1] In an implementation that supports the [CODE(URI)@en[[[http://suika.fam.cx/www/2006/feature/XDoctype]]]] feature, a [CODE(DOMi)@en[[[DocumentType]]]] node must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface. See [[DOM XML Document Type Definition]>>3] for details.
elementTypes of
type NamedNodeMap, read‐onlyA live NamedNodeMap object that contains all the element
type definitions belonging to the DocumentType node.
On getting, the attribute MUST return the
NamedNodeMap object that contains all the
ElementTypeDefinition
nodes belonging to the DocumentType 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 DocumentType node is created during the process
to create a DOM from an XML document, the following
requirements are applied: The NamedNodeMap object in the
elementType attribute
MUST be so transformed that the object contains
the ElementTypeDefinition nodes for the element types
whose name is presented as the Name of the element type or
attribute definition list declarations processed by the XML
processor. If there is more than one element type declarations for an
element type, then the declarations other than the first one
MUST be ignored for the purpose of constructing the
NamedNodeMap object.
generalEntities
of type NamedNodeMap, read‐onlyA live NamedNodeMap object that contains all the general
entities belonging to the DocumentType node.
On getting, the attribute MUST return the
same value as the entities attribute (defined in the
DocumentType interface) of the same node.
This attribute is part of the interface for historical reason.
notations of type
notations, read‐only
A live NamedNodeMap object that contains all the
notations belonging to the DocumentType node.
On getting, the attribute MUST return the
same value as the notations attribute (defined in the
DocumentType interface) of the same node.
This attribute is part of the interface for historical reason.
Implementations are not required to implement the
notations attribute twice (for DocumentType
and DocumentTypeDefinition interfaces); they share exactly
same definition.
A future version of this interface might define the
parameterEntities and getter/setter for parameter entities.
ElementTypeDefinition Interfaceinterface ElementTypeDefinition {
}** Modifications to [CODE(DOMi)@en[[[Node]]]] members [3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object [['''MUST''']] return [CODE(IDL)@en[[[null]]]]. [4] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object [['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object. Note that it might be [CODE(IDL)@en[[[null]]]]. [1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object [['''MUST''']] return the name of the element type. [2] The getters of the [CODE(DOMa)@en[[[nodeValue]]]] and [CODE(DOMa)@en[[[textContent]]]] attributes of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object [['''MUST''']] return [CODE(IDL)@en[[[null]]]]. ;; Thus, the setter of these attributes do nothing. The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object [['''MUST NOT''']] throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. ** The [CODE(DOMi)@en[ElementTypeDefinition]] Interface [5] The [DFN@en[[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute]] of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] interface is defined in [[manakai//DOM Extensions]>>50].
AttributeDefinition Interfaceinterface AttributeDefinition {
}** Modifications to [CODE(DOMi)@en[[[Node]]]] members [3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] return [CODE(IDL)@en[[[null]]]]. [9] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the [CODE(DOMi)@en[[[AttributeDefinition]]]] object. Note that it might be [CODE(IDL)@en[[[null]]]]. [1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] return the name of the attribute. [2] The getter of the [CODE(DOMa)@en[[[nodeValue]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] return the normalized default value of the attribute. @@ [4] The getter of the [CODE(DOMa)@en[[[textContent]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] behave as if it were an [CODE(DOMi)@en[[[Attr]]]] object. The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object [['''MUST''']] behave as if the following algorithm is performed: = If the [CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only, then throw an [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. = Remove any child node the node has. = If the new value is not empty and not [CODE(IDL)@en[[[null]]]], then create a [CODE(DOMi)@en[[[Text]]]] node whose [CODE(DOMa)@en[[[data]]]] is the new value and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. ** Definition groups [6] The [DFN@en[definition group [CODE(DOM)@en[[[DeclaredValueType]]]]]] contains integers indicating the type of attribute value: ,[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]],[CODE(IDL)[[[0]]]],The attribute value type corresponding to [[no value]] in XML Information Set. ,[CODE(DOMc)@en[[[CDATA_ATTR]]]],[CODE(IDL)[[[1]]]],The attribute value type is [CODE(XML)@en[[[CDATA]]]]. ,[CODE(DOMc)@en[[[ID_ATTR]]]],[CODE(IDL)[[[2]]]],The attribute value type is [CODE(XML)@en[[[ID]]]]. ,[CODE(DOMc)@en[[[IDREF_ATTR]]]],[CODE(IDL)[[[3]]]],The attribute value type is [CODE(XML)@en[[[IDREF]]]]. ,[CODE(DOMc)@en[[[IDREFS_ATTR]]]],[CODE(IDL)[[[4]]]],The attribute value type is [CODE(XML)@en[[[IDREFS]]]]. ,[CODE(DOMc)@en[[[ENTITY_ATTR]]]],[CODE(IDL)[[[5]]]],The attribute value type is [CODE(XML)@en[[[ENTITY]]]]. ,[CODE(DOMc)@en[[[ENTITIES_ATTR]]]],[CODE(IDL)[[[6]]]],The attribute value type is [CODE(XML)@en[[[ENTITIES]]]]. ,[CODE(DOMc)@en[[[NMTOKEN_ATTR]]]],[CODE(IDL)[[[7]]]],The attribute value type is [CODE(XML)@en[[[NMTOKEN]]]]. ,[CODE(DOMc)@en[[[NMTOKENS_ATTR]]]],[CODE(IDL)[[[8]]]],The attribute value type is [CODE(XML)@en[[[NMTOKENS]]]]. ,[CODE(DOMc)@en[[[NOTATION_ATTR]]]],[CODE(IDL)[[[9]]]],The attribute value type is [CODE(XML)@en[[[NOTATION]]]]. ,[CODE(DOMc)@en[[[ENUMERATION_ATTR]]]],[CODE(IDL)[[[10]]]],The attribute value is enumeration type. ,[CODE(DOMc)@en[[[UNKNOWN_ATTR]]]],[CODE(IDL)[[[11]]]],"The attribute value type is unknown, because no declaration for the attribute has been read but not [CODE(InfoProp)@en[[[all declarations processed]]]] property would be false." The type of these constants are [CODE(IDL)@en[[[unsigned]] [[short]]]]. If no attribute type information is provided, or if the source of that information does not distinguish [[no value]] and [[unknown]] as in XML Information Set, then the [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]] value [['''MUST''']] be used. ;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]] object by [CODE(DOMm)@en[[[createAttributeDefinition]]]] method has [CODE(DOMa)@en[[[declaredType]]]] attribute set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. If the source of the attribute type information does not distinguish [[no value]] and / or [[unknown]] and [CODE(XML)@en[[[CDATA]]]], then the [CODE(DOMc)@en[[[CDATA_ATTR]]]] value [['''MUST''']] be used. [11] In Perl binding, the objects implementing the [CODE(DOMi)@en[[[Attr]]]] interface [['''MUST''']] also implement the [CODE(DOM)@en[[[DeclaredValueType]]]] constant group. [7] The [DFN@en[definition group [CODE(DOM)@en[[[DefaultValueType]]]]]] contains integers indicating the type of default attribute value: ,[CODE(DOMc)@en[[[UNKNOWN_DEFAULT]]]],[CODE(IDL)[[[0]]]],The default value is unknown. ,[CODE(DOMc)@en[[[FIXED_DEFAULT]]]],[CODE(IDL)[[[1]]]],The default value is provided and the attribute is [CODE(XML)@en[#[[FIXED]]]] to that value. ,[CODE(DOMc)@en[[[REQUIRED_DEFAULT]]]],[CODE(IDL)[[[2]]]],An attribute specification is [CODE(XML)@en[#[[REQUIRED]]]] for the attribute. ,[CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]],[CODE(IDL)[[[3]]]],The default value is [CODE(XML)@en[#[[IMPLIED]]]]. ,[CODE(DOMc)@en[[[EXPLICIT_DEFAULT]]]],[CODE(IDL)[[[4]]]],The default value is provided but the attribute is not fixed to it. The type of these constants are [CODE(IDL)@en[[[unsigned]] [[short]]]]. If the source of the attribute default value type does not distinguish the [CODE(XML)@en[#[[IMPLIED]]]] default and unknown default, then the [CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]] value [['''MUST''']] be used. ;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]] object by [CODE(DOMm)@en[[[createAttributeDefinition]]]] method has [CODE(DOMa)@en[[[declaredType]]]] attribute set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. ** Tree-relationship Attributes [10] The [DFN@en[[CODE(DOMa)@en[[[ownerElementTypeDefinition]]]] attribute]] of the [CODE(DOMi)@en[[[AttributeDefinition]]]] interface is read-only and of type [CODE(DOMi)@en[[[ElementTypeDefinition]]]]. It is the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node which the [CODE(DOMi)@en[[[AttributeDefinition]]]] node belong to. If the [CODE(DOMi)@en[[[AttributeDefinition]]]] node is included in the [CODE(DOMa)@en[[[attributeDefinitions]]]] list of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node, then the attribute [['''MUST''']] return the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node. Otherwise, it [['''MUST''']] return [CODE(DOM)@en[[[null]]]]. ;; This attribute is analogue to the [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute for [CODE(DOMi)@en[[[ElementTypeDefinition]]]], [CODE(DOMi)@en[[[Entity]]]], and [CODE(DOMi)@en[[[Notation]]]] nodes, or the [CODE(DOMa)@en[[[ownerElement]]]] attribute for [CODE(DOMi)@en[[[Attr]]]] nodes. ** Attributes [5] The [DFN@en[[CODE(DOMa)@en[[[declaredType]]]] attribute]] of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object represents the type of the attribute value. This attribute is read-write. The type of the attribute is [CODE(IDL)@en[[[unsigned]] [[short]]]]. It is expected that this attribute has a value from the definition group [CODE(DOM)@en[[[DeclaredValueType]]]]. The getter [['''MUST''']] return a value associated to this attribute. The setter [['''MUST''']] throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]] [CODE(DOMi)@en[[[DOMException]]]] if the [CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only. Otherwise, the setter [['''MUST''']] set the specified value as the value associated to this attribute. If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]] object, then it [['''MUST''']] set a value from the [CODE(DOM)@en[[[DeclaredValueType]]]] definition group. [8] The [DFN@en[[CODE(DOMa)@en[[[defaultType]]]] attribute]] of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object represents the type of the attribute default value. This attribute is read-write. The type of the attribute is [CODE(IDL)@en[[[unsigned]] [[short]]]]. It is expected that this attribute has a value from the definition group [CODE(DOM)@en[[[DefaultValueType]]]]. The getter [['''MUST''']] return a value associated to this attribute. The setter [['''MUST''']] throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]] [CODE(DOMi)@en[[[DOMException]]]] if the [CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only. Otherwise, the setter [['''MUST''']] set the specified value as the value associated to this attribute. If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]] object, then it [['''MUST''']] set a value from the [CODE(DOM)@en[[[DefaultValueType]]]] definition group.
<http://www.w3.org/TR/xml>.
This version of the specification is referenced.<http://www.w3.org/TR/CSS21>.<http://dev.w3.org/csswg/cssom/Overview.html>.<http://dev.w3.org/2006/webapi/selectors-api/Overview.html>.
The latest published version of the specification is available at
<http://www.w3.org/TR/selectors-api/>.<http://www.w3.org/TR/xbl/>.