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. Math support is currently rudimentary. Macaulay 2 examples may be included in the list
Each element of the list may be a text string, or one of the elements below.The following items are used by themselves
- BR -- break to the next line
- HR -- a horizontal rule (line)
- PARA -- hypertext paragraph container
Items which take a text string (or other hypertext list) as argument
- TT s -- makes the argument s into a typewriter like, fixed font
- EM s -- change the font of s to emphasize it
- PRE s -- considers the string s to be preformatted.
- SUB s -- subscript
- SUP s -- superscript
Items which place hyperlinks into the documentation
- TO -- hypertext documentation link
- TOH -- hypertext documentation link followed by a headline
- TO2 -- labeled hypertext documentation link
Other useful hypertext elements
- UL -- hypertext UL item
- EXAMPLE -- hypertext EXAMPLE item
Example
For example, the hypertext list
{
hr,
"When referring to a ",
EM "Macaulay 2",
" identifier such as ",
TT "matrix",
", use the TT element, or use a cross-reference, as in ",
TO matrix,
". Incorporate ",
EM "Macaulay 2",
" examples (during ",
TO (installPackage,String),
") as illustrated here.",
EXAMPLE "matrix{{1,2},{3,4}}",
hr
}
when used in a
document node, produces
When referring to a
Macaulay 2 identifier such as
matrix, use the TT element, or use a cross-reference, as in
matrix. Incorporate
Macaulay 2 examples (during
installPackage(String)) as illustrated here.
i1 : matrix{{1,2},{3,4}}
o1 = | 1 2 |
| 3 4 |
2 2
o1 : Matrix ZZ <--- ZZ
|