makehelp - Maple Help

Home : Support : Online Help : System : Help : makehelp

makehelp

insert a text or .mws or .mw file into a help database

 Calling Sequence makehelp(topic, file, library) makehelp(topic, file, library, options)

Parameters

 topic - name, string; topic of the help file to be created file - name, string; name of the text or .mws or .mw file to be used library - name, string; library in which the help file is to be stored options - optional arguments of the form keyword=value, where keyword can be any of aliases, browser or showhelp

Description

The makehelp command reads a file, assumed to contain help for the specified topic, and adds it to a library help database.

 • The topic is specified in the form: name, or name1/name2.
 • The file argument can be either the path to a Maple worksheet or flat text. Filenames should match the conventions for your platform. Note that filename characters that are special to Maple (such as the backslash character itself) must be preceded by a backslash when entering the string in Maple. (For example, "c:\\mydir\\myfile.txt".)
 • The library argument specifies the path to the help database where the specified file will be stored.
 • If the optional argument aliases=A is specified, where A is a list of strings and names, then these are added to the help database as aliases for the topic.
 • If the optional argument browser=B is specified, where B is a list of strings and names, then these are added to the help database as table-of-contents entries for the topic. To place a given help page inside of a folder in the help browser table-of-contents, use the folder name as the first entry in a list of strings, for example: $\left["FolderName","CommandName"\right]$.
 Like the topic, an alias or a table-of-contents entry can be of the form name or name1/name2.
 • By default, the makehelp command displays the created help page using the help viewer. The option showhelp = false can be used to suppress showing the help page in the help viewer.

Note: The examples shown below do not work unless you have the files used in the makehelp commands.

Examples

Create a help file for topic mypkg/myfunc. The text of the help file is currently in myfunc.txt. Store the resulting help/mypkg/text/myfunc object in library mylib.

 > $\mathrm{makehelp}\left(\mathrm{mypkg/myfunc},"myfunc.txt","mylib"\right):$

Or you can use .mw files to create a help file.

 > $\mathrm{makehelp}\left(\mathrm{mypkg/myfunc},"myfunc.mw","mylib"\right):$

The showhelp option can suppress the display of the help browser.

 > $\mathrm{makehelp}\left(\mathrm{mypkg/myfunc},"myfunc.mw","mylib",\mathrm{showhelp}=\mathrm{false}\right):$

The following example assumes you want to replace the Maple help file for diff with your own help file. In order for this example to work, you must have placed your own library directory as the first component of libname, ahead of the Maple library. Your library directory must exist and be writable for the example to work.

 > $\mathrm{makehelp}\left(\mathrm{diff},"newdiff.txt",\mathrm{libname}\left[1\right],\mathrm{aliases}=\left["Diff","differentiate","differentiation","derivative"\right],\mathrm{browser}=\left["Mathematics/Calculus/Differential Calculus/Diff","Mathematics/Calculus/Differential Calculus/diff","Mathematics/Inert Functions/Diff"\right]\right):$