Command - Maple Help

# Online Help

###### All Products    Maple    MapleSim

How to Create a Top-level Command Help Page

Template Instructions

 To create a top-level command help page using the template:
 1 Enter ?examples/CommandTemplate at the Maple prompt or click the following hyperlink: Top-level Command help page template.
 2 Save the worksheet with an appropriate name.
 3 Replace  with the name of the command and  with a brief description of the command.  Remove the angle brackets (< >) surrounding each field.

Help Page Template Sections

Calling Sequences

 • Use the format specified for the calling sequences. Replace , , , and options with the appropriate names.
 • Use one calling sequence per distinct general calling sequence.  Add more calling sequences if required.

Parameters

 • Sort parameters to match the order in which they appear as you read the calling sequences.
 • Replace , , and 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.

Options

 • Sort options in alphabetical order.
 • Replace option1, , and

Description

 • Use one or more of the following structures for the first bullets in the description.  This will describe the functionality of the command.

 OR

 • If optional equations (options) can be specified, use the following format.

Examples

 • 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.

See Also

 • List help page hyperlinks in alphabetical order separated by commas. For more information, see worksheet/managing/linking and worksheet/documenting/hyperlinkeditor.

 See Also