help
(help [ hlpfile [ hlptopic [
option ]]] )
This function opens the help system
using hlpfile with hlptopic.
Arguments
|
hlpfile (optionally)string, the filename of the help file
(.chm or .hlp)
hlptopic (optionally) string, the topic to be
shown
option (optionally) actually not supported in BricsCAD
LISP; is a flag to control CHM/HLP viewer
|
Return
|
T if help was successfully
opened, NIL otherwise
|
Example
|
(help "PipeHelp.chm"
"PipeHelp")
(help
"www.cadtools.de/ProgramHelp/index.html")
(help "www.cadtools.de/ProgramHelp/index.html"
"/topic")
important for all cases :
as the (help) function can use a second string
argument ("content index"), it is important how to handle it
:
BricsCAD and AutoCAD just combine the first
string (the main help URL) and the second string
together;
so it is important that the second (optional)
string then contains the delimiter, like the "/"
character
(help
"www.cadtools.de/ProgramHelp/index.html")
(help "www.cadtools.de/ProgramHelp"
"/index.html")
works
(help
"www.cadtools.de/ProgramHelp/index.html/")
does not work
So to have context-specific pages, add the
separator to the second "context" string.
|
Remarks
|
see (setfunhelp) function on how to register a help topic for a custom
command
|