Cross-References and Links

2 min read

Types of Cross-References and Links

Paligo has several different types of cross-references and hyperlinks, and they need to be set up differently depending on what you want to achieve.

We categorize the cross-reference and hyperlink types as:

Cross-references : External Target

These are cross-references to other topics in your Paligo instance.

  • Reference a topic that appears once in your publication

    Use a cross-reference that targets the topic directly, see Add Cross-Reference to a Topic.

  • Reference a topic that appears multiple times in your publication

    Use a cross-reference that targets the topic's fork in the publication structure. With this approach, you can link to one specific instance of the topic in the publication. For instructions, see Add Cross-Reference to a Topic.

  • Reference a section that is in a different topic

    Use a cross-reference that targets an element in another topic. The cross-reference has to use the xml:id of the target element, so that Paligo links to the correct element. The xml:id is a unique id that is usually generated automatically. For instructions, see Add a Cross-Reference to an Element in Another Topic.

Cross-references: Internal Target

These are cross-references to content inside the topic you are editing. These types of references are sometimes called anchor links.

  • Reference content that is in the same topic

    Use a cross-reference that targets an element in another location inside the same topic. These types of cross-references are also known as anchor links. For instructions, see Add Cross-Reference Within the Topic.

External Links

These are hyperlinks that target content or features that are outside of Paligo.

  • Link to an external web site

    Use to add a link to a page on a website that is not part of your published output. For instructions, see Add External Links.

  • Link to a local file

    Use to link to a file that is stored locally with your output content rather than on the web. For example, you might want a help center topic to link to a PDF that you add to the output folder after publishing. For instructions, see Add Link to Local File.

  • Link to a downloadable file

    Use a download link and a script to allow users to download files from your content. For instructions, see Add Downloadable Files.

  • Link to a phone number

    Use to add a link that, when selected, calls a phone number automatically (using of the user's phone apps). For example, you could add a link that calls your customer care helpline. For instructions, see Add Link to Phone Number.

Automatic Links

These are links that Paligo will generate automatically (when your content is set up for auto-links).

Email Links
  • Link to an email address

    Use to add a link that, when selected, creates a new email with a specific email address in place. For instructions, see Add Link to Email Address.

Embedded Content Links

These are links to documents or other content that embed content in your published pages.

  • Google Doc documents

  • Web pages

  • OneDrive documents

To learn more, see Embed Google Doc or OneDrive Documents and Embed a Webpage.