    | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
| | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
index — An index to a book or part of a book
index ::=
addressanchorannotationbibliolistblockquotebridgeheadcalloutlistcautionclasssynopsiscmdsynopsisconstraintdefconstructorsynopsisdestructorsynopsisepigraphequationexamplefieldsynopsisfigureformalparafuncsynopsisglosslisthtml:formimportantindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)informalequationinformalexampleinformalfigureinformaltable (db.cals.informaltable)informaltable (db.html.informaltable)itemizedlistliterallayoutmediaobjectmethodsynopsismsgsetnoteorderedlistparaprocedureproductionsetprogramlistingprogramlistingcoqandasetremarkrevhistoryscreenscreencoscreenshotsegmentedlistsidebarsimparasimplelistsynopsistable (db.cals.table)table (db.html.table)tasktipvariablelistwarningsegmentedlistAn Index contains the formatted index of a document.
An index may begin with introductory material, followed by
any number of IndexEntrys or IndexDivs.
Formatted as a displayed block.
An Index in a Book
frequently 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.
Common attributes and common linking attributes.
Specifies an identifying string for presentation purposes
Identifies the editorial or publication status of the element on which it occurs
These elements contain index: appendix, article, book, chapter, part, preface, sect1, sect2, sect3, sect4, sect5, section.
The following elements occur in index: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, html:form, 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, mediaobject, methodsynopsis, msgset, note, orderedlist, 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, variablelist, warning.
An index with a title and
indexdivs.
<index xmlns='http://docbook.org/ns/docbook'> <title>Index</title> <indexdiv><title>D</title> <indexentry> <primaryie>database (bibliographic), 253, 255</primaryie> <secondaryie>structure, 255</secondaryie> <secondaryie>tools, 259</secondaryie> </indexentry> <indexentry> <primaryie>dates (language specific), 179</primaryie> </indexentry> <indexentry> <primaryie>DC fonts, <emphasis>172</emphasis>, 177</primaryie> <secondaryie>Math fonts, 177</secondaryie> </indexentry> </indexdiv> </index>
An index without a title or divisions.
<index xmlns='http://docbook.org/ns/docbook'> <indexentry> <primaryie>Example</primaryie> <secondaryie>Chapter</secondaryie> <seeie>Example Chapter</seeie> </indexentry> <indexentry> <primaryie>Example Chapter, 35-48</primaryie> <seealsoie>Examples</seealsoie> </indexentry> <indexentry> <primaryie>Examples, 18, 36, 72-133</primaryie> </indexentry> </index>
| | | |
| important | | indexdiv |