Taskbody Element (taskbody)
The taskbody element defines the main structure of a task, containing essential components such as prerequisites, procedural steps, and expected results.
The taskbody element serves as the central container for instructional content in a task topic, ensuring a structured and logical flow. It serves these primary purposes:
-
Organizes task-related content into predefined sections
-
Supports key elements such as
prereq,steps,result, andexample -
Maintains consistency in procedural documentation
Key characteristics of the taskbody element:
-
Must be present in every
tasktopic -
Contains a sequence of elements that define a complete procedure and is less strict than that of the strict task topic
A taskbody consists of these required and optional elements:
- Prerequisite (
prereq) (optional, in any order, any number) -
An optional, task-specific element that describes conditions that must be fulfilled or actions that must be performed before starting the task. May include system requirements, access privileges needed, or prior tasks that must be completed.
- Context (
context) (optional, in any order, any number) -
An optional, task-specific element that provides background information or explains why the task is necessary. Helps users understand the purpose and importance of the task without describing how to perform it.
- Section (
section) (optional, in any order, any number) -
An optional, common element that can appear before or after any standard task element to provide additional information not covered by the structured task components. Useful for specialized content that doesn't fit into other task elements.
- Steps (
steps) (required, one only) -
A required, task-specific element (if
steps-unorderedis not used) that contains a sequence ofstepelements representing ordered actions to perform. Steps are numbered automatically in output formats to show the exact sequence users must follow. - Steps Unordered (
steps-unordered) (required, one only) -
A required, task-specific element (if
stepsis not used) that contains a sequence ofstepelements representing unordered actions that can be performed in any sequence. Typically rendered as a bulleted list rather than a numbered list. - Result (
result) (optional, one only, precedes example) -
An optional, task-specific element that describes the expected outcome after completing all the steps in the task. May include system responses, changes to the interface, or verification methods to confirm successful completion.
- Example (
example) (optional, any number, precedes postreq) -
An optional, common element that provides a sample scenario or usage of the task. Can include code samples, screenshots, or walkthroughs that illustrate how the task might be applied in a real-world situation.
- Postrequisite (
postreq) (optional, any number) -
An optional, task-specific element that describes actions that should be performed after the main task is completed. May include cleanup activities, verification procedures, or follow-up tasks.
Content within the taskbody element typically follows these output formatting rules:
-
Each main section (
prereq,context,steps, and so on) is typically labeled with a heading, like Prerequisite, Context, Procedure, or distinctive formatting in the output -
The
stepssection is usually formatted as a numbered list, whilesteps-unorderedappears as a bulleted list -
Supporting information like
noteandhazardstatementare styled distinctively to draw attention -
The
prereqandpostreqsections may be visually separated from the main procedure to emphasize their importance -
Elements with specific roles, like
exampleorresult, may be labeled or styled uniquely to indicate their purpose -
Nested elements, like
substepswithinsteps, are typically indented or otherwise visually distinguished from their parent elements
A taskbody element with its most common elements in the Heretto CCMS Content Editor.
The DITA source of the taskbody element with the surrounding context of a task:
<task id="task-6667">
<title>Signing in to MobileView</title>
<shortdesc>Learn how to sign in to the MobileView application through the ClusterControl server.</shortdesc>
<prolog>
<author translate="no" type="creator">Heretto User <user@heretto.com></author>
</prolog>
<taskbody>
<prereq>
<p>Ensure you have your username, password, and the name of the server that you want to connect to.</p>
</prereq>
<context>
<p>After signing in, you can sign out and disconnect from a particular project without closing MobileView. Signing out without closing the application is helpful if you plan to sing in again using different credentials.</p>
</context>
<steps>
<step>
<cmd>To open MobileView, click <menucascade><uicontrol>Start</uicontrol><uicontrol>All programs</uicontrol></menucascade> Thunderbird MobileView.</cmd>
</step>
<step>
<cmd>In the MobileView window, do one of the following:</cmd>
<choices>
<choice>Enter your MobileView username and password.</choice>
<choice>Sign in using your <tm tmtype="reg">Windows</tm> user account by selecting the <uicontrol>Windows</uicontrol> selection button.</choice>
</choices>
</step>
<step>
<cmd>In the directory field, enter the name or IP address of the main StormCluster ClusterControl server. Click <uicontrol>Sign In</uicontrol>.</cmd>
</step>
</steps>
<result>
<p>You are signed in to MobileView. You can sign out by clicking <menucascade><uicontrol>Home</uicontrol><uicontrol>Sign Out</uicontrol></menucascade>. If you do not sign out manually, you will be signed out automatically after a period of inactivity. </p>
</result>
<postreq>
<p>After signing in, verify that the dashboard shows the correct user information and project data.</p>
</postreq>
</taskbody>
</task>