From c5dbf00ef6ffb4f6b5df8fb39f116af28f9e6b09 Mon Sep 17 00:00:00 2001
From: dlichteblau <dlichteblau>
Date: Sun, 2 Mar 2008 17:03:11 +0000
Subject: [PATCH] documentation update

---
 doc/index.xml       |  8 +++++++-
 doc/xmls-compat.xml | 28 ++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/doc/index.xml b/doc/index.xml
index bf03985..8823f09 100644
--- a/doc/index.xml
+++ b/doc/index.xml
@@ -48,10 +48,12 @@
 	<a href="http://common-lisp.net/project/plexippus-xpath/">Plexippus</a>:
 	XPath 1.0
       </li>
+<!--
       <li>
 	<a href="http://repo.or.cz/w/xuriella.git">Xuriella</a>:
 	XSLT 1.0 (work in progress)
       </li>
+-->
       <li>
 	<a href="http://common-lisp.net/project/closure/closure-html/">Closure
 	  HTML</a>:
@@ -76,10 +78,14 @@
 	New sink slot omit-xml-declaration-p; functions cxml:unescaped
 	and sax:unescaped.
       </li>
+      <li>
+	Added XPath support to the XMLS compatibility model.
+      </li>
       <li>
 	Fixed various DTD serialization bugs.  Fixed xmls compatibility
 	bugs.  Fixed variable names in with-source.  Fixed
-	klacks-error export. 
+	klacks-error export.  Consistently use strings as base URIs.
+	Fixed PARSE for non-file-streams.
       </li>
     </ul>
     <div style="background-color: #f7f7f7;
diff --git a/doc/xmls-compat.xml b/doc/xmls-compat.xml
index 5acfa14..dbb961a 100644
--- a/doc/xmls-compat.xml
+++ b/doc/xmls-compat.xml
@@ -23,6 +23,7 @@
       only.  The old behaviour using pairs of prefix and local names
       was removed.
     </p>
+<!--
     <p>
       <strike>
 	fixme: It is unclear to me how namespaces are meant to
@@ -36,6 +37,7 @@
 	to me how that works in xmls.
       </strike>
     </p>
+-->
     <p>
       <div class="def">Function CXML-XMLS:MAKE-XMLS-BUILDER (&amp;key include-default-values include-namespace-uri)</div>
       Create a SAX handler which builds XMLS list structures.&#160;
@@ -87,5 +89,31 @@
       Accessors for xmls node data.
     </p>
     <p>
+      <div class="def">Accessor CXML-XMLS:MAKE-XPATH-NAVIGATOR ()</div>
+      Creates a navigator object for use with Plexippus XPath.
     </p>
+    <p>
+      Note that the navigator object caches parts of the document
+      structure, so when re-using a navigator across XPath evalutions,
+      make sure not to modify the list structure.
+    </p>
+    <p>
+      Example:
+    </p>
+    <pre>CL-USER> (defparameter *test-document*
+	   (cxml:parse
+            "&lt;foo a='b'>
+               &lt;a id='1'/> &lt;b id='2'/> &lt;c id='3'/>
+               &lt;a id='4'/> &lt;b id='5'/> &lt;c id='6'/>
+               &lt;a id='7'/> &lt;b id='8'/> &lt;c id='9'/>
+               &lt;last/>
+             &lt;/foo>"
+	    (cxml-xmls:make-xmls-builder)))
+*TEST-DOCUMENT*</pre>
+<pre>CL-USER> (let ((xpath:*navigator* (cxml-xmls:make-xpath-navigator)))
+	   (xpath:evaluate "//c[position()=2]|//a[@id='1']"
+			   *test-document*))
+#&lt;XPATH:NODE-SET (a ((id 1))), ... {27C751F1}></pre>
+<pre>CL-USER> (xpath:all-nodes *)
+(("a" (("id" "1"))) ("c" (("id" "6"))))</pre>
 </documentation>