DITA Best Practices : Using a Task to create a numbered list (Using <Steps/>)

Created by Todd Stupnik, last modified on Nov 18, 2014

Use the <steps> element to create a numbered list of all the steps that the user must follow to complete the task. The <steps> element is the container for all of the individual <step> elements that your task contains.

Use the <step> element to develop each each that the user must follow to complete the task. Each <step> element must reside in the <steps> container and must being with a <cmd> element.

Example Code:

<steps>
      <step>
          <cmd>Select an <b>Account</b> from the corresponding dropdown. </cmd>
      </step>
      <step>
          <cmd>Click the <b>Submit Start Date</b> and <b>Submit End Date</b> fields to display
               an interactive calendar. Select the month and day or click the "&lt;" or ">"
               arrows to navigate to the desired month.</cmd>
      </step>
</steps>

 

Step-by-step guide

To create a numbered list:

  1. When creating a new task, by default the steps element appears, containing one individual step element. A command <cmd></cmd> element resides within the step element. 

  2. To insert additional steps, place the cursor either within the command element, or between the command and step element. Click Enter and select New Step at the top of the resulting list.