<?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(..., Subnodes => ...) -- a menu of documentation nodes</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_documentation_spkeys.html">next</a> | <a href="_document_lp..._cm_sp__See__Also_sp_eq_gt_sp..._rp.html">previous</a> | <a href="_documentation_spkeys.html">forward</a> | <a href="_document_lp..._cm_sp__See__Also_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(..., Subnodes => ...) -- a menu of documentation nodes</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 { ... , Subnodes => { ... }, ... }</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>This option inserts into a documentation page a menu of subnodes. Here is a generic example:<pre>Subnodes => {
"An example of subnodes",
TO "a link name",
TO "another link name"
},</pre>
The <tt>Subnodes</tt> option defines how the tree structure of the documentation is constructed. This is relevant when printing the documentation.</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__Subnodes_sp_eq_gt_sp..._rp.html" title="a menu of documentation nodes">Subnodes</a> -- a menu of documentation nodes</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="../../Text/html/___T__O.html" title="hypertext documentation link">TO</a> -- hypertext documentation link</span></li>
<li><span><a href="../../SimpleDoc/html/_doc_lp__String_rp.html" title="a simple documentation function">doc</a> -- a simple documentation function</span></li>
</ul>
</div>
</div>
</body>
</html>
