Les éléments de base impliqués dans la création d’un ensemble d’étapes comprennent les éléments <setps>, <step>, <cmd> et <info>.
|
<steps>
|
Une série d’instructions pas-à-pas. L’élément <steps> peut contenir un ou plusieurs éléments <step>.
|
|
<step>
|
Une seule étapes. L’étape doit contenir un élément <cmd>. L’élément <step> peut aussi contenir l’élément <info> et des éléments supplémentaires qui fournissent de l’information concernant l’étape (ils sont décrits plus loin dans ce cours).
|
|
<cmd>
|
Une commande. Le texte de l’élément <cmd> doit être à la voix active et devrait contenir une seule phrase.
|
|
<info>
|
Information supplémentaire concernant l’étape.
|
Vidéo : Ajouter des étapes à une tâche DITA
Pratique
- Continuez de travailler sur le fichier l_tache_debut.dita.
- Après la balise de fermeture de l’élément <context>, ajoutez un élément <steps>.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<task id="my_first_task">
...
</context>
<steps>
</steps>
</taskbody>
</task>
Comme avec les éléments <prereq> et <context>, l’élément <taskbody> ne peut contenir qu’un élément <steps>. Vous restreindre à un seul élément <steps> vous assure que la rubrique décrit uniquement comment réaliser une tâche.
- À l’intérieur de l’élément <steps>, ajoutez un élément <step>.
...
<steps>
<step>
</step>
</steps>
...
L’élément <steps> doit contenir au moins un élément <step>. La plupart des éditeurs DITA ajoutent le premier élément <step> à l’intérieur de l’élément <steps> (et généralement un élément <cmd> imbriqué dans l’élément <step>).
Avec DITA, le contenu de chaque étape individuelle est aussi hautement controllé ; chaque étape a un ensemble spécifique d’éléments, qui doit apparaître dans un ordre spécifique. L’action que le lecteur doit réaliser est contenue dans un élément <cmd> (lu comme « commande »), qui est un élément requis dans <step>. Dans la plupart des cas, <cmd> contient une simple phrase, qui est une instruction directe faite au lecteur pour réaliser une action.
- À l’intérieur de l’élément <step>, ajoutez un élément <cmd> avec le texte présenté ici.
...
<steps>
<step>
<cmd>Sélectionnez un emplacement pour observer les canards.</cmd>
</step>
</steps>
...
Comme meilleure pratique, l’élément <cmd> devrait être limité à une simple phrase, à la voix active, qui dirige le lecteur dans l’action à réaliser. Pour fournir des informations supplémentaires à propos du contenu de l’élément <cmd>, utilisez l’élément <info>.
Pour fournir une information supplémentaire au sujet de l’instruction contenue dans l’élément <cmd>, utilisez l’élément <info>. Vous pouvez utilisez autant d’éléments <info> que nécessaire après l’élément <cmd> et avant l’élément <stepresult>.
- Après l’élément <cmd>, ajoutez un élément <info> avec le texte indiqué ici.
...
<steps>
<step>
<cmd>Sélectionnez un emplacement pour observer les canards.</cmd>
<info><p>En général, vous trouverez des canards dans des endroits sauvages, près de l'eau.</p></info>
</step>
</steps>
...
L’élément <info> peut contenir du texte, des notes, des images, des tableaux, etc. Comme pour les autres éléments pouvant contenir du contenu mixte, les meilleures pratiques vous imposent d’utiliser un élément <p> pour encadrer le texte, même si l’élément <info> ne contient qu’un paragraphe.
Les autres rubriques de cette leçon introduisent des éléments supplémentaires que vous pouvez utiliser pour documenter l’étape.
Contributeurs
