doc/readme.lml

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