Aufgaben

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

Falls eine Handlungsanweisung (procedure) zu wenig Auszeichnungsmöglichkeiten bietet, gibt es seit DocBook 4.3 das umfangreichere task-Element mit der Sie Aufgaben auszeichnen.

Eine Aufgabe im Sinne von DocBook enthält nicht nur Handlungsanweisungen, sondern eine Zusammenfassung, Vorbedingungen und aufgabenbezogene Informationen. Im folgenden Beispiel wird eine Aufgabe gezeigt über die Kunst des Teekochens.

Beispiel: Eine Aufgabenbeschreibung

<task>
   <title>Wie Sie guten Tee kochen</title>
   <tasksummary>
        <para>In dieser Aufgabe werden wir untersuchen, welche Komponenten für einen guten Tee benötigt werden.</para>
   </tasksummary>
   <taskprerequisites>
      <title>Vorausetzungen</title>
      <para>...</para>
      <itemizedlist>
        <listitem>
          <para>Ein guter Tee.</para>
        </listitem>
        <listitem>
          <para>Ein Teesieb.</para>
        </listitem>
        <listitem>
          <para>Eine Teekanne mit Teegläser.</para>
        </listitem>
        <listitem>
          <para>Falls gewünscht, Teezucker</para>
        </listitem>
      </itemizedlist>
   </taskprerequisites>
   <procedure>
      <title>Tee kochen</title>
      <step>
        <para>Wählen Sie einen Tee aus</para>
      </step>
      <step>
        <para>Fügen Sie pro Tasse einen Teelöffel Tee in das Teesieb.</para>
      </step>
      <step>
        <para>Kochen Sie Wasser bis zum Siedepunkt. Wenn Sie grünen Tee zubereiten, lassen Sie das Wasser nach dem Sieden ca. 3 bis 5 Minuten abkühlen.</para>
      </step>
      <step>
        <para>Wärmen Sie die Teekanne mit etwas kochendem Wasser vorher an.</para>
      </step>
      <step>
        <para>Stellen Sie das Teesieb in Ihre Teekanne und übergießen Sie mit kochendem Wasser.</para>
      </step>
      <step>
        <para>Lassen Sie den Tee ziehen. Je nach Teesorte und Intensität kann dies zwischen 3 bis 10 Minuten betragen.</para>
      </step>
   </procedure>
   <taskrelated>
     <title>Siehe auch</title>
     <para>Weitere Informationen erhalten Sie in folgender Liste:</para>
     <itemizedlist>...</itemizedlist>
   </taskrelated>
</task>

Zeile 1: Jede Aufgabe beginnt mit task.
Zeile 3: Eine optionale Zusammenfassung der Aufgabe.
Zeile 6: Optionale Voraussetzungen für diese Aufgabe.
Zeile 24: Die Handlungsanweisung(en) für die Erfüllung der Aufgabe.
Zeile 45: Optionale Informationen, die mit der Aufgabe in Beziehung stehen.

Ein ähnliches Ergebnis können Sie auch mit Abschnitten erreichen. Manchmal ist es jedoch praktisch zwischen scheinbar unzusammenhängenden Abschnitten und einem task-Element zu unterscheiden. Für diesen Zweck gibt es task, dass alle entsprechenden Informationen unter einem Element vereint.

Zukünftige DocBook 5-Versionen erlauben vermutlich das task-Element auf derselben Ebene wie ein Abschnittselement. Klären Sie diesen Sachverhalt in der DocBook-Referenz.

  

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

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