Install S-PLUS Help Files

DESCRIPTION:

Installs help files written to accompany user-contributed S-PLUS functions.

USAGE:

Splus HINSTALL datadir sgmlfiles    

OPTIONAL ARGUMENTS:

datadir
fully-qualified or relative path to a .Data directory under which to install the help files. An SGML copy of the help file will be installed in datadir/__Shelp, an HTML copy will be installed under datadir/__Hhelp.
sgmlfiles
names of help files. Help files for use in S-PLUS should have file extension .sgml.

SIDE EFFECTS:

Two copies of the source SGML files are created under the specified .Data directory, one SGML and one HTML.

DETAILS:

The sole purpose of the HINSTALL utility is to install the help files. HINSTALL installs the files and also performs the SGML-to-HTML translation necessary to create the HTML files used by JavaHelp. Watch for errors of the form "SGMLS error"; these usually indicate missing or inappropriate tags in your source help files.

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