Inserting cross references to elements within a topic

Last Updated : Mar 14, 2024 |

About this task

Important:

Linking to elements within the same topic creates circular references. If number of circular references in a publication reaches a threshold number, Publication Manager crashes while opening the publication. Therefore, avoid linking to elements within the same topic.

Instead, add the element in a common topic and reference in the topic any number of times.

Do not link to title elements within other elements. Link to the parent element instead. For example, to link to a table within a topic, add the ID to the table element rather than to the title element.

Important:

Link text for cross references to specific elements is not updated automatically if you change the title of the cross-referenced element. For example, if you cross reference a figure with a title of “Front view of server” and use that title for the link text of the cross reference, the link text is not automatically updated if you change the figure title to “Front view of S8800.” If you change the title of an element that is cross referenced, you must manually update the link text of the cross references.

Procedure

  1. Assign an ID to the element that you want to link to if it does not already have an ID.

    Do not use numbers for IDs, and never use a single number. Use a descriptive ID instead.

  2. Save and check in the topic that has the element ID.
  3. Check out the topic in which you want to insert the cross reference.
  4. Place your cursor in the location where you want to add the cross reference and press Enter and insert the xref (cross reference) element.

    Alternatively, from the toolbar, click the link icon () and select Cross Reference.

    The Cross reference (xref) dialog box is displayed.

  5. Click the Tridion Docs icon (Tridion Docs browse icon), browse and select the topic that you want to reference.
  6. From the window, select the element that you want to reference.
  7. Click Insert and close.