DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
Preface
Synopsis
Content Model
Preface ::= ((DocInfo?,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)+, (Sect1*| (RefEntry)*| SimpleSect*|Section*))| (Sect1+| (RefEntry)+| SimpleSect+|Section+)))Attributes
Name
Type
Default
Status CDATA None Tag Minimization
The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.
Parameter Entities
%partcontent.mix; Description
Preface is a preface or forward in a Book. The Preface element may appear more than once and should be used for all introductory chapter-like material. For example, a Book might have both a Foreward and an Introduction. Both should be tagged as Prefaces in DocBook.
Processing expectations
Formatted as a displayed block. Usually introduces a forced page break and often starts on the next recto page. It is common for the page numbers in prefaces to be displayed as roman numerals rather than arabic numerals. Prefaces are usually listed in the Table of Contents.
Children
The following elements occur in Preface: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, 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, RefEntry, Screen, ScreenCO, ScreenShot, Sect1, Section, SegmentedList, Sidebar, SimPara, SimpleList, SimpleSect, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
Attributes
- Status
Status identifies the editorial or publication status of the Preface.
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).
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.