O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

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

Synopsis

synopsis ::= (infodb.titleforbidden.info, ((text | lineannotation | Bibliography inlines | Computer-output inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines | User-input inlines)* | textobject))

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • continuation (enumeration) = “continues” | “restarts”

  • linenumbering (enumeration) = “numbered” | “unnumbered”

  • startinglinenumber (integer)

  • language

  • xml:space (enumeration) = “preserve”

  • label

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 line breaks within this element are significant. A synopsis element is usually displayed in a fixed-width font.

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

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required