promptHtml(name, filename, sep = ""))
name.html
, where
name
is the character string resulting from
deparsing the object name. The default file is stored in the working
directory, and it must be moved to the .Data\__Hhelp directory to access
it from a Commands window.
help
function to
display documentation for the object. As produced by
promptHtml
, the file for a function contains
the call to the function and individual sections for each of the arguments.
The file for a data frame contains the name of the data frame, its
dimensions, and individual sections for each of the variables in the data frame.
You need to fill in the actual information about the arguments, a description of the value returned by the function, examples, and whatever other information is appropriate.
A preferred method for creating user-defined help uses the
prompt
function. This creates an SGML help file that
can be used to generate an HTML help file, using the tools included in your
SHOME\help\buildhelpfiles distribution. You can create a compiled
help file
(.chm) that displays your HTML help files in HTML Help, a Microsoft help standard. See Chapter 4, User-Defined Help Files in the S-PLUS 6.1
for Windows Supplement for details.
promptHtml(myfunc) # creates myfunc.html in your working directory.
promptHtml(testfunc,"C://lenk/examples/testfunc.html") # creates testfunc.html in C:\lenk\examples.