`<stepresult>`

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.

Content model

Contained by

<step>, <substep>

Zero or more of the following

Text
<boolean>
<cite>
<data>
<data-about>
<div>
<dl>
<draft-comment>
<fig>
<fn>
<foreign>
<image>
<indexterm>
<indextermref>
<keyword>
<lines>
<lq>
<note>
<object>
<ol>
<p>
<ph>
<pre>
<q>
<required-cleanup>
<simpletable>
<sl>
<state>
<table>
<term>
<text>
<tm>
<ul>
<unknown>
<xref>

Contained by

<step>
<substep>

Inheritance

- topic/itemgroup task/stepresult

The <stepresult> element is specialized from <itemgroup>. It is defined in the task module.

Example

This section is non-normative.

<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>

Attributes

The following attributes are available on this element: Universal attribute group and outputclass.