Macaulay2 » Documentation
Packages » Text :: Text
next | previous | forward | backward | up | index | toc

Text -- documentation and hypertext

Description

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

Version

This documentation describes version 0.0 of Text.

Citation

If you have used this package in your research, please cite it as follows:

@misc{TextSource,
  title = {{Text: documentation and hypertext. Version~0.0}},
  author = {},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/master/M2/Macaulay2/packages}}
}

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
  • 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, defined in Text.m2.

The source of this document is in Text.m2:30:0.