Documentation tweaks
Sun Dec 7 01:53:47 PST 2008 David Lichteblau <david@lichteblau.com>
* Documentation tweaks
Warning: CRC errors found. These are probably harmless but should be repaired.
See 'darcs gzcrcs --help' for more information.
diff -rN -u old-plexippus-xpath/doc/index.css new-plexippus-xpath/doc/index.css
--- old-plexippus-xpath/doc/index.css 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/doc/index.css 2014-07-28 15:39:03.000000000 -0700
@@ -165,3 +165,18 @@
margin: 0 0 1em;
list-style-type: none;
}
+
+pre {
+ padding: 1em;
+ width: 70%;
+ background-color: #f7f7f7;
+ border: 1px solid #0070a0 /* default color */;
+}
+
+p {
+ width: 90%;
+}
+
+li {
+ width: 90%;
+}
diff -rN -u old-plexippus-xpath/doc/index.xml new-plexippus-xpath/doc/index.xml
--- old-plexippus-xpath/doc/index.xml 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/doc/index.xml 2014-07-28 15:39:03.000000000 -0700
@@ -4,7 +4,8 @@
<h3>About</h3>
<p>
- Plexippus XPath is an implementation of XPath 1.0.
+ Plexippus XPath is an implementation of XPath 1.0, written by
+ Ivan Shvedunov.
</p>
<p>
@@ -14,16 +15,33 @@
(<a href="http://common-lisp.net/cgi-bin/mailman/listinfo/plexippus-xpath-devel">list information</a>).
</p>
+ <h3>Implementation-specific notes</h3>
+ <p>
+ This beta version of Plexippus XPath works only
+ on <a href="http://www.sbcl.org">SBCL</a>.
+ </p>
+ <p>
+ Ports to other Lisps are welcome and mainly involve
+ implementation-specific support for non-trapping IEEE floating point
+ arithmetic. Please submit patches to the mailing list, ideally
+ after running the XSLT test suite using
+ the <a href="http://common-lisp.net/project/xuriella/">Xuriella
+ XSLT</a> project.
+ </p>
+
<h3>Related projects</h3>
<ul>
<li>
<a href="http://common-lisp.net/project/cxml/">Closure XML</a>
</li>
+ <li>
+ <a href="http://common-lisp.net/project/xuriella/">Xuriella XSLT</a>
+ </li>
</ul>
- <h3>Recent Changes</h3>
- <p><b>2008-xx-yy</b></p>
+ <h3>Recent changes</h3>
+ <p><b>2008-12-07</b></p>
<ul>
- <li>not released yet; work in progress</li>
+ <li>First beta release</li>
</ul>
</page>
diff -rN -u old-plexippus-xpath/doc/index.xsl new-plexippus-xpath/doc/index.xsl
--- old-plexippus-xpath/doc/index.xsl 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/doc/index.xsl 2014-07-28 15:39:03.000000000 -0700
@@ -90,17 +90,11 @@
<ul class="main">
<li>
<a href="installation.html">
- Installing <xsl:value-of select="/page/@title"/>
+ Download and Installation
</a>
- <ul class="sub">
- <li><a href="installation.html#download">Download</a></li>
- <li><a href="installation.html#compilation">Installation</a></li>
- </ul>
</li>
<li>
- <a href="examples.html"><strike>Examples</strike></a>
- (to be written)
- <br/>&#160;
+ <a href="examples.html">Examples</a>
</li>
<li>
<a href="atdoc/index.html">API documentation</a>
diff -rN -u old-plexippus-xpath/doc/installation.xml new-plexippus-xpath/doc/installation.xml
--- old-plexippus-xpath/doc/installation.xml 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/doc/installation.xml 2014-07-28 15:39:03.000000000 -0700
@@ -1,11 +1,9 @@
-<page title="Installing Plexippus XPath">
+<page title="Download and Installation">
<h3>Download</h3>
<p>
- <strike>
- Download a
- <a href="#tbd">tarball</a>.
- </strike>
+ Download a
+ <a href="http://common-lisp.net/project/plexippus-xpath/download/">tarball</a>.
</p>
<p>
Get it from darcs repository:
@@ -16,6 +14,10 @@
<p>
Plexippus XPath needs
<a href="http://common-lisp.net/project/cxml">cxml</a>,
+ <a href="http://cliki.net/parse-number">parse-number</a>,
+ <a href="http://www.weitz.de/cl-ppcre">cl-ppcre</a>,
+ and <a href="http://common-lisp.net/project/cl-yacc">cl-yacc</a>.
+
</p>
<p>
<a href="http://www.cliki.net/asdf">ASDF</a> is used for
diff -rN -u old-plexippus-xpath/package.lisp new-plexippus-xpath/package.lisp
--- old-plexippus-xpath/package.lisp 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/package.lisp 2014-07-28 15:39:03.000000000 -0700
@@ -352,6 +352,7 @@
is usually sorted either in document order,or in reverse document order.
See @fun{xpath:evaluate} for the @code{unordered} argument.
+ @aboutclass{node-set}
@aboutfun{make-node-set}
@aboutfun{pipe-of}
@end{section}
diff -rN -u old-plexippus-xpath/plx.lisp new-plexippus-xpath/plx.lisp
--- old-plexippus-xpath/plx.lisp 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/plx.lisp 2014-07-28 15:39:03.000000000 -0700
@@ -56,7 +56,8 @@
@pre{plx:generate-id(node-set?)}
Returns an alphanumeric string that uniquely identifies the first node of
the @code{node-set} (or context node if @code{node-set} isn't specified)
- within its document. Analagous to @code{generate-id()} of XSLT."
+ within its document. Analagous to @code{generate-id()} of XSLT (except
+ that the latter works across multiple documents)."
`(with-namespaces (("plx" *plx-uri*)) ,@body))
(define-extension plx *plx-uri*)
diff -rN -u old-plexippus-xpath/types.lisp new-plexippus-xpath/types.lisp
--- old-plexippus-xpath/types.lisp 2014-07-28 15:39:03.000000000 -0700
+++ new-plexippus-xpath/types.lisp 2014-07-28 15:39:03.000000000 -0700
@@ -48,7 +48,7 @@
@see-constructor{make-node-set}"))
(defun pipe-of (node-set)
- "@arg[node-set]{a node set}
+ "@arg[node-set]{a @class{node-set}}
@return{a pipe}
Returns the pipe that contains the elements of the @code{node-set}."
(slot-value node-set 'pipe))
@@ -56,7 +56,7 @@
;; FIXME: (setf ...) functions aren't documented by atdoc
(defun (setf pipe-of) (pipe node-set)
"@arg[pipe]{a pipe}
- @arg[node-set]{a node-set}
+ @arg[node-set]{a @class{node-set}}
@return{the value of @code{pipe}}
Sets the pipe that contains the element sof the @code{node-set}."
(setf (slot-value node-set 'pipe) pipe))
@@ -74,7 +74,7 @@
(typep object 'node-set))
(defun node-set-empty-p (node-set)
- "@arg[node-set]{a node-set}
+ "@arg[node-set]{a @class{node-set}}
@return{a generalized boolean}
Returns true if @code{node-set} is empty"
(pipe-empty-p (pipe-of node-set)))
@@ -82,8 +82,8 @@
(defun make-node-set (pipe &optional (ordering :unordered))
"@arg[pipe]{a pipe}
@arg[ordering]{one of :document-order, :reverse-document-order, :unordered}
- @return{a node set}
- Makes a node set containing nodes from the @code{pipe} with specified @code{ordering}."
+ @return{a @class{node-set}}
+ Makes a @class{node-set} containing nodes from the @code{pipe} with specified @code{ordering}."
(let ((visited (make-hash-table :test 'equal)))
(make-instance 'node-set
:pipe (filter-pipe
@@ -95,7 +95,7 @@
:ordering ordering)))
(defun sort-node-set (node-set)
- "@arg[node-set]{a node set}
+ "@arg[node-set]{a @class{node-set}}
@return{a sorted version of @code{node-set}}
Sorts the @code{node-set} according to document order."
(make-node-set (sorted-pipe-of node-set)
@@ -331,11 +331,11 @@
(defun node-set-value (value)
"@arg[value]{value of an XPath-supported type or an XML node}
- @return{a node set}
+ @return{a @class{node-set}}
@short{Returns the value of XPath node-set() function.}
- For XML nodes returns a node set consisting of the single node specified
- by @code{value}."
+ For XML nodes returns a @class{node-set} consisting of the single node
+ specified by @code{value}."
(cond ((node-set-p value)
value)
((xpath-protocol:node-p value)