setindex
setindex — An index to a set of books.
Synopsis
setindex ::=
- Sequence of:
- One of:
- Zero or more of:
annotationbridgeheadformalgroupremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
- Zero or more of:
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- label
- status
- type
Additional Constraints
- If this element is the root element, it 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.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
- label
Specifies an identifying string for presentation purposes
- status
Identifies the editorial or publication status of the element on which it occurs
- type
Specifies the target index for this term
Parents
Children
The following elements occur in setindex: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glosslist, important, indexdiv, indexentry, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.info), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, subtitle, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, typedefsynopsis, unionsynopsis, variablelist, warning.