Skip to main content
Version: DocBook V4.5

primaryie

primaryie — A primary term in an index entry, not in the text

Synopsis

Mixed Content Model

primaryie ::=
(#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

PrimaryIE identifies the most significant word or words in an IndexEntry. IndexEntrys occur in an Index, not in the flow of the text. They are part of a formatted index, not markers for indexing.

If a document includes both IndexTerms and IndexEntrys, the IndexEntrys are usually constructed from the IndexTerms by some external process.

Processing expectations

Formatted as a displayed block. The PrimaryIE starts a new entry in the Index.

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

Attributes

linkends

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

Examples

For examples, see index.