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.
topic (base), map (base), classifyMap, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary |
( text data or data or data-about or foreign or unknown or keyword or term or indexterm) (any number) |
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap |
( text data or data or data-about or foreign or unknown or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or term or abbreviated-form or indexterm) (any number) |
( text data or data or data-about or foreign or unknown or keyword or wintitle or term or indexterm) (any number) |
+ 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:
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:
Keyref provides a redirectable reference based on a key defined within a map. See 3.4.2.3 The keyref attribute for information on using this attribute. |
||||
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) |
A set of related attributes, described in 3.4.1.3 univ-atts attribute group |
|||
A set of related attributes, described in 3.4.1.2 global-atts attribute group |
||||
A common attribute described in 3.4.1.9 Other common DITA attributes |