DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

IndexDiv

Name

IndexDiv -- A division in an index

Synopsis

Content Model

IndexDiv ::=
((Title,Subtitle?,TitleAbbrev?)?,
 ((ItemizedList|OrderedList|VariableList|SimpleList|LiteralLayout|
   ProgramListing|ProgramListingCO|Screen|ScreenCO|ScreenShot|
   Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|SimPara|
   Address|BlockQuote|Graphic|GraphicCO|MediaObject|MediaObjectCO|
   InformalEquation|InformalExample|InformalFigure|InformalTable|
   Anchor|Comment|Link|OLink|ULink)*,
  (IndexEntry+|SegmentedList)))

Attributes

Common attributes

Tag Minimization

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

Description

An IndexDiv identifies a section of an Index. An index might be divided into sections in order to group entries, usually alphabetically.

An index may contain any number of IndexEntry or IndexDiv elements, but it cannot contain a mixture of both at the same level.

Processing expectations

Formatted as a displayed block.

Parents

These elements contain IndexDiv: Index, SetIndex.

Children

The following elements occur in IndexDiv: Address, Anchor, BlockQuote, CmdSynopsis, Comment, FormalPara, FuncSynopsis, Graphic, GraphicCO, IndexEntry, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, Link, LiteralLayout, MediaObject, MediaObjectCO, OLink, OrderedList, Para, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, SimPara, SimpleList, Subtitle, Synopsis, Title, TitleAbbrev, ULink, VariableList.

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

Examples

For examples, see Index.

PrevHomeNext
IndexUpIndexEntry

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.