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
Prev		Next

---

Synopsis

Name

Synopsis -- A general-purpose element for representing the syntax of commands or functions

Synopsis

Mixed Content Model

Synopsis ::=
((LineAnnotation|#PCDATA|FootnoteRef|XRef|Abbrev|Acronym|Citation|
  CiteRefEntry|CiteTitle|Emphasis|FirstTerm|ForeignPhrase|
  GlossTerm|Footnote|Phrase|Quote|Trademark|WordAsWord|Link|OLink|
  ULink|Action|Application|ClassName|Command|ComputerOutput|
  Database|Email|EnVar|ErrorCode|ErrorName|ErrorType|Filename|
  Function|GUIButton|GUIIcon|GUILabel|GUIMenu|GUIMenuItem|
  GUISubmenu|Hardware|Interface|InterfaceDefinition|KeyCap|
  KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|MediaLabel|
  MenuChoice|MouseButton|MsgText|Option|Optional|Parameter|Prompt|
  Property|Replaceable|ReturnValue|SGMLTag|StructField|StructName|
  Symbol|SystemItem|Token|Type|UserInput|VarName|Anchor|Author|
  AuthorInitials|CorpAuthor|ModeSpec|OtherCredit|ProductName|
  ProductNumber|RevHistory|Comment|Subscript|Superscript|
  InlineGraphic|InlineMediaObject|InlineEquation|Synopsis|
  CmdSynopsis|FuncSynopsis|IndexTerm|Graphic|MediaObject)+)

Attributes

Common attributes

Name	Type	Default
Label	CDATA	None
Format	Enumerated notation: linespecific	"linespecific"

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%admon.mix;	%bookcomponent.content;	%component.mix;
%divcomponent.mix;	%example.mix;	%figure.mix;
%footnote.mix;	%glossdef.mix;	%indexdivcomponent.mix;
%para.char.mix;	%programlisting.content;	%qandaset.mix;
%refcomponent.mix;	%screen.content;	%sidebar.mix;
%synop.class;	%tbl.entry.mdl;

Description

A Synopsis is a verbatim environment for displaying command, function, and other syntax summaries.

Unlike CmdSynopsis and FuncSynopsis which have a complex interior structure, Synopsis is simply a verbatim environment.

Processing expectations

This element is displayed "verbatim"; whitespace and linebreaks within this element are significant. Synopsis elements are usually displayed in a fixed width font.

 Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Parents

These elements contain Synopsis: Answer, Appendix, Application, Article, Attribution, BiblioDiv, Bibliography, BiblioMisc, BlockQuote, Callout, Caution, Chapter, Citation, CiteTitle, Comment, Emphasis, entry, Example, Figure, Footnote, ForeignPhrase, Glossary, GlossDef, GlossDiv, GlossSee, GlossSeeAlso, GlossTerm, Important, Index, IndexDiv, InformalExample, InformalFigure, LineAnnotation, Link, ListItem, LiteralLayout, LoTentry, Member, MsgAud, MsgExplan, MsgText, Note, OLink, Para, PartIntro, Phrase, Preface, Procedure, ProductName, ProgramListing, QandADiv, QandASet, Question, Quote, RefEntryTitle, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Screen, ScreenInfo, Sect1, Sect2, Sect3, Sect4, Sect5, Section, Seg, SetIndex, Sidebar, SimPara, SimpleSect, Step, Synopsis, Term, Tip, ToCback, ToCentry, ToCfront, ULink, Warning.

Children

The following elements occur in Synopsis: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GlossTerm, Graphic, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, LineAnnotation, Link, Literal, Markup, MediaLabel, MediaObject, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Acronym, Footnote, IndexTerm.

Attributes

Format

The Format attribute applies the linespecific notation to all synopses. All white space and line breaks must be preserved.

Label

Label specifies an identifying number or string that may be used in presentation.

See Also

CmdSynopsis, ComputerOutput, FuncSynopsis, LineAnnotation, LiteralLayout, ProgramListing, Screen, ScreenShot, UserInput

Examples

<!DOCTYPE synopsis PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<synopsis>
chgrp [-R [-H | -L | -P] [-f] group file...
</synopsis>

chgrp [-R [-H | -L | -P] [-f] group file...

<!DOCTYPE synopsis PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<synopsis>
int max(int int1, int int2);
</synopsis>

int max(int int1, int int2);

For additional examples, see also Optional, RefEntry.

---

Prev	Home	Next
SynopFragmentRef	Up	SystemItem

Back to: DocBook: The Definitive Guide