DocBook XML Schreibwerkzeuge

Text-Editoren
XML-Editoren

Text-Editoren

Da DocBook ein nicht-binäres Format ist, können Sie reine Texteditoren wie emacs, pico, Windows Notepad oder vi zum Schreiben nutzen. Und in der Tat machen einige genau das, weil sie hiermit volle Kontrolle über ihren Text haben und die handgeschriebenen Tags jederzeit sichtbar sind. Auf der anderen Seite können diese Text-Editoren keine Validierung Ihres DocBook-Dokuments durchführen: Sie bemerken Ihre Fehler erst während des Erstellvorgangs. Und die Struktur eines Dokuments - insbesondere große Dokumente - ist ebenfalls schwer im Textmodus zu analysieren. Etwas Abhilfe schafft hier die Einrückung mehrerer Ebenen.

Wenn Sie diesen Weg einschlagen wollen oder zumindest ausprobieren möchten, dann ist es eine gute Idee einen Editor zu wählen, der zumindest XML Syntax-Highlighting unterstützt. Ein guter Editor, der auch noch frei verfügbar ist, ist ConText, zu finden unter http://www.fixedsys.com/context/. Unglücklicherweise kann ConText nicht im UTF-8-Format speichern. Für US-ASCII-Dokumente stellt dies kein Problem dar (speichern Sie den Text als DOS oder Unix und alles ist gut), aber sobald Sie irgendwas oberhalb von ASCII 127 verwenden, wird ConText so gut wie nutzlos. Eine gute, freie Alternative ist SciTE unter http://scintilla.sourceforge.net/SciTEDownload.html. Es ist weniger intuitiv, aber sehr mächtig.

Warnung

Speichern Sie Dokumente, die keinen US-ASCII-Inhalt besitzen, niemals in 8 Bit, weder in ConText noch einem anderen Editor! Alles was über US ASCII hinaus geht, muss in einer Unicode-Kodierung, wie UTF-8 (für die meisten Sprachen) oder UTF-16 (für einige Sprachen, falls die UTF-16-Dateilänge geringer oder zumindest nicht viel größer als UTF-8 ist), gespeichert werden. Die Kodierungsprobleme stellen weitere gute Gründe dar, einen XML-Editor zu nutzen: Sie werden die Daten normalerweise automatisch in der korrekten Codierung speichern.

XML-Editoren

Dedizierte XML-Editoren haben häufig grafische Benutzeroberflächen, die Tags schön (und manchmal irritierend) hervorheben; viele erlauben es Ihnen die Elemente ein- und auszuklappen, so dass Sie die Struktur Ihres Dokumentes sehen und gleichzeitig in das aktuelle Element hineinzoomen können. Die meisten können Ihr Dokument gegen das DocBook DTD validieren und einige haben einen speziellen DocBook-Bearbeitungsmodus, der es Ihnen ermöglicht, fast wie in einer Textverarbeitung zu schreiben.

Der Autor dieser Anleitung hat einige der Werkzeuge ausprobiert (freie, günstige und Evaluierungsversionen) und empfand XMLMind XML Editor als am nützlichsten. Das ist eine persönliche Einschätzung; Ihre Erfahrung kann natürlich ganz anders aussehen.

Einige XML-Editoren die Sie versuchen sollten:

XMLMind XML Editor, kurz XXE. Die Standard-Edition ist kostenfrei.

http://www.xmlmind.com/xmleditor/

Läuft unter: Linux, Windows, Mac OS X. Benötigt Java, aber Sie benötigen Java eh, da Sie die Dokumente sonst nicht aus den Quellen erstellen können – mehr unter Firebird Docbuilding Howto.

Features: Baumansicht (alle Elemente einklappbar) und gestylte Ansichten (Kapitel und Bereiche klappbar). Ich arbeite normalerweise mit letzterem: Die Ansicht zeigt das Dokument in grundlegendem, aber klarem Textverarbeitungsähnlichen Layout, das in einem Stylesheet definiert ist, dass mit der Anwendung ausgeliefert wird. Beide Ansichten können gleichzeitig aktiviert werden. Der DocBook-Modus lässt Sie nur DocBook-Anweisungen einfügen. Element-Wähler. Attribut-Editor. Suchen und ersetzen. Rechtschreibprüfung. Sonderzeichenauswahl. Schnellzugriffsfunktionen um häufig verwendete Elemente, wie sections, lists, tables, etc., aufzurufen. Was ich vermisse ist eine Klartextansicht des XML-Quellcodes.
Oxygen XML Editor. $ 48 für nichtkommerzielle Zwecke. Freie 30-Tage-Testversion.

http://www.oxygenxml.com

Läuft unter: Windows, Mac OS X, Linux, Eclipse. Benötigt Java.

Features: XML-Quellcode-Editor. Baumansicht. Attribut-Editor. Gliederungsbereich. Tooltips für DocBook-Tags. XSLT-Debugger (ein leistungsfähiges Tool, irrelevant für das Schreiben, aber großartig, wenn Sie mit unseren Transformations-Stylesheets arbeiten wollen). Validierung, Refactoring, Rechtschreibprüfung, etc.. Ein sehr guter XML-Editor.
epcEdit. € 89 für nichtkommerzielle Nutzung. 60-Tage Probierversion.

http://www.epcedit.com

Läuft unter: Linux, Windows, Solaris. Benötigt Tcl/Tk 8.1 oder höher (im Paket enthalten).

Features: Struktur-Baumansicht. Element-Wähler. Attributeditor. Documentbereich kann zwischen Klartext und grafischen XML-Modus umschalten. Kein spezieller DocBook-Modus, kann aber jedes XML-Dokument validieren, dass auf DTD basiert.
Altova XMLSpy. The Home Edition ist mittlerweile frei.

http://www.altova.com/products_ide.html

Läuft unter: Windows, Eclipse. (Läuft angeblich auch mit Wine unter Linux und auf Mac OS X mittels Virtual PC 6.)

Features: Text- und Browseransichten. Alle Elemente klappbar in der Browseransicht. Browseransicht nur lesbar. Elementwähler. Bearbeitungs- und Suchfunktionen. Attributwähler. Sonderzeichenauswahl.

Es gibt eine Feature-Matrix, die die Versionen Home, Professional und Enterprise miteinander vergleicht http://www.altova.com/matrix_x.html.

Diese Liste erhebt keinen Anspruch auf Vollständigkeit, aber wenn Sie einen guten XML-Editor kennen (gut aus der Perspektive eines Firebird-Dokumentenschreibers), der hier fehlt, lassen Sie es uns über die Mailingliste wissen.