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

Children

The following elements occur in see: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, coref, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), glossterm (db._glossterm), glossterm (db.glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlineequation, inlinemediaobject, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, subscript, superscript, termdef, trademark, uri, wordasword, xref.

See Also

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

Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)