r2692: *** empty log message ***
[lml.git] / doc / readme.html
1 <?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml"><head><title>LML README</title><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"></meta><meta content="Kevin Rosenberg 2002 <kevin@rosenberg.net>" name="Copyright"></meta><meta content="Lisp Markup Language Documentation" name="description"></meta><meta content="Kevin Rosenberg" name="author"></meta><meta content="Common Lisp, HTML, Markup Langauge" name="keywords"></meta></head><body><h1>LML Documentation</h1><h2>Overview</h2><p>LML is a Common Lisp package for generating HTML and XHTML documents. LML is authored by <a href="mailto:kevin@rosenberg.net">Kevin Rosenberg</a>. The home page for LML is <a href="http://lml.b9.com/">http://www.b9.com/</a>.</p><h2>Installation</h2><p>The easiest way to install LML is to use the <a href="http://www.debian.org/">Debian</a> GNU/Linux operating system. You can then use the command <tt>apt-get install cl-lml</tt> to automatically download and install the LML package.</p><p>On a non-Debian system, you need to have either <a href="http://cclan.sourceforge.net/">ASDF</a> or <a href="http://www.sourceforge.net/clocc/">mk-defsystem</a> installed to load the system definition file. You will need to change the source pathname in the system file to match the location where you have installed LML.</p><h2>Usage</h2><p>Currently, there is no documentation on the functions provided by LML. However, the source code is instructive and there are example files included in the LML package.</p><h2>Examples</h2><table><tbody border="1"><tr><td style="color:000;background-color:ccc;font-weight:bold;" colspan="2">Iteration</td></tr><tr><td><pre>"The square of the first five integers are"
4   (loop as x from 1 to 5 
5       doing
6       (lml-print " ~D" (* x x)))</pre></td><td> 1 4 9 16 25</td></tr></tbody></table></body></html>