Home Prev Up NextDocBook 5: The Definitive Guide (Version 1.0.4 for DocBook V5.0)

see

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

Synopsis

Attributes

Common attributes and common linking attributes.

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:

  1 <indexterm><primary>Extensible Markup Language</primary>
  2   <see>XML</see></indexterm>
    <indexterm><primary>Extensible Markup Language</primary>
  4   <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.

Parents

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

Children [+]

This element contains 100 elements.

See Also

indexentry, indexterm, primary, primaryie, secondary, secondaryie, seealso, seealsoie, seeie, tertiary, tertiaryie

Prev Home Next
section Up seealso
Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)

Copyright © 2010, 2011 Norman Walsh.