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.
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap |
( text data or text) (any number) |
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap |
<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>
The attribute indicates whether this item in a syntax diagram is optional, required, or default. Output processors may indicate this designation in a generated diagram. See 3.4.2.4.1 Using the -dita-use-conref-target value for more information on the -dita-use-conref-target value. |
||||
Root attribute from which new metadata attributes can be specialized. |
||||
A generic attribute that has no specific purpose. It is intended to act as a base for specialized attributes that have a simple value syntax like the conditional processing attributes (one or more alphanumeric values separated by whitespace), but is not itself a filtering or flagging attribute. |
||||
Contains the name of the product to which the element applies. |
||||
This attribute can be used for any other properties that might be needed to describe an audience, or to provide selection criteria for the element. Alternatively, the props attribute may be specialized to provide a new metadata attribute instead of using the general otherprops attribute. |
||||
Indicates a revision level of an element that identifies when the element was added or modified. It may be used to flag outputs when it matches a run-time parameter; it cannot be used for filtering. It is not sufficient to be used for version control. |
||||
new | changed | deleted | unchanged | -dita-use-conref-target |
||||
id-atts attribute group (id, conref, conrefend, conaction, conkeyref) |
A set of related attributes, described in 3.4.1.4 id-atts attribute group |
|||
localization-atts attribute group (translate, xml:lang, dir) |
A set of related attributes, described in 3.4.1.6 localization-atts attribute group. |
|||
A set of related attributes, described in 3.4.1.2 global-atts attribute group |
||||
Class and outputclass are described in 3.4.1.9 Other common DITA attributes |