<?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>tutorial -- convert documentation from tutorial format</title> <link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/> </head> <body> <table class="buttons"> <tr> <td><div><a href="_typical__Values.html">next</a> | <a href="_truncate__Output.html">previous</a> | <a href="_typical__Values.html">forward</a> | <a href="_truncate__Output.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>tutorial -- convert documentation from tutorial format</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>tutorial x</tt></div> </dd></dl> </div> </li> <li><div class="single">Inputs:<ul><li><span><tt>x</tt>, <span>a <a href="___String.html">string</a></span>, documentation in tutorial format</span></li> </ul> </div> </li> <li><div class="single">Outputs:<ul><li><span>documentation in hypertext format</span></li> </ul> </div> </li> </ul> </div> <div class="single"><h2>Description</h2> <div><p>Some of the Macaulay2 documentation is written in this format.</p> <table class="examples"><tr><td><pre>i1 : ///-- We can compute $(x+y)^3$ as follows. R = QQ[x,y] (x+y)^3 /// o1 = -- We can compute $(x+y)^3$ as follows. R = QQ[x,y] (x+y)^3</pre> </td></tr> <tr><td><pre>i2 : tutorial oo +-----------+ o2 = {We can compute $(x+y)^3$ as follows., |R = QQ[x,y]|} +-----------+ |(x+y)^3 | +-----------+ o2 : List</pre> </td></tr> <tr><td><pre>i3 : peek oo o3 = {TEX{"We can compute $(x+y)^3$ as follows."}, TABLE{class => examples, ------------------------------------------------------------------------ TR{TD{ExampleItem{"R = QQ[x,y]"}}}, TR{TD{ExampleItem{"(x+y)^3"}}}}}</pre> </td></tr> </table> </div> </div> </div> </body> </html>