<?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>beginDocumentation -- package item: start documentation section</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_document.html">next</a> | <a href="_export__Mutable.html">previous</a> | <a href="_document.html">forward</a> | <a href="_export__Mutable.html">backward</a> | <a href="_creating_spa_sppackage.html">up</a> | <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>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_packages.html" title="">packages</a> > <a href="_creating_spa_sppackage.html" title="">creating a package</a> > <a href="_begin__Documentation.html" title="package item: start documentation section">beginDocumentation</a></div>
<hr/>
<div><h1>beginDocumentation -- package item: start documentation section</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>beginDocumentation()</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Consequences:<ul><li>Initiates the documentation section of a package. Loads the packages <a href="../../SimpleDoc/html/index.html" title="simpler documentation for functions and methods">SimpleDoc</a> and <a href="../../Text/html/index.html" title="">Text</a>.</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><p>Documentation for a package, and tests for the package, are placed after this point in a package file. This way, documentation can be loaded separately, Macaulay2 examples in the documentation can be run, and the whole documentation can be stored in a database.</p>
<p>For an example, see <a href="_an_spexample_spof_spa_sppackage.html" title="">an example of a package</a></p>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_install__Package.html" title="load and install a package and its documentation ">installPackage</a> -- load and install a package and its documentation </span></li>
<li><span><a href="_check.html" title="perform tests of a package">check</a> -- perform tests of a package</span></li>
<li><span><a href="_writing_spdocumentation.html" title="">writing documentation</a></span></li>
</ul>
</div>
</div>
</body>
</html>
