Table of Contents
User Guide
Content Key References
Content Key References
Use content key references to reuse content by referencing content through keys.
Setting Variable Content in a Warehouse Topic
Use warehouse topics to contain variables such as product or interface names.
Adding a Warehouse Topic to a Map
Add a warehouse topic to a map as a keydef so you can insert it as a conkeyref in topics.
Inserting a Conkeyref into a Topic
Insert a conkeyref in a topic.
Content Key References

Use content key references to reuse content by referencing content through keys.
Content key references (conkeyref) enable you to reuse content in warehouse topics. A warehouse topic holds content that you’ll reference to. It’s an organized method of tracking and managing reused content that might change.
We recommend you use content key references for variable content that is used often, such as product names, notes, or images.
Example of warehouse files include:
  • Text warehouse files contain names and other strings
  • Media warehouse files contain images and videos
  • Notes warehouse files contain warning, notes, and cautions
To use conkeyrefs, create a warehouse file to hold your variable content using the procedure in Setting Variable Content in a Warehouse Topic. Next, add the warehouse file as a keydef in your map. For more information, see Adding a Warehouse Topic to a Map. Once the warehouse file is ready to be referenced by a topic in the map, you can begin Inserting a Conkeyref into a Topic.
Setting Variable Content in a Warehouse Topic

Use warehouse topics to contain variables such as product or interface names.
You have an empty topic open and want to make it a warehouse file containing variable text.
  1. Click Insert -> Phrase.

    Step Information

    Expected Result
    The Phrase element is inserted.

  2. In the Phrase element, enter the variable text.

    Example
    Enter easyDITA.

  3. Click Properties.

    Expected Result
    The Properties Pane displays.

  4. In the Id field, enter an Id for the variable. When inserting a conkeyref, this Id name identifies the variable text you are conkeyref’ing to.

    Example
    Enter productName.

You created variable content, which you also assigned an Id to.
Next, you’ll need to look at Adding a Warehouse Topic to a Map.

Adding a Warehouse Topic to a Map

Add a warehouse topic to a map as a keydef so you can insert it as a conkeyref in topics.
You created a warehouse topic using the procedure in Setting Variable Content in a Warehouse Topic.

You have a map open and want to insert a warehouse topic as a keydef.
  1. In the Map Editor Pane, right-click the map.

    Step Information
    The available options change based on the element selected.
    Expected Result
    The context menu displays.

  2. Select Append element -> keydef.

    Expected Result
    The Required Properties window displays.

  3. Enter a Keys name.

    Example
    Enter Text.

  4. Click Save.

    Expected Result
    The Keydef element is inserted.

  5. Drag and drop the warehouse topic onto the keydef element.

    Step Information

    Expected Result
    The Insert dialog displays.

  6. Click Set references.
You added the warehouse topic as a keydef element in a map.
Now, you’re ready to begin Inserting a Conkeyref into a Topic.

Inserting a Conkeyref into a Topic

Insert a conkeyref in a topic.
You added a warehouse topic as a keydef in a map using the procedure in Adding a Warehouse Topic to a Map.
You have a topic open and want to insert a conkeyref to an element in a warehouse topic.
  1. Place your cursor where you want to insert a conkeyref.
  2. Click Re-use Content -> Insert Conkeyref.

    Expected Result
    The Conkeyref drop-down element displays.
  3. Enter or select the conkeyref name from the drop-down menu.

    Expected Result
    The conkeyref is inserted.
A conkeyref is inserted.