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

blob: 07b545fe530e551b81ac4fa3e7fa3ef7fc197959 [file] [log] [blame]

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