`<step>`

A step is an action that people take to complete a task. It can also contain additional information about the step, such as an example, result, or troubleshooting guidance.

Rendering expectations

When the @importance attribute is specified on the <step> element, it indicates whether the step is optional or required. Implementations might want to consider having their stylesheets render a applicable label when @importance is specified on <step>,

Specialization hierarchy

The <step> element is specialized from <li>. It is defined in the task module.

Content model

Contained by

<steps>, <steps-unordered>

In order

Contained by

Inheritance

- topic/li task/step

The <step> element is specialized from <li>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes.

For this element, the @importance attribute is limited to the values optional, required, or -dita-use-conref-target.

The following attributes are available on this element: universal attributes and the attributes defined below.

@importance: For this element, the @importance attribute is limited to the values optional, required, or -dita-use-conref-target.

Example

This section is non-normative.

The following code sample shows many of the elements that the <step> element can contain:

<step>
  <cmd>Specify the configuration parameters.</cmd>
  <info>The configuration parameters can be specified from either the command line or
        the product GUI.</info>
  <choices>
    <choice>From a command prompt, type config -l parameter</choice>
    <choice>Click New Configuration Parameters</choice>
  </choices>
  <stepresult>You receive a 'Configuration successful' message.</stepresult>
  <steptroubleshooting>If you do not receive a 'Configuration successful message,'
                       retry the configuration operation.</steptroubleshooting>
</step>