<tasktroubleshooting>
Task troubleshooting information is information that is intended to help people respond to the situation if a task does not complete as expected.
Usage information
In particular, the <tasktroubleshooting>
element can be used to explain how users can recover when the
results of a task do not match those listed in the
<result> element. The troubleshooting
remedy typically contains one or more actions for solving a
problem. For complex remedies, link to another task.
Rendering expectations
Implementations might want to consider having their stylesheets render a label for this element.
Specialization hierarchy
The <tasktroubleshooting> element is specialized from
<section>. It is defined in the task module.
Content model
(Text | <audio> | <dl> | <div> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <q> | <term> | <text> | <tm> | <xref> | <data> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup>)*
Contained by
- 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
Inheritance
- topic/section task/tasktroubleshooting
The <tasktroubleshooting> element is specialized from <section>. It is defined in the task module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes.
Example
This section is non-normative.
In the following code sample, the <tasktroubleshooting> element
contains brief information that explains the steps that the user can take when the results
of a task are not as expected. For a complex remedy, the author could provide a link to
another task topic.
<task id="add-new-categories>
<title>Adding new user categories</title>
<taskbody>
<steps>
<!-- ... -->
</steps>
<result>
<p>The User Type menu displays the new types you added.</p>
</result>
<tasktroubleshooting>
<p>If the User Type menu does not display the additions, try
one or more of the following:
<ul>
<li>Refresh the page</li>
<li>Verify that Add Types window is not still open; if so,
go to it and press <uicontrol>OK</uicontrol>.</li>
</ul>
</p>
</tasktroubleshooting>
</taskbody>