How to Create a Package Command Help Page
Template Instructions
Help Page Template Sections
To create a Package Command help page using the template:
Enter ?examples/PackageCommandTemplate at the Maple prompt or click the following hyperlink: Package Command help page template.
Save the worksheet with an appropriate name.
Replace <Package_Name> with the name of the package; <Command_Name> with the name of the package command; and <one line description of the command> with a brief description of the command. Remove the angle brackets (< >) surrounding each field.
Calling Sequence
Use the format specified for the calling sequences. Replace <Command_Name>, <param1>, and <param2> 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, <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.
Options
Sort options in alphabetical order.
Replace option1, <data type>, and <option description> with your information.
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
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_Name> package, so it can be used in the form <Command_Name>(..) only after executing the command with(<Package_Name>). However, it can always be accessed through the long form of the command by using <Package_Name>[<Command_Name>](..).
Examples
The first command should be the with(<Package_Name>) 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.
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.
The package name is usually in this list, for ease of navigation.
examples/PackageCommandTemplate
Templates
UsingPackages
worksheet/documenting/hyperlinkeditor
worksheet/managing/linking
Download Help Document
