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

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