Sémantique des étapes

Les étapes d'une procédure sont définies dans la rubrique de type task. Les rubriques de type task possèdent généralement une structure simple, composée d'un ensemble unique d'étapes. Certaines procédures peuvent cependant requérir une structure plus sophistiquée qui inclut des substeps et les points de décision.

Parmi les trois types d'information de base dans DITA, le type task est le plus clairement défini. En d'autres termes, le type d'information task possède les règles les plus strictes. Une tâche doit être constituée d'un ensemble unique d'étapes. Si vous pensez avoir besoin de plus d'un ensemble d'étapes, vous devez très certainement créer plus d'une rubrique task.

Dans la plupart des cas, un ensemble d'étapes est constitué d'un ou plusieurs éléments step, chacun comprenant un élément commande obligatoire (cmd), et un élément stepresult optionnel.

La syntaxe d'un ensemble typique d'étapes se présente comme suit : 
<steps>
  <step>
    <cmd>Tournez la clé vers la droite.<cmd>
    <stepresult>La lumière de l'appareil s'allume.</stepresult>
  </step>
  <step>
    <cmd>Appuyez sur le bouton <uicontrol>Démarrer</uicontrol>.</cmd>
  </step>
</steps>
Dans certains cas, la complexité d'un ensemble d'étapes requiert une structure plus complexe. Trois éléments plus sophistiqués peuvent être utilisés :
  • substeps
  • choices
  • choicetable

Les exemples sont souvent un bon moyen d'expliquer une tâche, et le type d'information task permet d'inclure un exemple (optionnel) d'une étape (stepxmp) après un élément cmd et un exemple général (optionnel) après le bloc steps.

Les informations explicatives en complément d'une commande peuvent être éventuellement ajoutées après cmd dans une étape grâce à l'élément info.

Avant le bloc steps, le contexte dans lequel une tâche est effectuée peut être décrit grâce à l'élément context. Si des pré-requis ou des pré-conditions pour une tâche doivent être effectués, ils peuvent être décrits dans l'élément prereq au-dessus du bloc steps.

Après le bloc steps, tout post-requis peut être décrit (à l'aide de l'élément postreq), et le résultat général des étapes d'une tâche peut s'écrire dans un élément result.

La structure générale d'une rubrique task est : 
<task>
 <shortdesc>...</shortdesc>
 <taskbody>
  <prereq>...</prereq>
  <context>...</context>
  <steps>
  ...
  </steps>
  <result>...</result>
  <example>...</example>
  <postreq>...</postreq>
 </taskbody>
</task>