Create JavaHelp Help Set for Installed Help Files

DESCRIPTION:

Creates the appropriate JavaHelp help set files for help files installed with the HINSTALL utility.

USAGE:

Splus BUILD_JHELP [name]

OPTIONAL ARGUMENTS:

name
a name for the main help set file, by default the directory name of the chapter in which BUILD_JHELP is invoked.

SIDE EFFECTS:

creates a directory __Jhelp in the current chapter's .Data, if it does not already exist. This directory contains the main help set file, a map file used for topic lookup, a TOC file for contents lookup, an Index file for index lookup, and a HelpSearch directory containing full-text search information. If the current chapter is not installed inside $SHOME, the __Jhelp directory also contains a gifs directory containing some GIF images used by the JavaHelp interface.

SEE ALSO:

, , .

EXAMPLES:

# creating your own help file for a function, and making a new
# JavaHelp help set with information about your new help file in it

myfunc <- function(x) x^2
prompt(myfunc)
!vi myfunc.sgml
!Splus HINSTALL .Data myfunc.sgml
!Splus BUILD_JHELP