Skip to main content
Version: DocBook V4.5

secondaryie

secondaryie — A secondary term in an index entry, rather than in the text

Synopsis​

Mixed Content Model​

secondaryie ::=
(#PCDATA|footnoteref|xref|biblioref|abbrev|acronym|citation|
citerefentry|citetitle|citebiblioid|emphasis|firstterm|
foreignphrase|glossterm|termdef|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

Name

Type

Default

linkends

IDREFS

None

Description​

SecondaryIE identifies a secondary word or words in an IndexEntry.

In IndexEntrys, you can specify as many secondary terms that are necessary. Secondary and tertiary terms can be mixed, following the primary.

Processing expectations​

Formatted as a displayed block. SecondaryIEs occur below the PrimaryIE, usually aligned with each other and indented from the primary.

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 secondaryie: indexentry.

Attributes​

linkends

Linkends, if used, points to the IndexTerms indexed by this entry.

Examples​

For examples, see index.