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.

Example

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

Contains

Doctype Content model
ditabase, task ( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or draft-comment or required-cleanup or fn or indextermref or indexterm or data or data-about or foreign or unknown) (any number)

Contained by

Doctype Parents
ditabase, task step, substep

Inheritance:

- topic/itemgroup task/stepresult

Attributes

Name Description Data Type Default Value Required?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes      

Return to main page.

OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.