<?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>documentation keys</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___Document__Tag.html">next</a> | <a href="_document_lp..._cm_sp__Subnodes_sp_eq_gt_sp..._rp.html">previous</a> | <a href="___Document__Tag.html">forward</a> | <a href="_document_lp..._cm_sp__Subnodes_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>documentation keys</h1>
<div><p>The Macaulay2 documentation is linked together by cross-references from one documentation node to another. Each node is identified by a string, which is the title of the node. Some nodes, such as this one, have titles that are simply invented by the author. Others have titles that are manufactured in a certain way from the aspect of the program being documented, for the sake of uniformity.</p>
<p>For example, the title of the node describing resolutions of modules is <tt>"resolution Module"</tt>. The corresponding key is <tt>(resolution, Module)</tt>, and it is the job of the function <a href="_make__Document__Tag.html" title="convert a documentation key to a documentation tag">makeDocumentTag</a> to convert keys to titles.</p>
<p>Here is a list of the various types of documentation keys.</p>
<ul><li><tt>"a string"</tt></li>
<li><tt>s</tt>a symbol</li>
<li><tt>(f,X)</tt>a method function or unary operator <tt>f</tt> that accepts an argument of type <tt>X</tt></li>
<li><tt>(f,X,Y)</tt>a method function or binary operator <tt>f</tt> that accepts 2 arguments, of types <tt>X</tt> and <tt>Y</tt></li>
<li><tt>(f,X,Y,Z)</tt>a method function <tt>f</tt> that accepts 3 arguments, of types <tt>X</tt>, <tt>Y</tt> and <tt>Z</tt></li>
<li><tt>(f,X,Y,Z,T)</tt>a method function <tt>f</tt> that accepts 4 arguments, of types <tt>X</tt>, <tt>Y</tt>, <tt>Z</tt> and <tt>T</tt></li>
<li><tt>[f,A]</tt>a function <tt>f</tt> with an optional named <tt>A</tt></li>
<li><tt>(NewOfFromMethod,X,Y,Z)</tt>the method for <tt>new X of Y from Z</tt></li>
<li><tt>(NewOfMethod,X,Y)</tt>the method for <tt>new X of Y</tt></li>
<li><tt>(NewFromMethod,X,Z)</tt>the method for <tt>new X from Z</tt></li>
<li><tt>(NewMethod,X)</tt>the method for <tt>new X</tt></li>
<li><tt>((symbol ++, symbol =), X,Y)</tt>the method for assignment <tt>X ++ Y = ...</tt></li>
<li><tt>(homology,X)</tt>the method for <tt>HH X</tt></li>
<li><tt>(homology,ZZ,X)</tt>the method for <tt>HH_ZZ X</tt></li>
<li><tt>(cohomology,ZZ,X)</tt>the method for <tt>HH^ZZ X</tt></li>
<li><tt>(homology,ZZ,X,Y)</tt>the method for <tt>HH_ZZ (X,Y)</tt></li>
<li><tt>(cohomology,ZZ,X,Y)</tt>the method for <tt>HH^ZZ (X,Y)</tt></li>
<li><tt>(E,ZZ,X)</tt>the method for <tt>E_ZZ X</tt> or <tt>E^ZZ X</tt>, where <tt>E</tt> is a scripted functor</li>
<li><tt>(E,ZZ,X,Y)</tt>the method for <tt>E_ZZ (X,Y)</tt> or <tt>E^ZZ (X,Y)</tt>, where <tt>E</tt> is a scripted functor</li>
</ul>
<table class="examples"><tr><td><pre>i1 : makeDocumentTag "some title"
o1 = User :: some title
o1 : DocumentTag</pre>
</td></tr>
<tr><td><pre>i2 : makeDocumentTag (symbol ++, Module, Module)
o2 = User :: Module ++ Module
o2 : DocumentTag</pre>
</td></tr>
<tr><td><pre>i3 : makeDocumentTag ((symbol _, symbol =), Symbol, Thing)
o3 = User :: Symbol _ Thing = Thing
o3 : DocumentTag</pre>
</td></tr>
<tr><td><pre>i4 : makeDocumentTag (Tor,ZZ,Module,Module)
o4 = User :: Tor_ZZ(Module,Module)
o4 : DocumentTag</pre>
</td></tr>
</table>
</div>
</div>
</body>
</html>
