Group

Name

Group -- A group of elements in a CmdSynopsis

Synopsis

Content Model

Group ::=
((Arg|Group|Option|SynopFragmentRef|Replaceable|SBR)+)

Attributes

Common attributes

Name

Type

Default

Rep

Enumeration:

Norepeat
Repeat

"Norepeat"
Choice

Enumeration:

Opt
Optmult
Plain
Req
Reqmult

"Opt"

Tag Minimization

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

Description

A Group surrounds several related items. Usually, they are grouped because they are mutually exclusive. The user is expected to select one of the items.

Processing expectations

Formatted inline. The additional processing expectations of a Group are significant. For a complete discussion, see CmdSynopsis.

(4.0) Future Changes

The OptMult and ReqMult values for the Choice attribute will be removed in DocBook V4.0. Use the Rep attribute instead to indicate that the choice is repeatable.

Parents

These elements contain Group: Arg, CmdSynopsis, Group, SynopFragment.

Children

The following elements occur in Group: Arg, Group, Option, Replaceable, SBR, SynopFragmentRef.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Choice

Choice indicates whether the Arg is required (Req or Plain) or optional (Opt). Arguments identified as Plain are required, but are shown without additional decoration. The OptMult and ReqMult choices will be removed in DocBook V4.0; use the Rep attribute instead.

Rep

A Rep value of Repeat indicates that the Group is reapeatable. This is frequently rendered with an ellipsis.

See Also

Arg, CmdSynopsis, RefSynopsisDiv, SBR, SynopFragment, SynopFragmentRef

Examples

For examples, see CmdSynopsis, SynopFragment.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.