Informations for MMAlpha developers


Back to welcome page
Up!

Documenting a package

Any MMAlpha package must be provided with a documentation directory which has to be put in the $MMALPHA/Mathematica/doc/packages
directory.
The best way to see how this should be done is to examine the example of the Matrix package documentation, place here.
This directory contains four items:

The documentation notebook should follow a standard structure which is obvious when examining Matrix.nb. Please, try to follow this structure, and avoid re-inventing your own presentation: this only makes the software messy, or... takes some of our (precious) time to adapt your contribution. You find:

It is a good practive to start writing your new package using such a documentation notebook: just copy this directory in your own work space, and adapt it. While developing your package, you will use tests that you can later incorporate into the test program that you must provide with you package.
Content of this directory

Last modification: May 26, 2006.
To get more info: Patrice.Quinton@irisa.fr