<?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(..., Key => ...) -- key of a documentation node</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html">next</a> | <a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html">previous</a> | <a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html">forward</a> | <a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html">backward</a> | up | <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>
<hr/>
<div><h1>document(..., Key => ...) -- key of a 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">Consequences:<ul><li>specifies the name under which the documentation is stored</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>The document key is the the name of the node, specifically the one that allows users to find the documentation for the desired command. Some node names, rather than being strings, are sequences of Macaulay2 objects that refer to specific method functions. If one is documenting a function of Macaulay2, the key will just be the function's name, as in the documentation for <a href="_resolution.html" title="projective resolution">resolution</a>.<pre>Key => resolution,</pre>
However, if one is documenting a method for a function, then the key will have a different form, as in the documentation for <a href="_resolution_lp__Module_rp.html" title="compute a projective resolution of a module">resolution(Module)</a>.<pre>Key => (resolution,Module),</pre>
If one is documenting an optional argument to a function, then the key has a different form still, as in <a href="_resolution_lp..._cm_sp__Syzygy__Limit_sp_eq_gt_sp..._rp.html" title="stop when this number of syzygies are obtained">resolution(..., SyzygyLimit => ...)</a>.<pre>Key => [resolution,SyzygyLimit],</pre>
Finally, if one is documenting an overview of a group of functions or a package, as in <a href="_chain_spcomplexes.html" title="">chain complexes</a> then one would set up a document key of the form:<pre>Key => "chain complexes",</pre>
</div>
</div>
<h2>Further information</h2>
<ul><li><span>Default value: <a href="_null.html" title="the unique member of the empty class">null</a></span></li>
<li><span>Function: <span><a href="_document.html" title="package item: documentation node">document</a> -- package item: documentation node</span></span></li>
<li><span>Option name: <span><a href="_document_lp..._cm_sp__Key_sp_eq_gt_sp..._rp.html" title="key of a documentation node">Key</a> -- key of a documentation node</span></span></li>
</ul>
<div class="single"><h2>Caveat</h2>
<div>No two documentation nodes may have the same key or even a key that is a synonym for a key which is already used. However, sometimes there is a need for several documentation nodes to have the same key. This happens when a command that needs to be documented is a synonym for another already documented command. In this case the synonym's key should be stated in quotation marks. As an example, look at the documentation for <a href="../../Text/html/___S__U__B__S__E__C__T__I__O__N.html" title="hypertext SUBSECTION item">SUBSECTION</a> and <a href="../../Text/html/___H__E__A__D__E__R2.html" title="hypertext HEADER2 item">HEADER2</a>.</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_document.html" title="package item: documentation node">document</a> -- package item: documentation node</span></li>
<li><span><a href="../../Text/html/___T__O.html" title="hypertext documentation link">TO</a> -- hypertext documentation link</span></li>
</ul>
</div>
</div>
</body>
</html>
