DITA

Specifications
OASIS TC

Cover page information
Notices
Introduction
DITA terminology, notation, and conventions
Overview of DITA
Accessibility and translation
- Accessibility
- Translation and localization
DITA map processing
DITA addressing
DITA processing
Configuration and specialization
Element reference
- DITA elements, A to Z
- DITA attributes, A to Z
- Topic elements
  - Basic topic elements
    - abstract
    - body
    - bodydiv
    - dita
    - prolog
    - related-links
    - shortdesc
    - title
    - titlealt
    - topic
  - Body elements
    - alt
    - cite
    - dd
    - ddhd
    - desc
    - div
    - dl
    - dlentry
    - dlhead
    - draft-comment
    - dt
    - dthd
    - example
    - fallback
    - fig
    - figgroup
    - fn
    - image
    - include
    - keyword
    - li
    - lines
    - longdescref
    - lq
    - note
    - object
    - ol
    - p
    - param
    - ph
    - pre
    - q
    - section
    - sl
    - sli
    - term
    - text
    - tm
    - ul
    - xref
  - Multimedia elements
    - audio
    - media-source
    - media-track
    - video
    - video-poster
  - Indexing elements
  - Related links elements
    - link
    - linkinfo
    - linklist
    - linkpool
    - linktext
  - Table elements
    - colspec
    - entry
    - row
    - simpletable
    - stentry
    - sthead
    - strow
    - table
    - tbody
    - tgroup
    - thead
- Map elements
  - Basic map elements
    - keytext
    - map
    - navref
    - relcell
    - relcolspec
    - relheader
    - relrow
    - reltable
    - topicref
    - topicmeta
    - ux-window
  - Subject scheme elements
- Metadata elements
  - Descriptive metadata
    - audience
    - author
    - category
    - keywords
    - othermeta
    - prodinfo
    - publisher
    - prodname
    - prognum
  - Lifecycle management metadata
    - copyrholder
    - copyright
    - copyryear
    - created
    - critdates
    - metadata
    - permissions
    - resourceid
    - revised
    - source
  - Product information metadata
    - brand
    - component
    - featnum
    - platform
    - series
    - vrmlist
    - vrm
- Specialization elements
- Domain elements
- Other elements
  - Legacy conversion elements
    - required-cleanup
  - DITAVAL elements
    - alt-text
    - endflag
    - prop
    - revprop
    - startflag
    - style-conflict
    - val
- Attributes
Conformance
Acknowledgments
Aggregated RFC-2119 statements
Coding practices for DITA grammar files
Constraint modules
- Examples: Constraints implemented using DTDs
- Examples: Constraints implemented using RNG
Expansion modules
- Examples: Expansion implemented using DTDs
- Examples: Expansion implemented using RNG
Element-by-element recommendations for translators
Formatting expectations
Migrating to DITA 2.0
- Changes from DITA 1.3 to DITA 2.0
- Information about migrating to DITA 2.0
OASIS grammar files
Processing interoperability considerations
Revision history

Examples of scoped keys

This section is non-normative.

This section of the specification contains examples and scenarios. They illustrate how scoped keys can be used.

Example: Scoped key definitions for variable text
Scoped key definitions can be used for variable text. This enables you to use the same DITA topic multiple times in a DITA map, and in each instance the variable text can resolve differently.
Example: References to scoped keys
You can address scoped keys from outside the key scope in which the keys are defined.
Example: Key definitions in nested key scopes
In this scenario, the root map contains nested key scopes, each of which contain duplicate key definitions. The effective key definition depends on key-scope precedence rules.
Example: Key scopes and omnibus publications
Key scopes enable you to create omnibus publications that include multiple submaps that define the same key names for common items, such as product names or common topic clusters.
Example: How key scopes affect key precedence
For purposes of key definition precedence, the scope-qualified key definitions from a child scope are considered to occur at the location of the scope-defining element within the parent scope.
Example: How key scopes with the same name interact
In a large publication it is possible that two sets of content will use the same key scope name. These scopes have no relationship with each other aside from the shared name; key definitions in one are not shared with the other.
Example: subjectrefs attribute with key scopes

Parent topic: Indirect key-based addressing

Report an Issue · Colophon