<index-see-also>

An <index-see-also> element directs the reader to an index entry that the reader should use in addition to the current one.

Usage information

There can be multiple <index-see-also> elements within a single <indexterm> element.

Processing expectations

Processors SHOULD ignore an <index-see-also> element if its parent <indexterm> element contains any <indexterm> children.

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <indexterm> )*

Zero or more

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@keyref
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

Examples

This section is non-normative.

This section contains examples of how <index-see-also> elements can be used.

Example 1. Use of an <index-see-also> element

The following code sample shows the use of an <index-see-also> element to generate a "see also" reference to the index entry for "goldfish". 

<indexterm>carp
  <index-see-also>goldfish</index-see-also>
</indexterm>

This markup generates a primary index entry for "carp" and a redirection that instructs the reader to "see also goldfish".

Example 2. Use of an <index-see-also> element to redirect to a multilevel index entry

The following code sample shows the use of an <index-see-also> element to redirect to a multilevel <indexterm> element:

<indexterm>feeding
  <index-see-also>goldfish
    <indexterm>feeding</indexterm>
  </index-see-also>
</indexterm>