Index see and see also

Readers can be re-directed from a searched-for term to related terms in the index that provide further references. You can use the index-see and index-see-also indexing elements for this purpose.

The index-see element is used to redirect the reader to a synonymous index term. The index-see element is nested inside a standard indexterm element, with indexterm containing the term to appear in the index, and the index-see containing the term for readers to be pointed to. The index-see must be the only child element of the parent indexterm.

For example, the code
<indexterm>forced induction
   <index-see>turbocharger</index-see>
</indexentry>
will result in an output of:

forced induction, See turbocharger

Where possible, index-see entries should be placed in the ditamap topicmeta, because they are logically applicable at the publication level, rather than the topic level.

The structure of the index-see entry in the ditamap is shown in the example:
<map id="lumberer_om_05">
  <title>Lumberer XT Owner's Manual</title>
  <topicmeta>
    <keywords>
      <indexterm>forced induction
        <index-see>turbocharger</index-see>
      </indexterm>
    </keywords>
  </topicmeta>
  <topicref...>...</topicref>
  <topicref...>...</topicref>
  <topicref...>...</topicref>
		...
</map>

The index-see-also element is similar in function to index-see, except that it also provides a page reference to the original term.

For example, the code
<indexterm>forced induction
   <index-see-also>turbocharger</index-see-also>
</indexentry>
will result in an output of:

forced induction .................... 15
      See also turbocharger

Do not use index-see-also in the ditamap top level map element's topicmeta, although you can use it within the topicref element's topicmeta within the ditamap.

In a hypertext document that supports indexes, the same example might be displayed as:

Screen capture showing a see-also entry in a Help system