next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
SimpleDoc > docTemplate

docTemplate -- a template for a documentation node

Synopsis

Description

docTemplate is a String, which can be cut and paste into a text file, to be used as a template for writing documentation for functions and other objects in a package.

i1 : print docTemplate

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

See also

For the programmer

The object docTemplate is a string.