Home Eclipse IDE/PDE Plugins dokumentieren
Dokumentation und Eclipse-Hilfe PDF Drucken

Das FXL-Dokumentations-Tooling ermöglicht die Erstellung von Dokumentationen, die unter anderem pseudo-XML-Schemata sowie UML-Klassendiagramme enthalten können. Um solche und andere HTML-basierte Dokumentationen in das Eclipse-Hilfesystem zu integrieren, bietet Eclipse den Extension-Point org.eclipse.help. Mit Hilfe von sogenannten toc (table of contents) Dateien läßt sich die Struktur der Hilfe beschreiben, die Inhalte werden als HTML-Seiten hinterlegt.

Nachteilhaft an den im Eclipse-Framework mitgelieferten Editoren ist

  • Keine direkte Unterstützung für Mehrsprachigkeit. Die Implementierung der Eclipse-Hilfe unterstützt zwar Mehrsprachigkeit, allerdings müssen dann mehrere toc-Dateien gepflegt werden.
  • Keine Auflösung von Referenzen. Alle Referenzen liegen als Strings vor. Ist eine Referenz ungültig, so wird dies erst zur Laufzeit (durch fehlerhafte Anzeige der Hilfe) erkannt.
  • Verschiedene andere Dateien müssen von Hand nachgepflegt werden. Die plugin.xml benötigt den Eintrag, welche toc.xml-Dateien verwendet werden sollen. Die build.properties benötigen die Informationen, welche Dateien mit in das zu bauende Plugin aufgenommen werden sollen. Sollen kontext-sensitive Hilfen genutzt werden, muss außerdem noch eine context.xml-Datei gepfegt werden.
  • Die Hinterlegung der Inhalte der Dokumentationen erfolgt in Form von HTML-Seiten. Es gibt standardmäßig kein Werkeug zur Erstellung der Dokumente, welche auch erweiterte Funktionalitäten wie die Beschreibung von XML-Schemata und UML-Klassendiagrammen. Dazu müssen andere Werkzeuge eingesetzt werden.

Das CDF-Modul zur Bearbeitung von Eclipse-Hilfen dafür konzipiert, die genannten Schwächen zu vermeiden und die Erstellung und Pflege von Dokumentationen so einfach wie möglich zu gestalten. Dabei entstehen zur Laufzeit keine Abhängikeiten der von Ihnen erstellten Software zum CDF-Tooling.

Tutorial anschauen

Weiterführende Informationen

Bild 1: Erstellung einer oder beliebig vieler "Table of Contents". Direkte Integration der Internationalisierung. Die verschiedenen Dateien (toc, plugin.xml, build.properties) werden bei Bedarf automatisch erstellt und gepflegt.

doku1
Bild 1
Bild 2+3: Module, die eine existierende Struktur erweitern, können Referenzen verwenden (nicht nur unvalidierte Strings). Der Editor enthält entsprechende Dialoge zum Finden der Referenzen + markiert nicht gefundene als Fehler.
doku2
Bild 2

doku3
Bild 3

Bild 4 +5: Der Standalone-CDF-Editor kann mit Hilfe eines Profiles dazu genutzt werden, die Struktur der Hilfe zu erstellen und zu bearbeiten. Das Profil hat den Vorteil, alle für die Dokumentation unwichtigen Informationen (Java-Klassen, History etc) vor dem Nutzer zu verbergen, so dass er sich voll auf die Aufgabe des Dokumentierens konzentrieren kann. Damit kann der Editor auch von einem Nicht-Entwickler eingesetzt werden.
doku4
Bild 4

doku5
Bild 5