|
How to Create a Top-level Command Help Page
|
|
Template Instructions
|
|
|
|
To create a top-level command help page using the template:
|
|
2.
|
Save the worksheet with an appropriate name.
|
|
3.
|
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.
|
|
|
|
Help Page Template Sections
|
|
|
|
Calling Sequences
|
|
|
•
|
Use the format specified for the calling sequences. Replace <Command_Name>, <param1>, <param2>, and opts 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 <param1>, <data type>, and <parameter description> 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.
|
|
•
|
If optional equations (opts) 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.
|
|
|
|
Download Help Document
Was this information helpful?
