Das Java-Hilfesystem

Online-Hilfen sind nicht notwendig - das ist eine teilweise berechtigte Einstellung mancher Programmierer. Und in der Tat, Programme sollten intuitiv zu bedienen sein und genau das tun, was von ihnen erwartet wird. Und für eine »Datei | Sichern als...«-Operation wird auch kein vernünftiger Mensch eine umfangreiche Hilfe benötigen.

Aber das ist nur die eine Seite der Medaille. Nicht-triviale Programme führen auch nicht-triviale Operationen durch, und diese bedürfen in der Regel einer Hilfe. Je komplexer ein Programm wird, umso notwendiger ist diese Funktion.

Bei vielen Programmen, zum Beispiel Spreadsheets, wird es sogar so sein, dass eine Reihe von Funktionen extrem selten benötigt wird - aber jedes Mal eine andere davon. Ohne sinnvolle Hilfe deinstalliere ich dann Programme wieder, bei denen ich nicht weiterkomme, oder ich verschwende meine Zeit mit dem Ausprobieren.

All diese Argumente gelten auch für Java-GUI-Anwendungen. Anwendungen auf dem Desktop spielen zwar nicht die Rolle, von der viele geträumt haben, aber tot ist Java deshalb auf dem Client noch lange nicht. Selbst bei Server-basierten Java-Anwendungen finden sich immer wieder kleine Administrationsdialoge mit grafischer Oberfläche, die die Konfiguration und Überwachung auf einfache Weise zur Verfügung stellen.

Java Help ist eine reine Java-Anwendung, die es schon seit drei Jahren gibt. Sie besteht einerseits aus einem Konzept - wie organisiere ich meine Hilfedateien - und andererseits aus den notwendigen Tools, um die Dateien dann anzuzeigen. Die kompilierten Klassen, die für diesen Zweck notwendig sind, dürfen frei mit eigenen Anwendungen verteilt werden. Der Quellcode wird auch mitgeliefert, aber Open Source ist dies noch lange nicht. Er dient nur zur Illustration und darf weder verändert noch weitergegeben werden. Manche Firmen haben noch einen weiten Weg vor sich.

Download und Installation

Der Download erfolgt wie üblich bei Java über die Seiten bei Sun (siehe[1]), nachdem die Lizenzvereinbarung akzeptiert wurde. Aktuell ist die Version 1.1.2_01, die in zwei Teilen heruntergeladen werden muss: einmal Java Help 1.1, anschließend noch das Patch auf 1.1.2_01.

Wer schon ein JDK oder zumindest ein JRE auf seiner Maschine hat, sollte aufpassen: Es gibt eine Version mit und eine Version ohne Java-Runtime. Letztere ist die richtige, sie ist aber immer noch fast 8,4 MByte groß. Das Patch kommt mit knapp 1,5 MByte daher.

Die eigentliche Java-Help-Runtime, die auch mit eigenen Programmen verteilt werden darf, ist deutlich kleiner, je nach Funktionsumfang, beispielsweise mit oder ohne Volltextsuche, sind es zwischen 220 und 400 KByte.

Die Installation ist simpel. Die heruntergeladene Datei »javahelp1_1-unix-no _rt.bin« wird ausführbar gemacht (mit »chmod +x«) und anschließend aufgerufen. Das Programm sucht nach vorhandenen Java-Versionen im »PATH« und stellt sie zur Auswahl. Nach der Wahl der entsprechenden Version (in der Regel sollte hier sowieso nur ein JDK/JRE im Pfad vorhanden sein) startet Install Anywhere. Der Rest läuft ab wie bei der Installation von Windows-Programmen gewohnt.

Um die Installation des Patches zu erleichtern ist es empfehlenswert, als Zielverzeichnis »/usr/local/jh1.1.2« zu verwenden (nur der letzte Bestandteil des Pfades ist dabei wichtig). Dadurch kann das Patch sehr einfach mit

# unzip javahelp-1_1_2_01.zip -d /usr/local/

eingespielt werden (es besteht aus neueren Versionen der Java-Help-Jars).

Abbildung 1: Java Help als Dokumentationsbrowser.

Erste Schritte

Java Help enthält einen Users Guide, der sowohl in HTML als auch im PDF-Format vorliegt. Neben Browser und Acrobat Reader kann auch das Java-Help-System selbst verwendet werden, um die Hilfe anzuzeigen, denn Java Help basiert auf HTML 3.2 (siehe Abbildung 1).

Wer die KDE-2-Hilfe kennt, wird sich sofort zurechtfinden. Links gibt es eine Navigationsleiste, die entweder ein Inhaltsverzeichnis, einen Index oder eine Volltextsuche bietet. Rechts im Hauptfenster wird der Hilfetext angezeigt.

Das implementierte Konzept hat zwei Vorteile: Erstens ist HTML ein Standard, so dass keine neue Auszeichnungssprache zu lernen ist. Zweitens kann die Hilfe so geschrieben werden, dass sie gleichzeitig als Dokumentation dient, also schon vor dem Programmaufruf zur Verfügung steht.

Der Users Guide führt umfassend in die Verwendung von Java Help ein. Dabei sind zwei Blickwinkel wichtig, die des Hilfe-Autors und die des Programmierers. Zusätzlich gibt es noch ein Verzeichnis »demos«, das insbesondere für Programmierer interessant ist.