Syntax #
s.choice.option
Purpose #
The s.choice.option annotation is used to tag a span element as being an action that a user can choose to perform during a procedure. This element can be contained within a choice table or plain text. A choice option element can be paired with a choice description element, but this is not required.
See s.choice.description for more information.
Examples #
The following is an example of a time where you might want to use the s.choice.option annotation:
In this example, the s.choice.option annotation will be applied to the spans “Option A” and “Option B”.
The following is an example of a rule that will apply s.choice.option:
In this example, the s.choice.option annotation is being applied only to spans with the TaskOptionChar style.
The following is the DITA XML output for the previous rule, with the relevant portion in bold:
<conbody>
<p><choptionhd id=”ID-0000008c”>Options</choptionhd> <chdeschd id=”ID-0000008e”>Explanations</chdeschd>
</p>
<p><choption id=”ID-00000090″>Option A</choption> <chdesc id=”ID-00000092″>This is what happens when you do Option A.</chdesc>
</p>
<p><choption id=”ID-00000094″>Option B</choption> <chdesc id=”ID-00000096″>This is what happens when you do Option B.</chdesc>
</p>
</conbody>
</concept>
