synopfragmentref

synopfragmentref — A reference to a fragment of a command synopsis.

Synopsis

synopfragmentref ::=

  • text

Additional Constraints

  • @linkend on synopfragmentref must point to a synopfragment.

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.

At the point where each piece was extracted, insert a synopfragmentref that points to the fragment. The content of the synopfragmentref will be presented inline.

The extracted pieces are placed in synopfragments at the end of the cmdsynopsis.

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.

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.

Parents

These elements contain synopfragmentref: arg, group (db.group).

Examples

See synopfragment for an example using this element.

Last revised by Norman Walsh on (git hash: 4a070f84c9fc7bc85cf9f71d71fa54f4db18f973 a835fdf61c7f87ce1038e2869080d80ea67d3696)