setindex

$Revision: 1.3 $

$Date: 2002/06/12 11:18:36 $

setindex — An index to a set of books

Synopsis

Content Model

setindex ::=
(setindexinfo?,
 (title,subtitle?,titleabbrev?)?,
 (calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
  simplelist|variablelist|caution|important|note|tip|warning|
  literallayout|programlisting|programlistingco|screen|screenco|
  screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|
  fieldsynopsis|constructorsynopsis|destructorsynopsis|
  methodsynopsis|formalpara|para|simpara|address|blockquote|
  graphic|graphicco|mediaobject|mediaobjectco|informalequation|
  informalexample|informalfigure|informaltable|equation|example|
  figure|table|msgset|procedure|sidebar|qandaset|task|
  productionset|constraintdef|anchor|bridgehead|remark|highlights|
  abstract|authorblurb|epigraph|indexterm|beginpage)*,
 (indexdiv*|indexentry*))

Attributes

Common attributes

DocBook NG “Bourbon” Content Model

setindex ::=

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

Additional attributes: (Required attributes, if any, are bold)

  • label
  • status

DocBook NG “Bourbon” Additional Constraints

  • The root element must have a version attribute.

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.

Examples

See Index.