Skip to main content

Add a See Index Reference

A see index reference is a combination of a primary element for the main term and a see element for the link to the additional term.

Index for letter T. It has an entry for Thermal and next to that it shows see Temperature.

The index topic will look like this with see index references.

Note

It is also possible to use a see element for a secondary term, but these entries can become complicated. It is usually better to keep your index entries as simple as possible, so that your readers can find the information they need quickly.

If you use a see index reference, the index topic will show the main terms in alphabetical order without page numbers with a link in brackets to another term. It might be that you want to include terms that could be used for the same thing and refer the reader to the preferred term instead.

To add a see index 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 immediately before the text for the term that you want to use.

  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 indexterm and select it from the menu.

    Paligo adds an indexterm element with an primary element inside it.

  5. Enter the main term inside the primary element to make it appear in the index.

    Paligo editor shows a para element that contains an indexentry element. Inside the indexentry element is a primary element.

    Note

    You should now have a structure like that shown in the example below. Here, we have used "temperature" as an example of a primary term.

    <para>If the sensor detects that the room is too hot or too cold, the system will raise a <indexterm><primary>temperature</primary></indexterm> temperature alarm.</para>

  6. Position the cursor after the primary reference, but before the end of the indexterm.

    Add_Secondary_Reference.jpg

    Tip

    Move the cursor with the keyboard arrows to easier position it between the chevrons.

  7. 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.

  8. Enter see and select it from the menu.

  9. Enter the term inside the see element that is to appear as link within brackets in the index.

    The entered term must be an existing index term.

    Paligo editor shows a para that contains an indexterm element. Inside the indexterm element is a primary element with a main term. There is also a see element.

    Note

    You should now have a structure like that shown below, where we have used "Temperature" as the "see" index entry.

    <para>If the sensor detects that the room is too hot or too cold, the system will raise a <indexterm><primary>Thermal</primary><see>Temperature</see></indexterm>temperature alarm.</para>

  10. Select Save. Save icon.

When you publish, Paligo will automatically add your index entries to your index topic. If you do not have an index topic, see Create an Index Topic.