Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 26a45c815a6c6e849cd5c3dda6a0c52fa41626d0 / . / doc / xml.html
blob: da4200916c46da874c67b948630edfcec8c2f424 [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 Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]5 <title>The XML C parser and toolkit of Gnome</title>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]6 <meta name="GENERATOR" content="amaya 8.5, see http://www.w3.org/Amaya/">
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 Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]11<h1 align="center">The XML C parser and toolkit of Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]12
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]13<h1>Note: this is the flat content of the <a href="index.html">web
14site</a></h1>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]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
Daniel Veillard7ebac022004-02-25 22:36:35 +0000[diff] [blame]20<p
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]21style="text-align: right; font-style: italic; font-size: 10pt">"Programming
22with libxml2 is like the thrilling embrace of an exotic stranger." <a
23href="http://diveintomark.org/archives/2004/02/18/libxml2">Mark
24Pilgrim</a></p>
Daniel Veillard7ebac022004-02-25 22:36:35 +0000[diff] [blame]25
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]26<p>Libxml2 is the XML C parser and toolkit developed for the Gnome project
27(but usable outside of the Gnome platform), it is free software available
28under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
29License</a>. XML itself is a metalanguage to design markup languages, i.e.
30text language where semantic and structure are added to the content using
31extra "markup" information enclosed between angle brackets. HTML is the most
32well-known markup language. Though the library is written in C <a
33href="python.html">a variety of language bindings</a> make it available in
34other environments.</p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]35
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]36<p>Libxml2 is known to be very portable, the library should build and work
37without serious troubles on a variety of systems (Linux, Unix, Windows,
38CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, ...)</p>
Daniel Veillard710823b2003-03-04 10:05:52 +0000[diff] [blame]39
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]40<p>Libxml2 implements a number of existing standards related to markup
41languages:</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]42<ul>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]43 <li>the XML standard: <a
44 href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li>
45 <li>Namespaces in XML: <a
46 href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li>
47 <li>XML Base: <a
48 href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]49 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a> :
50 Uniform Resource Identifiers <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]51 href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li>
52 <li>XML Path Language (XPath) 1.0: <a
53 href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li>
54 <li>HTML4 parser: <a
55 href="http://www.w3.org/TR/html401/">http://www.w3.org/TR/html401/</a></li>
Daniel Veillard23a52c52003-08-18 10:01:18 +0000[diff] [blame]56 <li>XML Pointer Language (XPointer) Version 1.0: <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]57 href="http://www.w3.org/TR/xptr">http://www.w3.org/TR/xptr</a></li>
58 <li>XML Inclusions (XInclude) Version 1.0: <a
59 href="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</a></li>
Daniel Veillard23a52c52003-08-18 10:01:18 +0000[diff] [blame]60 <li>ISO-8859-x encodings, as well as <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]61 href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8]
62 and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>
63 [UTF-16] Unicode encodings, and more if using iconv support</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]64 <li>part of SGML Open Technical Resolution TR9401:1997</li>
65 <li>XML Catalogs Working Draft 06 August 2001: <a
66 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 Veillard5c396542002-03-15 07:57:50 +0000[diff] [blame]67 <li>Canonical XML Version 1.0: <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]68 href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a>
69 and the Exclusive XML Canonicalization CR draft <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]70 href="http://www.w3.org/TR/xml-exc-c14n">http://www.w3.org/TR/xml-exc-c14n</a></li>
Daniel Veillard758c5312003-12-15 11:51:25 +0000[diff] [blame]71 <li>Relax NG, ISO/IEC 19757-2:2003, <a
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]72 href="http://www.oasis-open.org/committees/relax-ng/spec-20011203.html">http://www.oasis-open.org/committees/relax-ng/spec-20011203.html</a></li>
Daniel Veillardf83a2c72003-04-08 13:48:40 +0000[diff] [blame]73 <li>W3C XML Schemas Part 2: Datatypes <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]74 href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC 02 May
75 2001</a></li>
76 <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a> Working Draft 7
77 April 2004</li>
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]78</ul>
79
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]80<p>In most cases libxml2 tries to implement the specifications in a
81relatively strictly compliant way. As of release 2.4.16, libxml2 passed all
821800+ tests from the <a
83href="http://www.oasis-open.org/committees/xml-conformance/">OASIS XML Tests
84Suite</a>.</p>
Daniel Veillard5b16f582002-02-20 11:38:46 +0000[diff] [blame]85
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]86<p>To some extent libxml2 provides support for the following additional
87specifications but doesn't claim to implement them completely:</p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]88<ul>
89 <li>Document Object Model (DOM) <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]90 href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>
91 the document model, but it doesn't implement the API itself, gdome2 does
92 this on top of libxml2</li>
93 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a> :
94 libxml2 implements a basic FTP client code</li>
95 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a> :
96 HTTP/1.0, again a basic HTTP client code</li>
97 <li>SAX: a SAX2 like interface and a minimal SAX1 implementation compatible
98 with early expat versions</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]99</ul>
100
Daniel Veillardf83a2c72003-04-08 13:48:40 +0000[diff] [blame]101<p>A partial implementation of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]102href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas Part
1031: Structure</a> is being worked on but it would be far too early to make any
104conformance statement about it at the moment.</p>
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]105
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]106<p>Separate documents:</p>
107<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]108 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a> providing an
109 implementation of XSLT 1.0 and common extensions like EXSLT for
110 libxml2</li>
111 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page</a>
112 : a standard DOM2 implementation for libxml2</li>
113 <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec page</a>: an
114 implementation of <a href="http://www.w3.org/TR/xmldsig-core/">W3C XML
115 Digital Signature</a> for libxml2</li>
116 <li>also check the related links section below for more related and active
117 projects.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]118</ul>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]119<!----------------<p>Results of the <a
Daniel Veillard806cada2003-03-19 21:58:59 +0000[diff] [blame]120href="http://xmlbench.sourceforge.net/results/benchmark/index.html">xmlbench
Daniel Veillard31ae4622004-02-16 07:45:44 +0000[diff] [blame]121benchmark</a> on sourceforge February 2004 (smaller is better):</p>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]122
Daniel Veillard31ae4622004-02-16 07:45:44 +0000[diff] [blame]123<p align="center"><img src="benchmark.png"
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]124alt="benchmark results for Expat Xerces libxml2 Oracle and Sun toolkits"></p>
Daniel Veillardcf80b782004-03-07 19:32:19 +0000[diff] [blame]125-------------->
Daniel Veillard806cada2003-03-19 21:58:59 +0000[diff] [blame]126
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]127<p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
128
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]129<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]130
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]131<p>This document describes libxml, the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]132href="http://www.w3.org/XML/">XML</a> C parser and toolkit developed for the
133<a href="http://www.gnome.org/">Gnome</a> project. <a
134href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
135structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]136
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]137<p>Here are some key points about libxml:</p>
138<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]139 <li>Libxml2 exports Push (progressive) and Pull (blocking) type parser
140 interfaces for both XML and HTML.</li>
141 <li>Libxml2 can do DTD validation at parse time, using a parsed document
142 instance, or with an arbitrary DTD.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]143 <li>Libxml2 includes complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000[diff] [blame]144 href="http://www.w3.org/TR/xpath">XPath</a>, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]145 href="http://www.w3.org/TR/xptr">XPointer</a> and <a
146 href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
147 <li>It is written in plain C, making as few assumptions as possible, and
148 sticking closely to ANSI C/POSIX for easy embedding. Works on
149 Linux/Unix/Windows, ported to a number of other platforms.</li>
150 <li>Basic support for HTTP and FTP client allowing applications to fetch
151 remote resources.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]152 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]153 <li>The internal document representation is as close as possible to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]154 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]155 <li>Libxml2 also has a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]156 href="http://www.megginson.com/SAX/index.html">SAX like interface</a>;
157 the interface is designed to be compatible with <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]158 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]159 <li>This library is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]160 href="http://www.opensource.org/licenses/mit-license.html">MIT
161 License</a>. See the Copyright file in the distribution for the precise
162 wording.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]163</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]164
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]165<p>Warning: unless you are forced to because your application links with a
166Gnome-1.X library requiring it, <strong><span
167style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
168libxml2</p>
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]169
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]170<h2><a name="FAQ">FAQ</a></h2>
171
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]172<p>Table of Contents:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]173<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]174 <li><a href="FAQ.html#License">License(s)</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]175 <li><a href="FAQ.html#Installati">Installation</a></li>
176 <li><a href="FAQ.html#Compilatio">Compilation</a></li>
177 <li><a href="FAQ.html#Developer">Developer corner</a></li>
178</ul>
179
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]180<h3><a name="License">License</a>(s)</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]181<ol>
182 <li><em>Licensing Terms for libxml</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]183 <p>libxml2 is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]184 href="http://www.opensource.org/licenses/mit-license.html">MIT
185 License</a>; see the file Copyright in the distribution for the precise
186 wording</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]187 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]188 <li><em>Can I embed libxml2 in a proprietary application ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]189 <p>Yes. The MIT License allows you to keep proprietary the changes you
190 made to libxml, but it would be graceful to send-back bug fixes and
191 improvements as patches for possible incorporation in the main
192 development tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]193 </li>
194</ol>
195
196<h3><a name="Installati">Installation</a></h3>
197<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]198 <li><strong><span style="background-color: #FF0000">Do Not Use
199 libxml1</span></strong>, use libxml2</li>
200 <li><em>Where can I get libxml</em> ?
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]201 <p>The original distribution comes from <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]202 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a
Daniel Veillard024f1992003-12-10 16:43:49 +0000[diff] [blame]203 href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]204 <p>Most Linux and BSD distributions include libxml, this is probably the
205 safer way for end-users to use libxml.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]206 <p>David Doolin provides precompiled Windows versions at <a
207 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/ ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
208 </li>
209 <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
210 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]211 <li>If you are not constrained by backward compatibility issues with
212 existing applications, install libxml2 only</li>
213 <li>If you are not doing development, you can safely install both.
214 Usually the packages <a
215 href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a
216 href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
217 compatible (this is not the case for development packages).</li>
218 <li>If you are a developer and your system provides separate packaging
219 for shared libraries and the development components, it is possible
220 to install libxml and libxml2, and also <a
221 href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
222 and <a
223 href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
224 too for libxml2 &gt;= 2.3.0</li>
225 <li>If you are developing a new application, please develop against
226 libxml2(-devel)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]227 </ul>
228 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]229 <li><em>I can't install the libxml package, it conflicts with libxml0</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]230 <p>You probably have an old libxml0 package used to provide the shared
231 library for libxml.so.0, you can probably safely remove it. The libxml
232 packages provided on <a
233 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> provide
234 libxml.so.0</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]235 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]236 <li><em>I can't install the libxml(2) RPM package due to failed
237 dependencies</em>
238 <p>The most generic solution is to re-fetch the latest src.rpm , and
239 rebuild it locally with</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]240 <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]241 <p>If everything goes well it will generate two binary rpm packages (one
242 providing the shared libs and xmllint, and the other one, the -devel
243 package, providing includes, static libraries and scripts needed to build
244 applications with libxml(2)) that you can install locally.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]245 </li>
246</ol>
247
248<h3><a name="Compilatio">Compilation</a></h3>
249<ol>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]250 <li><em>What is the process to compile libxml2 ?</em>
251 <p>As most UNIX libraries libxml2 follows the "standard":</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]252 <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
253 <p><code>cd libxml-xxxx</code></p>
254 <p><code>./configure --help</code></p>
255 <p>to see the options, then the compilation/installation proper</p>
256 <p><code>./configure [possible options]</code></p>
257 <p><code>make</code></p>
258 <p><code>make install</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]259 <p>At that point you may have to rerun ldconfig or a similar utility to
260 update your list of installed shared libs.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]261 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]262 <li><em>What other libraries are needed to compile/install libxml2 ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]263 <p>Libxml2 does not require any other library, the normal C ANSI API
264 should be sufficient (please report any violation to this rule you may
265 find).</p>
266 <p>However if found at configuration time libxml2 will detect and use the
267 following libs:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]268 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]269 <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
270 highly portable and available widely compression library.</li>
271 <li>iconv: a powerful character encoding conversion library. It is
272 included by default in recent glibc libraries, so it doesn't need to
273 be installed specifically on Linux. It now seems a <a
274 href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
275 of the official UNIX</a> specification. Here is one <a
276 href="http://www.gnu.org/software/libiconv/">implementation of the
277 library</a> which source can be found <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]278 href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
279 </ul>
280 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]281 <li><em>Make check fails on some platforms</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]282 <p>Sometimes the regression tests' results don't completely match the
283 value produced by the parser, and the makefile uses diff to print the
284 delta. On some platforms the diff return breaks the compilation process;
285 if the diff is small this is probably not a serious problem.</p>
286 <p>Sometimes (especially on Solaris) make checks fail due to limitations
287 in make. Try using GNU-make instead.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]288 </li>
289 <li><em>I use the CVS version and there is no configure script</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]290 <p>The configure script (and other Makefiles) are generated. Use the
291 autogen.sh script to regenerate the configure script and Makefiles,
292 like:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]293 <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
294 </li>
295 <li><em>I have troubles when running make tests with gcc-3.0</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]296 <p>It seems the initial release of gcc-3.0 has a problem with the
297 optimizer which miscompiles the URI module. Please use another
298 compiler.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]299 </li>
300</ol>
301
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]302<h3><a name="Developer">Developer</a> corner</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]303<ol>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]304 <li><em>Troubles compiling or linking programs using libxml2</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]305 <p>Usually the problem comes from the fact that the compiler doesn't get
306 the right compilation or linking flags. There is a small shell script
307 <code>xml2-config</code> which is installed as part of libxml2 usual
308 install process which provides those flags. Use</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]309 <p><code>xml2-config --cflags</code></p>
310 <p>to get the compilation flags and</p>
311 <p><code>xml2-config --libs</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]312 <p>to get the linker flags. Usually this is done directly from the
313 Makefile as:</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]314 <p><code>CFLAGS=`xml2-config --cflags`</code></p>
315 <p><code>LIBS=`xml2-config --libs`</code></p>
316 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]317 <li><em>I want to install my own copy of libxml2 in my home directory and
318 link my programs against it, but it doesn't work</em>
319 <p>There are many different ways to accomplish this. Here is one way to
320 do this under Linux. Suppose your home directory is <code>/home/user.
321 </code>Then:</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]322 <ul>
323 <li>Create a subdirectory, let's call it <code>myxml</code></li>
William M. Brack99906ad2005-01-09 17:02:42 +0000[diff] [blame]324 <li>unpack the libxml2 distribution into that subdirectory</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]325 <li>chdir into the unpacked distribution
326 (<code>/home/user/myxml/libxml2 </code>)</li>
327 <li>configure the library using the "<code>--prefix</code>" switch,
328 specifying an installation subdirectory in
329 <code>/home/user/myxml</code>, e.g.
330 <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other
331 configuration options}</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]332 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]333 <li>now run <code>make</code> followed by <code>make install</code></li>
334 <li>At this point, the installation subdirectory contains the complete
335 "private" include files, library files and binary program files (e.g.
336 xmllint), located in
337 <p><code>/home/user/myxml/xmlinst/lib,
338 /home/user/myxml/xmlinst/include </code> and <code>
339 /home/user/myxml/xmlinst/bin</code></p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]340 respectively.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]341 <li>In order to use this "private" library, you should first add it to
342 the beginning of your default PATH (so that your own private program
343 files such as xmllint will be used instead of the normal system
344 ones). To do this, the Bash command would be
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]345 <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p>
346 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]347 <li>Now suppose you have a program <code>test1.c</code> that you would
348 like to compile with your "private" library. Simply compile it using
349 the command
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]350 <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]351 Note that, because your PATH has been set with <code>
352 /home/user/myxml/xmlinst/bin</code> at the beginning, the xml2-config
353 program which you just installed will be used instead of the system
354 default one, and this will <em>automatically</em> get the correct
355 libraries linked with your program.</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]356 </ul>
357 </li>
358
359 <p></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]360 <li><em>xmlDocDump() generates output on one line.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]361 <p>Libxml2 will not <strong>invent</strong> spaces in the content of a
362 document since <strong>all spaces in the content of a document are
363 significant</strong>. If you build a tree from the API and want
364 indentation:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]365 <ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]366 <li>the correct way is to generate those yourself too.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]367 <li>the dangerous way is to ask libxml2 to add those blanks to your
368 content <strong>modifying the content of your document in the
369 process</strong>. The result may not be what you expect. There is
370 <strong>NO</strong> way to guarantee that such a modification won't
371 affect other parts of the content of your document. See <a
372 href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault
373 ()</a> and <a
374 href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile
375 ()</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]376 </ol>
377 </li>
378 <li>Extra nodes in the document:
379 <p><em>For a XML file as below:</em></p>
380 <pre>&lt;?xml version="1.0"?&gt;
381&lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
382&lt;NODE CommFlag="0"/&gt;
383&lt;NODE CommFlag="1"/&gt;
384&lt;/PLAN&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]385 <p><em>after parsing it with the function
386 pxmlDoc=xmlParseFile(...);</em></p>
387 <p><em>I want to the get the content of the first node (node with the
388 CommFlag="0")</em></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]389 <p><em>so I did it as following;</em></p>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]390 <pre>xmlNodePtr pnode;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]391pnode=pxmlDoc-&gt;children-&gt;children;</pre>
392 <p><em>but it does not work. If I change it to</em></p>
393 <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
394 <p><em>then it works. Can someone explain it to me.</em></p>
395 <p></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]396 <p>In XML all characters in the content of the document are significant
397 <strong>including blanks and formatting line breaks</strong>.</p>
398 <p>The extra nodes you are wondering about are just that, text nodes with
399 the formatting spaces which are part of the document but that people tend
400 to forget. There is a function <a
401 href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
402 ()</a> to remove those at parse time, but that's an heuristic, and its
403 use should be limited to cases where you are certain there is no
404 mixed-content in the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]405 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]406 <li><em>I get compilation errors of existing code like when accessing
407 <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
408 <p>You are compiling code developed for libxml version 1 and using a
409 libxml2 development environment. Either switch back to libxml v1 devel or
410 even better fix the code to compile with libxml2 (or both) by <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]411 href="upgrade.html">following the instructions</a>.</p>
412 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]413 <li><em>I get compilation errors about non existing
414 <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
415 fields.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]416 <p>The source code you are using has been <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]417 href="upgrade.html">upgraded</a> to be able to compile with both libxml
418 and libxml2, but you need to install a more recent version:
419 libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]420 </li>
421 <li><em>XPath implementation looks seriously broken</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]422 <p>XPath implementation prior to 2.3.0 was really incomplete. Upgrade to
423 a recent version, there are no known bugs in the current version.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]424 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]425 <li><em>The example provided in the web page does not compile.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]426 <p>It's hard to maintain the documentation in sync with the code
427 &lt;grin/&gt; ...</p>
428 <p>Check the previous points 1/ and 2/ raised before, and please send
429 patches.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]430 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]431 <li><em>Where can I get more examples and information than provided on the
432 web page?</em>
433 <p>Ideally a libxml2 book would be nice. I have no such plan ... But you
434 can:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]435 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]436 <li>check more deeply the <a href="html/libxml-lib.html">existing
437 generated doc</a></li>
438 <li>have a look at <a href="examples/index.html">the set of
439 examples</a>.</li>
440 <li>look for examples of use for libxml2 function using the Gnome code.
441 For example the following will query the full Gnome CVS base for the
442 use of the <strong>xmlAddChild()</strong> function:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]443 <p><a
444 href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]445 <p>This may be slow, a large hardware donation to the gnome project
446 could cure this :-)</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]447 </li>
448 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]449 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Browse
450 the libxml2 source</a> , I try to write code as clean and documented
451 as possible, so looking at it may be helpful. In particular the code
452 of xmllint.c and of the various testXXX.c test programs should
453 provide good examples of how to do things with the library.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]454 </ul>
455 </li>
456 <li>What about C++ ?
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]457 <p>libxml2 is written in pure C in order to allow easy reuse on a number
458 of platforms, including embedded systems. I don't intend to convert to
459 C++.</p>
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]460 <p>There is however a C++ wrapper which may fulfill your needs:</p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]461 <ul>
462 <li>by Ari Johnson &lt;ari@btigate.com&gt;:
463 <p>Website: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]464 href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]465 <p>Download: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]466 href="http://sourceforge.net/project/showfiles.php?group_id=12999">http://sourceforge.net/project/showfiles.php?group_id=12999</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]467 </li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]468 <!-- Website is currently unavailable as of 2003-08-02
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]469 <li>by Peter Jones &lt;pjones@pmade.org&gt;
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]470 <p>Website: <a
471 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]472 </li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]473 -->
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]474 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]475 </li>
476 <li>How to validate a document a posteriori ?
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]477 <p>It is possible to validate documents which had not been validated at
478 initial parsing time or documents which have been built from scratch
479 using the API. Use the <a
480 href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>
481 function. It is also possible to simply add a DTD to an existing
482 document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]483 <pre>xmlDocPtr doc; /* your existing document */
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]484xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
485
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]486 dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
487
488 doc-&gt;intSubset = dtd;
489 if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
490 else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
491 </pre>
492 </li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]493 <li>So what is this funky "xmlChar" used all the time?
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]494 <p>It is a null terminated sequence of utf-8 characters. And only utf-8!
495 You need to convert strings encoded in different ways to utf-8 before
496 passing them to the API. This can be accomplished with the iconv library
497 for instance.</p>
John Fleck61f6fb62002-10-31 15:23:29 +0000[diff] [blame]498 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]499 <li>etc ...</li>
500</ol>
501
502<p></p>
503
Daniel Veillard66f68e72003-08-18 16:39:51 +0000[diff] [blame]504<h2><a name="Documentat">Developer Menu</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]505
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]506<p>There are several on-line resources related to using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]507<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]508 <li>Use the <a href="search.php">search engine</a> to look up
509 information.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]510 <li>Check the <a href="FAQ.html">FAQ.</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]511 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
512 documentation</a> automatically extracted from code comments.</li>
513 <li>Look at the documentation about <a href="encoding.html">libxml
514 internationalization support</a>.</li>
515 <li>This page provides a global overview and <a href="example.html">some
516 examples</a> on how to use libxml.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]517 <li><a href="examples/index.html">Code examples</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]518 <li>John Fleck's libxml2 tutorial: <a href="tutorial/index.html">html</a>
519 or <a href="tutorial/xmltutorial.pdf">pdf</a>.</li>
Daniel Veillard1177ca42003-04-26 22:29:54 +0000[diff] [blame]520 <li>If you need to parse large files, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]521 href="xmlreader.html">xmlReader</a> API tutorial</li>
522 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
523 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
524 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]525 <li>George Lebl wrote <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]526 href="http://www-106.ibm.com/developerworks/library/l-gnome3/">an article
527 for IBM developerWorks</a> about using libxml.</li>
528 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
529 file</a>.</li>
530 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>
531 description. If you are starting a new project using libxml you should
532 really use the 2.x version.</li>
Daniel Veillard845cce42002-01-09 11:51:37 +0000[diff] [blame]533 <li>And don't forget to look at the <a
534 href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]535</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]536
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]537<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]538
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]539<p>Well, bugs or missing features are always possible, and I will make a
540point of fixing them in a timely fashion. The best way to report a bug is to
541use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome
542bug tracking database</a> (make sure to use the "libxml2" module name). I
543look at reports there regularly and it's good to have a reminder when a bug
544is still open. Be sure to specify that the bug is for the package libxml2.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]545
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]546<p>For small problems you can try to get help on IRC, the #xml channel on
547irc.gnome.org (port 6667) usually have a few person subscribed which may help
548(but there is no garantee and if a real issue is raised it should go on the
549mailing-list for archival).</p>
Daniel Veillard9582d6c2003-09-16 11:40:04 +0000[diff] [blame]550
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]551<p>There is also a mailing-list <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]552href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
553href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
554href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
555please visit the <a
556href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
557follow the instructions. <strong>Do not send code, I won't debug it</strong>
558(but patches are really appreciated!).</p>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]559
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]560<p>Please note that with the current amount of virus and SPAM, sending mail
561to the list without being subscribed won't work. There is *far too many
562bounces* (in the order of a thousand a day !) I cannot approve them manually
563anymore. If your mail to the list bounced waiting for administrator approval,
564it is LOST ! Repost it and fix the problem triggering the error. Also please
565note that <span style="color: #FF0000; background-color: #FFFFFF">emails with
566a legal warning asking to not copy or redistribute freely the informations
567they contain</span> are <strong>NOT</strong> acceptable for the mailing-list,
568such mail will as much as possible be discarded automatically, and are less
569likely to be answered if they made it to the list, <strong>DO NOT</strong>
570post to the list from an email address where such legal requirements are
571automatically added, get private paying support if you can't share
572informations.</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]573
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]574<p>Check the following <strong><span style="color: #FF0000">before
575posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]576<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]577 <li>Read the <a href="FAQ.html">FAQ</a> and <a href="search.php">use the
578 search engine</a> to get information related to your problem.</li>
579 <li>Make sure you are <a href="ftp://xmlsoft.org/libxml2/">using a recent
580 version</a>, and that the problem still shows up in a recent version.</li>
581 <li>Check the <a href="http://mail.gnome.org/archives/xml/">list
582 archives</a> to see if the problem was reported already. In this case
583 there is probably a fix available, similarly check the <a
584 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registered
585 open bugs</a>.</li>
586 <li>Make sure you can reproduce the bug with xmllint or one of the test
587 programs found in source in the distribution.</li>
588 <li>Please send the command showing the error as well as the input (as an
589 attachment)</li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]590</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]591
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]592<p>Then send the bug with associated information to reproduce it to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]593href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
594related I will approve it. Please do not send mail to me directly, it makes
595things really hard to track and in some cases I am not the best person to
596answer a given question, ask on the list.</p>
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]597
598<p>To <span style="color: #E50000">be really clear about support</span>:</p>
599<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]600 <li>Support or help <span style="color: #E50000">requests MUST be sent to
601 the list or on bugzilla</span> in case of problems, so that the Question
602 and Answers can be shared publicly. Failing to do so carries the implicit
603 message "I want free support but I don't want to share the benefits with
604 others" and is not welcome. I will automatically Carbon-Copy the
605 xml@gnome.org mailing list for any technical reply made about libxml2 or
606 libxslt.</li>
607 <li>There is <span style="color: #E50000">no garantee of support</span>, if
608 your question remains unanswered after a week, repost it, making sure you
609 gave all the detail needed and the information requested.</li>
610 <li>Failing to provide information as requested or double checking first
611 for prior feedback also carries the implicit message "the time of the
612 library maintainers is less valuable than my time" and might not be
613 welcome.</li>
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]614</ul>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]615
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]616<p>Of course, bugs reported with a suggested patch for fixing them will
617probably be processed faster than those without.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]618
619<p>If you're looking for help, a quick look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]620href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
621provide the answer. I usually send source samples when answering libxml2
622usage questions. The <a
623href="http://xmlsoft.org/html/book1.html">auto-generated documentation</a> is
624not as polished as I would like (i need to learn more about DocBook), but
625it's a good starting point.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]626
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]627<h2><a name="help">How to help</a></h2>
628
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]629<p>You can help the project in various ways, the best thing to do first is to
630subscribe to the mailing-list as explained before, check the <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]631href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]632href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug
633database</a>:</p>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]634<ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]635 <li>Provide patches when you find problems.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]636 <li>Provide the diffs when you port libxml2 to a new platform. They may not
637 be integrated in all cases but help pinpointing portability problems
638 and</li>
639 <li>Provide documentation fixes (either as patches to the code comments or
640 as HTML diffs).</li>
641 <li>Provide new documentations pieces (translations, examples, etc
642 ...).</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]643 <li>Check the TODO file and try to close one of the items.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]644 <li>Take one of the points raised in the archive or the bug database and
645 provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
646 </a>before to avoid synchronization problems and check that the suggested
647 fix will fit in nicely :-)</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]648</ol>
649
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]650<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]651
Daniel Veillard688f6692004-03-26 10:57:38 +0000[diff] [blame]652<p>The latest versions of libxml2 can be found on the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]653href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> server ( <a
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]654href="http://xmlsoft.org/sources/">HTTP</a>, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]655href="ftp://xmlsoft.org/libxml2/">FTP</a> and rsync are available), there is also
656mirrors (<a href="ftp://ftp.planetmirror.com/pub/xmlsoft/">Australia</a>( <a
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]657href="http://xmlsoft.planetmirror.com/">Web</a>), <a
Daniel Veillard20c8cf22001-06-26 22:47:36 +0000[diff] [blame]658href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]659href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> as <a
660href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">source archive</a>
661, Antonin Sprinzl also provide <a href="ftp://gd.tuwien.ac.at/pub/libxml/">a
662mirror in Austria</a>. (NOTE that you need both the <a
663href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
664href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
665packages installed to compile applications using libxml.)</p>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]666
667<p>You can find all the history of libxml(2) and libxslt releases in the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]668href="http://xmlsoft.org/sources/old/">old</a> directory. The precompiled
669Windows binaries made by Igor Zlatovic are available in the <a
670href="http://xmlsoft.org/sources/win32/">win32</a> directory.</p>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]671
672<p>Binary ports:</p>
673<ul>
674 <li>Red Hat RPMs for i386 are available directly on <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]675 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM will compile on
676 any architecture supported by Red Hat.</li>
677 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
678 maintainer of the Windows port, <a
679 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
680 binaries</a>.</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]681 <li>Blastwave provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]682 href="http://www.blastwave.org/packages.php/libxml2">Solaris
683 binaries</a>.</li>
684 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> provides <a
685 href="http://www.explain.com.au/oss/libxml2xslt.html">Mac Os X
686 binaries</a>.</li>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]687 <li>The HP-UX porting center provides <a
688 href="http://hpux.connect.org.uk/hppd/hpux/Gnome/">HP-UX binaries</a></li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]689 <li>Bull provides precompiled <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]690 href="http://gnome.bullfreeware.com/new_index.html">RPMs for AIX</a> as
691 patr of their GNOME packages</li>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]692</ul>
693
694<p>If you know other supported binary ports, please <a
695href="http://veillard.com/">contact me</a>.</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]696
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]697<p><a name="Snapshot">Snapshot:</a></p>
698<ul>
Daniel Veillard3cef1192004-08-18 09:30:31 +0000[diff] [blame]699 <li>Code from the W3C cvs base libxml2 module, updated hourly <a
Daniel Veillard9110ed62006-04-03 15:21:57 +0000[diff] [blame]700 href="ftp://xmlsoft.org/libxml2/libxml2-cvs-snapshot.tar.gz">libxml2-cvs-snapshot.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]701 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard9110ed62006-04-03 15:21:57 +0000[diff] [blame]702 href="ftp://xmlsoft.org/libxml2/libxml-docs.tar.gz">libxml-docs.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]703</ul>
704
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]705<p><a name="Contribs">Contributions:</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]706
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]707<p>I do accept external contributions, especially if compiling on another
708platform, get in touch with the list to upload the package, wrappers for
709various languages have been provided, and can be found in the <a
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]710href="python.html">bindings section</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]711
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]712<p>Libxml2 is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]713<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]714 <li><p>The <a href="http://cvs.gnome.org/viewcvs/libxml2/">Gnome CVS
715 base</a>. Check the <a
716 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a>
717 page; the CVS module is <b>libxml2</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]718 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]719 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]720</ul>
721
Daniel Veillard78fed532004-10-09 19:44:48 +0000[diff] [blame]722<h2><a name="News">Releases</a></h2>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]723
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]724<p>Items not finished and worked on, get in touch with the list if you want
725to help those</p>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]726<ul>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]727 <li>More testing on RelaxNG</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]728 <li>Finishing up <a href="http://www.w3.org/TR/xmlschema-1/">XML
729 Schemas</a></li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]730</ul>
731
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]732<p>The <a href="ChangeLog.html">change log</a> describes the recents commits
733to the <a href="http://cvs.gnome.org/viewcvs/libxml2/">CVS</a> code base.</p>
Daniel Veillard2d908032004-08-10 10:16:36 +0000[diff] [blame]734
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]735<p>There is the list of public releases:</p>
736
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]737<h3>2.6.26: Jun 6 2006</h3>
Daniel Veillard69839ba2006-06-06 13:27:03 +0000[diff] [blame]738<ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]739 <li>portability fixes: Python detection (Joseph Sacco), compilation
740 error(William Brack and Graham Bennett), LynxOS patch (Olli Savia)</li>
741 <li>bug fixes: encoding buffer problem, mix of code and data in
742 xmlIO.c(Kjartan Maraas), entities in XSD validation (Kasimier Buchcik),
743 variousXSD validation fixes (Kasimier), memory leak in pattern (Rob
744 Richards andKasimier), attribute with colon in name (Rob Richards), XPath
745 leak inerror reporting (Aleksey Sanin), XInclude text include of
746 selfdocument.</li>
747 <li>improvements: Xpath optimizations (Kasimier), XPath object
748 cache(Kasimier)</li>
Daniel Veillard69839ba2006-06-06 13:27:03 +0000[diff] [blame]749</ul>
750
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]751<h3>2.6.25: Jun 6 2006:</h3>
752
753<p>Do not use or package 2.6.25</p>
754
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +0000[diff] [blame]755<h3>2.6.24: Apr 28 2006</h3>
756<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]757 <li>Portability fixes: configure on Windows, testapi compile on windows
758 (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher),
759 HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1
760 cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on
761 Windows (Roland Schwingel).
762 </li>
763 <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier
764 Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li>
765 <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext()
766 on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming
767 bug, xmlParseComment (with William Brack), regexp bug fixes (DV &amp;
768 Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier),
769 one Relax-NG interleave bug, xmllint --path and --valid,
770 XSD bugfixes (Kasimier), remove debug
771 left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole),
772 xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large
773 number of cleanups and small fixes based on Coverity reports, bug
774 in character ranges, Unicode tables const (Aivars Kalvans), schemas
775 fix (Stefan Kost), xmlRelaxNGParse error deallocation,
776 xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed
777 code point, ixmllint --nonet to never reach the net (Gary Coady),
778 line break in writer after end PI (Jason Viers). </li>
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +0000[diff] [blame]779 <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li>
780 <li>New features: Relax NG structure error handlers.</li>
781</ul>
782
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]783<h3>2.6.23: Jan 5 2006</h3>
784<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]785 <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows
786 (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas),
787 --with-minimum compilation fixes (William Brack), error case handling fix
788 on Solaris (Albert Chin), don't use 'list' as parameter name reported by
789 Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin),
790 MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick
791 Jones),</li>
792 <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose
793 (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring
794 parsing code (Bjorn Reese)</li>
795 <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack),
796 combinatory explosion and performances in regexp code, leak in
797 xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo
798 Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik),
799 XPath pattern based evaluation bugs (DV &amp; Kasimier),
800 xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in
801 xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of
802 vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF
803 split problem (William), issues with non-namespaced attributes in
804 xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards),
805 HTML parsing of script, Python must not output to stdout (Nic Ferrier),
806 exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype
807 totalDigits bug (Kasimier Buchcik), error handling when writing to an
808 xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi
809 Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix
810 XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier),
811 fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml
812 (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of
813 runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs
814 (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair),
815 compilation and build fixes (Michael Day), removed dependancies on
816 xmlSchemaValidError (Kasimier), bug with &lt;xml:foo/&gt;, more XPath
817 pattern based evaluation fixes (Kasimier)</li>
818 <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier
819 Buchcik), node copy checks and fix for attribute (Rob Richards), counted
820 transition bug in regexps, ctxt-&gt;standalone = -2 to indicate no
821 standalone attribute was found, add xmlSchemaSetParserStructuredErrors()
822 (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API
823 (Kasimier), handle gzipped HTTP resources (Gary Coady), add
824 htmlDocDumpMemoryFormat. (Rob Richards),</li>
825 <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save
826 function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]827</ul>
828
Daniel Veillard33b20b72005-09-12 21:43:20 +0000[diff] [blame]829<h3>2.6.22: Sep 12 2005</h3>
830<ul>
831 <li>build fixes: compile without schematron (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]832 <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i,
833 CDATA push parser bug, xmlElemDump problem with XHTML1 doc,
834 XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some
835 output formatting for meta element (Rob Richards), script and style
836 XHTML1 serialization (David Madore), Attribute derivation fixups in XSD
837 (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li>
838 <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add
839 XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for
840 derive (Kasimier Buchcik).</li>
841 <li>documentation: generation of gtk-doc like docs, integration with
842 devhelp.</li>
Daniel Veillard33b20b72005-09-12 21:43:20 +0000[diff] [blame]843</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]844
Daniel Veillardb3d14912005-09-04 20:47:39 +0000[diff] [blame]845<h3>2.6.21: Sep 4 2005</h3>
846<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]847 <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling
848 convention problems on Windows (Marcus Boerger), cleanups based on Linus'
849 sparse tool, update of win32/configure.js (Rob Richards), remove warnings
850 on Windows(Marcus Boerger), compilation without SAX1, detection of the
851 Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko),
852 compilation/link with threads and old gcc, compile problem by C370 on
853 Z/OS,</li>
854 <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8
855 bug (Jiri Netolicky), XPath NaN compare bug (William Brack),
856 htmlParseScript potential bug, Schemas regexp handling of spaces, Base64
857 Schemas comparisons NIST passes, automata build error xsd:all,
858 xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas
859 foreign namespaces handling, XML Schemas facet comparison (Kupriyanov
860 Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml:
861 namespace ahndling in Schemas (Kasimier), empty model group in Schemas
862 (Kasimier), wilcard in Schemas (Kasimier), URI composition (William),
863 xs:anyType in Schemas (Kasimier), Python resolver emmitting error
864 messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to
865 fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob
866 Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8
867 serialization, streaming XPath, Schemas determinism detection problem,
868 XInclude bug, Schemas context type (Dean Hill), validation fix (Derek
869 Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas
870 type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling,
871 xmlGetLineNo fixes, bug on entities handling, entity name extraction in
872 error handling with XInclude, text nodes in HTML body tags (Gary Coady),
873 xml:id and IDness at the treee level fixes, XPath streaming patterns
874 bugs.</li>
875 <li>improvements: structured interfaces for schemas and RNG error reports
876 (Marcus Boerger), optimization of the char data inner loop parsing
877 (thanks to Behdad Esfahbod for the idea), schematron validation though
878 not finished yet, xmlSaveOption to omit XML declaration, keyref match
879 error reports (Kasimier), formal expression handling code not plugged
880 yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option
881 for text nodes allocation.</li>
Daniel Veillardb3d14912005-09-04 20:47:39 +0000[diff] [blame]882 <li>documentation: xmllint man page had --nonet duplicated</li>
883</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]884
Daniel Veillard78dfc9f2005-07-10 22:30:30 +0000[diff] [blame]885<h3>2.6.20: Jul 10 2005</h3>
886<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]887 <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor
888 Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and
889 andriy@google.com), use gcc weak references to pthread to avoid the
890 pthread dependancy on Linux, compilation problem (Steve Nairn), compiling
891 of subset (Morten Welinder), IPv6/ss_family compilation (William Brack),
892 compilation when disabling parts of the library, standalone test
893 distribution.</li>
894 <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack),
895 HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer
896 overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup
897 (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch
898 (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup
899 on XInclude (William), pattern fixes (William), attribute bug in
900 exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob
901 Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type
902 QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug
903 (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob
904 Richards), a small RelaxNG leak, HTML parsing in push mode bug (James
905 Bursa), failure to detect UTF-8 parsing bugs in CDATA sections,
906 areBlanks() heuristic failure, duplicate attributes in DTD bug
907 (William).</li>
908 <li>improvements: lot of work on Schemas by Kasimier Buchcik both on
909 conformance and streaming, Schemas validation messages (Kasimier Buchcik,
910 Matthew Burgess), namespace removal at the python level (Brent
911 Hendricks), Update to new Schemas regression tests from W3C/Nist
912 (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of
913 xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert),
914 standalone test framework and programs, new DOM import APIs
915 xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and
916 xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and
917 Schemas regression tests, xmlStopParser() available in pull mode too,
918 ienhancement to xmllint --shell namespaces support, Windows port of the
919 standalone testing tools (Kasimier and William),
920 xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX
921 Schemas APIs, Schemas xmlReader support.</li>
Daniel Veillard78dfc9f2005-07-10 22:30:30 +0000[diff] [blame]922</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]923
Daniel Veillard771971f2005-04-02 10:49:51 +0000[diff] [blame]924<h3>2.6.19: Apr 02 2005</h3>
925<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]926 <li>build fixes: drop .la from RPMs, --with-minimum build fix (William
927 Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX
928 5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on
929 Linux/ELF/gcc4</li>
930 <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return
931 code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY
932 Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin),
933 segfault in Schemas (Kasimier Buchcik), Schemas attribute validation
934 (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards),
935 HTML serialization of name attribute on a elements, Python error handlers
936 leaks and improvement (Brent Hendricks), uninitialized variable in
937 encoding code, Relax-NG validation bug, potential crash if
938 gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures,
939 switched back to assuming UTF-8 in case no encoding is given at
940 serialization time</li>
941 <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets
942 checking and also mixed handling.</li>
Daniel Veillard771971f2005-04-02 10:49:51 +0000[diff] [blame]943 <li></li>
944</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]945
Daniel Veillard57c000e2005-03-13 18:34:29 +0000[diff] [blame]946<h3>2.6.18: Mar 13 2005</h3>
947<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]948 <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation,
949 Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed),
950 some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li>
951 <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and
952 xmlreader stopping on non-fatal errors, thread support for dictionnaries
953 reference counting (Gary Coady), internal subset and push problem, URL
954 saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths
955 fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix
956 (Mike Hommey), warning should not count as error (William Brack),
957 xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup
958 FTP and HTTP code to reuse the uri parsing and IPv6 (William),
959 xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being
960 empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows
961 (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent
962 Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug
963 (Rob Richards), Schemas decimal type fixes (William Brack),
964 xmlByteConsumed static buffer (Ben Maurer).</li>
965 <li>improvement: speedup parsing comments and DTDs, dictionnary support for
966 hash tables, Schemas Identity constraints (Kasimier), streaming XPath
967 subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical
968 values handling (Kasimier), add xmlTextReaderByteConsumed (Aron
969 Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]970 <li>Documentation: Wiki support (Joel Reed)</li>
Daniel Veillard57c000e2005-03-13 18:34:29 +0000[diff] [blame]971</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]972
Daniel Veillard298d9642005-01-16 20:01:55 +0000[diff] [blame]973<h3>2.6.17: Jan 16 2005</h3>
974<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]975 <li>build fixes: Windows, warnings removal (William Brack),
976 maintainer-clean dependency(William), build in a different directory
977 (William), fixing --with-minimum configure build (William), BeOS build
978 (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan
979 McNichol)</li>
980 <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
981 to use the catalog(s), loop on output (William Brack), XPath memory leak,
982 ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
983 warning not using error callback (William), xmlStopParser bug (William),
984 UTF-16 with BOM on DTDs (William), namespace bug on empty elements in
985 push mode (Rob Richards), line and col computations fixups (Aleksey
986 Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
987 patterns with too many steps, bug in RNG choice optimization, line number
988 sometimes missing.</li>
989 <li>improvements: XSD Schemas (Kasimier Buchcik), python generator
990 (William), xmlUTF8Strpos speedup (William), unicode Python strings
991 (William), XSD error reports (Kasimier Buchcik), Python __str__ call
992 serialize().</li>
993 <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for
994 the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel
995 Reed), error extraction API from regexps, new XMLSave option for format
996 (Phil Shafer)</li>
997 <li>documentation: site improvement (John Fleck), FAQ entries
998 (William).</li>
Daniel Veillard298d9642005-01-16 20:01:55 +0000[diff] [blame]999</ul>
1000
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1001<h3>2.6.16: Nov 10 2004</h3>
1002<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1003 <li>general hardening and bug fixing crossing all the API based on new
1004 automated regression testing</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1005 <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1006 <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding
1007 conversion functions return values, UTF-8 bug affecting XPath reported by
1008 Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
1009 <li>documentation: fix to xmllint man page, some API function descritpion
1010 were updated.</li>
1011 <li>improvements: DTD validation APIs provided at the Python level (Brent
1012 Hendricks)</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1013</ul>
1014
Daniel Veillardc2f83d12004-10-27 22:59:21 +0000[diff] [blame]1015<h3>2.6.15: Oct 27 2004</h3>
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]1016<ul>
1017 <li>security fixes on the nanoftp and nanohttp modules</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1018 <li>build fixes: xmllint detection bug in configure, building outside the
1019 source tree (Thomas Fitzsimmons)</li>
1020 <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
1021 paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
1022 saving to python file objects (Malcolm Tredinnick), DTD lookup fix
1023 (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
1024 fixes (DV and Rob Richards), Schemas memory bug, structured error handler
1025 on Python 64bits, thread local memory deallocation, memory leak reported
1026 by Volker Roth, xmlValidateDtd in the presence of an internal subset,
1027 entities and _private problem (William), xmlBuildRelativeURI error
1028 (William).</li>
1029 <li>improvements: better XInclude error reports (William), tree debugging
1030 module and tests, convenience functions at the Reader API (Graham
1031 Bennett), add support for PI in the HTML parser.</li>
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]1032</ul>
1033
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]1034<h3>2.6.14: Sep 29 2004</h3>
1035<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1036 <li>build fixes: configure paths for xmllint and xsltproc, compilation
1037 without HTML parser, compilation warning cleanups (William Brack &amp;
1038 Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
1039 <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
1040 Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
1041 transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
1042 (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
1043 handling of failed realloc(), out of bound array adressing in Schemas
1044 date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
1045 E20 validation fix (Malcolm),</li>
1046 <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
1047 xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
1048 (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
1049 Tredinnick), Schemas support for xsi:schemaLocation,
1050 xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]1051</ul>
1052
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]1053<h3>2.6.13: Aug 31 2004</h3>
1054<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1055 <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
1056 Solaris compiler warning, fixing RPM BuildRequires,</li>
1057 <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
1058 (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
1059 and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
1060 problem (William), Schemas hexbinary empty values, encoding error could
1061 genrate a serialization loop.</li>
1062 <li>Improvements: Schemas validity improvements (Kasimier), added --path
1063 and --load-trace options to xmllint</li>
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]1064 <li>documentation: tutorial update (John Fleck)</li>
1065</ul>
1066
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1067<h3>2.6.12: Aug 22 2004</h3>
1068<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1069 <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
1070 Breitenlohner), perl path lookup (William), diff on Solaris (Albert
1071 Chin), some 64bits cleanups.</li>
1072 <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
1073 (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
1074 Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
1075 (Torkel Lyng)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1076 <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1077 <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
1078 debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
1079 xmlReader state after attribute reading (William), structured error
1080 handler (William), XInclude generated xml:base fixup (William), Windows
1081 memory reallocation problem (Steve Hay), Out of Memory conditions
1082 handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
1083 htmlReadMemory init (William), a posteriori validation DTD base
1084 (William), notations serialization missing, xmlGetNodePath (Dodji),
1085 xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
1086 (William)</li>
1087 <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
1088 (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
1089 xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
1090 to not generate start/end nodes, extend xmllint --version to include CVS
1091 tag (William)</li>
1092 <li>documentation: web pages fixes, validity API docs fixes (William)
1093 schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1094</ul>
1095
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]1096<h3>2.6.11: July 5 2004</h3>
1097<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1098 <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
1099 attributes, namespaces and simple types.</li>
1100 <li>build fixes: --with-minimum (William Brack), some gcc cleanup
1101 (William), --with-thread-alloc (William)</li>
1102 <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
1103 path on Windows</li>
1104 <li>documentation: update to the tutorial (John Fleck), xmllint return code
1105 (John Fleck), man pages (Ville Skytta),</li>
1106 <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
1107 properly initialize the library (William), empty node set in XPath
1108 (William), xmlSchemas errors (William), invalid charref problem pointed
1109 by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
1110 with div processing (William), XPointer and xml:base problem(William),
1111 Reader and entities, xmllint return code for schemas (William), reader
1112 streaming problem (Steve Ball), DTD serialization problem (William),
1113 libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
1114 Python classes, xmlReader buffer bug, Python bindings memory interfaces
1115 improvement (with Stéphane Bidoul), Fixed the push parser to be back to
1116 synchronous behaviour.</li>
1117 <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
1118 namespace in debug shell (Stefano Debenedetti), Python based regression
1119 test for non-Unix users (William), dynamically increase the number of
1120 XPath extension functions in Python and fix a memory leak (Marc-Antoine
1121 Parent and William)</li>
1122 <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
1123 and generated code on Linux, plus use gcc runtime profiling to optimize
1124 the code generated in the RPM packages.</li>
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]1125</ul>
1126
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]1127<h3>2.6.10: May 17 2004</h3>
1128<ul>
1129 <li>Web page generated for ChangeLog</li>
1130 <li>build fixes: --without-html problems, make check without make all</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1131 <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
1132 vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
1133 use "list" as parameter name, make tests work with Python 1.5 (Ed
1134 Davis),</li>
1135 <li>improvements: made xmlTextReaderMode public, small buffers resizing
1136 (Morten Welinder), add --maxmem option to xmllint, add
1137 xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
1138 escaping, added escaping customization</li>
1139 <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
1140 Brack), xmlReader end of stream problem, node deregistration with reader,
1141 URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp
1142 transition reduction (William), various XSD Schemas fixes (Kasimier
1143 Buchcik), XInclude fallback problem (William), weird problems with DTD
1144 (William), structured error handler callback context (William), reverse
1145 xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]1146</ul>
1147
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]1148<h3>2.6.9: Apr 18 2004</h3>
1149<ul>
1150 <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1151 <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
1152 Beckett), Relax-NG compilation (William Brack), Regexp patches (with
1153 William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
1154 William), Relax-NG name classes compares (William), XInclude duplicate
1155 fallback (William), external DTD encoding detection (William), a DTD
1156 validation bug (William), xmlReader Close() fix, recusive extention
1157 schemas</li>
1158 <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
1159 save optimization, better handle IIS broken HTTP redirect behaviour (Ian
1160 Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
1161 dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
1162 clanup (William), keep ChangeLog compressed when installing from RPMs</li>
1163 <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
1164 example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
1165 <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
1166 compiler NaN handling bug (Mark Vakoc)</li>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]1167</ul>
1168
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]1169<h3>2.6.8: Mar 23 2004</h3>
1170<ul>
1171 <li>First step of the cleanup of the serialization code and APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1172 <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
1173 Dickmeiss), anyURI for "" (John Belmonte)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]1174 <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
1175 <li>xmlDocCopyNode() extension (William)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1176 <li>Relax-NG: fix when processing XInclude results (William), external
1177 reference in interleave (William), missing error on &lt;choice&gt;
1178 failure (William), memory leak in schemas datatype facets.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]1179 <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1180 <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
1181 Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
1182 URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
1183 XInclude and XPointer fixes for entities (William), XML parser bug
1184 reported by Holger Rauch, nanohttp fd leak (William), regexps char
1185 groups '-' handling (William), dictionnary reference counting problems,
1186 do not close stderr.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]1187 <li>performance patches from Petr Pajas</li>
1188 <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1189 <li>compilation and portability fixes: --without-valid, catalog cleanups
1190 (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
1191 to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino
1192 Vidal), Windows build (Eric Zurcher)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]1193</ul>
1194
Daniel Veillard92914492004-02-23 16:33:21 +0000[diff] [blame]1195<h3>2.6.7: Feb 23 2004</h3>
1196<ul>
1197 <li>documentation: tutorial updates (John Fleck), benchmark results</li>
1198 <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
1199 <li>XPath optimization (Petr Pajas)</li>
1200 <li>DTD ID handling optimization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1201 <li>bugfixes: xpath number with &gt; 19 fractional (William Brack), push
1202 mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
1203 xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
1204 handling NULL, trying to fix Relax-NG/Perl interface.</li>
Daniel Veillard92914492004-02-23 16:33:21 +0000[diff] [blame]1205 <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
1206 <li>Added relaxng option to xmllint --shell</li>
1207</ul>
1208
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]1209<h3>2.6.6: Feb 12 2004</h3>
1210<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1211 <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
1212 William) reported by Yuuichi Teranishi</li>
1213 <li>bugfixes: make test and path issues, xmlWriter attribute serialization
1214 (William Brack), xmlWriter indentation (William), schemas validation
1215 (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
1216 Paraschenko), XInclude empty fallback (William), HTML warnings (William),
1217 XPointer in XInclude (William), Python namespace serialization,
1218 isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
1219 entities in internal subset (William), internal subset bug in push mode,
1220 &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
1221 <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
1222 (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
1223 --with-minimum configuration.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]1224 <li>XInclude: allow the 2001 namespace without warning.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1225 <li>Documentation: missing example/index.html (John Fleck), version
1226 dependancies (John Fleck)</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]1227 <li>reader API: structured error reporting (Steve Ball)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1228 <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
1229 prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
1230 patch</li>
1231 <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
1232 input.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]1233</ul>
1234
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]1235<h3>2.6.5: Jan 25 2004</h3>
1236<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1237 <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
1238 (William), xs:all problem (William), a number of XPointer bugfixes
1239 (William), xmllint error go to stderr, DTD validation problem with
1240 namespace, memory leak (William), SAX1 cleanup and minimal options fixes
1241 (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
1242 evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
1243 XML Schemas double free (Steve Ball), XInclude with no href, argument
1244 callbacks order for XPath callbacks (Frederic Peters)</li>
1245 <li>Documentation: python scripts (William Brack), xslt stylesheets (John
1246 Fleck), doc (Sven Zimmerman), I/O example.</li>
1247 <li>Python bindings: fixes (William), enum support (Stéphane Bidoul),
1248 structured error reporting (Stéphane Bidoul)</li>
1249 <li>XInclude: various fixes for conformance, problem related to dictionnary
1250 references (William &amp; me), recursion (William)</li>
1251 <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
1252 Mickautsch),</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]1253 <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
1254 <li>code cleanup for strings functions (William)</li>
1255 <li>Windows: compiler patches (Mark Vakoc)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1256 <li>Parser optimizations, a few new XPath and dictionnary APIs for future
1257 XSLT optimizations.</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]1258</ul>
1259
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1260<h3>2.6.4: Dec 24 2003</h3>
1261<ul>
1262 <li>Windows build fixes (Igor Zlatkovic)</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]1263 <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
1264 <li>Unix and Makefile packaging fixes (me, William Brack,</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1265 <li>Documentation improvements (John Fleck, William Brack), example fix
1266 (Lucas Brasilino)</li>
1267 <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
1268 NULL strings (William Brack) , API building reader or parser from
1269 filedescriptor should not close it, changed XPath sorting to be stable
1270 again (William Brack), xmlGetNodePath() generating '(null)' (William
1271 Brack), DTD validation and namespace bug (William Brack), XML Schemas
1272 double inclusion behaviour</li>
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1273</ul>
1274
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1275<h3>2.6.3: Dec 10 2003</h3>
1276<ul>
1277 <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1278 <li>added a repository of examples, examples from Aleksey Sanin, Dodji
1279 Seketeli, Alfred Mickautsch</li>
1280 <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
1281 (Kenneth Haley)</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1282 <li>Unicode range checking (William Brack)</li>
1283 <li>code cleanup (William Brack)</li>
1284 <li>Python bindings: doc (John Fleck), bug fixes</li>
1285 <li>UTF-16 cleanup and BOM issues (William Brack)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1286 <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
1287 xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
1288 (James Bursa), attribute defaulting and validation, some serialization
1289 cleanups, XML_GET_LINE macro, memory debug when using threads (William
1290 Brack), serialization of attributes and entities content, xmlWriter
1291 (Daniel Schulman)</li>
1292 <li>XInclude bugfix, new APIs and update to the last version including the
1293 namespace change.</li>
1294 <li>XML Schemas improvements: include (Robert Stepanek), import and
1295 namespace handling, fixed the regression tests troubles, added examples
1296 based on Eric van der Vlist book, regexp fixes</li>
1297 <li>preliminary pattern support for streaming (needed for schemas
1298 constraints), added xmlTextReaderPreservePattern() to collect subdocument
1299 when streaming.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1300 <li>various fixes in the structured error handling</li>
1301</ul>
1302
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1303<h3>2.6.2: Nov 4 2003</h3>
1304<ul>
1305 <li>XPath context unregistration fixes</li>
1306 <li>text node coalescing fixes (Mark Lilback)</li>
1307 <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
1308 <li>BeOS patches (Marcin 'Shard' Konicki)</li>
1309 <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
1310 <li>compilation fixes (Mark Vakoc)</li>
1311 <li>stdin parsing fix (William Brack)</li>
1312 <li>a posteriori DTD validation fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1313 <li>xmlReader bug fixes: Walker fixes, python bindings</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1314 <li>fixed xmlStopParser() to really stop the parser and errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1315 <li>always generate line numbers when using the new xmlReadxxx
1316 functions</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1317 <li>added XInclude support to the xmlReader interface</li>
1318 <li>implemented XML_PARSE_NONET parser option</li>
1319 <li>DocBook XSLT processing bug fixed</li>
1320 <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
1321 <li>XPointer failure in XInclude are now handled as resource errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1322 <li>fixed xmllint --html to use the HTML serializer on output (added
1323 --xmlout to implement the previous behaviour of saving it using the XML
1324 serializer)</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1325</ul>
1326
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1327<h3>2.6.1: Oct 28 2003</h3>
1328<ul>
1329 <li>Mostly bugfixes after the big 2.6.0 changes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1330 <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
1331 (William Brack)</li>
1332 <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
1333 Zlatkovic)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1334 <li>xmlWriter bugfix (Alfred Mickautsch)</li>
1335 <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1336 <li>context reset: error state reset, push parser reset (Graham
1337 Bennett)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1338 <li>context reuse: generate errors if file is not readable</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1339 <li>defaulted attributes for element coming from internal entities
1340 (Stephane Bidoul)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1341 <li>Python: tab and spaces mix (William Brack)</li>
1342 <li>Error handler could crash in DTD validation in 2.6.0</li>
1343 <li>xmlReader: do not use the document or element _private field</li>
1344 <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1345 <li>general bug fixes: mandatory encoding in text decl, serializing
1346 Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
1347 XPath errors not reported, slow HTML parsing of large documents.</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1348</ul>
1349
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1350<h3>2.6.0: Oct 20 2003</h3>
1351<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1352 <li>Major revision release: should be API and ABI compatible but got a lot
1353 of change</li>
1354 <li>Increased the library modularity, far more options can be stripped out,
1355 a --with-minimum configuration will weight around 160KBytes</li>
1356 <li>Use per parser and per document dictionnary, allocate names and small
1357 text nodes from the dictionnary</li>
1358 <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
1359 provides namespace resolution and defaulted attributes, minimize memory
1360 allocations and copies, namespace checking and specific error handling,
1361 immutable buffers, make predefined entities static structures, etc...</li>
1362 <li>rewrote all the error handling in the library, all errors can be
1363 intercepted at a structured level, with precise information
1364 available.</li>
1365 <li>New simpler and more generic XML and HTML parser APIs, allowing to
1366 easilly modify the parsing options and reuse parser context for multiple
1367 consecutive documents.</li>
1368 <li>Similar new APIs for the xmlReader, for options and reuse, provided new
1369 functions to access content as const strings, use them for Python
1370 bindings</li>
1371 <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
1372 Walker i.e. reader on a document tree based on Alfred Mickautsch code,
1373 make room in nodes for line numbers, reference counting and future PSVI
1374 extensions, generation of character ranges to be checked with faster
1375 algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer
1376 access</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1377 <li>New xmlWriter API provided by Alfred Mickautsch</li>
1378 <li>Schemas: base64 support by Anthony Carrico</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1379 <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
1380 and charset informations if available.</li>
1381 <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
1382 zeroOrMore, better error reporting.</li>
1383 <li>Python bindings (Stéphane Bidoul), never use stdout for errors
1384 output</li>
1385 <li>Portability: all the headers have macros for export and calling
1386 convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
1387 Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor),
1388 Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul),
1389 warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
1390 'Shard' Konicki)</li>
1391 <li>Documentation fixes and README (William Brack), search fix (William),
1392 tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
1393 <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
1394 mutexes, HTML doctype lowercase, SAX/IO (William), compression detection
1395 and restore (William), attribute declaration in DTDs (William), namespace
1396 on attribute in HTML output (William), input filename (Rob Richards),
1397 namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
1398 (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
1399 Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
1400 mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
1401 (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
1402 error handling.</li>
1403 <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
1404 testing, --nodict for building without tree dictionnary, --nocdata to
1405 replace CDATA by text, --nsclean to remove surperfluous namespace
1406 declarations</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1407 <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1408 <li>a lot of profiling and tuning of the code, speedup patch for
1409 xmlSearchNs() by Luca Padovani. The xmlReader should do far less
1410 allocation and it speed should get closer to SAX. Chris Anderson worked
1411 on speeding and cleaning up repetitive checking code.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1412 <li>cleanup of "make tests"</li>
1413 <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1414 <li>deactivated the broken docBook SGML parser code and plugged the XML
1415 parser instead.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1416</ul>
1417
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]1418<h3>2.5.11: Sep 9 2003</h3>
1419
1420<p>A bugfix only release:</p>
1421<ul>
1422 <li>risk of crash in Relax-NG</li>
1423 <li>risk of crash when using multithreaded programs</li>
1424</ul>
1425
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1426<h3>2.5.10: Aug 15 2003</h3>
1427
1428<p>A bugfixes only release</p>
1429<ul>
1430 <li>Windows Makefiles (William Brack)</li>
1431 <li>UTF-16 support fixes (Mark Itzcovitz)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1432 <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
1433 on Windows (Mikhail Grushinskiy)</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1434 <li>HTML parser (Oliver Stoeneberg)</li>
1435 <li>XInclude performance problem reported by Kevin Ruscoe</li>
1436 <li>XML parser performance problem reported by Grant Goodale</li>
1437 <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]1438 <li>and a couple other cleanup</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1439</ul>
1440
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1441<h3>2.5.9: Aug 9 2003</h3>
1442<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1443 <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
1444 (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
1445 (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
1446 xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean
1447 Griffin), HTML parsing problem (William Brack), DTD validation for mixed
1448 content + namespaces, HTML serialization, library initialization,
1449 progressive HTML parser</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1450 <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
1451 <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
1452 <li>doc fixes and improvements (John Fleck)</li>
1453 <li>configure flag for -with-fexceptions when embedding in C++</li>
1454 <li>couple of new UTF-8 helper functions (William Brack)</li>
1455 <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
1456 <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1457 <li>general compilation/warning cleanup Solaris/HP-UX/... (William
1458 Brack)</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1459</ul>
1460
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1461<h3>2.5.8: Jul 6 2003</h3>
1462<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1463 <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
1464 Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
1465 PI related memleak, compilation without schemas or without xpath (Joerg
1466 Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
1467 rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
1468 xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1469 <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
1470 <li>William Brack fixed multithreading lock problems</li>
1471 <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1472 <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane
1473 Bidoul)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1474 <li>A few W3C Schemas Structure improvements</li>
1475 <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1476 <li>Python bindings for thread globals (Stéphane Bidoul), and method/class
1477 generator</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1478 <li>added --nonet option to xmllint</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1479 <li>documentation improvements (John Fleck)</li>
1480</ul>
1481
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]1482<h3>2.5.7: Apr 25 2003</h3>
1483<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1484 <li>Relax-NG: Compiling to regexp and streaming validation on top of the
1485 xmlReader interface, added to xmllint --stream</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]1486 <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
1487 <li>Support for large files: RGN validated a 4.5GB instance</li>
1488 <li>Thread support is now configured in by default</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1489 <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
1490 (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
1491 and zero bytes handling, some missing Windows file path conversions,
1492 behaviour of the parser and validator in the presence of "out of memory"
1493 error conditions</li>
1494 <li>extended the API to be able to plug a garbage collecting memory
1495 allocator, added xmlMallocAtomic() and modified the allocations
1496 accordingly.</li>
1497 <li>Performances: removed excessive malloc() calls, speedup of the push and
1498 xmlReader interfaces, removed excessive thread locking</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]1499 <li>Documentation: man page (John Fleck), xmlReader documentation</li>
1500 <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
1501</ul>
1502
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]1503<h3>2.5.6: Apr 1 2003</h3>
1504<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1505 <li>Fixed W3C XML Schemas datatype, should be compliant now except for
1506 binHex and base64 which are not supported yet.</li>
1507 <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
1508 XInclude entities handling, encoding detection on external subsets, XML
1509 Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]1510 <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
1511 <li>documentation: added --relaxng option to xmllint man page (John)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1512 <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
1513 errors</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]1514</ul>
1515
1516<h3>2.5.5: Mar 24 2003</h3>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]1517<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1518 <li>Lot of fixes on the Relax NG implementation. More testing including
1519 DocBook and TEI examples.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]1520 <li>Increased the support for W3C XML Schemas datatype</li>
1521 <li>Several bug fixes in the URI handling layer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1522 <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
1523 conversion, line counting in the parser.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]1524 <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
1525 <li>Fixed the RPM spec file name</li>
1526</ul>
1527
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]1528<h3>2.5.4: Feb 20 2003</h3>
1529<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1530 <li>Conformance testing and lot of fixes on Relax NG and XInclude
1531 implementation</li>
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]1532 <li>Implementation of XPointer element() scheme</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1533 <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
1534 namespaces,
1535 <p>2 serialization bugs, node info generation problems, a DTD regexp
1536 generation problem.</p>
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]1537 </li>
1538 <li>Portability: windows updates and path canonicalization (Igor)</li>
1539 <li>A few typo fixes (Kjartan Maraas)</li>
1540 <li>Python bindings generator fixes (Stephane Bidoul)</li>
1541</ul>
1542
Daniel Veillard1d788d22003-02-10 16:21:58 +0000[diff] [blame]1543<h3>2.5.3: Feb 10 2003</h3>
1544<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1545 <li>RelaxNG and XML Schemas datatypes improvements, and added a first
1546 version of RelaxNG Python bindings</li>
1547 <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
1548 serializing namespace nodes, encoding conversion bug, XHTML1
1549 serialization</li>
Daniel Veillard1d788d22003-02-10 16:21:58 +0000[diff] [blame]1550 <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
1551</ul>
1552
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]1553<h3>2.5.2: Feb 5 2003</h3>
1554<ul>
1555 <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
1556 <li>Schemas support now compiled in by default.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1557 <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
1558 delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul),
1559 XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory
1560 consumption, HTML parser, HTML serialization in the presence of
1561 namespaces</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]1562 <li>added an HTML API to check elements and attributes.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1563 <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
1564 patches (Stefan Kost)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]1565 <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1566 <li>Added python bindings for XPointer, contextual error reporting
1567 (Stéphane Bidoul)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]1568 <li>URI/file escaping problems (Stefano Zacchiroli)</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1569</ul>
1570
Daniel Veillarde2830f12003-01-08 17:47:49 +0000[diff] [blame]1571<h3>2.5.1: Jan 8 2003</h3>
1572<ul>
1573 <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
1574 <li>documentation updates (John)</li>
1575 <li>a couple of XmlTextReader fixes</li>
1576</ul>
1577
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]1578<h3>2.5.0: Jan 6 2003</h3>
1579<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1580 <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
1581 API (with help of Stéphane Bidoul)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]1582 <li>Windows: more exports, including the new API (Igor)</li>
1583 <li>XInclude fallback fix</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1584 <li>Python: bindings for the new API, packaging (Stéphane Bidoul),
1585 drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup
1586 and iterators for Python-2.2 (Hannu Krosing)</li>
1587 <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
1588 (John)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]1589 <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
1590 <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
1591 <li>Entities handling fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1592 <li>new API to optionally track node creation and deletion (Lukas
1593 Schroeder)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]1594 <li>Added documentation for the XmltextReader interface and some <a
1595 href="guidelines.html">XML guidelines</a></li>
1596</ul>
1597
Daniel Veillardc1eed322002-12-12 11:01:32 +0000[diff] [blame]1598<h3>2.4.30: Dec 12 2002</h3>
1599<ul>
1600 <li>2.4.29 broke the python bindings, rereleasing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1601 <li>Improvement/fixes of the XML API generator, and couple of minor code
1602 fixes.</li>
Daniel Veillardc1eed322002-12-12 11:01:32 +0000[diff] [blame]1603</ul>
1604
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1605<h3>2.4.29: Dec 11 2002</h3>
1606<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1607 <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
1608 (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1609 <li>Fix for prev in python bindings (ERDI Gergo)</li>
1610 <li>Fix for entities handling (Marcus Clarke)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1611 <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
1612 dump</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1613 <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
1614 <li>Fix for HTTP URL escaping problem</li>
1615 <li>added an TextXmlReader (C#) like API (work in progress)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1616 <li>Rewrote the API in XML generation script, includes a C parser and saves
1617 more informations needed for C# bindings</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1618</ul>
1619
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]1620<h3>2.4.28: Nov 22 2002</h3>
1621<ul>
1622 <li>a couple of python binding fixes</li>
1623 <li>2 bug fixes in the XML push parser</li>
1624 <li>potential memory leak removed (Martin Stoilov)</li>
1625 <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
1626 <li>added encoding support for XInclude parse="text"</li>
1627 <li>autodetection of XHTML1 and specific serialization rules added</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1628 <li>nasty threading bug fixed (William Brack)</li>
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]1629</ul>
1630
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]1631<h3>2.4.27: Nov 17 2002</h3>
1632<ul>
1633 <li>fixes for the Python bindings</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1634 <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
1635 HTML parser, Schemas (Charles Bozeman), document fragment support
1636 (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
1637 xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
1638 Pajas), entities processing</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]1639 <li>added grep to xmllint --shell</li>
1640 <li>VMS update patch from Craig A. Berry</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1641 <li>cleanup of the Windows build with support for more compilers (Igor),
1642 better thread support on Windows</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]1643 <li>cleanup of Unix Makefiles and spec file</li>
1644 <li>Improvements to the documentation (John Fleck)</li>
1645</ul>
1646
Daniel Veillard48267432002-10-18 11:21:38 +0000[diff] [blame]1647<h3>2.4.26: Oct 18 2002</h3>
1648<ul>
1649 <li>Patches for Windows CE port, improvements on Windows paths handling</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1650 <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() ,
1651 HTML serialization, Namespace compliance, and a number of small
1652 problems</li>
Daniel Veillard48267432002-10-18 11:21:38 +0000[diff] [blame]1653</ul>
1654
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1655<h3>2.4.25: Sep 26 2002</h3>
1656<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1657 <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
1658 tree, xmlI/O, Html</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1659 <li>Serious rewrite of XInclude</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1660 <li>Made XML Schemas regexp part of the default build and APIs, small fix
1661 and improvement of the regexp core</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1662 <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1663 <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
1664 Daniel Gehriger, Mark Vakoc)</li>
1665 <li>Improved the python I/O bindings, the tests, added resolver and regexp
1666 APIs</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1667 <li>New logos from Marc Liyanage</li>
1668 <li>Tutorial improvements: John Fleck, Christopher Harris</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1669 <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
1670 Merlet)</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1671 <li>removal of all stderr/perror use for error reporting</li>
1672 <li>Better error reporting: XPath and DTD validation</li>
1673 <li>update of the trio portability layer (Bjorn Reese)</li>
1674</ul>
1675
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]1676<p><strong>2.4.24: Aug 22 2002</strong></p>
1677<ul>
1678 <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1679 <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
1680 (fcrozat)</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]1681 <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
1682 <li>C14N improvements by Aleksey</li>
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]1683 <li>doc cleanups: Rick Jones</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]1684 <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
1685 <li>XInclude: implementation of fallback and xml:base fixup added</li>
1686</ul>
1687
Daniel Veillard782afda2002-07-08 15:12:49 +0000[diff] [blame]1688<h3>2.4.23: July 6 2002</h3>
1689<ul>
1690 <li>performances patches: Peter Jacobi</li>
1691 <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
1692 <li>added xmlDocFormatDump: Chema Celorio</li>
1693 <li>new tutorial: John Fleck</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1694 <li>new hash functions and performances: Sander Vesik, portability fix from
1695 Peter Jacobi</li>
1696 <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
1697 HTML parsers, ID lookup function</li>
Daniel Veillard782afda2002-07-08 15:12:49 +0000[diff] [blame]1698 <li>removal of all remaining sprintf: Aleksey Sanin</li>
1699</ul>
1700
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]1701<h3>2.4.22: May 27 2002</h3>
1702<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1703 <li>a number of bug fixes: configure scripts, base handling, parser, memory
1704 usage, HTML parser, XPath, documentation (Christian Cornelssen),
1705 indentation, URI parsing</li>
1706 <li>Optimizations for XMLSec, fixing and making public some of the network
1707 protocol handlers (Aleksey)</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]1708 <li>performance patch from Gary Pennington</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1709 <li>Charles Bozeman provided date and time support for XML Schemas
1710 datatypes</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]1711</ul>
1712
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1713<h3>2.4.21: Apr 29 2002</h3>
1714
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1715<p>This release is both a bug fix release and also contains the early XML
1716Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
1717href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
1718interfaces are likely to change, there is huge holes, it is clearly a work in
1719progress and don't even think of putting this code in a production system,
1720it's actually not compiled in by default. The real fixes are:</p>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1721<ul>
1722 <li>a couple of bugs or limitations introduced in 2.4.20</li>
1723 <li>patches for Borland C++ and MSC by Igor</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1724 <li>some fixes on XPath strings and conformance patches by Richard
1725 Jinks</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1726 <li>patch from Aleksey for the ExcC14N specification</li>
1727 <li>OSF/1 bug fix by Bjorn</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]1728</ul>
1729
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]1730<h3>2.4.20: Apr 15 2002</h3>
1731<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1732 <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]1733 <li>XPath conformance testing by Richard Jinks</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1734 <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
1735 libxml.m4</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]1736</ul>
1737
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]1738<h3>2.4.19: Mar 25 2002</h3>
1739<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1740 <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
1741 encoder</li>
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]1742 <li>portability fixes in the HTTP code</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]1743 <li>memory allocation checks using valgrind, and profiling tests</li>
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]1744 <li>revamp of the Windows build and Makefiles</li>
1745</ul>
1746
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]1747<h3>2.4.18: Mar 18 2002</h3>
1748<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1749 <li>bug fixes: tree, SAX, canonicalization, validation, portability,
1750 XPath</li>
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]1751 <li>removed the --with-buffer option it was becoming unmaintainable</li>
1752 <li>serious cleanup of the Python makefiles</li>
1753 <li>speedup patch to XPath very effective for DocBook stylesheets</li>
1754 <li>Fixes for Windows build, cleanup of the documentation</li>
1755</ul>
1756
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]1757<h3>2.4.17: Mar 8 2002</h3>
1758<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1759 <li>a lot of bug fixes, including "namespace nodes have no parents in
1760 XPath"</li>
1761 <li>fixed/improved the Python wrappers, added more examples and more
1762 regression tests, XPath extension functions can now return node-sets</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1763 <li>added the XML Canonicalization support from Aleksey Sanin</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1764</ul>
1765
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000[diff] [blame]1766<h3>2.4.16: Feb 20 2002</h3>
1767<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1768 <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
1769 from OASIS and W3C. Compliance has been significantly improved.</li>
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000[diff] [blame]1770 <li>a couple of portability fixes too.</li>
1771</ul>
1772
Daniel Veillard397ff112002-02-11 18:27:20 +0000[diff] [blame]1773<h3>2.4.15: Feb 11 2002</h3>
1774<ul>
1775 <li>Fixed the Makefiles, especially the python module ones</li>
1776 <li>A few bug fixes and cleanup</li>
1777 <li>Includes cleanup</li>
1778</ul>
1779
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]1780<h3>2.4.14: Feb 8 2002</h3>
1781<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1782 <li>Change of License to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1783 href="http://www.opensource.org/licenses/mit-license.html">MIT
1784 License</a> basically for integration in XFree86 codebase, and removing
1785 confusion around the previous dual-licensing</li>
1786 <li>added Python bindings, beta software but should already be quite
1787 complete</li>
1788 <li>a large number of fixes and cleanups, especially for all tree
1789 manipulations</li>
1790 <li>cleanup of the headers, generation of a reference API definition in
1791 XML</li>
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]1792</ul>
1793
1794<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]1795<ul>
1796 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
1797 <li>cleanup of timing code from Justin Fletcher</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1798 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
1799 Narojnyi</li>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]1800 <li>Cygwin patch from Robert Collins</li>
1801 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
1802</ul>
1803
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]1804<h3>2.4.12: Dec 7 2001</h3>
1805<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1806 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
1807 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
1808 (robert)</li>
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]1809 <li>Eric Lavigne contributed project files for MacOS</li>
1810 <li>some makefiles cleanups</li>
1811</ul>
1812
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]1813<h3>2.4.11: Nov 26 2001</h3>
1814<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1815 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
1816 cleanups</li>
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]1817 <li>xmllint man pages improvement by Heiko Rupp</li>
1818 <li>updated VMS build instructions from John A Fotheringham</li>
1819 <li>Windows Makefiles updates from Igor</li>
1820</ul>
1821
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1822<h3>2.4.10: Nov 10 2001</h3>
1823<ul>
1824 <li>URI escaping fix (Joel Young)</li>
1825 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
1826 <li>Fixes namespace handling problems when using DTD and validation</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1827 <li>improvements on xmllint: Morus Walter patches for --format and
1828 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1829 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
1830 <li>fixes to the HTML parser</li>
1831</ul>
1832
1833<h3>2.4.9: Nov 6 2001</h3>
1834<ul>
1835 <li>fixes more catalog bugs</li>
1836 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
1837</ul>
1838
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]1839<h3>2.4.8: Nov 4 2001</h3>
1840<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1841 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
1842 tool</li>
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]1843 <li>fixed a compile errors and some includes troubles.</li>
1844</ul>
1845
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1846<h3>2.4.7: Oct 30 2001</h3>
1847<ul>
1848 <li>exported some debugging interfaces</li>
1849 <li>serious rewrite of the catalog code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1850 <li>integrated Gary Pennington thread safety patch, added configure option
1851 and regression tests</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1852 <li>removed an HTML parser bug</li>
1853 <li>fixed a couple of potentially serious validation bugs</li>
1854 <li>integrated the SGML DocBook support in xmllint</li>
1855 <li>changed the nanoftp anonymous login passwd</li>
1856 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
1857 <li>general bug fixes</li>
1858 <li>updated xmllint man page by John Fleck</li>
1859 <li>some VMS and Windows updates</li>
1860</ul>
1861
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1862<h3>2.4.6: Oct 10 2001</h3>
1863<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1864 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1865 <li>portability and configure fixes</li>
1866 <li>an infinite loop on the HTML parser was removed (William)</li>
1867 <li>Windows makefile patches from Igor</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1868 <li>fixed half a dozen bugs reported for libxml or libxslt</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1869 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
1870</ul>
1871
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]1872<h3>2.4.5: Sep 14 2001</h3>
1873<ul>
1874 <li>Remove a few annoying bugs in 2.4.4</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1875 <li>forces the HTML serializer to output decimal charrefs since some
1876 version of Netscape can't handle hexadecimal ones</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]1877</ul>
1878
1879<h3>1.8.16: Sep 14 2001</h3>
1880<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1881 <li>maintenance release of the old libxml1 branch, couple of bug and
1882 portability fixes</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]1883</ul>
1884
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]1885<h3>2.4.4: Sep 12 2001</h3>
1886<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1887 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
1888 Catalog</li>
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]1889 <li>a few bug fixes and some portability changes</li>
1890 <li>some documentation cleanups</li>
1891</ul>
1892
Daniel Veillard39936902001-08-24 00:49:01 +0000[diff] [blame]1893<h3>2.4.3: Aug 23 2001</h3>
1894<ul>
1895 <li>XML Catalog support see the doc</li>
1896 <li>New NaN/Infinity floating point code</li>
1897 <li>A few bug fixes</li>
1898</ul>
1899
1900<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1901<ul>
1902 <li>adds xmlLineNumbersDefault() to control line number generation</li>
1903 <li>lot of bug fixes</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1904 <li>the Microsoft MSC projects files should now be up to date</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1905 <li>inheritance of namespaces from DTD defaulted attributes</li>
1906 <li>fixes a serious potential security bug</li>
1907 <li>added a --format option to xmllint</li>
1908</ul>
1909
1910<h3>2.4.1: July 24 2001</h3>
1911<ul>
1912 <li>possibility to keep line numbers in the tree</li>
1913 <li>some computation NaN fixes</li>
1914 <li>extension of the XPath API</li>
1915 <li>cleanup for alpha and ia64 targets</li>
1916 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1917</ul>
1918
1919<h3>2.4.0: July 10 2001</h3>
1920<ul>
1921 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1922 <li>Fixed XML Base implementation, added a couple of examples to the
1923 regression tests</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1924 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]1925</ul>
1926
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1927<h3>2.3.14: July 5 2001</h3>
1928<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1929 <li>fixed some entities problems and reduce memory requirement when
1930 substituting them</li>
1931 <li>lots of improvements in the XPath queries interpreter can be
1932 substantially faster</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1933 <li>Makefiles and configure cleanups</li>
1934 <li>Fixes to XPath variable eval, and compare on empty node set</li>
1935 <li>HTML tag closing bug fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1936 <li>Fixed an URI reference computation problem when validating</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1937</ul>
1938
Daniel Veillard2adbb512001-06-28 16:20:36 +0000[diff] [blame]1939<h3>2.3.13: June 28 2001</h3>
1940<ul>
1941 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
1942 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
1943</ul>
1944
1945<h3>1.8.14: June 28 2001</h3>
1946<ul>
1947 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
1948 <li>Small Makefile fix</li>
1949</ul>
1950
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]1951<h3>2.3.12: June 26 2001</h3>
1952<ul>
1953 <li>lots of cleanup</li>
1954 <li>a couple of validation fix</li>
1955 <li>fixed line number counting</li>
1956 <li>fixed serious problems in the XInclude processing</li>
1957 <li>added support for UTF8 BOM at beginning of entities</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1958 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
1959 miscompile uri.c (William), Thomas Leitner provided a fix for the
1960 optimizer on Tru64</li>
1961 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
1962 compilation on Windows MSC</li>
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]1963 <li>update of libxml-doc.el (Felix Natter)</li>
1964 <li>fixed 2 bugs in URI normalization code</li>
1965</ul>
1966
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]1967<h3>2.3.11: June 17 2001</h3>
1968<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1969 <li>updates to trio, Makefiles and configure should fix some portability
1970 problems (alpha)</li>
1971 <li>fixed some HTML serialization problems (pre, script, and block/inline
1972 handling), added encoding aware APIs, cleanup of this code</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]1973 <li>added xmlHasNsProp()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1974 <li>implemented a specific PI for encoding support in the DocBook SGML
1975 parser</li>
1976 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
1977 node selection)</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]1978 <li>fixed a performance problem and an error in the validation code</li>
1979 <li>fixed XInclude routine to implement the recursive behaviour</li>
1980 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
1981 <li>added --version to xmllint for bug reports</li>
1982</ul>
1983
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]1984<h3>2.3.10: June 1 2001</h3>
1985<ul>
1986 <li>fixed the SGML catalog support</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1987 <li>a number of reported bugs got fixed, in XPath, iconv detection,
1988 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]1989 <li>XPath string function should now handle unicode correctly</li>
1990</ul>
1991
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]1992<h3>2.3.9: May 19 2001</h3>
1993
1994<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
1995<ul>
1996 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1997 <li>some serious speed optimization again</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]1998 <li>some documentation cleanups</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1999 <li>trying to get better linking on Solaris (-R)</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2000 <li>XPath API cleanup from Thomas Broyer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2001 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
2002 xmlValidGetValidElements()</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2003 <li>Added an INSTALL file</li>
2004 <li>Attribute removal added to API: #54433</li>
2005 <li>added a basic support for SGML catalogs</li>
2006 <li>fixed xmlKeepBlanksDefault(0) API</li>
2007 <li>bugfix in xmlNodeGetLang()</li>
2008 <li>fixed a small configure portability problem</li>
2009 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
2010</ul>
2011
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]2012<h3>1.8.13: May 14 2001</h3>
2013<ul>
2014 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
2015</ul>
2016
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]2017<h3>2.3.8: May 3 2001</h3>
2018<ul>
2019 <li>Integrated an SGML DocBook parser for the Gnome project</li>
2020 <li>Fixed a few things in the HTML parser</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2021 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
2022 point portability issue</li>
2023 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
2024 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]2025 <li>incorporated more Windows cleanup</li>
2026 <li>added xmlSaveFormatFile()</li>
2027 <li>fixed problems in copying nodes with entities references (gdome)</li>
2028 <li>removed some troubles surrounding the new validation module</li>
2029</ul>
2030
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2031<h3>2.3.7: April 22 2001</h3>
2032<ul>
2033 <li>lots of small bug fixes, corrected XPointer</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2034 <li>Non deterministic content model validation support</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2035 <li>added xmlDocCopyNode for gdome2</li>
2036 <li>revamped the way the HTML parser handles end of tags</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2037 <li>XPath: corrections of namespaces support and number formatting</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2038 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2039 <li>HTML output fixes from P C Chow and William M. Brack</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2040 <li>Improved validation speed sensible for DocBook</li>
2041 <li>fixed a big bug with ID declared in external parsed entities</li>
2042 <li>portability fixes, update of Trio from Bjorn Reese</li>
2043</ul>
2044
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2045<h3>2.3.6: April 8 2001</h3>
2046<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2047 <li>Code cleanup using extreme gcc compiler warning options, found and
2048 cleared half a dozen potential problem</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2049 <li>the Eazel team found an XML parser bug</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2050 <li>cleaned up the user of some of the string formatting function. used the
2051 trio library code to provide the one needed when the platform is missing
2052 them</li>
2053 <li>xpath: removed a memory leak and fixed the predicate evaluation
2054 problem, extended the testsuite and cleaned up the result. XPointer seems
2055 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2056</ul>
2057
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]2058<h3>2.3.5: Mar 23 2001</h3>
2059<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2060 <li>Biggest change is separate parsing and evaluation of XPath expressions,
2061 there is some new APIs for this too</li>
2062 <li>included a number of bug fixes(XML push parser, 51876, notations,
2063 52299)</li>
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]2064 <li>Fixed some portability issues</li>
2065</ul>
2066
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2067<h3>2.3.4: Mar 10 2001</h3>
2068<ul>
2069 <li>Fixed bugs #51860 and #51861</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2070 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
2071 size to be application tunable.</li>
2072 <li>Some cleanup in the validation code, still a bug left and this part
2073 should probably be rewritten to support ambiguous content model :-\</li>
2074 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
2075 parser</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2076 <li>Fixed another bug in xmlNodeGetContent()</li>
2077 <li>Bjorn fixed XPath node collection and Number formatting</li>
2078 <li>Fixed a loop reported in the HTML parsing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2079 <li>blank space are reported even if the Dtd content model proves that they
2080 are formatting spaces, this is for XML conformance</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2081</ul>
2082
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]2083<h3>2.3.3: Mar 1 2001</h3>
2084<ul>
2085 <li>small change in XPath for XSLT</li>
2086 <li>documentation cleanups</li>
2087 <li>fix in validation by Gary Pennington</li>
2088 <li>serious parsing performances improvements</li>
2089</ul>
2090
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2091<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]2092<ul>
2093 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
2094 <li>fixed a Dtd parsing bug</li>
2095 <li>fixed a bug in xmlNodeGetContent</li>
2096 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
2097</ul>
2098
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2099<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2100<ul>
2101 <li>some XPath and HTML bug fixes for XSLT</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2102 <li>small extension of the hash table interfaces for DOM gdome2
2103 implementation</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2104 <li>A few bug fixes</li>
2105</ul>
2106
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2107<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]2108<ul>
2109 <li>Lots of XPath bug fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2110 <li>Add a mode with Dtd lookup but without validation error reporting for
2111 XSLT</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2112 <li>Add support for text node without escaping (XSLT)</li>
2113 <li>bug fixes for xmlCheckFilename</li>
2114 <li>validation code bug fixes from Gary Pennington</li>
2115 <li>Patch from Paul D. Smith correcting URI path normalization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2116 <li>Patch to allow simultaneous install of libxml-devel and
2117 libxml2-devel</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2118 <li>the example Makefile is now fixed</li>
2119 <li>added HTML to the RPM packages</li>
2120 <li>tree copying bugfixes</li>
2121 <li>updates to Windows makefiles</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2122 <li>optimization patch from Bjorn Reese</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2123</ul>
2124
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2125<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]2126<ul>
2127 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
2128 <li>added htmlHandleOmittedElem()</li>
2129 <li>Applied Bjorn Reese's IPV6 first patch</li>
2130 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2131 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]2132</ul>
2133
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]2134<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]2135<ul>
2136 <li>Fix the Windows problems of 2.2.8</li>
2137 <li>integrate OpenVMS patches</li>
2138 <li>better handling of some nasty HTML input</li>
2139 <li>Improved the XPointer implementation</li>
2140 <li>integrate a number of provided patches</li>
2141</ul>
2142
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]2143<h3>2.2.9: Nov 25 2000</h3>
2144<ul>
2145 <li>erroneous release :-(</li>
2146</ul>
2147
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]2148<h3>2.2.8: Nov 13 2000</h3>
2149<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2150 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
2151 support</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]2152 <li>Patch in conditional section handling</li>
2153 <li>updated MS compiler project</li>
2154 <li>fixed some XPath problems</li>
2155 <li>added an URI escaping function</li>
2156 <li>some other bug fixes</li>
2157</ul>
2158
2159<h3>2.2.7: Oct 31 2000</h3>
2160<ul>
2161 <li>added message redirection</li>
2162 <li>XPath improvements (thanks TOM !)</li>
2163 <li>xmlIOParseDTD() added</li>
2164 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
2165 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
2166</ul>
2167
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]2168<h3>2.2.6: Oct 25 2000:</h3>
2169<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2170 <li>Added an hash table module, migrated a number of internal structure to
2171 those</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]2172 <li>Fixed a posteriori validation problems</li>
2173 <li>HTTP module cleanups</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2174 <li>HTML parser improvements (tag errors, script/style handling, attribute
2175 normalization)</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]2176 <li>coalescing of adjacent text nodes</li>
2177 <li>couple of XPath bug fixes, exported the internal API</li>
2178</ul>
2179
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]2180<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]2181<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]2182 <li>XPointer implementation and testsuite</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2183 <li>Lot of XPath fixes, added variable and functions registration, more
2184 tests</li>
2185 <li>Portability fixes, lots of enhancements toward an easy Windows build
2186 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]2187 <li>Late validation fixes</li>
2188 <li>Integrated a lot of contributed patches</li>
2189 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]2190 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]2191</ul>
2192
2193<h3>2.2.4: Oct 1 2000:</h3>
2194<ul>
2195 <li>main XPath problem fixed</li>
2196 <li>Integrated portability patches for Windows</li>
2197 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2198</ul>
2199
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]2200<h3>2.2.3: Sep 17 2000</h3>
2201<ul>
2202 <li>bug fixes</li>
2203 <li>cleanup of entity handling code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2204 <li>overall review of all loops in the parsers, all sprintf usage has been
2205 checked too</li>
2206 <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
2207 works smoothly now.</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]2208</ul>
2209
2210<h3>1.8.10: Sep 6 2000</h3>
2211<ul>
2212 <li>bug fix release for some Gnome projects</li>
2213</ul>
2214
2215<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]2216<ul>
2217 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]2218 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]2219</ul>
2220
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]2221<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]2222<ul>
2223 <li>a purely bug fixes release</li>
2224 <li>fixed an encoding support problem when parsing from a memory block</li>
2225 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2226 <li>removed a bug in the function allowing to override the memory
2227 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]2228</ul>
2229
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]2230<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]2231<ul>
2232 <li>applied a lot of portability fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2233 <li>better encoding support/cleanup and saving (content is now always
2234 encoded in UTF-8)</li>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]2235 <li>the HTML parser now correctly handles encodings</li>
2236 <li>added xmlHasProp()</li>
2237 <li>fixed a serious problem with &amp;#38;</li>
2238 <li>propagated the fix to FTP client</li>
2239 <li>cleanup, bugfixes, etc ...</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2240 <li>Added a page about <a href="encoding.html">libxml Internationalization
2241 support</a></li>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]2242</ul>
2243
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2244<h3>1.8.9: July 9 2000</h3>
2245<ul>
2246 <li>fixed the spec the RPMs should be better</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2247 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
2248 rpmfind users problem</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2249</ul>
2250
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]2251<h3>2.1.1: July 1 2000</h3>
2252<ul>
2253 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
2254 <li>improvements on the HTML parser</li>
2255</ul>
2256
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2257<h3>2.1.0 and 1.8.8: June 29 2000</h3>
2258<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2259 <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
2260 to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
2261 about &amp;#38; charref parsing</li>
2262 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
2263 also contains numerous fixes and enhancements:
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2264 <ul>
2265 <li>added xmlStopParser() to stop parsing</li>
2266 <li>improved a lot parsing speed when there is large CDATA blocs</li>
2267 <li>includes XPath patches provided by Picdar Technology</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2268 <li>tried to fix as much as possible DTD validation and namespace
2269 related problems</li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2270 <li>output to a given encoding has been added/tested</li>
2271 <li>lot of various fixes</li>
2272 </ul>
2273 </li>
2274</ul>
2275
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2276<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2277<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2278 <li>First public release of libxml2. If you are using libxml, it's a good
2279 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
2280 scheduled for Apr 3 the release occurred only on Apr 12 due to massive
2281 workload.</li>
2282 <li>The include are now located under $prefix/include/libxml (instead of
2283 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2284 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2285 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2286 <pre>#include "xxx.h"</pre>
2287 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]2288 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2289 <li>the memory allocation routines used by libxml can now be overloaded
2290 dynamically by using xmlMemSetup()</li>
2291 <li>The previously CVS only tool tester has been renamed
2292 <strong>xmllint</strong> and is now installed as part of the libxml2
2293 package</li>
2294 <li>The I/O interface has been revamped. There is now ways to plug in
2295 specific I/O modules, either at the URI scheme detection level using
2296 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
2297 parser context using xmlCreateIOParserCtxt()</li>
2298 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
2299 number of the libxml module in use</li>
2300 <li>a number of optional features of libxml can now be excluded at
2301 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2302</ul>
2303
2304<h3>2.0.0beta: Mar 14 2000</h3>
2305<ul>
2306 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2307 <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org
2308 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
2309 RPMs</li>
2310 <li>This version is now the head in the Gnome CVS base, the old one is
2311 available under the tag LIB_XML_1_X</li>
2312 <li>This includes a very large set of changes. From a programmatic point
2313 of view applications should not have to be modified too much, check the
2314 <a href="upgrade.html">upgrade page</a></li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2315 <li>Some interfaces may changes (especially a bit about encoding).</li>
2316 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2317 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2318 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
2319 handled now</li>
2320 <li>Better handling of entities, especially well-formedness checking
2321 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2322 <li>DTD conditional sections</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2323 <li>Validation now correctly handle entities content</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2324 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
2325 structures to accommodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2326 </ul>
2327 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2328 <li>Serious progress were made toward compliance, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2329 href="conf/result.html">here are the result of the test</a> against the
2330 OASIS testsuite (except the Japanese tests since I don't support that
2331 encoding yet). This URL is rebuilt every couple of hours using the CVS
2332 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]2333</ul>
2334
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2335<h3>1.8.7: Mar 6 2000</h3>
2336<ul>
2337 <li>This is a bug fix release:</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2338 <li>It is possible to disable the ignorable blanks heuristic used by
2339 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
2340 that for adherence to XML spec, this behaviour will be disabled by
2341 default in 2.x . The same function will allow to keep compatibility for
2342 old code.</li>
2343 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
2344 avoiding heuristic is really the Right Way :-\</li>
2345 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
2346 compilation on some platforms has been fixed</li>
2347 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
2348 URIs</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2349</ul>
2350
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]2351<h3>1.8.6: Jan 31 2000</h3>
2352<ul>
2353 <li>added a nanoFTP transport module, debugged until the new version of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2354 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
2355 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]2356</ul>
2357
2358<h3>1.8.5: Jan 21 2000</h3>
2359<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2360 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2361 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
2362 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]2363 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2364 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
2365 to solve the zlib checks problems</li>
2366 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
2367 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2368</ul>
2369
2370<h3>1.8.4: Jan 13 2000</h3>
2371<ul>
2372 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
2373 <li>all exit() call should have been removed from libxml</li>
2374 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
2375 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]2376</ul>
2377
2378<h3>1.8.3: Jan 5 2000</h3>
2379<ul>
2380 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2381 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2382 <li>lots of bug fixes and improvement added over XMas holidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]2383 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]2384 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
2385 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2386 <li>External entity loading code has been revamped, now it uses
2387 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]2388 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]2389</ul>
2390
2391<h3>1.8.2: Dec 21 1999</h3>
2392<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2393 <li>I got another problem with includes and C++, I hope this issue is fixed
2394 for good this time</li>
2395 <li>Added a few tree modification functions: xmlReplaceNode,
2396 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
2397 xmlDocSetRootElement</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]2398 <li>Tried to improve the HTML output with help from <a
2399 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]2400</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2401
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]2402<h3>1.8.1: Dec 18 1999</h3>
2403<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2404 <li>various patches to avoid troubles when using libxml with C++ compilers
2405 the "namespace" keyword and C escaping in include files</li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]2406 <li>a problem in one of the core macros IS_CHAR was corrected</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2407 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
2408 and more specifically the Dia application</li>
2409 <li>fixed a posteriori validation (validation after parsing, or by using a
2410 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2411 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]2412</ul>
2413
2414<h3>1.8.0: Dec 12 1999</h3>
2415<ul>
2416 <li>cleanup, especially memory wise</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2417 <li>the parser should be more reliable, especially the HTML one, it should
2418 not crash, whatever the input !</li>
2419 <li>Integrated various patches, especially a speedup improvement for large
2420 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
2421 configure with --with-buffers to enable them.</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]2422 <li>attribute normalization, oops should have been added long ago !</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2423 <li>attributes defaulted from DTDs should be available, xmlSetProp() now
2424 does entities escaping by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]2425</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]2426
2427<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2428<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]2429 <li>Lots of HTML improvement</li>
2430 <li>Fixed some errors when saving both XML and HTML</li>
2431 <li>More examples, the regression tests should now look clean</li>
2432 <li>Fixed a bug with contiguous charref</li>
2433</ul>
2434
2435<h3>1.7.3: Sep 29 1999</h3>
2436<ul>
2437 <li>portability problems fixed</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2438 <li>snprintf was used unconditionally, leading to link problems on system
2439 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2440</ul>
2441
2442<h3>1.7.1: Sep 24 1999</h3>
2443<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2444 <li>The basic type for strings manipulated by libxml has been renamed in
2445 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
2446 is that CHAR was conflicting with a predefined type on Windows. However
2447 on non WIN32 environment, compatibility is provided by the way of a
2448 <strong>#define </strong>.</li>
2449 <li>Changed another error : the use of a structure field called errno, and
2450 leading to troubles on platforms where it's a macro</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2451</ul>
2452
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2453<h3>1.7.0: Sep 23 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2454<ul>
2455 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2456 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
2457 <li>Added an errno to report errors by another mean than a simple printf
2458 like callback</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2459 <li>Finished ID/IDREF support and checking when validation</li>
2460 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2461 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
2462 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
2463 implementation</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2464 <li>Added an HTML parser front-end</li>
2465</ul>
2466
2467<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2468
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2469<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
2470markup-based structured documents. Here is <a name="example">an example XML
2471document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2472<pre>&lt;?xml version="1.0"?&gt;
2473&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
2474 &lt;head&gt;
2475 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
2476 &lt;/head&gt;
2477 &lt;chapter&gt;
2478 &lt;title&gt;The Linux adventure&lt;/title&gt;
2479 &lt;p&gt;bla bla bla ...&lt;/p&gt;
2480 &lt;image href="linus.gif"/&gt;
2481 &lt;p&gt;...&lt;/p&gt;
2482 &lt;/chapter&gt;
2483&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2484
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2485<p>The first line specifies that it is an XML document and gives useful
2486information about its encoding. Then the rest of the document is a text
2487format whose structure is specified by tags between brackets. <strong>Each
2488tag opened has to be closed</strong>. XML is pedantic about this. However, if
2489a tag is empty (no content), a single tag can serve as both the opening and
2490closing tag if it ends with <code>/&gt;</code> rather than with
2491<code>&gt;</code>. Note that, for example, the image tag has no content (just
2492an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2493
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2494<p>XML can be applied successfully to a wide range of tasks, ranging from
2495long term structured document maintenance (where it follows the steps of
2496SGML) to simple data encoding mechanisms like configuration file formatting
2497(glade), spreadsheets (gnumeric), or even shorter lived documents such as
2498WebDAV where it is used to encode remote calls between a client and a
2499server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2500
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2501<h2><a name="XSLT">XSLT</a></h2>
2502
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2503<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
2504
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2505<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
2506language for transforming XML documents into other XML documents (or
2507HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2508
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2509<p>A separate library called libxslt is available implementing XSLT-1.0 for
2510libxml2. This module "libxslt" too can be found in the Gnome CVS base.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2511
Daniel Veillard29f61002005-08-06 09:07:15 +0000[diff] [blame]2512<p>You can check the progresses on the libxslt <a
2513href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2514
2515<h2><a name="Python">Python and bindings</a></h2>
2516
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2517<p>There are a number of language bindings and wrappers available for
2518libxml2, the list below is not exhaustive. Please contact the <a
2519href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
2520(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
2521order to get updates to this list or to discuss the specific topic of libxml2
2522or libxslt wrappers or bindings:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2523<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2524 <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
2525 most up-to-date C++ bindings for libxml2, check the <a
2526 href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
2527 and the <a
Daniel Veillardc14401e2002-11-20 14:28:17 +0000[diff] [blame]2528 href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2529 <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
2530 based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]2531 <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
2532 <p>Website: <a
2533 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
2534 </li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2535 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2536 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
2537 Sergeant</a> developed <a
2538 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
2539 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
2540 application server</a>.</li>
Daniel Veillard4ac494b2003-09-18 15:08:00 +0000[diff] [blame]2541 <li>If you're interested into scripting XML processing, have a look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2542 href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
2543 Libxml2 Perl bindings.</li>
2544 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
2545 earlier version of the libxml/libxslt <a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2546 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]2547 <li>Gopal.V and Peter Minten develop <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2548 href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
2549 C# libxml2 bindings.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2550 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2551 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
2552 libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]2553 <li>Uwe Fechner also provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2554 href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
2555 implementation for Kylix2/D5/D6 from Borland.</li>
2556 <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a>
2557 and libxml2 bindings are also available in Ruby through the <a
2558 href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
2559 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2560 <li>Steve Ball and contributors maintains <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2561 href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
2562 Tcl</a>.</li>
Daniel Veillard142fb212005-04-07 12:48:10 +0000[diff] [blame]2563 <li>libxml2 and libxslt is the default XML library for PHP5.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2564 <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
2565 an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
2566 libxslt as part of GNU ClasspathX project.</li>
2567 <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
2568 <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]2569 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2570 href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
2571 provides <a
2572 href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
2573 osax</a>. This is an osax for Mac OS X with a set of commands to
2574 implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
2575 commands for Property-lists (Apple's fast lookup table XML format.)</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]2576 <li>Francesco Montorsi developped <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2577 href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
2578 wrappers that interface libxml2, allowing wxWidgets applications to
2579 load/save/edit XML instances.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2580</ul>
2581
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2582<p>The distribution includes a set of Python bindings, which are guaranteed
2583to be maintained as part of the library in the future, though the Python
2584interface have not yet reached the completeness of the C API.</p>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2585
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2586<p>Note that some of the Python purist dislike the default set of Python
2587bindings, rather than complaining I suggest they have a look at <a
2588href="http://codespeak.net/lxml/">lxml the more pythonic bindings for libxml2
2589and libxslt</a> and <a
2590href="http://codespeak.net/mailman/listinfo/lxml-dev">help Martijn
2591Faassen</a> complete those.</p>
Daniel Veillard929746e2005-05-11 11:08:22 +0000[diff] [blame]2592
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2593<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
2594maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
2595of the Python bindings</a>.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2596
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2597<p>Note to people interested in building bindings, the API is formalized as
2598<a href="libxml2-api.xml">an XML API description file</a> which allows to
2599automate a large part of the Python bindings, this includes function
2600descriptions, enums, structures, typedefs, etc... The Python script used to
2601build the bindings is python/generator.py in the source distribution.</p>
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +0000[diff] [blame]2602
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2603<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]2604<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2605 <li>If you use an RPM based distribution, simply install the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2606 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
2607 RPM</a> (and if needed the <a
2608 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
2609 RPM</a>).</li>
2610 <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
2611 module distribution</a> corresponding to your installed version of
2612 libxml2 and libxslt. Note that to install it you will need both libxml2
2613 and libxslt installed and run "python setup.py build install" in the
2614 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]2615</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2616
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2617<p>The distribution includes a set of examples and regression tests for the
2618python bindings in the <code>python/tests</code> directory. Here are some
2619excerpts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2620
2621<h3>tst.py:</h3>
2622
2623<p>This is a basic test of the file interface and DOM navigation:</p>
MST 2003 John Fleck2dffb762003-11-29 04:41:24 +0000[diff] [blame]2624<pre>import libxml2, sys
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2625
2626doc = libxml2.parseFile("tst.xml")
2627if doc.name != "tst.xml":
2628 print "doc.name failed"
2629 sys.exit(1)
2630root = doc.children
2631if root.name != "doc":
2632 print "root.name failed"
2633 sys.exit(1)
2634child = root.children
2635if child.name != "foo":
2636 print "child.name failed"
2637 sys.exit(1)
2638doc.freeDoc()</pre>
2639
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2640<p>The Python module is called libxml2; parseFile is the equivalent of
2641xmlParseFile (most of the bindings are automatically generated, and the xml
2642prefix is removed and the casing convention are kept). All node seen at the
2643binding level share the same subset of accessors:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2644<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2645 <li><code>name</code> : returns the node name</li>
2646 <li><code>type</code> : returns a string indicating the node type</li>
2647 <li><code>content</code> : returns the content of the node, it is based on
2648 xmlNodeGetContent() and hence is recursive.</li>
2649 <li><code>parent</code> , <code>children</code>, <code>last</code>,
2650 <code>next</code>, <code>prev</code>, <code>doc</code>,
2651 <code>properties</code>: pointing to the associated element in the tree,
2652 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2653</ul>
2654
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2655<p>Also note the need to explicitly deallocate documents with freeDoc() .
2656Reference counting for libxml2 trees would need quite a lot of work to
2657function properly, and rather than risk memory leaks if not implemented
2658correctly it sounds safer to have an explicit function to free a tree. The
2659wrapper python objects like doc, root or child are them automatically garbage
2660collected.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2661
2662<h3>validate.py:</h3>
2663
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2664<p>This test check the validation interfaces and redirection of error
2665messages:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2666<pre>import libxml2
2667
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2668#deactivate error messages from the validation
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2669def noerr(ctx, str):
2670 pass
2671
2672libxml2.registerErrorHandler(noerr, None)
2673
2674ctxt = libxml2.createFileParserCtxt("invalid.xml")
2675ctxt.validate(1)
2676ctxt.parseDocument()
2677doc = ctxt.doc()
2678valid = ctxt.isValid()
2679doc.freeDoc()
2680if valid != 0:
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2681 print "validity check failed"</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2682
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2683<p>The first thing to notice is the call to registerErrorHandler(), it
2684defines a new error handler global to the library. It is used to avoid seeing
2685the error messages when trying to validate the invalid document.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2686
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2687<p>The main interest of that test is the creation of a parser context with
2688createFileParserCtxt() and how the behaviour can be changed before calling
2689parseDocument() . Similarly the informations resulting from the parsing phase
2690are also available using context methods.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2691
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2692<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
2693C function interfaces in terms of objects method as much as possible. The
2694best to get a complete view of what methods are supported is to look at the
2695libxml2.py module containing all the wrappers.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2696
2697<h3>push.py:</h3>
2698
2699<p>This test show how to activate the push parser interface:</p>
2700<pre>import libxml2
2701
2702ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
2703ctxt.parseChunk("/&gt;", 2, 1)
2704doc = ctxt.doc()
2705
2706doc.freeDoc()</pre>
2707
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2708<p>The context is created with a special call based on the
2709xmlCreatePushParser() from the C library. The first argument is an optional
2710SAX callback object, then the initial set of data, the length and the name of
2711the resource in case URI-References need to be computed by the parser.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2712
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2713<p>Then the data are pushed using the parseChunk() method, the last call
2714setting the third argument terminate to 1.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2715
2716<h3>pushSAX.py:</h3>
2717
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2718<p>this test show the use of the event based parsing interfaces. In this case
2719the parser does not build a document, but provides callback information as
2720the parser makes progresses analyzing the data being provided:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2721<pre>import libxml2
2722log = ""
2723
2724class callback:
2725 def startDocument(self):
2726 global log
2727 log = log + "startDocument:"
2728
2729 def endDocument(self):
2730 global log
2731 log = log + "endDocument:"
2732
2733 def startElement(self, tag, attrs):
2734 global log
2735 log = log + "startElement %s %s:" % (tag, attrs)
2736
2737 def endElement(self, tag):
2738 global log
2739 log = log + "endElement %s:" % (tag)
2740
2741 def characters(self, data):
2742 global log
2743 log = log + "characters: %s:" % (data)
2744
2745 def warning(self, msg):
2746 global log
2747 log = log + "warning: %s:" % (msg)
2748
2749 def error(self, msg):
2750 global log
2751 log = log + "error: %s:" % (msg)
2752
2753 def fatalError(self, msg):
2754 global log
2755 log = log + "fatalError: %s:" % (msg)
2756
2757handler = callback()
2758
2759ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
2760chunk = " url='tst'&gt;b"
2761ctxt.parseChunk(chunk, len(chunk), 0)
2762chunk = "ar&lt;/foo&gt;"
2763ctxt.parseChunk(chunk, len(chunk), 1)
2764
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +0000[diff] [blame]2765reference = "startDocument:startElement foo {'url': 'tst'}:" + \
2766 "characters: bar:endElement foo:endDocument:"
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2767if log != reference:
2768 print "Error got: %s" % log
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2769 print "Expected: %s" % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2770
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2771<p>The key object in that test is the handler, it provides a number of entry
2772points which can be called by the parser as it makes progresses to indicate
2773the information set obtained. The full set of callback is larger than what
2774the callback class in that specific example implements (see the SAX
2775definition for a complete list). The wrapper will only call those supplied by
2776the object when activated. The startElement receives the names of the element
2777and a dictionary containing the attributes carried by this element.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2778
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2779<p>Also note that the reference string generated from the callback shows a
2780single character call even though the string "bar" is passed to the parser
2781from 2 different call to parseChunk()</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2782
2783<h3>xpath.py:</h3>
2784
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2785<p>This is a basic test of XPath wrappers support</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2786<pre>import libxml2
2787
2788doc = libxml2.parseFile("tst.xml")
2789ctxt = doc.xpathNewContext()
2790res = ctxt.xpathEval("//*")
2791if len(res) != 2:
2792 print "xpath query: wrong node set size"
2793 sys.exit(1)
2794if res[0].name != "doc" or res[1].name != "foo":
2795 print "xpath query: wrong node set value"
2796 sys.exit(1)
2797doc.freeDoc()
2798ctxt.xpathFreeContext()</pre>
2799
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2800<p>This test parses a file, then create an XPath context to evaluate XPath
2801expression on it. The xpathEval() method execute an XPath query and returns
2802the result mapped in a Python way. String and numbers are natively converted,
2803and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
2804the document, the XPath context need to be freed explicitly, also not that
2805the result of the XPath query may point back to the document tree and hence
2806the document must be freed after the result of the query is used.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2807
2808<h3>xpathext.py:</h3>
2809
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2810<p>This test shows how to extend the XPath engine with functions written in
2811python:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2812<pre>import libxml2
2813
2814def foo(ctx, x):
2815 return x + 1
2816
2817doc = libxml2.parseFile("tst.xml")
2818ctxt = doc.xpathNewContext()
2819libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
2820res = ctxt.xpathEval("foo(1)")
2821if res != 2:
2822 print "xpath extension failure"
2823doc.freeDoc()
2824ctxt.xpathFreeContext()</pre>
2825
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2826<p>Note how the extension function is registered with the context (but that
2827part is not yet finalized, this may change slightly in the future).</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2828
2829<h3>tstxpath.py:</h3>
2830
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2831<p>This test is similar to the previous one but shows how the extension
2832function can access the XPath evaluation context:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2833<pre>def foo(ctx, x):
2834 global called
2835
2836 #
2837 # test that access to the XPath evaluation contexts
2838 #
2839 pctxt = libxml2.xpathParserContext(_obj=ctx)
2840 ctxt = pctxt.context()
2841 called = ctxt.function()
2842 return x + 1</pre>
2843
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2844<p>All the interfaces around the XPath parser(or rather evaluation) context
2845are not finalized, but it should be sufficient to do contextual work at the
2846evaluation point.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2847
2848<h3>Memory debugging:</h3>
2849
2850<p>last but not least, all tests starts with the following prologue:</p>
2851<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2852libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2853
2854<p>and ends with the following epilogue:</p>
2855<pre>#memory debug specific
2856libxml2.cleanupParser()
2857if libxml2.debugMemory(1) == 0:
2858 print "OK"
2859else:
2860 print "Memory leak %d bytes" % (libxml2.debugMemory(1))
2861 libxml2.dumpMemory()</pre>
2862
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2863<p>Those activate the memory debugging interface of libxml2 where all
2864allocated block in the library are tracked. The prologue then cleans up the
2865library state and checks that all allocated memory has been freed. If not it
2866calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2867
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2868<h2><a name="architecture">libxml2 architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2869
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2870<p>Libxml2 is made of multiple components; some of them are optional, and
2871most of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2872<ul>
2873 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2874 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2875 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2876 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2877 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2878 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2879 <li>a SAX tree module to build an in-memory DOM representation</li>
2880 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2881 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2882 <li>an XPath module for global lookup in a DOM representation
2883 (optional)</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2884 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2885</ul>
2886
2887<p>Graphically this gives the following:</p>
2888
2889<p><img src="libxml.gif" alt="a graphical view of the various"></p>
2890
2891<p></p>
2892
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2893<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2894
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2895<p>The parser returns a tree built during the document analysis. The value
2896returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
2897<strong>xmlDoc</strong> structure). This structure contains information such
2898as the file name, the document type, and a <strong>children</strong> pointer
2899which is the root of the document (or more exactly the first child under the
2900root which is the document). The tree is made of <strong>xmlNode</strong>s,
2901chained in double-linked lists of siblings and with a children&lt;-&gt;parent
2902relationship. An xmlNode can also carry properties (a chain of xmlAttr
2903structures). An attribute may have a value which is a list of TEXT or
2904ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2905
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2906<p>Here is an example (erroneous with respect to the XML spec since there
2907should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2908
2909<p><img src="structure.gif" alt=" structure.gif "></p>
2910
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2911<p>In the source package there is a small program (not installed by default)
2912called <strong>xmllint</strong> which parses XML files given as argument and
2913prints them back as parsed. This is useful for detecting errors both in XML
2914code and in the XML parser itself. It has an option <strong>--debug</strong>
2915which prints the actual in-memory structure of the document; here is the
2916result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2917<pre>DOCUMENT
2918version=1.0
2919standalone=true
2920 ELEMENT EXAMPLE
2921 ATTRIBUTE prop1
2922 TEXT
2923 content=gnome is great
2924 ATTRIBUTE prop2
2925 ENTITY_REF
2926 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2927 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2928 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2929 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2930 TEXT
2931 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2932 ELEMENT chapter
2933 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2934 TEXT
2935 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2936 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2937 TEXT
2938 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2939 ELEMENT image
2940 ATTRIBUTE href
2941 TEXT
2942 content=linus.gif
2943 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2944 TEXT
2945 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2946
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2947<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2948
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2949<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2950
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2951<p>Sometimes the DOM tree output is just too large to fit reasonably into
2952memory. In that case (and if you don't expect to save back the XML document
2953loaded using libxml), it's better to use the SAX interface of libxml. SAX is
2954a <strong>callback-based interface</strong> to the parser. Before parsing,
2955the application layer registers a customized set of callbacks which are
2956called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2957
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2958<p>To get more detailed step-by-step guidance on using the SAX interface of
2959libxml, see the <a
2960href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
2961documentation</a>.written by <a href="mailto:james@daa.com.au">James
2962Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2963
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2964<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
2965program located in the gnome-xml module (it's usually not shipped in the
2966binary packages of libxml, but you can find it in the tar source
2967distribution). Here is the sequence of callbacks that would be reported by
2968testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2969<pre>SAX.setDocumentLocator()
2970SAX.startDocument()
2971SAX.getEntity(amp)
2972SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
2973SAX.characters( , 3)
2974SAX.startElement(head)
2975SAX.characters( , 4)
2976SAX.startElement(title)
2977SAX.characters(Welcome to Gnome, 16)
2978SAX.endElement(title)
2979SAX.characters( , 3)
2980SAX.endElement(head)
2981SAX.characters( , 3)
2982SAX.startElement(chapter)
2983SAX.characters( , 4)
2984SAX.startElement(title)
2985SAX.characters(The Linux adventure, 19)
2986SAX.endElement(title)
2987SAX.characters( , 4)
2988SAX.startElement(p)
2989SAX.characters(bla bla bla ..., 15)
2990SAX.endElement(p)
2991SAX.characters( , 4)
2992SAX.startElement(image, href='linus.gif')
2993SAX.endElement(image)
2994SAX.characters( , 4)
2995SAX.startElement(p)
2996SAX.characters(..., 3)
2997SAX.endElement(p)
2998SAX.characters( , 3)
2999SAX.endElement(chapter)
3000SAX.characters( , 1)
3001SAX.endElement(EXAMPLE)
3002SAX.endDocument()</pre>
3003
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3004<p>Most of the other interfaces of libxml2 are based on the DOM tree-building
3005facility, so nearly everything up to the end of this document presupposes the
3006use of the standard DOM tree build. Note that the DOM tree itself is built by
3007a set of registered default callbacks, without internal specific
3008interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3009
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3010<h2><a name="Validation">Validation &amp; DTDs</a></h2>
3011
3012<p>Table of Content:</p>
3013<ol>
3014 <li><a href="#General5">General overview</a></li>
3015 <li><a href="#definition">The definition</a></li>
3016 <li><a href="#Simple">Simple rules</a>
3017 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]3018 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3019 <li><a href="#Declaring">Declaring elements</a></li>
3020 <li><a href="#Declaring1">Declaring attributes</a></li>
3021 </ol>
3022 </li>
3023 <li><a href="#Some">Some examples</a></li>
3024 <li><a href="#validate">How to validate</a></li>
3025 <li><a href="#Other">Other resources</a></li>
3026</ol>
3027
3028<h3><a name="General5">General overview</a></h3>
3029
3030<p>Well what is validation and what is a DTD ?</p>
3031
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3032<p>DTD is the acronym for Document Type Definition. This is a description of
3033the content for a family of XML files. This is part of the XML 1.0
3034specification, and allows one to describe and verify that a given document
3035instance conforms to the set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3036
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3037<p>Validation is the process of checking a document against a DTD (more
3038generally against a set of construction rules).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3039
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3040<p>The validation process and building DTDs are the two most difficult parts
3041of the XML life cycle. Briefly a DTD defines all the possible elements to be
3042found within your document, what is the formal shape of your document tree
3043(by defining the allowed content of an element; either text, a regular
3044expression for the allowed list of children, or mixed content i.e. both text
3045and children). The DTD also defines the valid attributes for all elements and
3046the types of those attributes.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3047
3048<h3><a name="definition1">The definition</a></h3>
3049
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3050<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
3051href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
3052Rev1</a>):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3053<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3054 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
3055 elements</a></li>
3056 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
3057 attributes</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3058</ul>
3059
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3060<p>(unfortunately) all this is inherited from the SGML world, the syntax is
3061ancient...</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3062
3063<h3><a name="Simple1">Simple rules</a></h3>
3064
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3065<p>Writing DTDs can be done in many ways. The rules to build them if you need
3066something permanent or something which can evolve over time can be radically
3067different. Really complex DTDs like DocBook ones are flexible but quite
3068harder to design. I will just focus on DTDs for a formats with a fixed simple
3069structure. It is just a set of basic rules, and definitely not exhaustive nor
3070usable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3071
3072<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
3073
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3074<p>Assuming the top element of the document is <code>spec</code> and the dtd
3075is placed in the file <code>mydtd</code> in the subdirectory
3076<code>dtds</code> of the directory from where the document were loaded:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3077
3078<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
3079
3080<p>Notes:</p>
3081<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3082 <li>The system string is actually an URI-Reference (as defined in <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3083 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
3084 full URL string indicating the location of your DTD on the Web. This is a
3085 really good thing to do if you want others to validate your document.</li>
3086 <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
3087 magic string) so that the DTD is looked up in catalogs on the client side
3088 without having to locate it on the web.</li>
3089 <li>A DTD contains a set of element and attribute declarations, but they
3090 don't define what the root of the document should be. This is explicitly
3091 told to the parser/validator as the first element of the
3092 <code>DOCTYPE</code> declaration.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3093</ul>
3094
3095<h4><a name="Declaring2">Declaring elements</a>:</h4>
3096
3097<p>The following declares an element <code>spec</code>:</p>
3098
3099<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
3100
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3101<p>It also expresses that the spec element contains one <code>front</code>,
3102one <code>body</code> and one optional <code>back</code> children elements in
3103this order. The declaration of one element of the structure and its content
3104are done in a single declaration. Similarly the following declares
3105<code>div1</code> elements:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3106
Daniel Veillard51737272002-01-23 23:10:38 +0000[diff] [blame]3107<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3108
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3109<p>which means div1 contains one <code>head</code> then a series of optional
3110<code>p</code>, <code>list</code>s and <code>note</code>s and then an
3111optional <code>div2</code>. And last but not least an element can contain
3112text:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3113
3114<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
3115
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3116<p><code>b</code> contains text or being of mixed content (text and elements
3117in no particular order):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3118
3119<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
3120
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3121<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
3122<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
3123order.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3124
3125<h4><a name="Declaring1">Declaring attributes</a>:</h4>
3126
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3127<p>Again the attributes declaration includes their content definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3128
3129<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
3130
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3131<p>means that the element <code>termdef</code> can have a <code>name</code>
3132attribute containing text (<code>CDATA</code>) and which is optional
3133(<code>#IMPLIED</code>). The attribute value can also be defined within a
3134set:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3135
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3136<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
3137"ordered"&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3138
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3139<p>means <code>list</code> element have a <code>type</code> attribute with 3
3140allowed values "bullets", "ordered" or "glossary" and which default to
3141"ordered" if the attribute is not explicitly specified.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3142
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3143<p>The content type of an attribute can be text (<code>CDATA</code>),
3144anchor/reference/references
3145(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
3146(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
3147(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
3148<code>chapter</code> element can have an optional <code>id</code> attribute
3149of type <code>ID</code>, usable for reference from attribute of type
3150IDREF:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3151
3152<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
3153
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3154<p>The last value of an attribute definition can be <code>#REQUIRED
3155</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
3156meaning that it is optional, or the default value (possibly prefixed by
3157<code>#FIXED</code> if it is the only allowed).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3158
3159<p>Notes:</p>
3160<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3161 <li>Usually the attributes pertaining to a given element are declared in a
3162 single expression, but it is just a convention adopted by a lot of DTD
3163 writers:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3164 <pre>&lt;!ATTLIST termdef
3165 id ID #REQUIRED
3166 name CDATA #IMPLIED&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3167 <p>The previous construct defines both <code>id</code> and
3168 <code>name</code> attributes for the element <code>termdef</code>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3169 </li>
3170</ul>
3171
3172<h3><a name="Some1">Some examples</a></h3>
3173
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3174<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
3175contains some complex DTD examples. The example in the file
3176<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
3177directly included within the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3178
3179<h3><a name="validate1">How to validate</a></h3>
3180
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3181<p>The simplest way is to use the xmllint program included with libxml. The
3182<code>--valid</code> option turns-on validation of the files given as input.
3183For example the following validates a copy of the first revision of the XML
31841.0 specification:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3185
3186<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
3187
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3188<p>the -- noout is used to disable output of the resulting tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3189
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3190<p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
3191against a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3192
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3193<p>Libxml2 exports an API to handle DTDs and validation, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3194href="http://xmlsoft.org/html/libxml-valid.html">associated
3195description</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3196
3197<h3><a name="Other1">Other resources</a></h3>
3198
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3199<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
3200will just list one for now, others pointers welcome:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3201<ul>
3202 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
3203</ul>
3204
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3205<p>I suggest looking at the examples found under test/valid/dtd and any of
3206the large number of books available on XML. The dia example in test/valid
3207should be both simple and complete enough to allow you to build your own.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3208
3209<p></p>
3210
3211<h2><a name="Memory">Memory Management</a></h2>
3212
3213<p>Table of Content:</p>
3214<ol>
3215 <li><a href="#General3">General overview</a></li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3216 <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3217 <li><a href="#cleanup">Cleaning up after parsing</a></li>
3218 <li><a href="#Debugging">Debugging routines</a></li>
3219 <li><a href="#General4">General memory requirements</a></li>
3220</ol>
3221
3222<h3><a name="General3">General overview</a></h3>
3223
3224<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3225href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
3226provides the interfaces to the libxml2 memory system:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3227<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3228 <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
3229 xmlMalloc() and xmlRealloc()</li>
3230 <li>those routines can be reallocated to a specific set of routine, by
3231 default the libc ones i.e. free(), malloc() and realloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3232 <li>the xmlmemory.c module includes a set of debugging routine</li>
3233</ul>
3234
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3235<h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3236
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3237<p>It is sometimes useful to not use the default memory allocator, either for
3238debugging, analysis or to implement a specific behaviour on memory management
3239(like on embedded systems). Two function calls are available to do so:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3240<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3241 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
3242 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3243 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3244 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
3245 which allow to set up a new set of memory allocation functions</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3246</ul>
3247
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3248<p>Of course a call to xmlMemSetup() should probably be done before calling
3249any other libxml2 routines (unless you are sure your allocations routines are
3250compatibles).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3251
3252<h3><a name="cleanup">Cleaning up after parsing</a></h3>
3253
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3254<p>Libxml2 is not stateless, there is a few set of memory structures needing
3255allocation before the parser is fully functional (some encoding structures
3256for example). This also mean that once parsing is finished there is a tiny
3257amount of memory (a few hundred bytes) which can be recollected if you don't
3258reuse the parser immediately:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3259<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3260 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
3261 ()</a> is a centralized routine to free the parsing states. Note that it
3262 won't deallocate any produced tree if any (use the xmlFreeDoc() and
3263 related routines for this).</li>
3264 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
3265 ()</a> is the dual routine allowing to preallocate the parsing state
3266 which can be useful for example to avoid initialization reentrancy
3267 problems when using libxml2 in multithreaded applications</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3268</ul>
3269
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3270<p>Generally xmlCleanupParser() is safe, if needed the state will be rebuild
3271at the next invocation of parser routines, but be careful of the consequences
3272in multithreaded applications.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3273
3274<h3><a name="Debugging">Debugging routines</a></h3>
3275
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3276<p>When configured using --with-mem-debug flag (off by default), libxml2 uses
3277a set of memory allocation debugging routines keeping track of all allocated
3278blocks and the location in the code where the routine was called. A couple of
3279other debugging routines allow to dump the memory allocated infos to a file
3280or call a specific routine when a given block number is allocated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3281<ul>
3282 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3283 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
3284 <a
3285 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
3286 and <a
3287 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
3288 are the memory debugging replacement allocation routines</li>
3289 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
3290 ()</a> dumps all the informations about the allocated memory block lefts
3291 in the <code>.memdump</code> file</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3292</ul>
3293
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3294<p>When developing libxml2 memory debug is enabled, the tests programs call
3295xmlMemoryDump () and the "make test" regression tests will check for any
3296memory leak during the full regression test sequence, this helps a lot
3297ensuring that libxml2 does not leak memory and bullet proof memory
3298allocations use (some libc implementations are known to be far too permissive
3299resulting in major portability problems!).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3300
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3301<p>If the .memdump reports a leak, it displays the allocation function and
3302also tries to give some informations about the content and structure of the
3303allocated blocks left. This is sufficient in most cases to find the culprit,
3304but not always. Assuming the allocation problem is reproducible, it is
3305possible to find more easily:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3306<ol>
3307 <li>write down the block number xxxx not allocated</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3308 <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
3309 when using GDB is to simply give the command
Daniel Veillard75794822002-04-11 16:24:32 +0000[diff] [blame]3310 <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
3311 <p>before running the program.</p>
3312 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3313 <li>run the program under a debugger and set a breakpoint on
3314 xmlMallocBreakpoint() a specific function called when this precise block
3315 is allocated</li>
3316 <li>when the breakpoint is reached you can then do a fine analysis of the
3317 allocation an step to see the condition resulting in the missing
3318 deallocation.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3319</ol>
3320
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3321<p>I used to use a commercial tool to debug libxml2 memory problems but after
3322noticing that it was not detecting memory leaks that simple mechanism was
3323used and proved extremely efficient until now. Lately I have also used <a
3324href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
3325success, it is tied to the i386 architecture since it works by emulating the
3326processor and instruction set, it is slow but extremely efficient, i.e. it
3327spot memory usage errors in a very precise way.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3328
3329<h3><a name="General4">General memory requirements</a></h3>
3330
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3331<p>How much libxml2 memory require ? It's hard to tell in average it depends
3332of a number of things:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3333<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3334 <li>the parser itself should work in a fixed amount of memory, except for
3335 information maintained about the stacks of names and entities locations.
3336 The I/O and encoding handlers will probably account for a few KBytes.
3337 This is true for both the XML and HTML parser (though the HTML parser
3338 need more state).</li>
3339 <li>If you are generating the DOM tree then memory requirements will grow
3340 nearly linear with the size of the data. In general for a balanced
3341 textual document the internal memory requirement is about 4 times the
3342 size of the UTF8 serialization of this document (example the XML-1.0
3343 recommendation is a bit more of 150KBytes and takes 650KBytes of main
3344 memory when parsed). Validation will add a amount of memory required for
3345 maintaining the external Dtd state which should be linear with the
3346 complexity of the content model defined by the Dtd</li>
3347 <li>If you need to work with fixed memory requirements or don't need the
3348 full DOM tree then using the <a href="xmlreader.html">xmlReader
3349 interface</a> is probably the best way to proceed, it still allows to
3350 validate or operate on subset of the tree if needed.</li>
3351 <li>If you don't care about the advanced features of libxml2 like
3352 validation, DOM, XPath or XPointer, don't use entities, need to work with
3353 fixed memory requirements, and try to get the fastest parsing possible
3354 then the SAX interface should be used, but it has known restrictions.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3355</ul>
3356
3357<p></p>
3358
3359<h2><a name="Encodings">Encodings support</a></h2>
3360
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3361<p>If you are not really familiar with Internationalization (usual shortcut
3362is I18N) , Unicode, characters and glyphs, I suggest you read a <a
3363href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
3364by Tim Bray on Unicode and why you should care about it.</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]3365
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3366<p>If you don't understand why <b>it does not make sense to have a string
3367without knowing what encoding it uses</b>, then as Joel Spolsky said <a
3368href="http://www.joelonsoftware.com/articles/Unicode.html">please do not
3369write another line of code until you finish reading that article.</a>. It is
3370a prerequisite to understand this page, and avoid a lot of problems with
3371libxml2, XML or text processing in general.</p>
Daniel Veillarde5d68de2005-03-10 15:03:40 +0000[diff] [blame]3372
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3373<p>Table of Content:</p>
3374<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3375 <li><a href="encoding.html#What">What does internationalization support
3376 mean ?</a></li>
3377 <li><a href="encoding.html#internal">The internal encoding, how and
3378 why</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3379 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
3380 <li><a href="encoding.html#Default">Default supported encodings</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3381 <li><a href="encoding.html#extend">How to extend the existing
3382 support</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3383</ol>
3384
3385<h3><a name="What">What does internationalization support mean ?</a></h3>
3386
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3387<p>XML was designed from the start to allow the support of any character set
3388by using Unicode. Any conformant XML parser has to support the UTF-8 and
3389UTF-16 default encodings which can both express the full unicode ranges. UTF8
3390is a variable length encoding whose greatest points are to reuse the same
3391encoding for ASCII and to save space for Western encodings, but it is a bit
3392more complex to handle in practice. UTF-16 use 2 bytes per character (and
3393sometimes combines two pairs), it makes implementation easier, but looks a
3394bit overkill for Western languages encoding. Moreover the XML specification
3395allows the document to be encoded in other encodings at the condition that
3396they are clearly labeled as such. For example the following is a wellformed
3397XML document encoded in ISO-8859-1 and using accentuated letters that we
3398French like for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3399<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
3400&lt;très&gt;là&lt;/très&gt;</pre>
3401
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3402<p>Having internationalization support in libxml2 means the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3403<ul>
3404 <li>the document is properly parsed</li>
3405 <li>informations about it's encoding are saved</li>
3406 <li>it can be modified</li>
3407 <li>it can be saved in its original encoding</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3408 <li>it can also be saved in another encoding supported by libxml2 (for
3409 example straight UTF8 or even an ASCII form)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3410</ul>
3411
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3412<p>Another very important point is that the whole libxml2 API, with the
3413exception of a few routines to read with a specific encoding or save to a
3414specific encoding, is completely agnostic about the original encoding of the
3415document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3416
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3417<p>It should be noted too that the HTML parser embedded in libxml2 now obey
3418the same rules too, the following document will be (as of 2.2.2) handled in
3419an internationalized fashion by libxml2 too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3420<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
3421 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
3422&lt;html lang="fr"&gt;
3423&lt;head&gt;
3424 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
3425&lt;/head&gt;
3426&lt;body&gt;
3427&lt;p&gt;W3C crée des standards pour le Web.&lt;/body&gt;
3428&lt;/html&gt;</pre>
3429
3430<h3><a name="internal">The internal encoding, how and why</a></h3>
3431
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3432<p>One of the core decisions was to force all documents to be converted to a
3433default internal encoding, and that encoding to be UTF-8, here are the
3434rationales for those choices:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3435<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3436 <li>keeping the native encoding in the internal form would force the libxml
3437 users (or the code associated) to be fully aware of the encoding of the
3438 original document, for examples when adding a text node to a document,
3439 the content would have to be provided in the document encoding, i.e. the
3440 client code would have to check it before hand, make sure it's conformant
3441 to the encoding, etc ... Very hard in practice, though in some specific
3442 cases this may make sense.</li>
3443 <li>the second decision was which encoding. From the XML spec only UTF8 and
3444 UTF16 really makes sense as being the two only encodings for which there
3445 is mandatory support. UCS-4 (32 bits fixed size encoding) could be
3446 considered an intelligent choice too since it's a direct Unicode mapping
3447 support. I selected UTF-8 on the basis of efficiency and compatibility
3448 with surrounding software:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3449 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3450 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
3451 more costly to import and export CPU wise) is also far more compact
3452 than UTF-16 (and UCS-4) for a majority of the documents I see it used
3453 for right now (RPM RDF catalogs, advogato data, various configuration
3454 file formats, etc.) and the key point for today's computer
3455 architecture is efficient uses of caches. If one nearly double the
3456 memory requirement to store the same amount of data, this will trash
3457 caches (main memory/external caches/internal caches) and my take is
3458 that this harms the system far more than the CPU requirements needed
3459 for the conversion to UTF-8</li>
3460 <li>Most of libxml2 version 1 users were using it with straight ASCII
3461 most of the time, doing the conversion with an internal encoding
3462 requiring all their code to be rewritten was a serious show-stopper
3463 for using UTF-16 or UCS-4.</li>
3464 <li>UTF-8 is being used as the de-facto internal encoding standard for
3465 related code like the <a href="http://www.pango.org/">pango</a>
3466 upcoming Gnome text widget, and a lot of Unix code (yet another place
3467 where Unix programmer base takes a different approach from Microsoft
3468 - they are using UTF-16)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3469 </ul>
3470 </li>
3471</ul>
3472
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3473<p>What does this mean in practice for the libxml2 user:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3474<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3475 <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
3476 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
3477 is simply to append 0 byte, as usual.</li>
3478 <li>One just need to make sure that when using chars outside the ASCII set,
3479 the values has been properly converted to UTF-8</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3480</ul>
3481
3482<h3><a name="implemente">How is it implemented ?</a></h3>
3483
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3484<p>Let's describe how all this works within libxml, basically the I18N
3485(internationalization) support get triggered only during I/O operation, i.e.
3486when reading a document or saving one. Let's look first at the reading
3487sequence:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3488<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3489 <li>when a document is processed, we usually don't know the encoding, a
3490 simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
3491 the ASCII range (0-0x7F) maps with ASCII</li>
3492 <li>the xml declaration if available is parsed, including the encoding
3493 declaration. At that point, if the autodetected encoding is different
3494 from the one declared a call to xmlSwitchEncoding() is issued.</li>
3495 <li>If there is no encoding declaration, then the input has to be in either
3496 UTF-8 or UTF-16, if it is not then at some point when processing the
3497 input, the converter/checker of UTF-8 form will raise an encoding error.
3498 You may end-up with a garbled document, or no document at all ! Example:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3499 <pre>~/XML -&gt; ./xmllint err.xml
3500err.xml:1: error: Input is not proper UTF-8, indicate encoding !
3501&lt;très&gt;là&lt;/très&gt;
3502 ^
3503err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
3504&lt;très&gt;là&lt;/très&gt;
3505 ^</pre>
3506 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3507 <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
3508 then search the default registered encoding converters for that encoding.
3509 If it's not within the default set and iconv() support has been compiled
3510 it, it will ask iconv for such an encoder. If this fails then the parser
3511 will report an error and stops processing:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3512 <pre>~/XML -&gt; ./xmllint err2.xml
3513err2.xml:1: error: Unsupported encoding UnsupportedEnc
3514&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
3515 ^</pre>
3516 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3517 <li>From that point the encoder processes progressively the input (it is
3518 plugged as a front-end to the I/O module) for that entity. It captures
3519 and converts on-the-fly the document to be parsed to UTF-8. The parser
3520 itself just does UTF-8 checking of this input and process it
3521 transparently. The only difference is that the encoding information has
3522 been added to the parsing context (more precisely to the input
3523 corresponding to this entity).</li>
3524 <li>The result (when using DOM) is an internal form completely in UTF-8
3525 with just an encoding information on the document node.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3526</ol>
3527
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3528<p>Ok then what happens when saving the document (assuming you
3529collected/built an xmlDoc DOM like structure) ? It depends on the function
3530called, xmlSaveFile() will just try to save in the original encoding, while
3531xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
3532encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3533<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3534 <li>if no encoding is given, libxml2 will look for an encoding value
3535 associated to the document and if it exists will try to save to that
3536 encoding,
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3537 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
3538 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3539 <li>so if an encoding was specified, either at the API level or on the
3540 document, libxml2 will again canonicalize the encoding name, lookup for a
3541 converter in the registered set or through iconv. If not found the
3542 function will return an error code</li>
3543 <li>the converter is placed before the I/O buffer layer, as another kind of
3544 buffer, then libxml2 will simply push the UTF-8 serialization to through
3545 that buffer, which will then progressively be converted and pushed onto
3546 the I/O layer.</li>
3547 <li>It is possible that the converter code fails on some input, for example
3548 trying to push an UTF-8 encoded Chinese character through the UTF-8 to
3549 ISO-8859-1 converter won't work. Since the encoders are progressive they
3550 will just report the error and the number of bytes converted, at that
3551 point libxml2 will decode the offending character, remove it from the
3552 buffer and replace it with the associated charRef encoding &amp;#123; and
3553 resume the conversion. This guarantees that any document will be saved
3554 without losses (except for markup names where this is not legal, this is
3555 a problem in the current version, in practice avoid using non-ascii
3556 characters for tag or attribute names). A special "ascii" encoding name
3557 is used to save documents to a pure ascii form can be used when
3558 portability is really crucial</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3559</ol>
3560
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3561<p>Here are a few examples based on the same test document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3562<pre>~/XML -&gt; ./xmllint isolat1
3563&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
3564&lt;très&gt;là&lt;/très&gt;
3565~/XML -&gt; ./xmllint --encode UTF-8 isolat1
3566&lt;?xml version="1.0" encoding="UTF-8"?&gt;
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3567&lt;très&gt;là &nbsp;&lt;/très&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3568~/XML -&gt; </pre>
3569
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3570<p>The same processing is applied (and reuse most of the code) for HTML I18N
3571processing. Looking up and modifying the content encoding is a bit more
3572difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
3573so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
3574been provided. The parser also attempts to switch encoding on the fly when
3575detecting such a tag on input. Except for that the processing is the same
3576(and again reuses the same code).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3577
3578<h3><a name="Default">Default supported encodings</a></h3>
3579
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3580<p>libxml2 has a set of default converters for the following encodings
3581(located in encoding.c):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3582<ol>
3583 <li>UTF-8 is supported by default (null handlers)</li>
3584 <li>UTF-16, both little and big endian</li>
3585 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
3586 <li>ASCII, useful mostly for saving</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3587 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
3588 predefined entities like &amp;copy; for the Copyright sign.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3589</ol>
3590
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3591<p>More over when compiled on an Unix platform with iconv support the full
3592set of encodings supported by iconv can be instantly be used by libxml. On a
3593linux machine with glibc-2.1 the list of supported encodings and aliases fill
35943 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
3595various Japanese ones.</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]3596
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3597<p>To convert from the UTF-8 values returned from the API to another encoding
3598then it is possible to use the function provided from <a
3599href="html/libxml-encoding.html">the encoding module</a> like <a
3600href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the
3601POSIX <a
3602href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>
3603API directly.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3604
3605<h4>Encoding aliases</h4>
3606
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3607<p>From 2.2.3, libxml2 has support to register encoding names aliases. The
3608goal is to be able to parse document whose encoding is supported but where
3609the name differs (for example from the default set of names accepted by
3610iconv). The following functions allow to register and handle new aliases for
3611existing encodings. Once registered libxml2 will automatically lookup the
3612aliases when handling a document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3613<ul>
3614 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
3615 <li>int xmlDelEncodingAlias(const char *alias);</li>
3616 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
3617 <li>void xmlCleanupEncodingAliases(void);</li>
3618</ul>
3619
3620<h3><a name="extend">How to extend the existing support</a></h3>
3621
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3622<p>Well adding support for new encoding, or overriding one of the encoders
3623(assuming it is buggy) should not be hard, just write input and output
3624conversion routines to/from UTF-8, and register them using
3625xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
3626called automatically if the parser(s) encounter such an encoding name
3627(register it uppercase, this will help). The description of the encoders,
3628their arguments and expected return values are described in the encoding.h
3629header.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3630
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3631<h2><a name="IO">I/O Interfaces</a></h2>
3632
3633<p>Table of Content:</p>
3634<ol>
3635 <li><a href="#General1">General overview</a></li>
3636 <li><a href="#basic">The basic buffer type</a></li>
3637 <li><a href="#Input">Input I/O handlers</a></li>
3638 <li><a href="#Output">Output I/O handlers</a></li>
3639 <li><a href="#entities">The entities loader</a></li>
3640 <li><a href="#Example2">Example of customized I/O</a></li>
3641</ol>
3642
3643<h3><a name="General1">General overview</a></h3>
3644
3645<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3646href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
3647the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3648<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3649 <li>Entities loader, this is a routine which tries to fetch the entities
3650 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
3651 don't look at the public identifier since libxml2 do not maintain a
3652 catalog. You can redefine you own entity loader by using
3653 <code>xmlGetExternalEntityLoader()</code> and
3654 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
3655 example</a>.</li>
3656 <li>Input I/O buffers which are a commodity structure used by the parser(s)
3657 input layer to handle fetching the informations to feed the parser. This
3658 provides buffering and is also a placeholder where the encoding
3659 converters to UTF8 are piggy-backed.</li>
3660 <li>Output I/O buffers are similar to the Input ones and fulfill similar
3661 task but when generating a serialization from a tree.</li>
3662 <li>A mechanism to register sets of I/O callbacks and associate them with
3663 specific naming schemes like the protocol part of the URIs.
3664 <p>This affect the default I/O operations and allows to use specific I/O
3665 handlers for certain names.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3666 </li>
3667</ul>
3668
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3669<p>The general mechanism used when loading http://rpmfind.net/xml.html for
3670example in the HTML parser is the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3671<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3672 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
3673 the parsing context and the URI string.</li>
3674 <li>the URI string is checked against the existing registered handlers
3675 using their match() callback function, if the HTTP module was compiled
3676 in, it is registered and its match() function will succeeds</li>
3677 <li>the open() function of the handler is called and if successful will
3678 return an I/O Input buffer</li>
3679 <li>the parser will the start reading from this buffer and progressively
3680 fetch information from the resource, calling the read() function of the
3681 handler until the resource is exhausted</li>
3682 <li>if an encoding change is detected it will be installed on the input
3683 buffer, providing buffering and efficient use of the conversion
3684 routines</li>
3685 <li>once the parser has finished, the close() function of the handler is
3686 called once and the Input buffer and associated resources are
3687 deallocated.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3688</ol>
3689
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3690<p>The user defined callbacks are checked first to allow overriding of the
3691default libxml2 I/O routines.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3692
3693<h3><a name="basic">The basic buffer type</a></h3>
3694
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3695<p>All the buffer manipulation handling is done using the
3696<code>xmlBuffer</code> type define in <code><a
3697href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
3698resizable memory buffer. The buffer allocation strategy can be selected to be
3699either best-fit or use an exponential doubling one (CPU vs. memory use
3700trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
3701<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
3702system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
3703of functions allows to manipulate buffers with names starting with the
3704<code>xmlBuffer...</code> prefix.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3705
3706<h3><a name="Input">Input I/O handlers</a></h3>
3707
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3708<p>An Input I/O handler is a simple structure
3709<code>xmlParserInputBuffer</code> containing a context associated to the
3710resource (file descriptor, or pointer to a protocol handler), the read() and
3711close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
3712encoding handler are also present to support charset conversion when
3713needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3714
3715<h3><a name="Output">Output I/O handlers</a></h3>
3716
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3717<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
3718Input one except the callbacks are write() and close().</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3719
3720<h3><a name="entities">The entities loader</a></h3>
3721
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3722<p>The entity loader resolves requests for new entities and create inputs for
3723the parser. Creating an input from a filename or an URI string is done
3724through the xmlNewInputFromFile() routine. The default entity loader do not
3725handle the PUBLIC identifier associated with an entity (if any). So it just
3726calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
3727XML).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3728
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3729<p>If you want to hook up a catalog mechanism then you simply need to
3730override the default entity loader, here is an example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3731<pre>#include &lt;libxml/xmlIO.h&gt;
3732
3733xmlExternalEntityLoader defaultLoader = NULL;
3734
3735xmlParserInputPtr
3736xmlMyExternalEntityLoader(const char *URL, const char *ID,
3737 xmlParserCtxtPtr ctxt) {
3738 xmlParserInputPtr ret;
3739 const char *fileID = NULL;
3740 /* lookup for the fileID depending on ID */
3741
3742 ret = xmlNewInputFromFile(ctxt, fileID);
3743 if (ret != NULL)
3744 return(ret);
3745 if (defaultLoader != NULL)
3746 ret = defaultLoader(URL, ID, ctxt);
3747 return(ret);
3748}
3749
3750int main(..) {
3751 ...
3752
3753 /*
3754 * Install our own entity loader
3755 */
3756 defaultLoader = xmlGetExternalEntityLoader();
3757 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
3758
3759 ...
3760}</pre>
3761
3762<h3><a name="Example2">Example of customized I/O</a></h3>
3763
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3764<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
3765real use case</a>, xmlDocDump() closes the FILE * passed by the application
3766and this was a problem. The <a
3767href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
3768new output handler with the closing call deactivated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3769<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3770 <li>First define a new I/O output allocator where the output don't close
3771 the file:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3772 <pre>xmlOutputBufferPtr
3773xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3774&nbsp;&nbsp;&nbsp;&nbsp;xmlOutputBufferPtr ret;
3775&nbsp;&nbsp;&nbsp;&nbsp;
3776&nbsp;&nbsp;&nbsp;&nbsp;if (xmlOutputCallbackInitialized == 0)
3777&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlRegisterDefaultOutputCallbacks();
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3778
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3779&nbsp;&nbsp;&nbsp;&nbsp;if (file == NULL) return(NULL);
3780&nbsp;&nbsp;&nbsp;&nbsp;ret = xmlAllocOutputBuffer(encoder);
3781&nbsp;&nbsp;&nbsp;&nbsp;if (ret != NULL) {
3782&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;context = file;
3783&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;writecallback = xmlFileWrite;
3784&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;closecallback = NULL; /* No close callback */
3785&nbsp;&nbsp;&nbsp;&nbsp;}
3786&nbsp;&nbsp;&nbsp;&nbsp;return(ret);
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3787} </pre>
3788 </li>
3789 <li>And then use it to save the document:
3790 <pre>FILE *f;
3791xmlOutputBufferPtr output;
3792xmlDocPtr doc;
3793int res;
3794
3795f = ...
3796doc = ....
3797
3798output = xmlOutputBufferCreateOwn(f, NULL);
3799res = xmlSaveFileTo(output, doc, NULL);
3800 </pre>
3801 </li>
3802</ol>
3803
3804<h2><a name="Catalog">Catalog support</a></h2>
3805
3806<p>Table of Content:</p>
3807<ol>
3808 <li><a href="General2">General overview</a></li>
3809 <li><a href="#definition">The definition</a></li>
3810 <li><a href="#Simple">Using catalogs</a></li>
3811 <li><a href="#Some">Some examples</a></li>
3812 <li><a href="#reference">How to tune catalog usage</a></li>
3813 <li><a href="#validate">How to debug catalog processing</a></li>
3814 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3815 <li><a href="#implemento">The implementor corner quick review of the
3816 API</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3817 <li><a href="#Other">Other resources</a></li>
3818</ol>
3819
3820<h3><a name="General2">General overview</a></h3>
3821
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3822<p>What is a catalog? Basically it's a lookup mechanism used when an entity
3823(a file or a remote resource) references another entity. The catalog lookup
3824is inserted between the moment the reference is recognized by the software
3825(XML parser, stylesheet processing, or even images referenced for inclusion
3826in a rendering) and the time where loading that resource is actually
3827started.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3828
3829<p>It is basically used for 3 things:</p>
3830<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3831 <li>mapping from "logical" names, the public identifiers and a more
3832 concrete name usable for download (and URI). For example it can associate
3833 the logical name
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3834 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3835 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
3836 downloaded</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3837 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
3838 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3839 <li>remapping from a given URL to another one, like an HTTP indirection
3840 saying that
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3841 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
3842 <p>should really be looked at</p>
3843 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
3844 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3845 <li>providing a local cache mechanism allowing to load the entities
3846 associated to public identifiers or remote resources, this is a really
3847 important feature for any significant deployment of XML or SGML since it
3848 allows to avoid the aleas and delays associated to fetching remote
3849 resources.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3850</ul>
3851
3852<h3><a name="definition">The definitions</a></h3>
3853
3854<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
3855<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3856 <li>the older SGML catalogs, the official spec is SGML Open Technical
3857 Resolution TR9401:1997, but is better understood by reading <a
3858 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
3859 James Clark. This is relatively old and not the preferred mode of
3860 operation of libxml.</li>
3861 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
3862 Catalogs</a> is far more flexible, more recent, uses an XML syntax and
3863 should scale quite better. This is the default option of libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3864</ul>
3865
3866<p></p>
3867
3868<h3><a name="Simple">Using catalog</a></h3>
3869
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3870<p>In a normal environment libxml2 will by default check the presence of a
3871catalog in /etc/xml/catalog, and assuming it has been correctly populated,
3872the processing is completely transparent to the document user. To take a
3873concrete example, suppose you are authoring a DocBook document, this one
3874starts with the following DOCTYPE definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3875<pre>&lt;?xml version='1.0'?&gt;
3876&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
3877 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
3878
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3879<p>When validating the document with libxml, the catalog will be
3880automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
3881DocBk XML V3.1.4//EN" and the system identifier
3882"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
3883been installed on your system and the catalogs actually point to them, libxml
3884will fetch them from the local disk.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3885
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3886<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
3887DOCTYPE example it's a really old version, but is fine as an example.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3888
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3889<p>Libxml2 will check the catalog each time that it is requested to load an
3890entity, this includes DTD, external parsed entities, stylesheets, etc ... If
3891your system is correctly configured all the authoring phase and processing
3892should use only local files, even if your document stays portable because it
3893uses the canonical public and system ID, referencing the remote document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3894
3895<h3><a name="Some">Some examples:</a></h3>
3896
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3897<p>Here is a couple of fragments from XML Catalogs used in libxml2 early
3898regression tests in <code>test/catalogs</code> :</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3899<pre>&lt;?xml version="1.0"?&gt;
3900&lt;!DOCTYPE catalog PUBLIC
3901 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
3902 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
3903&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
3904 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
3905 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
3906...</pre>
3907
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3908<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
3909written in XML, there is a specific namespace for catalog elements
3910"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
3911catalog is a <code>public</code> mapping it allows to associate a Public
3912Identifier with an URI.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3913<pre>...
3914 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
3915 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
3916...</pre>
3917
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3918<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
3919any URI starting with a given prefix should be looked at another URI
3920constructed by replacing the prefix with an new one. In effect this acts like
3921a cache system for a full area of the Web. In practice it is extremely useful
3922with a file prefix if you have installed a copy of those resources on your
3923local system.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3924<pre>...
3925&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
3926 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3927&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
3928 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3929&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
3930 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3931&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
3932 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3933&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
3934 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3935...</pre>
3936
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3937<p>Delegation is the core features which allows to build a tree of catalogs,
3938easier to maintain than a single catalog, based on Public Identifier, System
3939Identifier or URI prefixes it instructs the catalog software to look up
3940entries in another resource. This feature allow to build hierarchies of
3941catalogs, the set of entries presented should be sufficient to redirect the
3942resolution of all DocBook references to the specific catalog in
3943<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
3944references for DocBook 4.2.1 to a specific catalog installed at the same time
3945as the DocBook resources on the local machine.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3946
3947<h3><a name="reference">How to tune catalog usage:</a></h3>
3948
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3949<p>The user can change the default catalog behaviour by redirecting queries
3950to its own set of catalogs, this can be done by setting the
3951<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
3952empty one should deactivate loading the default <code>/etc/xml/catalog</code>
3953default catalog</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3954
3955<h3><a name="validate">How to debug catalog processing:</a></h3>
3956
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3957<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
3958make libxml2 output debugging informations for each catalog operations, for
3959example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3960<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
3961warning: failed to load external entity "title.xml"
3962orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
3963orchis:~/XML -&gt; xmllint --memory --noout test/ent2
3964Failed to parse catalog /etc/xml/catalog
3965Failed to parse catalog /etc/xml/catalog
3966warning: failed to load external entity "title.xml"
3967Catalogs cleanup
3968orchis:~/XML -&gt; </pre>
3969
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3970<p>The test/ent2 references an entity, running the parser from memory makes
3971the base URI unavailable and the the "title.xml" entity cannot be loaded.
3972Setting up the debug environment variable allows to detect that an attempt is
3973made to load the <code>/etc/xml/catalog</code> but since it's not present the
3974resolution fails.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3975
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3976<p>But the most advanced way to debug XML catalog processing is to use the
3977<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
3978catalogs and make resolution queries to see what is going on. This is also
3979used for the regression tests:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3980<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
3981 "-//OASIS//DTD DocBook XML V4.1.2//EN"
3982http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
3983orchis:~/XML -&gt; </pre>
3984
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3985<p>For debugging what is going on, adding one -v flags increase the verbosity
3986level to indicate the processing done (adding a second flag also indicate
3987what elements are recognized at parsing):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3988<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
3989 "-//OASIS//DTD DocBook XML V4.1.2//EN"
3990Parsing catalog test/catalogs/docbook.xml's content
3991Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
3992http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
3993Catalogs cleanup
3994orchis:~/XML -&gt; </pre>
3995
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3996<p>A shell interface is also available to debug and process multiple queries
3997(and for regression tests):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3998<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
3999 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4000&gt; help
4001Commands available:
4002public PublicID: make a PUBLIC identifier lookup
4003system SystemID: make a SYSTEM identifier lookup
4004resolve PublicID SystemID: do a full resolver lookup
4005add 'type' 'orig' 'replace' : add an entry
4006del 'values' : remove values
4007dump: print the current catalog state
4008debug: increase the verbosity level
4009quiet: decrease the verbosity level
4010exit: quit the shell
4011&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
4012http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4013&gt; quit
4014orchis:~/XML -&gt; </pre>
4015
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4016<p>This should be sufficient for most debugging purpose, this was actually
4017used heavily to debug the XML Catalog implementation itself.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4018
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4019<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4020
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4021<p>Basically XML Catalogs are XML files, you can either use XML tools to
4022manage them or use <strong>xmlcatalog</strong> for this. The basic step is
4023to create a catalog the -create option provide this facility:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4024<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
4025&lt;?xml version="1.0"?&gt;
4026&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4027 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4028&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4029orchis:~/XML -&gt; </pre>
4030
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4031<p>By default xmlcatalog does not overwrite the original catalog and save the
4032result on the standard output, this can be overridden using the -noout
4033option. The <code>-add</code> command allows to add entries in the
4034catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4035<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
4036 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
4037 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
4038orchis:~/XML -&gt; cat tst.xml
4039&lt;?xml version="1.0"?&gt;
4040&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
4041 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4042&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4043&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4044 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4045&lt;/catalog&gt;
4046orchis:~/XML -&gt; </pre>
4047
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4048<p>The <code>-add</code> option will always take 3 parameters even if some of
4049the XML Catalog constructs (like nextCatalog) will have only a single
4050argument, just pass a third empty string, it will be ignored.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4051
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4052<p>Similarly the <code>-del</code> option remove matching entries from the
4053catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4054<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
4055 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
4056&lt;?xml version="1.0"?&gt;
4057&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4058 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4059&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4060orchis:~/XML -&gt; </pre>
4061
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4062<p>The catalog is now empty. Note that the matching of <code>-del</code> is
4063exact and would have worked in a similar fashion with the Public ID
4064string.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4065
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4066<p>This is rudimentary but should be sufficient to manage a not too complex
4067catalog tree of resources.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4068
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4069<h3><a name="implemento">The implementor corner quick review of the
4070API:</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4071
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4072<p>First, and like for every other module of libxml, there is an
4073automatically generated <a href="html/libxml-catalog.html">API page for
4074catalog support</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4075
4076<p>The header for the catalog interfaces should be included as:</p>
4077<pre>#include &lt;libxml/catalog.h&gt;</pre>
4078
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4079<p>The API is voluntarily kept very simple. First it is not obvious that
4080applications really need access to it since it is the default behaviour of
4081libxml2 (Note: it is possible to completely override libxml2 default catalog
4082by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
4083plug an application specific resolver).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4084
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4085<p>Basically libxml2 support 2 catalog lists:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4086<ul>
4087 <li>the default one, global shared by all the application</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4088 <li>a per-document catalog, this one is built if the document uses the
4089 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
4090 associated to the parser context and destroyed when the parsing context
4091 is destroyed.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4092</ul>
4093
4094<p>the document one will be used first if it exists.</p>
4095
4096<h4>Initialization routines:</h4>
4097
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4098<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
4099used at startup to initialize the catalog, if the catalog should be
4100initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
4101should be called before xmlInitializeCatalog() which would otherwise do a
4102default initialization first.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4103
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4104<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
4105own catalog list if needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4106
4107<h4>Preferences setup:</h4>
4108
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4109<p>The XML Catalog spec requires the possibility to select default
4110preferences between public and system delegation,
4111xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
4112xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
4113be forbidden, allowed for global catalog, for document catalog or both, the
4114default is to allow both.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4115
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4116<p>And of course xmlCatalogSetDebug() allows to generate debug messages
4117(through the xmlGenericError() mechanism).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4118
4119<h4>Querying routines:</h4>
4120
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4121<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
4122and xmlCatalogResolveURI() are relatively explicit if you read the XML
4123Catalog specification they correspond to section 7 algorithms, they should
4124also work if you have loaded an SGML catalog with a simplified semantic.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4125
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4126<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
4127operate on the document catalog list</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4128
4129<h4>Cleanup and Miscellaneous:</h4>
4130
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4131<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
4132the per-document equivalent.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4133
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4134<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
4135first catalog in the global list, and xmlCatalogDump() allows to dump a
4136catalog state, those routines are primarily designed for xmlcatalog, I'm not
4137sure that exposing more complex interfaces (like navigation ones) would be
4138really useful.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4139
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4140<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
4141it's similar as xmlParseFile() except it bypass all catalog lookups, it's
4142provided because this functionality may be useful for client tools.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4143
4144<h4>threaded environments:</h4>
4145
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4146<p>Since the catalog tree is built progressively, some care has been taken to
4147try to avoid troubles in multithreaded environments. The code is now thread
4148safe assuming that the libxml2 library has been compiled with threads
4149support.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4150
4151<p></p>
4152
4153<h3><a name="Other">Other resources</a></h3>
4154
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4155<p>The XML Catalog specification is relatively recent so there isn't much
4156literature to point at:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4157<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4158 <li>You can find a good rant from Norm Walsh about <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4159 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
4160 need for catalogs</a>, it provides a lot of context informations even if
4161 I don't agree with everything presented. Norm also wrote a more recent
4162 article <a
4163 href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
4164 entities and URI resolvers</a> describing them.</li>
4165 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
4166 catalog proposal</a> from John Cowan</li>
4167 <li>The <a href="http://www.rddl.org/">Resource Directory Description
4168 Language</a> (RDDL) another catalog system but more oriented toward
4169 providing metadata for XML namespaces.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4170 <li>the page from the OASIS Technical <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4171 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
4172 Resolution</a> who maintains XML Catalog, you will find pointers to the
4173 specification update, some background and pointers to others tools
4174 providing XML Catalog support</li>
4175 <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
4176 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
4177 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
4178 the resources found on the system. Otherwise it will just create
4179 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillard8594de92003-04-25 10:08:44 +0000[diff] [blame]4180 <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4181 <p>should allow to process DocBook documentations without requiring
4182 network accesses for the DTD or stylesheets</p>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]4183 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4184 <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
4185 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
4186 to work fine for me too</li>
4187 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
4188 manual page</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4189</ul>
4190
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4191<p>If you have suggestions for corrections or additions, simply contact
4192me:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4193
4194<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4195
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4196<p>This section is directly intended to help programmers getting bootstrapped
4197using the XML tollkit from the C language. It is not intended to be
4198extensive. I hope the automatically generated documents will provide the
4199completeness required, but as a separate set of documents. The interfaces of
4200the XML parser are by principle low level, Those interested in a higher level
4201API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]4202
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4203<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
4204separated from the <a href="html/libxml-htmlparser.html">HTML parser
4205interfaces</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]4206
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4207<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4208
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4209<p>Usually, the first thing to do is to read an XML input. The parser accepts
4210documents either from in-memory strings or from files. The functions are
4211defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4212<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4213 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4214 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4215 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4216</dl>
4217<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4218 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4219 <dd><p>Parse an XML document contained in a (possibly compressed)
4220 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4221 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4222</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4223
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4224<p>The parser returns a pointer to the document structure (or NULL in case of
4225failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4226
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4227<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4228
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4229<p>In order for the application to keep the control when the document is
4230being fetched (which is common for GUI based programs) libxml2 provides a
4231push interface, too, as of version 1.8.3. Here are the interface
4232functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4233<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
4234 void *user_data,
4235 const char *chunk,
4236 int size,
4237 const char *filename);
4238int xmlParseChunk (xmlParserCtxtPtr ctxt,
4239 const char *chunk,
4240 int size,
4241 int terminate);</pre>
4242
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4243<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4244<pre> FILE *f;
4245
4246 f = fopen(filename, "r");
4247 if (f != NULL) {
4248 int res, size = 1024;
4249 char chars[1024];
4250 xmlParserCtxtPtr ctxt;
4251
4252 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4253 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4254 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
4255 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4256 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4257 xmlParseChunk(ctxt, chars, res, 0);
4258 }
4259 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4260 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4261 xmlFreeParserCtxt(ctxt);
4262 }
4263 }</pre>
4264
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4265<p>The HTML parser embedded into libxml2 also has a push interface; the
4266functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4267
4268<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
4269
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4270<p>The tree-building interface makes the parser memory-hungry, first loading
4271the document in memory and then building the tree itself. Reading a document
4272without building the tree is possible using the SAX interfaces (see SAX.h and
4273<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
4274Henstridge's documentation</a>). Note also that the push interface can be
4275limited to SAX: just use the two first arguments of
4276<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]4277
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4278<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4279
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4280<p>The other way to get an XML tree in memory is by building it. Basically
4281there is a set of functions dedicated to building new elements. (These are
4282also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
4283code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4284<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]4285 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4286 xmlNodePtr tree, subtree;
4287
4288 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4289 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
4290 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
4291 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
4292 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4293 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4294 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4295 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
4296 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
4297 subtree = xmlNewChild(tree, NULL, "image", NULL);
4298 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4299
4300<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4301
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4302<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4303
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4304<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
4305code has access to the internal structure of all the elements of the tree.
4306The names should be somewhat simple like <strong>parent</strong>,
4307<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
4308<strong>properties</strong>, etc... For example, still with the previous
4309example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4310<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4311
4312<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4313<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4314
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4315<p>points to the text node containing the chapter title "The Linux
4316adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4317
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4318<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
4319present before the document root, so <code>doc-&gt;children</code> may point
4320to an element which is not the document Root Element; a function
4321<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]4322
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4323<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4324
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4325<p>Functions are provided for reading and writing the document content. Here
4326is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4327<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4328 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
4329 xmlChar *value);</code></dt>
4330 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
4331 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4332 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4333</dl>
4334<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4335 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
4336 *name);</code></dt>
4337 <dd><p>This function returns a pointer to new copy of the property
4338 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4339 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4340</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4341
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4342<p>Two functions are provided for reading and writing the text associated
4343with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4344<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4345 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
4346 *value);</code></dt>
4347 <dd><p>This function takes an "external" string and converts it to one
4348 text node or possibly to a list of entity and text nodes. All
4349 non-predefined entity references like &amp;Gnome; will be stored
4350 internally as entity nodes, hence the result of the function may not be
4351 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4352 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4353</dl>
4354<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4355 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
4356 inLine);</code></dt>
4357 <dd><p>This function is the inverse of
4358 <code>xmlStringGetNodeList()</code>. It generates a new string
4359 containing the content of the text and entity nodes. Note the extra
4360 argument inLine. If this argument is set to 1, the function will expand
4361 entity references. For example, instead of returning the &amp;Gnome;
4362 XML encoding in the string, it will substitute it with its value (say,
4363 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4364 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4365</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4366
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4367<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4368
4369<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4370<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4371 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
4372 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4373 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4374 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4375</dl>
4376<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4377 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4378 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4379 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4380</dl>
4381<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4382 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4383 <dd><p>Saves the document to a file. In this case, the compression
4384 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4385 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4386</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4387
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4388<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4389
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4390<p>The library transparently handles compression when doing file-based
4391accesses. The level of compression on saves can be turned on either globally
4392or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4393<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4394 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4395 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4396 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4397</dl>
4398<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4399 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4400 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4401 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4402</dl>
4403<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4404 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4405 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4406 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4407</dl>
4408<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4409 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4410 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4411 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4412</dl>
4413
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4414<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4415
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4416<p>Entities in principle are similar to simple C macros. An entity defines an
4417abbreviation for a given string that you can reuse many times throughout the
4418content of your document. Entities are especially useful when a given string
4419may occur frequently within a document, or to confine the change needed to a
4420document to a restricted area in the internal subset of the document (at the
4421beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4422<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]44232 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]44243 &lt;!ENTITY xml "Extensible Markup Language"&gt;
44254 ]&gt;
44265 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]44276 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]44287 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4429
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4430<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
4431its name with '&amp;' and following it by ';' without any spaces added. There
4432are 5 predefined entities in libxml2 allowing you to escape characters with
4433predefined meaning in some parts of the xml document content:
4434<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
4435for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
4436<strong>&amp;quot;</strong> for the character '"', and
4437<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4438
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4439<p>One of the problems related to entities is that you may want the parser to
4440substitute an entity's content so that you can see the replacement text in
4441your application. Or you may prefer to keep entity references as such in the
4442content to be able to save the document back without losing this usually
4443precious information (if the user went through the pain of explicitly
4444defining entities, he may have a a rather negative attitude if you blindly
4445substitute them as saving time). The <a
4446href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
4447function allows you to check and change the behaviour, which is to not
4448substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4449
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4450<p>Here is the DOM tree built by libxml2 for the previous document in the
4451default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4452<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4453DOCUMENT
4454version=1.0
4455 ELEMENT EXAMPLE
4456 TEXT
4457 content=
4458 ENTITY_REF
4459 INTERNAL_GENERAL_ENTITY xml
4460 content=Extensible Markup Language
4461 TEXT
4462 content=</pre>
4463
4464<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4465<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4466DOCUMENT
4467version=1.0
4468 ELEMENT EXAMPLE
4469 TEXT
4470 content= Extensible Markup Language</pre>
4471
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4472<p>So, entities or no entities? Basically, it depends on your use case. I
4473suggest that you keep the non-substituting default behaviour and avoid using
4474entities in your XML document or data if you are not willing to handle the
4475entity references elements in the DOM tree.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4476
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4477<p>Note that at save time libxml2 enforces the conversion of the predefined
4478entities where necessary to prevent well-formedness problems, and will also
4479transparently replace those with chars (i.e. it will not generate entity
4480reference elements in the DOM tree or call the reference() SAX callback when
4481finding them in the input).</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4482
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4483<p><span style="background-color: #FF0000">WARNING</span>: handling entities
4484on top of the libxml2 SAX interface is difficult!!! If you plan to use
4485non-predefined entities in your documents, then the learning curve to handle
4486then using the SAX API may be long. If you plan to use complex documents, I
4487strongly suggest you consider using the DOM interface instead and let libxml
4488deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]4489
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4490<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4491
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4492<p>The libxml2 library implements <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4493href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
4494recognizing namespace constructs in the input, and does namespace lookup
4495automatically when building the DOM tree. A namespace declaration is
4496associated with an in-memory structure and all elements or attributes within
4497that namespace point to it. Hence testing the namespace is a simple and fast
4498equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4499
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4500<p>I suggest that people using libxml2 use a namespace, and declare it in the
4501root element of their document as the default namespace. Then they don't need
4502to use the prefix in the content but we will have a basis for future semantic
4503refinement and merging of data from different sources. This doesn't increase
4504the size of the XML output significantly, but significantly increases its
4505value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4506<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
4507 &lt;elem1&gt;...&lt;/elem1&gt;
4508 &lt;elem2&gt;...&lt;/elem2&gt;
4509&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4510
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4511<p>The namespace value has to be an absolute URL, but the URL doesn't have to
4512point to any existing resource on the Web. It will bind all the element and
4513attributes with that URL. I suggest to use an URL within a domain you
4514control, and that the URL should contain some kind of version information if
4515possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
4516good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]4517
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4518<p>Then when you load a file, make sure that a namespace carrying the
4519version-independent prefix is installed on the root element of your document,
4520and if the version information don't match something you know, warn the user
4521and be liberal in what you accept as the input. Also do *not* try to base
4522namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
4523same as &lt;bar:text&gt; in another document. What really matters is the URI
4524associated with the element or the attribute, not the prefix string (which is
4525just a shortcut for the full URI). In libxml, element and attributes have an
4526<code>ns</code> field pointing to an xmlNs structure detailing the namespace
4527prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4528
4529<p>@@Interfaces@@</p>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4530<pre>xmlNodePtr node;
Daniel Veillardfc8dc352003-10-18 09:07:46 +0000[diff] [blame]4531if(!strncmp(node-&gt;name,"mytag",5)
4532 &amp;&amp; node-&gt;ns
4533 &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
4534 ...
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4535}</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4536
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4537<p>Usually people object to using namespaces together with validity checking.
4538I will try to make sure that using namespaces won't break validity checking,
4539so even if you plan to use or currently are using validation I strongly
4540suggest adding namespaces to your document. A default namespace scheme
4541<code>xmlns="http://...."</code> should not break validity even on less
4542flexible parsers. Using namespaces to mix and differentiate content coming
4543from multiple DTDs will certainly break current validation schemes. To check
4544such documents one needs to use schema-validation, which is supported in
4545libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4546href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4547
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4548<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4549
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4550<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4551
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4552<p>Version 2 of libxml2 is the first version introducing serious backward
4553incompatible changes. The main goals were:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4554<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4555 <li>a general cleanup. A number of mistakes inherited from the very early
4556 versions couldn't be changed due to compatibility constraints. Example
4557 the "childs" element in the nodes.</li>
4558 <li>Uniformization of the various nodes, at least for their header and link
4559 parts (doc, parent, children, prev, next), the goal is a simpler
4560 programming model and simplifying the task of the DOM implementors.</li>
4561 <li>better conformances to the XML specification, for example version 1.x
4562 had an heuristic to try to detect ignorable white spaces. As a result the
4563 SAX event generated were ignorableWhitespace() while the spec requires
4564 character() in that case. This also mean that a number of DOM node
4565 containing blank text may populate the DOM tree which were not present
4566 before.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4567</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4568
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4569<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4570
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4571<p>So client code of libxml designed to run with version 1.x may have to be
4572changed to compile against version 2.x of libxml. Here is a list of changes
4573that I have collected, they may not be sufficient, so in case you find other
4574change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
4575mail</a>:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4576<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4577 <li>The package name have changed from libxml to libxml2, the library name
4578 is now -lxml2 . There is a new xml2-config script which should be used to
4579 select the right parameters libxml2</li>
4580 <li>Node <strong>childs</strong> field has been renamed
4581 <strong>children</strong> so s/childs/children/g should be applied
4582 (probability of having "childs" anywhere else is close to 0+</li>
4583 <li>The document don't have anymore a <strong>root</strong> element it has
4584 been replaced by <strong>children</strong> and usually you will get a
4585 list of element here. For example a Dtd element for the internal subset
4586 and it's declaration may be found in that list, as well as processing
4587 instructions or comments found before or after the document root element.
4588 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
4589 a document. Alternatively if you are sure to not reference DTDs nor have
4590 PIs or comments before or after the root element
4591 s/-&gt;root/-&gt;children/g will probably do it.</li>
4592 <li>The white space issue, this one is more complex, unless special case of
4593 validating parsing, the line breaks and spaces usually used for indenting
4594 and formatting the document content becomes significant. So they are
4595 reported by SAX and if your using the DOM tree, corresponding nodes are
4596 generated. Too approach can be taken:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4597 <ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4598 <li>lazy one, use the compatibility call
4599 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
4600 relying on a special (and possibly broken) set of heuristics of
4601 libxml to detect ignorable blanks. Don't complain if it breaks or
4602 make your application not 100% clean w.r.t. to it's input.</li>
4603 <li>the Right Way: change you code to accept possibly insignificant
4604 blanks characters, or have your tree populated with weird blank text
4605 nodes. You can spot them using the commodity function
4606 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
4607 nodes.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4608 </ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4609 <p>Note also that with the new default the output functions don't add any
4610 extra indentation when saving a tree in order to be able to round trip
4611 (read and save) without inflating the document with extra formatting
4612 chars.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4613 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4614 <li>The include path has changed to $prefix/libxml/ and the includes
4615 themselves uses this new prefix in includes instructions... If you are
4616 using (as expected) the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4617 <pre>xml2-config --cflags</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4618 <p>output to generate you compile commands this will probably work out of
4619 the box</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4620 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4621 <li>xmlDetectCharEncoding takes an extra argument indicating the length in
4622 byte of the head of the document available for character detection.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4623</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4624
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4625<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4626
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4627<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
4628to allow smooth upgrade of existing libxml v1code while retaining
4629compatibility. They offers the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4630<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4631 <li>similar include naming, one should use
4632 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
4633 <li>similar identifiers defined via macros for the child and root fields:
4634 respectively <strong>xmlChildrenNode</strong> and
4635 <strong>xmlRootNode</strong></li>
4636 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
4637 inserted once in the client code</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4638</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4639
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4640<p>So the roadmap to upgrade your existing libxml applications is the
4641following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4642<ol>
4643 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4644 <li>find all occurrences where the xmlDoc <strong>root</strong> field is
4645 used and change it to <strong>xmlRootNode</strong></li>
4646 <li>similarly find all occurrences where the xmlNode
4647 <strong>childs</strong> field is used and change it to
4648 <strong>xmlChildrenNode</strong></li>
4649 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
4650 <strong>main()</strong> or in the library init entry point</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4651 <li>Recompile, check compatibility, it should still work</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4652 <li>Change your configure script to look first for xml2-config and fall
4653 back using xml-config . Use the --cflags and --libs output of the command
4654 as the Include and Linking parameters needed to use libxml.</li>
4655 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
4656 libxml-devel-1.8.y can be kept simultaneously)</li>
4657 <li>remove your config.cache, relaunch your configuration mechanism, and
4658 recompile, if steps 2 and 3 were done right it should compile as-is</li>
4659 <li>Test that your application is still running correctly, if not this may
4660 be due to extra empty nodes due to formating spaces being kept in libxml2
4661 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
4662 code before calling the parser (next to
4663 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4664</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4665
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4666<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]4667
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4668<p>Let me put some emphasis on the fact that there is far more changes from
4669libxml 1.x to 2.x than the ones you may have to patch for. The overall code
4670has been considerably cleaned up and the conformance to the XML specification
4671has been drastically improved too. Don't take those changes as an excuse to
4672not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4673
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4674<h2><a name="Thread">Thread safety</a></h2>
4675
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4676<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
4677threads can safely work in parallel parsing different documents. There is
4678however a couple of things to do to ensure it:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4679<ul>
4680 <li>configure the library accordingly using the --with-threads options</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4681 <li>call xmlInitParser() in the "main" thread before using any of the
4682 libxml2 API (except possibly selecting a different memory allocator)</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4683</ul>
4684
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4685<p>Note that the thread safety cannot be ensured for multiple threads sharing
4686the same document, the locking must be done at the application level, libxml
4687exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
4688The parts of the library checked for thread safety are:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4689<ul>
4690 <li>concurrent loading</li>
4691 <li>file access resolution</li>
4692 <li>catalog access</li>
4693 <li>catalog building</li>
4694 <li>entities lookup/accesses</li>
4695 <li>validation</li>
4696 <li>global variables per-thread override</li>
4697 <li>memory handling</li>
4698</ul>
4699
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4700<p>XPath is supposed to be thread safe now, but this wasn't tested
4701seriously.</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4702
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]4703<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4704
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4705<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
4706Object Model</em>; this is an API for accessing XML or HTML structured
4707documents. Native support for DOM in Gnome is on the way (module gnome-dom),
4708and will be based on gnome-xml. This will be a far cleaner interface to
4709manipulate XML files within Gnome since it won't expose the internal
4710structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4711
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4712<p>The current DOM implementation on top of libxml2 is the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4713href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
4714is a full DOM interface, thanks to Paolo Casarini, check the <a
4715href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
4716informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4717
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]4718<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4719
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4720<p>Here is a real size example, where the actual content of the application
4721data is not kept in the DOM tree but uses internal structures. It is based on
4722a proposal to keep a database of jobs related to Gnome, with an XML based
4723storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
4724base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4725<pre>&lt;?xml version="1.0"?&gt;
4726&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
4727 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4728
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4729 &lt;gjob:Job&gt;
4730 &lt;gjob:Project ID="3"/&gt;
4731 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
4732 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4733
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4734 &lt;gjob:Update&gt;
4735 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
4736 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
4737 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
4738 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4739
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4740 &lt;gjob:Developers&gt;
4741 &lt;gjob:Developer&gt;
4742 &lt;/gjob:Developer&gt;
4743 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4744
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4745 &lt;gjob:Contact&gt;
4746 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
4747 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
4748 &lt;gjob:Company&gt;
4749 &lt;/gjob:Company&gt;
4750 &lt;gjob:Organisation&gt;
4751 &lt;/gjob:Organisation&gt;
4752 &lt;gjob:Webpage&gt;
4753 &lt;/gjob:Webpage&gt;
4754 &lt;gjob:Snailmail&gt;
4755 &lt;/gjob:Snailmail&gt;
4756 &lt;gjob:Phone&gt;
4757 &lt;/gjob:Phone&gt;
4758 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4759
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4760 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4761 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4762 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4763
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4764 &lt;gjob:Skills&gt;
4765 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4766
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4767 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4768 A GNOME based system that will allow a superuser to configure
4769 compressed and uncompressed files and/or file systems to be backed
4770 up with a supported media in the system. This should be able to
4771 perform via find commands generating a list of files that are passed
4772 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
4773 or via operations performed on the filesystem itself. Email
4774 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4775 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4776
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4777 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4778
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4779 &lt;/gjob:Jobs&gt;
4780&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4781
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4782<p>While loading the XML file into an internal DOM tree is a matter of
4783calling only a couple of functions, browsing the tree to gather the data and
4784generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4785
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4786<p>The suggested principle is to be tolerant with respect to the input
4787structure. For example, the ordering of the attributes is not significant,
4788the XML specification is clear about it. It's also usually a good idea not to
4789depend on the order of the children of a given node, unless it really makes
4790things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4791<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4792 * A person record
4793 */
4794typedef struct person {
4795 char *name;
4796 char *email;
4797 char *company;
4798 char *organisation;
4799 char *smail;
4800 char *webPage;
4801 char *phone;
4802} person, *personPtr;
4803
4804/*
4805 * And the code needed to parse it
4806 */
4807personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
4808 personPtr ret = NULL;
4809
4810DEBUG("parsePerson\n");
4811 /*
4812 * allocate the struct
4813 */
4814 ret = (personPtr) malloc(sizeof(person));
4815 if (ret == NULL) {
4816 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4817 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4818 }
4819 memset(ret, 0, sizeof(person));
4820
4821 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4822 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4823 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4824 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
4825 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4826 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
4827 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4828 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4829 }
4830
4831 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4832}</pre>
4833
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4834<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4835<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4836 <li>Usually a recursive parsing style is the more convenient one: XML data
4837 is by nature subject to repetitive constructs and usually exhibits highly
4838 structured patterns.</li>
4839 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
4840 i.e. the pointer to the global XML document and the namespace reserved to
4841 the application. Document wide information are needed for example to
4842 decode entities and it's a good coding practice to define a namespace for
4843 your application set of data and test that the element and attributes
4844 you're analyzing actually pertains to your application space. This is
4845 done by a simple equality test (cur-&gt;ns == ns).</li>
4846 <li>To retrieve text and attributes value, you can use the function
4847 <em>xmlNodeListGetString</em> to gather all the text and entity reference
4848 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4849</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4850
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4851<p>Here is another piece of code used to parse another level of the
4852structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4853<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]4854/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4855 * a Description for a Job
4856 */
4857typedef struct job {
4858 char *projectID;
4859 char *application;
4860 char *category;
4861 personPtr contact;
4862 int nbDevelopers;
4863 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
4864} job, *jobPtr;
4865
4866/*
4867 * And the code needed to parse it
4868 */
4869jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
4870 jobPtr ret = NULL;
4871
4872DEBUG("parseJob\n");
4873 /*
4874 * allocate the struct
4875 */
4876 ret = (jobPtr) malloc(sizeof(job));
4877 if (ret == NULL) {
4878 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4879 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4880 }
4881 memset(ret, 0, sizeof(job));
4882
4883 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4884 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4885 while (cur != NULL) {
4886
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4887 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
4888 ret-&gt;projectID = xmlGetProp(cur, "ID");
4889 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4890 fprintf(stderr, "Project has no ID\n");
4891 }
4892 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4893 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
4894 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4895 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
4896 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4897 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
4898 ret-&gt;contact = parsePerson(doc, ns, cur);
4899 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4900 }
4901
4902 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4903}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4904
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4905<p>Once you are used to it, writing this kind of code is quite simple, but
4906boring. Ultimately, it could be possible to write stubbers taking either C
4907data structure definitions, a set of XML examples or an XML DTD and produce
4908the code needed to import and export the content between C data and XML
4909storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4910
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4911<p>Feel free to use <a href="example/gjobread.c">the code for the full C
4912parsing example</a> as a template, it is also available with Makefile in the
4913Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4914
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]4915<h2><a name="Contributi">Contributions</a></h2>
4916<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4917 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
4918 patches, Gary Pennington worked on the validation API, threading support
4919 and Solaris port.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4920 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4921 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
4922 maintainer of the Windows port, <a
4923 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
4924 binaries</a></li>
4925 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
4926 <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]4927 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4928 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
4929 Sergeant</a> developed <a
4930 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
4931 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
4932 application server</a></li>
4933 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
4934 href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
4935 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
4936 documentation</li>
4937 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]4938 href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +0000[diff] [blame]4939 <li>there is a module for <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4940 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
4941 in OpenNSD/AOLServer</a></li>
4942 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
4943 first version of libxml/libxslt <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]4944 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]4945 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4946 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
4947 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
4948 <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
4949 <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
4950 Digital Signature</a> <a
4951 href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
4952 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and
4953 contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
4954 bindings for libxml2 and libxslt</a>, as well as <a
4955 href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
4956 xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
4957 a GUI for xsltproc.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]4958</ul>
4959
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4960<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]4961</body>
4962</html>