JavaHelp system
| JavaHelp system | |
|---|---|
| Basic data
|
|
| Maintainer | Java Community Process |
| developer | Sun Microsystems |
| Current version | 2.0_05 (October 3, 2007) |
| operating system | platform independent |
| programming language | Java |
| category | Help system |
| License | GNU General Public License with Classpath Exception |
| javahelp.java.net | |
JavaHelp System is a platform-independent Java help system from Sun Microsystems , which makes it possible to easily integrate online help and documentation in Java applications. The help texts are HTML -based, while the interface is XML -based.
The JavaHelp system is understood to mean both the specification of the programming interface (according to Java Specification Request 97) and the reference implementation of this specification. The reference implementation is open source under the GNU General Public License 2.0. The programming interface is currently (2010) in version 2.0, the reference implementation in version 2.0_05.
JavaHelp System is not itself an authoring tool , but there are a number of authoring tools that can generate help information in JavaHelp format.
Components and properties
The JavaHelp system consists of the following parts:
- Help Viewer
- The Help Viewer is a window for displaying help including navigation elements such as toolbar, navigation window and full-text search. The help texts themselves are based on HTML 3.2 and can be enhanced with simple Java components for further functionalities. Table of contents and index according to W3C standards are generated automatically.
- The Help Viewer can be displayed in a separate window or anywhere else within an application. The same applies to the individual components of the Help Viewer (such as the navigation window).
- Context sensitive help
- Context-sensitive help information can also be displayed outside of the Help Viewer using Swing components. The corresponding help is linked based on the IDs of the current Swing Controls.
- JavaHelp API
- The JavaHelp API is responsible for the summary and correct display of the help texts. It also enables help information from various sources such as the table of contents, index and search databases to be consolidated.
- The JavaHelp API is designed to be configurable and extensible. For example, it can be expanded with special navigation aids, search algorithms or HTML viewers.
- Help information
- The help information is separated from the rest of the application by the JavaHelp system. This enables help in different languages, for example. This also makes it possible to update the online help or only parts of the online help independently and independently of the application.
Web links
- JSR 97 JavaHelp 2.0 Specification
- Linux magazine 2001/12
Individual evidence
- ↑ JavaHelp project page on java.net ( Memento from June 11, 2007 in the Internet Archive )
- ↑ JavaHelp Features