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

---

SecondaryIE

Name

SecondaryIE -- A secondary term in an index entry, rather than in the text

Synopsis

Mixed Content Model

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

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.

Children

The following elements occur in SecondaryIE: 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, PrimaryIE, Secondary, See, SeeAlso, SeeAlsoIE, SeeIE, Tertiary, TertiaryIE

Examples

For examples, see Index.

---

Prev	Home	Next
Secondary	Up	Sect1

Back to: DocBook: The Definitive Guide