How to Create a Package Command Help Page - Maple Help

Home : Support : Online Help : System : Help : Creating Help Pages : Help Page Templates : Templates/PackageCommand

How to Create a Package Command Help Page

Template Instructions

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

Help Page Template Sections

Calling Sequence

 • Use the format specified for the calling sequences. Replace , , and  with the appropriate name and parameters for your command.
 • Use one calling sequence per distinct general calling sequence. Add more calling sequences if required.

Parameters

 • Sort parameters to match order in which they appear as you read calling sequences.
 • Replace param1, , and with your information.
 • If a parameter is optional, use the following format.

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

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 (opts) can be specified, use the following format.

 • Include the following statement as one of the last points in the description section, with the appropriate information filled in.
 This command is part of the  package, so it can be used in the form (..) only after executing the command with().  However, it can always be accessed through the long form of the command by using [](..).

Examples

 • The first command should be the with() 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 forms.