<?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>docExample -- an example documentation node</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_doc__Template.html">next</a> | <a href="_doc_lp__String_rp.html">previous</a> | <a href="_doc__Template.html">forward</a> | <a href="_doc_lp__String_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>docExample -- an example 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>docExample</tt></div>
</dd></dl>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><div>The variable docExample is a <a href="../../Macaulay2Doc/html/___String.html" title="the class of all strings">String</a> containing an example of the use of <a href="_doc_lp__String_rp.html" title="a simple documentation function">doc(String)</a> to write a documentation page, visible <a href="_simple__Doc__Frob_lp__Z__Z_cm__Matrix_rp.html">here</a>.</div>
<table class="examples"><tr><td><pre>i1 : print docExample
doc ///
Key
(simpleDocFrob,ZZ,Matrix)
Headline
A sample documentation node
Usage
x = simpleDocFrob(n,M)
Inputs
n:ZZ
positive
M:Matrix
which is square
Outputs
x:Matrix
A block diagonal matrix with {\tt n}
copies of {\tt M} along the diagonal
Consequences
This section is used if the function causes side effects.
Description
Text
Each paragraph of text begins with "Text". The following
line starts a sequence of Macaulay2 example input lines.
However, see @TO (matrix,List)@.
Example
M = matrix"1,2;3,4";
simpleDocFrob(3,M)
Caveat
This is not a particularly useful function
SeeAlso
matrix
(directSum,List)
///</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_doc__Template.html" title="a template for a documentation node">docTemplate</a> -- a template for a documentation node</span></li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="_doc__Example.html" title="an example documentation node">docExample</a> is <span>a <a href="../../Macaulay2Doc/html/___String.html">string</a></span>.</p>
</div>
</div>
</body>
</html>
