Key References (Indirect Links)

In a map, you can indirectly link to topics by using key references. You can consider key references as a reuse-friendly alternative to adding Links to files in Heretto.

Overview

Instead of directly linking to a topic by using the exact file path, key references link to a key name assigned to a topic in map. In different maps, topics with key references can link to different topics without limiting topic reuse.

Use Cases

Consider using key references in the following scenarios:

When you want to reuse a topic in different maps and want to make the reused topic link to different topics.
Figure 2. Keyref in the Content Editor.
The following example shows the linking illustrated in the Key Reference Operation diagram in the Content Editor.

Maintenance Guidelines

Keep the following guidelines in mind when using key references:

The following Heretto CCMS reports can help you manage key references:
- Invalid Keyrefs and Conkeyrefs Report checks for broken key references. This report lists keyrefs linking to key names that are not defined in the map.
- Folder Keys Report identifies all the keys used in a specific folder and where they're used. This report is helpful if you're looking for ways to maximize your reuse opportunities.
Develop a key naming convention that is easy to implement and use.
Over a given map, we recommend using unique key values.

Publishing Guidelines

Keep the following guidelines in mind when publishing content with key references:

Your map won't publish if the key references in the map are not resolved.
If there are the same key values in a map, the key resolves to the first instance of that key name in the map.
If you publish to a print-friendly output (for example, PDF), links may reference a page number.

Assign Key Names to a Topicref

You must set a key name on a topicref element in a map to indirectly link to a topic.

In the Content Library, double-click a map to open it in the Content Editor.
In the Content Editor, hover over the topic you want to assign a key name to.
A quick list of icons is displayed.
Click the Key icon.
In the Keys field, enter a key name and click Update.
Note:
If the key name you enter has multiple terms, underscores are required instead of spaces to separate the terms.

Insert a key reference. See Insert Key References.

Insert Key References

Create an indirect, inline link by inserting a key reference to a key name.

In a map, assign a key name to the topicref element that you want to indirectly link to. See Assign Key Names to a Topicref.

In the Content Library, double-click a map to open it in the Content Editor.
Go to a topic and place your cursor where you want to insert a link.
In the Content Editor toolbar, click Insert Link .
In the Link dialog, from the Link To drop-down menu, select Key (key reference).
Under the Keyref field, in the list, double-click a key.

Remember:
You must open a map or set map context to see available keys and resolve key references.

Under maintenance

Heretto Help