YstokHTML

YstokHTML is a collection of Common Lisp libraries for generating and parsing HTML and XHTML documents. YstokHTML is based on:

• HTMLGen and PHTML by Franz, Inc.,
• LML2 by Kevin Rosenberg,
• HTML-TEMPLATE by Edi Weitz.

All the libraries are based on effective algorithms not relying on regular expression functions.

Prerequisites and options

• Ystok-Library, obligatory.
• Our version of ACL-Compat, which is only needed for the YstokHTML parser.
• Ystok-URI, optional; if included, YstokHTML exports more utility functions.

LHTML - Lisp markup language for HTML

Both the YstokHTML generator and parser support the LHTML, the S-expression language used by the Franz's HTMLGen facility. Recently, Peter Seibel has described the FOO HTML, a similar generator syntax, in his book Practical Common Lisp.

Differences between YstokHTML and HTMLGen

• Renamed html macro to htm (a la Edi Weitz's CL-WHO).
• YstokHTML is XHTML compatible with close tags so that (htm :hr) can produce '<hr>' or '<hr />' depending on *html-mode*. Whether print-html-... functions produce XHTML termination '/>' also depends on *html-mode*.
• Lowercase tag names when *html-mode* is :xml.
• Lowercase attribute names when *html-mode* is :xml or *attribute-case* is :downcase; so (htm ((:p class 'a))) produces '<p class="a"></p>'.
• Added new tags :include, :nbsp, :jscript, :format, :format-safe, :!doctype, :?xml.
• Added new custom tag :escape, which invokes full-fledged html-template:escape-string and escapes not only four characters, but all satisfying template:*escape-char-p*.
• Added special attribute tag :optional, which is similar to :if*.
• Automatic conversion attribute values to strings (quoting).
• Removal of the if* macro from the htmlgen.lisp source code.
• Renamed html-process to descriptor:
  • it is of a "normal" structure type now, not of type list;
  • slot name-attrs renamed to name-attr;
  • added slot uri-attrs specifying a list of attributes of type URI.
• Function prin1-safe-http-string replaced by generic prin1-attribute-value of signature:
   (val &optional stream).
• Changed html-print-list and html-print signature:
   (form &optional stream).
• def-std-html now defines a macro named as follows:
  • either a symbol explicitly passed as an optional macro-name argument,
  • or by default (intern "key") instead of (intern "WITH-HTML-key"), produced by the Franz's HTMLGen.
• Owing to calls of attribute-name-string and prin1-attribute-value, now html-standard-print generates HTML close to what is produced by the htm macro.

Download and installation

yhtml-0-3-006.zip
76KB

YstokHTML is available from http://lisp.ystok.ru/yhtml/yhtml-0-3-006.zip. The distribution package contains both the ASDLite/ASDF file yhtml.asd and the LispWorks system definition file defsys.lisp.

Here is change.log.

Documentation

Currently, there is no documentation on YstokHTML other than for the HTMLGen and PHTML mentioned above. However, the source code is instructive and there are the demonstration file html-examples.lisp and the test cases file phtml-test.lisp in the distribution package.

If you fail to grab the original documentation at Franz's website, try our local copies htmlgen.html and phtml.htm.

Examples

(html:with-html-stream (*standard-output*)
  ((:table :border 2)
   (:tr ((:th :colspan 2)
         (:i "The square of four integers")))
   (dotimes (i 4)
     (html:htm
      (:tr (:td (:princ i))
           (:td (:b (:princ (* i i))))))))

See also

• YHTML-Template,
• BBcode.