/usr/share/doc/smlnj-doc/mlrisc/mltex.html is in smlnj-doc 110.79-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- Generated by mltex2html -->
<!-- do not edit this file -->
<html>
<head>
<title> MLT<sub>E</sub>X </title>
</head>
<body bgcolor="#ffffff" text="#000020"
link="navy" vlink="gray" alink="maroon">
<table border=0>
<tr>
<td width=2> </td>
<td valign=top align=left>
<center><h1><font color="#486591"><b>MLT<sub>E</sub>X</b></font></h1></center>
<hr>
<!-- table of contents -->
<table cellpadding=0 cellspacing=0 border=0 align=right bgcolor="#e6e6e6">
<tr><td>
</td></tr><tr><td>
<table bgcolor="#486591" width="100%" border=0
cellpadding=0 cellspacing=0>
<tr><td align=center><font color="ffffff">
MLT<sub>E</sub>X
</font>
</td></tr></table><tr><td>
<a href="#link0000"><font size="-1" color="#486591">Macros</font></a><br>
<a href="#link0001"><font size="-1" color="#486591">Other Stuff</font></a><br>
<a href="#link0002"><font size="-1" color="#486591">Bugs and Shortcomings</font></a><br>
</td></tr>
</table>
<!-- end of table of contents -->
<font color="#ff0000">MLT<sub>E</sub>X</font> is a special <font color="#ff0000">L<sup>A</sup>T<sub>E</sub>X</font> package for writing
MLRISC documentation. It is similar to the
<font color="#ff0000">latex2html</font><cite>[latex2html]</cite> tool
except that MLT<sub>E</sub>X has special environments for documenting
Standard ML code. In addition, there is an accompanying tool
called <font color="#ff0000">mltex2html</font> for generating HTML pages.
This page, for example, is formatted by MLT<sub>E</sub>X.
<p>
<a name="link0000"></a>
<h2><font color="#486591">Macros</font></h2>
Environments defined in MLT<sub>E</sub>X are:
<dl>
<dt><font color="#000070">SML</font><dd> This environment is used to display MLRISC code.
For example,
<font color="#000000"><small><pre>
\begin{SML}
datatype 'a tree =
EMPTY
| LEAF of 'a
| NODE of 'a * 'a tree * 'a tree
\end{SML}
</pre></small></font>
generates:
<font color="#000000"><small><pre>
<font color="#6060a0"><b>datatype</b></font> <font color="#00aaaa">'a</font> tree =
EMPTY
| LEAF <font color="#6060a0"><b>of</b></font> <font color="#00aaaa">'a</font>
| NODE <font color="#6060a0"><b>of</b></font> <font color="#00aaaa">'a</font> * <font color="#00aaaa">'a</font> tree * <font color="#00aaaa">'a</font> tree
</pre></small></font>
<dt><font color="#000070">methods</font><dd> This environment can be used to document a list of
methods to an interface. For example,
<font color="#000000"><small><pre>
\begin{methods}
\sml{+ : int * int -> int} & addition \\
\sml{- : int * int -> int} & subtraction \\
\sml{* : int * int -> int} & multiplication \\
\sml{/ : int * int -> int} & division \\
\end{methods}
</pre></small></font>
generates:
<dl><dt><tt>
<tt>+ : int * int -> int</tt> </tt><dd> addition <dt><tt>
<tt>- : int * int -> int</tt> </tt><dd> subtraction <dt><tt>
<tt>* : int * int -> int</tt> </tt><dd> multiplication <dt><tt>
<tt>/ : int * int -> int</tt> </tt><dd> division <dt><tt>
</tt></dl>
</dl>
<p>
Macros defined in MLT<sub>E</sub>X are:
<dl>
<dt><font color="#000070">sml</font><dd> This macro can be used inline for formating SML code fragment.
For example the fragment
<font color="#000000"><small><pre>
\begin{quotation}
\begin{tabular}{l}
\sml{val toString : int -> string} \\
\sml{val map : ('a -> 'b) -> 'a list -> 'a list}
\end{tabular}
\end{quotation}
</pre></small></font>
is formated as:
<blockquote>
<table border=0 align=center><tr><td align=left>
<tt><font color="#6060a0"><b>val</b></font> toString : int -> string</tt> </tr><tr><td align=left>
<tt><font color="#6060a0"><b>val</b></font> map : (<font color="#00aaaa">'a</font> -> <font color="#00aaaa">'b</font>) -> <font color="#00aaaa">'a</font> list -> <font color="#00aaaa">'a</font> list</tt>
</td></tr></table>
</blockquote>
<dt><font color="#000070">href</font><dd> This macro generates a html hypertext link to a
page within the same logical document. For example, we can say
<font color="#000000"><small><pre>
\href{url}{text}
</pre></small></font>
<dt><font color="#000070">mlrischref</font><dd> This macro generates a html hypertext link to MLRISC
code. The general syntax is:
<font color="#000000"><small><pre>
\mlrischref{path}{text}
</pre></small></font>
The <tt>path</tt> parameter is a relative path in the MLRISC hierarchy.
<dt><font color="#000070">externhref</font><dd>
This macro generates an external hypertext link to a document outside
of the same logical document. The general syntax is:
<font color="#000000"><small><pre>
\externhref{url}{text}
</pre></small></font>
<dt><font color="#000070">newdef</font><dd> This macro defines a new term. The general syntax is
<font color="#000000"><small><pre>
\newdef{text}
</pre></small></font>
</dl>
<p>
<a name="link0001"></a>
<h2><font color="#486591">Other Stuff</font></h2>
In addition to the above, MLT<sub>E</sub>X understands the following L<sup>A</sup>T<sub>E</sub>X
environments and macros, and will translate them into HTML equivalents.
<font color="#000000"><small><pre>
\begin{itemize} \end{itemize}
\begin{description} \end{description}
\begin{enumerate} \end{enumerate}
\verb
\begin{tabular} \end{tabular}
\begin{figure} \end{figure} \caption
\begin{wrapfigure} \end{wrapfigure}
\section \subsection \subsubsection \paragraph
\ref \label
\noindent \linebreak
\psfig
</pre></small></font>
<a name="link0002"></a>
<h2><font color="#486591">Bugs and Shortcomings</font></h2>
There are too many to list. But the things to watch for are:
<ul>
<li> A macro and all its arguments must appear in the same line.
<li> The tool can get confused if too many macros appear on the same line.
<li> Nesting of macros may not be handled correctly.
<li> Math mode is not robust.
</ul>
<p>
Please send bug fixes and comments to
<a href="mailto:leunga@cs.nyu.edu">Allen Leung</a>.
<hr>
<table cellpadding=0 cellspacing=0 width="100%">
<tr>
<td align=left>
<table>
<tr><td><font size="-1">
<a href="mailto:george@research.bell-labs.com">Lal George</a>
</font></td></tr>
<tr><td><font size="-1">
<a href="mailto:leunga@cs.nyu.edu">Allen Leung</a>
</font></td></tr>
</table>
</td>
<td align=right>
<a href="http://cm.bell-labs.com/cm/cs/what/smlnj/index.html">
<img src="graphics/smlnj.jpg" width=80 height=50
alt="SML/NJ" border=0>
</a>
<a href="http://validator.w3.org/check?url=http://www.cs.nyu.edu/leunga/MLRISC/Doc/html/">
<img src="graphics/vh401.gif" width=88 height=31
alt="Validate this page" border=0>
</a>
</td>
</tr>
<tr> <td align=left>
<font size="-1">
<i> Generated by
<a href="mltex.html">
<font color="#007777">mltex2html</font>
</a>
</i>
</font>
</td>
</tr>
<tr> <td>
<font size="-2">
Last modified: Tue Aug 8 23:22:30 UTC 2017 by buildd@lcy01-08
</font>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>
|