DocBook 5: The Definitive Guide
| | By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM
|
| DocBook: The Definitive Guide | ||
|---|---|---|
| Prev | Next | |
Name
Arg -- An argument in a CmdSynopsis
Synopsis
Mixed Content Model
Arg ::= ((#PCDATA|Arg|Group|Option|SynopFragmentRef|Replaceable|SBR)+)
Attributes
Common attributes
Name | Type | Default |
| Rep | Enumeration: NorepeatRepeat | "Norepeat" |
| Choice | Enumeration: OptPlainReq | "Opt" |
Tag Minimization
Both the start- and end-tags are required for this element.
Description
See CmdSynopsis for more information.
Processing expectations
May be formatted inline or as a displayed block, depending on context.
Parents
These elements contain Arg: Arg, CmdSynopsis, Group, SynopFragment.
Children
The following elements occur in Arg: 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.
- Rep
A Rep value of Repeat indicates that the Arg is reapeatable. This is frequently rendered with an ellipsis.
See Also
CmdSynopsis, Group, RefSynopsisDiv, SBR, SynopFragment, SynopFragmentRef
Examples
For examples, see CmdSynopsis, SynopFragment.
| Prev | Home | Next |
| AreaSpec | Up | ArtHeader |
Back to: DocBook: The Definitive Guide
O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts International | About O'Reilly | Affiliated Companies
© 1999, O'Reilly & Associates, Inc.