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