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

synopfragment — A portion of a cmdsynopsis broken out from the main body of the synopsis

Synopsis

synopfragment ::= (arg | group)+

Description

A complex cmdsynopsis can be made more manageable with synopfragments. 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 synopfragments 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> ...

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