next | previous | forward | backward | up | top | index | toc | Macaulay2 website
Macaulay2Doc > The Macaulay2 language > writing documentation > hypertext list format

hypertext list format

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. Macaulay2 examples may be included in the list using the EXAMPLE tag. See Text for the full list of hypertext types.

Each element of the list may be a text string, or one of the elements below. The following items are used by themselves:

  • BR -- line break
  • HR -- hypertext HR element (horizontal rule)

Items that take a text string (or other hypertext list) as argument:

  • HEADER1 -- hypertext HEADER1 item
  • HEADER2 -- hypertext HEADER2 item
  • HEADER3 -- hypertext HEADER3 item
  • HEADER4 -- hypertext HEADER4 item
  • HEADER5 -- hypertext HEADER5 item
  • HEADER6 -- hypertext HEADER6 item
  • HEADER2 -- hypertext HEADER2 item
  • PARA -- hypertext paragraph container
  • SPAN -- hypertext span
  • ITALIC -- hypertext italic font
  • TT -- hypertext TT item
  • EM -- hypertext EM item
  • PRE -- preformatted text
  • SUB -- hypertext subscript
  • SUP -- hypertext superscript

Items that place hyperlinks into the documentation:

  • HREF -- hypertext link
  • TO -- hypertext documentation link
  • TO2 -- labeled hypertext documentation link
  • TOH -- hypertext documentation link followed by a headline

Other useful hypertext elements:

  • OL -- hypertext OL item
  • UL -- hypertext UL item
  • LI -- hypertext list item
  • DL -- hypertext DL element
  • DT -- hypertext DT element
  • DD -- hypertext DD element
  • CODE -- hypertext CODE item
  • EXAMPLE -- hypertext EXAMPLE item

Example

For example, the hypertext list:

{  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{} }

when used as the input to document produces:

When referring to a Macaulay2 identifier such as matrix, use the TT element, or use a cross-reference, as in matrix. Incorporate Macaulay2 examples (during installPackage(String)) as illustrated here. 
i1 : matrix{{1,2},{3,4}}

o1 = | 1 2 |
     | 3 4 |

              2        2
o1 : Matrix ZZ  <--- ZZ

See also