Montrer des exemples et résultats

Une étape peut comprendre un exemple de comment elle est réalisée et du texte concernant le résultat obtenu lorsque les étapes ont été complétées avec succès.

  • Utilisez <stepxmp> (step example) pour montrer un exemple de réalisation de l’étape. Une étape peut contenir un nombre illimité d’éléments <stepxmp>.

  • Utilisez <stepresult> pour décrire le résultat de l’étape.

Remarque : L’élément <stepxmp> montre un exemple pour l’étape en cours ; pour montrer un exemple pour l’ensemble de la tâche, utilisez l’élément <example> qui sera présenté dans la prochaine leçon.

Vidéo : Ajouter un exemple d’étape à une tâche DITA

Pratique
  1. Continuez de travailler sur le fichier l_tache_debut.dita.
  2. Après la balise de fermeture du dernier élément <step>, créez un nouvel élément <step>, contenant un élément <cmd> et le texte présenté ici :
    ...<step><cmd>Lorsque vous avez identifié un canard, écrivez une note dans votre guide.</cmd>
    </step>...

  3. Après l’élément <cmd>, ajoutez un élément <stepxmp>.
    ...<step><cmd>Lorsque vous avez identifié un canard, écrivez une note dans votre guide.</cmd>
       <stepxmp>
       </stepxmp> 
    </step>...

    L’élément <stepxmp> contient un exemple qui illustre ou clarifie l’étape.
    L’élément <stepxmp> peut contenir les éléments que vous pouvez utilisez dans un élément <li>. Pour présenter des exemples où les sauts de lignes et les espaces sont importants, vous pouvez utiliser l’élément <pre> ou l’élément <codeblock>.
  4. À l’intérieur de l’élément <stepxmp>, ajoutez un élément <p>, puis insérez un élément <image> à l’intérieur de l’élément <p>.
    ...<step><cmd>Lorsque vous avez identifié un canard, écrivez une note dans votre guide.</cmd>
       <stepxmp>
          <p><image href="checklist.png"/></p>
    
       </stepxmp>
    </step>...

    Remarque : Le fichier checklist.png est dans les fichiers exemple, dans le dossier leçon2.

L’élément <stepresult> décrit le résultat de l’exécution réussie de l’étape.

L’élément <stepresult> doit être le dernier élément dans un élément <step> ; aucun autre élément ne peut venir après lui.

  1. Après la balise de fermeture de l’élément <stepxmp>, ajoutez un élément <stepresult>.
    ...
       </stepxmp>
       <stepresult>
       </stepresult>
    </step>
    ...

  2. À l’intérieur de l’élément <stepresult>, ajoutez un élément <p> et ajoutez-y du contenu tel que présenté ici :
    ...
       </stepxmp>
       <stepresult>
    <p>Vous aurez désormais une trace que vous pourrez conserver pour le reste de votre vie.</p>
       </stepresult>
    </step>
    ...

Contributeurs