<?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(..., Outputs => ...) -- outputs for a function</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__See__Also_sp_eq_gt_sp..._rp.html">next</a> | <a href="_document_lp..._cm_sp__Key_sp_eq_gt_sp..._rp.html">previous</a> | <a href="_document_lp..._cm_sp__See__Also_sp_eq_gt_sp..._rp.html">forward</a> | <a href="_document_lp..._cm_sp__Key_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(..., Outputs => ...) -- outputs for a function</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 { ... , Outputs => { outputs, ... }, ... }</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_document.html" title="package item: documentation node">document</a></span></li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>The entries should consist of items in one of the following forms.<ul><li><tt>hypertext</tt></li>
<li><tt>class => hypertext (or null)</tt></li>
<li><tt>symbolname => hypertext (or null)</tt></li>
<li><tt>symbolname => class => hypertext (or null)</tt></li>
</ul>
As an example, here is the <tt>Outputs</tt> entry of the method <a href="_resolution_lp__Ideal_rp.html" title="compute a projective resolution of (the quotient ring corresponding to) an ideal">resolution(Ideal)</a>:<pre> Outputs => { {"a resolution of ", TT "R/I", " by projective ", TT "R", "-modules" } },</pre>
Note that the hypertext list needs to be bounded by <tt>{</tt> and <tt>}</tt> as there is only one output for <a href="_resolution_lp__Ideal_rp.html" title="compute a projective resolution of (the quotient ring corresponding to) an ideal">resolution(Ideal)</a>. Without the braces, multiple outputs are defined. Note also that the <a href="___Type.html" title="the class of all types">Type</a> of the output is automatically added in this case.Here is an example of the <tt>Outputs</tt> entry of the function <a href="_sin.html" title="compute the sine">sin</a>:<pre>Outputs => { { "the sine of ", TT "x", "" } },</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__Outputs_sp_eq_gt_sp..._rp.html" title="outputs for a function">Outputs</a> -- outputs for a function</span></span></li>
</ul>
<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="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html" title="inputs for a function">Inputs</a> -- inputs for a function</span></li>
<li><span><a href="___Usage.html" title="shows the usage of a function">Usage</a> -- shows the usage of a function</span></li>
</ul>
</div>
</div>
</body>
</html>
