Skip to main content

Add Index References

Abstract

Learn how to add index references to your topics in Paligo. The references tell Paligo what terms should appear in the index and what type of reference should be used.

To get index entries to appear in an index topic, add index references in the topics that contain your content. These references tell Paligo:

  • What terms should appear in the index topic

  • What type of reference the terms should use.

    There are four types of index references that you can use (see the table below).

If your content does not contain any index references, your index topic will be empty when you publish.

The following table shows the reference types.

Appearance

Type

Description
Index for letter T, showing Temperature with a page number, Thermal image with a page number, and Thresholds with a page number.

Primary Index References

The index topic will only show the main terms in alphabetical order with page numbers. Learn more, see Add a Primary Index Reference.
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.

Secondary Index References

The index topic will show both main terms and subterms in alphabetical order with page numbers. Learn more, see Add a Secondary Index Reference.
Index for letter T. It has an entry for Thermal and next to that it shows see Temperature.

See Index References

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. Learn more about how to add these extra references, see Add a See Index Reference.
Index for the letter T. It has an entry for Temperature with two page numbers as references. Below that, there is an entry for Thermal, next to it is the text: see Temperature.

See Also Index References

The index topic will show the main terms in alphabetical order with page numbers including a link within brackets to an additional term. Learn more about how to add these extra references, see Add a See Also Index Reference.

Note

If you publish to HTML or HTML5 there will be hyperlinks instead of page numbers.