Blame - doc/xml.html - platform/external/libxml2

blob: 8de026032e5a66ac9bd2476a5ae0c820a617fa19 [file] [log] [blame]

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