1ecccadf53f22f09b02938bffbb4cf9044f8d14d
[lml.git] / doc / readme.html
1 <?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.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 name="Copyright" content="Kevin Rosenberg 2002 <kevin@rosenberg.net>" /><meta name="description" content="Lisp Markup Language Documentation" /><meta name="author" content="Kevin Rosenberg" /><meta name="keywords" content="Common Lisp, HTML, Markup Langauge" /></head><body><h1>LML Documentation</h1><h2>Overview</h2><p><a href="http://lml.b9.com">LML</a> is a Common Lisp package for generating HTML and XHTML documents. 
4        LML is authored by 
5        <a href="mailto:kevin@rosenberg.net">Kevin Rosenberg</a>. The home page for LML is
6        <a href="http://lml.b9.com/">http://lml.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>
7        GNU/Linux operating system. You can then use the command <tt>apt-get install cl-lml</tt>
8        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>
9            or <a href="http://www.sourceforge.net/clocc/">mk-defsystem</a>
10        installed to load the system definition file. You will need to change the source 
11        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
12                    instructive and there are example files included in the LML package.</p><h2>Examples</h2><table border="1" cellpadding="3"><tbody><tr><td colspan="2" style="color:#000;background-color:#ccc;font-weight:bold;">Iteration</td></tr><tr><td><pre>(i "The square of the first five integers are)"
13  (b
14    (loop as x from 1 to 5 
15      doing
16      (lml-format " ~D" (* x x))))</pre></td><td><i>The square of the first five integers are</i><b> 1 4 9 16 25</b></td></tr></tbody></table><hr /><p>View this page's <a href="http://lml.b9.com/">LML</a> <a href="readme.lml">source</a>.</p></body></html>