Insert a cross-reference

Use a cross-reference as an inline link to another topic that you can insert within a topic.

Before you begin

You must check out the topic.

About this task

You can use a cross-reference as a link to any of the following:

  • Another topic
  • An element in another topic
  • An element in another part of the same topic
Note: Cross-references can link from one topic to any topic in either the same Context Map or the same Content Store. Unless you have more than one Content Store, this usually means you can link to any two topics in CCMS Web.

To insert a cross-reference:

Procedure

  1. Put your cursor where you want to insert the cross-reference.
    Alternatively, you can select text to turn into a link.
  2. Do one of the following:
    • Click Link icon and select Cross Reference.
    • Right-click and select Link > Cross Reference
  3. Find the topic or element that you want to reference using Search.
    You can use the dropdown list to limit the search to either topics in the same Context Map or any topic in CCMS Web.
  4. From the search results, choose one of the following actions:
    • To link to the topic, click the radio button for the topic.
    • To link to an element in a topic:
      1. Expand the topic result to see all possible linkage elements.
      2. Click the radio button for an element.
    You can click any title or text snippet to see a preview of the linked topic or element. If you click the snippet for an element, the linked element is highlighted in the preview.
  5. Click Insert.
    A link is inserted at the cursor's location. If you had selected text, it turns into a link.
  6. Optional: Click in the link, and enter or edit the text for the link.
    The cross-reference is inserted at the specified location.