Maple Professionel
Maple Académique
Maple Edition Étudiant
Maple Personal Edition
Maple Player
Maple Player for iPad
MapleSim Professionel
MapleSim Académique
Maple T.A. - Suite d'examens de classement
Maple T.A. MAA Placement Test Suite
Möbius - Didacticiels de mathématiques en ligne
Machine Design / Industrial Automation
Aéronautique
Ingénierie des véhicules
Robotics
Energie
System Simulation and Analysis
Model development for HIL
Modélisation du procédé pour la conception de systèmes de contrôle
Robotics/Motion Control/Mechatronics
Other Application Areas
Enseignement des mathématiques
Enseignement de l’ingénierie
Enseignement secondaire et supérieur (CPGE, BTS)
Tests et évaluations
Etudiants
Modélisation financière
Recherche opérationnelle
Calcul haute performance
Physique
Webinaires en direct
Webinaires enregistrés
Agenda des évènements
Forum MaplePrimes
Blog Maplesoft
Membres Maplesoft
Maple Ambassador Program
MapleCloud
Livres blancs techniques
Bulletin électronique
Livres Maple
Math Matters
Portail des applications
Galerie de modèles MapleSim
Cas d'Etudes Utilisateur
Exploring Engineering Fundamentals
Concepts d’enseignement avec Maple
Centre d’accueil utilisateur Maplesoft
Centre de ressources pour enseignants
Centre d’assistance aux étudiants
How to Create a Package Command Help Page
Template Instructions
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.
Help Page Template Sections
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, 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
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