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

blob: 638d1c9f409cb28609d35b946013ac8af089403b [file] [log] [blame]

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