Maple Professional
Maple Academic
Maple Student Edition
Maple Personal Edition
Maple Player
Maple Player for iPad
MapleSim Professional
MapleSim Academic
Maple T.A. - Testing & Assessment
Maple T.A. MAA Placement Test Suite
Möbius - Online Courseware
Machine Design / Industrial Automation
Aerospace
Vehicle Engineering
Robotics
Power Industries
System Simulation and Analysis
Model development for HIL
Plant Modeling for Control Design
Robotics/Motion Control/Mechatronics
Other Application Areas
Mathematics Education
Engineering Education
High Schools & Two-Year Colleges
Testing & Assessment
Students
Financial Modeling
Operations Research
High Performance Computing
Physics
Live Webinars
Recorded Webinars
Upcoming Events
MaplePrimes
Maplesoft Blog
Maplesoft Membership
Maple Ambassador Program
MapleCloud
Technical Whitepapers
E-Mail Newsletters
Maple Books
Math Matters
Application Center
MapleSim Model Gallery
User Case Studies
Exploring Engineering Fundamentals
Teaching Concepts with Maple
Maplesoft Welcome Center
Teacher Resource Center
Student Help Center
makehelp - insert a text or .mws or .mw file into a help database
Calling Sequence
makehelp(topic, file)
makehelp(topic, file, library)
makehelp(topic, file, library, options)
Parameters
topic
-
topic of the help file to be created
file
name of the text or .mws or .mw file to be used
library
library in which the help file is to be stored
options
optional arguments of the form keyword=value
Description
The makehelp command reads a file, assumed to contain help for the specified topic, and either displays it using the help viewer, or adds it to a library help database. The file can be either a Maple worksheet or flat text.
The topic can be of the form `name`, or `name1/name2`. Filenames should match the conventions for your system. 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".)
If a third argument is specified, the makehelp command saves the resulting help page in the specified library help database.
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.
Like the topic, an alias or a table-of-contents entry can be of the form `name` or `name1/name2`.
The makehelp command displays the created help page using the help viewer (unless the call to makehelp was terminated with a colon).
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.
Or you can use .mws files to create a help file.
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.
See Also
Help Page Templates, INTERFACE_HELP
Download Help Document