index-see-also

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.

The <index-see> and <index-see-also> elements are ignored if their parent indexterm element contains any indexterm children.

In addition to its "see also" redirection, an index-see-also functions as a pointwise indexterm, 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.

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

Contains

Doctype	Content model
ditabase, topic, task, reference, concept	( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or data or data-about or foreign or unknown or indexterm) (any number)
map, bookmap	( text data or keyword or term or data or data-about or foreign or unknown or indexterm) (any number)

Contained by

Doctype	Parents
bookmap, map, ditabase, topic, task, concept, reference, glossary	indexterm

Inheritance:

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

Attributes

Name	Description	Data Type	Default Value	Required?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;)	A set of related attributes, described at %univ-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, keyref	Common attributes described in Other common DITA attributes