<?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>SYNOPSIS</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___S__Y__N__O__P__S__I__S_lp..._cm_sp__Heading_sp_eq_gt_sp..._rp.html">next</a> | <a href="_synonym.html">previous</a> | <a href="___S__Y__N__O__P__S__I__S_lp..._cm_sp__Heading_sp_eq_gt_sp..._rp.html">forward</a> | <a href="_synonym.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>SYNOPSIS</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="single"><a href="_using_spfunctions_spwith_spoptional_spinputs.html">Optional inputs</a>:<ul><li><span><a href="___S__Y__N__O__P__S__I__S.html">BaseFunction => ...</a>, </span></li>
<li><span><a href="___S__Y__N__O__P__S__I__S.html">Consequences => ...</a>, </span></li>
<li><span><a href="___S__Y__N__O__P__S__I__S_lp..._cm_sp__Heading_sp_eq_gt_sp..._rp.html">Heading => ...</a>, </span></li>
<li><span><a href="___S__Y__N__O__P__S__I__S.html">Inputs => ...</a>, </span></li>
<li><span><a href="___S__Y__N__O__P__S__I__S.html">Outputs => ...</a>, </span></li>
<li><span><a href="___S__Y__N__O__P__S__I__S.html">Usage => ...</a>, </span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><p>This function prepares a standardized synopsis in hypertext for use in documentation nodes.</p>
Here is an empty template for use with SYNOPSIS.<pre> SYNOPSIS (
Heading => "",
Usage => ""
BaseFunction => fn,
Inputs => {
},
Consequences => {
}
Outputs => {
},
PARA {
},
EXAMPLE lines ///
///
),</pre>
<p>The options are used just as with <a href="_document.html" title="package item: documentation node">document</a>.</p>
Here is an example of its use.<pre> SYNOPSIS {
Heading => "using binary methods for method functions",
Usage => "f(x,y)",
Inputs => {
"f" => { "a method function" },
"x" => { "an object of type ", TT "X" },
"y" => { "an object of type ", TT "Y" }
},
Outputs => {
{ "the previously installed method for ", TT "f(X,Y)", " is called with arguments ", TT "(x,y)", ", and the return value is returned.
If no such method has been installed, then Macaulay2 searches for a method
for ", TT "f(X',Y')", ", where ", TT "X'", " is an ancestor of ", TT "X", " and ", TT "Y'", " is an ancestor of ", TT "Y", "
(see ", TO "inheritance", " for details)."
}
},
"The second line of the following example illustrates the syntax above, using ", TO "source", ", which happens to be a method function.",
EXAMPLE lines ///
source(String,String) := peek;
source("foo","bar")
///,
PARA "The same syntax works for 3 or 4 arguments."
}</pre>
</div>
</div>
</div>
</body>
</html>
