Table of Contents
User Guide
Key References
Key References
Key references are indirect links that use key-addressing to topics based on the context map.
Assigning Key Names to Topics
Set the Keys attribute on a topic so you can indirectly link to it in a topic.
Inserting a Keyref
Use the Reuse features to insert a keyref and create an indirect reference to an element in a map.
Key References

Key references are indirect links that use key-addressing to topics based on the context map.
Key references (keyrefs) are a form of indirect linking that uses keys defined in maps to generate links. Keys are assigned to elements in a map. You can think of keys as references to ‘things’ in a map rather than content. And because you’re linking to ‘things’ and not exact topics, this makes linking more abstract and optimizes your reuse capabilities.
To create a key reference, you need to do the following:
Let’s look at an example. You need to publish a manual for both the Toaster 1000 and Toaster 1500. Both publication maps reuse the Setting up the Toaster topic. However, they contain different Button Functions topics.
Although the content in the Button Functions topics is different, conceptually they’re the same. So, within each publication map, you’ll use the same key name for the Button Functions topics, which is buttonFunctions.
In the Setting up the Toaster topic, there is a keyref indirectly linking to the topic with the key name buttonFunctions:
Based on the publication map used, the link in the Setting up the Toaster topic will resolve to the correct Button Functions topic included in the map. Let’s look at the Toaster 1000 publication map:
When the Setting up the Toaster topic is in the Toaster 1000 map, the buttonFunctions keyref will link to the Toaster 1000 Button Functions topic and display like this:
But when the Setting up the Toaster topic is in the Toaster 1500 map, the buttonFunctions keyref will link to the Toaster 1500 Button Functions topic instead:
This enables you to reuse the Setting Up the Toaster topic in both publication maps. Then based on the map context, the keyref is resolved to display a link to the topic in the map with the key name being referenced.
Assigning Key Names to Topics

Set the Keys attribute on a topic so you can indirectly link to it in a topic.
You have a map open and want to set the Keys attribute on a topic reference.
  1. In the Map Editor Pane, right-click the topic you want to reference to and select Edit element attributes.

    Expected Result
    The context menu displays.
  2. In the Keys field, enter a term to identify the reference.

    Example
  3. Click Save.
A key is created for the selected element in the map. This key will be used when Inserting a Keyref.
Inserting a Keyref

Use the Reuse features to insert a keyref and create an indirect reference to an element in a map.
You assigned a key attribute to a topic that you want to indirectly link to using the procedure in Assigning Key Names to Topics.
You have a topic open and want to insert a keyref to a topic.
  1. Place your cursor where you want to insert a keyref.
  2. Click Re-use Content -> Insert Keyref.

    Step Information
  3. Enter or select the keyref name from the drop-down menu.

    Example
A key reference is inserted, indirectly linking the topic to the referenced element with the key name.