Syntax #
s.keyword
Purpose #
The s.keyword annotation is used to tag a span element as being any piece of information associated with a key value. Examples of these include product names, list items, copyrighted terms, and reusable text. This annotation will apply the <keyword> tag, and should be used only when a more specific variant is not applicable.
This annotation can be applied to an inline text span, but the applied tag will only appear in a metadata or prolog element.
More specific version of this tag include, but are not limited to:
- <apiname> (See s.apiname)
- <term> (See s.term)
- <ph> (See s.phrase)
- <kwd> (See s.syntax.keyword)
Example #
The following is an example of a time when you might want to use the annotation
The following is an example of a rule that will apply the annotation
The following is the DITA XML output for the rule:
<p>The Stilo MacGuffin uses the <keyword>Start</keyword> command to begin operation.</p>
