Permalink
Switch branches/tags
release10.1_t6 release10.1_t5 release10.1_t4 release10.1_t3 release10.1_t2 release10.1_t1 release10.1_release_point release10.1_rc5 release10.1_rc4 release10.1_rc3 release10.1_rc2 release10.1_rc1 release10.1_beta3_release_point release10.1.beta2_release_point release10.1.beta_t6 release10.1.beta_t5 release10.1.beta_t4 release10.1.beta_t3 release10.1.beta_t2 release10.1.beta_t1 release10.1.beta_release_point release10.1.beta_rc4 release10.1.beta_rc3 release10.1.beta_rc2 release10.1.beta_rc1 release10.0_t3 release10.0_t2 release10.0_t1 release10.0_rc9 release10.0_rc8 release10.0_rc7 release10.0_rc6 release10.0_rc5 release10.0_rc4 release10.0_rc3 release10.0_rc2 release10.0_rc1 release10.0.pre-final.30_release_point release10.0.pre-final.17_release_point release10.0.beta_t13 release10.0.beta_t12 release10.0.beta_t11 release10.0.beta_t10 release10.0.beta_t9 release10.0.beta_t8 release10.0.beta_t7 release10.0.beta_t6 release10.0.beta_t5 release10.0.beta_t4 release10.0.beta_t3 release10.0.beta_t2 release10.0.beta_t1 release10.0.beta_release_point release10.0.beta_rc2 release10.0.beta_rc1 release_aclt2 release_acl100b14t8 release_acl100b11t7 release_acl100b10t6 release_acl100b8t5 release_acl100b7t4 release_acl100b6t3 release_acl100b4t2 release_acl100b2t1 release_acl90b21rc5 release_acl90b20_release_point release_acl90b20rc4 release_acl90b19rc3 release_acl90b18rc2 release_acl90b15_release_point release_acl90b15rc1 release_acl90b13t1 release_acl90b11t1 release_acl90b9t1 release_acl90b8t1 release_acl90b6_release_point release_acl90b6rc2 release_acl90b_release_point release_acl90a52rc1 release_acl90a44rc2 release_acl90a43rc1 release_acl90a39 release_acl90a39rc2 release_acl90a32 release_acl90a27 release_acl90a25 release_acl90a24 release_acl90a23 release_acl90a20 release_acl90a18 documentation_for_acl90_201200717 documentation_for_acl90_20120614 documentation_for_acl90b_20120323 documentation_for_acl90b_20120313 documentation_for_acl90b_20120214 documentation_for_acl10.1_20170309 documentation_for_acl10.1b_20160928 documentation_for_acl10.0_20150813 acl100express_Dec2015update1202_rc1 acl100express_Aug2016update081516_rc1
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
121 lines (88 sloc) 3.35 KB

net-xml-generator - A Pretty Printing XML Generator for Common Lisp

Table of contents

  • Description
  • Author
  • Author comments
  • Documentation
  • Platforms
  • Dependencies
  • Installation
  • Configuration
  • Licence
  • Notes
  • Examples
  • Franz Inc. Open Source Info

Description

This module consists of a single source file net-xml-generator.cl.

It provides a modified readtable that allows normal Lisp source code to contain possibly-nested marked subforms that emit an XML element. The tree that is Lisp source code integrates transparently with the tree that is the intended XML, and the entire panoply of Lisp operators (iteration, special forms, function calls) can be mixed with XML generation. The Lisp code that emits XML has a structure paralleling the XML.

The Common Lisp pretty printer is optionally used to indent the emitted XML for human readability. See the file xml-generator-blurb.html distributed along with this module for a gentle introduction, and xml-generator-blurb.cl which shows how that html file was itself generated using the module.

Author

Steven Haflich, Franz Inc.

Author comments

Platforms

All Allegro Common Lisp versions. It mostly should work on other implementations, but uses the ACL named-readtable facility (which could trivially be added to any other implementation) and more importantly may depend on subtle details of the pretty printer.

Dependencies

Allegro Common Lisp

The Allegro Common Lisp excl:named-readtable facility.

Installation

Start your lisp and compile and load net-xml-generator.cl which is part of this project:

(load (compile-file "/path/to/your/net-xml-generator.cl")

To test,

(load "/path/to/your/xml-generator-blurb.cl")
(generate-this-page :out-path "./xml-generator-blurb-copy.html" )

and that named file will be generated which should be an exact copy of xml-generator-blurb.html

Configuration

No configuration is necessary, but see the documentation in the source file how to use the customized readtable in your Lisp code.

Documentation

The full documentation is contained in block comments in the net-xml-generator.cl source file itself.

License

The net-xml-generator source code is licensed under the terms of the Lisp Lesser GNU Public License, known as the LLGPL. The LLGPL consists of a preamble and the LGPL. Where these conflict, the preamble takes precedence. This project is referenced in the preamble as the LIBRARY.

Notes

An earlier version of this code was first released as part of the Ray Tracing example in the Franz Inc Dynamic Learning Center.

Examples and Information

The xml-generator-blurb.cl is an odd, self-referential example of Lisp code using the generator.

Franz Open Source Info

This project's homepage is http://opensource.franz.com. There is an informal community support and development mailing list opensource@franz.com for these open source projects. We encourage you to take advantage by subscribing to the list. Once you're subscribed, email to opensource@franz.com with your questions, comments, suggestions, and patches.