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