Howto Ship Helpsets with the Program

General Remark

Once you finished your helpset you want to ship it with your program. JavaHelp offers many possibilites to do that. Here only one approach is shortly described.

Availibility of JavaHelp

To manage and view the helpset you need to have the JavaHelp classes available. You can ship them with your application (jh.jar) and put the JAR file to the CLASSPATH.

Helpset in Subdirectory

If you ship the helpset with your program instead of hosting it on a server, you should refer to it with an URL relative to the resource directory of your class loader. Put your helpset in a subdirectory of that directory. If your program is in a JAR file and the helpset is not, then you should add "." to your CLASSPATH. Otherwise the resource will not be found.

Helpset in JAR

You could also bundle the helpset with the JAR file that contains your program. If you create an extra JAR for your helpset, you need to add it to your CLASSPATH. Be aware that the filenames are case sensitive.