doc/readme.lml

   1 ;;; -*- Mode: Lisp -*-
   2
   3 (in-package :lml)
   4
   5 (page readme
   6    (head
   7     (title "LML README")
   8     (meta-key :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1")
   9     (meta "Copyright" "Kevin Rosenberg 2002 <kevin@rosenberg.net>")
  10     (meta "description" "Lisp Markup Language Documentation")
  11     (meta "author" "Kevin Rosenberg")
  12     (meta "keywords" "Common Lisp, HTML, Markup Langauge"))
  13
  14    (body
  15     (h1 "LML Documentation")
  16     (h2 "Overview")
  17     (p [LML is a Common Lisp package for generating HTML and XHTML documents.
  18        LML is authored by
  19        ,(a :href "mailto:kevin@rosenberg.net" "Kevin Rosenberg"). The home page for LML is
  20        ,(a :href "http://lml.b9.com/" "http://www.b9.com/").])
  21
  22     (h2 "Installation")
  23     (p [The easiest way to install LML is to use the ,(a :href "http://www.debian.org/" "Debian")
  24        GNU/Linux operating system. You can then use the command ,(tt "apt-get install cl-lml")
  25        to automatically download and install the LML package.])
  26     (p [On a non-Debian system, you need to have either ,(a :href "http://cclan.sourceforge.net/" "ASDF")
  27            or ,(a :href "http://www.sourceforge.net/clocc/" "mk-defsystem")
  28        installed to load the system definition file. You will need to change the source
  29        pathname in the system file to match the location where you have installed LML.])
  30
  31     (h2 "Usage")
  32     (p [Currently, there is no documentation on the functions provided by LML. However, the source code is
  33                    instructive and there are example files included in the LML package.])
  34
  35     (h2 "Examples")
  36     (table :border 1 :cellpadding 3
  37      (tbody
  38       (tr
  39        (td :colspan 2 :style "color:#000;background-color:#ccc;font-weight:bold;" "Iteration"))
  40       (tr
  41        (td
  42         (pre
  43 "(i \"The square of the first five integers are)\"
  44  (b
  45    (loop as x from 1 to 5
  46      doing
  47      (lml-print \" ~D\" (* x x))))"))
  48        (td
  49         (i "The square of the first five integers are")
  50         (b
  51          (loop as x from 1 to 5
  52                doing
  53                (lml-print " ~D" (* x x))))))
  54       ))
  55     (hr)
  56     (p [View this page's ,(a :href "readme.lml" "source").])
  57       ))