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.
| Doctype | Content model |
|---|---|
| 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) |
| machineryTask | ( text data or data or data-about or foreign or unknown or keyword or wintitle or term or indexterm) (any number) |
| 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 | indexterm |
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:
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:
| 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) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class | A common attribute described in Other common DITA attributes |
Return to main page.
DITA v1.2 CD 04
Copyright © OASIS Open 2005, 2010. All Rights Reserved.