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

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