Key References (Indirect Links)
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.
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.
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.
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.