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

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