Vorgehen beim Anpassen der DocBook-Stylesheets

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

In den letzten Abschnitten wurde gezeigt, wie Sie Änderungen in die Stylesheets einbringen, nicht jedoch der generelle Ablauf. Wie Sie bei einer Anpassung an die DocBook-Stylesheets generell vorgehen, beschreibt die folgende Anleitung:

1. Welche DocBook-Version?
   Stellen Sie zunächst sicher, in welcher DocBook-Version Sie schreiben. Wählen Sie Ihre Anpassungsdatei wie in Eine Anpassungsdatei für die DocBook-Stylesheets gezeigt.
2. Überprüfen der vorhandenen Parameter
   Überprüfen Sie, ob Ihr Problem durch die vorhandenen Parameter unter DocBook XSL Stylesheets: Reference Documentation zu lösen ist, bevor Sie Templates anpassen.
3. Kopieren vom Original
   Falls Parameter nicht weiterhelfen, identifizieren Sie zuerst das entsprechende Template. Möchten Sie beispielsweise das Element command anpassen, suchen Sie in den DocBook-Stylesheets danach und werden es in der Datei inline.xsl finden.
4. Einfügen der Änderungen
   Kopieren Sie das gefundene Template in Ihre Anpassungsdatei und ändern Sie es nach Ihren Wünschen.
5. Informieren Sie sich im DocBook XSL: The Complete Guide
   Falls Sie nicht weiterkommen, suchen Sie im Buch von Bob Stayton nach einer Lösung.
6. Testen Sie Ihre Anpassung
   Überprüfen Sie ob Ihr Template aufgerufen wird, indem Sie ein xsl:message mit einer Meldung ausgeben.

Wenn Sie die DocBook-Stylesheets anpassen, haben sich aus Sicht des Autors folgende Punkte bewährt:

• Verwenden Sie Parameter für "Konstanten": Die meisten Werte die Sie in Ihr Stylesheet eintragen wie Farbe, Schrift, Schriftstil sind mehr variabel als konstant. Führen Sie einen Parameter für diese Werte ein. Dadurch kann dieser über die Kommandozeile bei Bedarf angepasst werden. Des Weiteren erhöhen Sie die Konsistenz Ihres XSLT-Codes.
• Dokumentieren Sie Parameter: Eine ebenso alte wie dennoch aktuelle Empfehlung: Parameter sollten Sie in einem XML-Kommentar dokumentieren, ebenso die erlaubten Werte. Falls Sie eine Dokumentation Ihrer Anpassung benötigen, hilft Ihnen das so genannte "Literate Programming". Norman Walsh beschreibt diese Technik. Die DocBook-Stylesheets sind auf diese Art dokumentiert.
• Verwenden Sie Attributmengen: Die DocBook-Stylesheets nutzen Attributmengen, um Attribute unter einem Begriff zusammenzufassen. Besonders bei XSL-FO mit seiner Vielzahl an Attributen, ermöglicht diese Methode eine konsistente Schreibweise. Nutzen Sie aus diesem Grund ebenfalls Attributmengen, sowohl um vorhandene zu überschreiben oder zu erweitern, als auch für Ihre eigenen Attribute.
• Limitieren Sie xsl:for-each: Verwenden Sie xsl:for-each für die Fälle, für die es ein sehr strenges Inhaltsmodell gibt (wie simplelist). In den meisten Fällen ist es vorteilhafter, wenn Sie xsl:apply-templates verwenden.
• Modularisieren Sie Ihre Anpassungsdatei: Umfangreiche Anpassungen profitieren, wenn Sie Ihre Anpassungsdatei auf verschiedene Stylesheets aufteilen. Im Hauptstylesheet fügen Sie diese über xsl:include ein. Empfehlenswert ist es, die Dateien so zu benennen, wie die Original-Stylesheets. Sie erhöhen die Übersichtlichkeit und sehen sofort, in welchen Dateien Sie Anpassungen vorgenommen haben.

  

<< zurück

vor >>