<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>document -- package item: documentation node</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___T__E__S__T.html">next</a> | <a href="_begin__Documentation.html">previous</a> | <a href="___T__E__S__T.html">forward</a> | <a href="_begin__Documentation.html">backward</a> | <a href="_creating_spa_sppackage.html">up</a> | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_packages.html" title="">packages</a> > <a href="_creating_spa_sppackage.html" title="">creating a package</a> > <a href="_document.html" title="package item: documentation node">document</a></div>
<hr/>
<div><h1>document -- package item: documentation node</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>document { Key => key, ... }</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><span>a <a href="___List.html">list</a></span>, a hypertext list including special documentation entries; any optional arguments are to be placed in this list</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>formatted documentation is created and stored</li>
</ul>
</div>
</li>
<li><div class="single"><a href="_using_spfunctions_spwith_spoptional_spinputs.html">Optional inputs</a>:<ul><li><span><tt>SourceCode => </tt><span><span>a <a href="___List.html">list</a></span>, <span>default value null</span>, a list of functions whose source code should be displayed in the documentation</span></span></li>
<li><span><a href="_document_lp..._cm_sp__Base__Function_sp_eq_gt_sp..._rp.html">BaseFunction => ...</a>, -- function for a documented feature</span></li>
<li><span><a href="_document_lp..._cm_sp__Caveat_sp_eq_gt_sp..._rp.html">Caveat => ...</a>, -- warnings</span></li>
<li><span><a href="_document_lp..._cm_sp__Consequences_sp_eq_gt_sp..._rp.html">Consequences => ...</a>, -- side-effects of a function</span></li>
<li><span><a href="___Headline.html">Headline => ...</a>, -- make a headline for a documentation node</span></li>
<li><span><a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html">Inputs => ...</a>, -- inputs for a function</span></li>
<li><span><a href="_document_lp..._cm_sp__Key_sp_eq_gt_sp..._rp.html">Key => ...</a>, -- key of a documentation node</span></li>
<li><span><a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html">Outputs => ...</a>, -- outputs for a function</span></li>
<li><span><a href="_document_lp..._cm_sp__See__Also_sp_eq_gt_sp..._rp.html">SeeAlso => ...</a>, -- crossreferences in documentation</span></li>
<li><span><a href="_document_lp..._cm_sp__Subnodes_sp_eq_gt_sp..._rp.html">Subnodes => ...</a>, -- a menu of documentation nodes</span></li>
<li><span><a href="___Usage.html">Usage => ...</a>, -- shows the usage of a function</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><p>There are two basic types of documentation. The first type documents a function or a method, as in <a href="_resolution_lp__Module_rp.html" title="compute a projective resolution of a module">resolution(Module)</a>. The second type of documentation is for overviews or functions with methods, as in <a href="_chain_spcomplexes.html" title="">chain complexes</a> or <a href="_resolution.html" title="projective resolution">resolution</a> respectively. The headings <a href="___Usage.html" title="shows the usage of a function">Usage</a>, <a href="___Function.html" title="the class of all functions">Function</a>, <a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html" title="inputs for a function">Inputs</a>, <a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html" title="outputs for a function">Outputs</a>, and <a href="_document_lp..._cm_sp__Consequences_sp_eq_gt_sp..._rp.html" title="side-effects of a function">Consequences</a>, are useful only for documentation of the first type.</p>
<p>Here is a template for a typical documentation node.</p>
<pre>document {
Key => key,
Headline => "one line description", -- not needed for overviews
Usage => "usage",
BaseFunction => "function", -- usually not needed
SourceCode => {METHOD1,...}, -- usually not needed
Inputs => {
inputs
},
Consequences => {
effects
},
Outputs => {
outputs
},
"There can be explanatory prose here in the form of a hypertext list.",
EXAMPLE lines \/\/\/
m2code
m2code
m2code
\/\/\/,
"There can be explanatory prose here in the form of a hypertext list.",
Caveat => {"warning"},
SeeAlso => {"other things"},
Subnodes => {
"subheading a",
TO "node 1",
TO "node 2",
"subheading b",
TO "node 3",
...
},
}</pre>
<p>Hypertext markup items that you may use:</p>
<ul><li><span><a href="___E__X__A__M__P__L__E.html" title="hypertext EXAMPLE item">EXAMPLE</a> -- hypertext EXAMPLE item</span></li>
</ul>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_writing_spdocumentation.html" title="">writing documentation</a></span></li>
<li><span><a href="_conventions_spfor_spdocumentation.html" title="">conventions for documentation</a></span></li>
<li><span><a href="_hypertext.html" title="prepare hypertext for display">hypertext</a> -- prepare hypertext for display</span></li>
<li><span><a href="___Wikipedia_lp__String_rp.html" title="link to a Wikipedia entry">Wikipedia</a> -- link to a Wikipedia entry</span></li>
</ul>
</div>
<div class="waystouse"><h2>Ways to use <tt>document</tt> :</h2>
<ul><li>document(List)</li>
</ul>
</div>
</div>
</body>
</html>
