5.22. stepresult

L'élément <stepresult> fournit des informations à propos du résultat prévu d'une étape. Si on documentait une interface utilisateur, le résultat pourrait décrire une boîte de dialogue qui s'ouvre, ou l'aspect d'un indicateur de progression. Les résultats d'étape sont utiles pour indique à un utilisateur qu'il est sur la bonne voie, mais ne devraient pas être employés pour toutes les étapes, car cela deviendrait rapidement fastidieux.

Exemple

<steps>
 <step>
  <cmd importance="urgent">Once you have the water place it in the microwave.</cmd>
  <info>Try not to spill any, as water is very wet.</info>
 </step>
 <step importance="required">
  <cmd>Start the Microwave.</cmd>
  <stepxmp>As an example, push the <b>Start</b> button</stepxmp>
  <stepresult>The Microwave starts running. You should hear it humming.</stepresult>
 </step>
 <step importance="optional">
  <cmd>Once the water begins to boil, stop the Microwave.</cmd>
 </step>
</steps>

Contient :

Doctype Modèle de contenu
ditabase, task ( données textuelles ou ph ou codeph ou synph ou filepath ou msgph ou userinput ou systemoutput ou b ou u ou i ou tt ou sup ou sub ou uicontrol ou menucascade ou term ou xref ou cite ou q ou boolean ou state ou keyword ou option ou parmname ou apiname ou cmdname ou msgnum ou varname ou wintitle ou tm ou p ou lq ou note ou dl ou parml ou ul ou ol ou sl ou pre ou codeblock ou msgblock ou screen ou lines ou fig ou syntaxdiagram ou imagemap ou image ou object ou table ou simpletable ou draft-comment ou required-cleanup ou fn ou indextermref ou indexterm ou data ou data-about ou foreign ou unknown) (un nombre quelconque)

Contenu par :

Doctype Parents
ditabase, task step, substep

Héritage :

- topic/itemgroup task/stepresult

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) Un ensemble d'attributs liés, décrit à la section 25.7. %univ-atts; entité paramètre sans objet pour une entité paramètre sans objet
%global-atts; (xtrf, xtrc) Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts; entité paramètre sans objet pour une entité paramètre sans objet
class, outputclass Attributs communs, décrit à la section 25.9. Autres attributs DITA communs