Linking Overview
There are two main link types: inline links and block links. Each of them offers a few options to chose from.
Inline Links
Inline links enable you to add links in line with text. All inline link types use the same element, cross-reference (xref). Their properties and behavior change based on the attributes that are set on the cross-reference.
- File in Heretto
Direct links to topics and files in the CCMS.
- Key (Key reference)
Indirect links to other topics in the CCMS.
- Element in this file (Local link)
Links to elements in the same topic, for example, to a figure or a step.
- URL (External link)
Links to resources that are not part of the current document, for example, web pages.
- URL (Peer link)
Links to resources that are part of the current set of content but might not be accessible at build (publishing) time.
Block Links
Block links are created with different elements or with attributes. For example, relationship table links are created in the reltable element, and map links are created by using a set of map attributes. Unlike inline links that are scattered across content, block links are more centralized which makes them easier to maintain.
- Relationship table links
Links between topics that belong to the same map created in a reltable element at the end of the map.
- Related links
Links to other topic that belong to the same map added in a related-links element at the end of a topic.
- Map links
Links between topics that belong to the same map created with map attributes.