Articles in this section

See more

Add Cross-Reference to Topic

Avatar
Anders
  • Updated
Follow

In a publication, there is a structure that references all of the topics (and sub-publications) that exist in the publication. Each reference to a topic or sub-publication is called a "fork" and has its fork:id. This is just for identifying the connection between the publication and the topic / sub-publication and pointing out its position. It is not the same as the topic's xml:id.

For example, if you have a "Safety" topic that appears three times in the same publication, you can link to the fork for the second instance and the link will go to the second "Safety" topic. If you linked to the topic instead of the fork, the link would always go to the first instance of that topic.

Note

It is possible to add cross-references to elements inside other topics, see Link to Element in Other Topic.

To add a cross-reference:

  1. Select the topic or component in the Content Manager to open it in the Editor.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternatively, you can Create a Topic and edit that.

  2. Position the cursor where the link is to be inserted.

    Tip

    Alternatively, highlight the text that you want to use as link label.

  3. Select the Insert tab in the Toolbar.

    Toolbar_Insert_small.png

  4. Select Link and choose Cross-reference. Insert_Link.png

    Cross-reference_LinkMenu_small.png

    Tip

    Or use the keyboard shortcut Alt + R (Windows) or Option ⌥ + R (Mac) to add the cross-reference.

  5. Enter a text as Link Label. Leave it blank if you want the link text to be the same as the topic title, see Auto-Text for Cross-References.

    Linklabel_small.png

  6. Locate the target in the tree structure or use the quick search.

    Cross-reference_dialogue_small.png

    Tip

    Make your search more efficient by selecting which resource types to search for.

    Resource_Types_To_Search_small.png

  7. Select whether to make the cross-reference towards the topic or a fork.

    • Topic Topic_Image_small.png

      If the target topic for the link only appears once in the publication, then you can link to the topic. This creates a link that uses the xml:id of the topic. To add a topic reference, select the topic with the black icon. Paligo recommends this approach because the links will work when content is reused in other publications and also for topic branches.

    • Fork Fork_Image_small.png

      If the target topic appears multiple times in the same publication, you should link to the fork instead. By linking to the "fork" you link to the position of the topic in the publication structure by using the fork:id. To add a "fork" reference, expand the publication and select the "fork" with the grey icon. It is important to know that fork links only work within the publication they originate from.

    Topic_or_Fork_small.png

    Paligo adds a cross-reference to the title of the selected topic or fork.

  8. Select Save. Save icon.

Note

If you want to change the cross-reference text or apply auto-text, select it to display the cross-reference editor. You can use that to enable or disable auto-text and change the text of the label, see Auto-Text for Cross-References.

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk