Programming with the JavaHelp System

The topics in this chapter of the JavaHelp System User's Guide describe the aspects of the JavaHelp system of primary interest to application developers.

The JavaHelp classes are distributed in the following JAR files. The JAR files are located in the javahelp\lib folder.

jh.jar
The standard library, it includes everything needed to use the help viewer and the standard navigator types (TOC, index, full-text search).

jhbasic.jar
A subset of jh.jar that does not include support for the full-text search engine. This may be useful for very simple help systems that do not require a full-text search database or help systems where size is important.

jhall.jar
Includes all of the JavaHelp system classes, including the tools required to create a search database.

jsearch.jar
The default full-text search engine used in the JavaHelp system.

Supplemental Information

You will probably find the following supplemental documentation and source code useful:

API
The javadoc generated documentation of the JavaHelp API is included with this release. You can view the API using the JavaHelp API viewer (demos\bin\apiviewer) or using a web browser (doc\api\index.html)

Specification The JavaHelp 1.0 specification is included in this release and can be found at:
doc\spec\index.html

Sample Source Files This release includes demo programs that demonstrate JavaHelp system functionality. Sources for the demo programs are included in the release at:
demos\src

Implementing Context-Sensitive Help

Embedding JavaHelp Components

Creating Lightweight Java Components

jh.jar	The standard library, it includes everything needed to use the help viewer and the standard navigator types (TOC, index, full-text search).
jhbasic.jar	A subset of `jh.jar` that does not include support for the full-text search engine. This may be useful for very simple help systems that do not require a full-text search database or help systems where size is important.
jhall.jar	Includes all of the JavaHelp system classes, including the tools required to create a search database.
jsearch.jar	The default full-text search engine used in the JavaHelp system.

API	The `javadoc` generated documentation of the JavaHelp API is included with this release. You can view the API using the JavaHelp API viewer (`demos\bin\apiviewer`) or using a web browser (`doc\api\index.html`)
Specification	The JavaHelp 1.0 specification is included in this release and can be found at: doc\spec\index.html
Sample Source Files	This release includes demo programs that demonstrate JavaHelp system functionality. Sources for the demo programs are included in the release at: demos\src