Skip to main content

"See" Glossary Reference

If you want a glossary term to refer to another glossary term, you can use a "see" reference. For example, if you have a glossary term for "Coolant" you could use a "see" reference to guide the reader towards a related term, such as "See refrigeration".

glossary-see-reference.jpg

Tip

You can also use "See Also" Glossary Reference.

To use a "see" reference:

  1. Open your glossary topic or Create a Glossary Topic.

  2. Click inside the glossary element.

  3. Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.

    Element context menu shows a search field and a list of elements that are valid at the current position.
  4. Enter glossentry and select it from the menu.

    Paligo adds a glossentry element and it contains a glossterm, acronym, glossdef, and para element (the para is in the glossdef).

    glossterm-acronym-definition.jpg
  5. Click after the glossterm element, but before the acronym element.

    see-cursor-position.jpg

    This selects the glossentry element, which you can see in the Element Structure Menu and in the Element Attributes Panel.

    see-reference-allshow-glossentry.jpg
  6. Use the Element Context Menu to add the glossee element.

    Glossary topic open in Paligo editor. The glosssee element is selected. In the element attributes section, the otherterm attribute has been added to the glosssee element and it has its value set to the xml id of another glossary term.
  7. Delete the acronym, glossdef, and para elements for the glossary entry. You should now be left with the glossentry and glosssee elements.

    Note

    You can have either a glossee element or a glossdef element in a glossentry, but not both.

  8. In your glossary definitions, locate the glossary term that you want to reference.

    For example, if you want to have a "See Refrigeration" reference, find the glossary definition for "Refrigeration".

  9. Select the glossentry element for the term that you want to reference.

  10. In the Element Attributes Panel, copy the xml:id attribute for the glossentry.

    glossentry-id-copy.jpg

    Note

    If the glossentry does not have an xml:id, select the glossentry element in the element structure menu, and then select Generate ID. Paligo will create an xml:id for the glossentry element.

  11. Select the glosseealso or glossee element that you added earlier.

  12. In the Element Attributes Panel, add the Otherterm attribute and paste in the copied xml:id as the value.

    The Otherterm attribute links the glosseealso or glossee element with the other glossary term that you are referencing. The xml:id is what Paligo needs to identify the other glossary term.

    glossee-otherterm.jpg
  13. Select Save. Save icon.

When you publish your content (including your glossary), you will get a "See" reference to the glossary term you chose in step 8.

Example 1. "See" reference in a glossary

For this example, imagine you have a glossary term for "Profiling" and instead of a description, you want a reference to show "See Filters".

In your glossary topic, you already have a "Filters" glossary entry that has this structure:

<glossentry xml:id="N5fa17485ec783">
      <glossterm xinfo:text="14442">Filters</glossterm>
      <glossdef>
        <para>Filters are also known as profiles or conditional text. You can use them to markup your topics so that when you publish, you can choose whether to include of exclude parts of your content.</para>
      </glossdef>
    </glossentry>

The first step is to create a new glossary entry, so you add a new glossentry element and name the entry "Profiling".

glossary entry, with the term set to Profiling, and a blank acronym element and a blank definition.

You delete its acronymn and glossdef elements as there is no need for an acronym and you cannot have a definition and a "see" reference in the same glossary term.

Glossary entry has its term, but the acronym and definition have been deleted.

You add the glossee element.

Glossary term with the glossee element added.

You select the glossentry element for the glossary term you want to reference, in this case, "Filters". Then you copy its xml:id value from the Element attributes section.

Glossary topic in Paligo editor. The glossentry element is highlighted in the element structure menu and the element attributes section. Its xml id is shown in the element attributes section and is also highlighted.

You select the glossee element for the "Profiling" glossary entry, and then add the Otherterm attribute in the Element attributes section.

You copy the xml:id of the "Filters" glossary entry into the value field for the Otherterm attribute.

Glossary topic open in Paligo editor. The glosssee element is selected. In the element attributes section, the otherterm attribute has been added to the glosssee element and it has its value set to the xml id of another glossary term.

You save the glossary and publish it as part of a publication. In the output, the entry for Profiling shows "See Filtering".

Example of a glossary output. There is a glossary heading with a list of glossary terms and their definitions. An arrow points to the term for "Profiling" and its entry shows "see Filters"