Authoring JavaHelp for Viskit

This summary describes how developers can integrate help pages in the Viskit JavaHelp system. Both HTML and XML files may be modified.

How to make Viskit JavaHelp modifications

  1. Add html, css, images, etc. in subdirectory viskit/javahelp/Pages.
  2. Table of contents configuration file refers topic titles to tokens vHelpTOC.xml
  3. Corresponding filenames for each token are defined in the JavaHelp map vHelpMap.jhm
  4. Must rebuild Viskit to see any changes in HTML pages or table of contents.
  5. Tested changes can be checked into CVS.

JavaHelp file details

The javahelp/ directory contains the following:

The jhall.jar is Sun code which implements the JavaHelp system, as well as containing the search-indexing utility.

JavaHelp configuration background

JavaHelp support in Viskit is contained in these project areas: