This is Text.info, produced by Macaulay2, version 1.22

Text -- documentation and hypertext
***********************************

Description
===========

This package is a repository for functions related to typesetting the
documentation using $\TeX$ and hypertext list format (Macaulay2Doc),
usable with either document (Macaulay2Doc),
or doc (SimpleDoc). In particular, see
html(TEX), validate(Hypertext), and
show(Hypertext).

Version
=======

This documentation describes version 0.0 of Text.

Source code
===========

The source code from which this documentation is derived is in the file Text.m2
(see common/share/Macaulay2/Text.m2 ).

Exports
=======

  * Types
      * ANCHOR -- hypertext anchor
      * BLOCKQUOTE -- hypertext BLOCKQUOTE item
      * BODY -- hypertext BODY item
      * BOLD -- hypertext BOLD item
      * BR -- line break
      * BUTTON (missing documentation)
      * CDATA -- hypertext CDATA element
      * CODE -- hypertext CODE item
      * COMMENT -- hypertext COMMENT element
      * DD -- hypertext DD element
      * DIV -- a hypertext division
      * DL -- hypertext DL element
      * DT -- hypertext DT element
      * EM -- hypertext EM item
      * ExampleItem -- a type of hypertext for holding
        example inputs awaiting outputs
      * HEAD -- hypertext HEAD item
      * HEADER1 -- hypertext HEADER1 item
      * HEADER2 -- hypertext HEADER2 item
      * HEADER3 -- hypertext HEADER3 item
      * HEADER4 -- hypertext HEADER4 item
      * HEADER5 -- hypertext HEADER5 item
      * HEADER6 -- hypertext HEADER6 item
      * HR -- hypertext HR element (horizontal rule)
      * HREF -- hypertext link
      * HTML -- hypertext item
      * Hypertext -- the class of markup lists used with
        hypertext
      * HypertextContainer -- the class of markup
        lists that can contain paragraphs
      * HypertextParagraph -- the class of markup
        lists that constitute separate paragraphs
      * HypertextVoid (missing documentation)
      * IMG -- hypertext IMG item
      * INDENT (missing documentation)
      * INPUT (missing documentation)
      * IntermediateMarkUpType -- the class of
        intermediate markup types
      * ITALIC -- hypertext italic font
      * KBD -- hypertext KBD item
      * LABEL -- hypertext label item
      * LATER -- a hypertext element for lazy evaluation
      * LI -- hypertext list item
      * LINK -- a hypertext LINK element
      * LITERAL -- hypertext literal text
      * MarkUpType -- the class of markup types used with
        hypertext
      * MENU -- hypertext menu item
      * META -- a hypertext META element
      * OL -- hypertext OL item
      * PARA -- hypertext paragraph container
      * PRE -- preformatted text
      * SAMP -- hypertext SAMP item
      * SCRIPT -- hypertext SCRIPT element
      * SMALL -- hypertext SMALL item
      * SPAN -- hypertext span
      * STRONG -- hypertext STRONG item
      * STYLE -- hypertext STYLE element
      * SUB -- hypertext subscript
      * SUBSECTION -- hypertext SUBSECTION item
      * SUP -- hypertext superscript
      * TABLE -- hypertext table
      * TD -- hypertext TD element
      * TEX -- hypertext TEX item
      * TH -- hypertext TH element
      * TITLE -- hypertext title
      * TO -- hypertext documentation link
      * TO2 -- labeled hypertext documentation link
      * TOH -- hypertext documentation link followed by a headline
      * TR -- hypertext TR element
      * TT -- hypertext TT item
      * UL -- hypertext UL item
      * VAR -- hypertext VAR item
  * Functions and commands
      * M2CODE -- CODE object with syntax highlighting
      * "style" -- see style(Hypertext),
      * validate -- validate a hypertext object
  * Methods
      * html(TEX) -- conversion of $\TeX$ to html
      * "M2CODE(Thing)" -- see M2CODE, -- CODE object with syntax
        highlighting
      * options(MarkUpType)
      * show(Hypertext)
      * "show(TEX)" -- see show(Hypertext),
      * style(Hypertext)
      * "new TEX from BasicList" -- see TEX, -- hypertext TEX item
      * "new TEX from String" -- see TEX, -- hypertext TEX item
      * "new TO from Thing" -- see TO, -- hypertext documentation
        link
      * "new TOH from Thing" -- see TOH, -- hypertext documentation
        link followed by a headline
      * "validate(Hypertext)" -- see validate, -- validate a
        hypertext object

For the programmer
==================

The object Text, is a package (Macaulay2Doc).

BR -- line break
****************

Synopsis
========

  * Usage:
        BR{}

For the programmer
==================

The object BR, is a markup type, with ancestor
classes HypertextVoid (missing documentation) < Hypertext <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HR -- hypertext HR element (horizontal rule)
********************************************

Description
===========

+-----------------------------------------------------------------------------+
|i1 : DIV{"hi there", HR{}, "ho there" }                                      |
|                                                                             |
|o1 = hi there----------------------------------------------------------------|
|     --------ho there                                                        |
+-----------------------------------------------------------------------------+
|i2 : html oo                                                                 |
|                                                                             |
|o2 = <div>                                                                   |
|     hi there<hr>ho there</div>                                              |
+-----------------------------------------------------------------------------+

For the programmer
==================

The object HR, is a markup type, with ancestor
classes HypertextVoid (missing documentation) < Hypertext <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

Hypertext -- the class of markup lists used with hypertext
**********************************************************

Description
===========

Intended for internal use only.

Types of markup list :
======================

  * ANCHOR -- hypertext anchor
  * BOLD -- hypertext BOLD item
  * BUTTON (missing documentation)
  * CDATA -- hypertext CDATA element
  * CODE -- hypertext CODE item
  * COMMENT -- hypertext COMMENT element
  * EM -- hypertext EM item
  * ExampleItem -- a type of hypertext for holding example
    inputs awaiting outputs
  * HREF -- hypertext link
  * HypertextContainer -- the class of markup lists
    that can contain paragraphs
  * HypertextParagraph -- the class of markup lists
    that constitute separate paragraphs
  * HypertextVoid (missing documentation)
  * ITALIC -- hypertext italic font
  * KBD -- hypertext KBD item
  * LABEL -- hypertext label item
  * LATER -- a hypertext element for lazy evaluation
  * LITERAL -- hypertext literal text
  * SAMP -- hypertext SAMP item
  * SMALL -- hypertext SMALL item
  * SPAN -- hypertext span
  * STRONG -- hypertext STRONG item
  * SUB -- hypertext subscript
  * SUP -- hypertext superscript
  * TD -- hypertext TD element
  * TEX -- hypertext TEX item
  * TO -- hypertext documentation link
  * TO2 -- labeled hypertext documentation link
  * TOH -- hypertext documentation link followed by a headline
  * TT -- hypertext TT item
  * VAR -- hypertext VAR item

Functions and methods returning a markup list :
===============================================

  * arXiv (SimpleDoc) -- link to an arXiv article
  * hypertext (Macaulay2Doc) -- prepare hypertext for display
  * stacksProject (SimpleDoc) -- link to a Stacks Project
    tag
  * SYNOPSIS (Macaulay2Doc) -- a standardized synopsis for use
    in documentation nodes
  * wikipedia (SimpleDoc) -- link to a Wikipedia article

Methods that use a markup list :
================================

  * show(Hypertext)
  * style(Hypertext)
  * "validate(Hypertext)" -- see validate, -- validate a
    hypertext object

For the programmer
==================

The object Hypertext, is a type (Macaulay2Doc),
with ancestor classes BasicList (Macaulay2Doc), < Thing (Macaulay2Doc).

show(Hypertext)
***************

Synopsis
========

  * Function: show (Macaulay2Doc),
  * Usage:
        show x
  * Inputs:
      * x, a markup list, an instance of the type TEX,
        or a markup list,
  * Consequences:
      * displays x in the appropriate viewer

Ways to use this method:
========================

  * show(Hypertext)
  * "show(TEX)"

style(Hypertext)
****************

Synopsis
========

  * Function: style,
  * Usage:
        style (x,opts)
  * Inputs:
      * x, a markup list, hypertext (Macaulay2Doc),
  * Consequences:
      * Returns a new Hypertext object with its style option updated.

Description
===========

+---------------------------------------------+
|i1 : d = DIV { "Hello" }                     |
|                                             |
|o1 = Hello                                   |
+---------------------------------------------+
|i2 : d = style(d, "font-weight" => "bold")   |
|                                             |
|o2 = Hello                                   |
+---------------------------------------------+
|i3 : peek d                                  |
|                                             |
|o3 = DIV{"Hello", style => font-weight:bold;}|
+---------------------------------------------+

Ways to use this method:
========================

  * style(Hypertext)

validate -- validate a hypertext object
***************************************

Synopsis
========

  * Usage:
        validate x
  * Inputs:
      * x, a markup list, a hypertext object to validate
  * Outputs:
      * x, a markup list, the input hypertext object,
        possibly with errors fixed
  * Consequences:
      * The hypertext is checked for validity, to ensure that the HTML code
        returned by html validate x is valid.

Description
===========

This function is somewhat provisional.  In particular, it is hard to check
everything, because our hypertext format includes some entities of class
IntermediateMarkUpType, that don't correspond directly
to HTML.  Either those will have to be eliminated, or a more-final type of
hypertext, convertible immediately to HTML, will have to be developed.

Ways to use validate :
======================

  * "validate(Hypertext)"

For the programmer
==================

The object validate, is a method function (Macaulay2Doc).

ANCHOR -- hypertext anchor
**************************

Synopsis
========

  * Usage:
        ANCHOR{"id"=>u,p}
  * Inputs:
      * u, the name of the anchor
      * p, some hypertext
  * Consequences:
      * When converted to html (Macaulay2Doc), the phrase p will be
        enclosed in a hypertext anchor named u.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object ANCHOR, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

BOLD -- hypertext BOLD item
***************************

Synopsis
========

  * Usage:
        BOLD x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type BOLD,

Description
===========

BOLD x encloses x in a hypertext BOLD item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.  This corresponds to B in html format.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object BOLD, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

BUTTON
******

For the programmer
==================

The object BUTTON (missing documentation) is a markup type,
with ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

CDATA -- hypertext CDATA element
********************************

Description
===========

+--------------------------+
|i1 : html CDATA "hi there"|
|                          |
|o1 = <![CDATA[hi there]]> |
+--------------------------+

For the programmer
==================

The object CDATA, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

CODE -- hypertext CODE item
***************************

Synopsis
========

  * Usage:
        CODE x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type CODE,

Description
===========

CODE x encloses x in a hypertext CODE item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object CODE, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

COMMENT -- hypertext COMMENT element
************************************

Description
===========

+----------------------------+
|i1 : html COMMENT "hi there"|
|                            |
|o1 = <!--hi there-->        |
+----------------------------+

For the programmer
==================

The object COMMENT, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

EM -- hypertext EM item
***********************

Synopsis
========

  * Usage:
        EM x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type EM,

Description
===========

EM x encloses x in a hypertext EM item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object EM, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

ExampleItem -- a type of hypertext for holding example inputs awaiting outputs
******************************************************************************

For the programmer
==================

The object ExampleItem, is an intermediate markup type,
with ancestor classes Hypertext,
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HREF -- hypertext link
**********************

Synopsis
========

  * Usage:
        HREF{u,p}
        HREF{u}
  * Inputs:
      * u, a url
      * p, a phrase
  * Outputs:
      * an instance of the type HREF,

Description
===========

HREF{u,p} encloses the phrase p in a hypertext HREF link pointing to the URL u.
If p is omitted, then u is used as the phrase and as the URL.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HREF, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HypertextContainer -- the class of markup lists that can contain paragraphs
***************************************************************************

Description
===========

Mark-up lists of this type get special handling when converted to nets by
net (Macaulay2Doc), because the paragraphs must be collected and wrapped.

Types of markup list container :
================================

  * BODY -- hypertext BODY item
  * DIV -- a hypertext division
  * DL -- hypertext DL element
  * HEAD -- hypertext HEAD item
  * HTML -- hypertext item
  * INDENT (missing documentation)
  * LI -- hypertext list item
  * MENU -- hypertext menu item
  * OL -- hypertext OL item
  * TABLE -- hypertext table
  * TR -- hypertext TR element
  * UL -- hypertext UL item

For the programmer
==================

The object HypertextContainer, is a type (Macaulay2Doc),
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

BODY -- hypertext BODY item
***************************

Synopsis
========

  * Usage:
        BODY x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type BODY,

Description
===========

BODY x encloses x in a hypertext BODY item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object BODY, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

DIV -- a hypertext division
***************************

Synopsis
========

  * Usage:
        DIV x

Description
===========

This corresponds directly to an HTML DIV element.  It is sort of a
general-purpose container for top-level blocks, such as paragraphs, lists, and
tables.

For the programmer
==================

The object DIV, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

DL -- hypertext DL element
**************************

For the programmer
==================

