Skip to main content

Add a Secondary Index Reference

If you use a secondary index reference, the index topic will show both main terms and subterms in alphabetical order with page numbers. If you publish to HTML, there is a hyperlink to the page instead of a page number.

Index for letter T. It shows Temperature and a page number at the top level. Indented at the second level are entries for Alarms, Maximum, Minimum, and Shutdown, each with a page number.

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

Tip

To find out more about using the Element Context Menu to add content, see About Authoring.

To add a secondary index reference to your content:

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

  9. Enter the subterm inside the secondary element to make it appear in the index.

    Paligo editor shows a para that contains an indexentry element. Inside the indexentry element there is a primary element with the main term. After the primary element is a secondary element.

    Note

    You should now have a structure like this (where we have used "alarm" as an example of a secondary term):

    <para>If the sensor detects that the room is too hot or too cold, the system will raise a <indexterm><primary>Temperature</primary><secondary>alarm</secondary></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.