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 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.
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.
Children
The following elements occur in See: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
In some contexts, the following elements are excluded: Acronym, Footnote.
