Macaulay2 » Documentation
Packages » PackageTemplate :: PackageTemplate

next | previous | forward | backward | up | index | toc

PackageTemplate -- an example Macaulay2 package

Description

PackageTemplate is an example package which can be used as a template for user packages.

Author

Jane Doe <[email protected]>

Version

This documentation describes version 1.0 of PackageTemplate.

Citation

If you have used this package in your research, please cite it as follows:

@misc{PackageTemplateSource,
  title = {{PackageTemplate: an example \emph{Macaulay2} package. Version~1.0}},
  author = {Jane Doe},
  howpublished = {A \emph{Macaulay2} package available at
    "http://www.math.uiuc.edu/~doe/"}
}

Exports

Functions and commands
- firstFunction -- a silly first function
- secondFunction -- a silly second function
Methods
- firstFunction(ZZ) -- see firstFunction -- a silly first function
- secondFunction(ZZ,List) (missing documentation)
- secondFunction(ZZ,ZZ) -- a silly second function
Symbols
- MyOption -- optional argument specifying a level

For the programmer

The object PackageTemplate is a package, defined in PackageTemplate.m2.

The source of this document is in PackageTemplate.m2:50:0.