`<steptroubleshooting>`

Step troubleshoooting is information that is intended to help people respond to the situation if a step does not complete as expected.

Specialization hierarchy

The <steptroubleshooting> element is specialized from <div>. It is defined in the task module.

Content model

Contained by

<step>

Zero or more of the following

Text
<audio>
<cite>
<data>
<div>
<dl>
<draft-comment>
<example>
<fig>
<fn>
<foreign>
<image>
<include>
<indexterm>
<keyword>
<lines>
<lq>
<note>
<object>
<ol>
<p>
<ph>
<pre>
<q>
<required-cleanup>
<simpletable>
<sl>
<table>
<term>
<text>
<tm>
<ul>
<video>
<xref>

Contained by

<step>

Inheritance

- topic/div task/steptroubleshooting

The <steptroubleshooting> element is specialized from <div>. It is defined in the task module.

Attributes

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

Example

This section is non-normative.

The following code sample shows how the <steptroubleshooting> element specifies the troubleshooting actions that a user can take if the step does not complete as they expected:

<step>
  <cmd>Log in to the system</cmd>
  <stepresult>
    <p>The <wintitle>Welcome</wintitle> screen appears.</p>
  </stepresult>
  <steptroubleshooting>
    <p>If the <wintitle>Welcome</wintitle> screen does not
       appear, try one or more of the following actions:</p>
    <ul>
      <li>Verify that the user name was entered correctly</li>
      <li>Verify that the password was entered correctly</li>
      <li>Confirm that the maintenance contract is still active</li>
    </ul>
  </steptroubleshooting>
</step>