Das Element task beschreibt eine Handlungsanweisung oder Prozedur. Da es sehr komplex ist, wird dafür eine separate section in diesem Buch reserviert.
Ein gut ausgefüllter Task mit jeweils nur einem Kindelement ist im folgenden als XML Schnippsel dargestellt. Natürlich sind in den Elementen an bestimmten Stellen noch weitere Blockelemente erlaubt, wie Warnhinweise, Listen, Tabellen, etc.
<task> <title>Ein Task</title> <abstract> <p>Abstract-Element in Task</p> </abstract> <taskbody> <prereq> <p>Prereq-Element in Task</p> </prereq> <context> <p>Context-Element in Task</p> </context> <steps> <stepsection> <p>Stepsection-Element in Task</p> </stepsection> <step> <cmd>Cmd-Element in Step</cmd> <substeps> <substep> <cmd>Substep-Element in Step</cmd> <info> <p>Info-Element in Substep</p> </info> <stepresult> <p>Stepresult-Element in Substep</p> </stepresult> </substep> </substeps> <choices> <choice> <p>Choice-Element in Step</p> </choice> <choice> <p>Zweites Choice-Element in Step</p> </choice> </choices> <choicetable> <chhead> <choptionhd> <p>Choicetable mit leeren Zellen in Step</p> </choptionhd> <chdeschd/> </chhead> <chrow> <choption/> <chdesc/> </chrow> </choicetable> <info> <p>Info-Element in Step</p> </info> <stepresult> <p>Stepresult-Element in Step</p> </stepresult> </step> </steps> <result> <p>Result-Element in Task</p> </result> <postreq> <p>Postreq-Element in task</p> </postreq> </taskbody> </task>Plain Text
Aus diesem XML Schnippsel kann man sich leicht die zugrundeliegende Grammatik als Grafik erzeugen lassen, z.B. mit dem oXygen XML Editor. (Da es sich um eine SVG Grafik handelt, sollte man auf einem Rechner verlustfrei reinzoomen können)
DITA <abstract> DITA <taskbody> DITA <prereq> DITA <context> DITA <steps> DITA <step> DITA <substeps> DITA <cmd> DITA <info> DITA <stepresult> DITA <choices> DITA <choicetable> DITA <choption> DITA <chdesc> DITA <result> DITA <postreq>
| Buchwelt | DITA |
| Einleitung |
Das <abstract> Element kann weitere Blockelemente beinhalten und dient zur initialen Beschreibung der Handlungsanweisung, Prozesses oder der Prozedur (Ich hoffe, dass ich alle in diesem Kontext relevanten Synonyme aufgezählt habe) |
| Vorbedingung |
Im Rumpf der Task taskbody können Vorbedingungen angegeben werden, die erfüllt sein müssen bevor die Handlungsanweisung ausgeführt werden kann. In diesem prereq Element sind wieder weitere Blockelemente, wie Listen und Tabellen erlaubt. Natürlich sollte in der Ausgabe dieser Abschnitt irgendwie gekennzeichnet sein - so wie auch alle anderen Elemente - um diesen vom Fließtext zu unterscheiden. |
| Kontext |
Im <context> Element wird beschrieben in welchem Kontext (Umgebung, Zweck und Nutzen) die Handlungsprozedur ausgeführt werden soll. Hier sind auch wieder viele Blockelemente erlaubt. |
| Inhalt der Arbeitsschritte |
Schlussendlich hat man auch noch im <steps> Element die Möglichkeit weiteren Kapitelinhalt einzugeben - über das <stepsection> Element. |
| Arbeitsschritt |
Das <step> Element selbst hat im einfachsten Fall ein <substeps> Element, so dass eine einfache verschachtelte nummerierte Liste abgebildet werden kann. <step> <cmd>Cmd-Element in Step</cmd> <substeps> <substep> <cmd>Substep-Element in Step</cmd> <info> <p>Info-Element in Substep</p> </info> <stepresult> <p>Stepresult-Element in Substep</p> </stepresult> </substep> </substeps> [...]Plain Text Im <cmd> Element steht dabei die auszuführende Aktion, während andere Elemente die Aktion weiter präzisieren. Besonders interessant ist dabei, dass z.B. Warnhinweise ( <hazardstatement> ) immer vor dem <cmd> Element bedatet werden müssen. Im <info> Element können zusätzliche Informationen stehen. Der <stepresult> dokumentiert schließlich das Ergebnis des Arbeitsschritts. |
| Auswahl der Aktionen |
Hat der Ausführende des Handlungsschritts mehrere Optionen für die Aktion, dann kann das mittels des Elements <choices> modelliert werden. Statt einer Liste steht auch eine tabellarische Darstellung ( <choicetable> ) zur Verfügung, die neben der Aktion ( <choption> ) auch noch eine Beschreibung ( <chdesc> ) derselben erlaubt. <choices> <choice> <p>Choice-Element in Step</p> </choice> <choice> <p>Zweites Choice-Element in Step</p> </choice> </choices> <choicetable> <chhead> <choptionhd> <p>Choicetable mit leeren Zellen in Step</p> </choptionhd> <chdeschd/> </chhead> <chrow> <choption/> <chdesc/> </chrow> </choicetable>Plain Text |
| Ergebnis der Handlungsanweisung |
Werden alle Arbeitsschritte ausgeführt, dann sollte ein Ergebnis ( <result> ) dokumentiert werden. Diese Ergebnis-Elemente stehen auch im <step> und <substep> Element als <stepresult> Element zur Verfügung. |
| Nachbedingung |
Analog zur Vorbedingung der Task kann auch eine Nachbedingung über das Element <postreq> dokumentiert werden. |