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