Keywords - Function groups - @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Group: Reading and Writing

Function: makehelp
Description: makehelp invokes the automatic translator for generating help pages.


Usage: makehelp(options, file)
Input:
options options, e.g. "html" for HTML pages, "ascii" for short help pages or "latex" for manual pages
file filename or directoryname

Note:

Example:



; generates a single HTML file from an XploRe quantlet called "grandrews"

makehelp ("html", "/home/user/XploRe/lib/grandrews.xpl")

Result:



An HTML page "grandrews.html" compatible with the XploRe APSS is written into the directory specified by XPL4OUTHELP.

Example:



; generates a complete revised APSS into directory /opt/bin/XploRe

makehelp ("html", "/opt/bin/XploRe")

Result:



Generates a complete helpsystem from the files in

/opt/bin/XploRe/hlp2 and /opt/bin/XploRe/help and

writes the resulting files in /opt/bin/XploRe/help

and /opt/bin/XploRe/help/text. Make sure that the

directories exist and you have permission to write into this directory.


Group: Reading and Writing

Keywords - Function groups - @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

(C) MD*TECH Method and Data Technologies, 21.9.2000