Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

RefSynopsisDiv
Guide to the DocBook DTD
PrevNext

RefSynopsisDiv

Name

RefSynopsisDiv -- Major division of a reference page, in which the syntax of the subject of the reference page is indicated

Content Model

  RefSynopsisDivInfo?,
  (Title, 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 | InformalEquation
    | InformalExample | InformalTable | Equation | Example
    | Figure | Table | MsgSet | Procedure | Sidebar | Anchor
    | BridgeHead | Comment | Highlights | Abstract
    | AuthorBlurb | Epigraph)+
    , RefSect2*)
    | (RefSect2+)
  )

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Major division of a reference page, in which the syntax of the subject of the reference page is indicated. It contains, in order, an optional Title and TitleAbbrev, followed by either one or more synopses (Synopsis, CmdSynopsis, or FuncSynopsis) succeeded by any number of RefSect2s, or simply one or more RefSect2s. It has common attributes.

Parents

RefSynopsisDiv occurs in RefEntry.

Children

RefSynopsisDiv contains these elements: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, InformalEquation, InformalExample, InformalTable, ItemizedList, LiteralLayout, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, RefSect2, RefSynopsisDivInfo, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.

In some contexts, additional elements may be allowed by inclusions in parent elements.

Examples

<REFSYNOPSISDIV ID="RS-061-66">
<SYNOPSIS>
<COMMAND>ls</COMMAND>
<OPTIONAL><PARAMETER>options</PARAMETER></OPTIONAL>
<REPLACEABLE CLASS="PARAMETER">directory name
</REPLACEABLE>
</SYNOPSIS>
</REFSYNOPSISDIV>
PrevHomeNext
RefSynopsisDivInfoUpReleaseInfo