The object DL, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HEAD -- hypertext HEAD item
***************************

Synopsis
========

  * Usage:
        HEAD x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEAD,

Description
===========

HEAD x encloses x in a hypertext HEAD item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEAD, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HTML -- hypertext item
**********************

Synopsis
========

  * Usage:
        HTML x
  * Inputs:
      * x
  * Outputs:
      * an instance of the type HTML, x enclosed in an HTML item

Description
===========

+-------------------------------------------------------+
|i1 : HTML { HEAD { TITLE "foo" }, BODY { "Hi there" } }|
|                                                       |
|o1 =                                                   |
|                                                       |
|     Hi there                                          |
+-------------------------------------------------------+
|i2 : html oo                                           |
|                                                       |
|o2 = <!DOCTYPE html>                                   |
|     <html lang="en">                                  |
|       <head>                                          |
|         <title>foo</title>                            |
|       </head>                                         |
|       <body>                                          |
|     Hi there  </body>                                 |
|                                                       |
|     </html>                                           |
+-------------------------------------------------------+

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HTML, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

INDENT
******

For the programmer
==================

The object INDENT (missing documentation) is an intermediate markup type,
with ancestor classes HypertextContainer,
< Hypertext < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

LI -- hypertext list item
*************************

Synopsis
========

  * Usage:
        LI x
  * Inputs:
      * x
  * Outputs:
      * an instance of the type LI,

Description
===========

Entries in a UL, list should be of type LI, but conversion
to type LI, is done automatically for the user.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object LI, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

MENU -- hypertext menu item
***************************

Description
===========

This hyeprtext item is intended to be used at most once per page, at the end.
When converted by info (Macaulay2Doc), it produces the Menu at the
end of the page.
+-----------------------------------------------------------------------------+
|i1 : DIV { PARA "Hi there.",                                                 |
|         MENU { "some topics", TO "topic a", TO "topic b", "more topics", TO |
|                                                                             |
|o1 = Hi there.                                                               |
|                                                                             |
|     Menu                                                                    |
|     ----                                                                    |
|                                                                             |
|     some topics                                                             |
|                                                                             |
|       * "topic a"                                                           |
|       * "topic b"                                                           |
|                                                                             |
|     more topics                                                             |
|                                                                             |
|       * "topic c"                                                           |
|-----------------------------------------------------------------------------|
|"topic c" } }                                                                |
+-----------------------------------------------------------------------------+
|i2 : info oo                                                                 |
|                                                                             |
|o2 = Hi there.                                                               |
|                                                                             |
|     * Menu:                                                                 |
|                                                                             |
|                                                                             |
|     some topics                                                             |
|     * topic a::                                                             |
|     * topic b::                                                             |
|                                                                             |
|     more topics                                                             |
|     * topic c::                                                             |
+-----------------------------------------------------------------------------+
|i3 : html ooo                                                                |
|                                                                             |
|o3 = <div>                                                                   |
|       <p>Hi there.</p>                                                      |
|       <div>                                                                 |
|         <h3>Menu</h3>                                                       |
|         <h4>some topics</h4>                                                |
|         <ul>                                                                |
|           <li>                                                              |
|     <span><span class="tt">topic a</span> (missing documentation)<!--tag:   |
|     </span>      </li>                                                      |
|           <li>                                                              |
|     <span><span class="tt">topic b</span> (missing documentation)<!--tag:   |
|     </span>      </li>                                                      |
|         </ul>                                                               |
|         <h4>more topics</h4>                                                |
|         <ul>                                                                |
|           <li>                                                              |
|     <span><span class="tt">topic c</span> (missing documentation)<!--tag:   |
|     </span>      </li>                                                      |
|         </ul>                                                               |
|       </div>                                                                |
|     </div>                                                                  |
|-----------------------------------------------------------------------------|
|topic a-->                                                                   |
|                                                                             |
|                                                                             |
|topic b-->                                                                   |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|topic c-->                                                                   |
+-----------------------------------------------------------------------------+

For the programmer
==================

The object MENU, is an intermediate markup type,
with ancestor classes HypertextContainer,
< Hypertext < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

OL -- hypertext OL item
***********************

Synopsis
========

  * Usage:
        OL x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type OL,

Description
===========

OL x encloses the list x as a hypertext OL itemized list.

The argument x should be a list of strings or hypertext items.

Here is an example. The expression
OL {"first","second","third"}
produces
  0. first
  1. second
  2. third

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

Functions and methods returning an object of class OL :
=======================================================

  * isc (OnlineLookup) -- ISC lookup
  * oeis (OnlineLookup) -- OEIS lookup

For the programmer
==================

The object OL, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

TABLE -- hypertext table
************************

Synopsis
========

  * Usage:
        TABLE x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type TABLE,

Description
===========

TABLE x produces a hypertext TABLE from a list of lists.

For the programmer
==================

The object TABLE, is a markup type, with
ancestor classes HypertextContainer, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

TR -- hypertext TR element
**************************

For the programmer
==================

The object TR, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

UL -- hypertext UL item
***********************

Synopsis
========

  * Usage:
        UL x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type UL,

Description
===========

UL x encloses the list x as a hypertext UL itemized list.

The argument x should be a list of strings or hypertext items.

Here is an example. The expression
UL {"first","second","third"}
produces
  * first
  * second
  * third

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object UL, is a markup type, with ancestor
classes HypertextContainer, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HypertextParagraph -- the class of markup lists that constitute separate paragraphs
***********************************************************************************

Description
===========

Intended for internal use only.

Types of markup list paragraph :
================================

  * BLOCKQUOTE -- hypertext BLOCKQUOTE item
  * DD -- hypertext DD element
  * DT -- hypertext DT element
  * HEADER1 -- hypertext HEADER1 item
  * HEADER2 -- hypertext HEADER2 item
  * HEADER3 -- hypertext HEADER3 item
  * HEADER4 -- hypertext HEADER4 item
  * HEADER5 -- hypertext HEADER5 item
  * HEADER6 -- hypertext HEADER6 item
  * PARA -- hypertext paragraph container
  * PRE -- preformatted text
  * SCRIPT -- hypertext SCRIPT element
  * STYLE -- hypertext STYLE element
  * SUBSECTION -- hypertext SUBSECTION item
  * TITLE -- hypertext title

For the programmer
==================

The object HypertextParagraph, is a type (Macaulay2Doc),
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

BLOCKQUOTE -- hypertext BLOCKQUOTE item
***************************************

Synopsis
========

  * Usage:
        BLOCKQUOTE x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type BLOCKQUOTE,

Description
===========

