Markierungspunkte direkt im Inhalt

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

Die einfachste und schnellste Form um Inhalt zu kommentieren, sind Markierungspunkte in den Text einzufügen:

Beispiel: Einfügen von Markierungspunkten

<programlisting language="python2">#!/usr/bin/python -u
import sys
import string
import commands <co ANKER="co.commands"/>

cmd = ["file", sys.argv[1], "| cut -d',' -f2" ] <co ANKER="co.cmd"/>
cmd = string.join(cmd) <co ANKER="co.join"/>

(res, out) = commands.getstatusoutput(cmd) <co ANKER="co.run"/>

print res, out
</programlisting>

Ersetzen Sie den Platzhalter ANKER durch id in DocBook 4 und xml:id in DocBook 5.

Um die markierten Stellen zu beschreiben, verwenden Sie eine Callout-Liste (Markierungslisten (calloutlist)). Jede Liste enthält das Element callout, das in seinem Attribut arearefs auf einen oder mehrere Markierungspunkte verweist:

Beispiel: Referenzieren auf die Markierungspunkte

<calloutlist>
   <callout arearefs="co.commands">
      <para>Importiert </para>
   </callout>
   <callout arearefs="co.cmd co.join">
      <para>...</para>
   </callout> 
   ... 
</calloutlist>

Diese Methode ist nur praktikabel, wenn Inhalt und Markierungspunkte zusammen sind. Sobald der Inhalt in einer externen Datei liegt, kann sie nicht mehr angewendet werden. In diesem Fall müssen Sie auf die indirekte Methode ausweichen (siehe nächste Seite).

  

<< 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