see — Part of an index term directing the reader instead to another entry in the index
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
footnote
footnoteref
foreignphrase
glossterm
phrase
(db.phrase)quote
subscript
superscript
wordasword
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
remark
subscript
superscript
xref
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.
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.
These elements contain see
: indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange).
The following elements occur in see: text, abbrev
, accel
, acronym
, alt
, anchor
, annotation
, application
, author
, biblioref
, citation
, citebiblioid
, citerefentry
,
citetitle
, classname
, code
, command
, computeroutput
, constant
, coref
, database
, date
, editor
, email
, emphasis
(db.emphasis), envar
,
errorcode
, errorname
, errortext
, errortype
, exceptionname
, filename
, firstterm
, footnote
, footnoteref
, foreignphrase
, function
, glossterm
, guibutton
,
guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, html:button
, html:fieldset
, html:input
, html:label
, html:select
, html:textarea
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), initializer
, inlineequation
, inlinemediaobject
, interfacename
, jobtitle
, keycap
, keycode
, keycombo
, keysym
, link
, literal
, markup
, menuchoice
, methodname
,
modifier
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, org
, orgname
, package
, parameter
, person
, personname
, phrase
(db.phrase), productname
, productnumber
, prompt
, property
, quote
, remark
, replaceable
, returnvalue
, shortcut
, subscript
, superscript
, symbol
, systemitem
, tag
, termdef
, token
, trademark
,
type
, uri
, userinput
, varname
, wordasword
, xref
.
indexentry
, indexterm
, primary
, primaryie
, secondary
, secondaryie
, seealso
, seealsoie
, seeie
, tertiary
, tertiaryie