Überlegungen vor der Anpassung

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

Bevor Sie DocBook an Ihre Wünsche anpassen, sollten Sie sich zuvor über einige Dinge eine Meinung bilden:

  • Welche DocBook-Version? Eine pauschale Aussage kann nicht getroffen werden und ist vom jeweiligen Autor und dessen Vorbedingungen und Zielsetzungen abhängig. Einige Vorteile der neueren Version sind in Unterschiede zwischen DocBook 4 und 5 angegeben. Haben Sie Programme, die nur DocBook 4 unterstützen, ist es besser, bei dieser Version zu bleiben. Möchten Sie DocBook an eigene Bedürfnisse anpassen oder die Vorteile der neuen Version nutzen, ist DocBook 5 möglicherweise die bessere Wahl.
  • Aufwandsabschätzung Die folgende Liste beschreibt den Aufwand einer jeden Anpassung. Schreiben Sie diese so, dass sie sich von anderen ebenso einfach wie DocBook anpassen lässt. Die folgende Liste ist sortiert nach Schwierigkeitsgrad, beginnend mit dem einfachsten:
    Keine Anpassung
    Dies ist die einfachste und bequemste Art. Falls Sie dennoch "neue Elemente" benötigen, ohne DocBook anzupassen, ist die einzige Möglichkeit, eines der allgemeinen DocBook-Attribute zu nutzen, wie role oder condition. Hierdurch erhält das Element eine zusätzliche Eigenschaft, die sich über XSLT entsprechend von gleichen Elementen ohne Attribut unterscheiden lassen.

    Entfernen von Elementen oder Attributen
    Die "schonendste" Anpassung, da Sie nur eine Untermenge von DocBook erstellen und somit kompatibel bleiben. Stylesheet-Änderungen sind nicht erforderlich. Der Vorteil beim Entfernen besteht darin, dass Sie bei Bedarf immer auf das Original DocBook-Schema wechseln können, falls Sie die Anpassung nicht zur Hand haben.

    Einfügen neuer Element oder Attribute
    Neue Elemente in DocBook führen zu einer Erweiterung und sind damit inkompatibel zum Ursprungsschema. Des Weiteren führen neue Elemente zwangsläufig zu einer Stylesheet-Anpassung, egal ob sie transformiert oder unterdrückt werden.

    Einfügen eines Schema in DocBook
    Ein anderes Schema in DocBook zu integrieren, ist prinzipiell nichts anderes als neue Elemente und Attribute einzufügen. Die Herausforderung besteht darin, die Stellen in DocBook zu finden, mit denen das neue Schema verbunden wird.
  • Weniger Elemente? Überprüfen Sie, ob Simplified DocBook für Sie eine Alternative ist. Es enthält nur einen Bruchteil des vollständigen Schema.
  • Einschränken von Attributen Für manche Attribute ist es praktisch, nur bestimmte Attributwerte zuzulassen. Wenn Sie beispielsweise nur für zwei Sprachen schreiben, könnten Sie nur diese erlauben.

Anmerkung: Eine DocBook-Anpassung ist nur die halbe Arbeit
Die Anpassung von DocBook ist nur die halbe Arbeit: Wenn Sie DocBook um neue Elemente erweitern, werden die DocBook-Stylesheets diese nicht erkennen. Aus diesem Grund müssen Sie bei neuen Elementen eine Anpassungsdatei für die DocBook-Stylesheets schreiben, da Sie ansonsten eine Fehlermeldung erhalten. Entfernen Sie Elemente, brauchen Sie keine Stylesheet-Anpassung.

Was sind die Vor- und Nachteile, wenn Sie DocBook anpassen? Hier eine kurze Zusammenstellung:

Vorteile einer Anpassung

  • DocBook lässt sich an eigene Wünsche anpassen.
  • Inhaltsmodelle lassen sich vereinfachen, so dass Anwender nicht mit einer unüberschaubaren Vielfalt konfrontiert werden.
  • Attribute lassen sich durch eine Anpassung mit einer Auswahl an sinnvollen Werten vorbelegen. Des Weiteren lassen sich Vorgabewerte festlegen.
  • Durch eine Anpassung lassen sich verschiedene Szenarien testen oder neue Ideen integrieren, die erst in zukünftigen Versionen eingefügt werden.

Nachteile einer Anpassung

  • Durch eine Anpassung haben Sie nicht mehr Original-DocBook. Programme, die ein Dokument auf Basis von DocBook erwarten, können dadurch verwirrt werden.
  • Neue Elemente benötigen eine Stylesheet-Anpassung.
  • Eine Anpassung ist an eine bestimmte DocBook-Version gekoppelt. Neuerungen oder Fehlerkorrekturen werden somit nicht zwangsläufig übernommen, sondern müssen erst "freigeschaltet" werden.
  • Beim Austausch von Dokumenten, muss immer die Anpassungsdatei mitgeliefert werden. Bei einem Dokument auf Basis des Original-DocBook-Schema ist es wahrscheinlicher, das der Empfänger dieses Schema bereits besitzt.

  

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