<?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>docTemplate -- a template for a documentation node</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_package__Template.html">next</a> | <a href="_doc__Example.html">previous</a> | <a href="_package__Template.html">forward</a> | <a href="_doc__Example.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>docTemplate -- a template for a documentation node</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>docTemplate</tt></div>
</dd></dl>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><div>docTemplate is a <a href="../../Macaulay2Doc/html/___String.html" title="the class of all strings">String</a>, which can be cut and paste into a text file, to be used as a template for writing documentation for functions and other objects in a package.</div>
<table class="examples"><tr><td><pre>i1 : print docTemplate
doc ///
Key
Headline
Usage
Inputs
Outputs
Consequences
Description
Text
Code
Example
Text
Code
Example
Subnodes
Caveat
SeeAlso
///</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_doc__Example.html" title="an example documentation node">docExample</a> -- an example documentation node</span></li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="_doc__Template.html" title="a template for a documentation node">docTemplate</a> is <span>a <a href="../../Macaulay2Doc/html/___String.html">string</a></span>.</p>
</div>
</div>
</body>
</html>
