Create a Help File
|
Create a help file that can be displayed as a help page within the Maple online help system.
|
|
This method converts a Maple worksheet into a Maple help file and saves it into your help database. It is assumed that a directory has been created to contain your help database (.hdb file) by using your system software. See About Help Databases in Maple.
|
1.
|
Create or open the worksheet to save as a help file. For information on help page templates, see Help Page Templates.
|
2.
|
From the Tools menu, select Help Database, and then Save as Help Page. The Save to Database dialog with Indexing and Database information opens.
|
3.
|
In the Select Writable Database combination box, enter the full filename (including directory pathname) or select the filename of your help database. Check the contents of the <maple>\lib folder to make sure you use a unique name for your database.
|
4.
|
In the Topic box, enter a help topic name to represent the worksheet. The help topic name is used to display the help page once it has been integrated into the Maple online help system by entering ?helptopicname at a prompt. See View a Help File as a Help Page.
|
5.
|
(optional) In the Aliases text box, enter alternative help topic names to use for displaying your new help page (see previous step). Separate multiple aliases by using a comma or a space.
|
6.
|
(optional) In the Table of Contents text box, enter the location in the Table of Contents where an entry is to be added. If a user clicks the Table of Contents entry for your help page, Maple displays the help page. Use the forward slash (/) to separate the text to display at each level of the Table of Contents.
|
7.
|
In the Format drop-down list, select the type of Maple worksheet file format to use: Classic (.mws) or Standard (.mw). Classic .mws format help pages can be viewed in both Worksheet interfaces and the Command-line interface, but do not support any Standard Worksheet features. Standard .mw format help pages can be viewed only in the Standard Worksheet interface.
|
|
Help database directories only appear in the Select Writable Database box if they have been declared in a libname command during the current Maple session and if they already contain a writable .hdb file.
|
8.
|
Click Save to save the worksheet as a help file in your help database.
|
|
If the specified .hdb file does not exist, you are asked if you want Maple to create it. Click Yes and the .hdb file is created in the specified directory.
|
|
Download Help Document
Was this information helpful?