XML mention domain

3.16.10 XML mention domain

Use the XML-mention domain elements for mentions of named XML constructs, including elements, attributes, entities, processing instructions, and document-type declaration components. These elements enable specific typographic effects for different construct types, precise search and retrieval of specific constructs, and automatic indexing of different constructs. This domain is intended to support the description and documentation of XML document types and XML applications.

Note: Although the original XML 1.0 Recommendation specifically reserved element names beginning with "xml" or "XML"' for the use of the XML standard itself, the subsequent introduction of namespaces made the restriction unnecessary. The restriction was formally removed in the XML 1.0 Fifth Edition Specification Errata. The OASIS DITA Technical Committee acknowledges this revised policy in its use of the semantically precise prefix "xml" for the XML mention domain.

3.16.10.1 numcharref
Use the <numcharref> element to identify mentions of XML numeric character references, for example, "
" or "
". This element enables more precise semantic searching of the DITA source; it also enables distinct output formatting. The content of the <numcharref> element should be the numeric value without any leading or trailing characters added as style, for example, "10" or "x0a". This element is part of the XML mention domain.
3.16.10.2 parameterentity
Use the <parameterentity> element to identify mentions of parameter entities, for example, "%keyword.content;". This element enables more precise semantic searching of the DITA source; it also enables distinct formatting, such as adding the percentage sign (%) or trailing semi-colon (;) delimiters to the parameter entity name. The content of the <parameterentity> element should be the entity name without the leading percentage sign or trailing semi-colon. This element is part of the XML mention domain.
3.16.10.3 textentity
Use the <textentity> element to identify mentions of XML text entities, for example, "&xml-d-att;". This element enables more precise semantic searching of the DITA source; it also enables distinct formatting, such as adding an ampersand (&) as a leading character and a semi-colon (;) as a trailing character. The content of the <textentity> element should be the entity name without the ampersand and semi-colon delimiters. This element is part of the XML mention domain.
3.16.10.4 xmlatt
Use the <xmlatt> element to identify mentions of XML attributes, for example, @audience. This element enables more precise semantic searching of the DITA source; it also enables distinct formatting, such as preceding the name of the attribute with a commercial at (@) sign. The content of the <xmlatt> element should be the attribute name without commercial at or equals (=) characters. This element is part of the XML mention domain.
3.16.10.5 xmlelement
Use the <xmlelement> element to identify mentions of XML element types. This element enables more precise semantic searching of the DITA source; it also enables distinct formatting, such as surrounding the name of the element with angle brackets. The content of the <xmlelement> element should be the element type name without leading or trailing angle brackets. This element is part of the XML mention domain.
3.16.10.6 xmlnsname
Use the <xmlnsname> element to identify mentions of namespace names, for example, "http://dita.oasis-open.org/architecture/2005/". This element enables more precise semantic searching of the DITA source; it also enables distinct formatting. This element is part of the XML mention domain.
3.16.10.7 xmlpi
Use the <xmlpi> element to identify mentions of processing instruction names, such as <?piname pi value?>. This element enables more precise semantic searching of the DITA source; it also enables distinct formatting. This element is part of the XML mention domain.

Parent topic: 3.16 Technical-content domains elements

Previous topic: 3.16.9.5 screen

Next topic: 3.16.10.1 numcharref

Return to main page.