OSCL/CXML
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sb-unicode backport

Browse Source 
namespace-korrekturen
noch documentation
This commit is contained in:
dlichteblau
2005-12-27 20:01:10 +00:00
parent dbb2732913
commit 36ba984844
11 changed files with 62 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/dom.html
View File

@ -117,6 +117,15 @@
href="using.html#misc">namespace normalizer</a> is used.
</li>
</ul>
<p>
<tt>unparse-document-to-octets</tt> returns an <tt>(unsigned-byte
8)</tt> array, whereas <tt>unparse-document</tt> writes
characters.&nbsp; <tt>unparse-document</tt> is useful together
with <tt>with-output-to-string</tt>.&nbsp; However, note that the
resulting document in both cases is UTF-8 encoded, so the
characters written by <tt>unparse-document</tt> are really UTF-8
bytes encoded as characters.
</p>
<a name="mapping"/>
<h3>DOM/Lisp mapping</h3>

39
doc/installation.html
View File

@ -14,35 +14,31 @@
<h2>Download</h2>
<ul>
<li>
<a href="http://common-lisp.net/project/cxml/download/">tarballs</a>
<div><a href="http://common-lisp.net/project/cxml/download/">tarballs</a></div>
</li>
<li>
<li>
<div>
Anoncvs (<a href="http://common-lisp.net/cgi-bin/viewcvs.cgi/cxml/?cvsroot=cxml">browse</a>):
<pre>$ export CVSROOT=:pserver:anonymous@common-lisp.net:/project/cxml/cvsroot
$ cvs login
Logging in to :pserver:anonymous@common-lisp.net:2401/project/cxml/cvsroot
CVS password: anonymous
$ cvs co cxml</pre>
</lii>
</div>
</li>
</ul>
<a name="implementations"/>
<h2>Implementation-specific notes</h2>
<p>
CXML should be portable to all Common Lisp implementations
supporting gray streams. Currently supported are ACL, CLISP,
CMUCL, LispWorks, OpenMCL, and SBCL.
supported by <a
href="http://common-lisp.net/project/cl-plus-ssl/#trivial-gray-streams">trivial-gray-streams</a>.
</p>
<ul>
<li>
Note that CMUCL and OpenMCL do not support Unicode
natively.&nbsp; (You might want to use the <a
href="using.html#rods">recoding SAX handler</a> to work with
native strings anyway.)
</li>
<li>
SBCL and CLISP will trip over cxml's non-ASCII source files
unless compiled using a suitable locale configuration
unless run using a suitable locale configuration
(<tt>LC_CTYPE=en_US.ISO-8859-1</tt> should help).
</li>
<li>
@ -51,19 +47,6 @@ $ cvs co cxml</pre>
</li>
</ul>
<!--
<p>
Optional configuration (skip this unless you know better): CXML
has full Unicode code support - - even on Lisps without Unicode
strings. On non-unicode aware Lisps, <tt>DOMString</tt> is
implemented as an array of character codes. CXML will auto-detect
at compile-time which string representation to use. To override
the auto-detection, you can set one of the features
<tt>:rune-is-character</tt> and <tt>:rune-is-integer</tt> before
loading <tt>cxml.asd</tt>.
</p>
-->
<a name="compilation"/>
<h2>Compilation</h2>
<p>
@ -117,9 +100,9 @@ $ cd 2001/DOM-Test-Suite && ant dom1-dtd dom2-dtd</pre>
</p>
<p>
<b>fixme</b> My parser does not understand the current testsuite
anymore.&nbsp; To fix this problem, revert the affected files
manually after check-out:
<b>fixme</b> domtest.lisp does not understand the current
testsuite driver anymore.&nbsp; To fix this problem, revert the
affected files manually after check-out:
</p>
<pre>$ cd 2001/XML-Test-Suite/xmlconf/

2
doc/quickstart.html
View File

@ -16,7 +16,7 @@
<ul class="sub">
<li><a href="installation.html#download"><b>Download</b></a></li>
<li><a href="installation.html#implementations">Implementation-specific notes</a></li>
<li><a href="installation.html#compilation"><b>Compilation</b></a></li>
<li><a href="installation.html#compilation">Compilation</a></li>
<li><a href="installation.html#tests">Tests</a></li>
</ul>
</li>

32
doc/using.html
View File

@ -138,9 +138,10 @@
</p>
<p>
<div class="def">Function CXML:MAKE-CHARACTER-STREAM-SINK (stream &rest keys) => sink</div>
<div class="def">Function CXML:MAKE-OCTET-STREAM-SINK (stream &rest keys) => sink</div>
<div class="def">Function CXML:MAKE-OCTET-VECTOR-SINK (&rest keys) => sink</div>
Return a handle suitable for event-based XML serialization.
<div class="def">Function CXML:MAKE-CHARACTER-STREAM-SINK (stream &rest keys) => sink</div>
Return a SAX serialization handle.
</p>
<p>Keyword arguments:</p>
<ul>
@ -175,26 +176,6 @@
changes the document model and should only be used if whitespace
does not matter to the application.
</p>
<p>
If namespace support is enabled (the default), these functions use
a namespace normalizer (<tt>cxml:make-namespace-normalizer</tt>).
</p>
<p>
<tt>unparse-document-to-octets</tt> returns an <tt>(unsigned-byte
8)</tt> array, whereas <tt>unparse-document</tt> writes
characters.&nbsp; <tt>unparse-document</tt> is useful together
with <tt>with-output-to-string</tt>.&nbsp; However, note that the
resulting document in both cases is UTF-8 encoded, so the
characters written by <tt>unparse-document</tt> are really UTF-8
bytes encoded as characters.
</p>
<p>
These function provide the low-level mechanism used by the DOM
serialization functions. To serialize a document without building
its DOM tree first, create a sink handle and call SAX functions on that
handle. <tt>sax:end-document</tt> returns the serialized form of
the document described by the SAX events.
</p>
<p>
<div class="def">Macro CXML:WITH-XML-OUTPUT (sink &body body) => sink-specific result</div>
@ -214,17 +195,12 @@
(attribute "blub" "bla"))
(text "Hi there.")))</pre>
<p>
Prints this to <tt>stream</tt>, which must be an
<tt>(unsigned-byte 8)</tt> stream:
Prints this to <tt>stream</tt>:
</p>
<pre>&lt;foo xyz="abc"&gt;
&lt;bar blub="bla"&gt;&lt;/bar&gt;
Hi there.
&lt;/foo&gt;</pre>
<p>
(Note that these functions accept both strings and rods, so we
can write <tt>"foo"</tt> instead of <tt>#"foo"</tt> above.)
</p>
<p>
<div class="def">Macro XHTML-GENERATOR:WITH-XHTML (sink &rest forms)</div>