DITA Task topic task -//OASIS//ELEMENTS DITA Task//EN -//OASIS//ENTITIES DITA Task//EN urn:oasis:names:tc:dita:rng:taskMod.rng
ELEMENT TYPE NAME PATTERNS
COMMON ATTRIBUTE SETS Provide an alternative set of univ-atts that allows importance to be redefined locally new changed deleted unchanged -dita-use-conref-target
TOPIC NESTING OVERRIDES
COMMON CONTENT MODEL PATTERNS
ELEMENT TYPE DECLARATIONS
LONG NAME: Task element is the top-level element for a task topic. Tasks are the main building blocks for task-oriented user assistance. They generally provide step-by-step instructions that will enable a user to perform a task. A task answers the question of "how to?" by telling the user precisely what to do and the order in which to do it. Tasks have the same high-level structure as other topics, with a title, short description and body. Category: Task elements ]]>
LONG NAME: Task Body element is the main body-level element inside a task topic. A task body has a very specific structure, with the following elements in this order: , , , , and . Each of the body sections are optional. Category: Task elements ]]>
LONG NAME: Prerequisites ) section of a task should document things the user needs to know or do before starting the current task. Prerequisite links will be placed in a list after the related-links section; on output the links from the related-links section are added to the section. Category: Task elements ]]>
LONG NAME: Context section of a task provides background information for the task. This information helps the user understand what the PURPOSE of the task is and what they will gain by completing the task. This section should be brief and does not replace or recreate a concept topic on the same subject, although the context section may include some conceptual information. Category: Task elements ]]>
LONG NAME: Informal Steps element allows authors to describe procedural task information that would not normally be described as steps. ]]>
LONG NAME: Steps section of a task provides the main content of the task topic. The task is described as a series of steps that the user must follow to accomplish the task. One or more elements is required inside the section. Category: Task elements ]]>
LONG NAME: Steps: Unordered element, the section of a task provides the main content of the task topic, but particularly for cases in which the order of steps may vary from one situation to another. One or more steps is required inside the section. Category: Task elements ]]>
LONG NAME: Step section element provides expository text before a step element. Although the element is specialized from
  • and has the same content model as a list item, this is not considered a step, and rendering engines may choose to skip this element when numbering steps. ]]>
    • LONG NAME: Step optional required -dita-use-conref-target element represents an action that a user must follow to accomplish a task. Each step in a task must contain a command element which describes the particular action the user must do to accomplish the overall task. The step element can also contain information , steps or unordered steps , tutorial information , a step example , choices or a stepresult , although these are optional. Category: Task elements ]]>
    LONG NAME: Command ) element is required as the first element inside a . It provides the active voice instruction to the user for completing the step, and should not be more than one sentence. If the step needs additional explanation, this can follow the element inside an element. Category: Task elements ]]>
    LONG NAME: Information ) occurs inside a element to provide additional information about the step. Category: Task elements ]]>
    LONG NAME: Tutorial Information ) element contains additional information that is useful when the task is part of a tutorial. Category: Task elements ]]>
    LONG NAME: Step Example ) element is used to illustrate a step of a task. The example can be a couple of words, or an entire paragraph. Category: Task elements ]]>
    LONG NAME: Choices element contains a list of elements. It is used when the user will need to choose one of several actions while performing the steps of a task. Category: Task elements ]]>
    LONG NAME: Choice element describes one way that the user could accomplish the current step. Category: Task elements ]]>
    LONG NAME: Choice Table element contains a series of optional choices available within a step of a task. Category: Task elements ]]>
    LONG NAME: Choice Head element is a container inside the element that provides specific heading text to override the default Options and Description headings. The element contains both a and element as a pair. Category: Task elements ]]>
    LONG NAME: Choice Option Head element provides a specific label for the list of options that a user chooses from to accomplish a step. The default label for options is Option. Category: Task elements ]]>
    LONG NAME: Choice Description Head option provides a specific label for the list of descriptions of options that a user must choose to accomplish a step of a task. The default label overridden by is Description. Category: Task elements ]]>
    LONG NAME: Choice Row element is a container inside the element. The element contains both a and element as a pair. Category: Task elements ]]>
    LONG NAME: Choice Option element describes an option that a user could choose to accomplish a step of a task. In a user interface, for example, this might be the name of radio button. Category: Task elements ]]>
    LONG NAME: Choice Description element is a description of an option that a user chooses while performing a step to accomplish a task. It explains why the user would choose that option, and might explain the result of the choice when it is not immediately obvious. Category: Task elements ]]>
    LONG NAME: Step Result element provides information on the expected outcome of a step. If a user interface is being documented, the outcome could describe a dialog box opening, or the appearance of a progress indicator. Step results are useful to assure a user that they are on track, but should not be used for every step, as this quickly becomes tedious. Category: Task elements ]]>
    LONG NAME: Step Troubleshooting
    LONG NAME: Task Troubleshooting
    LONG NAME: Result element describes the expected outcome for the task as a whole. Category: Task elements ]]>
    LONG NAME: Post Requirements element describes steps or tasks that the user should do after the successful completion of the current task. It is often supported by links to the next task or tasks in the section. Category: Task elements ]]>
    SPECIALIZATION ATTRIBUTE DECLARATIONS