DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

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|Command|ComputerOutput|Database|Email|
  EnVar|ErrorCode|ErrorName|ErrorType|Filename|Function|GUIButton|
  GUIIcon|GUILabel|GUIMenu|GUIMenuItem|GUISubmenu|Hardware|
  Interface|InterfaceDefinition|KeyCap|KeyCode|KeyCombo|KeySym|
  Literal|Constant|Markup|MediaLabel|MenuChoice|MouseButton|
  MsgText|Option|Optional|Parameter|Prompt|Property|Replaceable|
  ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem|
  Token|Type|UserInput|VarName|Anchor|Author|AuthorInitials|
  CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber|
  RevHistory|Comment|Subscript|Superscript|InlineGraphic|
  InlineMediaObject)+)

Attributes

Common attributes

Name	Type	Default
Linkends	IDREFS	None

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

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.

Children

The following elements occur in PrimaryIE: 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.

Attributes

Linkends

Linkends, if used, points to the IndexTerms 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

Back to: DocBook: The Definitive Guide