index-see-also

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

An index-see-also element within an indexterm redirects the reader to another index entry that the reader should reference in addition to the current one.

The index-see and index-see-also elements allow a form of redirection to another index entry within the generated index. The index-see element refers to an index entry that the reader should use instead of the current one, whereas the index-see-also element refers to an index entry that the reader should use in addition to the current one.

Processors should ignore index-see and index-see-also elements if their parent indexterm element contains any indexterm children.

In addition to its "see also" redirection, an index-see-also functions as a pointwise index term, thereby typically generating a page reference as well as the "see also" indication.

It is not an error for there to be multiple index-see-also elements for a single index entry.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/index-base indexing-d/index-see-also

The following example illustrates the use of an index-see-also redirection element within an indexterm:

<indexterm>Carp
   <index-see-also>Goldfish</index-see-also>
</indexterm>
This will typically generate a page reference to "Carp" and a redirection:
  • Carp, 56
    • see also Goldfish

The following example illustrates the use of an index-see-also redirection element to a more complex (multilevel) indexterm:

<indexterm>Feeding
   <index-see-also>Goldfish <indexterm>feeding</indexterm></index-see-also>
</indexterm>

This is part of the indexing markup that might generate index entries such as:

  • Feeding, 348
    • see also Goldfish feeding
  • Goldfish
    • feeding, 56
    • flushing, 128, 345
The following example illustrates using a specialization of ph within index-see-also:
<indexterm>μ = E<sub>0</sub>/V<sup>2</sup>
  <index-see-also>E=mc<sup>2</sup></index-see-also>
</indexterm>

Attributes

The following attributes are available on this element: Universal attribute group and keyref.