Table of Contents
User Guide
Content Key References

Content key references (conkeyrefs) are a method of reusing content by referencing content through keys.

Conrefs are used for variable text like company or product names. A content key reference is a reference to variable content via a key reference. By using key references, you can abstractly reference the content without specifying the element. For more information, see Key References.

section
These variables are typically organized into one or more warehouse topics. Having all your variables in one location like a warehouse topic makes it easier to track, manage, and maintain your content.
To use conkeyrefs, you need to do the following:
  1. Create a warehouse file to hold your variable content. For more information, see Setting Variable Content in a Warehouse Topic.
  2. Add the warehouse file as a keydef in your map. For more information, see Adding a Warehouse Topic to a Map.
  3. Insert a conkeyref in a topic to reuse the variable content. For more information, see Inserting a Conkeyref into a Topic.
section

Conkeyref Example

You need to publish a manual for both the Toaster 1000 and Toaster 1500. Both publication maps reuse the same Setting up the Toaster topic because the set up documentation for each model is the same. But what if you want to mention the specific toaster model? You can make the toaster models variables that you create conkeyrefs to. For example, we use the following key name and Id combination to resolve the product name varsProperNouns/productName:
When the Setting up the Toaster topic is in the Toaster 1000 publication map, then the conkeyref to varsProperNouns/productName resolves to the Toaster 1000 product name. For example:
When the Setting up the Toaster topic is in the Toaster 1500 publication map, then the conkeyref to varsProperNouns/productName resolves to the Toaster 1500 product name. For example:
Each of these publication maps contain their own warehouse topics with variables specific to the product model. So if there are any topics reused among several product models, using conkeyrefs eliminates the need for duplicate topics.