groupchoice

The <groupchoice> element is part of the subset of elements that define syntax diagrams in DITA. A group is a logical set of pieces of syntax that go together. A group choice specifies that the user must make a choice about which part of the syntax to use. Groups are often nested. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Contains

( (title) (optional) then (repsep) (optional) then (groupseq or groupchoice or groupcomp or fragref or kwd or var or delim or oper or sep or synnote or synnoteref) (any number) )

Contained by

syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Inheritance

topic/figgroup, pr-d/groupchoice

Attributes

Name Description Data Type Default Value Required?
importance The attribute indicates whether a variable is optional, required, or default. optional | required | default #IMPLIED No
%univ-atts-no-importance A set of related attributes, described at %univ-atts;, but without the importance attribute parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes

Example

<syntaxdiagram frame="bottom">
 <title>CopyFile</title>
 <groupseq><kwd>COPYF</kwd></groupseq>
 <groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
 <groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
 <groupchoice><var>input-filename</var><kwd>*INFILE</kwd></groupchoice>
 <groupchoice><var>output-filename</var><kwd>*OUTFILE</kwd></groupchoice>
</syntaxdiagram>