Getting Started

Automatic Links to other Topics

You can set Paligo to create automatic links to other related topics. The links appear at the bottom of a topic and help readers to find other relevant information. Using automatic links is much easier and quicker to set up and manage than using manually-entered links.

There are two types of automatic links:

  • TOC-based automatic links, which, by default, appear below an "In this section" heading. These are links to topics that are "children" of the topic.

  • Taxonomy-based automatic links, which give you control over the relationships between topics. By default, these links appear below a "See also" heading.

To learn how to set up both types of automatic links, see the sections below.

In HTML5 outputs, Paligo automatically adds links to related topics at the bottom of certain pages. They are shown below an "In this section" heading and they link to any topics that are "children" of the current topic.

In the following images, the contents sidebar shows that "The Mission Control Center" is the currently displayed page and it has three "child" topics, which are "Command Center", "Guidance System" and "Ground Segment". As the page has "child" topics, Paligo automatically adds an "In this section" to the bottom of the topic, and it contains links to the three child topics.

child-topics.png
in-this-section-316.png

If you want to stop the "In this section" links from appearing, you can hide them using CSS:

  1. Use a CSS editor to create a CSS file, and add the following CSS to it:

    section-toc section-toc-after {
    display:none;
    }
  2. Save the CSS file and upload it to your HTML5 Layout.

    1. In Paligo, select Layout and then select the Layout that you want to use for your HTML5 output.

    2. In the Layout Editor, select CSS, JS, logos and other assets.

    3. In the CSS field, upload your CSS file and then select Save.

When you publish your content using the HTML5 Layout, the CSS is included in the output and the "In this section" heading and links will no longer appear. If you want to make them appear, upload a CSS file that does not contain the CSS you added in step 1 and republish.

Taxonomy tags are labels that you can add to any topic. You can use them to categorize your topics and also to get Paligo to create automatic links between topics in HTML5 outputs. The automatic links appear in a "See also" section at the bottom of a topic.

For example, if you have several topics about batteries, you might create a "Battery" taxonomy tag and add it to each of the battery-related topics. Then you can set Paligo to create automatic links between the topics. Each of the topics will have a "See also" section at the bottom with links to the other topics that have the "Battery" tag.

taxonomy-links-in-place.jpg

To learn how to create taxonomy-based links, watch the video or refer to the instructions below.

  1. In the Content Manager, open the Taxonomy Manager and then open the Taxonomies branch.

  2. Select the option button ( ... ) for the Taxonomies branch, and then select Create taxonomy tag.

    create-taxonomy-tag.png
  3. Enter a name for your taxonomy tag. This can be any name, and it is going to be the top-level taxonomy tag, also known as the "root". We recommend that you use a name that describes the group of taxonomy tags that you are going to create.

  4. Select the option button ( ... ) for the taxonomy tag you created in steps 2 and 3, and then select Create taxonomy tag.

  5. Enter a name for your taxonomy tag. Later, you will set your Layout to create see also links for this tag, so we recommend that you give the tag a meaningful name that categorizes the type of content. For example, if you were creating tags for mobile phone documentation, you might have a tag for "Battery".

    added-taxonomy-tag.png
  6. Repeat steps 4 and 5 to create as many taxonomy tags as you need. Each taxonomy tag will be used to define a relationship between your topics. For example, imagine you have a "Battery" taxonomy tag and you add it to 5 topics. In your output, each of those 5 topics will have a "See also" section with automatic links to the other 4 topics that have the "Battery" tag.

  7. Select the option button ( ... ) for the top-level tag that you created in steps 2 and 3 and then select Floating Content Panel. Drag your tags from the Floating Content Panel on to the relevant topics in the Content Manager. Do not drag the top level "root" tag on to a topic as this will stop the "see also" links from working.

    add-tags-to-topics.gif

    Note

    You can find out which topics are associated with a taxonomy by double-clicking on a taxonomy tag. Paligo displays details for that taxonomy tag, including the names of the topics that use it.

  8. Select Layout and then choose the Layout that you will use to publish your content.

  9. In the Layout Editor, select Classes and attributes.

  10. Set Output taxonomies to Enable.

  11. In the Relationship taxonomy section, enter the names of the top-level (root) taxonomy tags that you want Paligo to generate "See also" links for. If you want to include several taxonomy tags, separate each taxonomy tag name with a semi-colon.

    relationship-taxonomy.png
  12. Set Output role attribute as class names to Enable.

  13. Select Save.

When you publish using the Layout you edited, Paligo will automatically create a "See also" section. It will be included at the bottom of any topics that use the taxonomies you added to the Relationship taxonomy list in the Layout. The links that are added will be to other topics that also use the same taxonomy label.