How to Create a Top-level Command Help Page
Help Page Template Sections
To create a top-level command help page using the template:
Enter ?examples/CommandTemplate at the Maple prompt or click the following hyperlink: Top-level Command help page template.
Save the worksheet with an appropriate name.
Replace <Command_Name> with the name of the command and <one line description of the command> with a brief description of the command. Remove the angle brackets (< >) surrounding each field.
Use the format specified for the calling sequences. Replace <Command_Name>, <param1>, <param2>, and options with the appropriate names.
Use one calling sequence per distinct general calling sequence. Add more calling sequences if required.
Sort parameters to match the order in which they appear as you read the calling sequences.
Replace <param1>, <data type>, and <parameter description> with your information.
If a parameter is optional, add it to the Options section as well as to the list of named options in the following section.
If optional equations (options) can be specified, use the following format.
Sort options in alphabetical order.
Replace option1, <data type>, and <option description> with your information.
Use one or more of the following structures for the first bullets in the description. This will describe the functionality of the command.
Include both simple and complicated examples. Include examples of optional parameters or multiple calling sequences when applicable.
If you will be saving your help page in .mws format, you must use 1-D math to enter your examples. If you will be saving the help page in .mw format, you can choose 1-D math, 2-D math, or a mixture of input formats.
Add comments for each example.
List help page hyperlinks in alphabetical order separated by commas. For more information, see worksheet/managing/linking and worksheet/documenting/hyperlinkeditor.
Download Help Document