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

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