Steps Element (steps)
The steps element contains a sequence of steps that describe how to perform a task. It's suitable for both simple procedures and complex, multi-level instructions.
The steps element serves these primary purposes:
-
Organizing procedural instructions in a sequential, ordered format
-
Presenting clear, step-by-step guidance for completing tasks
Key characteristics of the steps element:
-
A container element that must contain one or more
stepelements, each with a requiredcmdelement and optional supporting elements -
Can include
stepsectionelements to group steps and provide introductory text between steps -
Supports complex content within steps, including substeps, choices, and notes
-
Must appear within the
taskbodyelement of a task topic Can be replaced by the
steps-unorderedelement (stepsandsteps-unorderedcan't coexist)
A steps element consists of these optional and required components:
- Step Section (
stepsection) - An optional element that provides additional content between steps. It can be used to group related steps together, introduce a set of steps, or provide transitional information.
- Step (
step) - A required element that contains a single step in the procedure, including a command (action) in the required
cmdelement and optional, additional elements such asinfo,example, orsubsteps.
Content within the steps element typically follows these output formatting rules:
-
Steps with one
stepelement might be presented as a paragraph Steps with two or more
stepelements are automatically numbered in sequential orderUnlike steps, step sections are not numbered but may be emphasized (bold)
Use steps to:
-
Provide sequential instructions for completing a task in the form of clear, numbered steps
-
Detail a process that must be performed in a specific order
-
Guide users through complex procedures with multiple actions
A steps element added to a task topic in the Heretto CCMS Content Editor.
The steps element in a task topic for setting up a user account:
<task id="task-5384">
<title>Signing in to MobileView</title>
<shortdesc>Sign in to the MobileView application through the ClusterControl server.</shortdesc>
<prolog>
<author translate="no" type="creator">Heretto User <user@heretto.com></author>
</prolog>
<taskbody>
<prereq>
<p>Ensure you have your username, password, and the name of the server that you want to connect to.</p>
</prereq>
<steps>
<step>
<cmd>To open MobileView, click <menucascade><uicontrol>Start</uicontrol><uicontrol>All programs</uicontrol><uicontrol>Thunderbird MobileView</uicontrol></menucascade>.</cmd>
</step>
<step>
<cmd>In the MobileView window, do one of the following:</cmd>
<choices>
<choice>Enter your MobileView username and password.</choice>
<choice>Sign in using your <tm tmtype="reg">Windows</tm> user account by selecting the <uicontrol>Windows</uicontrol> selection button.</choice>
</choices>
</step>
<step>
<cmd>In the directory field, enter the name or IP address of the main StormCluster ClusterControl server. Click <uicontrol>Sign In</uicontrol>.</cmd>
</step>
</steps>
<result>
<p>You are signed in to MobileView. You can sign out by clicking <menucascade><uicontrol>Home</uicontrol><uicontrol>Sign Out</uicontrol></menucascade>. If you do not sign out manually, you will be signed out automatically after a period of inactivity. </p>
</result>
</taskbody>
</task>