    | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
| | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
synopsis — A general-purpose element for representing the syntax of commands or functions
synopsis ::=
info? (db.titleforbidden.info)abbrevaccelacronymaltanchorannotationapplicationauthorbibliorefcitationcitebiblioidciterefentrycitetitleclassnamecocodecommandcomputeroutputconstantcorefdatabasedateeditoremailemphasis (db.emphasis)envarerrorcodeerrornameerrortexterrortypeexceptionnamefilenamefirsttermfootnotefootnoterefforeignphrasefunctionglosstermguibuttonguiiconguilabelguimenuguimenuitemguisubmenuhardwarehtml:buttonhtml:fieldsethtml:inputhtml:labelhtml:selecthtml:textareaindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)initializerinlineequationinlinemediaobjectinterfacenamekeycapkeycodekeycombokeysymlineannotationlinkliteralmarkupmenuchoicemethodnamemodifiermousebuttonnonterminalolinkooclassooexceptionoointerfaceoptionoptionalorgnamepackageparameterpersonnamephrase (db.phrase)productnameproductnumberpromptpropertyquoteremarkreplaceablereturnvalueshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarktypeuriuserinputvarnamewordaswordxreftextobjectCommon attributes and common linking attributes.
Additional attributes:
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.
This element is displayed “verbatim”; whitespace and linebreaks within this element are significant. Synopsis elements are usually
displayed in a fixed width font.
Common attributes and common linking attributes.
Determines whether line numbering continues from the previous element or restarts.
Enumerated values: | |
|---|---|
| “continues” | Line numbering continues from the immediately preceding element with the same name. |
| “restarts” | Line numbering restarts (begins at 1, usually). |
FIXME:
Identifies the language (i.e. programming language) of the verbatim content.
Determines whether lines are numbered.
Enumerated values: | |
|---|---|
| “numbered” | Lines are numbered. |
| “unnumbered” | Lines are not numbered. |
Specifies the initial line number.
Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not.
Enumerated values: | |
|---|---|
| “preserve” | Whitespace must be preserved. |
These elements contain synopsis: annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.
The following elements occur in synopsis: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, co, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db.emphasis), envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm, footnote, footnoteref, foreignphrase, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, html:button, html:fieldset, html:input, html:label, html:select, html:textarea, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), initializer, inlineequation, inlinemediaobject, interfacename, keycap, keycode, keycombo, keysym, lineannotation, link, literal, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, package, parameter, personname, phrase (db.phrase), productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, textobject, token, trademark, type, uri, userinput, varname, wordasword, xref.
cmdsynopsis, computeroutput, funcsynopsis, lineannotation, literallayout, programlisting, screen, screenshot, userinput<article xmlns='http://docbook.org/ns/docbook'> <title>Example synopsis</title> <synopsis>chgrp [-R [-H | -L | -P]] [-f] group file...</synopsis> </article>
chgrp [-R [-H | -L | -P]] [-f] group file...
<article xmlns='http://docbook.org/ns/docbook'> <title>Example synopsis</title> <synopsis>int max(int int1, int int2);</synopsis> </article>
int max(int int1, int int2);
| | | |
| synopfragmentref | | systemitem |