<?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>packageTemplate -- a template for a package</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_simple__Doc__Frob.html">next</a> | <a href="_doc__Template.html">previous</a> | <a href="_simple__Doc__Frob.html">forward</a> | <a href="_doc__Template.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>packageTemplate -- a template for a package</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>packageTemplate s</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>s</tt>, <span>a <a href="../../Macaulay2Doc/html/___String.html">string</a></span>, the name of the package</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><div>This routine returns a barebones package template that you can use to start writing a package.</div>
<table class="examples"><tr><td><pre>i1 : print packageTemplate "WonderfulModules"
newPackage(
"WonderfulModules",
Version => "0.1",
Date => "",
Authors => {{Name => "",
Email => "",
HomePage => ""}},
Headline => "",
DebuggingMode => true
)
export {}
-- Code here
beginDocumentation()
doc ///
Key
WonderfulModules
Headline
Description
Text
Example
Caveat
SeeAlso
///
doc ///
Key
Headline
Usage
Inputs
Outputs
Consequences
Description
Text
Example
Caveat
SeeAlso
///
TEST ///
-- test code and assertions here
-- may have as many TEST sections as needed
///</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>Ways to use <tt>packageTemplate</tt> :</h2>
<ul><li>packageTemplate(String)</li>
</ul>
</div>
</div>
</body>
</html>
