Links to files in Heretto

Links to files in Heretto enable you to link to other topics or files in the Content Library. You can use this linking option to redirect users to a separate page from the original topic.

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

Overview

When you link to files in Heretto, you don't need to worry about the file having an ID assigned because Heretto automatically assigns a unique ID to each file upon its creation.

Peer link — Figure 1. Links to files in Heretto Operation.
This example shows a link that links from “Element B” in “Topic A” to “Topic B”.

Use Cases

Consider using links to files in Heretto in the following scenarios:

When you want to refer to another topic.
Figure 2. Link to Another Topic.
This PDF example shows that:
A link to the “Safety Warnings” topic is inserted in the note element.
The link, when clicked, takes you to the “Safety Warnings” topic in the same map.
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 to create a process topic based on links.
Figure 3. Links to files in Heretto in a Process Topic.
This example from the Heretto Portal shows that:
Links to files in Heretto are inserted in the prerequisite element, step elements, and postrequisite element.
Some of the links refer to topics in another map because the Heretto Portal can handle such a linking strategy.
When you want to link to a non-DITA file in the Content Library.
Figure 4. Link to a non-DITA File in Heretto.
The example from the Heretto Portal shows that:
A link to the Sample_DOCX_Document.docx file is inserted.
If you click the link, the Sample_DOCX_Document.docx downloads.

Maintenance Guidelines

Links to files in Heretto require a moderate level of maintenance because they may limit topic reuse. If you do not want to limit topic reuse, consider doing any of the following:

Inserting a key reference. See Key References (Indirect Links).
Inserting a relationship table. See Relationship Table Links.
Reusing elements. See Element Reuse.

Keep the following guidelines in mind when using links to files in Heretto:

If you link to a DITA topic, the title element of the topic is used as the link text. To reduce maintenance, we do not recommend entering custom link text.
Do not link to DITA maps as this may cause unexpected results in some outputs.
If you link to a non-DITA resource in the Heretto, the file name is used as the link text. If needed, enter custom generic link text.
Heretto CCMS prevents you from removing resources that are linked in other topics. When you attempt to move a resource to Trash, a warning appears. You need to remove the references to the resource before moving it to Trash.

Publishing Guidelines

Keep the following guidelines in mind when publishing content with links to files in Heretto:

If you publish to a print-friendly output (for example, PDF), links may reference a page number.
If you publish to a print-friendly output (for example, PDF), ensure that the topic that you link to is included in the same map as the topic that you link from.
If you publish to a web output (for example, webhelps, or Heretto Portal), you can link to topics not included in the same map as the topic that you link from.
We do not recommend linking to elements in other topics because some publishing engines or publishing scenarios may produce unexpected results in the output.

Insert Links to Topics or Files in Heretto CCMS

Create a direct, inline link to another topic or file located in Heretto CCMS by using the cross-reference (xref) element.

Open a topic and place your cursor where you want to insert a link.
In the Content Editor toolbar, click Insert Link .
The Link dialog opens with the A File in Heretto option selected.
Click Select file.
In the Library dialog, select a file and click Link to File.

Tip: You can select topics or other files from your Content Library. For example, you can link to a PDF or DOCX file.

You inserted a link to a topic or a file in your Content Library. If you linked a topic, the topic title is used as the link text and the link text changes automatically when you edit the title of the topic you linked.
If you linked to a non-DITA file, do the following:
1. Click the link that you just inserted.
2. In the Attributes tab, enter the file extension in both the format field and type field.
  If you linked to a DOCX file, enter docx in the format field and type field.
Optional: Change the link text by placing your cursor in the link and entering custom text.

Remember:
We don't recommend customizing the link text. You need to maintain and modify custom links each time the content changes and the link text is no longer relevant. You need to do that everywhere the link is used.

If you linked to non-DITA files, verify that the links are properly rendered in the output.

Insert Links to Elements in Other Topics

You can create a direct inline link to an element in another topic by using cross-references.

Remember: Linking to elements in other topics is not a best practice because it forces users to leave the context they are in and jump to a different location. Instead of linking to an element in another topic, consider reusing that element to create the experience of smooth flow of content.

Open a topic and place your cursor where you want to insert a link.
In the Content Editor toolbar, click Insert Link .

The Link dialog opens with the A File in Heretto option selected.
Click Select file.
In the Library dialog, select the file that contains the element that you want to link to and click the Link Inside File (Select Target Element) button.
Select the element you want to link to:
1. In the Create/Edit Link dialog, click an element and select it from the list that appears.
2. If prompted about an element ID value, click OK and Save.
  
  Tip:
  Heretto CCMS generates ID attribute values automatically, but you can modify them. ID attribute values must be unique. Assigning customized, meaningful values may boost consistency in your documentation.
3. Click the Insert Content button.
Optional: Change the link text by placing your cursor in the link and entering custom text.

Remember:
We don't recommend customizing the link text. You need to maintain and modify custom links each time the content changes and the link text is no longer relevant. You need to do that everywhere the link is used.

You inserted a link to an element in another topic.

Under maintenance

Heretto Help

Links to files in Heretto

Overview

Use Cases

Maintenance Guidelines

Publishing Guidelines

Insert Links to Topics or Files in Heretto CCMS

Insert Links to Elements in Other Topics

Footer Section

Our Support Team is here to help