BLOCKQUOTE x encloses x in a hypertext BLOCKQUOTE item.

The argument x should be a string.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line. 1234   2345    4567
5678 34    345    3455       7

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object BLOCKQUOTE, is a markup type,
with ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

DD -- hypertext DD element
**************************

For the programmer
==================

The object DD, is a markup type, with ancestor
classes HypertextParagraph, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

DT -- hypertext DT element
**************************

For the programmer
==================

The object DT, is a markup type, with ancestor
classes HypertextParagraph, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

HEADER1 -- hypertext HEADER1 item
*********************************

Synopsis
========

  * Usage:
        HEADER1 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER1,

Description
===========

HEADER1 x encloses x in a hypertext HEADER1 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER1 "Interesting thing"
 produces the following header.

Interesting thing
*****************

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER1, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HEADER2 -- hypertext HEADER2 item
*********************************

Synopsis
========

  * Usage:
        HEADER2 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER2,

Description
===========

HEADER2 x encloses x in a hypertext HEADER2 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER2 "Interesting thing"
 produces the following header.

Interesting thing
=================

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER2, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HEADER3 -- hypertext HEADER3 item
*********************************

Synopsis
========

  * Usage:
        HEADER3 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER3,

Description
===========

HEADER3 x encloses x in a hypertext HEADER3 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER3 "Interesting thing"
 produces the following header.

Interesting thing
-----------------

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER3, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HEADER4 -- hypertext HEADER4 item
*********************************

Synopsis
========

  * Usage:
        HEADER4 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER4,

Description
===========

HEADER4 x encloses x in a hypertext HEADER4 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER4 "Interesting thing"
 produces the following header.

Interesting thing

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER4, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HEADER5 -- hypertext HEADER5 item
*********************************

Synopsis
========

  * Usage:
        HEADER5 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER5,

Description
===========

HEADER5 x encloses x in a hypertext HEADER5 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER5 "Interesting thing"
 produces the following header.

Interesting thing

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER5, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HEADER6 -- hypertext HEADER6 item
*********************************

Synopsis
========

  * Usage:
        HEADER6 x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER6,

Description
===========

HEADER6 x encloses x in a hypertext HEADER6 header item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
HEADER6 "Interesting thing"
 produces the following header.

Interesting thing

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object HEADER6, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

PARA -- hypertext paragraph container
*************************************

Synopsis
========

  * Usage:
        PARA x
  * Inputs:
      * x, a string (Macaulay2Doc), , a hypertext list (Macaulay2Doc),
  * Outputs:
      *  a hypertext (Macaulay2Doc), paragraph containing x

Description
===========

For an example, see hypertext list format (Macaulay2Doc).

For the programmer
==================

The object PARA, is a markup type, with ancestor
classes HypertextParagraph, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

PRE -- preformatted text
************************

Synopsis
========

  * Usage:
        PRE x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type PRE,

Description
===========

PRE x encloses x in a hypertext PRE item.

The argument x should be a string, possibly containing newlines.Here is an
example.

   1234   2345    4567    5678
     34    345    3455       7

If one wishes to use quotation marks in the preformatted text, then /// (Macaulay2Doc),
should be used instead of quotation marks as delimiters.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

Methods that use an object of class PRE :
=========================================

  * "EXAMPLE(PRE)" -- see EXAMPLE (Macaulay2Doc), -- hypertext
    EXAMPLE item

For the programmer
==================

The object PRE, is a markup type, with ancestor
classes HypertextParagraph, < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

SCRIPT -- hypertext SCRIPT element
**********************************

For the programmer
==================

The object SCRIPT, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

STYLE -- hypertext STYLE element
********************************

For the programmer
==================

The object STYLE, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

SUBSECTION -- hypertext SUBSECTION item
***************************************

Synopsis
========

  * Usage:
        SUBSECTION x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type HEADER2,

Description
===========

SUBSECTION x encloses x in a hypertext HEADER2 header item. It is often used in
the Mathematical Overview section of the documentation.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.  The code
SUBSECTION "Interesting thing"
 produces the following header.

Interesting thing
=================

See also
========

  * HEADER2 -- hypertext HEADER2 item
  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object SUBSECTION, is a markup type,
with ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

TITLE -- hypertext title
************************

Synopsis
========

  * Usage:
        TITLE x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type TITLE,

Description
===========

TITLE x encloses x in a hypertext TITLE item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object TITLE, is a markup type, with
ancestor classes HypertextParagraph, <
Hypertext < BasicList (Macaulay2Doc) <
Thing (Macaulay2Doc).

HypertextVoid
*************

Types of void markup :
======================

  * BR -- line break
  * HR -- hypertext HR element (horizontal rule)
  * IMG -- hypertext IMG item
  * INPUT (missing documentation)
  * LINK -- a hypertext LINK element
  * META -- a hypertext META element

For the programmer
==================

The object HypertextVoid (missing documentation) is a type (Macaulay2Doc),
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

ITALIC -- hypertext italic font
*******************************

Synopsis
========

  * Usage:
        ITALIC x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type ITALIC,

Description
===========

ITALIC x encloses x in a hypertext ITALIC item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.  The result corresponds to the html I command.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object ITALIC, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

KBD -- hypertext KBD item
*************************

Synopsis
========

  * Usage:
        KBD x
  * Inputs:
      * x, a thing (Macaulay2Doc),
  * Outputs:
      * an instance of the type KBD,

Description
===========

This HTML tag is used to define keyboard input.

+-------------------+
|i1 : html KBD "F11"|
|                   |
|o1 = <kbd>F11</kbd>|
+-------------------+

This is rendered in the browser as F11.

See also
========

  * SAMP -- hypertext SAMP item
  * VAR -- hypertext VAR item

For the programmer
==================

The object KBD, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

LABEL -- hypertext label item
*****************************

Synopsis
========

  * Usage:
        LABEL x
  * Inputs:
      * x
  * Outputs:
      * an instance of the type LABEL,

Description
===========

+----------------------------------+
|i1 : html LABEL { "b" }           |
|                                  |
|o1 = <label>b</label>             |
+----------------------------------+
|i2 : LABEL { "title" => "a", "b" }|
|                                  |
|o2 = b                            |
+----------------------------------+

For the programmer
==================

The object LABEL, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

LATER -- a hypertext element for lazy evaluation
************************************************

Synopsis
========

  * Usage:
        LATER {f}
  * Inputs:
      * f, a function (Macaulay2Doc),
  * Outputs:
      * an instance of the type LATER,

Description
===========

