• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar

Learning DITA

Free DITA training

Free DITA training

  • Log in
  • Register
  • Newsletter
  • Profile
  • Privacy
  • Home
  • About
  • Courses
  • News
  • Resources
  • Support the site
  • Contact
  • Recordings

Lesson 2: Using keys

Posted on 12.02.16

Advanced reuse in DITA Lesson 2: Using keys
Objectives
  • Define a key for a path resource
  • Use a key for a path resource
  • Define a key for a text string resource
  • Use a key for a text string resource
  • Assemble key definitions in a submap

A DITA key is a placeholder for short text strings and file paths (or URLs). When you create a reusable topic, you can use keys in places where the text strings or file paths are different each time the topic is used. You define the final value for a key in a DITA map. When the reusable topic is used in different maps, the key values can be defined differently in each map.

This lesson describes how to define and use keys for short text strings and file paths.

Additional reading

DITA Specification, Key-based addressing

DITA Style Guide, Indirect linking with keys

DITA Style Guide, Variables using indirection

Contributors
  • Simon Bate
  • Jake Campbell
  • Gretyl Kinsey
Lesson Content
0% Complete 0/5 Steps
What is a key?
Using keys for paths
Using keys for text
Advanced key uses
Best practices for keys
Assessment for Using keys
Previous Lesson
Back to Course
Next Lesson

Categories: Free

sidebar

Blog Sidebar

  • Scriptorium logo
    Maximize the value of your content. Read more.
  • Scriptorium logo
    Already in DITA and need support? Contact us.
RSSTwitter

Want to add content? Join the ditatraining GitHub repository.

  • Home
  • Sponsor
  • News
  • Contact
  • Privacy

Maintained by Scriptorium Publishing

Logo and site presentation © 2015-2022 Scriptorium Publishing. Content based on the open-source DITA training project.