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


RefSynopsisDiv -- A syntactic synopsis of the subject of the reference page


Content Model

RefSynopsisDiv ::= (RefSynopsisDivInfo?,  (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.


RefSynopsisDiv contains a syntactic synopsis of the function or command described by the RefEntry. When RefEntrys are used to describe other sorts of things, RefSynopsisDiv should be used for whatever succinct, synopsis information seems appropriate.[1]

Processing expectations

Formatted as a displayed block. RefSynopsisDiv usually generates a section heading, in the same typographic style as a RefSect1 Title, called "Synopsis."

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 RefSynopsisDiv: RefEntry.


The following elements occur in RefSynopsisDiv: 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, RefSect2, RefSynopsisDivInfo, 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.

See Also

Arg, CmdSynopsis, Group, RefNameDiv, RefSect1, SBR, SynopFragment, SynopFragmentRef


For examples, see RefEntry.



In this book, each element of the DTD is described on a reference page, and the RefSynopsisDiv is used for the synopsis at the beginning of each entry.


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: