Glossary Topics and References

Abstract

Learn how to make a glossary topic in Paligo and then add references to your glossary in your content.

Technical documentation often includes a glossary, where technical terms are listed alphabetically with a brief explanation. They act as a quick reference for terms that may not be commonly understood outside of your organization or industry.

To create a glossary in Paligo:

  1. Create a Glossary Topic. This is where you add your glossary terms and their definitions.

    When you are creating your glossary, you should consider whether you want to use an automatic glossary title. You can also sort the glossary so that the entries appear in alphabetical order.

  2. If you want terms in your glossary to reference other terms in your glossary, you can use "see" and "see also" links. These need to be set up in the glossary topic.

  3. This is an optional step. If you want your topics to contain hyperlinks to the explanations in the glossary, you need to add references in your content.

    Alternatively, you can use the glossary topic without any references in your content. This will give you the glossary topic and the definitions you add, but there will be no links from your topics to your glossary.

  4. If you are publishing to PDF, you can set the glossary to only include those terms that are used in your publication. This is useful when you have a single glossary topic that you reuse in several different publications.

  5. If you are publishing to an HTML5 help center, you can choose whether your references to the glossary have "popovers" that appear when you hover the cursor over the term.

    Example of a glossary shown as a hover pop-up when published to HTML
  6. Add your glossary topic to a publication in the same way as you would add any other topic to a publication. Typically, the Glossary topic is placed at the end of the publication.

When you publish your content, the glossary is included. It contains a list of the glossary terms you have defined. If you have included references to the glossary in your content, those references appear as links. There are also popovers that appear if you publish to a HTML5 help center.