Name
synopfragment — A portion of a cmdsynopsis broken out from the main body of the synopsis
Synopsis
synopfragment ::=
(arg
| group
)+
Attribute synopsis
Description
A complex cmdsynopsis
can be made more
manageable with synopfragment
s. Rather than
attempting to present the entire synopsis in one large piece, parts of
the synopsis can be extracted and presented elsewhere. These extracted
pieces are placed in synopfragment
s at the end of the
cmdsynopsis
.
At the point in which each piece was extracted, insert a
synopfragmentref
that points to the fragment. The
content of the reference element will be presented inline.
Processing expectations
Formatted as a displayed block.
The presentation system is responsible for generating text that makes the reader aware of the link. This can be done with numbered bullets, or any other appropriate mechanism. Whatever mark is generated for the reference must also be generated for the fragment.
Online systems have additional flexibility. They may generate hot links between the references and the fragments, for example, or place the fragments in pop-up windows.
See Also
arg
, cmdsynopsis
, group
, refsynopsisdiv
, sbr
, synopfragmentref
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example synopfragment</title> <cmdsynopsis> <command>cccp</command> <arg>-$</arg> <arg>-C</arg> <arg rep='repeat'>-D<replaceable>name</replaceable> <arg>=<replaceable>definition</replaceable></arg></arg> <arg>-dD</arg> <arg>-dM</arg> ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.