Package Command Template - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : System : Help : Creating Help Pages : Help Page Templates : examples/PackageCommandTemplate

<Package Command Template>

<For more information on using this template, refer to the ?Templates/PackageCommand help page. Delete this text and the title.>

<Package_Name>[<Command_Name>] <one line description of the command >

Calling Sequence

<Command_Name>(<param1>, <param2>, options)

Parameters

param1 - <data type>; <parameter description>

param2 - (optional) <data type>; <parameter description>

options   - (optional) equation(s) of the form option=value where option is one of <option1>, <option2>, <option3>, ...

Options

option1 - <data type>; <option description>

option2 - <data type>; <option description>

Description

• 

The <Command_Name> command ...

  

<OR>

• 

The <Command_Name>(<param1>, <param2>) calling sequence ...

• 

<Use bullets,

  

indented paragraphs (list items),

and nonindented paragraphs within the help page.>

• 

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

<Add examples that demonstrate functionality and the types of problems you can solve. Add comments to the examples.>

withPackage_Name&colon;

example1

example2

See Also

<related help topic>, <related help topic>, <related help topic>, <Package Overview>