When the resulting hypertext element is processed later for conversion to html
or for printing, the function f will be evaluated (with no arguments) and the
hypertext it returns will be formatted.
+---------------------------------+
|i1 : f = () -> DIV { "hi there" }|
|                                 |
|o1 = f                           |
|                                 |
|o1 : FunctionClosure             |
+---------------------------------+
|i2 : LATER {f}                   |
|                                 |
|o2 = hi there                    |
+---------------------------------+
|i3 : peek oo                     |
|                                 |
|o3 = LATER{f}                    |
+---------------------------------+

For the programmer
==================

The object LATER, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

LITERAL -- hypertext literal text
*********************************

Synopsis
========

  * Usage:
        LITERAL x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type LITERAL,

Description
===========

LITERAL x produces a special hypertext item which contains HTML text that
should be left unchanged by html (Macaulay2Doc).

For the programmer
==================

The object LITERAL, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

SAMP -- hypertext SAMP item
***************************

Synopsis
========

  * Usage:
        SAMP x
  * Inputs:
      * x, a thing (Macaulay2Doc),
  * Outputs:
      * an instance of the type SAMP,

Description
===========

This HTML tag is used for sample output from a program

+-------------------------+
|i1 : html SAMP "ideal x" |
|                         |
|o1 = <samp>ideal x</samp>|
+-------------------------+

This is rendered in the browser as ideal x.

See also
========

  * KBD -- hypertext KBD item
  * VAR -- hypertext VAR item

For the programmer
==================

The object SAMP, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

SMALL -- hypertext SMALL item
*****************************

Synopsis
========

  * Usage:
        SMALL x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type SMALL,

Description
===========

SMALL x encloses x in a hypertext SMALL item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.

Here is some small text.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object SMALL, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

SPAN -- hypertext span
**********************

Synopsis
========

  * Usage:
        SPAN x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type SPAN,

Description
===========

SPAN x encloses x in a hypertext SPAN item.The argument x should be a string,
or a list or sequence of strings or hypertext items.  The result is that the
entries in the list or sequence are displayed sequentially.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object SPAN, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

STRONG -- hypertext STRONG item
*******************************

Synopsis
========

  * Usage:
        STRONG x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type STRONG,

Description
===========

STRONG x encloses x in a hypertext STRONG item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.

Here is strong text!

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object STRONG, is a markup type, with
ancestor classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

SUB -- hypertext subscript
**************************

Synopsis
========

  * Usage:
        SUB x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type SUB,

Description
===========

SUB x encloses x in a hypertext SUB item, thereby making it a subscript.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object SUB, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

SUP -- hypertext superscript
****************************

Synopsis
========

  * Usage:
        SUP x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type SUP,

Description
===========

SUP x encloses x in a hypertext SUP item, thereby making it a superscript.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object SUP, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

TD -- hypertext TD element
**************************

Types of TD :
=============

  * TH -- hypertext TH element

For the programmer
==================

The object TD, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

TH -- hypertext TH element
**************************

For the programmer
==================

The object TH, is a markup type, with ancestor
classes TD, < Hypertext < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

TEX -- hypertext TEX item
*************************

Synopsis
========

  * Usage:
        TEX x
  * Inputs:
      * x, a string (Macaulay2Doc), or a basic list (Macaulay2Doc),
  * Outputs:
      * an instance of the type TEX,

Description
===========

The constructor TEX x returns an object which may contain one or more $\LaTeX$
equations and matrices, several simple text formatting environments, as well as
other Hypertext, items. It is useful to use strings delimited
by /// (Macaulay2Doc), because in strings delimited by " (Macaulay2Doc),
the backslashes often used in $\LaTeX$ must be doubled. For
details on conversion to HTML see html(TEX).

See also
========

  * show(TEX)

Methods that use an object of class TEX :
=========================================

  * html(TEX) -- conversion of $\TeX$ to html
  * "show(TEX)" -- see show(Hypertext),
  * "new TEX from BasicList"
  * "new TEX from String"

For the programmer
==================

The object TEX, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

html(TEX) -- conversion of $\TeX$ to html
*****************************************

Synopsis
========

  * Function: html (Macaulay2Doc),
  * Usage:
        html t
  * Inputs:
      * t, an instance of the type TEX,
  * Outputs:
      * a string (Macaulay2Doc), a string containing the result
        of converting t to html

Description
===========

