 |
When developing Maple Worksheets for the Application
Center, it is important to present the material
in a consistent format. The aim of this Style
Guide and the worksheet
template is to help maintain consistency.
Please only use the built in styles such as Title,
Author, Text and Heading 1. You can use Maple's
style drop down box to choose between different
styles.
Any "non-math" Maple functions (e.g.
assign, unassign, map, match etc: that we would
not expect a non-Maple user to understand), should
be explained using a text paragraph or a short
comment shortly before the command.
You can omit Maple outputs (using ":")
where they do not add significantly to the understanding
of the solution or are more than a few lines long.
Use plots and numerical examples wherever possible
to clarify the problem and make the solution easier
to understand. Use mathematical notation within
Text regions whenever character notation is not
appropriate.
Please note: Maplesoft requires that a License
Agreement must be read and accepted by the
author before Solutions/Applications will be posted
on the Maple Application Center.
Worksheet Sections
Application Center worksheets should typically
consist of the following sections: (The styles
refer to the template styles). See the example
application to see the use of these sections.
1) Worksheet Header
- Title ( Style=Title )
- Author Details & Copyright Statement:
"by <Name>, <Institution>,
<Country>, <optional: email, URL>"
( Style = Author )
2) Introduction Section
- Statement of Problem and Objectives of the
Worksheet. This should be highly descriptive,
be of interest to both experts and non-experts
in your field and preferably have a diagram(s)
to illustrate the problem.
3) Initialization Section
- Contains a restart command and if possible,
all with() commands
- Optionally, define procedures to use later
in the worksheet
4) Sections on Solutions methods and Calculations
- Development of Model: Description of how the
model is developed and techniques used.
- Implementation of the Model: Description of
how the model is used to achieve the objectives
set out in the Introduction.
- Solutions and Results: Numeric and graphical
representations of the solutions to the problem(s)
described in the Introduction. Interpret the
results in text.
5) Conclusions
- Discussion on how well Maple helps to solve
these problems, highlighting the advantages
of using symbolic techniques, high precision
numerics, etc. Where possible, some guidance
should be included on how to explore and extend
the worksheet, e.g., "This solution assumes
a linear spring rate. Try using the following
to introduce a multi-rate spring..."
6) References
- All work should refer to all sources used
7) Disclaimer
- All worksheets must contain the following
disclaimer:
Legal Notice: The copyright for this application
is owned by the author(s). Neither Maplesoft nor
the author are responsible for any errors contained
within and are not liable for any damages resulting
from the use of this material. This application
is intended for non-commercial, non-profit use
only. Contact the author for permission if you
wish to use this application in for-profit activities.
Other Suggestions
Remove the output of the worksheet to reduce
file size (Edit->Remove Output->From Worksheet)
Collapse all sections to increase readiblity (View->Collapse
All Sections)
Hide ranges to improve appearance (View->Show
Hide Contents->Uncheck Sections and Execution
Groups)
Example Application
Please download this example
application to see an example of how to lay
out a Maple worksheet in a simple, easy to read
manner.
|
