Table of Contents
User Guide
Key References
Assigning a Key Name to Topics
Set the key name on a topic so you can indirectly link to it from a topic.
Inserting a Keyref
Insert a keyref to a key name defined in the map and create an indirect, inline link to an element in a map.
Assigning a Key Name to Topics

Set the key name on a topic so you can indirectly link to it from a topic.
  1. Open a map in the Map Editor .

    Expected Result
    The map displays in the Map Editor Pane.
  2. In the Map Editor , hover over the topic you want to assign a key name to.

    Expected Result
    A quick list of icons display.
  3. Select the key icon.

    Expected Result
    The Keys field displays.
  4. Enter a key name for the topic.

    Example
  5. Click Update .
  6. Click Save to save the changes you made to the map.
result

A key name is defined for the selected map element. This key name can be used when inserting a keyref in a topic. For more information, see Inserting a Keyref.

Inserting a Keyref

Insert a keyref to a key name defined in the map and create an indirect, inline link to an element in a map.
prereq
You must assign a key name to the topic that you want to indirectly link to before inserting a keyref. For more information, see Assigning a Key Name to Topics.
Remember:When using keys, you must have a map open or map context set in order to see available keys and for keyrefs to resolve.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Place your cursor where you want to insert a keyref.
  3. Click Link -> Keyref . Keyref drop-down menu
  4. Enter or select the key name you want to create a keyref to.

    Example

result

A key reference is inserted in the topic, which indirectly links to the topic in the map with the key name.