tasktroubleshooting

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

The tasktroubleshooting element provides information designed to help users remedy the situation when a task does not complete as expected. In particular, this 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.

Tip: Do not use <note type="trouble"> inside of tasktroubleshooting because its meaning there would be ambiguous.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/section task/tasktroubleshooting

Example

  <steps>
    <step><cmd>...</cmd></step>
    <!-- ... more steps ... -->
  </steps>
  <result>
    <p>The <uicontrol>User Type</uicontrol> menu updates to
      display 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 <wintitle>Add Types</wintitle> is not
          still open; if so, go to it and press
          <uicontrol>OK</uicontrol>.</li>
      </ul>
    </p>
  </tasktroubleshooting>
  <example>
    <p>For example, you could also do xyz.</p>
  </example>
  <postreq>
    <p>Once completed, you need to consider abc.</p>
  </postreq>

Attributes

The following attributes are available on this element: Universal attribute group and outputclass.