Inserting a variable from a topic map

Any variable defined in a topic map can be used inside a text fragment in topics and other library topics.

(This procedure is based on the Tridion Docs database repository and Oxygen XML editor. Other tools have similar functionality.)

On this page

• Prerequisites
• Context
• Procedure

Prerequisites

You have all the tools available, and the necessary rights to develop new content.

You must know the correct name of the variable. Note that this name is case sensitive.

Context

You can insert a variable from a topic map in one of the following ways:

• You can copy the variable from another topic or library topic.

  It will still be provided with the correct value when the document is published.

• You can insert the variable manually.

  It is enough to insert the variable, since the value will be inserted when the document is published.

In the procedures, descriptions and examples I use the <keyword> element. In many DITA systems, you can also use other elements. The elements must be defined in the system files that control the publishing system's functionality. Check with your system supplier for more information about this.

I recommend that you standardize the use of the <keyword> element for variables. Although it is permitted to use other elements, it is easier to be consistent. This consistency increases understanding in the team and facilitates maintenance. Especially for new users, it will be easier to identify which elements are variables and which are not.

Tip To identify the topic map I use to define variables, and make it easier to find, I refer to it as a "keymap". This is not a standard DITA designation. In your database system, I suggest that you establish "Keymap" as a map type in your metadata. Unique identification makes the topic map easier to find.

Procedure

1. Check out the topic or library topic in which you want to insert the variable.
2. Place the cursor in the requested position in the text.
3. To copy the variable from another topic or library topic:
   1. Open the topic or library topic from which you can copy the <keyword> element.

   2. Copy the <keyword> element and paste it into your own text.

      The value (content) of the variable is not significant. The correct value will be automatically inserted when the document is published.

4. To insert the variable manually:
   1. Create a <keyword> element.

   2. Change the keyref attribute to contain the correct variable name.

      You must use the correct name. Note that this name is case sensitive.

Tip Consider building a modular system with variable definitions. This allows reuse of definitions and values, and provides a high degree of consistency. These pages only explain how variables are used in DITA publishing. If you want additional explanations about the principle of variables, see under Methodology and especially Using variables in the text.

---

All external links open in a new window. I take no responsibility for information on external websites, even if I have linked to them. Please report links that do not work.

The information on this page represents my personal opinions and my understanding of the topic being described. Feel free to link to the page, but do not copy large parts of the content without permission. I take no responsibility for any errors, misunderstandings or missing information. I also take no responsibility for any mistakes you may make or cause as a result of incorrect or missing information. You are welcome to contribute with comments, relevant experiences or additional information. See Editor and contact information.