Index References

Abstract

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

To get index entries to appear in your index topic, you need to markup your topics so that they contain index references. These references tell Paligo what terms should appear in the index and what type of reference should be used.

There are several different types of index reference that you can use:

  • Primary index references, which are a "term" and a "page reference".

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

    To find out how to add these index references, see Primary Index References.

  • Secondary index references, which are a "main term", a "page reference", a "sub-term", and a "page reference" for the sub-term.

    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.

    To find out how to add these index references, see Secondary Index References.

  • See index references, which are a "main term" and "see" and "another term".

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

    You can find out how to add these index references in See Index Reference.

  • See also index references, which are a "main term" and "page reference" and "see also" and "another term".

    Index for the letter T. It shows Temperature as an entry. It has two page numbers for references and also another reference that shows see also Thermal.

    You can find out how to add these index references in See Also Index Reference.

Note

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

Primary index references are the basic references that you can see in most types of reference books. They have an index term and a reference to the page(s) that contain that term.

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

If you publish to HTML, there is a hyperlink to the page instead of a page number.

To create a primary index reference:

  1. Create a new topic or edit an existing one by selecting it in the Content Manager.

  2. Position the cursor immediately before the text for the term that you want to use, and then use the element context menu to add the indexterm element.

    To find out more about using the element context menu to add content, see Add Content to Topics

    Paligo editor shows a para element containing an indexterm element.
  3. Click Inside the indexterm element and use the element context menu to add the primary element.

    Paligo editor shows a para element that contains an indexentry element. Inside the indexentry element is a primary element.
  4. Click inside the primary element and enter the term that you want to appear in the index.

    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>
  5. Repeat step 4 for each index entry that you want to create.

  6. Select Save.

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.

Secondary index references are second-level references, where a primary term is indexed first, and then a secondary term is indexed as a subsection of that. For example, you could have a primary reference to "temperature" and then secondary references to "Alarms", "Maximum", "Minimum", and "Shutdown". So when the reader sees the index entries, they can see that "Alarms" is secondary and so is related specifically to alarms that relate to temperature. Similarly. maximum, minimum, and shutdown are also secondary and relate to temperature.

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.

If you publish to HTML, there is a hyperlink to the page instead of a page number.

To create a secondary index reference:

  1. Create a new topic or edit an existing one by selecting it in the Content Manager.

  2. Position the cursor immediately before the text for the term that you want to use, and then use the element context menu to add the indexterm element.

    To find out more about using the element context menu to add content, see Add Content to Topics

    Paligo editor shows a para element containing an indexterm element.
  3. Click Inside the indexterm element and use the element context menu to add the primary element.

    Paligo editor shows a para element that contains an indexentry element. Inside the indexentry element is a primary element.
  4. Click inside the primary element and enter the term that you want to appear in the index.

    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>
  5. Click after the primary reference but before the end of the indexterm. Then use the element context menu to add the secondary element.

    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.
  6. Click inside the secondary element and enter the secondary term that you want to appear in the index.

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

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.

For some terms, you may want your readers to refer to a different index entry instead. This is useful when there are several different words that could be used for the same thing, and you want to have a main term, with other terms referring to that. For example, you may want to use the word "temperature" as the main term, and have other related terms refer back to that. So for "thermal" and "heat", you could have "see Temperature".

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.

To create an index entry that shows "see" followed by a reference to another index entry, use the see element:

  1. Create a new topic or edit an existing one by selecting it in the Content Manager.

  2. Position the cursor immediately before the text for the term that you want to use, and then use the element context menu to add the indexterm element.

    To access the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).

    Paligo editor shows a para element containing an indexterm element.
  3. Click Inside the indexterm element and use the element context menu to add the primary element.

    Paligo editor shows a para element that contains an indexentry element. Inside the indexentry element is a primary element.
  4. Click inside the primary element and enter the term that you want to appear in the index.

    For "see" references, the primary term is the word that your readers will look up. For example, if you expect them to look up "Thermal" and you then want to refer them to "Temperature", set the primary element to "Thermal".

    You should now have a structure like that shown in the example below, where we have used "Thermal" as a primary 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></indexterm>temperature alarm.</para>
  5. Click after the closing </primary> element and before the closing </indexterm> element.

  6. Use the element context menu to add the see element.

    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.
  7. Click in the see element and enter the term that the "see" index entry should refer to. The text that you enter must be an exact match for another index term.

    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>
  8. Select Save.

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.

For some index entries, you may want the reader to refer to another related entry. For example, you could have an index entry for "Thermal Image", but you want your readers to also refer to the entry for "Temperature". For these, you can use a "see also" reference.

Index for the letter T. It shows Temperature as an entry. It has two page numbers for references and also another reference that shows see also Thermal.

For "see also" references, use:

  • A primary index reference for the main term

  • A seealso element for the "see also" term.

It's also possible to use a seealso 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.

To create a see also index reference:

  1. Create a new topic or edit an existing one by selecting it in the Content Manager.

  2. Position the cursor immediately before the text for the term that you want to use, and then use the element context menu to add the indexterm element.

    To access the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).

    Paligo editor shows a para element containing an indexterm element.
  3. Click Inside the indexterm element and use the element context menu to add the primary element.

    Paligo editor shows a para element that contains an indexentry element. Inside the indexentry element is a primary element.
  4. Click inside the primary element and enter the term that you want to appear in the index.

    For "see also" references, the primary term is the word that your readers will look up. For example, if you expect them to look up "Temperature", you set the primary term to Temperature.

    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>
  5. Click after the closing </primary> element and before the closing </indexterm> element.

  6. Use the element context menu to add the seealso element.

    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 also element.
  7. Click in the seealso element and enter the term that the "see also" index entry should refer to. For this example, we have used the term "thermal". The text that you enter must be an exact match for another index term.

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

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.