Local Cross-References

Local cross-references directly link to elements in the same topic.

Remember: We recommend structuring your topics in a way that guides users through the content without the need to excessively jump to different elements.

Overview

The element or topic that you directly link to must have a unique ID attribute assigned. Heretto CCMS enables you to assign the ID attributes to elements when you insert a link.

Figure 1. Local Cross-Reference Operation.

The following example shows a local cross-reference that links from “Element C” to “Element A” in the same topic.

Local link

Use Cases

Consider using local cross-references in the following scenarios:

  • When you want to mention a step element in another step element.
    Figure 2. Local Cross-Reference to a Step Element.
    The following PDF example shows that:
    • A local cross-reference to step four in step five is inserted.
    • The local cross-reference, when clicked, takes you to step five.
    • The link is print-friendly because the on page # text is automatically added to the local cross-reference.

      Where, # is the name of the page

    Local link in the PDF output.
  • When you want refer to another element in a long topic.
    Figure 3. Local Cross Reference to a Section Element.
    The following PDF output example shows that:
    • A local cross-reference to the “Safety Features” section element is inserted.
    • The local cross-reference, when clicked, takes you to the “Safety Features” section.
    • The link is print-friendly because the on page # text is automatically added to the local cross-reference.

      Where, # is the name of the page

    Local link in the PDF output.

Maintenance Guidelines

Local cross-references require little maintenance and don't limit reuse because they don't link to peer topics or external resources.

Keep the following guidelines in mind when using local cross-references:

  • If you link to an element with a title element, the title element is used as the link text. To reduce maintenance, we recommend not entering custom link text, because it will be unique to only that link-instance.
  • If you link to an element with no title element, you enter the link text manually. To reduce maintenance, we recommend making the link text generic.
  • If you delete the linked content, you need to delete the link, too. Heretto CCMS informs you about broken links.

Publishing Guidelines

Keep the following guidelines in mind when publishing content with local cross-references:

  • If you publish to a print-friendly output (for example, PDF), local cross-references include a page number.
  • In some short topics, clicking a local cross-reference won't take you to another place in the topic because the topic is too short (for example, when your topic fits on a single PDF page). As a result, the link may seem broken.