Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 60979bdcb3a749c21097dc12d6650548cb6e33ef / . / doc / xml.html
blob: 2f08585e829cf5ac5f2907a085733999457840b5 [file] [log] [blame]
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2 "http://www.w3.org/TR/REC-html40/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3<html>
4<head>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5 <title>The XML library for Gnome</title>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]6 <meta name="GENERATOR" content="amaya V3.2">
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]7 <meta http-equiv="Content-Type" content="text/html">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]8</head>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]9
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]10<body bgcolor="#ffffff">
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]11<p><a href="http://www.gnome.org/"><img src="smallfootonly.gif"
12alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png"
13alt="W3C Logo"></a></p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]14
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]15<h1 align="center">The XML library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]16
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]17<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
18
19<p></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]20<ul>
21 <li><a href="#Introducti">Introduction</a></li>
22 <li><a href="#Documentat">Documentation</a></li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]23 <li><a href="#Downloads">Downloads</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]24 <li><a href="#News">News</a></li>
25 <li><a href="#XML">XML</a></li>
26 <li><a href="#tree">The tree output</a></li>
27 <li><a href="#interface">The SAX interface</a></li>
28 <li><a href="#library">The XML library interfaces</a>
29 <ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]30 <li><a href="#Invoking">Invoking the parser: the pull way</a></li>
31 <li><a href="#Invoking">Invoking the parser: the push way</a></li>
32 <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]33 <li><a href="#Building">Building a tree from scratch</a></li>
34 <li><a href="#Traversing">Traversing the tree</a></li>
35 <li><a href="#Modifying">Modifying the tree</a></li>
36 <li><a href="#Saving">Saving the tree</a></li>
37 <li><a href="#Compressio">Compression</a></li>
38 </ul>
39 </li>
40 <li><a href="#Entities">Entities or no entities</a></li>
41 <li><a href="#Namespaces">Namespaces</a></li>
42 <li><a href="#Validation">Validation</a></li>
43 <li><a href="#Principles">DOM principles</a></li>
44 <li><a href="#real">A real example</a></li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]45 <li><a href="#Contributi">Contribution</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]46</ul>
47
48<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]49
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]50<p>This document describes libxml, the <a
51href="http://www.w3.org/XML/">XML</a> library provided in the <a
52href="http://www.gnome.org/">Gnome</a> framework. XML is a standard for
53building tag-based structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]54
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]55<p>Here are some key points about libxml:</p>
56<ul>
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]57 <li>It is written in plain C, making as few assumptions as possible and
58 sticking closely to ANSI C for easy embedding.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]59 <li>The internal document repesentation is as close as possible to the <a
60 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
61 <li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]62 like interface</a>; the interface is designed to be compatible with <a
63 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]64 <li>Libxml now includes a nearly complete <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]65 href="http://www.w3.org/TR/xpath">XPath</a> implementation.</li>
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]66 <li>Libxml exports Push and Pull type parser interfaces for both XML and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]67 HTML.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]68 <li>This library is released both under the <a
69 href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
70 IPR</a> and the GNU LGPL. Use either at your convenience, basically this
71 should make everybody happy, if not, drop me a mail.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]72 <li>There is <a href="upgrade.html">a first set of instructions</a>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]73 concerning upgrade from libxml-1.x to libxml-2.x</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]74</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]75
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]76<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]77
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]78<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]79<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]80 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]81 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]82 documentation</a> automatically extracted from code comments.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]83 <li>This page provides a global overview and <a href="#real">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]84 examples</a> on how to use libxml.</li>
85 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
86 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
87 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]88 <li>George Lebl wrote <a
89 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]90 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]91 <li>It is also a good idea to check to <a href="mailto:raph@levien.com">Raph
92 Levien</a> <a href="http://levien.com/gnome/">web site</a> since he is
93 building the <a href="http://levien.com/gnome/gdome.html">DOM interface
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]94 gdome</a> on top of libxml result tree and an implementation of <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]95 href="http://www.w3.org/Graphics/SVG/">SVG</a> called <a
96 href="http://www.levien.com/svg/">gill</a>. Check his <a
97 href="http://www.levien.com/gnome/domination.html">DOMination
98 paper</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]99 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
100 file</a></li>
101 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
102 starting a new project using libxml you should really use the 2.x
103 version.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]104 <li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]105 archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]106</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]107
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]108<h3>Reporting bugs and getting help</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]109
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]110<p>Well, bugs or missing features are always possible, and I will make a point
111of fixing them in a timely fashion. The best way to report a bug is to <a
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]112href="http://bugs.gnome.org/db/pa/lgnome-xml.html">use the Gnome bug tracking
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]113database</a>. I look at reports there regularly and it's good to have a
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]114reminder when a bug is still open. Check the <a
115href="http://bugs.gnome.org/Reporting.html">instructions on reporting bugs</a>
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]116and be sure to specify that the bug is for the package gnome-xml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]117
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]118<p>There is also a mailing-list <a
119href="mailto:xml@rufus.w3.org">xml@rufus.w3.org</a> for libxml, with an <a
120href="http://xmlsoft.org/messages">on-line archive</a>. To subscribe to this
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]121majordomo based list, send a mail message to <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]122href="mailto:majordomo@rufus.w3.org">majordomo@rufus.w3.org</a> with
123"subscribe xml" in the <strong>content</strong> of the message.</p>
124
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]125<p>Alternatively, you can just send the bug to the <a
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]126href="mailto:xml@rufus.w3.org">xml@rufus.w3.org</a> list.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]127
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]128<p>Of course, bugs reports with a suggested patch for fixing them will
129probably be processed faster.</p>
130
131<p>If you're looking for help, a quick look at <a
132href="http://xmlsoft.org/messages/#407">the list archive</a> may actually
133provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]134questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]135documentantion</a> is not as polished as I would like (i need to learn more
136about Docbook), but it's a good starting point.</p>
137
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]138<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]139
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]140<p>The latest versions of libxml can be found on <a
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]141href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]142href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]143as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]144archive</a> or <a
145href="ftp://ftp.gnome.org/pub/GNOME/contrib/redhat/SRPMS/">RPM packages</a>.
146(NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]147href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
148href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]149packages installed to compile applications using libxml.)</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]150
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]151<p><a name="Snapshot">Snapshot:</a></p>
152<ul>
153 <li>Code from the W3C cvs base libxml <a
154 href="ftp://rpmfind.net/pub/libxml/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
155 <li>Docs, content of the web site, the list archive included <a
156 href="ftp://rpmfind.net/pub/libxml/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
157</ul>
158
159<p><a name="Contribs">Contribs:</a></p>
160
161<p>I do accept external contributions, especially if compiling on another
162platform, get in touch with me to upload the package. I will keep them in the
163<a href="ftp://rpmfind.net/pub/libxml/contribs/">contrib directory</a></p>
164
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]165<p>Libxml is also available from 2 CVS bases:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]166<ul>
167 <li><p>The <a href="http://dev.w3.org/cvsweb/XML/">W3C CVS base</a>,
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]168 available read-only using the CVS pserver authentification (I tend to use
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]169 this base for my own development, so it's updated more regularly, but the
170 content may not be as stable):</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]171 <pre>CVSROOT=:pserver:anonymous@dev.w3.org:/sources/public
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]172 password: anonymous
173 module: XML</pre>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]174 </li>
175 <li><p>The <a
176 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Gnome
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]177 CVS base</a>. Check the <a
178 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> page;
179 the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]180 </li>
181</ul>
182
183<h2><a name="News">News</a></h2>
184
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]185<h3>CVS only : check the <a
186href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
187for really accurate description</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]188<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]189 <li>working on HTML and XML links recognition layers, get in touch with me
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]190 if you want to test those.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]191</ul>
192
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]193<h3>1.8.9: July 9 2000</h3>
194<ul>
195 <li>fixed the spec the RPMs should be better</li>
196 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
197 rpmfind users problem</li>
198</ul>
199
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]200<h3>2.1.1: July 1 2000</h3>
201<ul>
202 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
203 <li>improvements on the HTML parser</li>
204</ul>
205
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]206<h3>2.1.0 and 1.8.8: June 29 2000</h3>
207<ul>
208 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
209 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
210 about &amp;#38; charref parsing</li>
211 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
212 also contains numerous fixes and enhancements:
213 <ul>
214 <li>added xmlStopParser() to stop parsing</li>
215 <li>improved a lot parsing speed when there is large CDATA blocs</li>
216 <li>includes XPath patches provided by Picdar Technology</li>
217 <li>tried to fix as much as possible DtD validation and namespace
218 related problems</li>
219 <li>output to a given encoding has been added/tested</li>
220 <li>lot of various fixes</li>
221 </ul>
222 </li>
223</ul>
224
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]225<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]226<ul>
227 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]228 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
229 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
230 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]231 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]232 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]233 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]234 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]235 <pre>#include "xxx.h"</pre>
236 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]237 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
238 <li>the memory allocation routines used by libxml can now be overloaded
239 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]240 <li>The previously CVS only tool tester has been renamed
241 <strong>xmllint</strong> and is now installed as part of the libxml2
242 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]243 <li>The I/O interface has been revamped. There is now ways to plug in
244 specific I/O modules, either at the URI scheme detection level using
245 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
246 parser context using xmlCreateIOParserCtxt()</li>
247 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
248 number of the libxml module in use</li>
249 <li>a number of optional features of libxml can now be excluded at configure
250 time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]251</ul>
252
253<h3>2.0.0beta: Mar 14 2000</h3>
254<ul>
255 <li>This is a first Beta release of libxml version 2</li>
256 <li>It's available only from<a href="ftp://rpmfind.net/pub/libxml/">
257 rpmfind.net FTP</a>, it's packaged as libxml2-2.0.0beta and available as
258 tar and RPMs</li>
259 <li>This version is now the head in the Gnome CVS base, the old one is
260 available under the tag LIB_XML_1_X</li>
261 <li>This includes a very large set of changes. Froma programmatic point of
262 view applications should not have to be modified too much, check the <a
263 href="upgrade.html">upgrade page</a></li>
264 <li>Some interfaces may changes (especially a bit about encoding).</li>
265 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]266 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]267 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
268 handled now</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]269 <li>Better handling of entities, especially well formedness checking and
270 proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]271 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]272 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]273 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
274 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]275 </ul>
276 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]277 <li>Serious progress were made toward compliance, <a
278 href="conf/result.html">here are the result of the test</a> against the
279 OASIS testsuite (except the japanese tests since I don't support that
280 encoding yet). This URL is rebuilt every couple of hours using the CVS
281 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]282</ul>
283
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]284<h3>1.8.7: Mar 6 2000</h3>
285<ul>
286 <li>This is a bug fix release:</li>
287 <li>It is possible to disable the ignorable blanks heuristic used by
288 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
289 that for adherence to XML spec, this behaviour will be disabled by default
290 in 2.x . The same function will allow to keep compatibility for old
291 code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]292 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
293 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]294 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
295 compilation on some platforms has been fixed</li>
296 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
297 URIs</li>
298</ul>
299
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]300<h3>1.8.6: Jan 31 2000</h3>
301<ul>
302 <li>added a nanoFTP transport module, debugged until the new version of <a
303 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
304 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]305</ul>
306
307<h3>1.8.5: Jan 21 2000</h3>
308<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]309 <li>adding APIs to parse a well balanced chunk of XML (production <a
310 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML
311 spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]312 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]313 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
314 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]315 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
316 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]317</ul>
318
319<h3>1.8.4: Jan 13 2000</h3>
320<ul>
321 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
322 <li>all exit() call should have been removed from libxml</li>
323 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
324 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]325</ul>
326
327<h3>1.8.3: Jan 5 2000</h3>
328<ul>
329 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]330 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000[diff] [blame]331 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]332 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]333 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
334 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]335 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]336 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]337 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]338</ul>
339
340<h3>1.8.2: Dec 21 1999</h3>
341<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]342 <li>I got another problem with includes and C++, I hope this issue is fixed
343 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]344 <li>Added a few tree modification functions: xmlReplaceNode,
345 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
346 xmlDocSetRootElement</li>
347 <li>Tried to improve the HTML output with help from <a
348 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]349</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]350
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]351<h3>1.8.1: Dec 18 1999</h3>
352<ul>
353 <li>various patches to avoid troubles when using libxml with C++ compilers
354 the "namespace" keyword and C escaping in include files</li>
355 <li>a problem in one of the core macros IS_CHAR was corrected</li>
356 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
357 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]358 <li>fixed a posteriori validation (validation after parsing, or by using a
359 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]360 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]361</ul>
362
363<h3>1.8.0: Dec 12 1999</h3>
364<ul>
365 <li>cleanup, especially memory wise</li>
366 <li>the parser should be more reliable, especially the HTML one, it should
367 not crash, whatever the input !</li>
368 <li>Integrated various patches, especially a speedup improvement for large
369 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
370 configure with --with-buffers to enable them.</li>
371 <li>attribute normalization, oops should have been added long ago !</li>
372 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
373 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]374</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]375
376<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]377<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]378 <li>Lots of HTML improvement</li>
379 <li>Fixed some errors when saving both XML and HTML</li>
380 <li>More examples, the regression tests should now look clean</li>
381 <li>Fixed a bug with contiguous charref</li>
382</ul>
383
384<h3>1.7.3: Sep 29 1999</h3>
385<ul>
386 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]387 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]388 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]389</ul>
390
391<h3>1.7.1: Sep 24 1999</h3>
392<ul>
393 <li>The basic type for strings manipulated by libxml has been renamed in
394 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
395 is that CHAR was conflicting with a predefined type on Windows. However on
396 non WIN32 environment, compatibility is provided by the way of a
397 <strong>#define </strong>.</li>
398 <li>Changed another error : the use of a structure field called errno, and
399 leading to troubles on platforms where it's a macro</li>
400</ul>
401
402<h3>1.7.0: sep 23 1999</h3>
403<ul>
404 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]405 href="html/gnome-xml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]406 <li>Added an errno to report errors by another mean than a simple printf
407 like callback</li>
408 <li>Finished ID/IDREF support and checking when validation</li>
409 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]410 href="html/gnome-xml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]411 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
412 implementation</li>
413 <li>Added an HTML parser front-end</li>
414</ul>
415
416<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]417
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]418<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]419markup-based structured documents. Here is <a name="example">an example XML
420document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]421<pre>&lt;?xml version="1.0"?&gt;
422&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
423 &lt;head&gt;
424 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
425 &lt;/head&gt;
426 &lt;chapter&gt;
427 &lt;title&gt;The Linux adventure&lt;/title&gt;
428 &lt;p&gt;bla bla bla ...&lt;/p&gt;
429 &lt;image href="linus.gif"/&gt;
430 &lt;p&gt;...&lt;/p&gt;
431 &lt;/chapter&gt;
432&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]433
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]434<p>The first line specifies that it's an XML document and gives useful
435information about its encoding. Then the document is a text format whose
436structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]437to be closed</strong>. XML is pedantic about this. However, if a tag is empty
438(no content), a single tag can serve as both the opening and closing tag if it
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]439ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note that,
440for example, the image tag has no content (just an attribute) and is closed by
441ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]442
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]443<p>XML can be applied sucessfully to a wide range of uses, from long term
444structured document maintenance (where it follows the steps of SGML) to simple
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]445data encoding mechanisms like configuration file formatting (glade),
446spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
447it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]448
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]449<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]450
451<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]452returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]453<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]454as the file name, the document type, and a <strong>children</strong> pointer
455which is the root of the document (or more exactly the first child under the
456root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]457chained in double-linked lists of siblings and with children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]458relationship. An xmlNode can also carry properties (a chain of xmlAttr
459structures). An attribute may have a value which is a list of TEXT or
460ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]461
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]462<p>Here is an example (erroneous with respect to the XML spec since there
463should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]464
465<p><img src="structure.gif" alt=" structure.gif "></p>
466
467<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]468called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]469prints them back as parsed. This is useful for detecting errors both in XML
470code and in the XML parser itself. It has an option <strong>--debug</strong>
471which prints the actual in-memory structure of the document, here is the
472result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]473<pre>DOCUMENT
474version=1.0
475standalone=true
476 ELEMENT EXAMPLE
477 ATTRIBUTE prop1
478 TEXT
479 content=gnome is great
480 ATTRIBUTE prop2
481 ENTITY_REF
482 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]483 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]484 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]485 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]486 TEXT
487 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]488 ELEMENT chapter
489 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]490 TEXT
491 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]492 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]493 TEXT
494 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]495 ELEMENT image
496 ATTRIBUTE href
497 TEXT
498 content=linus.gif
499 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]500 TEXT
501 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]502
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]503<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]504
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]505<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]506
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]507<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]508memory. In that case (and if you don't expect to save back the XML document
509loaded using libxml), it's better to use the SAX interface of libxml. SAX is a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]510<strong>callback-based interface</strong> to the parser. Before parsing, the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]511application layer registers a customized set of callbacks which are called by
512the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]513
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]514<p>To get more detailed step-by-step guidance on using the SAX interface of
515libxml, see the
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]516href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html"&gt;nice
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]517documentation.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]518Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]519
520<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
521program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]522binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]523distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]524testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]525<pre>SAX.setDocumentLocator()
526SAX.startDocument()
527SAX.getEntity(amp)
528SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
529SAX.characters( , 3)
530SAX.startElement(head)
531SAX.characters( , 4)
532SAX.startElement(title)
533SAX.characters(Welcome to Gnome, 16)
534SAX.endElement(title)
535SAX.characters( , 3)
536SAX.endElement(head)
537SAX.characters( , 3)
538SAX.startElement(chapter)
539SAX.characters( , 4)
540SAX.startElement(title)
541SAX.characters(The Linux adventure, 19)
542SAX.endElement(title)
543SAX.characters( , 4)
544SAX.startElement(p)
545SAX.characters(bla bla bla ..., 15)
546SAX.endElement(p)
547SAX.characters( , 4)
548SAX.startElement(image, href='linus.gif')
549SAX.endElement(image)
550SAX.characters( , 4)
551SAX.startElement(p)
552SAX.characters(..., 3)
553SAX.endElement(p)
554SAX.characters( , 3)
555SAX.endElement(chapter)
556SAX.characters( , 1)
557SAX.endElement(EXAMPLE)
558SAX.endDocument()</pre>
559
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]560<p>Most of the other functionalities of libxml are based on the DOM
561tree-building facility, so nearly everything up to the end of this document
562presupposes the use of the standard DOM tree build. Note that the DOM tree
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]563itself is built by a set of registered default callbacks, without internal
564specific interface.</p>
565
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]566<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]567
568<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]569using the XML library from the C language. It is not intended to be extensive.
570I hope the automatically generated documents will provide the completeness
571required, but as a separate set of documents. The interfaces of the XML
572library are by principle low level, there is nearly zero abstraction. Those
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]573interested in a higher level API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]574
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]575<p>The <a href="html/gnome-xml-parser.html">parser interfaces for XML</a> are
576separated from the <a href="html/gnome-xml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]577interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]578
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]579<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]580
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]581<p>Usually, the first thing to do is to read an XML input. The parser accepts
582documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]583defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]584<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]585 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]586 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]587 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]588</dl>
589<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]590 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]591 <dd><p>Parse an XML document contained in a (possibly compressed)
592 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]593 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]594</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]595
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]596<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]597failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]598
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]599<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]600
601<p>In order for the application to keep the control when the document is been
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]602fetched (which is common for GUI based programs) libxml provides a push
603interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]604<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
605 void *user_data,
606 const char *chunk,
607 int size,
608 const char *filename);
609int xmlParseChunk (xmlParserCtxtPtr ctxt,
610 const char *chunk,
611 int size,
612 int terminate);</pre>
613
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]614<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]615<pre> FILE *f;
616
617 f = fopen(filename, "r");
618 if (f != NULL) {
619 int res, size = 1024;
620 char chars[1024];
621 xmlParserCtxtPtr ctxt;
622
623 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]624 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]625 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
626 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]627 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]628 xmlParseChunk(ctxt, chars, res, 0);
629 }
630 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]631 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]632 xmlFreeParserCtxt(ctxt);
633 }
634 }</pre>
635
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]636<p>Also note that the HTML parser embedded into libxml also has a push
637interface; the functions are just prefixed by "html" rather than "xml"</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]638
639<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
640
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]641<p>A couple of comments can be made, first this mean that the parser is
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]642memory-hungry, first to load the document in memory, second to build the tree.
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]643Reading a document without building the tree is possible using the SAX
644interfaces (see SAX.h and <a
645href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]646Henstridge's documentation</a>). Note also that the push interface can be
647limited to SAX. Just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]648<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]649
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]650<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]651
652<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]653there is a set of functions dedicated to building new elements. (These are
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]654also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of code
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]655that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]656<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]657 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]658 xmlNodePtr tree, subtree;
659
660 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]661 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
662 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
663 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
664 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]665 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]666 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]667 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
668 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
669 subtree = xmlNewChild(tree, NULL, "image", NULL);
670 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]671
672<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]673
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]674<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]675
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]676<p>Basically by <a href="html/gnome-xml-tree.html">including "tree.h"</a> your
677code has access to the internal structure of all the elements of the tree. The
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]678names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]679<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]680<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]681example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]682<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]683
684<p>points to the title element,</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]685<pre>doc-&gt;children-&gt;children-&gt;next-&gt;child-&gt;child</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]686
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]687<p>points to the text node containing the chapter title "The Linux
688adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]689
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]690<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]691present before the document root, so <code>doc-&gt;children</code> may point
692to an element which is not the document Root Element, a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]693<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]694
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]695<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]696
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]697<p>Functions are provided for reading and writing the document content. Here
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]698is an excerpt from the <a href="html/gnome-xml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]699<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]700 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
701 xmlChar *value);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]702 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The
703 value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]704 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]705</dl>
706<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]707 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]708 *name);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]709 <dd><p>This function returns a pointer to the property content. Note that
710 no extra copy is made.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]711 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]712</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]713
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]714<p>Two functions are provided for reading and writing the text associated with
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]715elements:</p>
716<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]717 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]718 *value);</code></dt>
719 <dd><p>This function takes an "external" string and convert it to one text
720 node or possibly to a list of entity and text nodes. All non-predefined
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]721 entity references like &amp;Gnome; will be stored internally as entity
722 nodes, hence the result of the function may not be a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]723 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]724</dl>
725<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]726 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]727 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]728 <dd><p>This function is the inverse of
729 <code>xmlStringGetNodeList()</code>. It generates a new string
730 containing the content of the text and entity nodes. Note the extra
731 argument inLine. If this argument is set to 1, the function will expand
732 entity references. For example, instead of returning the &amp;Gnome;
733 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]734 "GNU Network Object Model Environment"). Set this argument if you want
735 to use the string for non-XML usage like User Interface.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]736 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]737</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]738
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]739<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]740
741<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]742<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]743 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]744 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]745 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]746 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]747</dl>
748<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]749 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]750 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]751 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]752</dl>
753<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]754 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]755 <dd><p>Saves the document to a file. In this case, the compression
756 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]757 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]758</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]759
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]760<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]761
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]762<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]763accesses. The level of compression on saves can be turned on either globally
764or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]765<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]766 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]767 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]768 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]769</dl>
770<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]771 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]772 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]773 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]774</dl>
775<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]776 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]777 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]778 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]779</dl>
780<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]781 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]782 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]783 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]784</dl>
785
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]786<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]787
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]788<p>Entities in principle are similar to simple C macros. An entity defines an
789abbreviation for a given string that you can reuse many times throughout the
790content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]791may occur frequently within a document, or to confine the change needed to a
792document to a restricted area in the internal subset of the document (at the
793beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]794<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]7952 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]7963 &lt;!ENTITY xml "Extensible Markup Language"&gt;
7974 ]&gt;
7985 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]7996 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]8007 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]801
802<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]803it's name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]804are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]805predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]806<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]807for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]808<strong>&amp;quot;</strong> for the character '"', and
809<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]810
811<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]812substitute an entity's content so that you can see the replacement text in
813your application. Or you may prefer to keep entity references as such in the
814content to be able to save the document back without losing this usually
815precious information (if the user went through the pain of explicitly defining
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]816entities, he may have a a rather negative attitude if you blindly susbtitute
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]817them as saving time). The <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]818href="html/gnome-xml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]819function allows you to check and change the behaviour, which is to not
820substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]821
822<p>Here is the DOM tree built by libxml for the previous document in the
823default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]824<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]825DOCUMENT
826version=1.0
827 ELEMENT EXAMPLE
828 TEXT
829 content=
830 ENTITY_REF
831 INTERNAL_GENERAL_ENTITY xml
832 content=Extensible Markup Language
833 TEXT
834 content=</pre>
835
836<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]837<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]838DOCUMENT
839version=1.0
840 ELEMENT EXAMPLE
841 TEXT
842 content= Extensible Markup Language</pre>
843
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]844<p>So, entities or no entities? Basically, it depends on your use case. I
845suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]846entities in your XML document or data if you are not willing to handle the
847entity references elements in the DOM tree.</p>
848
849<p>Note that at save time libxml enforce the conversion of the predefined
850entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]851transparently replace those with chars (i.e., it will not generate entity
852reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]853finding them in the input).</p>
854
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]855<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]856
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]857<p>The libxml library implements <a
858href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
859recognizing namespace contructs in the input, and does namespace lookup
860automatically when building the DOM tree. A namespace declaration is
861associated with an in-memory structure and all elements or attributes within
862that namespace point to it. Hence testing the namespace is a simple and fast
863equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]864
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]865<p>I suggest that people using libxml use a namespace, and declare it in the
866root element of their document as the default namespace. Then they don't need
867to use the prefix in the content but we will have a basis for future semantic
868refinement and merging of data from different sources. This doesn't augment
869significantly the size of the XML output, but significantly increase its value
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]870in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]871<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
872 &lt;elem1&gt;...&lt;/elem1&gt;
873 &lt;elem2&gt;...&lt;/elem2&gt;
874&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]875
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]876<p>Concerning the namespace value, this has to be an URL, but the URL doesn't
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]877have to point to any existing resource on the Web. It will bind all the
878element and atributes with that URL. I suggest to use an URL within a domain
879you control, and that the URL should contain some kind of version information
880if possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]881a good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]882
883<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]884version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]885and if the version information don't match something you know, warn the user
886and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]887namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
888same as &lt;bar:text&gt; in another document. What really matter is the URI
889associated with the element or the attribute, not the prefix string (which is
890just a shortcut for the full URI). In libxml element and attributes have a
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]891<code>ns</code> field pointing to an xmlNs structure detailing the namespace
892prefix and it's URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]893
894<p>@@Interfaces@@</p>
895
896<p>@@Examples@@</p>
897
898<p>Usually people object using namespace in the case of validation, I object
899this and will make sure that using namespaces won't break validity checking,
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]900so even is you plan to use or currently are using validation I strongly
901suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]902<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]903flexible parsers. Now using namespace to mix and differentiate content coming
904from multiple DTDs will certainly break current validation schemes. I will try
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]905to provide ways to do this, but this may not be portable or standardized.</p>
906
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]907<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]908
909<p>Well what is validation and what is a DTD ?</p>
910
911<p>Validation is the process of checking a document against a set of
912construction rules, a <strong>DTD</strong> (Document Type Definition) is such
913a set of rules.</p>
914
915<p>The validation process and building DTDs are the two most difficult parts
916of XML life cycle. Briefly a DTD defines all the possibles element to be
917found within your document, what is the formal shape of your document tree (by
918defining the allowed content of an element, either text, a regular expression
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]919for the allowed list of children, or mixed content i.e. both text and
920children). The DTD also defines the allowed attributes for all elements and
921the types of the attributes. For more detailed informations, I suggest to read
922the related parts of the XML specification, the examples found under
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]923gnome-xml/test/valid/dtd and the large amount of books available on XML. The
924dia example in gnome-xml/test/valid should be both simple and complete enough
925to allow you to build your own.</p>
926
927<p>A word of warning, building a good DTD which will fit your needs of your
928application in the long-term is far from trivial, however the extra level of
929quality it can insure is well worth the price for some sets of applications or
930if you already have already a DTD defined for your application field.</p>
931
932<p>The validation is not completely finished but in a (very IMHO) usable
933state. Until a real validation interface is defined the way to do it is to
934define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external
935variable to 1, this will of course be changed at some point:</p>
936
937<p>extern int xmlDoValidityCheckingDefaultValue;</p>
938
939<p>...</p>
940
941<p>xmlDoValidityCheckingDefaultValue = 1;</p>
942
943<p></p>
944
945<p>To handle external entities, use the function
946<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
947link in you HTTP/FTP/Entities database library to the standard libxml
948core.</p>
949
950<p>@@interfaces@@</p>
951
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]952<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]953
954<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]955Model</em> this is an API for accessing XML or HTML structured documents.
956Native support for DOM in Gnome is on the way (module gnome-dom), and it will
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]957be based on gnome-xml. This will be a far cleaner interface to manipulate XML
Daniel Veillardc08a2c61999-09-08 21:35:25 +0000[diff] [blame]958files within Gnome since it won't expose the internal structure. DOM defines a
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]959set of IDL (or Java) interfaces allowing to traverse and manipulate a
960document. The DOM library will allow accessing and modifying "live" documents
961presents on other programs like this:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]962
963<p><img src="DOM.gif" alt=" DOM.gif "></p>
964
965<p>This should help greatly doing things like modifying a gnumeric spreadsheet
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]966embedded in a GWP document for example.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]967
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]968<p>The current DOM implementation on top of libxml is the <a
969href="http://cvs.gnome.org/lxr/source/gdome/">gdome Gnome module</a>, this is
970a full DOM interface, thanks to <a href="mailto:raph@levien.com">Raph
971Levien</a>.</p>
972
973<p>The gnome-dom module in the Gnome CVS base is obsolete</p>
974
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]975<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]976
977<p>Here is a real size example, where the actual content of the application
978data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]979a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]980storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
981base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]982<pre>&lt;?xml version="1.0"?&gt;
983&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
984 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]985
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]986 &lt;gjob:Job&gt;
987 &lt;gjob:Project ID="3"/&gt;
988 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
989 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]990
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]991 &lt;gjob:Update&gt;
992 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
993 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
994 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
995 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]996
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]997 &lt;gjob:Developers&gt;
998 &lt;gjob:Developer&gt;
999 &lt;/gjob:Developer&gt;
1000 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1001
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1002 &lt;gjob:Contact&gt;
1003 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1004 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1005 &lt;gjob:Company&gt;
1006 &lt;/gjob:Company&gt;
1007 &lt;gjob:Organisation&gt;
1008 &lt;/gjob:Organisation&gt;
1009 &lt;gjob:Webpage&gt;
1010 &lt;/gjob:Webpage&gt;
1011 &lt;gjob:Snailmail&gt;
1012 &lt;/gjob:Snailmail&gt;
1013 &lt;gjob:Phone&gt;
1014 &lt;/gjob:Phone&gt;
1015 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1016
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1017 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1018 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1019 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1020
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1021 &lt;gjob:Skills&gt;
1022 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1023
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1024 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1025 A GNOME based system that will allow a superuser to configure
1026 compressed and uncompressed files and/or file systems to be backed
1027 up with a supported media in the system. This should be able to
1028 perform via find commands generating a list of files that are passed
1029 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1030 or via operations performed on the filesystem itself. Email
1031 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1032 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1033
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1034 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1035
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1036 &lt;/gjob:Jobs&gt;
1037&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1038
1039<p>While loading the XML file into an internal DOM tree is a matter of calling
1040only a couple of functions, browsing the tree to gather the informations and
1041generate the internals structures is harder, and more error prone.</p>
1042
1043<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1044structure. For example, the ordering of the attributes is not significant,
1045Cthe XML specification is clear about it. It's also usually a good idea to not
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1046be dependent of the orders of the children of a given node, unless it really
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1047makes things harder. Here is some code to parse the informations for a
1048person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1049<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1050 * A person record
1051 */
1052typedef struct person {
1053 char *name;
1054 char *email;
1055 char *company;
1056 char *organisation;
1057 char *smail;
1058 char *webPage;
1059 char *phone;
1060} person, *personPtr;
1061
1062/*
1063 * And the code needed to parse it
1064 */
1065personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1066 personPtr ret = NULL;
1067
1068DEBUG("parsePerson\n");
1069 /*
1070 * allocate the struct
1071 */
1072 ret = (personPtr) malloc(sizeof(person));
1073 if (ret == NULL) {
1074 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1075 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1076 }
1077 memset(ret, 0, sizeof(person));
1078
1079 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1080 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1081 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1082 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1083 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1084 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1085 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1086 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1087 }
1088
1089 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1090}</pre>
1091
1092<p>Here is a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1093<ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1094 <li>Usually a recursive parsing style is the more convenient one, XML data
1095 being by nature subject to repetitive constructs and usualy exibit highly
1096 stuctured patterns.</li>
1097 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e.
1098 the pointer to the global XML document and the namespace reserved to the
1099 application. Document wide information are needed for example to decode
1100 entities and it's a good coding practice to define a namespace for your
1101 application set of data and test that the element and attributes you're
1102 analyzing actually pertains to your application space. This is done by a
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1103 simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1104 <li>To retrieve text and attributes value, it is suggested to use the
1105 function <em>xmlNodeListGetString</em> to gather all the text and entity
1106 reference nodes generated by the DOM output and produce an single text
1107 string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1108</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1109
1110<p>Here is another piece of code used to parse another level of the
1111structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1112<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1113/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1114 * a Description for a Job
1115 */
1116typedef struct job {
1117 char *projectID;
1118 char *application;
1119 char *category;
1120 personPtr contact;
1121 int nbDevelopers;
1122 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1123} job, *jobPtr;
1124
1125/*
1126 * And the code needed to parse it
1127 */
1128jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1129 jobPtr ret = NULL;
1130
1131DEBUG("parseJob\n");
1132 /*
1133 * allocate the struct
1134 */
1135 ret = (jobPtr) malloc(sizeof(job));
1136 if (ret == NULL) {
1137 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1138 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1139 }
1140 memset(ret, 0, sizeof(job));
1141
1142 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1143 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1144 while (cur != NULL) {
1145
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1146 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1147 ret-&gt;projectID = xmlGetProp(cur, "ID");
1148 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1149 fprintf(stderr, "Project has no ID\n");
1150 }
1151 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1152 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1153 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1154 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1155 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1156 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1157 ret-&gt;contact = parsePerson(doc, ns, cur);
1158 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1159 }
1160
1161 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1162}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1163
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1164<p>One can notice that once used to it, writing this kind of code is quite
1165simple, but boring. Ultimately, it could be possble to write stubbers taking
1166either C data structure definitions, a set of XML examples or an XML DTD and
1167produce the code needed to import and export the content between C data and
1168XML storage. This is left as an exercise to the reader :-)</p>
1169
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]1170<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1171parsing example</a> as a template, it is also available with Makefile in the
1172Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1173
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1174<h2><a name="Contributi">Contributions</a></h2>
1175<ul>
1176 <li><a href="mailto:ari@btigate.com">Ari Johnson</a> provides a C++ wrapper
1177 for libxml:
1178 <p>Website: <a
1179 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1180 <p>Download: <a
1181 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1182 </li>
1183 <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a
1184 precompiled Windows version
1185 <p><a
1186 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
1187 </li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]1188 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> provided <a
1189 href="libxml-doc.el">an emacs module</a> to lookup libxml functions
1190 documentation</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1191 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
1192 href="http://xmlsoft.org/messages/0488.html">man pages</a> (not yet
1193 integrated in the distribution)</li>
1194</ul>
1195
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1196<p></p>
1197
1198<p><a href="mailto:Daniel.Veillard@w3.org">Daniel Veillard</a></p>
1199
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame^]1200<p>$Id: xml.html,v 1.40 2000/07/03 16:07:19 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1201</body>
1202</html>