Custom Demo

This document describes the steps that must be followed to run the application that demonstrates implementing htmlHelpPanel, and htmlIndexPanel's public components to create a custom help frame.

System Requirements

The only requirement for running the demonstration application is the presence of a Java runtime, JavaSoft version 1.1.3  preferred (although jHelp will run under 1.1.1 and 1.1.2 runtimes.) The runtime should be configured properly for your system, per the documentation that comes with it.

jHelp 2.0 will not run under a Java 1.02 runtime.

Setting the Classpath

When you unpacked the jHelp distribution zip onto your hard disk, it placed the jHelp package jar (jhelp.jar) in a subdirectory of your installation directory named "lib."

Running DemoApp requires that the jHelp package jar be named in the Java Classpath. How this is done is system dependent, although it is fairly similar across platforms. On a DOS-based platform it may be accomplished with a batch  or command-line instruction such as:

set CLASSPATH=%CLASSPATH%;d:\YourDirectory\lib\jhelp.jar

assuming that you have installed the jHelp distribution zip into to a folder named d:\YourDirectory.

If you already have a previous version of jHelp in your Classpath, then you should remove it before adding this newer version.

If you are unsure how to place jhelp.jar in your Java Classpath, you should ask someone who is familiar with this to do it for you on your system

Starting the CustomDemo Application

After you have placed jhelp.jar in your Classpath, log into your installation directory, and then into the examples/custom subdirectory. This directory should contain the file CustomDemo.class, among others.

At the system prompt, enter the command

java CustomDemo

The above assumes that the Java runtime executable (java.exe on Windows platforms) is in the executable path. Again, if you are not sure how to set up your Java runtime to run Java applications, you should ask someone who is familiar with the process to show you how to do this.