DocBook: The Definitive Guide

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


RefSect1 -- A major subsection of a reference entry


Content Model

RefSect1 ::= (RefSect1Info?,  (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)+,    RefSect2*)|   RefSect2+))


Common attributes





Tag Minimization

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


Reference pages have their own hierarchical structure. A RefSect1 is a major division in a RefEntry, analagous to a Sect1 elsewhere in the document.

The value of a separate hierarchical structure is that it allows the content model of sections in reference pages to be customized differently than the content model of sections outside. For example, because of this split, it was easy to add a recursive sectioning element (Section) as a peer to Sect1 in DocBook V3.1 without introducing it to RefEntrys, in which it would not be desirable.

Processing expectations

Formatted as a displayed block.

In some environments, the name, number, and order of major divisions in a reference page is strictly defined by house style. For example, one style requires that the first major section after the synopsis be the "Description," which it must have as its title.

In those cases, it may be useful to replace RefSect1 in the content model with a set of named sections (following the pattern of RefNameDiv and RefSynopsisDiv).

Formatting reference pages may require a fairly sophisticated processing system. Much of the meta-information about a reference page (its name, type, purpose, title, and classification) is stored in wrappers near the beginning of the RefEntry.

Common presentational features, such as titles and running headers, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.


These elements contain RefSect1: RefEntry.


The following elements occur in RefSect1: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, RefSect1Info, RefSect2, 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, IndexTerm.



Status identifies the editorial or publication status of the RefSect1.

Publication status might be used to control formatting (for example, printing a "draft" watermark on drafts) or processing (perhaps a document with a status of "final" should not include any components that are not final).

See Also

RefNameDiv, RefSynopsisDiv


For examples, see RefEntry.


Back to: DocBook: The Definitive Guide

O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.

DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition) © 2008-2017.
If you may any questions please contact us: