Macaulay2 » Documentation
Packages » SimpleDoc :: packageTemplate
next | previous | forward | backward | up | index | toc

packageTemplate -- a template for a package

Synopsis

Description

This routine returns a barebones package template that can be used to start writing a package.

i1 : print packageTemplate "WonderfulModules"
newPackage(
    "WonderfulModules",
    Version => "0.1",
    Date => "",
    Headline => "",
    Authors => {{ Name => "", Email => "", HomePage => ""}},
    AuxiliaryFiles => false,
    DebuggingMode => false
    )

export {}

-* Code section *-


-* Documentation section *-
beginDocumentation()

doc ///
Key
  WonderfulModules
Headline
Description
  Text
  Tree
  Example
  CannedExample
Acknowledgement
Contributors
References
Caveat
SeeAlso
Subnodes
///

doc ///
Key
Headline
Usage
Inputs
Outputs
Consequences
  Item
Description
  Text
  Example
  CannedExample
  Code
  Pre
ExampleFiles
Contributors
References
Caveat
SeeAlso
///

-* Test section *-
TEST /// -* [insert short title for this test] *-
-- test code and assertions here
-- may have as many TEST sections as needed
///

end--

-* Development section *-
restart
debug needsPackage "WonderfulModules"
check "WonderfulModules"

uninstallPackage "WonderfulModules"
restart
installPackage "WonderfulModules"
viewHelp "WonderfulModules"

See also

Ways to use packageTemplate :

For the programmer

The object packageTemplate is a method function.