<index-see>
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.
Because an <index-see> indicates a redirection to use instead of the
current entry, it is an error if, for any <index-see>, there is also an
<index-see-also> or an <indexterm> for the same index
entry (that is, another entry with an identical sort key). For example, if an
<indexterm> element with the content "Memory stick" also includes
<index-see>USB drive</index-see>, it is an error if there is also an
<indexterm> with the contents "Memory stick". This is to prevent index
entries that are both a redirect and a page reference, such as:
* Memory stick 42, 106
* See USB drive
An implementation MAY give an error message when it encounters this condition, and MAY recover from this error condition by treating the <index-see> as an <index-see-also>.
There can be multiple <index-see> 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
Example
The following example illustrates the use of an <index-see> redirection element within an <indexterm>:
<indexterm>Carassius auratus <index-see>Goldfish</index-see> </indexterm>
This will typically generate an index entry without a page reference:
The following example illustrates the use of an <index-see> redirection element to a more complex (multilevel) <indexterm>:
<indexterm>Feeding goldfish <index-see>Goldfish <indexterm>feeding</indexterm></index-see> </indexterm>
This is part of the indexing markup that might generate index entries such as:
The following example illustrates using a specialization of <ph> within <index-see>:
<indexterm>Einstein's mass and energy equation <index-see>E=mc<sup>2</sup></index-see> </indexterm>
Attributes
The following attributes are available on this element: Universal attribute group and @keyref.