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

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