Links to Elements in this File (Local Links)
Local links link to elements in the same topic. You can use this option to redirect readers to a different section in the same topic.
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 that you directly link to must have a unique ID attribute assigned. Heretto CCMS enables you to assign the ID attributes to elements while inserting a link.
The following example shows a local link that links from “Element C” to “ Element A” in the same topic.
Use Cases
Consider using local links in the following scenarios :
- When you want to mention a step element in another step element.
Figure 2. Local Links to a Step Element. This PDF example shows that:- A local link to step four in step five is inserted.
- The local link, when clicked, takes you to step four.
- The link is print-friendly because the on page
# text is automatically added to the
link.
Where, # is the name of the page
- When you want refer to another element in a longer topic.
Figure 3. Local Link to a Section Element. This PDF output example shows that:- A local link to the “Safety Features” section element is inserted.
- The local link 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
link.
Where, # is the name of the page
Maintenance Guidelines
Local links 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 links:
- If you link to an element with a title element, for example a section or example 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 links:
- If you publish to a print-friendly output (for example, PDF), local links include a page number.
- In some short topics, clicking a local links 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.