Javahelp-Framework: Hilfstexte simpel integrieren

Sun Microsystems‘ Javahelp-System ist eine Technologie für Hilfesysteme. Sie funktioniert in Anwendungen, die Java unterstützen, auf jeder Plattform und mit jedem Browser – sofern es sich um eine reine Java-Anwendung handelt. Das Framework ist ideal für den Einsatz in heterogenen Umgebungen wie dem Internet, einem Intranet, oder auch für Applets und Java-Applikationen. In diesem Artikel sollen die Vorteile von Javahelp erläutert und demonstriert werden, wie einfach es einzusetzen ist.

Vorteile

Javahelp wird mithilfe von JFC-Softwarekomponenten (Java Foundation Classes) implementiert, die Flexibilität bieten sowie eine einfache Entwicklung von selbst erstellten Benutzeroberflächen und Funktionen ermöglichen. Hilfe-Informationen für eine Anwendung können in diese selbst oder ein separates Fenster integriert werden. JFC bietet auch die Möglichkeit, die Hilfefunktionen mit eigenen Navigationssteuerelementen zu erweitern.

Javahelp erleichtert die dynamische Aktualisierung von Hilfedaten sowie die Speicherung an einem geeigneten Ort, sei es auf Client- oder Serverseite. Das Fenster zum Anzeigen der Inhalte verwendet HTML 3.2 als Format, so dass Content einfach erstellt werden kann. Die Standardnavigation bietet ein Inhaltsverzeichnis, einen Index und eine Volltextsuche. (Sowohl Inhaltsverzeichnis als auch Index folgen dabei den W3C-Standards.)

Das Javahelp-Datenblatt liefert hierzu die folgenden Informationen: Das Inhaltsverzeichnis unterstützt die erweiter- und reduzierbare Anzeige von Themen, eine unbegrenzte Zahl von Hierarchieebenen sowie das Zusammenfügen mehrerer Inhaltsverzeichnisse. Die Anzeige des Inhaltsverzeichnisses wird mit der Content-Anzeige synchronisiert, was bedeutet, dass das angezeigte Thema im Inhaltsverzeichnis hervorgehoben ist. Der Index unterstützt das Zusammenführen mehrerer Indizes. Die Volltextsuche soll möglichst flexibel und konfigurierbar sein. Auch die Suchmaschine kann entweder auf Client- oder auf Serverseite untergebracht sein.

Hilfe-Inhalte und Suchmaschine werden zu einer einzigen Datei im Standard-JAR-Format komprimiert. Alle Dateien können auch in unkomprimierter Form in einem Verzeichnis gespeichert werden. Aber die Komprimierung in eine einzige Datei ist aus Gründen einfacherer Speicherung und größerer Flexibilität beim Zugriff zu empfehlen. Anzeigen und durchsuchen kann man die Inhalte mit einem selbst geschriebenen Navigator, einer Suchmaschine, Standard-Javahelp-Viewern oder mit jedem beliebigen HTML-Viewer, also auch allen Standard-Webbrowsern.

Die Javahelp-API bietet einen Mechanismus für kontextsensible Hilfe und für ID-Mapping. Mithilfe der Javahelp-API können die Hilfeinformationen mehrerer Komponenten zusammengefügt werden, so dass der Benutzer nur ein einziges Gesamtdokument zu sehen bekommt. Der Mechanismus zum Zusammenführen wird auf Inhaltsverzeichnisse, Indizes und Suchdatenbanken angewandt.