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

blob: dcb7d6ea710fc93313e77b0dc141f4e98b935fb6 [file] [log] [blame]

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