[cxml-cvs] CVS cxml/doc

[dlichteblau]

Update of /project/cxml/cvsroot/cxml/doc
In directory clnet:/tmp/cvs-serv24285/doc

Modified Files:
	html.xsl klacks.xml 
Log Message:
new argument :buffering to make-source


--- /project/cxml/cvsroot/cxml/doc/html.xsl	2007/02/18 12:35:50	1.1
+++ /project/cxml/cvsroot/cxml/doc/html.xsl	2007/02/18 15:27:30	1.2
@@ -57,8 +57,8 @@
 	<li>
           <a href="klacks.html">Klacks parser</a>
           <ul class="sub">
-            <li><a href="klacks.html#parsing">Parsing incrementally</a></li>
-            <li><a href="klacks.html#sax">Bridging Klacks and SAX</a></li>
+            <li><a href="klacks.html#sources">Parsing incrementally</a></li>
+            <li><a href="klacks.html#klacksax">Bridging Klacks and SAX</a></li>
           </ul>
         </li>
 	<li>
--- /project/cxml/cvsroot/cxml/doc/klacks.xml	2007/02/18 14:35:14	1.2
+++ /project/cxml/cvsroot/cxml/doc/klacks.xml	2007/02/18 15:27:30	1.3
@@ -45,7 +45,8 @@
 * <b>(klacks:consume *source*)</b>
 NIL</pre>
 
-    <h3>Klacks sources</h3>
+    <a name="sources"/>
+    <h3>Parsing incrementally using sources</h3>
     <p>
       To parse using Klacks, create an XML <tt>source</tt> first.
     </p>
@@ -96,8 +97,22 @@
       closed otherwise.
     </p>
     <p>
-      <b>Keyword arguments</b> have the same meaning as with the SAX parser,
-      please refer to the documentation of <a
+      <b>Buffering:</b> By default, the Klacks parser performs buffering
+      of octets being read from the stream as an optimization.  This can
+      result in unwanted blocking if the stream is a socket and the
+      parser tries to read more data than required to parse the current
+      event.  Use <tt>:buffering nil</tt> to disable this optimization.
+    </p>
+    <ul>
+      <li>
+        <tt>buffering</tt> -- Boolean, defaults to <tt>t</tt>.  If
+        enabled, read data several kilobytes at time.  If disabled,
+        read only single bytes at a time.
+      </li>
+    </ul>
+    <p>
+      The following <b>keyword arguments</b> have the same meaning as
+      with the SAX parser, please refer to the documentation of <a
       href="sax.html#parser">parse-file</a> for more information:
     </p>
     <ul>
@@ -216,6 +231,7 @@
       exiting <tt>body</tt>, whether normally or abnormally.
     </p>
 
+    <a name="klacksax"/>
     <h3>Bridging Klacks and SAX</h3>
     <p>
       <div class="def">Function KLACKS:SERIALIZE-SOURCE (source handler)</div>