<?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 -- prepare hypertext for display</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_hypertext_splist_spformat.html">next</a> | <a href="_http__Headers_lp__String_rp.html">previous</a> | <a href="_hypertext_splist_spformat.html">forward</a> | <a href="_http__Headers_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>hypertext -- prepare hypertext for display</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>hypertext x</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>x</tt>, <span>a <a href="___List.html">list</a></span>, a list of strings and hypertext mark-up lists</span></li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><span>a <a href="../../Text/html/___Hypertext.html">mark-up list</a></span>, a new list of mark-up lists obtained from the old by making the format more suitable for ultimate display</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>Here is a list of some of the transformations that are performed.<ul><li>occurrences of <tt>null</tt>, such as those that might have been produced by the insertion of an extra comma, are removed</li>
<li><a href="___Sequence.html">sequences</a>, such as those produced by extra sets of parentheses, are <a href="_splice.html">spliced</a> into the lists containing them</li>
<li>the contents of lists and sequences are merged into the mark-up lists containing them</li>
<li>mark-up lists of type <a href="../../Text/html/___T__O.html" title="hypertext documentation link">TO</a> occurring a mark-up list of type <a href="../../Text/html/___U__L.html" title="hypertext UL item">UL</a> are converted to lists of type <a href="../../Text/html/___T__O__H.html" title="hypertext documentation link followed by a headline">TOH</a>, so the headlines of the items will appear in the resulting menu</li>
<li>the targets of the links in mark-up lists of type TO, TOH, and TO2, are converted into <a href="___Document__Tag.html">document tags</a></li>
<li>mark-up types, such as <a href="../../Text/html/___P__A__R__A.html" title="hypertext paragraph container">PARA</a>, are converted into lists of length 0 of that type</li>
<li>strings spanning multiple lines are wrapped into one long line after appropriately trimming the spaces at the beginning and end of each line</li>
<li>an error message is produced if something not recognizable as documentation is encountered</li>
</ul>
We may phase out this function in favor of performing the listed transformations automatically when hypertext elements are created.</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="../../Text/html/___Hypertext.html" title="the class of mark-up lists used with hypertext">Hypertext</a> -- the class of mark-up lists used with hypertext</span></li>
</ul>
</div>
<div class="waystouse"><h2>Ways to use <tt>hypertext</tt> :</h2>
<ul><li>hypertext(List)</li>
<li>hypertext(Sequence)</li>
</ul>
</div>
</div>
</body>
</html>
