primaryie
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# primaryie

## Name

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

##

# Synopsis

### Mixed Content Model

    primaryie ::=
    (#PCDATA|footnoteref|xref|abbrev|acronym|citation|citerefentry|
     citetitle|emphasis|firstterm|foreignphrase|glossterm|footnote|
     phrase|quote|trademark|wordasword|link|olink|ulink|action|
     application|classname|methodname|interfacename|exceptionname|
     ooclass|oointerface|ooexception|command|computeroutput|database|
     email|envar|errorcode|errorname|errortype|filename|function|
     guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|
     hardware|interface|keycap|keycode|keycombo|keysym|literal|
     constant|markup|medialabel|menuchoice|mousebutton|option|
     optional|parameter|prompt|property|replaceable|returnvalue|
     sgmltag|structfield|structname|symbol|systemitem|token|type|
     userinput|varname|nonterminal|anchor|author|authorinitials|
     corpauthor|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`. `IndexEntry`s 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 `IndexTerm`s and `IndexEntry`s, the `IndexEntry`s are usually constructed from the `IndexTerm`s 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`.

### Children

The following elements occur in primaryie: `abbrev`, `acronym`, `action`, `anchor`, `application`, `author`, `authorinitials`, `citation`, `citerefentry`, `citetitle`, `classname`, `command`, `computeroutput`, `constant`, `corpauthor`, `database`, `email`, `emphasis`, `envar`, `errorcode`, `errorname`, `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`, `othercredit`, `parameter`, `phrase`, `productname`, `productnumber`, `prompt`, `property`, `quote`, `remark`, `replaceable`, `returnvalue`, `revhistory`, `sgmltag`, `structfield`, `structname`, `subscript`, `superscript`, `symbol`, `systemitem`, `token`, `trademark`, `type`, `ulink`, `userinput`, `varname`, `wordasword`, `xref`.

## Attributes

linkends

  `Linkends`, if used, points to the `IndexTerm`s indexed by this entry.

## See Also

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

## Examples

For examples, see `index` .

Prev | Home | Next
primary | Up | printhistory

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.