index-see

An <index-see> element within an <indexterm> redirects the reader to another index entry that the reader should reference instead of 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.

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 (i.e., with an identical sort key). An implementation may (but need not) give an error message, and may (but need not) recover from this error condition by treating the index-see as an index-see-also.

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

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:

Carassius auratus, see Goldfish

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:

Feeding goldfish
- see 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

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