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+)))
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]
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.
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.
| [1] | 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. |
Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.