XML-Technologien / DocBook / Block-Elemente / Handlungsanweisungen

Handlungsanweisungen

(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)

Das Element procedure ist eine Handlungsanweisung und wird verwendet, wenn der Leser Vorgänge in einer bestimmten Reihenfolge ausführen soll. Eine Handlungsanweisung besteht aus Schritten (step) und Unterschritten (substeps), falls erforderlich. Alternative Anweisungen zeichnen Sie mit stepalternatives aus.

Damit eine Handlungsanweisung abgearbeitet werden kann, müssen häufig bestimmte Vorbedingungen erfüllt sein. DocBook bietet kein explizites Markup hierfür an; in einem solchen Fall müssen diese Bedingungen in die Schritte mit aufgenommen werden oder Sie verwenden task (siehe Aufgaben).

Beispiel: Eine Handlungsanweisung

<procedure>
 <title>Eine imaginäre Aufgabe</title>
 <step>
   <para>Der erste Schritt.</para>
   <substeps>
     <step><para>Der erste Unterschritt.</para></step>
     <step><para>Der zweite Unterschritt.</para></step>
   </substeps>
 </step>
 <step performance="optional">
   <para>Der zweite Schritt.</para>
 </step>
</procedure>

Zeile 2: optionaler Titel
Zeile 4: Ein Schritt zur Lösung der Anweisung
Zeile 5: Wird eine feinere Aufteilung benötigt, gibt es substeps.
Zeile 10: kennzeichnet, ob ein Schritt zwingend notwendig (required) oder optional ist (optional)

Hinweis: Verwenden Sie möglichst weniger als 10 Schritte
Obwohl DocBook keine Begrenzungen hinsichtlich der Anzahl der Schritte auferlegt, ist es empfehlenswert sich auf maximal 10 Schritte zu beschränken. Die Handlungsanweisung wird sonst zu unübersichtlich. Benötigen Sie dennoch mehr, sollten Sie Ihre Schritte überdenken und entweder mit substeps strukturieren oder in Abschnitte auslagern.

<< zurück

vor >>

Tipp der data2type-Redaktion:
Zum Thema DocBook bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

DITA
XSLT

Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de