| Library: | xplore |
| See also: |
| Quantlet: | makehelp | |
| Description: | makehelp invokes the automatic translator for generating help pages |
| Usage: | makehelp (modus, tmp, in {, outname}) | |
| Input: | ||
| modus | text vector defining which helpsystems should be generated. Possible values are "text", "tex", "html". | |
| tmp | text defining in which directory makehelp can write the generated help files. The user needs to have write permission to this directory. A possible choice is getenv("xpl4outtemp"). | |
| in | text which defines a directory or an XploRe file to be converted (see Notes for further information) | |
| outname | (optional) text which defines the output directory of the resulting files. Since the parameter is optional the default location is getenv("xpl4outhelp") | |
If you give a directory as the third parameter then XploRe assumes that you want to generate the whole helpsystem. In this case it is expected that the subdirectory lib of the given directory contains all the necessary quantlets. The output is written to the subdirectory tex, text and html (depending on the modus you choose).
In case that you generate only one help page, please note that with "html" no navigation list "Keywords - @ A B ... Z" will be generated.
After generating the help files you need, please have a look at the file "err.log". It contains information about errors and problems which occured during generating the help system. The file will exist only if errors or problems have occurred.
library("xplore")
makehelp("tex", getenv("xpl4outtemp"), "/opt/XploRe")
makehelp("text", getenv("xpl4outtemp"), "/opt/XploRe")
makehelp("html", getenv("xpl4outtemp"), "/opt/XploRe")
generates the three versions of the helpsystem. For your computer you have to replace /opt/XploRe by the directory where XploRe is installed.
; generates one help page
library("xplore")
tmpdir = getenv("xpl4outtemp")
outdir = getenv("xpl4outhelp")
; windows-style, for unix replace \\ by / !!
makehelp("html", tmpdir, getenv("xpl4lib")+"\\plot.xpl", outdir)
Generates the HTML version of the quantlet plot.
; generates a whole helpsystem
proc()=makeallhelp(version, out)
if(exist("out")<>2)
out = getenv("xpl4outhelp")
endif
tmp = getenv("xpl4outtemp")
in = getenv("xpl4syshome")
; if multiple directories are given
; then take the first one
if(getenv("os")=="windows")
tmpl = strtok(tmp, ";")
inl = strtok(in, ";")
outl = strtok(out, ";")
else
tmpl = strtok(tmp, ":")
inl = strtok(in, ":")
outl = strtok(out, ":")
endif
makehelp(version, tmpl[1], inl[1], outl[1])
endp
library("xplore")
makeallhelp("html")
generates the HTML version of the helpsystem. It takes the default directories given by the system environment.