OASIS grammar files

This section is non-normative.

This section provides information about the grammar files that are provided in the DITA base edition.

This section is non-normative.

The OASIS DITA Technical Committee uses certain conventions for the names of XML grammar files. We suggest using these conventions as a way to facilitate the interchange of grammar files.

DTD-based specialization modules

The DITA Technical Committee uses certain file-naming conventions for DTD-based specialization modules. While the grammar files shipped with DITA 2.0 do not include domain constraint or expansion modules, we suggest conventions for those modules also.

Module type File name Example
Structural moduleName.mod topic.mod
Element domain domainNameDomain.ext
  • highlightDomain.ent
  • highlightDomain.mod
Attribute domain attriNameAttDomain.ent deliveryTargetAttDomain.ent
Constraint qualifierTargetConstraint.mod
  • strictTaskbodyConstraint.mod
  • acmeHighlightDomainConstraint.mod
Expansion
  • acme-SectionExpansion.mod
  • acme-CellPurposeAttExpansion.ent
  • acme-otherpropsAttExpansion.mod
  • example-dlentryModeAttExpansion.ent

where:

  • moduleName is the name of the element type, such as "topic" or "map".
  • domainName is the short name of the domain, for example, "highlight" or "utilities".
  • attrName is the name of the specialized attribute, for example, "deliveryTarget".
  • ext is the file extension, for example, "ent" or "mod".
  • qualifier is a string that is specific to the constraints module and characterizes it, for example, "strict" or "requiredTitle" or "myCompany-".
  • Target is the target of the constraint with an initial capital, for example, "Topic" or "HighlightDomain".

RELAX NG-based specialization modules

The DITA Technical Committee uses certain file-naming conventions for RNG-based specialization modules. While the grammar files shipped with DITA 2.0 do not include domain constraint or expansion modules, we suggest conventions for those modules also.

Module type File name Example
Structural moduleNameMod.rng conceptMod.rng
Element domain domainNameDomainMod.rng highlightDomainMod.rng
Attribute domain attrNameAttDomain.rng deliveryTargetAttDomain.rng
Constraint qualifierTargetConstraintMod.rng
  • strictTaskbodyConstraintMod.rng
  • acmeHighlightDomainConstraintMod.rng
Expansion
  • sectionExpansionMod.rng
  • cellPurposeAtt.rng
  • acme-otherpropsAttExpansion.rng
  • tableCellAttExpansion.rng

where:

  • moduleName is the name of the element type, such as "topic" or "map".
  • domainName is the short name of the domain, for example, "highlight" or "utilities".
  • attrName is the name of the specialized attribute, for example, "deliveryTarget".
  • qualifier is a string that is specific to the constraints module and characterizes it, for example, "strict" or "requiredTitle" or "myCompany-".
  • Target is the target of the constraint with an initial capital, for example, "Topic" or "HighlightDomain".

This section is non-normative.

Each DITA grammar file has a globally-unique identifier. This identifier can reference either the latest version or a specific version of the grammar file.

Each of the following grammar files has globally-unique identifier:

  • Document-type shell
  • Structural vocabulary module
  • Element- or attribute domain module
  • Element-configuration module (constraint or expansion)

DTD-based grammar files

The public identifiers for the DTD files that are maintained by OASIS use the following format:

"-//OASIS//DTD DITA version information-type//EN"

where:

  • version either is the specific version number (for example, 2.0) or 2.x, which represents the most recent version of DITA 2.x. Omitting the version number entirely is also equivalent to the most recent version of DITA 2.x.
  • information-type is the name of the topic or map type, for example, Base Topic.

Note that "OASIS" is the owner identifier; this indicates that the artifacts are owned by OASIS. The keyword "DITA" is a convention that indicates that the artifact is DITA-related.

RNG-based grammar files

The URNs for the RNG files that are maintained by OASIS use the following format:

"urn:pubid:oasis:names:tc:dita:rng:information-type.rng:version"

where:

  • version either is the specific version number (for example, 2.0) or 2.x, which represents the most recent version of DITA 2.x. Omitting the version number entirely is also equivalent to the most recent version of DITA 2.x.
  • information-type is the name of the topic or map type, for example, basetopic

Note that oasis is the owner identifier; this indicates that the artifacts are owned by OASIS. The keyword dita is a convention that indicates that the artifact is DITA-related.

This section is non-normative.

The base DITA edition includes a set of attribute- and element-domain specializations. The attribute domains are available for use in both maps and topics, while the element domains vary as to where they can be made available.

Attribute-specialization domains

The following table lists the attribute specializations that are included in the base DITA edition.

Domain Description
@audience Attribute for conditional processing based on target audience
@deliveryTarget Attribute for conditional processing based on target delivery mechanism
@otherprops Attribute for conditional processing when an appropriate semantic is not developed
@platform Attribute for conditional processing based on platform
@product Attribute for conditional processing based on product

Element-domain specializations

The following table lists the element-domain specializations that are included in the base DITA edition.

Domain Purpose Where available Short name
Alternative titles Provides alternative titles for resources Map & topic alternativeTitles-d
DITAVALref Enables filtering a branch of a DITA map Map ditavalref-d
Emphasis Provides <em> and <strong> elements for indicating emphasis Map & topic emphasis-d
Hazard statement Provides a hazard statement element that meets meets ANSI Z535 and ISO 3864 requirements Map & topic hazard-d
Highlighting Provides typographic elements Map & topic hi-d
Map group Provides convenience elements for use in DITA maps Map mapgroup-d
Utilities Provides image maps and a sort key Map & topic ut-d

This section is non-normative.

The DITA specification contains a starter set of document-type shells. These document-type shells are commented and can be used as templates for creating custom document-type shells.

The following table lists the document-type shells that are included in the base DITA edition and the domains that are integrated into them.

Document-type shell Domains included Domains NOT included
Base map

All attribute domains

The following element domains:

  • Alternative titles
  • DITAVAL reference
  • Emphasis
  • Hazard statement
  • Highlighting
  • Map group
  • Utilities
  Not applicable
Base topic

All attribute domains and the following element domains:

  • Alternative titles
  • Emphasis
  • Hazard statement
  • Highlighting
  • Utilities

The following element domains:

  • DITAVAL reference
  • Map group
Subject scheme

All attribute domains

The following element domains:

  • Alternative titles
  • Emphasis
  • Highlighting

The following element domains:

  • DITAVAL reference
  • Hazard statement
  • Map group
  • Utilities