DITA 1.3 Language Reference : Language reference: All-inclusive edition : Technical content elements : Task elements : steptroubleshooting
Was this helpful?
steptroubleshooting
The steptroubleshooting element provides information that is designed to help remedy the situation when a step does not complete as expected. In particular, this element can be used to explain how users can recover when the results of a step do not match those listed in the stepresult element.
Tip: Do not use <note type="trouble"> inside of steptroubleshooting because its meaning there would be ambiguous.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
- topic/itemgroup task/steptroubleshooting
Example 262. Example
The following example illustrates using the steptroubleshooting element with a single action:

<step>
<cmd>Select <uicontrol>Perform system backup</uicontrol></cmd>
<stepresult>
<p>The message <systemoutput>Backup successfully
completed</systemoutput> displays.</p>
</stepresult>
<steptroubleshooting>
<p>If an error message displays during the system backup,
locate the error ID in the <cite>Troubleshooting Guide
</cite> and follow the instructions there.</p>
</steptroubleshooting>
</step>

The following example illustrates using the steptroubleshooting element with several actions:

<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:
<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>
</p>
</steptroubleshooting>
</step>
Attributes
The following attributes are available on this element: Universal attribute group and outputclass.