| Version: | 0.2 |
|---|---|
| Creator: | Lars Marius Garshol - larsga@garshol.priv.no |
| PublicId: | -//LM Garshol//DTD Documentation DTD 0.2//EN |
The DTD Documentation DTD can be used to document XML DTDs in XML. The intention is that the XML documentation should supplement the DTD itself and that the two together should make up the complete documentation.
| attribute | Documentation of an attribute. |
| attribute-group | Documentation of a common group of attributes. |
| attribute-group-ref | A reference to an attribute-group. |
| creator | A container element for information about the DTD creator. |
| descr | A description. |
| dtd-info | A container for DTD metadata. |
| dtddoc | The root element. |
| element | Documentation of an element. |
| elemref | A reference to an element. |
| An email address. | |
| homep | The URL of a home page. |
| name | The name of some entity related to the DTD. |
| one-line | A short description. |
| pubid | The public identifier for the DTD. |
| root-elements | A list of root elements. |
| shortname | A short name, abbreviation or acronym by which the DTD is known. |
| version | The version identifier for the DTD. |
Documentation of an attribute. This element contains the documentation of an attribute. It appears inside the element element to document the attribute in the context of a specific element.
Documentation of a common group of attributes. This element defines a group of documented attributes which can be referred to as a unit from elements which support this attribute group. Use attribute-group-ref to refer to attribute-group elements.
A reference to an attribute-group. This element is used within the documentation of an element to refer to a group of attributes supported by the element and documented with an attribute-group element.
A container element for information about the DTD creator. This element has no special significance apart from that it groups information about a DTD creator.
A description. This element should contain a textual description. The one-line child element can be used to distinguish the first part of the description as an abbreviated description.
A container for DTD metadata. This element contains other elements with information about the DTD, such as name, version and public identifier.
The root element. The dtddoc element is just the root element of the DTD and has no special significance.
Must appear as the root element.
Documentation of an element. This element contains the documentation of an element.
A reference to an element. This element is used inside the descr element to refer to other elements. It must contain the name of another element and nothing else.
An email address. This element should contain an email address.
The URL of a home page. This element should contain the URL of a home page.
The name of some entity related to the DTD. This element contains the full name of some entity which appears in the DTD documentation, such as the DTD itself, the DTD creator, an element type etc.
attribute attribute-group creator dtd-info element root-elements
A short description. This element is used inside the descr element to distinguish the first part of the description.
The public identifier for the DTD. This is the preferred public identifier for the DTD, which may or may not be a formal public identifier.
A list of root elements. This element is used to list the allowed root elements of the DTD.
A short name, abbreviation or acronym by which the DTD is known. This is often the same name as the root element of the DTD, and is intended mainly for convenience. For the Text Encoding Initiative DTD the shortname would be TEI.
The version identifier for the DTD. This is whatever identifier the DTD used for the documented version. There are no particular requirements on this identifier.