<kwd>

The <kwd> element defines a keyword within a syntax diagram. A keyword is 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.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/keyword pr-d/kwd

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>

Attributes

The following attributes are available on this element: Universal attribute group (with a narrowed definition of @importance, given below), @outputclass, and @keyref.

@importance
The attribute indicates whether this item in a syntax diagram is optional, required, or default. Output processors might indicate this designation in a generated diagram. Allowable values are:
optional
This section of the syntax is optional.
required
This section of the syntax is required.
default
This section of the syntax is used by default or has this default value.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.

Was this helpful?