<?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>hypertext list format</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_id.html">next</a> | <a href="_hypertext.html">previous</a> | <a href="_id.html">forward</a> | <a href="_hypertext.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>hypertext list format</h1>
<div>Documentation text is composed of a list of text and hypertext items. A single text string, even though it is not a list, is generally accepted as a hypertext list. Math support is currently rudimentary. Macaulay2 examples may be included in the list<p/>
Each element of the list may be a text string, or one of the elements below.The following items are used by themselves<ul><li><tt>BR</tt> -- break to the next line</li>
<li><tt>HR</tt> -- a horizontal rule (line)</li>
<li><span><a href="../../Text/html/___P__A__R__A.html" title="hypertext paragraph container">PARA</a> -- hypertext paragraph container</span></li>
</ul>
Items that take a text string (or other hypertext list) as argument<ul><li><tt>TT s</tt> -- makes the argument <tt>s</tt> into a typewriter like, fixed font</li>
<li><tt>EM s</tt> -- change the font of <tt>s</tt> to emphasize it</li>
<li><tt>PRE s</tt> -- considers the string <tt>s</tt> to be preformatted.</li>
<li><tt>SUB s</tt> -- subscript</li>
<li><tt>SUP s</tt> -- superscript</li>
</ul>
Items that place hyperlinks into the documentation<ul><li><span><a href="../../Text/html/___T__O.html" title="hypertext documentation link">TO</a> -- hypertext documentation link</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>
<li><span><a href="../../Text/html/___T__O2.html" title="labeled hypertext documentation link">TO2</a> -- labeled hypertext documentation link</span></li>
</ul>
Other useful hypertext elements<ul><li><span><a href="../../Text/html/___U__L.html" title="hypertext UL item">UL</a> -- hypertext UL item</span></li>
<li><span><a href="___E__X__A__M__P__L__E.html" title="hypertext EXAMPLE item">EXAMPLE</a> -- hypertext EXAMPLE item</span></li>
</ul>
<h2>Example</h2>
For example, the hypertext list<pre>{
HR{},
"When referring to a ",
EM "Macaulay2",
" identifier such as ",
TT "matrix",
", use the TT element, or use a cross-reference, as in ",
TO matrix,
". Incorporate ",
EM "Macaulay2",
" examples (during ",
TO (installPackage,String),
") as illustrated here.",
EXAMPLE "matrix{{1,2},{3,4}}",
HR{}
}</pre>
<p/>
when used in a <a href="_document.html" title="package item: documentation node">document</a> node, produces<p/>
<hr/>
When referring to a <em>Macaulay2</em> identifier such as <tt>matrix</tt>, use the TT element, or use a cross-reference, as in <a href="_matrix.html" title="make a matrix">matrix</a>. Incorporate <em>Macaulay2</em> examples (during <a href="_install__Package.html" title="load and install a package and its documentation ">installPackage(String)</a>) as illustrated here.<table class="examples"><tr><td><pre>i1 : matrix{{1,2},{3,4}}
o1 = | 1 2 |
| 3 4 |
2 2
o1 : Matrix ZZ <--- ZZ</pre>
</td></tr>
</table>
<hr/>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_conventions_spfor_spdocumentation.html" title="">conventions for documentation</a></span></li>
<li><span><a href="_writing_spdocumentation.html" title="">writing documentation</a></span></li>
</ul>
</div>
</div>
</body>
</html>
