refsynopsisdiv

$Revision: 1.3 $

$Date: 2002/06/12 11:18:32 $

refsynopsisdiv — A syntactic synopsis of the subject of the reference page

Synopsis

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|classsynopsis|
    fieldsynopsis|constructorsynopsis|destructorsynopsis|
    methodsynopsis|formalpara|para|simpara|address|blockquote|
    graphic|graphicco|mediaobject|mediaobjectco|informalequation|
    informalexample|informalfigure|informaltable|equation|example|
    figure|table|msgset|procedure|sidebar|qandaset|task|
    productionset|constraintdef|anchor|bridgehead|remark|
    highlights|abstract|authorblurb|epigraph|indexterm|beginpage)+,
   refsect2*)|
  (refsect2+)))

Attributes

Common attributes

Description

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.[21]

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.

Parents

These elements contain refsynopsisdiv: refentry.

See Also

arg, cmdsynopsis, group, refnamediv, refsect1, refsect2, refsect3, refsection, sbr, synopfragment, synopfragmentref.



[21] 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.
http://techdoc.kvindesland.no/devcenter/tdg/en/html/refsynopsisdiv.html
techdoc.kvindesland.no
crawl=CC-MAIN-2017-30
16346
application/http; msgtype=response
sha1:G362L6P6W5RVL26T3OESAIVFMLGXNVOJ
<urn:uuid:cad95435-ade3-4b79-85be-93548cb08720>
2017-07-26T16:31:32Z
92.221.184.82
text/html
sha1:J4TVABJ7TZRV3EI33ZTT37M3QLNGXOKU
<urn:uuid:a5ee4886-8383-41df-a1db-ec6c28216e92>
http://techdoc.kvindesland.no/devcenter/tdg/en/html/refsynopsisdiv.html
response
<urn:uuid:c912ada2-0481-4349-8aa4-d18bd71bc51c>
robots: classic
hostname: ip-10-166-24-167.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2017-30
operator: Common Crawl Admin
description: Wide crawl of the web for July 2017
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf