X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Freadme.lml;h=935092e560bfcf1f3ecc43c9e5dd63a9dacdcbf7;hb=1edc90cebe4ab0e2804ebe6a7c73599dc5690658;hp=f43c809de00b3f00b52c08b7dd076a265313a2d7;hpb=3e2b38a582f3b17eb3d80aa828f8f078b0a1f976;p=lml.git diff --git a/doc/readme.lml b/doc/readme.lml index f43c809..935092e 100644 --- a/doc/readme.lml +++ b/doc/readme.lml @@ -14,43 +14,44 @@ (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/") ".") + (p [,(a :href "http://lml.b9.com" "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://lml.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.") + (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.") + (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 + (table :border 1 :cellpadding 3 + (tbody (tr - (td :colspan 2 :style "color:000;background-color:ccc;font-weight:bold;" "Iteration")) + (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)))")) +"(i \"The square of the first five integers are)\" + (b + (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))))) - )))) + (i "The square of the first five integers are") + (b + (loop as x from 1 to 5 + doing + (lml-print " ~D" (* x x)))))) + )) + (hr) + (p [View this page's ,(a :href "http://lml.b9.com/" "LML") ,(a :href "readme.lml" "source").]) + ))