Name
synopsis — A general-purpose element for representing the syntax of commands or functions
Synopsis
synopsis ::=
(info? db.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)languagexml: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 ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access