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.
Contains
Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Doctype | Content model |
topic (base), map (base), classifyMap, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | |
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap | |
machineryTask | |
Contained by
Doctype | Content model |
topic (base), map (base), topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap, classifyMap, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | |
Inheritance
+ 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:
• 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
Attributes
Name | Description | Data Type | Default Value | Required? |
keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. | CDATA | #IMPLIED | No |
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | | | | |
global-atts attribute group (xtrf, xtrc) | | | | |
class | | | | |
Parent topic
