The strict task-document type supports the development of instructions for the completion of a procedure. The strict-task document type is built using the general-task information type combined with the strict taskbody constraint. See the reference below to ensure that you have the correct task document type when you update to DITA 1.3 from DITA 1.0 or DITA 1.1
Tasks are the essential
building blocks to provide procedural information. A task information type
answers the "How do I?" question by providing precise step-by-step instructions
detailing the requirements that must be fulfilled, the actions that must be
performed, and the order in which the actions must be performed. The
<task> topic includes sections for describing the
context, prerequisites, expected results, and other aspects of a task.
<task> element is the top-level element for the strict
task topic. The strict task document type contains a
<title> and a
optional alternative titles (
<titlealts>), a short
<taskbody> element is the main body element inside a
strict task document type. The strict task body has a constrained structure,
with these optional elements in the following order:
<task>consists of a series of steps that accomplish the task. The
<steps>element must have one or more
<step>elements, which provide the specifics about each step in the task. The
<steps>element can occur only once.
<step> element represents an action that a
user must follow to accomplish a task. Each
<step> in a
must contain a command
<cmd> element which
describes the particular action the user must perform to accomplish the
overall task. The
<step> element can also contain information
<substeps>, tutorial information
<tutorialinfo>, a step example
<choices>, a step result
<stepresult>, or troubleshooting
these are optional.
<task>topic, allowing for a single step in a procedure or a set of commands that need not be performed in a specific order.
<task id="birdhousebuilding"> <title>Building a bird house</title> <shortdesc>Building a birdhouse is a perfect activity for adults to share with their children or grandchildren. It can be used to teach about birds, as well as the proper use of tools. </shortdesc> <taskbody> <context>Birdhouses provide safe locations for birds to build nests and raise their young. They also provide shelter during cold and rainy spells.</context> <prereq>To build a sound birdhouse, you will need a complete set of tools: <ul><li>hand saw</li> <li>hammer ... </li> </ul></prereq> <steps> <step><cmd>Lay out the dimensions for the birdhouse elements.</cmd></step> <step><cmd>Cut the elements to size.</cmd></step> <step><cmd>Drill a 1 1/2" diameter hole for the bird entrance on the front.</cmd> <info>You need to look at the drawing for the correct placement of the hole.</info></step> <!--...--> </steps> <result>You now have a beautiful new birdhouse!</result> <postreq>Now find a good place to mount it.</postreq> </taskbody> </task>
Organizations that have created specializations based on the DITA 1.0 and 1.1 strict task model can review the recommendations in Migrating from DITA 1.1 to 1.2 for information about how to maintain their specializations.
Return to main page.
|Copyright © OASIS Open 2015. All Rights Reserved.||03 September 2015|