General task topic

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

version
1.3
author
OASIS DITA Technical Committee

The general-task document type was introduced in DITA 1.2. It provides a less-strict content model for task-oriented information than was available previously. Some organizations might prefer the general-task content model over the strict task model, as it can facilitate the migration of legacy content that does not follow the strict-task topic model. The general-task document type serves as the base for the strict-task and machine-industry-task document types. It also can be used to create new document types or specializations.

The purpose of the general task information type

Like the DITA strict task document type, the general task document and information types contain the essential building blocks to provide procedural information. Both task information types answer the "How do I?" question by providing step-by-step instructions that detail the requirements that must be fulfilled, the actions that must be performed, and the order in which the actions must be performed. Both task topics include sections for describing the context, prerequisites, expected results, and other aspects of a task.

The general task information type is specifically designed to accommodate task specializations that differ from the DITA task information type. It might also be used for the conversion of loosely structured tasks from other sources into DITA before they are restructured to follow the more restrictive DITA task model.

The structure of the general task topic

The task element is the top-level element for the general task topic. The general task topic contains a title and a taskbody with optional alternative titles (titlealts), a short description or abstract, a prolog, and related-links.

The following elements are described here because they are introduced as part of the general task model. All other elements are described in the strict task topic.

section
Represents an organizational division in a task topic. Sections organize subsets of information within the larger topic. Sections cannot be nested. A section can have an optional title.
steps-informal
Describes procedural task information that would not normally be ordered as steps, such as a group of general procedures that might all be applied in a particular situation. Instead of step, the steps-informal element uses ol and ul elements, which are less strictly defined than the step element. When converting legacy content, it might be simpler to convert numbered lists to ol elements than to step elements.

Comparison of general and strict task

The following table compares the structures of general and strict task:

General taskbody Strict taskbody constraint
prerequisite (optional, in any order, any number) prerequisite (optional, one only, must precede context)
context (optional, in any order, any number) context (optional, one only, must follow prerequisite)
section (optional, in any order, any number) (not defined for strict taskbody)
steps steps
steps-unordered steps-unordered
steps-informal (not defined for strict taskbody)
result (optional, one only, precedes example) result (optional, one only, precedes example)
example (optional, any number, precedes post-req) example (optional, one only, precedes post-req)
post-requisite (optional, any number) post-requisite (optional, one only)