synopfragment

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

Synopsis

synopfragment ::=

One or more of:
- arg
- group

Attributes

Common attributes and common linking attributes.

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

Parents

These elements contain synopfragment: cmdsynopsis.

Children

The following elements occur in synopfragment: arg, group.

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>
  <sbr/>
  <arg rep='repeat'>-I <replaceable>directory</replaceable></arg>
  <arg>-H</arg>
  <arg>-I-</arg>
  <arg rep='repeat'>-imacros <replaceable>file</replaceable></arg>
  <sbr/>
  <arg rep='repeat'>-include <replaceable>file</replaceable></arg>
  <group>
    <synopfragmentref linkend="langs">languages</synopfragmentref>
  </group>
  <arg>-lint</arg>
  <sbr/>
  <group>
    <arg>-M</arg>
    <arg>-MD</arg>
    <arg>-MM</arg>
    <arg>-MMD</arg>
  </group>
  <arg>-nostdinc</arg>
  <arg>-P</arg>
  <arg>-pedantic</arg>
  <sbr/>
  <arg>-pedantic-errors</arg>
  <arg>-trigraphs</arg>
  <arg>-U<replaceable>name</replaceable></arg>
  <sbr/>
  <arg>-undef</arg>
  <arg choice="plain"><synopfragmentref linkend="warn">warnings
    </synopfragmentref></arg>
  <group choice='req'>
    <arg><replaceable>infile</replaceable></arg>
    <arg>-</arg>
  </group>
  <group choice='req'>
    <arg><replaceable>outfile</replaceable></arg>
    <arg>-</arg>
  </group>

  <synopfragment xml:id="langs">
    <group choice="plain">
      <arg>-lang-c</arg>
      <arg>-lang-c++</arg>
      <arg>-lang-objc</arg>
    </group>
  </synopfragment>

  <synopfragment xml:id="warn">
    <arg>-Wtrigraphs</arg>
    <arg>-Wcomment</arg>
    <arg>-Wall</arg>
    <arg>-Wtraditional</arg>
  </synopfragment>

</cmdsynopsis>

</article>

cccp [-$] [-C] [-Dname [=definition]...] [-dD] [-dM]
[-I directory...] [-H] [-I-] [-imacros file...]
[-include file...] [(1) languages] [-lint]
[[-M] | [-MD] | [-MM] | [-MMD]] [-nostdinc] [-P] [-pedantic]
[-pedantic-errors] [-trigraphs] [-Uname]
[-undef] (2) warnings {[infile] | [-]} {[outfile] | [-]}

(1) [-lang-c] | [-lang-c++] | [-lang-objc]

(2) [-Wtrigraphs] [-Wcomment] [-Wall] [-Wtraditional]

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


symbol		synopfragmentref