Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / b6c1e2f9362af99f8f35ea4b299d34d297c615cd / . / doc / xml.html
blob: 99e16341f0a498c7f2e1335a3d0524d90ed1078d [file] [log] [blame]
Daniel Veillard09ab7e12001-07-10 15:49:44 +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 Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]6 <meta name="GENERATOR" content="amaya V5.0">
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 Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]11<h1 align="center">The XML C library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]12
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]13<h1>Note: this is the flat content of the <a href="index.html">web
14site</a></h1>
15
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]16<h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]17
18<p></p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]19
20<p>Libxml is the XML C library developped for the Gnome project. XML itself
21is a metalanguage to design markup languages, i.e. text language where
22semantic and structure are added to the content using extra "markup"
23information enclosed between angle bracket. HTML is the most well-known
24markup language.</p>
25
26<p>Libxml2 implements a number of existing standards related to markup
27languages:</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]28<ul>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]29 <li>the XML standard: <a
30 href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li>
31 <li>Namespaces in XML: <a
32 href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li>
33 <li>XML Base: <a
34 href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li>
35 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]36 : Uniform Resource Identifiers <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]37 href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li>
38 <li>XML Path Language (XPath) 1.0: <a
39 href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li>
40 <li>HTML4 parser: <a
41 href="http://www.w3.org/TR/html401/">http://www.w3.org/TR/html401/</a></li>
42 <li>most of XML Pointer Language (XPointer) Version 1.0: <a
43 href="http://www.w3.org/TR/xptr">http://www.w3.org/TR/xptr</a></li>
44 <li>XML Inclusions (XInclude) Version 1.0: <a
45 href="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</a></li>
46 <li>[ISO-8859-1], <a
47 href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8]
48 and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>
49 [UTF-16] core encodings</li>
50 <li>part of SGML Open Technical Resolution TR9401:1997</li>
51 <li>XML Catalogs Working Draft 06 August 2001: <a
52 href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html">http://www.oasis-open.org/committees/entity/spec-2001-08-06.html</a></li>
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]53</ul>
54
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]55<p>In most cases libxml tries to implement the specifications in a relatively
56strict way. To some extent libxml2 provide some support for the following
57other specification but don't claim to implement them:</p>
58<ul>
59 <li>Document Object Model (DOM) <a
60 href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>
61 it doesn't implement the API itself, gdome2 does this in top of
62 libxml2</li>
63 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]64 : libxml implements a basic FTP client code</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]65 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]66 : HTTP/1.0, again a basic HTTP client code</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]67 <li>SAX: a minimal SAX implementation compatible with early expat
68 versions</li>
69 <li>DocBook SGML v4: libxml2 includes a hackish parser to transition to
70 XML</li>
71</ul>
72
Daniel Veillard845cce42002-01-09 11:51:37 +0000[diff] [blame]73<p>Libxml2 is known to be very portable, should build and work without
74serious troubles on a variety of systems (Linux, Unix, Windows, CygWin,
75MacOs, MacOsX, RISC Os, OS/2, VMS, QNX, MVS, ...)</p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]76
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]77<p>Separate documents:</p>
78<ul>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]79 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a>
80 providing an implementation of XSLT 1.0 and extensions on top of
81 libxml2</li>
82 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page</a>
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]83 : a standard DOM2 implementation based on libxml2</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]84</ul>
85
86<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]87
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]88<p>This document describes libxml, the <a
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]89href="http://www.w3.org/XML/">XML</a> C library developped for the <a
90href="http://www.gnome.org/">Gnome</a> project. <a
91href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
92structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]93
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]94<p>Here are some key points about libxml:</p>
95<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]96 <li>Libxml exports Push and Pull type parser interfaces for both XML and
97 HTML.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]98 <li>Libxml can do DTD validation at parse time, using a parsed document
99 instance, or with an arbitrary DTD.</li>
100 <li>Libxml now includes nearly complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000[diff] [blame]101 href="http://www.w3.org/TR/xpath">XPath</a>, <a
102 href="http://www.w3.org/TR/xptr">XPointer</a> and <a
103 href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]104 <li>It is written in plain C, making as few assumptions as possible, and
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]105 sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]106 Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]107 <li>Basic support for HTTP and FTP client allowing aplications to fetch
108 remote resources</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]109 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]110 <li>The internal document repesentation is as close as possible to the <a
111 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
112 <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]113 like interface</a>; the interface is designed to be compatible with <a
114 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]115 <li>This library is released under the <a
116 href="http://www.opensource.org/licenses/mit-license.html">MIT
117 Licence</a> see the Copyright file in the distribution for the precise
118 wording.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]119</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]120
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]121<p>Warning: unless you are forced to because your application links with a
122Gnome library requiring it, <strong><span
123style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
124libxml2</p>
125
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]126<h2><a name="FAQ">FAQ</a></h2>
127
128<p>Table of Content:</p>
129<ul>
130 <li><a href="FAQ.html#Licence">Licence(s)</a></li>
131 <li><a href="FAQ.html#Installati">Installation</a></li>
132 <li><a href="FAQ.html#Compilatio">Compilation</a></li>
133 <li><a href="FAQ.html#Developer">Developer corner</a></li>
134</ul>
135
136<h3><a name="Licence">Licence</a>(s)</h3>
137<ol>
138 <li><em>Licensing Terms for libxml</em>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]139 <p>libxml is released under the <a
140 href="http://www.opensource.org/licenses/mit-license.html">MIT
141 Licence</a>, see the file Copyright in the distribution for the precise
142 wording</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]143 </li>
144 <li><em>Can I embed libxml in a proprietary application ?</em>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]145 <p>Yes. The MIT Licence allows you to also keep proprietary the changes
146 you made to libxml, but it would be graceful to provide back bugfixes and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]147 improvements as patches for possible incorporation in the main
148 development tree</p>
149 </li>
150</ol>
151
152<h3><a name="Installati">Installation</a></h3>
153<ol>
154 <li>Unless you are forced to because your application links with a Gnome
155 library requiring it, <strong><span style="background-color: #FF0000">Do
156 Not Use libxml1</span></strong>, use libxml2</li>
157 <li><em>Where can I get libxml</em>
158 ?
159 <p>The original distribution comes from <a
160 href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> or <a
161 href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">gnome.org</a></p>
162 <p>Most linux and Bsd distribution includes libxml, this is probably the
163 safer way for end-users</p>
164 <p>David Doolin provides precompiled Windows versions at <a
165 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/ ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
166 </li>
167 <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
168 <ul>
169 <li>If you are not concerned by any existing backward compatibility
170 with existing application, install libxml2 only</li>
171 <li>If you are not doing development, you can safely install both.
172 usually the packages <a
173 href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a
174 href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
175 compatible (this is not the case for development packages)</li>
176 <li>If you are a developer and your system provides separate packaging
177 for shared libraries and the development components, it is possible
178 to install libxml and libxml2, and also <a
179 href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
180 and <a
181 href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
182 too for libxml2 &gt;= 2.3.0</li>
183 <li>If you are developing a new application, please develop against
184 libxml2(-devel)</li>
185 </ul>
186 </li>
187 <li><em>I can't install the libxml package it conflicts with libxml0</em>
188 <p>You probably have an old libxml0 package used to provide the shared
189 library for libxml.so.0, you can probably safely remove it. Anyway the
190 libxml packages provided on <a
191 href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> provides
192 libxml.so.0</p>
193 </li>
194 <li><em>I can't install the libxml(2) RPM package due to failed
195 dependancies</em>
196 <p>The most generic solution is to refetch the latest src.rpm , and
197 rebuild it locally with</p>
198 <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code></p>
199 <p>if everything goes well it will generate two binary rpm (one providing
200 the shared libs and xmllint, and the other one, the -devel package
201 providing includes, static libraries and scripts needed to build
202 applications with libxml(2)) that you can install locally.</p>
203 </li>
204</ol>
205
206<h3><a name="Compilatio">Compilation</a></h3>
207<ol>
208 <li><em>What is the process to compile libxml ?</em>
209 <p>As most UNIX libraries libxml follows the "standard":</p>
210 <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
211 <p><code>cd libxml-xxxx</code></p>
212 <p><code>./configure --help</code></p>
213 <p>to see the options, then the compilation/installation proper</p>
214 <p><code>./configure [possible options]</code></p>
215 <p><code>make</code></p>
216 <p><code>make install</code></p>
217 <p>At that point you may have to rerun ldconfig or similar utility to
218 update your list of installed shared libs.</p>
219 </li>
220 <li><em>What other libraries are needed to compile/install libxml ?</em>
221 <p>Libxml does not requires any other library, the normal C ANSI API
222 should be sufficient (please report any violation to this rule you may
223 find).</p>
224 <p>However if found at configuration time libxml will detect and use the
225 following libs:</p>
226 <ul>
227 <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a>
228 : a highly portable and available widely compression library</li>
229 <li>iconv: a powerful character encoding conversion library. It's
230 included by default on recent glibc libraries, so it doesn't need to
231 be installed specifically on linux. It seems it's now <a
232 href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
233 of the official UNIX</a> specification. Here is one <a
234 href="http://clisp.cons.org/~haible/packages-libiconv.html">implementation
235 of the library</a> which source can be found <a
236 href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
237 </ul>
238 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]239 <li><em>make check fails on some platforms</em>
240 <p>Sometime the regression tests results don't completely match the value
241 produced by the parser, and the makefile uses diff to print the delta. On
242 some platforms the diff return breaks the compilation process, if the
243 diff is small this is probably not a serious problem</p>
244 </li>
245 <li><em>I use the CVS version and there is no configure script</em>
246 <p>The configure (and other Makefiles) are generated. Use the autogen.sh
247 script to regenerate the configure and Makefiles, like:</p>
248 <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
249 </li>
250 <li><em>I have troubles when running make tests with gcc-3.0</em>
251 <p>It seems the initial release of gcc-3.0 has a problem with the
252 optimizer which miscompiles the URI module. Please use another
253 compiler</p>
254 </li>
255</ol>
256
257<h3><a name="Developer">Developer</a> corner</h3>
258<ol>
259 <li><em>xmlDocDump() generates output on one line</em>
260 <p>libxml will not <strong>invent</strong> spaces in the content of a
261 document since <strong>all spaces in the content of a document are
262 significant</strong>. If you build a tree from the API and want
263 indentation:</p>
264 <ol>
265 <li>the correct way is to generate those yourself too</li>
266 <li>the dangerous way is to ask libxml to add those blanks to your
267 content <strong>modifying the content of your document in the
268 process</strong>. The result may not be what you expect. There is
269 <strong>NO</strong> way to guarantee that such a modification won't
270 impact other part of the content of your document. See <a
271 href="http://xmlsoft.org/html/libxml-parser.html#XMLKEEPBLANKSDEFAULT">xmlKeepBlanksDefault
272 ()</a> and <a
273 href="http://xmlsoft.org/html/libxml-tree.html#XMLSAVEFORMATFILE">xmlSaveFormatFile
274 ()</a></li>
275 </ol>
276 </li>
277 <li>Extra nodes in the document:
278 <p><em>For a XML file as below:</em></p>
279 <pre>&lt;?xml version="1.0"?&gt;
280&lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
281&lt;NODE CommFlag="0"/&gt;
282&lt;NODE CommFlag="1"/&gt;
283&lt;/PLAN&gt;</pre>
284 <p><em>after parsing it with the function
285 pxmlDoc=xmlParseFile(...);</em></p>
286 <p><em>I want to the get the content of the first node (node with the
287 CommFlag="0")</em></p>
288 <p><em>so I did it as following;</em></p>
289 <pre>xmlNodePtr pode;
290pnode=pxmlDoc-&gt;children-&gt;children;</pre>
291 <p><em>but it does not work. If I change it to</em></p>
292 <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
293 <p><em>then it works. Can someone explain it to me.</em></p>
294 <p></p>
295 <p>In XML all characters in the content of the document are significant
296 <strong>including blanks and formatting line breaks</strong>.</p>
297 <p>The extra nodes you are wondering about are just that, text nodes with
298 the formatting spaces wich are part of the document but that people tend
299 to forget. There is a function <a
300 href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
301 ()</a> to remove those at parse time, but that's an heuristic, and its
302 use should be limited to case where you are sure there is no
303 mixed-content in the document.</p>
304 </li>
305 <li><em>I get compilation errors of existing code like when accessing
306 <strong>root</strong> or <strong>childs fields</strong> of nodes</em>
307 <p>You are compiling code developed for libxml version 1 and using a
308 libxml2 development environment. Either switch back to libxml v1 devel or
309 even better fix the code to compile with libxml2 (or both) by <a
310 href="upgrade.html">following the instructions</a>.</p>
311 </li>
312 <li><em>I get compilation errors about non existing
313 <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
314 fields</em>
315 <p>The source code you are using has been <a
316 href="upgrade.html">upgraded</a> to be able to compile with both libxml
317 and libxml2, but you need to install a more recent version:
318 libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
319 </li>
320 <li><em>XPath implementation looks seriously broken</em>
321 <p>XPath implementation prior to 2.3.0 was really incomplete, upgrade to
322 a recent version, the implementation and debug of libxslt generated fixes
323 for most obvious problems.</p>
324 </li>
325 <li><em>The example provided in the web page does not compile</em>
326 <p>It's hard to maintain the documentation in sync with the code
327 &lt;grin/&gt; ...</p>
328 <p>Check the previous points 1/ and 2/ raised before, and send
329 patches.</p>
330 </li>
331 <li><em>Where can I get more examples and informations than in the web
332 page</em>
333 <p>Ideally a libxml book would be nice. I have no such plan ... But you
334 can:</p>
335 <ul>
336 <li>check more deeply the <a href="html/libxml-lib.html">existing
337 generated doc</a></li>
338 <li>looks for examples of use for libxml function using the Gnome code
339 for example the following will query the full Gnome CVs base for the
340 use of the <strong>xmlAddChild()</strong> function:
341 <p><a
342 href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p>
343 <p>This may be slow, a large hardware donation to the gnome project
344 could cure this :-)</p>
345 </li>
346 <li><a
347 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Browse
348 the libxml source</a>
349 , I try to write code as clean and documented as possible, so
350 looking at it may be helpful</li>
351 </ul>
352 </li>
353 <li>What about C++ ?
354 <p>libxml is written in pure C in order to allow easy reuse on a number
355 of platforms, including embedded systems. I don't intend to convert to
356 C++.</p>
357 <p>There is however a C++ wrapper provided by Ari Johnson
358 &lt;ari@btigate.com&gt; which may fullfill your needs:</p>
359 <p>Website: <a
360 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
361 <p>Download: <a
362 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
363 </li>
364 <li>How to validate a document a posteriori ?
365 <p>It is possible to validate documents which had not been validated at
366 initial parsing time or documents who have been built from scratch using
367 the API. Use the <a
368 href="http://xmlsoft.org/html/libxml-valid.html#XMLVALIDATEDTD">xmlValidateDtd()</a>
369 function. It is also possible to simply add a Dtd to an existing
370 document:</p>
371 <pre>xmlDocPtr doc; /* your existing document */
372 xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
373 dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
374
375 doc-&gt;intSubset = dtd;
376 if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
377 else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
378 </pre>
379 </li>
380 <li>etc ...</li>
381</ol>
382
383<p></p>
384
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]385<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]386
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]387<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]388<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]389 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]390 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]391 documentation</a> automatically extracted from code comments (using <a
392 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gtk-doc">gtk
393 doc</a>).</li>
Daniel Veillard8d869642000-07-14 12:12:59 +0000[diff] [blame]394 <li>Look at the documentation about <a href="encoding.html">libxml
395 internationalization support</a></li>
Daniel Veillardbc66f852002-01-14 09:49:20 +0000[diff] [blame]396 <li>This page provides a global overview and <a href="example.html">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]397 examples</a> on how to use libxml.</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]398 <li><a href="mailto:james@daa.com.au">James Henstridge</a>
399 wrote <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]400 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
401 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]402 <li>George Lebl wrote <a
403 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]404 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]405 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
406 file</a></li>
407 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
408 starting a new project using libxml you should really use the 2.x
409 version.</li>
Daniel Veillard845cce42002-01-09 11:51:37 +0000[diff] [blame]410 <li>And don't forget to look at the <a
411 href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]412</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]413
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]414<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]415
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]416<p>Well, bugs or missing features are always possible, and I will make a
417point of fixing them in a timely fashion. The best way to report a bug is to
418use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome
419bug tracking database</a> (make sure to use the "libxml" module name). I look
420at reports there regularly and it's good to have a reminder when a bug is
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]421still open. Be sure to specify that the bug is for the package libxml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]422
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]423<p>There is also a mailing-list <a
Daniel Veillard3197f162001-04-04 00:40:08 +0000[diff] [blame]424href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
425href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]426href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
427please visit the <a
428href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
429follow the instructions. <strong>Do not send code, I won't debug it</strong>
430(but patches are really appreciated!).</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]431
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]432<p>Check the following <strong><span style="color: #FF0000">before
433posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]434<ul>
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]435 <li>read the <a href="FAQ.html">FAQ</a></li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]436 <li>make sure you are <a href="ftp://xmlsoft.org/">using a recent
437 version</a>, and that the problem still shows up in those</li>
438 <li>check the <a href="http://mail.gnome.org/archives/xml/">list
439 archives</a> to see if the problem was reported already, in this case
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]440 there is probably a fix available, similary check the <a
441 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">registered
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]442 open bugs</a></li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]443 <li>make sure you can reproduce the bug with xmllint or one of the test
444 programs found in source in the distribution</li>
445 <li>Please send the command showing the error as well as the input (as an
446 attachement)</li>
447</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]448
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]449<p>Then send the bug with associated informations to reproduce it to the <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]450href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]451related I will approve it.. Please do not send me mail directly, it makes
452things really harder to track and in some cases I'm not the best person to
453answer a given question, ask the list instead.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]454
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]455<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]456probably be processed faster.</p>
457
458<p>If you're looking for help, a quick look at <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]459href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]460provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]461questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]462documentantion</a> is not as polished as I would like (i need to learn more
463about Docbook), but it's a good starting point.</p>
464
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]465<h2><a name="help">How to help</a></h2>
466
467<p>You can help the project in various ways, the best thing to do first is to
468subscribe to the mailing-list as explained before, check the <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]469href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
470href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome bug
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]471database:</a>:</p>
472<ol>
473 <li>provide patches when you find problems</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]474 <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]475 be integrated in all cases but help pinpointing portability problems
476 and</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]477 <li>provide documentation fixes (either as patches to the code comments or
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]478 as HTML diffs).</li>
479 <li>provide new documentations pieces (translations, examples, etc ...)</li>
480 <li>Check the TODO file and try to close one of the items</li>
481 <li>take one of the points raised in the archive or the bug database and
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]482 provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
483 </a>before to avoid synchronization problems and check that the suggested
484 fix will fit in nicely :-)</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]485</ol>
486
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]487<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]488
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]489<p>The latest versions of libxml can be found on <a
Daniel Veillard20c8cf22001-06-26 22:47:36 +0000[diff] [blame]490href="ftp://xmlsoft.org/">xmlsoft.org</a> (<a
491href="ftp://speakeasy.rpmfind.net/pub/libxml/">Seattle</a>, <a
492href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]493href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]494as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]495archive</a> or <a
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]496href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM
497packages</a>. (NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]498href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
499href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard95189532001-07-26 18:30:26 +0000[diff] [blame]500packages installed to compile applications using libxml.) <a
501href="mailto:izlatkovic@daenet.de">Igor Zlatkovic</a> is now the maintainer
502of the Windows port, <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]503href="http://www.fh-frankfurt.de/~igor/projects/libxml/index.html">he
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]504provides binaries</a>. <a href="mailto:Gary.Pennington@sun.com">Gary
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]505Pennington</a> provides <a href="http://garypennington.net/libxml2/">Solaris
506binaries</a>.</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]507
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]508<p><a name="Snapshot">Snapshot:</a></p>
509<ul>
510 <li>Code from the W3C cvs base libxml <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]511 href="ftp://xmlsoft.org/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]512 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]513 href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]514</ul>
515
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]516<p><a name="Contribs">Contributions:</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]517
518<p>I do accept external contributions, especially if compiling on another
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]519platform, get in touch with me to upload the package, wrappers for various
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]520languages have been provided, and can be found in the <a
521href="contribs.html">contrib section</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]522
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]523<p>Libxml is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]524<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]525 <li><p>The <a
526 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]527 CVS base</a>. Check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]528 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a>
529 page; the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]530 </li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]531 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]532</ul>
533
534<h2><a name="News">News</a></h2>
535
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]536<h3>CVS only : check the <a
537href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]538for a really accurate description</h3>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]539
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]540<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]541you want to test those</p>
542<ul>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]543 <li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done
544 as a separate C library on top of libxml called libxslt</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]545 <li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a
546 href="http://www.w3.org/TR/xinclude">XInclude</a></li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]547 <li>(seeems working but delayed from release) parsing/import of Docbook
548 SGML docs</li>
549</ul>
550
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame^]551<h3>2.4.14: Feb 8 2002</h3>
552<ul>
553 <li>Change of Licence to the <a
554 href="http://www.opensource.org/licenses/mit-license.html">MIT
555 Licence</a> basisally for integration in XFree86 codebase, and removing
556 confusion around the previous dual-licencing</li>
557 <li>added Python bindings, beta software but should already be quite
558 complete</li>
559 <li>a large number of fixes and cleanups, especially for all tree
560 manipulations</li>
561 <li>cleanup of the headers, generation of a reference API definition in
562 XML</li>
563</ul>
564
565<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]566<ul>
567 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
568 <li>cleanup of timing code from Justin Fletcher</li>
569 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
570 Narojnyi</li>
571 <li>Cygwin patch from Robert Collins</li>
572 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
573</ul>
574
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]575<h3>2.4.12: Dec 7 2001</h3>
576<ul>
577 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
578 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
579 (robert)</li>
580 <li>Eric Lavigne contributed project files for MacOS</li>
581 <li>some makefiles cleanups</li>
582</ul>
583
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]584<h3>2.4.11: Nov 26 2001</h3>
585<ul>
586 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
587 cleanups</li>
588 <li>xmllint man pages improvement by Heiko Rupp</li>
589 <li>updated VMS build instructions from John A Fotheringham</li>
590 <li>Windows Makefiles updates from Igor</li>
591</ul>
592
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]593<h3>2.4.10: Nov 10 2001</h3>
594<ul>
595 <li>URI escaping fix (Joel Young)</li>
596 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
597 <li>Fixes namespace handling problems when using DTD and validation</li>
598 <li>improvements on xmllint: Morus Walter patches for --format and
599 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
600 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
601 <li>fixes to the HTML parser</li>
602</ul>
603
604<h3>2.4.9: Nov 6 2001</h3>
605<ul>
606 <li>fixes more catalog bugs</li>
607 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
608</ul>
609
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]610<h3>2.4.8: Nov 4 2001</h3>
611<ul>
612 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
613 tool</li>
614 <li>fixed a compile errors and some includes troubles.</li>
615</ul>
616
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]617<h3>2.4.7: Oct 30 2001</h3>
618<ul>
619 <li>exported some debugging interfaces</li>
620 <li>serious rewrite of the catalog code</li>
621 <li>integrated Gary Pennington thread safety patch, added configure option
622 and regression tests</li>
623 <li>removed an HTML parser bug</li>
624 <li>fixed a couple of potentially serious validation bugs</li>
625 <li>integrated the SGML DocBook support in xmllint</li>
626 <li>changed the nanoftp anonymous login passwd</li>
627 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
628 <li>general bug fixes</li>
629 <li>updated xmllint man page by John Fleck</li>
630 <li>some VMS and Windows updates</li>
631</ul>
632
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]633<h3>2.4.6: Oct 10 2001</h3>
634<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]635 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]636 <li>portability and configure fixes</li>
637 <li>an infinite loop on the HTML parser was removed (William)</li>
638 <li>Windows makefile patches from Igor</li>
639 <li>fixed half a dozen bugs reported fof libxml or libxslt</li>
640 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
641</ul>
642
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]643<h3>2.4.5: Sep 14 2001</h3>
644<ul>
645 <li>Remove a few annoying bugs in 2.4.4</li>
646 <li>forces the HTML serializer to output decimal charrefs since some
647 version of Netscape can't handle hexadecimal ones</li>
648</ul>
649
650<h3>1.8.16: Sep 14 2001</h3>
651<ul>
652 <li>maintenance release of the old libxml1 branch, couple of bug and
653 portability fixes</li>
654</ul>
655
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]656<h3>2.4.4: Sep 12 2001</h3>
657<ul>
658 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
659 Catalog</li>
660 <li>a few bug fixes and some portability changes</li>
661 <li>some documentation cleanups</li>
662</ul>
663
Daniel Veillard39936902001-08-24 00:49:01 +0000[diff] [blame]664<h3>2.4.3: Aug 23 2001</h3>
665<ul>
666 <li>XML Catalog support see the doc</li>
667 <li>New NaN/Infinity floating point code</li>
668 <li>A few bug fixes</li>
669</ul>
670
671<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]672<ul>
673 <li>adds xmlLineNumbersDefault() to control line number generation</li>
674 <li>lot of bug fixes</li>
675 <li>the Microsoft MSC projects files shuld now be up to date</li>
676 <li>inheritance of namespaces from DTD defaulted attributes</li>
677 <li>fixes a serious potential security bug</li>
678 <li>added a --format option to xmllint</li>
679</ul>
680
681<h3>2.4.1: July 24 2001</h3>
682<ul>
683 <li>possibility to keep line numbers in the tree</li>
684 <li>some computation NaN fixes</li>
685 <li>extension of the XPath API</li>
686 <li>cleanup for alpha and ia64 targets</li>
687 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]688</ul>
689
690<h3>2.4.0: July 10 2001</h3>
691<ul>
692 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
693 <li>Fixed XML Base implementation, added a coupel of examples to the
694 regression tests</li>
695 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]696</ul>
697
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]698<h3>2.3.14: July 5 2001</h3>
699<ul>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]700 <li>fixed some entities problems and reduce mem requirement when
701 substituing them</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]702 <li>lots of improvements in the XPath queries interpreter can be
703 substancially faster</li>
704 <li>Makefiles and configure cleanups</li>
705 <li>Fixes to XPath variable eval, and compare on empty node set</li>
706 <li>HTML tag closing bug fixed</li>
707 <li>Fixed an URI reference computating problem when validating</li>
708</ul>
709
Daniel Veillard2adbb512001-06-28 16:20:36 +0000[diff] [blame]710<h3>2.3.13: June 28 2001</h3>
711<ul>
712 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
713 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
714</ul>
715
716<h3>1.8.14: June 28 2001</h3>
717<ul>
718 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
719 <li>Small Makefile fix</li>
720</ul>
721
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]722<h3>2.3.12: June 26 2001</h3>
723<ul>
724 <li>lots of cleanup</li>
725 <li>a couple of validation fix</li>
726 <li>fixed line number counting</li>
727 <li>fixed serious problems in the XInclude processing</li>
728 <li>added support for UTF8 BOM at beginning of entities</li>
729 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
730 miscompile uri.c (William), Thomas Leitner provided a fix for the
731 optimizer on Tru64</li>
732 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
733 compilation on Windows MSC</li>
734 <li>update of libxml-doc.el (Felix Natter)</li>
735 <li>fixed 2 bugs in URI normalization code</li>
736</ul>
737
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]738<h3>2.3.11: June 17 2001</h3>
739<ul>
740 <li>updates to trio, Makefiles and configure should fix some portability
741 problems (alpha)</li>
742 <li>fixed some HTML serialization problems (pre, script, and block/inline
743 handling), added encoding aware APIs, cleanup of this code</li>
744 <li>added xmlHasNsProp()</li>
745 <li>implemented a specific PI for encoding support in the DocBook SGML
746 parser</li>
747 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
748 node selection)</li>
749 <li>fixed a performance problem and an error in the validation code</li>
750 <li>fixed XInclude routine to implement the recursive behaviour</li>
751 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
752 <li>added --version to xmllint for bug reports</li>
753</ul>
754
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]755<h3>2.3.10: June 1 2001</h3>
756<ul>
757 <li>fixed the SGML catalog support</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]758 <li>a number of reported bugs got fixed, in XPath, iconv detection,
759 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]760 <li>XPath string function should now handle unicode correctly</li>
761</ul>
762
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]763<h3>2.3.9: May 19 2001</h3>
764
765<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
766<ul>
767 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
768 <li>some serious speed optimisation again</li>
769 <li>some documentation cleanups</li>
770 <li>trying to get better linking on solaris (-R)</li>
771 <li>XPath API cleanup from Thomas Broyer</li>
772 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
773 xmlValidGetValidElements()</li>
774 <li>Added an INSTALL file</li>
775 <li>Attribute removal added to API: #54433</li>
776 <li>added a basic support for SGML catalogs</li>
777 <li>fixed xmlKeepBlanksDefault(0) API</li>
778 <li>bugfix in xmlNodeGetLang()</li>
779 <li>fixed a small configure portability problem</li>
780 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
781</ul>
782
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]783<h3>1.8.13: May 14 2001</h3>
784<ul>
785 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
786</ul>
787
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]788<h3>2.3.8: May 3 2001</h3>
789<ul>
790 <li>Integrated an SGML DocBook parser for the Gnome project</li>
791 <li>Fixed a few things in the HTML parser</li>
792 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
793 point portability issue</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]794 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
795 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]796 <li>incorporated more Windows cleanup</li>
797 <li>added xmlSaveFormatFile()</li>
798 <li>fixed problems in copying nodes with entities references (gdome)</li>
799 <li>removed some troubles surrounding the new validation module</li>
800</ul>
801
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]802<h3>2.3.7: April 22 2001</h3>
803<ul>
804 <li>lots of small bug fixes, corrected XPointer</li>
805 <li>Non determinist content model validation support</li>
806 <li>added xmlDocCopyNode for gdome2</li>
807 <li>revamped the way the HTML parser handles end of tags</li>
808 <li>XPath: corrctions of namespacessupport and number formatting</li>
809 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
810 <li>HTML ouput fixes from P C Chow and William M. Brack</li>
811 <li>Improved validation speed sensible for DocBook</li>
812 <li>fixed a big bug with ID declared in external parsed entities</li>
813 <li>portability fixes, update of Trio from Bjorn Reese</li>
814</ul>
815
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]816<h3>2.3.6: April 8 2001</h3>
817<ul>
818 <li>Code cleanup using extreme gcc compiler warning options, found and
819 cleared half a dozen potential problem</li>
820 <li>the Eazel team found an XML parser bug</li>
821 <li>cleaned up the user of some of the string formatting function. used the
822 trio library code to provide the one needed when the platform is missing
823 them</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]824 <li>xpath: removed a memory leak and fixed the predicate evaluation
825 problem, extended the testsuite and cleaned up the result. XPointer seems
826 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]827</ul>
828
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]829<h3>2.3.5: Mar 23 2001</h3>
830<ul>
831 <li>Biggest change is separate parsing and evaluation of XPath expressions,
832 there is some new APIs for this too</li>
833 <li>included a number of bug fixes(XML push parser, 51876, notations,
834 52299)</li>
835 <li>Fixed some portability issues</li>
836</ul>
837
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]838<h3>2.3.4: Mar 10 2001</h3>
839<ul>
840 <li>Fixed bugs #51860 and #51861</li>
841 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
842 size to be application tunable.</li>
843 <li>Some cleanup in the validation code, still a bug left and this part
844 should probably be rewritten to support ambiguous content model :-\</li>
845 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
846 parser</li>
847 <li>Fixed another bug in xmlNodeGetContent()</li>
848 <li>Bjorn fixed XPath node collection and Number formatting</li>
849 <li>Fixed a loop reported in the HTML parsing</li>
850 <li>blank space are reported even if the Dtd content model proves that they
851 are formatting spaces, this is for XmL conformance</li>
852</ul>
853
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]854<h3>2.3.3: Mar 1 2001</h3>
855<ul>
856 <li>small change in XPath for XSLT</li>
857 <li>documentation cleanups</li>
858 <li>fix in validation by Gary Pennington</li>
859 <li>serious parsing performances improvements</li>
860</ul>
861
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]862<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]863<ul>
864 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
865 <li>fixed a Dtd parsing bug</li>
866 <li>fixed a bug in xmlNodeGetContent</li>
867 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
868</ul>
869
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]870<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]871<ul>
872 <li>some XPath and HTML bug fixes for XSLT</li>
873 <li>small extension of the hash table interfaces for DOM gdome2
874 implementation</li>
875 <li>A few bug fixes</li>
876</ul>
877
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]878<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]879<ul>
880 <li>Lots of XPath bug fixes</li>
881 <li>Add a mode with Dtd lookup but without validation error reporting for
882 XSLT</li>
883 <li>Add support for text node without escaping (XSLT)</li>
884 <li>bug fixes for xmlCheckFilename</li>
885 <li>validation code bug fixes from Gary Pennington</li>
886 <li>Patch from Paul D. Smith correcting URI path normalization</li>
887 <li>Patch to allow simultaneous install of libxml-devel and
888 libxml2-devel</li>
889 <li>the example Makefile is now fixed</li>
890 <li>added HTML to the RPM packages</li>
891 <li>tree copying bugfixes</li>
892 <li>updates to Windows makefiles</li>
893 <li>optimisation patch from Bjorn Reese</li>
894</ul>
895
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]896<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]897<ul>
898 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
899 <li>added htmlHandleOmittedElem()</li>
900 <li>Applied Bjorn Reese's IPV6 first patch</li>
901 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]902 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]903</ul>
904
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]905<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]906<ul>
907 <li>Fix the Windows problems of 2.2.8</li>
908 <li>integrate OpenVMS patches</li>
909 <li>better handling of some nasty HTML input</li>
910 <li>Improved the XPointer implementation</li>
911 <li>integrate a number of provided patches</li>
912</ul>
913
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]914<h3>2.2.9: Nov 25 2000</h3>
915<ul>
916 <li>erroneous release :-(</li>
917</ul>
918
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]919<h3>2.2.8: Nov 13 2000</h3>
920<ul>
921 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
922 support</li>
923 <li>Patch in conditional section handling</li>
924 <li>updated MS compiler project</li>
925 <li>fixed some XPath problems</li>
926 <li>added an URI escaping function</li>
927 <li>some other bug fixes</li>
928</ul>
929
930<h3>2.2.7: Oct 31 2000</h3>
931<ul>
932 <li>added message redirection</li>
933 <li>XPath improvements (thanks TOM !)</li>
934 <li>xmlIOParseDTD() added</li>
935 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
936 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
937</ul>
938
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]939<h3>2.2.6: Oct 25 2000:</h3>
940<ul>
941 <li>Added an hash table module, migrated a number of internal structure to
942 those</li>
943 <li>Fixed a posteriori validation problems</li>
944 <li>HTTP module cleanups</li>
945 <li>HTML parser improvements (tag errors, script/style handling, attribute
946 normalization)</li>
947 <li>coalescing of adjacent text nodes</li>
948 <li>couple of XPath bug fixes, exported the internal API</li>
949</ul>
950
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]951<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]952<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]953 <li>XPointer implementation and testsuite</li>
954 <li>Lot of XPath fixes, added variable and functions registration, more
955 tests</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]956 <li>Portability fixes, lots of enhancements toward an easy Windows build
957 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]958 <li>Late validation fixes</li>
959 <li>Integrated a lot of contributed patches</li>
960 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]961 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]962</ul>
963
964<h3>2.2.4: Oct 1 2000:</h3>
965<ul>
966 <li>main XPath problem fixed</li>
967 <li>Integrated portability patches for Windows</li>
968 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]969</ul>
970
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]971<h3>2.2.3: Sep 17 2000</h3>
972<ul>
973 <li>bug fixes</li>
974 <li>cleanup of entity handling code</li>
975 <li>overall review of all loops in the parsers, all sprintf usage has been
976 checked too</li>
977 <li>Far better handling of larges Dtd. Validating against Docbook XML Dtd
978 works smoothly now.</li>
979</ul>
980
981<h3>1.8.10: Sep 6 2000</h3>
982<ul>
983 <li>bug fix release for some Gnome projects</li>
984</ul>
985
986<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]987<ul>
988 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]989 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]990</ul>
991
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]992<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]993<ul>
994 <li>a purely bug fixes release</li>
995 <li>fixed an encoding support problem when parsing from a memory block</li>
996 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]997 <li>removed a bug in the function allowing to override the memory
998 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]999</ul>
1000
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]1001<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]1002<ul>
1003 <li>applied a lot of portability fixes</li>
1004 <li>better encoding support/cleanup and saving (content is now always
1005 encoded in UTF-8)</li>
1006 <li>the HTML parser now correctly handles encodings</li>
1007 <li>added xmlHasProp()</li>
1008 <li>fixed a serious problem with &amp;#38;</li>
1009 <li>propagated the fix to FTP client</li>
1010 <li>cleanup, bugfixes, etc ...</li>
1011 <li>Added a page about <a href="encoding.html">libxml Internationalization
1012 support</a></li>
1013</ul>
1014
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1015<h3>1.8.9: July 9 2000</h3>
1016<ul>
1017 <li>fixed the spec the RPMs should be better</li>
1018 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
1019 rpmfind users problem</li>
1020</ul>
1021
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]1022<h3>2.1.1: July 1 2000</h3>
1023<ul>
1024 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
1025 <li>improvements on the HTML parser</li>
1026</ul>
1027
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]1028<h3>2.1.0 and 1.8.8: June 29 2000</h3>
1029<ul>
1030 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
1031 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
1032 about &amp;#38; charref parsing</li>
1033 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
1034 also contains numerous fixes and enhancements:
1035 <ul>
1036 <li>added xmlStopParser() to stop parsing</li>
1037 <li>improved a lot parsing speed when there is large CDATA blocs</li>
1038 <li>includes XPath patches provided by Picdar Technology</li>
1039 <li>tried to fix as much as possible DtD validation and namespace
1040 related problems</li>
1041 <li>output to a given encoding has been added/tested</li>
1042 <li>lot of various fixes</li>
1043 </ul>
1044 </li>
1045</ul>
1046
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]1047<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1048<ul>
1049 <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]1050 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
1051 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
1052 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1053 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]1054 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1055 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]1056 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1057 <pre>#include "xxx.h"</pre>
1058 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]1059 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
1060 <li>the memory allocation routines used by libxml can now be overloaded
1061 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1062 <li>The previously CVS only tool tester has been renamed
1063 <strong>xmllint</strong> and is now installed as part of the libxml2
1064 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]1065 <li>The I/O interface has been revamped. There is now ways to plug in
1066 specific I/O modules, either at the URI scheme detection level using
1067 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
1068 parser context using xmlCreateIOParserCtxt()</li>
1069 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
1070 number of the libxml module in use</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1071 <li>a number of optional features of libxml can now be excluded at
1072 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]1073</ul>
1074
1075<h3>2.0.0beta: Mar 14 2000</h3>
1076<ul>
1077 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]1078 <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
1079 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
1080 RPMs</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]1081 <li>This version is now the head in the Gnome CVS base, the old one is
1082 available under the tag LIB_XML_1_X</li>
1083 <li>This includes a very large set of changes. Froma programmatic point of
1084 view applications should not have to be modified too much, check the <a
1085 href="upgrade.html">upgrade page</a></li>
1086 <li>Some interfaces may changes (especially a bit about encoding).</li>
1087 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]1088 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]1089 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
1090 handled now</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1091 <li>Better handling of entities, especially well formedness checking
1092 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]1093 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1094 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]1095 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
1096 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]1097 </ul>
1098 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]1099 <li>Serious progress were made toward compliance, <a
1100 href="conf/result.html">here are the result of the test</a> against the
1101 OASIS testsuite (except the japanese tests since I don't support that
1102 encoding yet). This URL is rebuilt every couple of hours using the CVS
1103 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]1104</ul>
1105
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1106<h3>1.8.7: Mar 6 2000</h3>
1107<ul>
1108 <li>This is a bug fix release:</li>
1109 <li>It is possible to disable the ignorable blanks heuristic used by
1110 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1111 that for adherence to XML spec, this behaviour will be disabled by
1112 default in 2.x . The same function will allow to keep compatibility for
1113 old code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1114 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
1115 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1116 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
1117 compilation on some platforms has been fixed</li>
1118 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
1119 URIs</li>
1120</ul>
1121
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]1122<h3>1.8.6: Jan 31 2000</h3>
1123<ul>
1124 <li>added a nanoFTP transport module, debugged until the new version of <a
1125 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
1126 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]1127</ul>
1128
1129<h3>1.8.5: Jan 21 2000</h3>
1130<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1131 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1132 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
1133 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]1134 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1135 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
1136 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]1137 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
1138 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1139</ul>
1140
1141<h3>1.8.4: Jan 13 2000</h3>
1142<ul>
1143 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
1144 <li>all exit() call should have been removed from libxml</li>
1145 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
1146 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]1147</ul>
1148
1149<h3>1.8.3: Jan 5 2000</h3>
1150<ul>
1151 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1152 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000[diff] [blame]1153 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]1154 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]1155 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
1156 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]1157 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]1158 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]1159 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]1160</ul>
1161
1162<h3>1.8.2: Dec 21 1999</h3>
1163<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1164 <li>I got another problem with includes and C++, I hope this issue is fixed
1165 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]1166 <li>Added a few tree modification functions: xmlReplaceNode,
1167 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
1168 xmlDocSetRootElement</li>
1169 <li>Tried to improve the HTML output with help from <a
1170 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]1171</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1172
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]1173<h3>1.8.1: Dec 18 1999</h3>
1174<ul>
1175 <li>various patches to avoid troubles when using libxml with C++ compilers
1176 the "namespace" keyword and C escaping in include files</li>
1177 <li>a problem in one of the core macros IS_CHAR was corrected</li>
1178 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
1179 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]1180 <li>fixed a posteriori validation (validation after parsing, or by using a
1181 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1182 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]1183</ul>
1184
1185<h3>1.8.0: Dec 12 1999</h3>
1186<ul>
1187 <li>cleanup, especially memory wise</li>
1188 <li>the parser should be more reliable, especially the HTML one, it should
1189 not crash, whatever the input !</li>
1190 <li>Integrated various patches, especially a speedup improvement for large
1191 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
1192 configure with --with-buffers to enable them.</li>
1193 <li>attribute normalization, oops should have been added long ago !</li>
1194 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
1195 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]1196</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1197
1198<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1199<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1200 <li>Lots of HTML improvement</li>
1201 <li>Fixed some errors when saving both XML and HTML</li>
1202 <li>More examples, the regression tests should now look clean</li>
1203 <li>Fixed a bug with contiguous charref</li>
1204</ul>
1205
1206<h3>1.7.3: Sep 29 1999</h3>
1207<ul>
1208 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1209 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1210 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1211</ul>
1212
1213<h3>1.7.1: Sep 24 1999</h3>
1214<ul>
1215 <li>The basic type for strings manipulated by libxml has been renamed in
1216 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1217 is that CHAR was conflicting with a predefined type on Windows. However
1218 on non WIN32 environment, compatibility is provided by the way of a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1219 <strong>#define </strong>.</li>
1220 <li>Changed another error : the use of a structure field called errno, and
1221 leading to troubles on platforms where it's a macro</li>
1222</ul>
1223
1224<h3>1.7.0: sep 23 1999</h3>
1225<ul>
1226 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1227 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1228 <li>Added an errno to report errors by another mean than a simple printf
1229 like callback</li>
1230 <li>Finished ID/IDREF support and checking when validation</li>
1231 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1232 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1233 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
1234 implementation</li>
1235 <li>Added an HTML parser front-end</li>
1236</ul>
1237
1238<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1239
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1240<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]1241markup-based structured documents. Here is <a name="example">an example XML
1242document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1243<pre>&lt;?xml version="1.0"?&gt;
1244&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
1245 &lt;head&gt;
1246 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
1247 &lt;/head&gt;
1248 &lt;chapter&gt;
1249 &lt;title&gt;The Linux adventure&lt;/title&gt;
1250 &lt;p&gt;bla bla bla ...&lt;/p&gt;
1251 &lt;image href="linus.gif"/&gt;
1252 &lt;p&gt;...&lt;/p&gt;
1253 &lt;/chapter&gt;
1254&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1255
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1256<p>The first line specifies that it's an XML document and gives useful
1257information about its encoding. Then the document is a text format whose
1258structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1259to be closed</strong>. XML is pedantic about this. However, if a tag is empty
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1260(no content), a single tag can serve as both the opening and closing tag if
1261it ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note
1262that, for example, the image tag has no content (just an attribute) and is
1263closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1264
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1265<p>XML can be applied sucessfully to a wide range of uses, from long term
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1266structured document maintenance (where it follows the steps of SGML) to
1267simple data encoding mechanisms like configuration file formatting (glade),
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1268spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
1269it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1270
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]1271<h2><a name="XSLT">XSLT</a></h2>
1272
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]1273<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
1274
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1275<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
1276language for transforming XML documents into other XML documents (or
1277HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]1278
1279<p>A separate library called libxslt is being built on top of libxml2. This
1280module "libxslt" can be found in the Gnome CVS base too.</p>
1281
Daniel Veillard383b1472001-01-23 11:39:52 +0000[diff] [blame]1282<p>You can check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1283href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a>
1284supported and the progresses on the <a
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]1285href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p>
1286
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]1287<h2><a name="architecture">libxml architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1288
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1289<p>Libxml is made of multiple components; some of them are optional, and most
1290of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1291<ul>
1292 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1293 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1294 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1295 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1296 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1297 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1298 <li>a SAX tree module to build an in-memory DOM representation</li>
1299 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1300 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1301 <li>an XPath module for global lookup in a DOM representation
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1302 (optional)</li>
1303 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]1304</ul>
1305
1306<p>Graphically this gives the following:</p>
1307
1308<p><img src="libxml.gif" alt="a graphical view of the various"></p>
1309
1310<p></p>
1311
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1312<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1313
1314<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1315returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1316<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1317as the file name, the document type, and a <strong>children</strong> pointer
1318which is the root of the document (or more exactly the first child under the
1319root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1320chained in double-linked lists of siblings and with a children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1321relationship. An xmlNode can also carry properties (a chain of xmlAttr
1322structures). An attribute may have a value which is a list of TEXT or
1323ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1324
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1325<p>Here is an example (erroneous with respect to the XML spec since there
1326should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1327
1328<p><img src="structure.gif" alt=" structure.gif "></p>
1329
1330<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1331called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1332prints them back as parsed. This is useful for detecting errors both in XML
1333code and in the XML parser itself. It has an option <strong>--debug</strong>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1334which prints the actual in-memory structure of the document; here is the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1335result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1336<pre>DOCUMENT
1337version=1.0
1338standalone=true
1339 ELEMENT EXAMPLE
1340 ATTRIBUTE prop1
1341 TEXT
1342 content=gnome is great
1343 ATTRIBUTE prop2
1344 ENTITY_REF
1345 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1346 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1347 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1348 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1349 TEXT
1350 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1351 ELEMENT chapter
1352 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1353 TEXT
1354 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1355 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1356 TEXT
1357 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1358 ELEMENT image
1359 ATTRIBUTE href
1360 TEXT
1361 content=linus.gif
1362 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1363 TEXT
1364 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1365
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1366<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1367
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1368<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1369
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1370<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1371memory. In that case (and if you don't expect to save back the XML document
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1372loaded using libxml), it's better to use the SAX interface of libxml. SAX is
1373a <strong>callback-based interface</strong> to the parser. Before parsing,
1374the application layer registers a customized set of callbacks which are
1375called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1376
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1377<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]1378libxml, see the <a
1379href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
1380documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1381Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1382
1383<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
1384program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1385binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1386distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1387testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1388<pre>SAX.setDocumentLocator()
1389SAX.startDocument()
1390SAX.getEntity(amp)
1391SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
1392SAX.characters( , 3)
1393SAX.startElement(head)
1394SAX.characters( , 4)
1395SAX.startElement(title)
1396SAX.characters(Welcome to Gnome, 16)
1397SAX.endElement(title)
1398SAX.characters( , 3)
1399SAX.endElement(head)
1400SAX.characters( , 3)
1401SAX.startElement(chapter)
1402SAX.characters( , 4)
1403SAX.startElement(title)
1404SAX.characters(The Linux adventure, 19)
1405SAX.endElement(title)
1406SAX.characters( , 4)
1407SAX.startElement(p)
1408SAX.characters(bla bla bla ..., 15)
1409SAX.endElement(p)
1410SAX.characters( , 4)
1411SAX.startElement(image, href='linus.gif')
1412SAX.endElement(image)
1413SAX.characters( , 4)
1414SAX.startElement(p)
1415SAX.characters(..., 3)
1416SAX.endElement(p)
1417SAX.characters( , 3)
1418SAX.endElement(chapter)
1419SAX.characters( , 1)
1420SAX.endElement(EXAMPLE)
1421SAX.endDocument()</pre>
1422
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1423<p>Most of the other interfaces of libxml are based on the DOM tree-building
1424facility, so nearly everything up to the end of this document presupposes the
1425use of the standard DOM tree build. Note that the DOM tree itself is built by
1426a set of registered default callbacks, without internal specific
1427interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1428
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]1429<h2><a name="Validation">Validation &amp; DTDs</a></h2>
1430
1431<p>Table of Content:</p>
1432<ol>
1433 <li><a href="#General5">General overview</a></li>
1434 <li><a href="#definition">The definition</a></li>
1435 <li><a href="#Simple">Simple rules</a>
1436 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]1437 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]1438 <li><a href="#Declaring">Declaring elements</a></li>
1439 <li><a href="#Declaring1">Declaring attributes</a></li>
1440 </ol>
1441 </li>
1442 <li><a href="#Some">Some examples</a></li>
1443 <li><a href="#validate">How to validate</a></li>
1444 <li><a href="#Other">Other resources</a></li>
1445</ol>
1446
1447<h3><a name="General5">General overview</a></h3>
1448
1449<p>Well what is validation and what is a DTD ?</p>
1450
1451<p>DTD is the acronym for Document Type Definition. This is a description of
1452the content for a familly of XML files. This is part of the XML 1.0
1453specification, and alows to describe and check that a given document instance
1454conforms to a set of rules detailing its structure and content.</p>
1455
1456<p>Validation is the process of checking a document against a DTD (more
1457generally against a set of construction rules).</p>
1458
1459<p>The validation process and building DTDs are the two most difficult parts
1460of the XML life cycle. Briefly a DTD defines all the possibles element to be
1461found within your document, what is the formal shape of your document tree
1462(by defining the allowed content of an element, either text, a regular
1463expression for the allowed list of children, or mixed content i.e. both text
1464and children). The DTD also defines the allowed attributes for all elements
1465and the types of the attributes.</p>
1466
1467<h3><a name="definition1">The definition</a></h3>
1468
1469<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
1470href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
1471Rev1</a>):</p>
1472<ul>
1473 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
1474 elements</a></li>
1475 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
1476 attributes</a></li>
1477</ul>
1478
1479<p>(unfortunately) all this is inherited from the SGML world, the syntax is
1480ancient...</p>
1481
1482<h3><a name="Simple1">Simple rules</a></h3>
1483
1484<p>Writing DTD can be done in multiple ways, the rules to build them if you
1485need something fixed or something which can evolve over time can be radically
1486different. Really complex DTD like Docbook ones are flexible but quite harder
1487to design. I will just focuse on DTDs for a formats with a fixed simple
1488structure. It is just a set of basic rules, and definitely not exhaustive nor
1489useable for complex DTD design.</p>
1490
1491<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
1492
1493<p>Assuming the top element of the document is <code>spec</code> and the dtd
1494is placed in the file <code>mydtd</code> in the subdirectory
1495<code>dtds</code> of the directory from where the document were loaded:</p>
1496
1497<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
1498
1499<p>Notes:</p>
1500<ul>
1501 <li>the system string is actually an URI-Reference (as defined in <a
1502 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
1503 full URL string indicating the location of your DTD on the Web, this is a
1504 really good thing to do if you want others to validate your document</li>
1505 <li>it is also possible to associate a <code>PUBLIC</code> identifier (a
1506 magic string) so that the DTd is looked up in catalogs on the client side
1507 without having to locate it on the web</li>
1508 <li>a dtd contains a set of elements and attributes declarations, but they
1509 don't define what the root of the document should be. This is explicitely
1510 told to the parser/validator as the first element of the
1511 <code>DOCTYPE</code> declaration.</li>
1512</ul>
1513
1514<h4><a name="Declaring2">Declaring elements</a>:</h4>
1515
1516<p>The following declares an element <code>spec</code>:</p>
1517
1518<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
1519
1520<p>it also expresses that the spec element contains one <code>front</code>,
1521one <code>body</code> and one optionnal <code>back</code> children elements
1522in this order. The declaration of one element of the structure and its
1523content are done in a single declaration. Similary the following declares
1524<code>div1</code> elements:</p>
1525
Daniel Veillard51737272002-01-23 23:10:38 +0000[diff] [blame]1526<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]1527
1528<p>means div1 contains one <code>head</code> then a series of optional
1529<code>p</code>, <code>list</code>s and <code>note</code>s and then an
1530optional <code>div2</code>. And last but not least an element can contain
1531text:</p>
1532
1533<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
1534
1535<p><code>b</code> contains text or being of mixed content (text and elements
1536in no particular order):</p>
1537
1538<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
1539
1540<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
1541<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
1542order.</p>
1543
1544<h4><a name="Declaring1">Declaring attributes</a>:</h4>
1545
1546<p>again the attributes declaration includes their content definition:</p>
1547
1548<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
1549
1550<p>means that the element <code>termdef</code> can have a <code>name</code>
1551attribute containing text (<code>CDATA</code>) and which is optionnal
1552(<code>#IMPLIED</code>). The attribute value can also be defined within a
1553set:</p>
1554
1555<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
1556"ordered"&gt;</code></p>
1557
1558<p>means <code>list</code> element have a <code>type</code> attribute with 3
1559allowed values "bullets", "ordered" or "glossary" and which default to
1560"ordered" if the attribute is not explicitely specified.</p>
1561
1562<p>The content type of an attribute can be text (<code>CDATA</code>),
1563anchor/reference/references
1564(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
1565(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
1566(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
1567<code>chapter</code> element can have an optional <code>id</code> attribute
1568of type <code>ID</code>, usable for reference from attribute of type
1569IDREF:</p>
1570
1571<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
1572
1573<p>The last value of an attribute definition can be <code>#REQUIRED
1574</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
1575meaning that it is optional, or the default value (possibly prefixed by
1576<code>#FIXED</code> if it is the only allowed).</p>
1577
1578<p>Notes:</p>
1579<ul>
1580 <li>usually the attributes pertaining to a given element are declared in a
1581 single expression, but it is just a convention adopted by a lot of DTD
1582 writers:
1583 <pre>&lt;!ATTLIST termdef
1584 id ID #REQUIRED
1585 name CDATA #IMPLIED&gt;</pre>
1586 <p>The previous construct defines both <code>id</code> and
1587 <code>name</code> attributes for the element <code>termdef</code></p>
1588 </li>
1589</ul>
1590
1591<h3><a name="Some1">Some examples</a></h3>
1592
1593<p>The directory <code>test/valid/dtds/</code> in the libxml distribution
1594contains some complex DTD examples. The <code>test/valid/dia.xml</code>
1595example shows an XML file where the simple DTD is directly included within
1596the document.</p>
1597
1598<h3><a name="validate1">How to validate</a></h3>
1599
1600<p>The simplest is to use the xmllint program comming with libxml. The
1601<code>--valid</code> option turn on validation of the files given as input,
1602for example the following validates a copy of the first revision of the XML
16031.0 specification:</p>
1604
1605<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
1606
1607<p>the -- noout is used to not output the resulting tree.</p>
1608
1609<p>The <code>--dtdvalid dtd</code> allows to validate the document(s) against
1610a given DTD.</p>
1611
1612<p>Libxml exports an API to handle DTDs and validation, check the <a
1613href="http://xmlsoft.org/html/libxml-valid.html">associated
1614description</a>.</p>
1615
1616<h3><a name="Other1">Other resources</a></h3>
1617
1618<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
1619will just list one for now, others pointers welcome:</p>
1620<ul>
1621 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
1622</ul>
1623
1624<p>I suggest looking at the examples found under test/valid/dtd and any of
1625the large number of books available on XML. The dia example in test/valid
1626should be both simple and complete enough to allow you to build your own.</p>
1627
1628<p></p>
1629
1630<h2><a name="Memory">Memory Management</a></h2>
1631
1632<p>Table of Content:</p>
1633<ol>
1634 <li><a href="#General3">General overview</a></li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]1635 <li><a href="#setting">Setting libxml set of memory routines</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]1636 <li><a href="#cleanup">Cleaning up after parsing</a></li>
1637 <li><a href="#Debugging">Debugging routines</a></li>
1638 <li><a href="#General4">General memory requirements</a></li>
1639</ol>
1640
1641<h3><a name="General3">General overview</a></h3>
1642
1643<p>The module <code><a
1644href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
1645provides the interfaces to the libxml memory system:</p>
1646<ul>
1647 <li>libxml does not use the libc memory allocator directly but xmlFree(),
1648 xmlMalloc() and xmlRealloc()</li>
1649 <li>those routines can be reallocated to a specific set of routine, by
1650 default the libc ones i.e. free(), malloc() and realloc()</li>
1651 <li>the xmlmemory.c module includes a set of debugging routine</li>
1652</ul>
1653
1654<h3><a name="setting">Setting libxml set of memory routines</a></h3>
1655
1656<p>It is sometimes useful to not use the default memory allocator, either for
1657debugging, analysis or to implement a specific behaviour on memory management
1658(like on embedded systems). Two function calls are available to do so:</p>
1659<ul>
1660 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet ()</a>
1661 which return the current set of functions in use by the parser</li>
1662 <li><a
1663 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
1664 which allow to set up a new set of memory allocation functions</li>
1665</ul>
1666
1667<p>Of course a call to xmlMemSetup() should probably be done before calling
1668any other libxml routines (unless you are sure your allocations routines are
1669compatibles).</p>
1670
1671<h3><a name="cleanup">Cleaning up after parsing</a></h3>
1672
1673<p>Libxml is not stateless, there is a few set of memory structures needing
1674allocation before the parser is fully functionnal (some encoding structures
1675for example). This also mean that once parsing is finished there is a tiny
1676amount of memory (a few hundred bytes) which can be recollected if you don't
1677reuse the parser immediately:</p>
1678<ul>
1679 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
1680 ()</a>
1681 is a centralized routine to free the parsing states. Note that it won't
1682 deallocate any produced tree if any (use the xmlFreeDoc() and related
1683 routines for this).</li>
1684 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
1685 ()</a>
1686 is the dual routine allowing to preallocate the parsing state which can
1687 be useful for example to avoid initialization reentrancy problems when
1688 using libxml in multithreaded applications</li>
1689</ul>
1690
1691<p>Generally xmlCleanupParser() is safe, if needed the state will be rebuild
1692at the next invocation of parser routines, but be careful of the consequences
1693in multithreaded applications.</p>
1694
1695<h3><a name="Debugging">Debugging routines</a></h3>
1696
1697<p>When configured using --with-mem-debug flag (off by default), libxml uses
1698a set of memory allocation debugging routineskeeping track of all allocated
1699blocks and the location in the code where the routine was called. A couple of
1700other debugging routines allow to dump the memory allocated infos to a file
1701or call a specific routine when a given block number is allocated:</p>
1702<ul>
1703 <li><a
1704 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
1705 <a
1706 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
1707 and <a
1708 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
1709 are the memory debugging replacement allocation routines</li>
1710 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
1711 ()</a>
1712 dumps all the informations about the allocated memory block lefts in the
1713 <code>.memdump</code> file</li>
1714</ul>
1715
1716<p>When developping libxml memory debug is enabled, the tests programs call
1717xmlMemoryDump () and the "make test" regression tests will check for any
1718memory leak during the full regression test sequence, this helps a lot
1719ensuring that libxml does not leak memory and bullet proof memory
1720allocations use (some libc implementations are known to be far too permissive
1721resulting in major portability problems!).</p>
1722
1723<p>If the .memdump reports a leak, it displays the allocation function and
1724also tries to give some informations about the content and structure of the
1725allocated blocks left. This is sufficient in most cases to find the culprit,
1726but not always. Assuming the allocation problem is reproductible, it is
1727possible to find more easilly:</p>
1728<ol>
1729 <li>write down the block number xxxx not allocated</li>
1730 <li>export the environement variable XML_MEM_BREAKPOINT=xxxx</li>
1731 <li>run the program under a debugger and set a breakpoint on
1732 xmlMallocBreakpoint() a specific function called when this precise block
1733 is allocated</li>
1734 <li>when the breakpoint is reached you can then do a fine analysis of the
1735 allocation an step to see the condition resulting in the missing
1736 deallocation.</li>
1737</ol>
1738
1739<p>I used to use a commercial tool to debug libxml memory problems but after
1740noticing that it was not detecting memory leaks that simple mechanism was
1741used and proved extremely efficient until now.</p>
1742
1743<h3><a name="General4">General memory requirements</a></h3>
1744
1745<p>How much libxml memory require ? It's hard to tell in average it depends
1746of a number of things:</p>
1747<ul>
1748 <li>the parser itself should work in a fixed amout of memory, except for
1749 information maintained about the stacks of names and entities locations.
1750 The I/O and encoding handlers will probably account for a few KBytes.
1751 This is true for both the XML and HTML parser (though the HTML parser
1752 need more state).</li>
1753 <li>If you are generating the DOM tree then memory requirements will grow
1754 nearly lineary with the size of the data. In general for a balanced
1755 textual document the internal memory requirement is about 4 times the
1756 size of the UTF8 serialization of this document (exmple the XML-1.0
1757 recommendation is a bit more of 150KBytes and takes 650KBytes of main
1758 memory when parsed). Validation will add a amount of memory required for
1759 maintaining the external Dtd state which should be linear with the
1760 complexity of the content model defined by the Dtd</li>
1761 <li>If you don't care about the advanced features of libxml like
1762 validation, DOM, XPath or XPointer, but really need to work fixed memory
1763 requirements, then the SAX interface should be used.</li>
1764</ul>
1765
1766<p></p>
1767
1768<h2><a name="Encodings">Encodings support</a></h2>
1769
1770<p>Table of Content:</p>
1771<ol>
1772 <li><a href="encoding.html#What">What does internationalization support
1773 mean ?</a></li>
1774 <li><a href="encoding.html#internal">The internal encoding, how and
1775 why</a></li>
1776 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
1777 <li><a href="encoding.html#Default">Default supported encodings</a></li>
1778 <li><a href="encoding.html#extend">How to extend the existing
1779 support</a></li>
1780</ol>
1781
1782<h3><a name="What">What does internationalization support mean ?</a></h3>
1783
1784<p>XML was designed from the start to allow the support of any character set
1785by using Unicode. Any conformant XML parser has to support the UTF-8 and
1786UTF-16 default encodings which can both express the full unicode ranges. UTF8
1787is a variable length encoding whose greatest point are to resuse the same
1788emcoding for ASCII and to save space for Western encodings, but it is a bit
1789more complex to handle in practice. UTF-16 use 2 bytes per characters (and
1790sometimes combines two pairs), it makes implementation easier, but looks a
1791bit overkill for Western languages encoding. Moreover the XML specification
1792allows document to be encoded in other encodings at the condition that they
1793are clearly labelled as such. For example the following is a wellformed XML
1794document encoded in ISO-8859 1 and using accentuated letter that we French
1795likes for both markup and content:</p>
1796<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
1797&lt;très&gt;là&lt;/très&gt;</pre>
1798
1799<p>Having internationalization support in libxml means the foolowing:</p>
1800<ul>
1801 <li>the document is properly parsed</li>
1802 <li>informations about it's encoding are saved</li>
1803 <li>it can be modified</li>
1804 <li>it can be saved in its original encoding</li>
1805 <li>it can also be saved in another encoding supported by libxml (for
1806 example straight UTF8 or even an ASCII form)</li>
1807</ul>
1808
1809<p>Another very important point is that the whole libxml API, with the
1810exception of a few routines to read with a specific encoding or save to a
1811specific encoding, is completely agnostic about the original encoding of the
1812document.</p>
1813
1814<p>It should be noted too that the HTML parser embedded in libxml now obbey
1815the same rules too, the following document will be (as of 2.2.2) handled in
1816an internationalized fashion by libxml too:</p>
1817<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
1818 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
1819&lt;html lang="fr"&gt;
1820&lt;head&gt;
1821 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
1822&lt;/head&gt;
1823&lt;body&gt;
1824&lt;p&gt;W3C crée des standards pour le Web.&lt;/body&gt;
1825&lt;/html&gt;</pre>
1826
1827<h3><a name="internal">The internal encoding, how and why</a></h3>
1828
1829<p>One of the core decision was to force all documents to be converted to a
1830default internal encoding, and that encoding to be UTF-8, here are the
1831rationale for those choices:</p>
1832<ul>
1833 <li>keeping the native encoding in the internal form would force the libxml
1834 users (or the code associated) to be fully aware of the encoding of the
1835 original document, for examples when adding a text node to a document,
1836 the content would have to be provided in the document encoding, i.e. the
1837 client code would have to check it before hand, make sure it's conformant
1838 to the encoding, etc ... Very hard in practice, though in some specific
1839 cases this may make sense.</li>
1840 <li>the second decision was which encoding. From the XML spec only UTF8 and
1841 UTF16 really makes sense as being the two only encodings for which there
1842 is amndatory support. UCS-4 (32 bits fixed size encoding) could be
1843 considered an intelligent choice too since it's a direct Unicode mapping
1844 support. I selected UTF-8 on the basis of efficiency and compatibility
1845 with surrounding software:
1846 <ul>
1847 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
1848 more costly to import and export CPU wise) is also far more compact
1849 than UTF-16 (and UCS-4) for a majority of the documents I see it used
1850 for right now (RPM RDF catalogs, advogato data, various configuration
1851 file formats, etc.) and the key point for today's computer
1852 architecture is efficient uses of caches. If one nearly double the
1853 memory requirement to store the same amount of data, this will trash
1854 caches (main memory/external caches/internal caches) and my take is
1855 that this harms the system far more than the CPU requirements needed
1856 for the conversion to UTF-8</li>
1857 <li>Most of libxml version 1 users were using it with straight ASCII
1858 most of the time, doing the conversion with an internal encoding
1859 requiring all their code to be rewritten was a serious show-stopper
1860 for using UTF-16 or UCS-4.</li>
1861 <li>UTF-8 is being used as the de-facto internal encoding standard for
1862 related code like the <a href="http://www.pango.org/">pango</a>
1863 upcoming Gnome text widget, and a lot of Unix code (yep another place
1864 where Unix programmer base takes a different approach from Microsoft
1865 - they are using UTF-16)</li>
1866 </ul>
1867 </li>
1868</ul>
1869
1870<p>What does this mean in practice for the libxml user:</p>
1871<ul>
1872 <li>xmlChar, the libxml data type is a byte, those bytes must be assembled
1873 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
1874 is simply to append 0 byte, as usual.</li>
1875 <li>One just need to make sure that when using chars outside the ASCII set,
1876 the values has been properly converted to UTF-8</li>
1877</ul>
1878
1879<h3><a name="implemente">How is it implemented ?</a></h3>
1880
1881<p>Let's describe how all this works within libxml, basically the I18N
1882(internationalization) support get triggered only during I/O operation, i.e.
1883when reading a document or saving one. Let's look first at the reading
1884sequence:</p>
1885<ol>
1886 <li>when a document is processed, we usually don't know the encoding, a
1887 simple heuristic allows to detect UTF-18 and UCS-4 from whose where the
1888 ASCII range (0-0x7F) maps with ASCII</li>
1889 <li>the xml declaration if available is parsed, including the encoding
1890 declaration. At that point, if the autodetected encoding is different
1891 from the one declared a call to xmlSwitchEncoding() is issued.</li>
1892 <li>If there is no encoding declaration, then the input has to be in either
1893 UTF-8 or UTF-16, if it is not then at some point when processing the
1894 input, the converter/checker of UTF-8 form will raise an encoding error.
1895 You may end-up with a garbled document, or no document at all ! Example:
1896 <pre>~/XML -&gt; ./xmllint err.xml
1897err.xml:1: error: Input is not proper UTF-8, indicate encoding !
1898&lt;très&gt;là&lt;/très&gt;
1899 ^
1900err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
1901&lt;très&gt;là&lt;/très&gt;
1902 ^</pre>
1903 </li>
1904 <li>xmlSwitchEncoding() does an encoding name lookup, canonalize it, and
1905 then search the default registered encoding converters for that encoding.
1906 If it's not within the default set and iconv() support has been compiled
1907 it, it will ask iconv for such an encoder. If this fails then the parser
1908 will report an error and stops processing:
1909 <pre>~/XML -&gt; ./xmllint err2.xml
1910err2.xml:1: error: Unsupported encoding UnsupportedEnc
1911&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
1912 ^</pre>
1913 </li>
1914 <li>From that point the encoder process progressingly the input (it is
1915 plugged as a front-end to the I/O module) for that entity. It captures
1916 and convert on-the-fly the document to be parsed to UTF-8. The parser
1917 itself just does UTF-8 checking of this input and process it
1918 transparently. The only difference is that the encoding information has
1919 been added to the parsing context (more precisely to the input
1920 corresponding to this entity).</li>
1921 <li>The result (when using DOM) is an internal form completely in UTF-8
1922 with just an encoding information on the document node.</li>
1923</ol>
1924
1925<p>Ok then what's happen when saving the document (assuming you
1926colllected/built an xmlDoc DOM like structure) ? It depends on the function
1927called, xmlSaveFile() will just try to save in the original encoding, while
1928xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
1929encoding:</p>
1930<ol>
1931 <li>if no encoding is given, libxml will look for an encoding value
1932 associated to the document and if it exists will try to save to that
1933 encoding,
1934 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
1935 </li>
1936 <li>so if an encoding was specified, either at the API level or on the
1937 document, libxml will again canonalize the encoding name, lookup for a
1938 converter in the registered set or through iconv. If not found the
1939 function will return an error code</li>
1940 <li>the converter is placed before the I/O buffer layer, as another kind of
1941 buffer, then libxml will simply push the UTF-8 serialization to through
1942 that buffer, which will then progressively be converted and pushed onto
1943 the I/O layer.</li>
1944 <li>It is possible that the converter code fails on some input, for example
1945 trying to push an UTF-8 encoded chinese character through the UTF-8 to
1946 ISO-8859-1 converter won't work. Since the encoders are progressive they
1947 will just report the error and the number of bytes converted, at that
1948 point libxml will decode the offending character, remove it from the
1949 buffer and replace it with the associated charRef encoding &amp;#123; and
1950 resume the convertion. This guarante that any document will be saved
1951 without losses (except for markup names where this is not legal, this is
1952 a problem in the current version, in pactice avoid using non-ascci
1953 characters for tags or attributes names @@). A special "ascii" encoding
1954 name is used to save documents to a pure ascii form can be used when
1955 portability is really crucial</li>
1956</ol>
1957
1958<p>Here is a few examples based on the same test document:</p>
1959<pre>~/XML -&gt; ./xmllint isolat1
1960&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
1961&lt;très&gt;là&lt;/très&gt;
1962~/XML -&gt; ./xmllint --encode UTF-8 isolat1
1963&lt;?xml version="1.0" encoding="UTF-8"?&gt;
1964&lt;très&gt;là  &lt;/très&gt;
1965~/XML -&gt; </pre>
1966
1967<p>The same processing is applied (and reuse most of the code) for HTML I18N
1968processing. Looking up and modifying the content encoding is a bit more
1969difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
1970so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
1971been provided. The parser also attempts to switch encoding on the fly when
1972detecting such a tag on input. Except for that the processing is the same
1973(and again reuses the same code).</p>
1974
1975<h3><a name="Default">Default supported encodings</a></h3>
1976
1977<p>libxml has a set of default converters for the following encodings
1978(located in encoding.c):</p>
1979<ol>
1980 <li>UTF-8 is supported by default (null handlers)</li>
1981 <li>UTF-16, both little and big endian</li>
1982 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
1983 <li>ASCII, useful mostly for saving</li>
1984 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
1985 predefined entities like &amp;copy; for the Copyright sign.</li>
1986</ol>
1987
1988<p>More over when compiled on an Unix platfor with iconv support the full set
1989of encodings supported by iconv can be instantly be used by libxml. On a
1990linux machine with glibc-2.1 the list of supported encodings and aliases fill
19913 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
1992various Japanese ones.</p>
1993
1994<h4>Encoding aliases</h4>
1995
1996<p>From 2.2.3, libxml has support to register encoding names aliases. The
1997goal is to be able to parse document whose encoding is supported but where
1998the name differs (for example from the default set of names accepted by
1999iconv). The following functions allow to register and handle new aliases for
2000existing encodings. Once registered libxml will automatically lookup the
2001aliases when handling a document:</p>
2002<ul>
2003 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
2004 <li>int xmlDelEncodingAlias(const char *alias);</li>
2005 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
2006 <li>void xmlCleanupEncodingAliases(void);</li>
2007</ul>
2008
2009<h3><a name="extend">How to extend the existing support</a></h3>
2010
2011<p>Well adding support for new encoding, or overriding one of the encoders
2012(assuming it is buggy) should not be hard, just write an input and output
2013conversion routines to/from UTF-8, and register them using
2014xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
2015called automatically if the parser(s) encounter such an encoding name
2016(register it uppercase, this will help). The description of the encoders,
2017their arguments and expected return values are described in the encoding.h
2018header.</p>
2019
2020<p>A quick note on the topic of subverting the parser to use a different
2021internal encoding than UTF-8, in some case people will absolutely want to
2022keep the internal encoding different, I think it's still possible (but the
2023encoding must be compliant with ASCII on the same subrange) though I didn't
2024tried it. The key is to override the default conversion routines (by
2025registering null encoders/decoders for your charsets), and bypass the UTF-8
2026checking of the parser by setting the parser context charset
2027(ctxt-&gt;charset) to something different than XML_CHAR_ENCODING_UTF8, but
2028there is no guarantee taht this will work. You may also have some troubles
2029saving back.</p>
2030
2031<p>Basically proper I18N support is important, this requires at least
2032libxml-2.0.0, but a lot of features and corrections are really available only
2033starting 2.2.</p>
2034
2035<h2><a name="IO">I/O Interfaces</a></h2>
2036
2037<p>Table of Content:</p>
2038<ol>
2039 <li><a href="#General1">General overview</a></li>
2040 <li><a href="#basic">The basic buffer type</a></li>
2041 <li><a href="#Input">Input I/O handlers</a></li>
2042 <li><a href="#Output">Output I/O handlers</a></li>
2043 <li><a href="#entities">The entities loader</a></li>
2044 <li><a href="#Example2">Example of customized I/O</a></li>
2045</ol>
2046
2047<h3><a name="General1">General overview</a></h3>
2048
2049<p>The module <code><a
2050href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
2051the interfaces to the libxml I/O system. This consists of 4 main parts:</p>
2052<ul>
2053 <li>Entities loader, this is a routine which tries to fetch the entities
2054 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
2055 don't look at the public identifier since libxml do not maintain a
2056 catalog. You can redefine you own entity loader by using
2057 <code>xmlGetExternalEntityLoader()</code> and
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]2058 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
2059 example</a>.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2060 <li>Input I/O buffers which are a commodity structure used by the parser(s)
2061 input layer to handle fetching the informations to feed the parser. This
2062 provides buffering and is also a placeholder where the encoding
2063 convertors to UTF8 are piggy-backed.</li>
2064 <li>Output I/O buffers are similar to the Input ones and fulfill similar
2065 task but when generating a serialization from a tree.</li>
2066 <li>A mechanism to register sets of I/O callbacks and associate them with
2067 specific naming schemes like the protocol part of the URIs.
2068 <p>This affect the default I/O operations and allows to use specific I/O
2069 handlers for certain names.</p>
2070 </li>
2071</ul>
2072
2073<p>The general mechanism used when loading http://rpmfind.net/xml.html for
2074example in the HTML parser is the following:</p>
2075<ol>
2076 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
2077 the parsing context and the URI string.</li>
2078 <li>the URI string is checked against the existing registered handlers
2079 using their match() callback function, if the HTTP module was compiled
2080 in, it is registered and its match() function will succeeds</li>
2081 <li>the open() function of the handler is called and if successful will
2082 return an I/O Input buffer</li>
2083 <li>the parser will the start reading from this buffer and progressively
2084 fetch information from the resource, calling the read() function of the
2085 handler until the resource is exhausted</li>
2086 <li>if an encoding change is detected it will be installed on the input
2087 buffer, providing buffering and efficient use of the conversion
2088 routines</li>
2089 <li>once the parser has finished, the close() function of the handler is
2090 called once and the Input buffer and associed resources are
2091 deallocated.</li>
2092</ol>
2093
2094<p>The user defined callbacks are checked first to allow overriding of the
2095default libxml I/O routines.</p>
2096
2097<h3><a name="basic">The basic buffer type</a></h3>
2098
2099<p>All the buffer manipulation handling is done using the
2100<code>xmlBuffer</code> type define in <code><a
2101href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
2102resizable memory buffer. The buffer allocation strategy can be selected to be
2103either best-fit or use an exponential doubling one (CPU vs. memory use
2104tradeoff). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
2105<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
2106system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
2107of functions allows to manipulate buffers with names starting with the
2108<code>xmlBuffer...</code> prefix.</p>
2109
2110<h3><a name="Input">Input I/O handlers</a></h3>
2111
2112<p>An Input I/O handler is a simple structure
2113<code>xmlParserInputBuffer</code> containing a context associated to the
2114resource (file descriptor, or pointer to a protocol handler), the read() and
2115close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
2116encoding handler are also present to support charset conversion when
2117needed.</p>
2118
2119<h3><a name="Output">Output I/O handlers</a></h3>
2120
2121<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
2122Input one except the callbacks are write() and close().</p>
2123
2124<h3><a name="entities">The entities loader</a></h3>
2125
2126<p>The entity loader resolves requests for new entities and create inputs for
2127the parser. Creating an input from a filename or an URI string is done
2128through the xmlNewInputFromFile() routine. The default entity loader do not
2129handle the PUBLIC identifier associated with an entity (if any). So it just
2130calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
2131XML).</p>
2132
2133<p>If you want to hook up a catalog mechanism then you simply need to
2134override the default entity loader, here is an example:</p>
2135<pre>#include &lt;libxml/xmlIO.h&gt;
2136
2137xmlExternalEntityLoader defaultLoader = NULL;
2138
2139xmlParserInputPtr
2140xmlMyExternalEntityLoader(const char *URL, const char *ID,
2141 xmlParserCtxtPtr ctxt) {
2142 xmlParserInputPtr ret;
2143 const char *fileID = NULL;
2144 /* lookup for the fileID depending on ID */
2145
2146 ret = xmlNewInputFromFile(ctxt, fileID);
2147 if (ret != NULL)
2148 return(ret);
2149 if (defaultLoader != NULL)
2150 ret = defaultLoader(URL, ID, ctxt);
2151 return(ret);
2152}
2153
2154int main(..) {
2155 ...
2156
2157 /*
2158 * Install our own entity loader
2159 */
2160 defaultLoader = xmlGetExternalEntityLoader();
2161 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
2162
2163 ...
2164}</pre>
2165
2166<h3><a name="Example2">Example of customized I/O</a></h3>
2167
2168<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
2169real use case</a>, xmlDocDump() closes the FILE * passed by the application
2170and this was a problem. The <a
2171href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
2172new output handler with the closing call deactivated:</p>
2173<ol>
2174 <li>First define a new I/O ouput allocator where the output don't close the
2175 file:
2176 <pre>xmlOutputBufferPtr
2177xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
2178    xmlOutputBufferPtr ret;
2179    
2180    if (xmlOutputCallbackInitialized == 0)
2181        xmlRegisterDefaultOutputCallbacks();
2182
2183    if (file == NULL) return(NULL);
2184    ret = xmlAllocOutputBuffer(encoder);
2185    if (ret != NULL) {
2186        ret-&gt;context = file;
2187        ret-&gt;writecallback = xmlFileWrite;
2188        ret-&gt;closecallback = NULL; /* No close callback */
2189    }
2190    return(ret); <br>
2191
2192
2193
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]2194
2195
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]2196
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]2197
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]2198
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]2199
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]2200
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]2201
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]2202
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]2203
Daniel Veillard9ae4b7a2001-12-13 14:24:09 +0000[diff] [blame]2204
Daniel Veillard845cce42002-01-09 11:51:37 +0000[diff] [blame]2205
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]2206
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]2207
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]2208
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame^]2209
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2210} </pre>
2211 </li>
2212 <li>And then use it to save the document:
2213 <pre>FILE *f;
2214xmlOutputBufferPtr output;
2215xmlDocPtr doc;
2216int res;
2217
2218f = ...
2219doc = ....
2220
2221output = xmlOutputBufferCreateOwn(f, NULL);
2222res = xmlSaveFileTo(output, doc, NULL);
2223 </pre>
2224 </li>
2225</ol>
2226
2227<h2><a name="Catalog">Catalog support</a></h2>
2228
2229<p>Table of Content:</p>
2230<ol>
2231 <li><a href="General2">General overview</a></li>
2232 <li><a href="#definition">The definition</a></li>
2233 <li><a href="#Simple">Using catalogs</a></li>
2234 <li><a href="#Some">Some examples</a></li>
2235 <li><a href="#reference">How to tune catalog usage</a></li>
2236 <li><a href="#validate">How to debug catalog processing</a></li>
2237 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
2238 <li><a href="#implemento">The implementor corner quick review of the
2239 API</a></li>
2240 <li><a href="#Other">Other resources</a></li>
2241</ol>
2242
2243<h3><a name="General2">General overview</a></h3>
2244
2245<p>What is a catalog? Basically it's a lookup mechanism used when an entity
2246(a file or a remote resource) references another entity. The catalog lookup
2247is inserted between the moment the reference is recognized by the software
2248(XML parser, stylesheet processing, or even images referenced for inclusion
2249in a rendering) and the time where loading that resource is actually
2250started.</p>
2251
2252<p>It is basically used for 3 things:</p>
2253<ul>
2254 <li>mapping from "logical" names, the public identifiers and a more
2255 concrete name usable for download (and URI). For example it can associate
2256 the logical name
2257 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
2258 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
2259 downloaded</p>
2260 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
2261 </li>
2262 <li>remapping from a given URL to another one, like an HTTP indirection
2263 saying that
2264 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
2265 <p>should really be looked at</p>
2266 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
2267 </li>
2268 <li>providing a local cache mechanism allowing to load the entities
2269 associated to public identifiers or remote resources, this is a really
2270 important feature for any significant deployment of XML or SGML since it
2271 allows to avoid the aleas and delays associated to fetching remote
2272 resources.</li>
2273</ul>
2274
2275<h3><a name="definition">The definitions</a></h3>
2276
2277<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
2278<ul>
2279 <li>the older SGML catalogs, the official spec is SGML Open Technical
2280 Resolution TR9401:1997, but is better understood by reading <a
2281 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
2282 James Clark. This is relatively old and not the preferred mode of
2283 operation of libxml.</li>
2284 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
2285 Catalogs</a>
2286 is far more flexible, more recent, uses an XML syntax and should scale
2287 quite better. This is the default option of libxml.</li>
2288</ul>
2289
2290<p></p>
2291
2292<h3><a name="Simple">Using catalog</a></h3>
2293
2294<p>In a normal environment libxml will by default check the presence of a
2295catalog in /etc/xml/catalog, and assuming it has been correctly populated,
2296the processing is completely transparent to the document user. To take a
2297concrete example, suppose you are authoring a DocBook document, this one
2298starts with the following DOCTYPE definition:</p>
2299<pre>&lt;?xml version='1.0'?&gt;
2300&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
2301 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
2302
2303<p>When validating the document with libxml, the catalog will be
2304automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
2305DocBk XML V3.1.4//EN" and the system identifier
2306"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
2307been installed on your system and the catalogs actually point to them, libxml
2308will fetch them from the local disk.</p>
2309
2310<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
2311DOCTYPE example it's a really old version, but is fine as an example.</p>
2312
2313<p>Libxml will check the catalog each time that it is requested to load an
2314entity, this includes DTD, external parsed entities, stylesheets, etc ... If
2315your system is correctly configured all the authoring phase and processing
2316should use only local files, even if your document stays portable because it
2317uses the canonical public and system ID, referencing the remote document.</p>
2318
2319<h3><a name="Some">Some examples:</a></h3>
2320
2321<p>Here is a couple of fragments from XML Catalogs used in libxml early
2322regression tests in <code>test/catalogs</code> :</p>
2323<pre>&lt;?xml version="1.0"?&gt;
2324&lt;!DOCTYPE catalog PUBLIC
2325 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
2326 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
2327&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
2328 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
2329 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
2330...</pre>
2331
2332<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
2333written in XML, there is a specific namespace for catalog elements
2334"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
2335catalog is a <code>public</code> mapping it allows to associate a Public
2336Identifier with an URI.</p>
2337<pre>...
2338 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
2339 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
2340...</pre>
2341
2342<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
2343any URI starting with a given prefix should be looked at another URI
2344constructed by replacing the prefix with an new one. In effect this acts like
2345a cache system for a full area of the Web. In practice it is extremely useful
2346with a file prefix if you have installed a copy of those resources on your
2347local system.</p>
2348<pre>...
2349&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
2350 catalog="file:///usr/share/xml/docbook.xml"/&gt;
2351&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
2352 catalog="file:///usr/share/xml/docbook.xml"/&gt;
2353&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
2354 catalog="file:///usr/share/xml/docbook.xml"/&gt;
2355&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
2356 catalog="file:///usr/share/xml/docbook.xml"/&gt;
2357&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
2358 catalog="file:///usr/share/xml/docbook.xml"/&gt;
2359...</pre>
2360
2361<p>Delegation is the core features which allows to build a tree of catalogs,
2362easier to maintain than a single catalog, based on Public Identifier, System
2363Identifier or URI prefixes it instructs the catalog software to look up
2364entries in another resource. This feature allow to build hierarchies of
2365catalogs, the set of entries presented should be sufficient to redirect the
2366resolution of all DocBook references to the specific catalog in
2367<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
2368references for DocBook 4.2.1 to a specific catalog installed at the same time
2369as the DocBook resources on the local machine.</p>
2370
2371<h3><a name="reference">How to tune catalog usage:</a></h3>
2372
2373<p>The user can change the default catalog behaviour by redirecting queries
2374to its own set of catalogs, this can be done by setting the
2375<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
2376empty one should deactivate loading the default <code>/etc/xml/catalog</code>
2377default catalog</p>
2378
2379<h3><a name="validate">How to debug catalog processing:</a></h3>
2380
2381<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
2382make libxml output debugging informations for each catalog operations, for
2383example:</p>
2384<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
2385warning: failed to load external entity "title.xml"
2386orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
2387orchis:~/XML -&gt; xmllint --memory --noout test/ent2
2388Failed to parse catalog /etc/xml/catalog
2389Failed to parse catalog /etc/xml/catalog
2390warning: failed to load external entity "title.xml"
2391Catalogs cleanup
2392orchis:~/XML -&gt; </pre>
2393
2394<p>The test/ent2 references an entity, running the parser from memory makes
2395the base URI unavailable and the the "title.xml" entity cannot be loaded.
2396Setting up the debug environment variable allows to detect that an attempt is
2397made to load the <code>/etc/xml/catalog</code> but since it's not present the
2398resolution fails.</p>
2399
2400<p>But the most advanced way to debug XML catalog processing is to use the
2401<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
2402catalogs and make resolution queries to see what is going on. This is also
2403used for the regression tests:</p>
2404<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
2405 "-//OASIS//DTD DocBook XML V4.1.2//EN"
2406http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
2407orchis:~/XML -&gt; </pre>
2408
2409<p>For debugging what is going on, adding one -v flags increase the verbosity
2410level to indicate the processing done (adding a second flag also indicate
2411what elements are recognized at parsing):</p>
2412<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
2413 "-//OASIS//DTD DocBook XML V4.1.2//EN"
2414Parsing catalog test/catalogs/docbook.xml's content
2415Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
2416http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
2417Catalogs cleanup
2418orchis:~/XML -&gt; </pre>
2419
2420<p>A shell interface is also available to debug and process multiple queries
2421(and for regression tests):</p>
2422<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
2423 "-//OASIS//DTD DocBook XML V4.1.2//EN"
2424&gt; help
2425Commands available:
2426public PublicID: make a PUBLIC identifier lookup
2427system SystemID: make a SYSTEM identifier lookup
2428resolve PublicID SystemID: do a full resolver lookup
2429add 'type' 'orig' 'replace' : add an entry
2430del 'values' : remove values
2431dump: print the current catalog state
2432debug: increase the verbosity level
2433quiet: decrease the verbosity level
2434exit: quit the shell
2435&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
2436http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
2437&gt; quit
2438orchis:~/XML -&gt; </pre>
2439
2440<p>This should be sufficient for most debugging purpose, this was actually
2441used heavily to debug the XML Catalog implementation itself.</p>
2442
2443<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
2444
2445<p>Basically XML Catalogs are XML files, you can either use XML tools to
2446manage them or use <strong>xmlcatalog</strong> for this. The basic step is
2447to create a catalog the -create option provide this facility:</p>
2448<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
2449&lt;?xml version="1.0"?&gt;
2450&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
2451 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
2452&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
2453orchis:~/XML -&gt; </pre>
2454
2455<p>By default xmlcatalog does not overwrite the original catalog and save the
2456result on the standard output, this can be overridden using the -noout
2457option. The <code>-add</code> command allows to add entries in the
2458catalog:</p>
2459<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
2460 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
2461 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
2462orchis:~/XML -&gt; cat tst.xml
2463&lt;?xml version="1.0"?&gt;
2464&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
2465 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
2466&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
2467&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
2468 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
2469&lt;/catalog&gt;
2470orchis:~/XML -&gt; </pre>
2471
2472<p>The <code>-add</code> option will always take 3 parameters even if some of
2473the XML Catalog constructs (like nextCatalog) will have only a single
2474argument, just pass a third empty string, it will be ignored.</p>
2475
2476<p>Similarly the <code>-del</code> option remove matching entries from the
2477catalog:</p>
2478<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
2479 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
2480&lt;?xml version="1.0"?&gt;
2481&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
2482 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
2483&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
2484orchis:~/XML -&gt; </pre>
2485
2486<p>The catalog is now empty. Note that the matching of <code>-del</code> is
2487exact and would have worked in a similar fashion with the Public ID
2488string.</p>
2489
2490<p>This is rudimentary but should be sufficient to manage a not too complex
2491catalog tree of resources.</p>
2492
2493<h3><a name="implemento">The implementor corner quick review of the
2494API:</a></h3>
2495
2496<p>First, and like for every other module of libxml, there is an
2497automatically generated <a href="html/libxml-catalog.html">API page for
2498catalog support</a>.</p>
2499
2500<p>The header for the catalog interfaces should be included as:</p>
2501<pre>#include &lt;libxml/catalog.h&gt;</pre>
2502
2503<p>The API is voluntarily kept very simple. First it is not obvious that
2504applications really need access to it since it is the default behaviour of
2505libxml (Note: it is possible to completely override libxml default catalog by
2506using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
2507plug an application specific resolver).</p>
2508
2509<p>Basically libxml support 2 catalog lists:</p>
2510<ul>
2511 <li>the default one, global shared by all the application</li>
2512 <li>a per-document catalog, this one is built if the document uses the
2513 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
2514 associated to the parser context and destroyed when the parsing context
2515 is destroyed.</li>
2516</ul>
2517
2518<p>the document one will be used first if it exists.</p>
2519
2520<h4>Initialization routines:</h4>
2521
2522<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
2523used at startup to initialize the catalog, if the catalog should be
2524initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
2525should be called before xmlInitializeCatalog() which would otherwise do a
2526default initialization first.</p>
2527
2528<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
2529own catalog list if needed.</p>
2530
2531<h4>Preferences setup:</h4>
2532
2533<p>The XML Catalog spec requires the possibility to select default
2534preferences between public and system delegation,
2535xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
2536xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
2537be forbidden, allowed for global catalog, for document catalog or both, the
2538default is to allow both.</p>
2539
2540<p>And of course xmlCatalogSetDebug() allows to generate debug messages
2541(through the xmlGenericError() mechanism).</p>
2542
2543<h4>Querying routines:</h4>
2544
2545<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
2546and xmlCatalogResolveURI() are relatively explicit if you read the XML
2547Catalog specification they correspond to section 7 algorithms, they should
2548also work if you have loaded an SGML catalog with a simplified semantic.</p>
2549
2550<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
2551operate on the document catalog list</p>
2552
2553<h4>Cleanup and Miscellaneous:</h4>
2554
2555<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
2556the per-document equivalent.</p>
2557
2558<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
2559first catalog in the global list, and xmlCatalogDump() allows to dump a
2560catalog state, those routines are primarily designed for xmlcatalog, I'm not
2561sure that exposing more complex interfaces (like navigation ones) would be
2562really useful.</p>
2563
2564<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
2565it's similar as xmlParseFile() except it bypass all catalog lookups, it's
2566provided because this functionality may be useful for client tools.</p>
2567
2568<h4>threaded environments:</h4>
2569
2570<p>Since the catalog tree is built progressively, some care has been taken to
2571try to avoid troubles in multithreaded environments. The code is now thread
2572safe assuming that the libxml library has been compiled with threads
2573support.</p>
2574
2575<p></p>
2576
2577<h3><a name="Other">Other resources</a></h3>
2578
2579<p>The XML Catalog specification is relatively recent so there isn't much
2580literature to point at:</p>
2581<ul>
2582 <li>You can find an good rant from Norm Walsh about <a
2583 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
2584 need for catalogs</a>, it provides a lot of context informations even if
2585 I don't agree with everything presented.</li>
2586 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
2587 catalog proposal</a> from John Cowan</li>
2588 <li>The <a href="http://www.rddl.org/">Resource Directory Description
2589 Language</a> (RDDL) another catalog system but more oriented toward
2590 providing metadata for XML namespaces.</li>
2591 <li>the page from the OASIS Technical <a
2592 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
2593 Resolution</a> who maintains XML Catalog, you will find pointers to the
2594 specification update, some background and pointers to others tools
2595 providing XML Catalog support</li>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]2596 <li>Here is a <a href="buildDocBookCatalog">shell script</a> to generate
2597 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
2598 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
2599 the resources found on the system. Otherwise it will just create
2600 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]2601 <p><code>export XMLCATALOG=$HOME/xmlcatalog</code></p>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]2602 <p>should allow to process DocBook documentations without requiring
2603 network accesses for the DTd or stylesheets</p>
2604 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2605 <li>I have uploaded <a href="ftp://xmlsoft.org/test/dbk412catalog.tar.gz">a
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]2606 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
2607 to work fine for me too</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2608 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
2609 manual page</a></li>
2610</ul>
2611
2612<p>If you have suggestions for corrections or additions, simply contact
2613me:</p>
2614
2615<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2616
2617<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2618using the XML library from the C language. It is not intended to be
2619extensive. I hope the automatically generated documents will provide the
2620completeness required, but as a separate set of documents. The interfaces of
2621the XML library are by principle low level, there is nearly zero abstraction.
2622Those interested in a higher level API should <a href="#DOM">look at
2623DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2624
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2625<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
2626separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2627interfaces</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]2628
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2629<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2630
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2631<p>Usually, the first thing to do is to read an XML input. The parser accepts
2632documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2633defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2634<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2635 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2636 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2637 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2638</dl>
2639<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2640 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2641 <dd><p>Parse an XML document contained in a (possibly compressed)
2642 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2643 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2644</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2645
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2646<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]2647failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2648
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2649<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2650
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2651<p>In order for the application to keep the control when the document is
2652being fetched (which is common for GUI based programs) libxml provides a push
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2653interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2654<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
2655 void *user_data,
2656 const char *chunk,
2657 int size,
2658 const char *filename);
2659int xmlParseChunk (xmlParserCtxtPtr ctxt,
2660 const char *chunk,
2661 int size,
2662 int terminate);</pre>
2663
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2664<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2665<pre> FILE *f;
2666
2667 f = fopen(filename, "r");
2668 if (f != NULL) {
2669 int res, size = 1024;
2670 char chars[1024];
2671 xmlParserCtxtPtr ctxt;
2672
2673 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2674 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2675 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
2676 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2677 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2678 xmlParseChunk(ctxt, chars, res, 0);
2679 }
2680 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2681 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2682 xmlFreeParserCtxt(ctxt);
2683 }
2684 }</pre>
2685
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2686<p>The HTML parser embedded into libxml also has a push interface; the
2687functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2688
2689<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
2690
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2691<p>The tree-building interface makes the parser memory-hungry, first loading
2692the document in memory and then building the tree itself. Reading a document
2693without building the tree is possible using the SAX interfaces (see SAX.h and
2694<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]2695Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2696limited to SAX: just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2697<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2698
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2699<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2700
2701<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]2702there is a set of functions dedicated to building new elements. (These are
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2703also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
2704code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2705<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2706 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2707 xmlNodePtr tree, subtree;
2708
2709 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2710 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
2711 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
2712 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
2713 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2714 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2715 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2716 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
2717 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
2718 subtree = xmlNewChild(tree, NULL, "image", NULL);
2719 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2720
2721<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2722
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2723<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2724
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2725<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2726code has access to the internal structure of all the elements of the tree.
2727The names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]2728<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2729<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2730example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2731<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2732
2733<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2734<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2735
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2736<p>points to the text node containing the chapter title "The Linux
2737adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2738
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2739<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]2740present before the document root, so <code>doc-&gt;children</code> may point
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2741to an element which is not the document Root Element; a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]2742<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2743
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2744<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2745
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2746<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2747is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2748<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]2749 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
2750 xmlChar *value);</code></dt>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2751 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
2752 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2753 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2754</dl>
2755<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]2756 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2757 *name);</code></dt>
Daniel Veillardc92c3042000-09-29 02:42:04 +0000[diff] [blame]2758 <dd><p>This function returns a pointer to new copy of the property
2759 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2760 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2761</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2762
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2763<p>Two functions are provided for reading and writing the text associated
2764with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2765<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]2766 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2767 *value);</code></dt>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2768 <dd><p>This function takes an "external" string and converts it to one
2769 text node or possibly to a list of entity and text nodes. All
2770 non-predefined entity references like &amp;Gnome; will be stored
2771 internally as entity nodes, hence the result of the function may not be
2772 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2773 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2774</dl>
2775<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]2776 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2777 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2778 <dd><p>This function is the inverse of
2779 <code>xmlStringGetNodeList()</code>. It generates a new string
2780 containing the content of the text and entity nodes. Note the extra
2781 argument inLine. If this argument is set to 1, the function will expand
2782 entity references. For example, instead of returning the &amp;Gnome;
2783 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2784 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2785 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2786</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2787
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2788<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2789
2790<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2791<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]2792 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2793 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2794 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2795 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2796</dl>
2797<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2798 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2799 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2800 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2801</dl>
2802<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2803 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2804 <dd><p>Saves the document to a file. In this case, the compression
2805 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2806 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2807</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2808
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2809<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2810
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2811<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2812accesses. The level of compression on saves can be turned on either globally
2813or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2814<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2815 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2816 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2817 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2818</dl>
2819<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2820 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2821 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2822 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2823</dl>
2824<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2825 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2826 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2827 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2828</dl>
2829<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2830 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2831 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2832 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2833</dl>
2834
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2835<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2836
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2837<p>Entities in principle are similar to simple C macros. An entity defines an
2838abbreviation for a given string that you can reuse many times throughout the
2839content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2840may occur frequently within a document, or to confine the change needed to a
2841document to a restricted area in the internal subset of the document (at the
2842beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2843<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]28442 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]28453 &lt;!ENTITY xml "Extensible Markup Language"&gt;
28464 ]&gt;
28475 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]28486 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]28497 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2850
2851<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]2852its name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2853are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2854predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2855<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2856for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2857<strong>&amp;quot;</strong> for the character '"', and
2858<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2859
2860<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]2861substitute an entity's content so that you can see the replacement text in
2862your application. Or you may prefer to keep entity references as such in the
2863content to be able to save the document back without losing this usually
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2864precious information (if the user went through the pain of explicitly
2865defining entities, he may have a a rather negative attitude if you blindly
2866susbtitute them as saving time). The <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2867href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2868function allows you to check and change the behaviour, which is to not
2869substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2870
2871<p>Here is the DOM tree built by libxml for the previous document in the
2872default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2873<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2874DOCUMENT
2875version=1.0
2876 ELEMENT EXAMPLE
2877 TEXT
2878 content=
2879 ENTITY_REF
2880 INTERNAL_GENERAL_ENTITY xml
2881 content=Extensible Markup Language
2882 TEXT
2883 content=</pre>
2884
2885<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2886<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2887DOCUMENT
2888version=1.0
2889 ELEMENT EXAMPLE
2890 TEXT
2891 content= Extensible Markup Language</pre>
2892
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2893<p>So, entities or no entities? Basically, it depends on your use case. I
2894suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2895entities in your XML document or data if you are not willing to handle the
2896entity references elements in the DOM tree.</p>
2897
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2898<p>Note that at save time libxml enforces the conversion of the predefined
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2899entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2900transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2901reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2902finding them in the input).</p>
2903
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]2904<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2905on top of the libxml SAX interface is difficult!!! If you plan to use
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]2906non-predefined entities in your documents, then the learning cuvre to handle
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2907then 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]2908strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]2909deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]2910
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2911<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2912
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]2913<p>The libxml library implements <a
2914href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
2915recognizing namespace contructs in the input, and does namespace lookup
2916automatically when building the DOM tree. A namespace declaration is
2917associated with an in-memory structure and all elements or attributes within
2918that namespace point to it. Hence testing the namespace is a simple and fast
2919equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2920
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2921<p>I suggest that people using libxml use a namespace, and declare it in the
2922root element of their document as the default namespace. Then they don't need
2923to 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]2924refinement and merging of data from different sources. This doesn't increase
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2925the size of the XML output significantly, but significantly increases its
2926value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2927<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
2928 &lt;elem1&gt;...&lt;/elem1&gt;
2929 &lt;elem2&gt;...&lt;/elem2&gt;
2930&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2931
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2932<p>The namespace value has to be an absolute URL, but the URL doesn't have to
2933point to any existing resource on the Web. It will bind all the element and
2934atributes with that URL. I suggest to use an URL within a domain you control,
2935and that the URL should contain some kind of version information if possible.
2936For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good
2937namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]2938
2939<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2940version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2941and if the version information don't match something you know, warn the user
2942and 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]2943namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2944same as &lt;bar:text&gt; in another document. What really matters is the URI
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2945associated with the element or the attribute, not the prefix string (which is
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2946just a shortcut for the full URI). In libxml, element and attributes have an
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]2947<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2948prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2949
2950<p>@@Interfaces@@</p>
2951
2952<p>@@Examples@@</p>
2953
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2954<p>Usually people object to using namespaces together with validity checking.
2955I will try to make sure that using namespaces won't break validity checking,
2956so even if you plan to use or currently are using validation I strongly
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2957suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2958<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2959flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2960from multiple DTDs will certainly break current validation schemes. I will
2961try to provide ways to do this, but this may not be portable or
2962standardized.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2963
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2964<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2965
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2966<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2967
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2968<p>Version 2 of libxml is the first version introducing serious backward
2969incompatible changes. The main goals were:</p>
2970<ul>
2971 <li>a general cleanup. A number of mistakes inherited from the very early
2972 versions couldn't be changed due to compatibility constraints. Example
2973 the "childs" element in the nodes.</li>
2974 <li>Uniformization of the various nodes, at least for their header and link
2975 parts (doc, parent, children, prev, next), the goal is a simpler
2976 programming model and simplifying the task of the DOM implementors.</li>
2977 <li>better conformances to the XML specification, for example version 1.x
2978 had an heuristic to try to detect ignorable white spaces. As a result the
2979 SAX event generated were ignorableWhitespace() while the spec requires
2980 character() in that case. This also mean that a number of DOM node
2981 containing blank text may populate the DOM tree which were not present
2982 before.</li>
2983</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2984
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2985<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2986
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2987<p>So client code of libxml designed to run with version 1.x may have to be
2988changed to compile against version 2.x of libxml. Here is a list of changes
2989that I have collected, they may not be sufficient, so in case you find other
2990change which are required, <a href="mailto:Daniel.Ïeillardw3.org">drop me a
2991mail</a>:</p>
2992<ol>
2993 <li>The package name have changed from libxml to libxml2, the library name
2994 is now -lxml2 . There is a new xml2-config script which should be used to
2995 select the right parameters libxml2</li>
2996 <li>Node <strong>childs</strong> field has been renamed
2997 <strong>children</strong> so s/childs/children/g should be applied
2998 (probablility of having "childs" anywere else is close to 0+</li>
2999 <li>The document don't have anymore a <strong>root</strong> element it has
3000 been replaced by <strong>children</strong> and usually you will get a
3001 list of element here. For example a Dtd element for the internal subset
3002 and it's declaration may be found in that list, as well as processing
3003 instructions or comments found before or after the document root element.
3004 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
3005 a document. Alternatively if you are sure to not reference Dtds nor have
3006 PIs or comments before or after the root element
3007 s/-&gt;root/-&gt;children/g will probably do it.</li>
3008 <li>The white space issue, this one is more complex, unless special case of
3009 validating parsing, the line breaks and spaces usually used for indenting
3010 and formatting the document content becomes significant. So they are
3011 reported by SAX and if your using the DOM tree, corresponding nodes are
3012 generated. Too approach can be taken:
3013 <ol>
3014 <li>lazy one, use the compatibility call
3015 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
3016 relying on a special (and possibly broken) set of heuristics of
3017 libxml to detect ignorable blanks. Don't complain if it breaks or
3018 make your application not 100% clean w.r.t. to it's input.</li>
3019 <li>the Right Way: change you code to accept possibly unsignificant
3020 blanks characters, or have your tree populated with weird blank text
3021 nodes. You can spot them using the comodity function
3022 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
3023 nodes.</li>
3024 </ol>
3025 <p>Note also that with the new default the output functions don't add any
3026 extra indentation when saving a tree in order to be able to round trip
3027 (read and save) without inflating the document with extra formatting
3028 chars.</p>
3029 </li>
3030 <li>The include path has changed to $prefix/libxml/ and the includes
3031 themselves uses this new prefix in includes instructions... If you are
3032 using (as expected) the
3033 <pre>xml2-config --cflags</pre>
3034 <p>output to generate you compile commands this will probably work out of
3035 the box</p>
3036 </li>
3037 <li>xmlDetectCharEncoding takes an extra argument indicating the lenght in
3038 byte of the head of the document available for character detection.</li>
3039</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3040
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3041<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3042
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3043<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
3044to allow smoth upgrade of existing libxml v1code while retaining
3045compatibility. They offers the following:</p>
3046<ol>
3047 <li>similar include naming, one should use
3048 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
3049 <li>similar identifiers defined via macros for the child and root fields:
3050 respectively <strong>xmlChildrenNode</strong> and
3051 <strong>xmlRootNode</strong></li>
3052 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
3053 inserted once in the client code</li>
3054</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3055
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3056<p>So the roadmap to upgrade your existing libxml applications is the
3057following:</p>
3058<ol>
3059 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
3060 <li>find all occurences where the xmlDoc <strong>root</strong> field is
3061 used and change it to <strong>xmlRootNode</strong></li>
3062 <li>similary find all occurences where the xmlNode <strong>childs</strong>
3063 field is used and change it to <strong>xmlChildrenNode</strong></li>
3064 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
3065 <strong>main()</strong> or in the library init entry point</li>
3066 <li>Recompile, check compatibility, it should still work</li>
3067 <li>Change your configure script to look first for xml2-config and fallback
3068 using xml-config . Use the --cflags and --libs ouptut of the command as
3069 the Include and Linking parameters needed to use libxml.</li>
3070 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
3071 libxml-devel-1.8.y can be kept simultaneously)</li>
3072 <li>remove your config.cache, relaunch your configuration mechanism, and
3073 recompile, if steps 2 and 3 were done right it should compile as-is</li>
3074 <li>Test that your application is still running correctly, if not this may
3075 be due to extra empty nodes due to formating spaces being kept in libxml2
3076 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
3077 code before calling the parser (next to
3078 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
3079</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3080
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3081<p>Following those steps should work. It worked for some of my own code.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3082
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3083<p>Let me put some emphasis on the fact that there is far more changes from
3084libxml 1.x to 2.x than the ones you may have to patch for. The overall code
3085has been considerably cleaned up and the conformance to the XML specification
3086has been drastically improved too. Don't take those changes as an excuse to
3087not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3088
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]3089<h2><a name="Thread">Thread safety</a></h2>
3090
3091<p>Starting with 2.4.7, libxml makes provisions to ensure that concurent
3092threads can safely work in parallel parsing different documents. There is
3093however a couple of things to do to ensure it:</p>
3094<ul>
3095 <li>configure the library accordingly using the --with-threads options</li>
3096 <li>call xmlInitParser() in the "main" thread before using any of the
3097 libxml API (except possibly selecting a different memory allocator)</li>
3098</ul>
3099
3100<p>Note that the thread safety cannot be ensured for multiple threads sharing
3101the same document, the locking must be done at the application level, libxml
3102exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
3103The parts of the library checked for thread safety are:</p>
3104<ul>
3105 <li>concurrent loading</li>
3106 <li>file access resolution</li>
3107 <li>catalog access</li>
3108 <li>catalog building</li>
3109 <li>entities lookup/accesses</li>
3110 <li>validation</li>
3111 <li>global variables per-thread override</li>
3112 <li>memory handling</li>
3113</ul>
3114
3115<p>XPath is supposed to be thread safe now, but this wasn't tested
3116seriously.</p>
3117
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]3118<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3119
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3120<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
3121Object Model</em>; this is an API for accessing XML or HTML structured
3122documents. Native support for DOM in Gnome is on the way (module gnome-dom),
3123and will be based on gnome-xml. This will be a far cleaner interface to
3124manipulate XML files within Gnome since it won't expose the internal
3125structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3126
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3127<p>The current DOM implementation on top of libxml is the <a
Daniel Veillarda47fb3d2001-03-25 17:23:49 +0000[diff] [blame]3128href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
3129is a full DOM interface, thanks to Paolo Casarini, check the <a
3130href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
3131informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3132
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]3133<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3134
3135<p>Here is a real size example, where the actual content of the application
3136data 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]3137a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3138storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
3139base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3140<pre>&lt;?xml version="1.0"?&gt;
3141&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
3142 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3143
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3144 &lt;gjob:Job&gt;
3145 &lt;gjob:Project ID="3"/&gt;
3146 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
3147 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3148
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3149 &lt;gjob:Update&gt;
3150 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
3151 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
3152 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
3153 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3154
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3155 &lt;gjob:Developers&gt;
3156 &lt;gjob:Developer&gt;
3157 &lt;/gjob:Developer&gt;
3158 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3159
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3160 &lt;gjob:Contact&gt;
3161 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
3162 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
3163 &lt;gjob:Company&gt;
3164 &lt;/gjob:Company&gt;
3165 &lt;gjob:Organisation&gt;
3166 &lt;/gjob:Organisation&gt;
3167 &lt;gjob:Webpage&gt;
3168 &lt;/gjob:Webpage&gt;
3169 &lt;gjob:Snailmail&gt;
3170 &lt;/gjob:Snailmail&gt;
3171 &lt;gjob:Phone&gt;
3172 &lt;/gjob:Phone&gt;
3173 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3174
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3175 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3176 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3177 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3178
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3179 &lt;gjob:Skills&gt;
3180 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3181
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3182 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3183 A GNOME based system that will allow a superuser to configure
3184 compressed and uncompressed files and/or file systems to be backed
3185 up with a supported media in the system. This should be able to
3186 perform via find commands generating a list of files that are passed
3187 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
3188 or via operations performed on the filesystem itself. Email
3189 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3190 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3191
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3192 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3193
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3194 &lt;/gjob:Jobs&gt;
3195&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3196
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3197<p>While loading the XML file into an internal DOM tree is a matter of
3198calling only a couple of functions, browsing the tree to gather the ata and
3199generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3200
3201<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3202structure. For example, the ordering of the attributes is not significant,
3203the XML specification is clear about it. It's also usually a good idea not to
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]3204depend on the order of the children of a given node, unless it really makes
3205things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3206<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3207 * A person record
3208 */
3209typedef struct person {
3210 char *name;
3211 char *email;
3212 char *company;
3213 char *organisation;
3214 char *smail;
3215 char *webPage;
3216 char *phone;
3217} person, *personPtr;
3218
3219/*
3220 * And the code needed to parse it
3221 */
3222personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
3223 personPtr ret = NULL;
3224
3225DEBUG("parsePerson\n");
3226 /*
3227 * allocate the struct
3228 */
3229 ret = (personPtr) malloc(sizeof(person));
3230 if (ret == NULL) {
3231 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3232 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3233 }
3234 memset(ret, 0, sizeof(person));
3235
3236 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3237 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3238 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3239 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
3240 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
3241 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
3242 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
3243 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3244 }
3245
3246 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3247}</pre>
3248
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3249<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3250<ul>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3251 <li>Usually a recursive parsing style is the more convenient one: XML data
3252 is by nature subject to repetitive constructs and usually exibits highly
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3253 stuctured patterns.</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3254 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
3255 i.e. the pointer to the global XML document and the namespace reserved to
3256 the application. Document wide information are needed for example to
3257 decode entities and it's a good coding practice to define a namespace for
3258 your application set of data and test that the element and attributes
3259 you're analyzing actually pertains to your application space. This is
3260 done by a simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]3261 <li>To retrieve text and attributes value, you can use the function
3262 <em>xmlNodeListGetString</em> to gather all the text and entity reference
3263 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3264</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3265
3266<p>Here is another piece of code used to parse another level of the
3267structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3268<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]3269/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3270 * a Description for a Job
3271 */
3272typedef struct job {
3273 char *projectID;
3274 char *application;
3275 char *category;
3276 personPtr contact;
3277 int nbDevelopers;
3278 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
3279} job, *jobPtr;
3280
3281/*
3282 * And the code needed to parse it
3283 */
3284jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
3285 jobPtr ret = NULL;
3286
3287DEBUG("parseJob\n");
3288 /*
3289 * allocate the struct
3290 */
3291 ret = (jobPtr) malloc(sizeof(job));
3292 if (ret == NULL) {
3293 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3294 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3295 }
3296 memset(ret, 0, sizeof(job));
3297
3298 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3299 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3300 while (cur != NULL) {
3301
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3302 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
3303 ret-&gt;projectID = xmlGetProp(cur, "ID");
3304 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3305 fprintf(stderr, "Project has no ID\n");
3306 }
3307 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3308 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
3309 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
3310 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
3311 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
3312 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
3313 ret-&gt;contact = parsePerson(doc, ns, cur);
3314 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3315 }
3316
3317 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3318}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]3319
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]3320<p>Once you are used to it, writing this kind of code is quite simple, but
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3321boring. Ultimately, it could be possble to write stubbers taking either C
3322data structure definitions, a set of XML examples or an XML DTD and produce
3323the code needed to import and export the content between C data and XML
3324storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3325
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]3326<p>Feel free to use <a href="example/gjobread.c">the code for the full C
3327parsing example</a> as a template, it is also available with Makefile in the
3328Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3329
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]3330<h2><a name="Contributi">Contributions</a></h2>
3331<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3332 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
3333 patches, Gary Pennington worked on the validation API, threading support
3334 and Solaris port.</li>
3335 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]3336 <li><a href="mailto:ari@lusis.org">Ari Johnson</a>
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]3337 provides a C++ wrapper for libxml:<br>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]3338 Website: <a
3339 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a><br>
3340 Download: <a
Daniel Veillard51095312001-10-28 18:51:57 +0000[diff] [blame]3341 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3342 <li><a href="mailto:izlatkovic@daenet.de">Igor Zlatkovic</a>
3343 is now the maintainer of the Windows port, <a
Daniel Veillard95189532001-07-26 18:30:26 +0000[diff] [blame]3344 href="http://www.fh-frankfurt.de/~igor/projects/libxml/index.html">he
3345 provides binaries</a></li>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]3346 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a>
Daniel Veillarddb9dfd92001-11-26 17:25:02 +0000[diff] [blame]3347 provides <a href="http://garypennington.net/libxml2/">Solaris
Daniel Veillard0a702dc2001-10-19 14:50:57 +0000[diff] [blame]3348 binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]3349 <li><a
3350 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3351 Sergeant</a>
3352 developped <a href="http://axkit.org/download/">XML::LibXSLT</a>, a perl
3353 wrapper for libxml2/libxslt as part of the <a
3354 href="http://axkit.com/">AxKit XML application server</a></li>
3355 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a>
3356 and <a href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
Daniel Veillardca989762001-06-23 17:39:29 +0000[diff] [blame]3357 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]3358 documentation</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3359 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a>
3360 provided <a href="http://xmlsoft.org/messages/0488.html">man
3361 pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +0000[diff] [blame]3362 <li>there is a module for <a
3363 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
3364 in OpenNSD/AOLServer</a></li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3365 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a>
3366 provides libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers
3367 for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]3368 <li>Petr Kozelka provides <a
3369 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
3370 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]3371</ul>
3372
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3373<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3374</body>
3375</html>