Help Page Format - Maple Programming Help

Online Help

All Products    Maple    MapleSim

Home : Support : Online Help : Configure Maple : Customize the Maple System : Creating Custom Help Pages : worksheet/reference/helpformat

Help Page Format


The help pages in the Maple help system follow a conventional format. Each help page contains one or more of the following attributes.






The name of the topic described in the help page





Calling Sequence

(for procedures) The command syntax required to invoke the procedure



(for package overview pages) The general form of the command syntax



for commands in that package






(for procedures) A description of each parameter in the calling sequence






A brief description of the topic






(for procedures) Examples that illustrate how to invoke the procedure and



the result of the invocation



(for package overview pages) Examples that illustrate the general use of the



package, using several package commands





See Also

A list of related items for which help is available





Help page templates are available. For more information, see Help Page Templates.

See Also

Create a Help File

Help Page Templates

Overview of Creating Help Pages in Maple


View a Help File as a Help Page