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

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