Javahelp-Framework: Hilfstexte simpel integrieren

Es gibt zwei wichtige Releases von Javahelp: 1.1.3 und 2.0. Die älteste Version von Java, die Javahelp 2.0 unterstützt, ist J2SE 1.2.2, daher braucht man sich um die Unterstützung von Javahelp in eigenem Code keine Gedanken zu machen. Das Javahelp-System besteht aus einer umfangreichen, erweiterbaren Spezifikation und API sowie aus einer Referenzimplementierung.

Das standardmäßige Hauptfenster des Javahelp-Systems hat drei Bereiche, wird nicht zerstört, wenn man das Fenster verlässt und ist konfigurierbar. Die drei Bereiche sind gegliedert in Symbolleiste, Navigationsbereich und Inhaltsbereich.

Benutzer können die Onlinehilfe innerhalb von Anwendungen auf unterschiedliche Weise aufrufen, zum Beispiel über die Auswahl eines Themas aus einem Hilfemenü oder durch das Klicken auf einen Hilfe-Button auf der grafischen Benutzeroberfläche einer Anwendung. Das Javahelp-System bietet eine einfache Schnittstelle, mit der eine Anwendung veranlassen kann, dass eine bestimmte Thema-ID angezeigt wird. Das Javahelp-System verknüpft die ID dann mit der entsprechenden URL und zeigt diese an. IDs werden den entsprechenden URLs in einer Metadatendatei des Javahelp-Systems zugeordnet, der sogenannten Map-Datei. Wenn man zum Beispiel einen Dateiauswahldialog programmiert, kann der Entwickler es so einrichten, dass die Thema-ID fc_help angezeigt wird, wenn man auf den Hilfe-Button unten in der Dialogbox klickt. In der Map-Datei ist die ID fc_help definiert als Datei mit Namen FileChooser.html, wobei die folgende XML-Syntax verwendet wird:

Das Trennen der Angaben für die Dateinamen (oder URLs) vom Programmcode bietet Content-Autoren die Kontrolle, welche Informationen mit einer bestimmten Thema-ID verknüpft werden.

Ein Tooltip ist eine kurze Information, die der Benutzer zu sehen bekommt, wenn sich der Cursor länger als eine bestimmte, einstellbare Zeit über einem Button befindet. Auch solche Tooltip-Informationen lassen sich in die Daten des Javahelp-Systems integrieren.

Das Javahelp-System bietet auch die Möglichkeit, die Onlinehilfe für grafische Komponenten der Benutzeroberfläche einer Anwendung aufzurufen. Der Benutzer führt dazu Gesten aus, die eine kontextsensible Hilfe aktivieren und wählt dann die entsprechende Komponente aus. Die mit dieser Komponente verknüpfte ID wird dann angezeigt. Es ist auch möglich, Hilfethemen über ein Inhaltsverzeichnis, einen Index-Navigator oder aus dem Content-Bereich des Hauptfensters aufzurufen.