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

---

SetIndex

Name

SetIndex -- An index to a set of books

Synopsis

Content Model

SetIndex ::=
((DocInfo?,Title,Subtitle?,TitleAbbrev?)?,
 (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
  SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
  LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
  ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|
  SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|
  MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
  InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
  Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract|
  AuthorBlurb|Epigraph|IndexTerm)*,
 (IndexDiv*|IndexEntry*))

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

%index.class;

Description

A SetIndex contains the formatted index of a complete Set of Books. An index may begin with introductory material, followed by any number of IndexEntrys or IndexDivs.

Processing expectations

Formatted as a displayed block. An Index in a Set usually causes a forced page break in print media.

In many processing systems, indexes are generated automatically or semiautomatically and never appear instantiated as DocBook markup.

Parents

These elements contain SetIndex: Book, Set.

Children

The following elements occur in SetIndex: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexDiv, IndexEntry, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.

In some contexts, the following elements are allowed anywhere: BeginPage.

Examples

See Index.

---

Prev	Home	Next
Set	Up	SetInfo

Back to: DocBook: The Definitive Guide