The <stepresult> element provides information on the expected outcome of a step. If a user interface is being documented, the outcome could describe a dialog box opening or the appearance of a progress indicator. Step results are useful to assure a user that they are on track, but should not be used for every step as this quickly becomes tedious.
Doctype | Content model |
---|---|
ditabase, task (strict), task (general), machineryTask, learningContent | step, substep |
<steps> <step> <cmd importance="urgent">Once you have the water place it in the microwave.</cmd> <info>Try not to spill any, as water is very wet.</info> </step> <step importance="required"> <cmd>Start the Microwave.</cmd> <stepxmp>As an example, push the <b>Start</b> button</stepxmp> <stepresult>The Microwave starts running. You should hear it humming.</stepresult> </step> <step importance="optional"> <cmd>Once the water begins to boil, stop the Microwave.</cmd> </step> </steps>
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
DITA v1.2 CD 04
Copyright © OASIS Open 2005, 2010. All Rights Reserved.