<?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>makeDocumentTag -- convert a documentation key to a documentation tag</title> <link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/> </head> <body> <table class="buttons"> <tr> <td><div><a href="___Make__Info.html">next</a> | <a href="___Make__Documentation.html">previous</a> | <a href="___Make__Info.html">forward</a> | <a href="___Make__Documentation.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>makeDocumentTag -- convert a documentation key to a documentation tag</h1> <div class="single"><h2>Synopsis</h2> <ul><li><div class="single"><a href="_using_spfunctions_spwith_spoptional_spinputs.html">Optional inputs</a>:<ul><li><span><span>a <a href="___Package.html">package</a></span></span></li> </ul> </div> </li> </ul> </div> <div class="single"><h2>Description</h2> <div><table class="examples"><tr><td><pre>i1 : makeDocumentTag (res,Module) o1 = User :: resolution(Module) o1 : DocumentTag</pre> </td></tr> <tr><td><pre>i2 : peek oo o2 = DocumentTag{(resolution, Module), resolution(Module), null, User}</pre> </td></tr> <tr><td><pre>i3 : makeDocumentTag (koszul,ZZ,Matrix) o3 = User :: koszul(ZZ,Matrix) o3 : DocumentTag</pre> </td></tr> <tr><td><pre>i4 : peek oo o4 = DocumentTag{(koszul, ZZ, Matrix), koszul(ZZ,Matrix), null, User}</pre> </td></tr> <tr><td><pre>i5 : makeDocumentTag [res,PairLimit] o5 = Macaulay2Doc :: resolution(..., PairLimit => ...) o5 : DocumentTag</pre> </td></tr> <tr><td><pre>i6 : peek oo o6 = DocumentTag{[resolution, PairLimit], resolution(..., PairLimit => ...), ------------------------------------------------------------------------ null, Macaulay2Doc}</pre> </td></tr> </table> </div> </div> <div class="single"><h2>See also</h2> <ul><li><span><a href="_documentation_spkeys.html" title="">documentation keys</a></span></li> </ul> </div> <div class="waystouse"><h2>Ways to use <tt>makeDocumentTag</tt> :</h2> <ul><li>makeDocumentTag(DocumentTag)</li> <li>makeDocumentTag(String)</li> <li>makeDocumentTag(Thing)</li> </ul> </div> </div> </body> </html>