Syntax #
s.choice.description
Purpose #
The s.choice.description annotation is used to tag a span element as being an explanation or result statement of 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 description element must be paired with a choice option element.
See s.choice.option 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.description annotation will be applied to the spans “This is what happens when you do Option A.” and “This is what happens when you do Option B.”
The following is an example of a rule that will apply s.choice.description:
In this example, the s.choice.description annotation is being applied only to spans with the TaskDefChar 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>
