[Prev] [Next]

SynopFragmentRef

Name

Synopsis

  RCDATA

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
Linkend	IDREF	#REQUIRED

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Part of a CmdSynopsis. It contains RCDATA (characters, in which entity references and character references are recognized in parsing) rather than elements. It has common and Linkend (required) attributes. Linkend should point to SynopFragment.

Parents

These elements contain SynopFragmentRef: Arg, and Group.

Children

SynopFragmentRef contains RCDATA.

Attributes

Linkend

ID of target pointed to by this element.

Examples

<cmdsynopsis>
  <!-- This is a synopsis for the command foo.
       The options -a and -x are optional and exclusive
       The option -c takes a cheese and is optional and repeatable
       The options -t and -k are referred to in another fragment
       The options -i, -j, and -k are required and exclusive
       The option -f takes a filename and is required
       The -t and -k options specify the kind of milk and mold in an
           optional and repeatable group
  -->
  <command>foo</command>
  <group>
    <arg>-a</arg>
    <arg>-x</arg>
  </group>
  <group>
  <arg rep=repeat>-c <replaceable>cheese</replaceable></arg>
  <synopfragmentref linkend=cheesetype>cheesetype</synopfragmentref>
  </group>
  <group choice=req>
    <arg>-i</arg>
    <arg>-j</arg>
    <arg>-k</arg>
  </group>
  <arg choice=req>-f <replaceable>filename</replaceable></arg>
  <synopfragment id=cheesetype>
    <group rep=repeat>
       <arg>-t <replaceable>milk</replaceable></arg>
       <arg>-k <replaceable>mold</replaceable></arg>
    </group>
  </synopfragment>
</cmdsynopsis>

[Prev] SynopFragment
[Next] Synopsis
[Reference Home] [Davenport Group Home]