next | previous | forward | backward | up | top | index | toc | Macaulay2 website
Macaulay2Doc > The Macaulay2 language > writing documentation > document > package documentation template

package documentation template

document {
        Key      => PackageName,
        Headline => "one line description",
        "There can be explanatory prose here in the form of a hypertext list.",
        EXAMPLE {
            "m2code",
            "m2code",
            "m2code"},
        "There can be explanatory prose here in the form of a hypertext list.",
        Acknowledgement => {} -- a hypertext list
        Contributors => {} -- a hypertext list
        References => {} -- a hypertext list
        Caveat => {"warning"}
        Subnodes => {
            TO functionName1,
            TO functionName2 -- and so on
            }
        }

See also