<?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>TO -- hypertext documentation link</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___T__O2.html">next</a> | <a href="___T__I__T__L__E.html">previous</a> | <a href="___T__O2.html">forward</a> | <a href="___T__I__T__L__E.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>TO -- hypertext documentation link</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>TO x</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>x</tt>, a documentation key</span></li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><span>an object of class <a href="___T__O.html" title="hypertext documentation link">TO</a></span>, </span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><tt>TO "x"</tt> produces a hypertext link to the documentation page labeled <tt>x</tt>.<p/>
See also <a href="../../Macaulay2Doc/html/_hypertext.html" title="prepare hypertext for display">hypertext</a>. The word <i>hypertext</i> in the previous sentence is an example of the use of <tt>TO</tt>.<p/>
The special form <tt>TO {"x", "s"}</tt> produces a hypertext link to the page labeled <tt>x</tt>, but with the string "s" appended to the string "x" at the point where the reference occurs. This form is needed because in some modes of output the link is indicated with a section number in brackets.<p/>
The special form <tt>TO (f,X)</tt> produces a hypertext link to the page documenting the method used for applying the function <tt>f</tt> to an argument of class <tt>X</tt>. For more arguments, use <tt>TO (f,X,Y)</tt> or <tt>TO (f,X,Y,Z)</tt>.<p/>
The special form <tt>TO [f,X]</tt> produces a hypertext link to the page documenting the optional argument named <tt>X</tt> for the function <tt>f</tt>.<p/>
If <tt>TO x</tt> is an entry in a <a href="___U__L.html" title="hypertext UL item">UL</a>, then it is treated as <tt>TOH x</tt>, and headlines are added automatically.</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="../../Macaulay2Doc/html/_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></li>
<li><span><a href="___T__O2.html" title="labeled hypertext documentation link">TO2</a> -- labeled hypertext documentation link</span></li>
<li><span><a href="___T__O__H.html" title="hypertext documentation link followed by a headline">TOH</a> -- hypertext documentation link followed by a headline</span></li>
</ul>
</div>
<div class="waystouse"><h2>Methods that use an object of class TO :</h2>
<ul><li>new TO from Thing</li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="___T__O.html" title="hypertext documentation link">TO</a> is <span>an <a href="___Intermediate__Mark__Up__Type.html">intermediate mark-up type</a></span>, with ancestor classes <a href="___Hypertext.html" title="the class of mark-up lists used with hypertext">Hypertext</a> < <a href="../../Macaulay2Doc/html/___Basic__List.html" title="the class of all basic lists">BasicList</a> < <a href="../../Macaulay2Doc/html/___Thing.html" title="the class of all things">Thing</a>.</p>
</div>
</div>
</body>
</html>
