kwd

The <kwd> element defines a keyword within a syntax diagram. A keyword must be typed or output, either by the user or application, exactly as specified in the syntax definition. 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

( text data )

Contained by

synph, groupseq, groupchoice, groupcomp

Inheritance

topic/keyword, pr-d/kwd

Attributes

Name Description Data Type Default Value Required?
keyref Currently not implemented in DITA processors. Provides a key that a process can use to associate the <kwd> with another topic that provides more details for that particular keyword. NMTOKEN #IMPLIED No
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>