see

see — Part of an index term directing the reader instead to another entry in the index.

Synopsis

see ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “normal”
    • “under”

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 indexterms, taken together, to form an illogical index. For example, given the following indexterms:

<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.

Attributes

Common attributes and common linking attributes.

class

Identifies the class of 'see'

Enumerated values:
“normal”

Normal

“under”

See 'under'

Parents

These elements contain see: indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange).

Last revised by Norman Walsh on (git hash: 32232d73aaed8bf7134470f3f72f9e1dc6874d38 68abf83671c42c0ef5e0aed2f171edf1c3b1bdcd)