<?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>Headline -- make a headline 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="___Heft.html">next</a> | <a href="___Heading.html">previous</a> | <a href="___Heft.html">forward</a> | <a href="___Heading.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>Headline -- make a headline 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>document { Key => key,</tt><br/><tt> Headline => "one line description", ... }</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_document.html" title="package item: documentation node">document</a></span></li>
<li><div class="single">Consequences:<ul><li>the headline string will be used to annotate itemized lists of cross references to the documentation <a href="_document_lp..._cm_sp__Key_sp_eq_gt_sp..._rp.html" title="key of a documentation node">Key</a></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>The headline of a documentation node, gives a brief, half line, description of the thing being documented. As an example, the headline for this documentation node was obtained with the code:<pre>Headline => "make a headline for a documentation node", </pre>
</div>
</div>
<div class="single"><h2>Functions with optional argument named Headline :</h2>
<ul><li>document(..., Headline => ...)</li>
<li><span>newPackage(..., Headline => ...), see <span><a href="_new__Package_lp__String_rp.html" title="package item: start a new package">newPackage(String)</a> -- package item: start a new package</span></span></li>
</ul>
</div>
<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="_hypertext.html" title="prepare hypertext for display">hypertext</a> -- prepare hypertext for display</span></li>
<li><span><a href="../../Text/html/___T__O__H.html" title="hypertext documentation link followed by a headline">TOH</a> -- hypertext documentation link followed by a headline</span></li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="___Headline.html" title="make a headline for a documentation node">Headline</a> is <span>a <a href="___Symbol.html">symbol</a></span>.</p>
</div>
</div>
</body>
</html>
