| DocBook: The Definitive Guide 2.0.12 (Alpha)

# see

$Revision: 1.3 $

$Date: 2002/06/12 11:18:35 $

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

## Synopsis

### Mixed Content Model

    see ::=
    (#PCDATA|footnoteref|xref|biblioref|abbrev|acronym|citation|
     citerefentry|citetitle|emphasis|firstterm|foreignphrase|
     glossterm|footnote|phrase|orgname|quote|trademark|wordasword|
     personname|link|olink|ulink|action|application|classname|
     methodname|interfacename|exceptionname|ooclass|oointerface|
     ooexception|package|command|computeroutput|database|email|envar|
     errorcode|errorname|errortype|errortext|filename|function|
     guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|
     hardware|interface|keycap|keycode|keycombo|keysym|literal|code|
     constant|markup|medialabel|menuchoice|mousebutton|option|
     optional|parameter|prompt|property|replaceable|returnvalue|
     sgmltag|structfield|structname|symbol|systemitem|uri|token|type|
     userinput|varname|nonterminal|anchor|author|authorinitials|
     corpauthor|corpcredit|modespec|othercredit|productname|
     productnumber|revhistory|remark|subscript|superscript|
     inlinegraphic|inlinemediaobject)*

### Attributes

Common attributes

## Description

The use of `See` in an `IndexTerm` indicates that the reader should be directed elsewhere in the index if they attempt to look up 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.

### Future Changes

The `InterfaceDefinition` element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

### Parents

These elements contain see: `indexterm`.

### Children

The following elements occur in see: `abbrev`, `acronym`, `action`, `anchor`, `application`, `author`, `authorinitials`, `biblioref`, `citation`, `citerefentry`, `citetitle`, `classname`, `code`, `command`, `computeroutput`, `constant`, `corpauthor`, `corpcredit`, `database`, `email`, `emphasis`, `envar`, `errorcode`, `errorname`, `errortext`, `errortype`, `exceptionname`, `filename`, `firstterm`, `footnote`, `footnoteref`, `foreignphrase`, `function`, `glossterm`, `guibutton`, `guiicon`, `guilabel`, `guimenu`, `guimenuitem`, `guisubmenu`, `hardware`, `inlinegraphic`, `inlinemediaobject`, `interface`, `interfacename`, `keycap`, `keycode`, `keycombo`, `keysym`, `link`, `literal`, `markup`, `medialabel`, `menuchoice`, `methodname`, `modespec`, `mousebutton`, `nonterminal`, `olink`, `ooclass`, `ooexception`, `oointerface`, `option`, `optional`, `orgname`, `othercredit`, `package`, `parameter`, `personname`, `phrase`, `productname`, `productnumber`, `prompt`, `property`, `quote`, `remark`, `replaceable`, `returnvalue`, `revhistory`, `sgmltag`, `structfield`, `structname`, `subscript`, `superscript`, `symbol`, `systemitem`, `token`, `trademark`, `type`, `ulink`, `uri`, `userinput`, `varname`, `wordasword`, `xref`.

## See Also

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

## Examples

For examples, see `indexterm`.

sectioninfo |  | seealso

Copyright © 1999, 2000, 2001, 2002, 2003 O'Reilly & Associates, Inc. All rights reserved.