Home
Language reference: All-inclusive edition
The language reference portion of the DITA specification contains a topic for each DITA element. The topic defines the element, its inheritance hierarchy, and provides examples of usage. This portion of the DITA specification also includes information about DITA attributes.
Domain elements
General purpose domains are not specific to any type of information, such as the hazard statement domain that provides elements for describing hazardous situations.
DITAVAL reference domain
The DITAVAL reference domain is used to reference a DITAVAL file that contains conditions that apply only to a subset of a DITA map. It also can be used to replicate a subset of a DITA map for multiple audiences.
<dvrKeyscopeSuffix>
The <dvrKeyscopeSuffix> element specifies the suffix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.

Specification URIs
Notices
Introduction to DITA 1.3
The Darwin Information Typing Architecture (DITA) specification defines a set of document types for authoring and organizing topic-oriented information, as well as a set of mechanisms for combining, extending, and constraining document types.
Architectural specification: All-inclusive edition
The architectural specification portion of the DITA specification outlines the framework of DITA. It contains an overview of DITA markup; addressing; processing; configuration, specialization, generalization, and constraints; as well as information about coding DITA grammar files.
Language reference: All-inclusive edition
The language reference portion of the DITA specification contains a topic for each DITA element. The topic defines the element, its inheritance hierarchy, and provides examples of usage. This portion of the DITA specification also includes information about DITA attributes.
- Element quick reference
  This section contains a listing of DITA elements.
- Topic elements
  The base topic elements include elements that make up the core building blocks of the DITA topic, such as topic, body, and related-links, as well as elements like <p> and <ph> that are used in many topic specializations. Some of these elements are also available inside the <topicmeta> map element.
- Map elements
  Map elements include the core components of DITA maps, such as <topicref> and <reltable>, as well as general purpose map specializations in the map group domain.
- Metadata elements
  Metadata elements include information that is located within the <topicmeta> element (in maps) or <prolog> element (in topics), as well as indexing elements that can be placed in additional locations within topic content.
- Domain elements
  General purpose domains are not specific to any type of information, such as the hazard statement domain that provides elements for describing hazardous situations.
  - Hazard statement elements
    The hazard statement domain elements are used to provide information about product safety hazards. The domain can be included in any topic type or map. Its elements are used to inform readers about potential hazards, consequences, and avoidance strategies.
  - Highlighting elements
    The highlighting elements are used to highlight text with styles (such as bold, italic, and monospace). Never use these elements when a semantically specific element is available. These elements are not intended for use by specializers, and are intended solely for use by authors when no semantically appropriate element is available and a formatting effect is required.
  - Utilities elements
    The utilities domain elements represent common features of a language that might not necessarily be semantic, such as image maps.
  - DITAVAL reference domain
    The DITAVAL reference domain is used to reference a DITAVAL file that contains conditions that apply only to a subset of a DITA map. It also can be used to replicate a subset of a DITA map for multiple audiences.
    - <ditavalref>
      The <ditavalref> element references a DITAVAL document that specifies filter conditions that can be used to process a map or map branch. Other DITAVAL-reference domain elements can be used to imply multiple copies of the map branch that contains them and so apply a different set of conditions to each copy.
    - <ditavalmeta>
      The <ditavalmeta> element defines metadata that is associated with a DITAVAL document used for one branch of a map.
    - <dvrResourcePrefix>
      The <dvrResourcePrefix> element specifies the prefix to use when constructing the effective file names of the resources that are referenced from within the map branch that is implied by the ancestor <ditavalref> element.
    - <dvrResourceSuffix>
      The <dvrResourceSuffix> element specifies the suffix to use when constructing the effective file names of resources that are referenced from within the map branch that is implied by the ancestor <ditavalref> element.
    - <dvrKeyscopePrefix>
      The <dvrKeyscopePrefix> element specifies the prefix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.
    - <dvrKeyscopeSuffix>
      The <dvrKeyscopeSuffix> element specifies the suffix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.
- Classification elements
  Classification elements support managing metadata. Those in the subject scheme map are used to define controlled values and to bind the controlled values to DITA attributes as enumerations. Those declared in the classification domain are used in other maps to classify content according to the scheme.
- Specialization elements
  Several DITA elements exist either for architectural reasons or for support of specialized markup yet to be designed. Although there is little need to use these elements unless you are directed to, some of them, such as <state>, can be used if your content makes use of these semantic distinctions. For example, a discussion of signals on a gate of an integrated logic circuit might use the <state> element to represent either on or off conditions of that gate.
- Legacy conversion elements
  Conversion elements exist primarily to aid in the conversion of content to DITA.
- DITAVAL elements
  A conditional processing profile (DITAVAL file) is used to identify which values are to be used for conditional processing during a particular output, build, or some other purpose. The profile should have an extension of .ditaval.
- Technical content elements
  Elements in the technical content section include the original Concept, Task, and Reference specializations, as well as specializations added in later releases. It also includes domains designed primarily for technical content.
- Learning and training elements
  Elements in the learning and training section include specialized topics, maps, content, and metadata elements specially designed to support instructional content.
- Attributes
  This section collects commonly used attributes, with common definitions. If an element uses a different definition, or narrows the scope of, an otherwise common attribute, it will be called out in the topic that defines the element.
Conformance
Conformance to the DITA specification allows documents and document types that are used with different processors or different versions of a processor to produce the same or similar results with little or no reimplementation or modification.
Acknowledgments
(Non-normative) Many members of the OASIS DITA Technical Committee participated in the creation of this specification and are gratefully acknowledged.
Non-normative information
This section contains non-normative information, including topics about new features in DITA 1.3 and migrating from DITA 1.2 to DITA 1.3.
Content models for learning and training package
For each element in the learning and training package, this section presents the content model and a list of parent elements that can contain that element.

`<dvrKeyscopeSuffix>`

The <dvrKeyscopeSuffix> element specifies the suffix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.

For map branches that are implied by <ditavalref> elements, the value of the <dvrKeyscopeSuffix> element contributes to the effective key scope names of the branch. The effective key scope names end with the value of the <dvrKeyscopeSuffix> element. Note that if the branch as authored does not specify a @keyscope value, specifying <dvrKeyscopeSuffix> (without also specifying <dvrKeyscopePrefix>) results in the branch establishing a key scope whose name is the value of the <dvrKeyscopeSuffix> element. The full key scope names also will reflect the value of a <dvrKeyscopePrefix> element if one is specified, regardless of whether the branch as authored specifies a @keyscope value.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/data ditavalref-d/dvrKeyscopeSuffix

Example

If the <dvrKeyscopeSuffix> is specified in the following way:

<topicref keys="branch-01"
    href="branch-01.dita" 
    keyscope="branch-01"
  >
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrKeyscopeSuffix>-cond01</dvrKeyscopeSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>

Then the effective key scope name for the branch "branch-01" is "branch-01-cond01".

Attributes

The following attributes are available on this element: Universal attribute group (except for @conkeyref, which is removed for all elements in this domain) and the attribute defined below.

@name: The name of the metadata item. For this element the default value is "dvrKeyscopeSuffix".