This method produces an HTML string, mainly converting several simple text
formatting environments, such as bold face, italics, etc. Rendering
mathematical characters and equations is done by $\KaTeX$ (see
https://katex.org/ ), a JavaScript math typesetting library for browsers. See
the list of supported functions and symbols (see
https://katex.org/docs/supported.html ) for more information, or this page (see
https://en.wikibooks.org/wiki/LaTeX/Mathematics ) for an introduction to math
mode in $\LaTeX$.

Equations in $..$ or \(...\) appear in inline mode, such as $x^2-1$, while
those in $$..$$ or \[...\] appear in display mode:$$\left(\!\begin{array}{cc}
x&z\\ y&w \end{array}\!\right).$$

In addition, {\bf ...}, {\em ...}, {\it ...}, {\tt ...}, and \url{...} are
converted to Hypertext, objects:

res(Module) is the method for making resolutions (see https://macaulay2.com).

Here are some examples designed to illustrate various other features of this
function when viewed in a browser:

+---------------------------+----------------------------------------------+
|$\Gamma\Omega\pi$          |$\Gamma\Omega\pi$                             |
+---------------------------+----------------------------------------------+
|$\partial\ell\infty$       |$\partial\ell\infty$                          |
+---------------------------+----------------------------------------------+
|$\Re\Im\aleph\beth$        |$\Re\Im\aleph\beth$                           |
+---------------------------+----------------------------------------------+
|$\NN\QQ\RR\CC\ZZ\PP$       |$\NN\QQ\RR\CC\ZZ\PP$                          |
+---------------------------+----------------------------------------------+
|$\binom{n}{k}$             |$\binom{n}{k}$                                |
+---------------------------+----------------------------------------------+
|$\sqrt[2]{\frac{a}{b}}$    |$\sqrt[2]{\frac{a}{b}}$                       |
+---------------------------+----------------------------------------------+
|$\sum\prod\coprod$         |$\sum\prod\coprod$                            |
+---------------------------+----------------------------------------------+
|$\bigoplus\bigotimes$      |$\bigoplus\bigotimes$                         |
+---------------------------+----------------------------------------------+
|$\bigcup\bigcap$           |$\bigcup\bigcap$                              |
+---------------------------+----------------------------------------------+
|$\bigvee\bigwedge$         |$\bigvee\bigwedge$                            |
+---------------------------+----------------------------------------------+
|$\int\oint\iint\iiint$     |$\int\oint\iint\iiint$                        |
+---------------------------+----------------------------------------------+
|$\oint\limits_{\partial M}$|$\oint\limits_{\partial M}$                   |
+---------------------------+----------------------------------------------+
|$\lim\limits_{x\to0}$      |$\lim\limits_{x\to0}$                         |
+---------------------------+----------------------------------------------+
|$\min\limits_{x\to\infty}$ |$\min\limits_{x\to\infty}$                    |
+---------------------------+----------------------------------------------+
|$\det\limits_{x\to0}$      |$\det\limits_{x\to0}$                         |
+---------------------------+----------------------------------------------+
|$\Pr\limits_{x\in\RR}$     |$\Pr\limits_{x\in\RR}$                        |
+---------------------------+----------------------------------------------+
|$\begin{pmatrix}           |$\begin{pmatrix} a & b \\ c & d \end{pmatrix}$|
| a & b \\                  |                                              |
| c & d                     |                                              |
|\end{pmatrix}$             |                                              |
+---------------------------+----------------------------------------------+
|$\begin{vmatrix}           |$\begin{vmatrix} a & b \\ c & d \end{vmatrix}$|
| a & b \\                  |                                              |
| c & d                     |                                              |
|\end{vmatrix}$             |                                              |
+---------------------------+----------------------------------------------+
+------------------+----------------------------------+
|$\mathnormal{...}$|$\mathnormal{ABCD \; abcd \; 123}$|
+------------------+----------------------------------+
|$\mathrm{...}$    |$\mathrm{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathit{...}$    |$\mathit{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathbf{...}$    |$\mathbf{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathsf{...}$    |$\mathsf{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathtt{...}$    |$\mathtt{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathfrak{...}$  |$\mathfrak{ABCD \; abcd \; 123}$  |
+------------------+----------------------------------+
|$\mathcal{...}$   |$\mathcal{ABCD \; abcd \; 123}$   |
+------------------+----------------------------------+
|$\mathbb{...}$    |$\mathbb{ABCD \; abcd \; 123}$    |
+------------------+----------------------------------+
|$\mathscr{...}$   |$\mathscr{ABCD \; abcd \; 123}$   |
+------------------+----------------------------------+
+--------------------+--------------------+
|$\underline{a}$     |$\underline{a}$     |
+--------------------+--------------------+
|$\hat{a}$           |$\hat{a}$           |
+--------------------+--------------------+
|$\widehat{a}$       |$\widehat{a}$       |
+--------------------+--------------------+
|$\tilde{a}$         |$\tilde{a}$         |
+--------------------+--------------------+
|$\widetilde{a}$     |$\widetilde{a}$     |
+--------------------+--------------------+
|$\stackrel\frown{a}$|$\stackrel\frown{a}$|
+--------------------+--------------------+
|$\check{a}$         |$\check{a}$         |
+--------------------+--------------------+
|$\breve{a}$         |$\breve{a}$         |
+--------------------+--------------------+
|$\bar{a}$           |$\bar{a}$           |
+--------------------+--------------------+
|$\grave{a}$         |$\grave{a}$         |
+--------------------+--------------------+
|$\acute{a}$         |$\acute{a}$         |
+--------------------+--------------------+
|$\dot{a}$           |$\dot{a}$           |
+--------------------+--------------------+
|$\ddot{a}$          |$\ddot{a}$          |
+--------------------+--------------------+
|$\not{a}$           |$\not{a}$           |
+--------------------+--------------------+
|$\mathring{a}$      |$\mathring{a}$      |
+--------------------+--------------------+
|$\vec{a}$           |$\vec{a}$           |
+--------------------+--------------------+
|$\overrightarrow{a}$|$\overrightarrow{a}$|
+--------------------+--------------------+
|$\overleftarrow{a}$ |$\overleftarrow{a}$ |
+--------------------+--------------------+
|$\overline{a}$      |$\overline{a}$      |
+--------------------+--------------------+

Lastly, new macros can be defined using script tags. For instance, inserting
the following LITERAL, item in the documentation defines the
structure sheaf:

LITERAL ///<script> macros["\\OO"] = "\\mathcal{O}" </script>///

The macro can be used at any point after: $$ 0 \to 2\OO_{\PP^3}(-3) \to
3\OO_{\PP^3}(-2) \to \OO_{\PP^3} \to \OO_C \to 0 $$

See also
========

  * tex (Macaulay2Doc) -- convert to $\TeX$ format
  * texMath (Macaulay2Doc) -- convert to TeX math format
  * show(TEX)

Ways to use this method:
========================

  * html(TEX) -- conversion of $\TeX$ to html

TO -- hypertext documentation link
**********************************

Synopsis
========

  * Usage:
        TO x
  * Inputs:
      * x, a documentation key
  * Outputs:
      * an instance of the type TO,

Description
===========

TO "x" produces a hypertext link to the documentation page labeled x.

See also hypertext (Macaulay2Doc).  The word hypertext in the
previous sentence is an example of the use of TO.

The special form TO {"x", "s"} produces a hypertext link to the page labeled x,
but with the string "s" appended to the string "x" at the point where the
reference occurs.  This form is needed because in some modes of output the link
is indicated with a section number in brackets.

The special form TO (f,X) produces a hypertext link to the page documenting the
method used for applying the function f to an argument of class X.  For more
arguments, use TO (f,X,Y) or TO (f,X,Y,Z).

The special form TO [f,X] produces a hypertext link to the page documenting the
optional argument named X for the function f.

If TO x is an entry in a UL, then it is treated as TOH x, and
headlines are added automatically.

See also
========

  * Key (Macaulay2Doc) -- key of a documentation node
  * TO2 -- labeled hypertext documentation link
  * TOH -- hypertext documentation link followed by a headline

Methods that use an object of class TO :
========================================

  * "new TO from Thing"

For the programmer
==================

The object TO, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

TO2 -- labeled hypertext documentation link
*******************************************

Synopsis
========

  * Usage:
        TO2 {x,p}
  * Inputs:
      * x, a documentation key
      * p, a phrase
  * Outputs:
      * an instance of the type TO2,

Description
===========

TO2 {x,"p"} produces a hypertext link labeled "p" to the documentation page
labeled x.

For the programmer
==================

The object TO2, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

TOH -- hypertext documentation link followed by a headline
**********************************************************

Synopsis
========

  * Usage:
        TOH x
  * Inputs:
      * x, a documentation key
  * Outputs:
      * an instance of the type TOH,

Description
===========

TOH "x" produces a hypertext link to the documentation page labeled x followed
by the Headline (Macaulay2Doc), for x.  If TO x is an entry in a
UL, then it is treated as TOH x, and headlines are added
automatically.

Methods that use an object of class TOH :
=========================================

  * "new TOH from Thing"

For the programmer
==================

The object TOH, is an intermediate markup type,
with ancestor classes Hypertext, <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

TT -- hypertext TT item
***********************

Synopsis
========

  * Usage:
        TT x
  * Inputs:
      * x,
  * Outputs:
      * an instance of the type TT,

Description
===========

TT x encloses x in a hypertext TT item.

The argument x should be a string, or a list or sequence of strings or
hypertext items.

Here is an example.

Here is a long line.  Here is a long line.  Here is a long line.  Here is a
long line.  Here is a long line.  Here is a long line.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object TT, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

VAR -- hypertext VAR item
*************************

Synopsis
========

  * Usage:
        VAR x
  * Inputs:
      * x, a thing (Macaulay2Doc),
  * Outputs:
      * an instance of the type VAR,

Description
===========

This HTML tag is used to represent a variable.

+-----------------+
|i1 : html VAR "x"|
|                 |
|o1 = <var>x</var>|
+-----------------+

This is rendered in the browser as x.

See also
========

  * KBD -- hypertext KBD item
  * SAMP -- hypertext SAMP item

For the programmer
==================

The object VAR, is a markup type, with ancestor
classes Hypertext, < BasicList (Macaulay2Doc)
< Thing (Macaulay2Doc).

IMG -- hypertext IMG item
*************************

Synopsis
========

  * Usage:
        IMG{x,y}
  * Inputs:
      * x,
      * y,
  * Outputs:
      * an instance of the type IMG,

Description
===========

IMG{"src" => x, "alt" => y} creates a hypertext IMG item.

The argument x should be a string containing the URL of the image, and y should
be a suitable string for the ALT attribute.

See also
========

  * hypertext (Macaulay2Doc) -- prepare hypertext for display

For the programmer
==================

The object IMG, is a markup type, with ancestor
classes HypertextVoid (missing documentation) < Hypertext <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

INPUT
*****

For the programmer
==================

The object INPUT (missing documentation) is a markup type,
with ancestor classes HypertextVoid (missing documentation) < Hypertext
< BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

LINK -- a hypertext LINK element
********************************

Synopsis
========

  * Usage:
        LINK x

Description
===========

This corresponds directly to an html LINK element.
+-----------------------------------------------------------------------------+
|i1 : html LINK { "title" => "Macaulay2", "rel" => "Top", "href" =>           |
|                                                                             |
|o1 = <link rel="Top" title="Macaulay2" href="index.html">                    |
|-----------------------------------------------------------------------------|
|"index.html" }                                                               |
+-----------------------------------------------------------------------------+

For the programmer
==================

The object LINK, is a markup type, with ancestor
classes HypertextVoid (missing documentation) < Hypertext <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).

M2CODE -- CODE object with syntax highlighting
**********************************************

Synopsis
========

  * Usage:
        M2CODE x
  * Inputs:
      * x, a thing (Macaulay2Doc),
  * Outputs:
      * an instance of the type CODE,

Description
===========

Returns a CODE object with its "class" attribute set to "language-macaulay2" so
that it will appear with syntax highlighting in the html documentation.  For
example,
M2CODE "ideal(x*z - y^2, y*w - z^2, x*w - y*z)"
 will appear as
ideal(x*z - y^2, y*w - z^2, x*w - y*z)

Ways to use M2CODE :
====================

  * "M2CODE(Thing)"

For the programmer
==================

The object M2CODE, is a method function (Macaulay2Doc).

MarkUpType -- the class of markup types used with hypertext
***********************************************************

Description
===========

Some markup types allow options (attributes) to be inserted in their html tags.
+-----------------------------------------------------------------------------+
|i1 : DIV ( "class" => "waystouse", SUBSECTION {"Ways to use ", TT            |
|             "There are many ways to use ", TO "resolution", "."             |
|             )                                                               |
|                                                                             |
|o1 = Ways to use resolution:                                                 |
|     =======================                                                 |
|                                                                             |
|     There are many ways to use "resolution".                                |
|-----------------------------------------------------------------------------|
|"resolution", ":"},                                                          |
+-----------------------------------------------------------------------------+
|i2 : html oo                                                                 |
|                                                                             |
|o2 = <div class="waystouse">                                                 |
|       <h2>Ways to use <span class="tt">resolution</span>:</h2>              |
|     There are many ways to use <a title="projective resolution"             |
|-----------------------------------------------------------------------------|
|href="/usr/share/doc/Macaulay2/Macaulay2Doc/html/_resolution.html">resolution|
|-----------------------------------------------------------------------------|
|</a>.</div>                                                                  |
+-----------------------------------------------------------------------------+

Types of markup type :
======================

  * IntermediateMarkUpType -- the class of
    intermediate markup types

Methods that use a markup type :
================================

  * options(MarkUpType)

Fixed objects of class MarkUpType :
===================================

  * ANCHOR -- hypertext anchor
  * BLOCKQUOTE -- hypertext BLOCKQUOTE item
  * BODY -- hypertext BODY item
  * BOLD -- hypertext BOLD item
  * BR -- line break
  * BUTTON (missing documentation)
  * CDATA -- hypertext CDATA element
  * CODE -- hypertext CODE item
  * COMMENT -- hypertext COMMENT element
  * DD -- hypertext DD element
  * DIV -- a hypertext division
  * DL -- hypertext DL element
  * DT -- hypertext DT element
  * EM -- hypertext EM item
  * ExampleItem -- a type of hypertext for holding example
    inputs awaiting outputs
  * HEAD -- hypertext HEAD item
  * HEADER1 -- hypertext HEADER1 item
  * HEADER2 -- hypertext HEADER2 item
  * HEADER3 -- hypertext HEADER3 item
  * HEADER4 -- hypertext HEADER4 item
  * HEADER5 -- hypertext HEADER5 item
  * HEADER6 -- hypertext HEADER6 item
  * HR -- hypertext HR element (horizontal rule)
  * HREF -- hypertext link
  * HTML -- hypertext item
  * IMG -- hypertext IMG item
  * INDENT (missing documentation)
  * INPUT (missing documentation)
  * ITALIC -- hypertext italic font
  * KBD -- hypertext KBD item
  * LABEL -- hypertext label item
  * LATER -- a hypertext element for lazy evaluation
  * LI -- hypertext list item
  * LINK -- a hypertext LINK element
  * LITERAL -- hypertext literal text
  * MENU -- hypertext menu item
  * META -- a hypertext META element
  * OL -- hypertext OL item
  * PARA -- hypertext paragraph container
  * PRE -- preformatted text
  * SAMP -- hypertext SAMP item
  * SCRIPT -- hypertext SCRIPT element
  * SMALL -- hypertext SMALL item
  * SPAN -- hypertext span
  * STRONG -- hypertext STRONG item
  * STYLE -- hypertext STYLE element
  * SUB -- hypertext subscript
  * SUBSECTION -- hypertext SUBSECTION item
  * SUP -- hypertext superscript
  * TABLE -- hypertext table
  * TD -- hypertext TD element
  * TEX -- hypertext TEX item
  * TH -- hypertext TH element
  * TITLE -- hypertext title
  * TO -- hypertext documentation link
  * TO2 -- labeled hypertext documentation link
  * TOH -- hypertext documentation link followed by a headline
  * TR -- hypertext TR element
  * TT -- hypertext TT item
  * UL -- hypertext UL item
  * VAR -- hypertext VAR item

For the programmer
==================

The object MarkUpType, is a type (Macaulay2Doc),
with ancestor classes SelfInitializingType (Macaulay2Doc),
< Type (Macaulay2Doc) <
MutableHashTable (Macaulay2Doc) < HashTable (Macaulay2Doc)
< Thing (Macaulay2Doc).

options(MarkUpType)
*******************

Synopsis
========

  * Function: options (Macaulay2Doc),

Description
===========

Optional arguments of mark up types allow attributes to be added to html
elements.
+--------------------------------------------------+
|i1 : DIV                                          |
|                                                  |
|o1 = DIV                                          |
|                                                  |
|o1 : MarkUpType                                   |
+--------------------------------------------------+
|i2 : options DIV                                  |
|                                                  |
|o2 = OptionTable{"accesskey" => null      }       |
|                 "class" => null                  |
|                 "contenteditable" => null        |
|                 "dir" => null                    |
|                 "draggable" => null              |
|                 "dropzone" => null               |
|                 "hidden" => null                 |
|                 "id" => null                     |
|                 "lang" => null                   |
|                 "onafterprint" => null           |
|                 "onbeforeprint" => null          |
|                 "onbeforeunload" => null         |
|                 "onblur" => null                 |
|                 "onchange" => null               |
|                 "onclick" => null                |
|                 "oncontextmenu" => null          |
|                 "ondblclick" => null             |
|                 "ondrag" => null                 |
|                 "ondragend" => null              |
|                 "ondragenter" => null            |
|                 "ondragleave" => null            |
|                 "ondragover" => null             |
|                 "ondragstart" => null            |
|                 "ondrop" => null                 |
|                 "onerror" => null                |
|                 "onfocusscript" => null          |
|                 "onhashchange" => null           |
|                 "oninputscript" => null          |
|                 "oninvalid" => null              |
|                 "onkeydown" => null              |
|                 "onkeypress" => null             |
|                 "onkeyup" => null                |
|                 "onload" => null                 |
|                 "onmessage" => null              |
|                 "onmousedown" => null            |
|                 "onmousemove" => null            |
|                 "onmouseout" => null             |
|                 "onmouseover" => null            |
|                 "onmouseup" => null              |
|                 "onmousewheel" => null           |
|                 "onoffline" => null              |
|                 "ononline" => null               |
|                 "onpagehide" => null             |
|                 "onpageshow" => null             |
|                 "onpopstate" => null             |
|                 "onresetscript" => null          |
|                 "onresize" => null               |
|                 "onscroll" => null               |
|                 "onsearch" => null               |
|                 "onselect" => null               |
|                 "onstorage" => null              |
|                 "onsubmit" => null               |
|                 "ontoggle" => null               |
|                 "onunload" => null               |
|                 "onwheel" => null                |
|                 "spellcheck" => null             |
|                 "style" => null                  |
|                 "tabindex" => null               |
|                 "title" => null                  |
|                 "translate" => null              |
|                 "xmlns" => null                  |
|                                                  |
|o2 : OptionTable                                  |
+--------------------------------------------------+
|i3 : d = DIV { "class" => "examples", "hi there" }|
|                                                  |
|o3 = hi there                                     |
+--------------------------------------------------+
|i4 : html d                                       |
|                                                  |
|o4 = <div class="examples">                       |
|     hi there</div>                               |
+--------------------------------------------------+
|i5 : net d                                        |
|                                                  |
|o5 = hi there                                     |
+--------------------------------------------------+

Ways to use this method:
========================

  * options(MarkUpType)

IntermediateMarkUpType -- the class of intermediate markup types
****************************************************************

Description
===========

An intermediate markup type is one that needs further processing to put it into
final form. A good example of one is TOH, which represents a link
to a documentation node, together with the headline of that node, which may not
have been created yet at the time the TOH, link is encountered.
Another example is HREF, which creates a link using the HTML <a>
element: when the link is created, the relative path to the target page depends
on the path to the page incorporating the link.

Fixed objects of class IntermediateMarkUpType :
===============================================

  * ExampleItem -- a type of hypertext for holding example
    inputs awaiting outputs
  * HREF -- hypertext link
  * INDENT (missing documentation)
  * LATER -- a hypertext element for lazy evaluation
  * LITERAL -- hypertext literal text
  * MENU -- hypertext menu item
  * TEX -- hypertext TEX item
  * TO -- hypertext documentation link
  * TO2 -- labeled hypertext documentation link
  * TOH -- hypertext documentation link followed by a headline

For the programmer
==================

The object IntermediateMarkUpType, is a
type (Macaulay2Doc), with ancestor classes MarkUpType,
< SelfInitializingType (Macaulay2Doc) < Type (Macaulay2Doc)
< MutableHashTable (Macaulay2Doc) <
HashTable (Macaulay2Doc) < Thing (Macaulay2Doc).

META -- a hypertext META element
********************************

Synopsis
========

  * Usage:
        META x

Description
===========

This corresponds directly to an html META element.
+-----------------------------------------------------------------------------+
|i1 : html META { "name" => "description",  "content" => "Dan Grayson's home  |
|                                                                             |
|o1 = <meta content="Dan Grayson's home page." name="description">            |
|-----------------------------------------------------------------------------|
|page." }                                                                     |
+-----------------------------------------------------------------------------+

For the programmer
==================

The object META, is a markup type, with ancestor
classes HypertextVoid (missing documentation) < Hypertext <
BasicList (Macaulay2Doc) < Thing (Macaulay2Doc).