JavaHelp System

JavaHelp System
JavaHelp System
Maintainer Java Community Process
Entwickler Sun Microsystems
Aktuelle Version 2.0_05
(3. Oktober 2007)
Betriebssystem plattformunabhängig
Programmier­sprache Java
Kategorie Hilfesystem
Lizenz GNU General Public License
javahelp.dev.java.net

JavaHelp System ist ein plattformunabhängiges Java-Hilfesystem von Sun Microsystems, das es ermöglicht, auf einfache Weise Online-Hilfen und Dokumentationen in Java-Applikationen einzubinden. Die Hilfetexte sind HTML-basiert, während hingegen die Schnittstelle XML-basiert ist.

Unter dem JavaHelp System versteht man sowohl die Spezifikation der Programmierschnittstelle (gemäß Java Specification Request 97) als auch die Referenzimplementierung dieser Spezifikation. Die Referenzimplementierung ist Open Source gemäß GNU General Public License 2.0.[1] Die Programmierschnittstelle liegt aktuell (2010) in der Version 2.0, die Referenzimplementierung in der Version 2.0_05 vor.

JavaHelp System ist selbst kein Autorenwerkzeug, es gibt aber eine Reihe von Autorenwerkzeugen, welche Hilfeinformationen im JavaHelp-Format erzeugen können.

Bestandteile und Eigenschaften

Das JavaHelp-System besteht aus den folgenden Teilen:[2]

Help Viewer
Der Help Viewer ist ein Fenster zur Darstellung der Hilfe inklusive Navigationselementen wie Toolbar, Navigationsfenster und Volltextsuche. Die Hilfetexte selbst werden basierend auf HTML 3.2 dargestellt und können um einfache Java-Komponenten für weitere Funktionalitäten angereichert werden. Inhaltsverzeichnis und Index gemäß W3C-Standards werden automatisch generiert.
Der Help Viewer kann in einem eigenständigen Fenster oder an beliebiger anderer Stelle innerhalb einer Applikation dargestellt werden. Dasselbe gilt auch für die einzelnen Bestandteile des Help Viewers (wie beispielsweise das Navigationsfenster).
Kontextsensitive Hilfe
Kontextsensitive Hilfeinformation kann auch außerhalb des Help Viewers mittels Swing-Komponenten dargestellt werden. Dabei wird basierend auf den IDs der aktuellen Swing Controls auf die entsprechende Hilfe verlinkt.
JavaHelp API
Die JavaHelp-API ist für die Zusammenfassung und korrekte Darstellung der Hilfetexte zuständig. Sie ermöglicht es auch, Hilfeinformationen aus verschiedenen Quellen wie beispielsweise Inhaltsverzeichnis, Index und Such-Datenbanken zusammenzufassen.
Die JavaHelp-API ist so konzipiert, dass sie konfigurierbar und erweiterbar ist. Beispielsweise kann sie um spezielle Navigationshilfen, Suchalgorithmen oder HTML-Viewer erweitert werden.
Hilfeinformationen
Die Hilfeinformationen werden durch das JavaHelp-System vom Rest der Applikation getrennt. Damit wird beispielsweise Hilfe in unterschiedlichen Sprachen möglich. Dadurch ist es auch möglich, die Online-Hilfe beziehungsweise nur Teile der Online-Hilfe eigenständig und unabhängig von der Applikation zu aktualisieren.

Weblinks

Einzelnachweise

  1. JavaHelp Projektseite auf java.net
  2. JavaHelp Features

Wikimedia Foundation.

Игры ⚽ Поможем сделать НИР

Schlagen Sie auch in anderen Wörterbüchern nach:

  • JavaHelp — is a format for online help files that can be displayed by the JavaHelp browser. It is written in Java, and is mainly used in Java applications. It can be used for any application but it does require the overhead of the JRE to load.File formatThe …   Wikipedia

  • Java-Plattform — Die Java Plattform (englisch Java Platform) definiert die Ablaufumgebung (Java Virtual Machine) und Programmierschnittstellen (Java Application Programming Interface) innerhalb der Java Technologie. Der Kern der Java Plattform ist die Java… …   Deutsch Wikipedia

  • Java Foundation Classes — Die Java Foundation Classes (JFC) ist eine Sammlung von Programmierschnittstellen (APIs) für die Erstellung portabler Java Graphical User Interfaces (GUIs). Die Java Foundation Classes werden durch die folgenden Features definiert: Swing GUI… …   Deutsch Wikipedia

  • Java Specification Request — Ein Java Specification Request (JSR) ist eine Anforderung einer neuen Java Spezifikation oder einer wichtigen Änderung einer existierenden Java Spezifikation, die im Rahmen des Java Community Process (JCP) an das von Sun Microsystems betriebene… …   Deutsch Wikipedia

  • Online help — This article is about documentation included with software. For product documentation maintained over the Internet, see web help. For Wikipedia s help pages, see Help:Contents and Wikipedia:Help desk. Online help is topic oriented, procedural or… …   Wikipedia

  • Adobe RoboHelp — Infobox Software name = Adobe RoboHelp developer = Adobe Systems caption = Adobe RoboHelp 7 latest release version = 7.0.2 latest release date = release date and age|2008|05|30 operating system = Windows XP Windows 2000 Windows Vista genre =… …   Wikipedia

  • AuthorIT — Author it (formerly AuthorIT) is a Content management system which is intended to be used by anyone responsible for creating, maintaining, and distributing content. The foundation of Author it resides in its ability to single source content… …   Wikipedia

  • DITA Open Toolkit — The DITA Open Toolkit, or dita ot, is an open source publishing system for publishing DITA content to multiple formats. It was developed by IBM, and released as a public standard in 2001, along with DITA. The dita ot reference implementation uses …   Wikipedia

  • Список расширений имени файла/H — / * A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Примечание: Поскольку расширение имени файла может быть любым, представленный список не является полным …   Википедия

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”