DocBook 5.2: The Definitive Guide  (Version 5.2.6 for DocBook 5.2b09a)

V5.2synopsisinfo

synopsisinfo — Information supplementing synopsis.

Synopsis

synopsisinfo ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • All of:
    • continuation (enumeration)
      • “continues”
      • “restarts”
    • linenumbering (enumeration)
      • “numbered”
      • “unnumbered”
    • startinglinenumber (integer)
    • xml:space (enumeration)
      • “preserve”
    • language

Description

A synopsisinfo is a verbatim environment for use in synopsis elements. It’s an “escape hatch” to include additional lines of text that don’t otherwise fit into the modeling provided by the synopsis element.

Processing expectations

This element is displayed “verbatim”; whitespace and line breaks within this element are significant.

Attributes

Common attributes and common linking attributes.

continuation

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).

language

Identifies the language (i.e. programming language) of the verbatim content.

linenumbering

Determines whether lines are numbered.

Enumerated values:
“numbered”

Lines are numbered.

“unnumbered”

Lines are not numbered.

startinglinenumber

Specifies the initial line number.

xml:space

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.

Children

The following elements occur in synopsisinfo: text, abbrev, accel, acronym, address, alt, anchor, annotation, application, author, bibliolist, biblioref, blockquote, bridgehead, buildtarget, calloutlist, caution, citation, citebiblioid, citerefentry, citetitle, classname, classsynopsis, cmdsynopsis, co, code, command, computeroutput, constant, constraintdef, constructorsynopsis, coref, danger, database, date, destructorsynopsis, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), enumidentifier, enumname, enumsynopsis, enumvalue, envar, epigraph, equation, errorcode, errorname, errortext, errortype, example, exceptionname, fieldsynopsis, figure, filename, firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), formalgroup, formalpara, funcsynopsis, function, glosslist, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), initializer, inlineequation, inlinemediaobject, interfacename, itemizedlist, jobtitle, keycap, keycode, keycombo, keysym, lineannotation, link, literal, literallayout, macroname, macrosynopsis, markup, mediaobject, menuchoice, methodname, methodsynopsis, modifier, mousebutton, msgset, namespace, namespacename, namespacesynopsis, nonterminal, note, olink, ooclass, ooexception, oointerface, option, optional, orderedlist, org, orgname, package, para, parameter, person, personname, phrase (db._phrase), phrase (db.phrase), procedure, productionset, productname, productnumber, programlisting, programlistingco, prompt, property, qandaset, quote (db._quote), quote (db.quote), remark, replaceable, returnvalue, revhistory, screen, screenco, screenshot, segmentedlist, shortcut, sidebar, simpara, simplelist, subscript, superscript, symbol, synopsis, systemitem, table (db.cals.table), table (db.html.table), tag, task, templateid, termdef, textobject, tip, token, trademark, type, typedefname, typedefsynopsis, unionname, unionsynopsis, uri, userinput, variablelist, varname, warning, wordasword, xref.