From 3e2b38a582f3b17eb3d80aa828f8f078b0a1f976 Mon Sep 17 00:00:00 2001 From: "Kevin M. Rosenberg" Date: Mon, 16 Sep 2002 06:07:02 +0000 Subject: [PATCH] r2692: *** empty log message *** --- README | 3 --- doc/Makefile | 10 +++++++++ doc/make.cl | 5 +++++ doc/readme.html | 6 ++++++ doc/readme.lml | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 77 insertions(+), 3 deletions(-) delete mode 100644 README create mode 100644 doc/Makefile create mode 100644 doc/make.cl create mode 100644 doc/readme.html create mode 100644 doc/readme.lml diff --git a/README b/README deleted file mode 100644 index f9a0da1..0000000 --- a/README +++ /dev/null @@ -1,3 +0,0 @@ -LML is a Common Lisp package for generating HTML and XHTML documents. - -The home page for LML is http://lml.b9.com/ diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..dadee61 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,10 @@ +.PHONY: site all clean + +all: site + +site: + lisp -init `pwd`/make.cl + +clean: + @rm -f *~ \#*\# .\#* memdump + diff --git a/doc/make.cl b/doc/make.cl new file mode 100644 index 0000000..5f06b4b --- /dev/null +++ b/doc/make.cl @@ -0,0 +1,5 @@ +(require :lml) +(in-package :lml) +(let ((cwd (parse-namestring (lml-cwd)))) + (process-dir cwd)) +(lml-quit) diff --git a/doc/readme.html b/doc/readme.html new file mode 100644 index 0000000..57ccaaf --- /dev/null +++ b/doc/readme.html @@ -0,0 +1,6 @@ + + +LML README

LML Documentation

Overview

LML is a Common Lisp package for generating HTML and XHTML documents. LML is authored by Kevin Rosenberg. The home page for LML is http://www.b9.com/.

Installation

The easiest way to install LML is to use the Debian GNU/Linux operating system. You can then use the command apt-get install cl-lml to automatically download and install the LML package.

On a non-Debian system, you need to have either ASDF or mk-defsystem 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.

Usage

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.

Examples

Iteration
"The square of the first five integers are"
+  (loop as x from 1 to 5 
+      doing
+      (lml-print " ~D" (* x x)))
1 4 9 16 25
\ No newline at end of file diff --git a/doc/readme.lml b/doc/readme.lml new file mode 100644 index 0000000..f43c809 --- /dev/null +++ b/doc/readme.lml @@ -0,0 +1,56 @@ +;;; -*- Mode: Lisp -*- + +(in-package :lml) + +(page readme + (head + (title "LML README") + (meta-key :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1") + (meta "Copyright" "Kevin Rosenberg 2002 ") + (meta "description" "Lisp Markup Language Documentation") + (meta "author" "Kevin Rosenberg") + (meta "keywords" "Common Lisp, HTML, Markup Langauge")) + + (body + (h1 "LML Documentation") + (h2 "Overview") + (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") ". " + "The home page for LML is " + (a :href "http://lml.b9.com/" "http://www.b9.com/") ".") + + (h2 "Installation") + (p "The easiest way to install LML is to use the " + (a :href "http://www.debian.org/" "Debian") + " GNU/Linux operating system. You can then use the command " + (tt "apt-get install cl-lml") + " to automatically download and install the LML package.") + (p "On a non-Debian system, you need to have either " + (a :href "http://cclan.sourceforge.net/" "ASDF") " or " + (a :href "http://www.sourceforge.net/clocc/" "mk-defsystem") + " 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.") + + (h2 "Usage") + (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.") + + (h2 "Examples") + (table + (tbody :border 1 + (tr + (td :colspan 2 :style "color:000;background-color:ccc;font-weight:bold;" "Iteration")) + (tr + (td + (pre +"\"The square of the first five integers are\" + (loop as x from 1 to 5 + doing + (lml-print \" ~D\" (* x x)))")) + (td + (loop as x from 1 to 5 + doing + (lml-print " ~D" (* x x))))) + )))) -- 2.34.1