QR code for this page

Powered by Titania Delivery

Indirect key-based addressing

DITA keys provide an alternative to direct addressing. The key reference mechanism provides a layer of indirection so that resources (for example, URIs, metadata, or variable text strings) can be defined at the DITA map level instead of locally in each topic.

For information about using keys to define and reference controlled values, see Subject scheme maps and their usage.

Note

The material in this section of the DITA specification is exceptionally complex; it is targeted at implementers who build processors and other rendering applications.

In this section:

  1. Core concepts for working with keys
    The concepts described below are critical for a full understanding of keys and key processing.
  2. Key scopes
    Key scopes enable map authors to specify different sets of key definitions for different map branches.
  3. Using keys for addressing
    For topic references, image references, and other link relationships, resources can be indirectly addressed by using the @keyref attribute. For content reference relationships, resources can be indirectly addressed by using the @conkeyref attribute.
  4. Addressing keys across scopes
    When referencing key definitions that are defined in a different key scope, key names might need to be qualified with key scope names.
  5. Cross-deliverable addressing and linking
    A map can use scoped keys to reference keys that are defined in a different root map. This cross-deliverable addressing can support the production of deliverables that contain working links to other deliverables.
  6. Processing key references
    Key references can resolve as links, as text, or as both. Within a map, they also can be used to create or supplement information on a topic reference. This topic covers information that is common to all key processing, regardless of how the key is used.
  7. Processing key references for navigation links and images
    Keys can be used to create or redirect links and cross references. Keys also can be used to address resources such as images or videos. This topic explains how to evaluate key references on links and cross references to determine a link target.
  8. Processing key references on <topicref> elements
    While <topicref> elements are used to define keys, they also can reference keys that are defined elsewhere. This topic explains how to evaluate key references on <topicref> elements and its specializations.
  9. Processing key references to generate text or link text
    Key references can be used to pull text from the key definition. This topic explains how to generate text from a key definition, regardless of whether the key reference also results in a link.
  10. Examples of keys
    This section of the specification contains examples and scenarios. They illustrate a wide variety of ways that keys can be used.
Parent topic: DITA addressing

Was this helpful?