Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / c4f631d28a2c121dda0723e4573dedbe80667373 / . / doc / xml.html
blob: 86d406e1e74a897c9bf943e56a6f9a753c9188b1 [file] [log] [blame]
Daniel Veillard6e93c4a2001-06-05 20:57:42 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3<html>
4<head>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]5 <title>The XML C library for Gnome</title>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]6 <meta name="GENERATOR" content="amaya V4.1">
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"
Daniel Veillardb370a742001-06-09 16:58:47 +0000[diff] [blame]13alt="W3C Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif"
14alt="Red Hat Logo"></a></p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]15
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]16<h1 align="center">The XML C library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]17
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]18<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
19
20<p></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]21<ul>
22 <li><a href="#Introducti">Introduction</a></li>
23 <li><a href="#Documentat">Documentation</a></li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]24 <li><a href="#Reporting">Reporting bugs and getting help</a></li>
25 <li><a href="#help">how to help</a></li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]26 <li><a href="#Downloads">Downloads</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]27 <li><a href="#News">News</a></li>
28 <li><a href="#XML">XML</a></li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]29 <li><a href="#XSLT">XSLT</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]30 <li><a href="#tree">The tree output</a></li>
31 <li><a href="#interface">The SAX interface</a></li>
32 <li><a href="#library">The XML library interfaces</a>
33 <ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]34 <li><a href="#Invoking">Invoking the parser: the pull way</a></li>
35 <li><a href="#Invoking">Invoking the parser: the push way</a></li>
36 <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]37 <li><a href="#Building">Building a tree from scratch</a></li>
38 <li><a href="#Traversing">Traversing the tree</a></li>
39 <li><a href="#Modifying">Modifying the tree</a></li>
40 <li><a href="#Saving">Saving the tree</a></li>
41 <li><a href="#Compressio">Compression</a></li>
42 </ul>
43 </li>
44 <li><a href="#Entities">Entities or no entities</a></li>
45 <li><a href="#Namespaces">Namespaces</a></li>
46 <li><a href="#Validation">Validation</a></li>
47 <li><a href="#Principles">DOM principles</a></li>
48 <li><a href="#real">A real example</a></li>
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]49 <li><a href="#Contributi">Contributions</a></li>
50</ul>
51
52<p>Separate documents:</p>
53<ul>
54 <li><a href="upgrade.html">upgrade instructions for migrating to
55 libxml2</a></li>
56 <li><a href="encoding.html">libxml Internationalization support</a></li>
57 <li><a href="xmlio.html">libxml Input/Output interfaces</a></li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]58 <li><a href="xmlmem.html">libxml Memory interfaces</a></li>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]59 <li><a href="xmldtd.html">a short introduction about DTDs and
60 libxml</a></li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]61 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]62</ul>
63
64<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]65
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]66<p>This document describes libxml, the <a
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]67href="http://www.w3.org/XML/">XML</a> C library developped for the <a
68href="http://www.gnome.org/">Gnome</a> project. <a
69href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
70structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]71
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]72<p>Here are some key points about libxml:</p>
73<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]74 <li>Libxml exports Push and Pull type parser interfaces for both XML and
75 HTML.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]76 <li>Libxml can do DTD validation at parse time, using a parsed document
77 instance, or with an arbitrary DTD.</li>
78 <li>Libxml now includes nearly complete <a
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]79 href="http://www.w3.org/TR/xpath">XPath</a> and <a
Daniel Veillard0c069222000-10-21 09:25:52 +0000[diff] [blame]80 href="http://www.w3.org/TR/xptr">XPointer</a> implementations.</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]81 <li>It is written in plain C, making as few assumptions as possible, and
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]82 sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]83 Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]84 <li>Basic support for HTTP and FTP client allowing aplications to fetch
85 remote resources</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]86 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]87 <li>The internal document repesentation is as close as possible to the <a
88 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
89 <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]90 like interface</a>; the interface is designed to be compatible with <a
91 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]92 <li>This library is released both under the <a
93 href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]94 IPR</a> and the <a href="http://www.gnu.org/copyleft/lesser.html">GNU
95 LGPL</a>. Use either at your convenience, basically this should make
96 everybody happy, if not, drop me a mail.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]97</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]98
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]99<p>Warning: unless you are forced to because your application links with a
100Gnome library requiring it, <strong><span
101style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
102libxml2</p>
103
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]104<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]105
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]106<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]107<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]108 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]109 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]110 documentation</a> automatically extracted from code comments (using <a
111 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gtk-doc">gtk
112 doc</a>).</li>
Daniel Veillard8d869642000-07-14 12:12:59 +0000[diff] [blame]113 <li>Look at the documentation about <a href="encoding.html">libxml
114 internationalization support</a></li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]115 <li>This page provides a global overview and <a href="#real">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]116 examples</a> on how to use libxml.</li>
117 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
118 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
119 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]120 <li>George Lebl wrote <a
121 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]122 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]123 <li>It is also a good idea to check to <a href="mailto:raph@levien.com">Raph
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]124 Levien</a>'s <a href="http://levien.com/gnome/">web site</a> since he is
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]125 building the <a href="http://levien.com/gnome/gdome.html">DOM interface
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]126 gdome</a> on top of libxml result tree and an implementation of <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]127 href="http://www.w3.org/Graphics/SVG/">SVG</a> called <a
128 href="http://www.levien.com/svg/">gill</a>. Check his <a
129 href="http://www.levien.com/gnome/domination.html">DOMination
130 paper</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]131 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
132 file</a></li>
133 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
134 starting a new project using libxml you should really use the 2.x
135 version.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]136 <li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]137 archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]138</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]139
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]140<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]141
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]142<p>Well, bugs or missing features are always possible, and I will make a point
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]143of fixing them in a timely fashion. The best way to report a bug is to use the
Daniel Veillard81781102001-03-07 09:31:47 +0000[diff] [blame]144<a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome bug
145tracking database</a> (make sure to use the "libxml" module name). I look at
146reports there regularly and it's good to have a reminder when a bug is still
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]147open. Check the <a
148href="http://bugzilla.gnome.org/bugwritinghelp.html">instructions on reporting
149bugs</a> and be sure to specify that the bug is for the package libxml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]150
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]151<p>There is also a mailing-list <a
Daniel Veillard3197f162001-04-04 00:40:08 +0000[diff] [blame]152href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
153href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
154href="http://xmlsoft.org/messages">old</a>). To subscribe to this list, please
155visit the <a href="http://mail.gnome.org/mailman/listinfo/xml">associated
156Web</a> page and follow the instructions.</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]157
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]158<p>Alternatively, you can just send the bug to the <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]159href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard6e93c4a2001-06-05 20:57:42 +0000[diff] [blame]160related I will approve it.. Please do not send me mail directly especially for
161portability problem, it makes things really harder to track and in some cases
162I'm not the best person to answer a given question, ask the list instead.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]163
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]164<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]165probably be processed faster.</p>
166
167<p>If you're looking for help, a quick look at <a
168href="http://xmlsoft.org/messages/#407">the list archive</a> may actually
169provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]170questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]171documentantion</a> is not as polished as I would like (i need to learn more
172about Docbook), but it's a good starting point.</p>
173
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]174<h2><a name="help">How to help</a></h2>
175
176<p>You can help the project in various ways, the best thing to do first is to
177subscribe to the mailing-list as explained before, check the <a
178href="http://xmlsoft.org/messages/">archives </a>and the <a
179href="http://bugs.gnome.org/db/pa/lgnome-xml.html">Gnome bug
180database:</a>:</p>
181<ol>
182 <li>provide patches when you find problems</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]183 <li>provide the diffs when you port libxml to a new platform. They may not
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]184 be integrated in all cases but help pinpointing portability problems
185 and</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]186 <li>provide documentation fixes (either as patches to the code comments or
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]187 as HTML diffs).</li>
188 <li>provide new documentations pieces (translations, examples, etc ...)</li>
189 <li>Check the TODO file and try to close one of the items</li>
190 <li>take one of the points raised in the archive or the bug database and
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]191 provide a fix. <a href="mailto:Daniel.Veillard@imag.fr">Get in touch with
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]192 me </a>before to avoid synchronization problems and check that the
193 suggested fix will fit in nicely :-)</li>
194</ol>
195
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]196<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]197
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]198<p>The latest versions of libxml can be found on <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]199href="ftp://xmlsoft.org/">xmlsoft.org</a> or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]200href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]201as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]202archive</a> or <a
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]203href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM
204packages</a>. (NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]205href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
206href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]207packages installed to compile applications using libxml.)</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]208
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]209<p><a name="Snapshot">Snapshot:</a></p>
210<ul>
211 <li>Code from the W3C cvs base libxml <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]212 href="ftp://xmlsoft.org/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]213 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]214 href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]215</ul>
216
217<p><a name="Contribs">Contribs:</a></p>
218
219<p>I do accept external contributions, especially if compiling on another
220platform, get in touch with me to upload the package. I will keep them in the
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]221<a href="ftp://xmlsoft.org/contribs/">contrib directory</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]222
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]223<p>Libxml is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]224<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]225 <li><p>The <a
226 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]227 CVS base</a>. Check the <a
228 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> page;
229 the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]230 </li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]231 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]232</ul>
233
234<h2><a name="News">News</a></h2>
235
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]236<h3>CVS only : check the <a
237href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]238for a really accurate description</h3>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]239
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]240<p>Items floating around but not actively worked on, get in touch with me if
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]241you want to test those</p>
242<ul>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]243 <li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done as
244 a separate C library on top of libxml called libxslt, not released yet but
245 available from CVS</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]246 <li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a
247 href="http://www.w3.org/TR/xinclude">XInclude</a></li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]248 <li>(seeems working but delayed from release) parsing/import of Docbook SGML
249 docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]250</ul>
251
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]252<h3>2.3.10: June 1 2001</h3>
253<ul>
254 <li>fixed the SGML catalog support</li>
255 <li>a number of reported bugs got fixed, in XPath, iconv detection, XInclude
256 processing</li>
257 <li>XPath string function should now handle unicode correctly</li>
258</ul>
259
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]260<h3>2.3.9: May 19 2001</h3>
261
262<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
263<ul>
264 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
265 <li>some serious speed optimisation again</li>
266 <li>some documentation cleanups</li>
267 <li>trying to get better linking on solaris (-R)</li>
268 <li>XPath API cleanup from Thomas Broyer</li>
269 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
270 xmlValidGetValidElements()</li>
271 <li>Added an INSTALL file</li>
272 <li>Attribute removal added to API: #54433</li>
273 <li>added a basic support for SGML catalogs</li>
274 <li>fixed xmlKeepBlanksDefault(0) API</li>
275 <li>bugfix in xmlNodeGetLang()</li>
276 <li>fixed a small configure portability problem</li>
277 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
278</ul>
279
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]280<h3>1.8.13: May 14 2001</h3>
281<ul>
282 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
283</ul>
284
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]285<h3>2.3.8: May 3 2001</h3>
286<ul>
287 <li>Integrated an SGML DocBook parser for the Gnome project</li>
288 <li>Fixed a few things in the HTML parser</li>
289 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
290 point portability issue</li>
291 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for DOM+validation
292 using the XML REC as input and a 700MHz celeron).</li>
293 <li>incorporated more Windows cleanup</li>
294 <li>added xmlSaveFormatFile()</li>
295 <li>fixed problems in copying nodes with entities references (gdome)</li>
296 <li>removed some troubles surrounding the new validation module</li>
297</ul>
298
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]299<h3>2.3.7: April 22 2001</h3>
300<ul>
301 <li>lots of small bug fixes, corrected XPointer</li>
302 <li>Non determinist content model validation support</li>
303 <li>added xmlDocCopyNode for gdome2</li>
304 <li>revamped the way the HTML parser handles end of tags</li>
305 <li>XPath: corrctions of namespacessupport and number formatting</li>
306 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
307 <li>HTML ouput fixes from P C Chow and William M. Brack</li>
308 <li>Improved validation speed sensible for DocBook</li>
309 <li>fixed a big bug with ID declared in external parsed entities</li>
310 <li>portability fixes, update of Trio from Bjorn Reese</li>
311</ul>
312
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]313<h3>2.3.6: April 8 2001</h3>
314<ul>
315 <li>Code cleanup using extreme gcc compiler warning options, found and
316 cleared half a dozen potential problem</li>
317 <li>the Eazel team found an XML parser bug</li>
318 <li>cleaned up the user of some of the string formatting function. used the
319 trio library code to provide the one needed when the platform is missing
320 them</li>
321 <li>xpath: removed a memory leak and fixed the predicate evaluation problem,
322 extended the testsuite and cleaned up the result. XPointer seems broken
323 ...</li>
324</ul>
325
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]326<h3>2.3.5: Mar 23 2001</h3>
327<ul>
328 <li>Biggest change is separate parsing and evaluation of XPath expressions,
329 there is some new APIs for this too</li>
330 <li>included a number of bug fixes(XML push parser, 51876, notations,
331 52299)</li>
332 <li>Fixed some portability issues</li>
333</ul>
334
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]335<h3>2.3.4: Mar 10 2001</h3>
336<ul>
337 <li>Fixed bugs #51860 and #51861</li>
338 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
339 size to be application tunable.</li>
340 <li>Some cleanup in the validation code, still a bug left and this part
341 should probably be rewritten to support ambiguous content model :-\</li>
342 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
343 parser</li>
344 <li>Fixed another bug in xmlNodeGetContent()</li>
345 <li>Bjorn fixed XPath node collection and Number formatting</li>
346 <li>Fixed a loop reported in the HTML parsing</li>
347 <li>blank space are reported even if the Dtd content model proves that they
348 are formatting spaces, this is for XmL conformance</li>
349</ul>
350
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]351<h3>2.3.3: Mar 1 2001</h3>
352<ul>
353 <li>small change in XPath for XSLT</li>
354 <li>documentation cleanups</li>
355 <li>fix in validation by Gary Pennington</li>
356 <li>serious parsing performances improvements</li>
357</ul>
358
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]359<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]360<ul>
361 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
362 <li>fixed a Dtd parsing bug</li>
363 <li>fixed a bug in xmlNodeGetContent</li>
364 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
365</ul>
366
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]367<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]368<ul>
369 <li>some XPath and HTML bug fixes for XSLT</li>
370 <li>small extension of the hash table interfaces for DOM gdome2
371 implementation</li>
372 <li>A few bug fixes</li>
373</ul>
374
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]375<h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]376<ul>
377 <li>Lots of XPath bug fixes</li>
378 <li>Add a mode with Dtd lookup but without validation error reporting for
379 XSLT</li>
380 <li>Add support for text node without escaping (XSLT)</li>
381 <li>bug fixes for xmlCheckFilename</li>
382 <li>validation code bug fixes from Gary Pennington</li>
383 <li>Patch from Paul D. Smith correcting URI path normalization</li>
384 <li>Patch to allow simultaneous install of libxml-devel and
385 libxml2-devel</li>
386 <li>the example Makefile is now fixed</li>
387 <li>added HTML to the RPM packages</li>
388 <li>tree copying bugfixes</li>
389 <li>updates to Windows makefiles</li>
390 <li>optimisation patch from Bjorn Reese</li>
391</ul>
392
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]393<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]394<ul>
395 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
396 <li>added htmlHandleOmittedElem()</li>
397 <li>Applied Bjorn Reese's IPV6 first patch</li>
398 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]399 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]400</ul>
401
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]402<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]403<ul>
404 <li>Fix the Windows problems of 2.2.8</li>
405 <li>integrate OpenVMS patches</li>
406 <li>better handling of some nasty HTML input</li>
407 <li>Improved the XPointer implementation</li>
408 <li>integrate a number of provided patches</li>
409</ul>
410
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]411<h3>2.2.9: Nov 25 2000</h3>
412<ul>
413 <li>erroneous release :-(</li>
414</ul>
415
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]416<h3>2.2.8: Nov 13 2000</h3>
417<ul>
418 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
419 support</li>
420 <li>Patch in conditional section handling</li>
421 <li>updated MS compiler project</li>
422 <li>fixed some XPath problems</li>
423 <li>added an URI escaping function</li>
424 <li>some other bug fixes</li>
425</ul>
426
427<h3>2.2.7: Oct 31 2000</h3>
428<ul>
429 <li>added message redirection</li>
430 <li>XPath improvements (thanks TOM !)</li>
431 <li>xmlIOParseDTD() added</li>
432 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
433 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
434</ul>
435
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]436<h3>2.2.6: Oct 25 2000:</h3>
437<ul>
438 <li>Added an hash table module, migrated a number of internal structure to
439 those</li>
440 <li>Fixed a posteriori validation problems</li>
441 <li>HTTP module cleanups</li>
442 <li>HTML parser improvements (tag errors, script/style handling, attribute
443 normalization)</li>
444 <li>coalescing of adjacent text nodes</li>
445 <li>couple of XPath bug fixes, exported the internal API</li>
446</ul>
447
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]448<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]449<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]450 <li>XPointer implementation and testsuite</li>
451 <li>Lot of XPath fixes, added variable and functions registration, more
452 tests</li>
453 <li>Portability fixes, lots of enhancements toward an easy Windows build and
454 release</li>
455 <li>Late validation fixes</li>
456 <li>Integrated a lot of contributed patches</li>
457 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]458 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]459</ul>
460
461<h3>2.2.4: Oct 1 2000:</h3>
462<ul>
463 <li>main XPath problem fixed</li>
464 <li>Integrated portability patches for Windows</li>
465 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]466</ul>
467
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]468<h3>2.2.3: Sep 17 2000</h3>
469<ul>
470 <li>bug fixes</li>
471 <li>cleanup of entity handling code</li>
472 <li>overall review of all loops in the parsers, all sprintf usage has been
473 checked too</li>
474 <li>Far better handling of larges Dtd. Validating against Docbook XML Dtd
475 works smoothly now.</li>
476</ul>
477
478<h3>1.8.10: Sep 6 2000</h3>
479<ul>
480 <li>bug fix release for some Gnome projects</li>
481</ul>
482
483<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]484<ul>
485 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]486 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]487</ul>
488
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]489<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]490<ul>
491 <li>a purely bug fixes release</li>
492 <li>fixed an encoding support problem when parsing from a memory block</li>
493 <li>fixed a DOCTYPE parsing problem</li>
494 <li>removed a bug in the function allowing to override the memory allocation
495 routines</li>
496</ul>
497
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]498<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]499<ul>
500 <li>applied a lot of portability fixes</li>
501 <li>better encoding support/cleanup and saving (content is now always
502 encoded in UTF-8)</li>
503 <li>the HTML parser now correctly handles encodings</li>
504 <li>added xmlHasProp()</li>
505 <li>fixed a serious problem with &amp;#38;</li>
506 <li>propagated the fix to FTP client</li>
507 <li>cleanup, bugfixes, etc ...</li>
508 <li>Added a page about <a href="encoding.html">libxml Internationalization
509 support</a></li>
510</ul>
511
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]512<h3>1.8.9: July 9 2000</h3>
513<ul>
514 <li>fixed the spec the RPMs should be better</li>
515 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
516 rpmfind users problem</li>
517</ul>
518
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]519<h3>2.1.1: July 1 2000</h3>
520<ul>
521 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
522 <li>improvements on the HTML parser</li>
523</ul>
524
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]525<h3>2.1.0 and 1.8.8: June 29 2000</h3>
526<ul>
527 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
528 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
529 about &amp;#38; charref parsing</li>
530 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
531 also contains numerous fixes and enhancements:
532 <ul>
533 <li>added xmlStopParser() to stop parsing</li>
534 <li>improved a lot parsing speed when there is large CDATA blocs</li>
535 <li>includes XPath patches provided by Picdar Technology</li>
536 <li>tried to fix as much as possible DtD validation and namespace
537 related problems</li>
538 <li>output to a given encoding has been added/tested</li>
539 <li>lot of various fixes</li>
540 </ul>
541 </li>
542</ul>
543
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]544<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]545<ul>
546 <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]547 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
548 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
549 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]550 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]551 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]552 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]553 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]554 <pre>#include "xxx.h"</pre>
555 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]556 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
557 <li>the memory allocation routines used by libxml can now be overloaded
558 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]559 <li>The previously CVS only tool tester has been renamed
560 <strong>xmllint</strong> and is now installed as part of the libxml2
561 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]562 <li>The I/O interface has been revamped. There is now ways to plug in
563 specific I/O modules, either at the URI scheme detection level using
564 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
565 parser context using xmlCreateIOParserCtxt()</li>
566 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
567 number of the libxml module in use</li>
568 <li>a number of optional features of libxml can now be excluded at configure
569 time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]570</ul>
571
572<h3>2.0.0beta: Mar 14 2000</h3>
573<ul>
574 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]575 <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
576 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
577 RPMs</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]578 <li>This version is now the head in the Gnome CVS base, the old one is
579 available under the tag LIB_XML_1_X</li>
580 <li>This includes a very large set of changes. Froma programmatic point of
581 view applications should not have to be modified too much, check the <a
582 href="upgrade.html">upgrade page</a></li>
583 <li>Some interfaces may changes (especially a bit about encoding).</li>
584 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]585 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]586 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
587 handled now</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]588 <li>Better handling of entities, especially well formedness checking and
589 proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]590 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]591 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]592 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
593 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]594 </ul>
595 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]596 <li>Serious progress were made toward compliance, <a
597 href="conf/result.html">here are the result of the test</a> against the
598 OASIS testsuite (except the japanese tests since I don't support that
599 encoding yet). This URL is rebuilt every couple of hours using the CVS
600 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]601</ul>
602
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]603<h3>1.8.7: Mar 6 2000</h3>
604<ul>
605 <li>This is a bug fix release:</li>
606 <li>It is possible to disable the ignorable blanks heuristic used by
607 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
608 that for adherence to XML spec, this behaviour will be disabled by default
609 in 2.x . The same function will allow to keep compatibility for old
610 code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]611 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
612 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]613 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
614 compilation on some platforms has been fixed</li>
615 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
616 URIs</li>
617</ul>
618
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]619<h3>1.8.6: Jan 31 2000</h3>
620<ul>
621 <li>added a nanoFTP transport module, debugged until the new version of <a
622 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
623 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]624</ul>
625
626<h3>1.8.5: Jan 21 2000</h3>
627<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]628 <li>adding APIs to parse a well balanced chunk of XML (production <a
629 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML
630 spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]631 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]632 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
633 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]634 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
635 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]636</ul>
637
638<h3>1.8.4: Jan 13 2000</h3>
639<ul>
640 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
641 <li>all exit() call should have been removed from libxml</li>
642 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
643 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]644</ul>
645
646<h3>1.8.3: Jan 5 2000</h3>
647<ul>
648 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]649 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000[diff] [blame]650 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]651 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]652 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
653 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]654 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]655 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]656 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]657</ul>
658
659<h3>1.8.2: Dec 21 1999</h3>
660<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]661 <li>I got another problem with includes and C++, I hope this issue is fixed
662 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]663 <li>Added a few tree modification functions: xmlReplaceNode,
664 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
665 xmlDocSetRootElement</li>
666 <li>Tried to improve the HTML output with help from <a
667 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]668</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]669
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]670<h3>1.8.1: Dec 18 1999</h3>
671<ul>
672 <li>various patches to avoid troubles when using libxml with C++ compilers
673 the "namespace" keyword and C escaping in include files</li>
674 <li>a problem in one of the core macros IS_CHAR was corrected</li>
675 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
676 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]677 <li>fixed a posteriori validation (validation after parsing, or by using a
678 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]679 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]680</ul>
681
682<h3>1.8.0: Dec 12 1999</h3>
683<ul>
684 <li>cleanup, especially memory wise</li>
685 <li>the parser should be more reliable, especially the HTML one, it should
686 not crash, whatever the input !</li>
687 <li>Integrated various patches, especially a speedup improvement for large
688 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
689 configure with --with-buffers to enable them.</li>
690 <li>attribute normalization, oops should have been added long ago !</li>
691 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
692 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]693</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]694
695<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]696<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]697 <li>Lots of HTML improvement</li>
698 <li>Fixed some errors when saving both XML and HTML</li>
699 <li>More examples, the regression tests should now look clean</li>
700 <li>Fixed a bug with contiguous charref</li>
701</ul>
702
703<h3>1.7.3: Sep 29 1999</h3>
704<ul>
705 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]706 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]707 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]708</ul>
709
710<h3>1.7.1: Sep 24 1999</h3>
711<ul>
712 <li>The basic type for strings manipulated by libxml has been renamed in
713 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
714 is that CHAR was conflicting with a predefined type on Windows. However on
715 non WIN32 environment, compatibility is provided by the way of a
716 <strong>#define </strong>.</li>
717 <li>Changed another error : the use of a structure field called errno, and
718 leading to troubles on platforms where it's a macro</li>
719</ul>
720
721<h3>1.7.0: sep 23 1999</h3>
722<ul>
723 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]724 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]725 <li>Added an errno to report errors by another mean than a simple printf
726 like callback</li>
727 <li>Finished ID/IDREF support and checking when validation</li>
728 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]729 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]730 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
731 implementation</li>
732 <li>Added an HTML parser front-end</li>
733</ul>
734
735<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]736
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]737<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]738markup-based structured documents. Here is <a name="example">an example XML
739document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]740<pre>&lt;?xml version="1.0"?&gt;
741&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
742 &lt;head&gt;
743 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
744 &lt;/head&gt;
745 &lt;chapter&gt;
746 &lt;title&gt;The Linux adventure&lt;/title&gt;
747 &lt;p&gt;bla bla bla ...&lt;/p&gt;
748 &lt;image href="linus.gif"/&gt;
749 &lt;p&gt;...&lt;/p&gt;
750 &lt;/chapter&gt;
751&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]752
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]753<p>The first line specifies that it's an XML document and gives useful
754information about its encoding. Then the document is a text format whose
755structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]756to be closed</strong>. XML is pedantic about this. However, if a tag is empty
757(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]758ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note that,
759for example, the image tag has no content (just an attribute) and is closed by
760ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]761
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]762<p>XML can be applied sucessfully to a wide range of uses, from long term
763structured document maintenance (where it follows the steps of SGML) to simple
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]764data encoding mechanisms like configuration file formatting (glade),
765spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
766it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]767
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]768<h2><a name="XSLT">XSLT</a></h2>
769
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]770<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
771
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]772<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a language
773for transforming XML documents into other XML documents (or HTML/textual
774output).</p>
775
776<p>A separate library called libxslt is being built on top of libxml2. This
777module "libxslt" can be found in the Gnome CVS base too.</p>
778
Daniel Veillard383b1472001-01-23 11:39:52 +0000[diff] [blame]779<p>You can check the <a
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]780href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a> supported
781and the progresses on the <a
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]782href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p>
783
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]784<h2>An overview of libxml architecture</h2>
785
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]786<p>Libxml is made of multiple components; some of them are optional, and most
787of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]788<ul>
789 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]790 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]791 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]792 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]793 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]794 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]795 <li>a SAX tree module to build an in-memory DOM representation</li>
796 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]797 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]798 <li>an XPath module for global lookup in a DOM representation
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]799 (optional)</li>
800 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]801</ul>
802
803<p>Graphically this gives the following:</p>
804
805<p><img src="libxml.gif" alt="a graphical view of the various"></p>
806
807<p></p>
808
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]809<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]810
811<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]812returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]813<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]814as the file name, the document type, and a <strong>children</strong> pointer
815which is the root of the document (or more exactly the first child under the
816root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]817chained in double-linked lists of siblings and with a children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]818relationship. An xmlNode can also carry properties (a chain of xmlAttr
819structures). An attribute may have a value which is a list of TEXT or
820ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]821
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]822<p>Here is an example (erroneous with respect to the XML spec since there
823should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]824
825<p><img src="structure.gif" alt=" structure.gif "></p>
826
827<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]828called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]829prints them back as parsed. This is useful for detecting errors both in XML
830code and in the XML parser itself. It has an option <strong>--debug</strong>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]831which prints the actual in-memory structure of the document; here is the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]832result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]833<pre>DOCUMENT
834version=1.0
835standalone=true
836 ELEMENT EXAMPLE
837 ATTRIBUTE prop1
838 TEXT
839 content=gnome is great
840 ATTRIBUTE prop2
841 ENTITY_REF
842 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]843 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]844 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]845 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]846 TEXT
847 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]848 ELEMENT chapter
849 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]850 TEXT
851 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]852 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]853 TEXT
854 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]855 ELEMENT image
856 ATTRIBUTE href
857 TEXT
858 content=linus.gif
859 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]860 TEXT
861 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]862
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]863<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]864
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]865<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]866
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]867<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]868memory. In that case (and if you don't expect to save back the XML document
869loaded 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]870<strong>callback-based interface</strong> to the parser. Before parsing, the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]871application layer registers a customized set of callbacks which are called by
872the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]873
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]874<p>To get more detailed step-by-step guidance on using the SAX interface of
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]875libxml, see the <a
876href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
877documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]878Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]879
880<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
881program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]882binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]883distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]884testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]885<pre>SAX.setDocumentLocator()
886SAX.startDocument()
887SAX.getEntity(amp)
888SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
889SAX.characters( , 3)
890SAX.startElement(head)
891SAX.characters( , 4)
892SAX.startElement(title)
893SAX.characters(Welcome to Gnome, 16)
894SAX.endElement(title)
895SAX.characters( , 3)
896SAX.endElement(head)
897SAX.characters( , 3)
898SAX.startElement(chapter)
899SAX.characters( , 4)
900SAX.startElement(title)
901SAX.characters(The Linux adventure, 19)
902SAX.endElement(title)
903SAX.characters( , 4)
904SAX.startElement(p)
905SAX.characters(bla bla bla ..., 15)
906SAX.endElement(p)
907SAX.characters( , 4)
908SAX.startElement(image, href='linus.gif')
909SAX.endElement(image)
910SAX.characters( , 4)
911SAX.startElement(p)
912SAX.characters(..., 3)
913SAX.endElement(p)
914SAX.characters( , 3)
915SAX.endElement(chapter)
916SAX.characters( , 1)
917SAX.endElement(EXAMPLE)
918SAX.endDocument()</pre>
919
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]920<p>Most of the other interfaces of libxml are based on the DOM tree-building
921facility, so nearly everything up to the end of this document presupposes the
922use of the standard DOM tree build. Note that the DOM tree itself is built by
923a set of registered default callbacks, without internal specific
924interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]925
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]926<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]927
928<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]929using the XML library from the C language. It is not intended to be extensive.
930I hope the automatically generated documents will provide the completeness
931required, but as a separate set of documents. The interfaces of the XML
932library are by principle low level, there is nearly zero abstraction. Those
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]933interested in a higher level API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]934
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]935<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
936separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]937interfaces</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]938
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]939<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]940
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]941<p>Usually, the first thing to do is to read an XML input. The parser accepts
942documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]943defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]944<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]945 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]946 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]947 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]948</dl>
949<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]950 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]951 <dd><p>Parse an XML document contained in a (possibly compressed)
952 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]953 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]954</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]955
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]956<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]957failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]958
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]959<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]960
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]961<p>In order for the application to keep the control when the document is being
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]962fetched (which is common for GUI based programs) libxml provides a push
963interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]964<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
965 void *user_data,
966 const char *chunk,
967 int size,
968 const char *filename);
969int xmlParseChunk (xmlParserCtxtPtr ctxt,
970 const char *chunk,
971 int size,
972 int terminate);</pre>
973
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]974<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]975<pre> FILE *f;
976
977 f = fopen(filename, "r");
978 if (f != NULL) {
979 int res, size = 1024;
980 char chars[1024];
981 xmlParserCtxtPtr ctxt;
982
983 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]984 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]985 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
986 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]987 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]988 xmlParseChunk(ctxt, chars, res, 0);
989 }
990 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]991 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]992 xmlFreeParserCtxt(ctxt);
993 }
994 }</pre>
995
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]996<p>The HTML parser embedded into libxml also has a push interface; the
997functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]998
999<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
1000
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1001<p>The tree-building interface makes the parser memory-hungry, first loading
1002the document in memory and then building the tree itself. Reading a document
1003without building the tree is possible using the SAX interfaces (see SAX.h and
1004<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1005Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1006limited to SAX: just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1007<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1008
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1009<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1010
1011<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]1012there is a set of functions dedicated to building new elements. (These are
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1013also 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]1014that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1015<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1016 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1017 xmlNodePtr tree, subtree;
1018
1019 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1020 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
1021 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
1022 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
1023 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1024 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1025 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1026 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
1027 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
1028 subtree = xmlNewChild(tree, NULL, "image", NULL);
1029 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1030
1031<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1032
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1033<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1034
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1035<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1036code has access to the internal structure of all the elements of the tree. The
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1037names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1038<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1039<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1040example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1041<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1042
1043<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1044<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1045
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1046<p>points to the text node containing the chapter title "The Linux
1047adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1048
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1049<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]1050present before the document root, so <code>doc-&gt;children</code> may point
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1051to an element which is not the document Root Element; a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]1052<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1053
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1054<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1055
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1056<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1057is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1058<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1059 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
1060 xmlChar *value);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1061 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The
1062 value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1063 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1064</dl>
1065<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1066 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1067 *name);</code></dt>
Daniel Veillardc92c3042000-09-29 02:42:04 +0000[diff] [blame]1068 <dd><p>This function returns a pointer to new copy of the property
1069 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1070 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1071</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1072
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1073<p>Two functions are provided for reading and writing the text associated with
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1074elements:</p>
1075<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1076 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1077 *value);</code></dt>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1078 <dd><p>This function takes an "external" string and converts it to one
1079 text node or possibly to a list of entity and text nodes. All
1080 non-predefined entity references like &amp;Gnome; will be stored
1081 internally as entity nodes, hence the result of the function may not be
1082 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1083 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1084</dl>
1085<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1086 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1087 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1088 <dd><p>This function is the inverse of
1089 <code>xmlStringGetNodeList()</code>. It generates a new string
1090 containing the content of the text and entity nodes. Note the extra
1091 argument inLine. If this argument is set to 1, the function will expand
1092 entity references. For example, instead of returning the &amp;Gnome;
1093 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1094 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1095 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1096</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1097
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1098<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1099
1100<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1101<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1102 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1103 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1104 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1105 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1106</dl>
1107<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1108 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1109 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1110 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1111</dl>
1112<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1113 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1114 <dd><p>Saves the document to a file. In this case, the compression
1115 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1116 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1117</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1118
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1119<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1120
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1121<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1122accesses. The level of compression on saves can be turned on either globally
1123or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1124<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1125 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1126 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1127 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1128</dl>
1129<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1130 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1131 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1132 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1133</dl>
1134<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1135 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1136 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1137 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1138</dl>
1139<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1140 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1141 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1142 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1143</dl>
1144
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1145<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1146
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1147<p>Entities in principle are similar to simple C macros. An entity defines an
1148abbreviation for a given string that you can reuse many times throughout the
1149content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1150may occur frequently within a document, or to confine the change needed to a
1151document to a restricted area in the internal subset of the document (at the
1152beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1153<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]11542 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]11553 &lt;!ENTITY xml "Extensible Markup Language"&gt;
11564 ]&gt;
11575 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]11586 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]11597 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1160
1161<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1162its name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1163are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1164predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1165<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1166for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1167<strong>&amp;quot;</strong> for the character '"', and
1168<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1169
1170<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]1171substitute an entity's content so that you can see the replacement text in
1172your application. Or you may prefer to keep entity references as such in the
1173content to be able to save the document back without losing this usually
1174precious information (if the user went through the pain of explicitly defining
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1175entities, he may have a a rather negative attitude if you blindly susbtitute
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1176them as saving time). The <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1177href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1178function allows you to check and change the behaviour, which is to not
1179substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1180
1181<p>Here is the DOM tree built by libxml for the previous document in the
1182default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1183<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1184DOCUMENT
1185version=1.0
1186 ELEMENT EXAMPLE
1187 TEXT
1188 content=
1189 ENTITY_REF
1190 INTERNAL_GENERAL_ENTITY xml
1191 content=Extensible Markup Language
1192 TEXT
1193 content=</pre>
1194
1195<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1196<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1197DOCUMENT
1198version=1.0
1199 ELEMENT EXAMPLE
1200 TEXT
1201 content= Extensible Markup Language</pre>
1202
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1203<p>So, entities or no entities? Basically, it depends on your use case. I
1204suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1205entities in your XML document or data if you are not willing to handle the
1206entity references elements in the DOM tree.</p>
1207
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1208<p>Note that at save time libxml enforces the conversion of the predefined
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1209entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1210transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1211reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1212finding them in the input).</p>
1213
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1214<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1215on top of the libxml SAX interface is difficult!!! If you plan to use
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1216non-predefined entities in your documents, then the learning cuvre to handle
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1217then using the SAX API may be long. If you plan to use complex documents, I
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1218strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]1219deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1220
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1221<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1222
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1223<p>The libxml library implements <a
1224href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
1225recognizing namespace contructs in the input, and does namespace lookup
1226automatically when building the DOM tree. A namespace declaration is
1227associated with an in-memory structure and all elements or attributes within
1228that namespace point to it. Hence testing the namespace is a simple and fast
1229equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1230
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1231<p>I suggest that people using libxml use a namespace, and declare it in the
1232root element of their document as the default namespace. Then they don't need
1233to use the prefix in the content but we will have a basis for future semantic
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1234refinement and merging of data from different sources. This doesn't increase
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1235the size of the XML output significantly, but significantly increases its
1236value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1237<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
1238 &lt;elem1&gt;...&lt;/elem1&gt;
1239 &lt;elem2&gt;...&lt;/elem2&gt;
1240&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1241
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1242<p>The namespace value has to be an absolute URL, but the URL doesn't have to
1243point to any existing resource on the Web. It will bind all the element and
1244atributes with that URL. I suggest to use an URL within a domain you control,
1245and that the URL should contain some kind of version information if possible.
1246For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good
1247namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1248
1249<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1250version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1251and if the version information don't match something you know, warn the user
1252and 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]1253namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1254same as &lt;bar:text&gt; in another document. What really matters is the URI
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1255associated with the element or the attribute, not the prefix string (which is
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1256just a shortcut for the full URI). In libxml, element and attributes have an
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1257<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1258prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1259
1260<p>@@Interfaces@@</p>
1261
1262<p>@@Examples@@</p>
1263
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1264<p>Usually people object to using namespaces together with validity checking.
1265I will try to make sure that using namespaces won't break validity checking,
1266so even if you plan to use or currently are using validation I strongly
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1267suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1268<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1269flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1270from multiple DTDs will certainly break current validation schemes. I will try
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1271to provide ways to do this, but this may not be portable or standardized.</p>
1272
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1273<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1274
1275<p>Well what is validation and what is a DTD ?</p>
1276
1277<p>Validation is the process of checking a document against a set of
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1278construction rules; a <strong>DTD</strong> (Document Type Definition) is such
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1279a set of rules.</p>
1280
1281<p>The validation process and building DTDs are the two most difficult parts
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1282of the XML life cycle. Briefly a DTD defines all the possibles element to be
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1283found within your document, what is the formal shape of your document tree (by
1284defining the allowed content of an element, either text, a regular expression
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1285for the allowed list of children, or mixed content i.e. both text and
1286children). The DTD also defines the allowed attributes for all elements and
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1287the types of the attributes. For more detailed information, I suggest that you
Daniel Veillard81781102001-03-07 09:31:47 +0000[diff] [blame]1288read the related parts of the XML specification, the examples found under
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1289gnome-xml/test/valid/dtd and any of the large number of books available on
1290XML. The dia example in gnome-xml/test/valid should be both simple and
1291complete enough to allow you to build your own.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1292
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1293<p>A word of warning, building a good DTD which will fit the needs of your
1294application in the long-term is far from trivial; however, the extra level of
1295quality it can ensure is well worth the price for some sets of applications or
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1296if you already have already a DTD defined for your application field.</p>
1297
1298<p>The validation is not completely finished but in a (very IMHO) usable
1299state. Until a real validation interface is defined the way to do it is to
1300define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external
1301variable to 1, this will of course be changed at some point:</p>
1302
1303<p>extern int xmlDoValidityCheckingDefaultValue;</p>
1304
1305<p>...</p>
1306
1307<p>xmlDoValidityCheckingDefaultValue = 1;</p>
1308
1309<p></p>
1310
1311<p>To handle external entities, use the function
1312<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
1313link in you HTTP/FTP/Entities database library to the standard libxml
1314core.</p>
1315
1316<p>@@interfaces@@</p>
1317
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1318<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1319
1320<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1321Model</em>; this is an API for accessing XML or HTML structured documents.
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1322Native support for DOM in Gnome is on the way (module gnome-dom), and will be
1323based on gnome-xml. This will be a far cleaner interface to manipulate XML
Daniel Veillard3197f162001-04-04 00:40:08 +0000[diff] [blame]1324files within Gnome since it won't expose the internal structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1325
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1326<p>The current DOM implementation on top of libxml is the <a
Daniel Veillarda47fb3d2001-03-25 17:23:49 +0000[diff] [blame]1327href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
1328is a full DOM interface, thanks to Paolo Casarini, check the <a
1329href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
1330informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1331
Daniel Veillarda47fb3d2001-03-25 17:23:49 +0000[diff] [blame]1332<p>The gnome-dom and gdome modules in the Gnome CVS base are obsolete</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1333
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1334<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1335
1336<p>Here is a real size example, where the actual content of the application
1337data 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]1338a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1339storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
1340base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1341<pre>&lt;?xml version="1.0"?&gt;
1342&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
1343 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1344
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1345 &lt;gjob:Job&gt;
1346 &lt;gjob:Project ID="3"/&gt;
1347 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
1348 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1349
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1350 &lt;gjob:Update&gt;
1351 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
1352 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
1353 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
1354 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1355
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1356 &lt;gjob:Developers&gt;
1357 &lt;gjob:Developer&gt;
1358 &lt;/gjob:Developer&gt;
1359 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1360
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1361 &lt;gjob:Contact&gt;
1362 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1363 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1364 &lt;gjob:Company&gt;
1365 &lt;/gjob:Company&gt;
1366 &lt;gjob:Organisation&gt;
1367 &lt;/gjob:Organisation&gt;
1368 &lt;gjob:Webpage&gt;
1369 &lt;/gjob:Webpage&gt;
1370 &lt;gjob:Snailmail&gt;
1371 &lt;/gjob:Snailmail&gt;
1372 &lt;gjob:Phone&gt;
1373 &lt;/gjob:Phone&gt;
1374 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1375
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1376 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1377 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1378 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1379
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1380 &lt;gjob:Skills&gt;
1381 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1382
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1383 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1384 A GNOME based system that will allow a superuser to configure
1385 compressed and uncompressed files and/or file systems to be backed
1386 up with a supported media in the system. This should be able to
1387 perform via find commands generating a list of files that are passed
1388 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1389 or via operations performed on the filesystem itself. Email
1390 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1391 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1392
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1393 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1394
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1395 &lt;/gjob:Jobs&gt;
1396&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1397
1398<p>While loading the XML file into an internal DOM tree is a matter of calling
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1399only a couple of functions, browsing the tree to gather the ata and generate
1400the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1401
1402<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1403structure. For example, the ordering of the attributes is not significant, the
1404XML specification is clear about it. It's also usually a good idea not to
1405depend on the order of the children of a given node, unless it really makes
1406things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1407<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1408 * A person record
1409 */
1410typedef struct person {
1411 char *name;
1412 char *email;
1413 char *company;
1414 char *organisation;
1415 char *smail;
1416 char *webPage;
1417 char *phone;
1418} person, *personPtr;
1419
1420/*
1421 * And the code needed to parse it
1422 */
1423personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1424 personPtr ret = NULL;
1425
1426DEBUG("parsePerson\n");
1427 /*
1428 * allocate the struct
1429 */
1430 ret = (personPtr) malloc(sizeof(person));
1431 if (ret == NULL) {
1432 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1433 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1434 }
1435 memset(ret, 0, sizeof(person));
1436
1437 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1438 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1439 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1440 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1441 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1442 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1443 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1444 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1445 }
1446
1447 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1448}</pre>
1449
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1450<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1451<ul>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1452 <li>Usually a recursive parsing style is the more convenient one: XML data
1453 is by nature subject to repetitive constructs and usually exibits highly
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1454 stuctured patterns.</li>
1455 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e.
1456 the pointer to the global XML document and the namespace reserved to the
1457 application. Document wide information are needed for example to decode
1458 entities and it's a good coding practice to define a namespace for your
1459 application set of data and test that the element and attributes you're
1460 analyzing actually pertains to your application space. This is done by a
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1461 simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1462 <li>To retrieve text and attributes value, you can use the function
1463 <em>xmlNodeListGetString</em> to gather all the text and entity reference
1464 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1465</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1466
1467<p>Here is another piece of code used to parse another level of the
1468structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1469<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1470/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1471 * a Description for a Job
1472 */
1473typedef struct job {
1474 char *projectID;
1475 char *application;
1476 char *category;
1477 personPtr contact;
1478 int nbDevelopers;
1479 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1480} job, *jobPtr;
1481
1482/*
1483 * And the code needed to parse it
1484 */
1485jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1486 jobPtr ret = NULL;
1487
1488DEBUG("parseJob\n");
1489 /*
1490 * allocate the struct
1491 */
1492 ret = (jobPtr) malloc(sizeof(job));
1493 if (ret == NULL) {
1494 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1495 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1496 }
1497 memset(ret, 0, sizeof(job));
1498
1499 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1500 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1501 while (cur != NULL) {
1502
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1503 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1504 ret-&gt;projectID = xmlGetProp(cur, "ID");
1505 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1506 fprintf(stderr, "Project has no ID\n");
1507 }
1508 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1509 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1510 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1511 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1512 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1513 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1514 ret-&gt;contact = parsePerson(doc, ns, cur);
1515 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1516 }
1517
1518 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1519}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1520
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1521<p>Once you are used to it, writing this kind of code is quite simple, but
1522boring. Ultimately, it could be possble to write stubbers taking either C data
1523structure definitions, a set of XML examples or an XML DTD and produce the
1524code needed to import and export the content between C data and XML storage.
1525This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1526
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]1527<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1528parsing example</a> as a template, it is also available with Makefile in the
1529Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1530
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1531<h2><a name="Contributi">Contributions</a></h2>
1532<ul>
Daniel Veillard851c59c2000-11-24 16:06:22 +0000[diff] [blame]1533 <li><a href="mailto:ari@lusis.org">Ari Johnson</a> provides a C++ wrapper
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1534 for libxml:
1535 <p>Website: <a
1536 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1537 <p>Download: <a
1538 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1539 </li>
1540 <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a
1541 precompiled Windows version
1542 <p><a
1543 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
1544 </li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]1545 <li><a
1546 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
1547 Sergeant</a> developped <a
1548 href="http://axkit.org/download/">XML::LibXSLT</a>, a perl wrapper for
1549 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
1550 application server</a></li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]1551 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> provided <a
1552 href="libxml-doc.el">an emacs module</a> to lookup libxml functions
1553 documentation</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1554 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
1555 href="http://xmlsoft.org/messages/0488.html">man pages</a> (not yet
1556 integrated in the distribution)</li>
1557</ul>
1558
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1559<p></p>
1560
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]1561<p><a href="mailto:Daniel.Veillard@imag.fr">Daniel Veillard</a></p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1562
Daniel Veillardb370a742001-06-09 16:58:47 +0000[diff] [blame]1563<p>$Id: xml.html,v 1.86 2001/06/05 20:57:42 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1564</body>
1565</html>