doc/index.xml

   1 <documentation title="Closure XML">
   2     <h1>Closure XML Parser</h1>
   3
   4     <p>An XML parser written in Common Lisp.</p>
   5
   6     <p>
   7       Closure XML was written
   8       by <a href="http://www.stud.uni-karlsruhe.de/~unk6/">Gilbert
   9       Baumann</a> as part of the Closure web browser and is now
  10       maintained by
  11       <a href="mailto:david@lichteblau.com">David Lichteblau</a>.
  12       It is licensed under Lisp-LGPL.
  13     </p>
  14
  15     <p>
  16       CXML implements a <a
  17       href="http://www.w3.org/TR/REC-xml-names/">namespace-aware</a>,
  18       validating <a
  19       href="http://www.w3.org/TR/2000/REC-xml-20001006">XML&#160;1.0</a>
  20       parser as well as the <a
  21       href="http://www.w3.org/TR/DOM-Level-2-Core/">DOM&#160;Level&#160;2&#160;Core</a>
  22       interfaces.  Two parser interfaces are offered, one SAX-like, the
  23       other similar to StAX.
  24     </p>
  25
  26     <p>
  27       Send bug reports to <a
  28       href="mailto:cxml-devel@common-lisp.net">cxml-devel@common-lisp.net</a>
  29       (<a
  30       href="http://common-lisp.net/cgi-bin/mailman/listinfo/cxml-devel">list
  31       information</a>).
  32     </p>
  33
  34     <h3>Add-on features</h3>
  35     <p>
  36       The following libraries are available as separate downloads:
  37     </p>
  38     <ul style="list-style-type: square">
  39       <li>
  40         <a href="http://www.lichteblau.com/cxml-rng/">cxml-rng</a>:
  41         Relax NG validation
  42       </li>
  43       <li>
  44         <a href="http://www.lichteblau.com/cxml-stp/">cxml-stp</a>:
  45         STP, an alternative to DOM
  46       </li>
  47       <li>
  48         <a href="http://common-lisp.net/project/plexippus-xpath/">Plexippus</a>:
  49         XPath 1.0
  50       </li>
  51       <li>
  52         <a href="http://repo.or.cz/w/xuriella.git">Xuriella</a>:
  53         XSLT 1.0 (work in progress)
  54       </li>
  55       <li>
  56         <a href="http://common-lisp.net/project/closure/closure-html/">Closure
  57           HTML</a>:
  58         parse HTML 4; convert between HTML and XHTML
  59       </li>
  60     </ul>
  61
  62
  63     <a name="changes"/>
  64     <h3>Recent Changes</h3>
  65     <p class="nomargin"><tt>rel-2007-10-21</tt></p>
  66     <ul class="nomargin">
  67       <li>
  68         Lisps using full 21 bit code points as characters are now fully
  69         supported (including SBCL and Clozure CL) addition to the
  70         existing support for 16 bit characters using UTF-16 (including
  71         Allegro and LispWorks).  The feature <tt>rune-is-utf-16</tt> is
  72         now set on 16 bit Lisps.<br/><br/> Make sure to update and
  73         recompile both cxml and closure-common when upgrading.
  74       </li>
  75       <li>
  76         New sink slot omit-xml-declaration-p; functions cxml:unescaped
  77         and sax:unescaped.
  78       </li>
  79       <li>
  80         Fixed various DTD serialization bugs.  Fixed xmls compatibility
  81         bugs.  Fixed variable names in with-source.  Fixed
  82         klacks-error export.
  83       </li>
  84     </ul>
  85     <div style="background-color: #f7f7f7;
  86                 width: 60%;
  87                 border: solid #9c0000;
  88                 margin: 0em 2pt 1em 2em;
  89                 padding: 1em">
  90       Runes have now been moved into
  91       a <b>separate CVS module</b> unter the
  92       name <b>closure-common</b>.  Releases will be available
  93       as <b>separate tarballs</b> in the download directory.  Please
  94       refer to the <a href="installation.html#download">
  95         installation instructions</a> for details.
  96     </div>
  97     <p class="nomargin"><tt>rel-2007-10-21</tt></p>
  98     <ul class="nomargin">
  99       <li>
 100         Moved runes into a separate project.
 101       </li>
 102       <li>
 103         Incompatible SAX changes: Added new classes
 104         sax:abstract-handler, sax:content-handler, sax:default-handler.
 105         Implementations of SAX handlers should now subclass one of
 106         these classes.
 107       </li>
 108       <li>
 109         fixed make-source :buffering nil, thanks to Magnus Henoch for
 110         the report
 111       </li>
 112       <li>
 113         fixed time and space usage in cases where entity references
 114         follow each other (thanks to Ivan Shvedunov for the report)
 115       </li>
 116       <li>
 117         In the DOM builder, grow a buffer for string normalization
 118         exponentially, fixing a long-standing speed issue.
 119       </li>
 120     </ul>
 121     <p class="nomargin"><tt>rel-2007-08-05</tt></p>
 122     <ul class="nomargin">
 123       <li>Various DTD serialization fixes</li>
 124       <li>UTF-8 fix, thanks to Francis Leboutte</li>
 125     </ul>
 126     <p class="nomargin"><tt>rel-2007-07-07</tt></p>
 127     <ul class="nomargin">
 128       <li>
 129         Fixed build on non-Unicode lisps.  Fixed parsing on
 130         non-Unicode lisps.  Fixed Unicode detection on OpenMCL.
 131       </li>
 132       <li>New function <tt>cxml:parse</tt>.</li>
 133       <li>Serialization no longer defaults to canonical form.</li>
 134       <li>Fixed octet array argument to make-source.</li>
 135       <li>
 136         XMLS compatibility is not <i>bug-for-bug</i>-compatible with
 137         XMLS any more.  There is now a mode using pairs of local name
 138         and namespace URI, and a second mode using qualified names
 139         only.  The old behaviour using pairs of prefix and local names
 140         was removed.  (Thanks to Douglas Crosher.)
 141       </li>
 142       <li>
 143         SCL support (thanks to Douglas Crosher).  Includes support for
 144         implementations where URIs are valid namestrings, and a mode
 145         where normal streams are used instead of xstreams and ystreams
 146         (albeit both SCL-specific at this point).
 147       </li>
 148       <li>new convenience serialization function cxml:doctype.  Various
 149         DTD serialization fixes.</li>
 150     </ul>
 151     <p class="nomargin"><tt>rel-2007-05-26</tt></p>
 152     <ul class="nomargin">
 153       <li>cxml.asd has been split up into <tt>cxml.asd</tt> for the
 154       XML parser and <tt>runes.asd</tt> for the runes package, in
 155       preparation of a complete split of the two systems.  Future CXML
 156       releases will use separate tarballs for <tt>runes</tt>
 157       and <tt>cxml</tt>.</li>
 158       <li>xml:base support (SAX and Klacks only, not yet used in DOM).
 159       See documentation <a href="sax.html#saxparser">here</a> and <a
 160       href="klacks.html#locator">here</a>.</li>
 161       <li>New class <tt>broadcast-handler</tt> as a generalization
 162       of the older <tt>sax-proxy</tt>.</li>
 163       <li>New class <tt>tapping-source</tt>, a klacks source that
 164       relays events from an upstream klacks source unchanged, while also
 165       emitting them as SAX events to a user-specified handler at the
 166       same time.</li>
 167       <li>Changed attributes to carry an lname even when occurring
 168       without a namespace.  Added new functions attribute*,
 169       unparse-attribute, and macro with-element*, with-namespace* to
 170       the SAX generation wrapper API.</li>
 171       <li>Klacks improvements: Incompatibly changed
 172       klacks:find-element and find-event to consider the current event
 173       as a result.  Added klacks-error, klacks:expect, klacks:skip,
 174       klacks:expecting-element.  Fixed serialize-event to generate
 175       start-prefix-mapping and end-prefix-mapping events.  New function
 176       map-current-namespace-declarations.</li>
 177       <li>fixed build with common-lisp-controller</li>
 178     </ul>
 179     <p class="nomargin"><tt>rel-2007-02-18</tt></p>
 180     <ul class="nomargin">
 181       <li>New StAX-like parser interface.</li>
 182       <li>Serialization fixes (thanks to Nathan Bird, Donavon Keithley).</li>
 183       <li>characters.lisp cleanup (thanks to Nathan Bird).</li>
 184       <li>Namespace normalizer bugfixes.</li>
 185       <li>Minor changes: clone-node on document as an extension.  DOM
 186       class hierarchy reworked.  New function parse-empty-document.
 187       Fixed the DOM serializer to not throw away local names.
 188       Fixed a long-standing bug in the parser for documents without a
 189       doctype. ANSI conformance fixes.</li>
 190     </ul>
 191     <p class="nomargin"><tt>rel-2006-01-05</tt></p>
 192     <ul class="nomargin">
 193       <li>Implemented DOM 2 Core.</li>
 194       <li>Error handling overhaul.</li>
 195       <li>UTF-8 string support in DOM on Lisps without Unicode characters.</li>
 196       <li>Sink API has been changed.</li>
 197       <li>Support internal subset serialization.</li>
 198       <li>Whitespace normalizer.</li>
 199       <li>Gilbert Baumann has clarified the license as Lisp-LGPL.</li>
 200       <li>Use trivial-gray-streams.</li>
 201     </ul>
 202     <p class="nomargin"><tt>rel-2005-06-25</tt></p>
 203     <ul class="nomargin">
 204       <li>Port to OpenMCL (thanks to Rudi Schlatte).</li>
 205       <li>Port to LispWorks (thanks to Edi Weitz).</li>
 206       <li>Minor new features: <tt>include-default-values</tt> argument to
 207       <tt>make-xmls-builder</tt>; <tt>handler</tt> argument
 208       to <tt>parse-dtd-stream</tt>; SAX proxy class</li>
 209       <li>Various bugfixes.</li>
 210     </ul>
 211     <p class="nomargin"><tt>patch-357</tt> (2004-10-10)</p>
 212     <ul class="nomargin">
 213       <li>Auto-detect unicode support for better asdf-installability.</li>
 214       <li>Use the puri library for Sys-ID handling.</li>
 215       <li>Semi-automatic caching of DTD instances.</li>
 216       <li>Support user-defined entity resolvers.</li>
 217       <li>Support for Oasis XML Catalogs.</li>
 218       <li>xhtmlgen version of Franz htmlgen.</li>
 219       <li>Fixes for SBCL's unicode support.</li>
 220     </ul>
 221     <p class="nomargin"><tt>patch-306</tt> (2004-09-03)</p>
 222     <ul class="nomargin">
 223       <li>Event-based serialization which does not require DOM documents</li>
 224       <li>XMLS compatiblity</li>
 225       <li>minor bugfixes (thread safety; should work on clisp again)</li>
 226     </ul>
 227     <p class="nomargin"><tt>patch-279</tt> (2004-05-11)</p>
 228     <ul class="nomargin">
 229       <li>Validation</li>
 230       <li>bugfixes; XHTML DTD parses again; corrected SAX entity handling</li>
 231     </ul>
 232     <p class="nomargin"><tt>patch-204</tt></p>
 233     <ul class="nomargin">
 234       <li>Renamed package <tt>XML</tt> to <tt>CXML</tt>.</li>
 235       <li>The unparse functions support non-canonical output now.</li>
 236     </ul>
 237     <p class="nomargin"><tt>patch-191</tt> (2004-03-18)</p>
 238     <ul class="nomargin">
 239       <li>Initial release.</li>
 240     </ul>
 241 </documentation>