Make the previous fix clozure-specific
[cxml-stp.git] / index.xml
blobc04721f345f8d9fe9759f502cd623cff276c0662
1 <page>
2   <p>
3     A data structure for well-formed XML documents, designed for Common
4     Lisp.
5   </p>
7   <h3>About</h3>
9   <p>
10     cxml-stp is an alternative to the
11     W3C's <a href="http://common-lisp.net/project/cxml/dom.html">DOM</a>,
12     which cxml also implements.  It was written
13     by <a href="mailto:david@lichteblau.com">David Lichteblau</a> as an
14     add-on library for
15     <a href="http://common-lisp.net/project/cxml">Closure XML</a> and is
16     available under an X11-style license.
17   </p>
18   <p>
19     Please send bug reports
20     to <a href="mailto:cxml-devel@common-lisp.net">
21       cxml-devel@common-lisp.net</a>
22     (<a href="http://common-lisp.net/cgi-bin/mailman/listinfo/cxml-devel">list information</a>).
23   </p>
24   <p>
25     <i>Acknowledgements:</i>
26     cxml-stp is inspired by <a href="http://www.xom.nu/">XOM</a>.
27   </p>
28   <h3>Download</h3>
29   <p>
30     Download a
31     <a href="http://www.lichteblau.com/cxml-stp/download/">tarball</a>.
32   </p>
34   <h3>Installation</h3>
35   <p>
36     cxml-stp needs
37     <a href="http://common-lisp.net/project/cxml">Closure XML</a>,
38     <a href="http://common-lisp.net/project/alexandria/">Alexandria</a>,
39     and <a href="http://common-lisp.net/project/plexippus-xpath/">Plexippus
40       XPath</a>.
41   </p>
42   <p>
43     <a href="http://www.cliki.net/asdf">ASDF</a> is used for
44     compilation.  Register the .asd file, e.g. by symlinking it,
45     then compile cxml-stp using <tt>asdf:operate</tt>.
46   </p>
47   <pre>$ ln -sf `pwd`/cxml-stp.asd /path/to/your/registry/
48 * (asdf:operate 'asdf:load-op :cxml-stp)</pre>
49   <p>
50     <i>Implementation-specific notes:</i>
51     At this point, cxml-stp is written to work with Lisp strings
52     (as opposed to runes and rods), and is meant to be used on
53     Lisp implementations with Unicode support.
54   </p>
56   <h3>Documentation</h3>
57   <p>
58     <raute/> <a href="tutorial/index.html">Tutorial</a>
59   </p>
60   <p>
61     <raute/> <a href="tutorial/examples.html">Code</a> snippets
62     from the tutorial collected on one page
63   </p>
64   <p>
65     <raute/> <a href="doc/pages/cxml-stp.html">API documentation</a>
66   </p>
67   <p>
68     There is also a rough "STP for DOM
69     users" <a href="DOM-COMPARISON">comparison</a> which should be
70     useful if you have a specific DOM function in mind and are looking
71     for STP's equivalent.
72   </p>
74   <h3>Recent changes</h3>
75   <p><b>2008-03-dd</b></p>
76   <ul>
77     <li>
78       XPath support.  (Thanks to Ivan Shvedunov for his contributions.)
79     </li>
80     <li>
81       Use 21 bit characters on Lisps offering them.
82     </li>
83     <li>
84       New function NUMBER-OF-CHILDREN.
85     </li>
86     <li>
87       Fixed FILTER-CHILDREN to return a list, not a vector.
88     </li>
89     <li>
90       Shortcut syntax using symbol in WITH-ATTRIBUTE (thanks to Cyrus Harmon).
91     </li>
92     <li>
93       Minor changes: Disabled uri syntax warnings.  Represent uris as
94       strings, not puri objects.
95     </li>
96   </ul>
97   <p><b>2007-10-21</b></p>
98   <ul>
99     <li>
100       New function FIND-RECURSIVELY-IF.
101     </li>
102     <li>
103       Minor changes: Update to current CXML's SAX builders.
104     </li>
105   </ul>
106   <p><b>2007-08-05</b></p>
107   <ul>
108     <li>
109       Initial public release. 
110     </li>
111   </ul>
112 </page>