Name
see — Part of an index term directing the reader instead to another entry in the index
Synopsis
see ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*
Attribute synopsis
Description
The use of see
in an
indexterm
indicates that the reader should be
directed elsewhere in the index when encountering this term.
The content of see
identifies another term in
the index which the reader should consult instead
of the current term.
Processing expectations
Suppressed. This element provides data for processing but it is not rendered in the primary flow of text.
It is possible for multiple indexterm
s, taken
together, to form an illogical index. For example, given the following
indexterm
s:
<indexterm><primary>Extensible Markup Language</primary> <see>XML</see></indexterm> <indexterm><primary>Extensible Markup Language</primary> <secondary>definition of</secondary> </indexterm>
there’s no way to construct a logical index because an entry in
the index should never have both a see
and other
content.
DocBook cannot detect these errors. You will have to rely on an external process to find them.
See Also
indexentry
, indexterm
, primary
, primaryie
, secondary
, secondaryie
, seealso ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.