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

blob: 27e754b4f27c803903d5cbac28607259ff31da5e [file] [log] [blame]

Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
				2	"http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	3	<html>
				4	<head>
Daniel Veillard	ec78c0f	2000-08-25 10:25:23 +0000	[diff] [blame]	5	<title>The XML C library for Gnome</title>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	6	<meta name="GENERATOR" content="amaya V5.0">
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	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	11	<p><a href="http://www.gnome.org/"><img src="smallfootonly.gif"
				12	alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png"
Daniel Veillard	b370a74	2001-06-09 16:58:47 +0000	[diff] [blame]	13	alt="W3C Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif"
				14	alt="Red Hat Logo"></a></p>
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	15
Daniel Veillard	ec78c0f	2000-08-25 10:25:23 +0000	[diff] [blame]	16	<h1 align="center">The XML C library for Gnome</h1>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	17
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	18	<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
				19
				20	<p></p>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	21	<ul>
				22	<li><a href="#Introducti">Introduction</a></li>
				23	<li><a href="#Documentat">Documentation</a></li>
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	24	<li><a href="#Reporting">Reporting bugs and getting help</a></li>
				25	<li><a href="#help">how to help</a></li>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	26	<li><a href="#Downloads">Downloads</a></li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	27	<li><a href="#News">News</a></li>
				28	<li><a href="#XML">XML</a></li>
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	29	<li><a href="#XSLT">XSLT</a></li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	30	<li><a href="#tree">The tree output</a></li>
				31	<li><a href="#interface">The SAX interface</a></li>
				32	<li><a href="#library">The XML library interfaces</a>
				33	<ul>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	34	<li><a href="#Invoking">Invoking the parser: the pull way</a></li>
				35	<li><a href="#Invoking">Invoking the parser: the push way</a></li>
				36	<li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	37	<li><a href="#Building">Building a tree from scratch</a></li>
				38	<li><a href="#Traversing">Traversing the tree</a></li>
				39	<li><a href="#Modifying">Modifying the tree</a></li>
				40	<li><a href="#Saving">Saving the tree</a></li>
				41	<li><a href="#Compressio">Compression</a></li>
				42	</ul>
				43	</li>
				44	<li><a href="#Entities">Entities or no entities</a></li>
				45	<li><a href="#Namespaces">Namespaces</a></li>
				46	<li><a href="#Validation">Validation</a></li>
				47	<li><a href="#Principles">DOM principles</a></li>
				48	<li><a href="#real">A real example</a></li>
Daniel Veillard	9698445	2000-08-31 13:50:12 +0000	[diff] [blame]	49	<li><a href="#Contributi">Contributions</a></li>
				50	</ul>
				51
				52	<p>Separate documents:</p>
				53	<ul>
				54	<li><a href="upgrade.html">upgrade instructions for migrating to
				55	libxml2</a></li>
				56	<li><a href="encoding.html">libxml Internationalization support</a></li>
				57	<li><a href="xmlio.html">libxml Input/Output interfaces</a></li>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	58	<li><a href="xmlmem.html">libxml Memory interfaces</a></li>
Daniel Veillard	300f7d6	2000-11-24 13:04:04 +0000	[diff] [blame]	59	<li><a href="xmldtd.html">a short introduction about DTDs and
				60	libxml</a></li>
Daniel Veillard	6e6a6cc	2001-02-15 15:55:44 +0000	[diff] [blame]	61	<li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a></li>
Daniel Veillard	7b06bcb	2001-06-22 16:03:51 +0000	[diff] [blame]	62	<li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page: a
				63	standard DOM interface for libxml2</a></li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	64	</ul>
				65
				66	<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	67
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	68	<p>This document describes libxml, the <a
Daniel Veillard	ec78c0f	2000-08-25 10:25:23 +0000	[diff] [blame]	69	href="http://www.w3.org/XML/">XML</a> C library developped for the <a
				70	href="http://www.gnome.org/">Gnome</a> project. <a
				71	href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
				72	structured documents/data.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	73
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	74	<p>Here are some key points about libxml:</p>
				75	<ul>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	76	<li>Libxml exports Push and Pull type parser interfaces for both XML and
				77	HTML.</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	78	<li>Libxml can do DTD validation at parse time, using a parsed document
				79	instance, or with an arbitrary DTD.</li>
				80	<li>Libxml now includes nearly complete <a
Daniel Veillard	8c2ecaf	2001-07-10 17:53:07 +0000	[diff] [blame^]	81	href="http://www.w3.org/TR/xpath">XPath</a>, <a
				82	href="http://www.w3.org/TR/xptr">XPointer</a> and <a
				83	href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
Daniel Veillard	ec78c0f	2000-08-25 10:25:23 +0000	[diff] [blame]	84	<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]	85	sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	86	Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	87	<li>Basic support for HTTP and FTP client allowing aplications to fetch
				88	remote resources</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	89	<li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	90	<li>The internal document repesentation is as close as possible to the <a
				91	href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
				92	<li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	93	like interface</a>; the interface is designed to be compatible with <a
				94	href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	95	<li>This library is released both under the <a
				96	href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	97	IPR</a> and the <a href="http://www.gnu.org/copyleft/lesser.html">GNU
				98	LGPL</a>. Use either at your convenience, basically this should make
				99	everybody happy, if not, drop me a mail.</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	100	</ul>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	101
Daniel Veillard	e0c1d72	2001-03-21 10:28:36 +0000	[diff] [blame]	102	<p>Warning: unless you are forced to because your application links with a
				103	Gnome library requiring it, <strong><span
				104	style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
				105	libxml2</p>
				106
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	107	<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	108
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	109	<p>There are some on-line resources about using libxml:</p>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	110	<ol>
Daniel Veillard	365e13b	2000-07-02 07:56:37 +0000	[diff] [blame]	111	<li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillard	c19fccc	2000-07-03 11:52:01 +0000	[diff] [blame]	112	<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]	113	documentation</a> automatically extracted from code comments (using <a
				114	href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gtk-doc">gtk
				115	doc</a>).</li>
Daniel Veillard	8d86964	2000-07-14 12:12:59 +0000	[diff] [blame]	116	<li>Look at the documentation about <a href="encoding.html">libxml
				117	internationalization support</a></li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	118	<li>This page provides a global overview and <a href="#real">some
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	119	examples</a> on how to use libxml.</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	120	<li><a href="mailto:james@daa.com.au">James Henstridge</a>
				121	wrote <a
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	122	href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
				123	documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	124	<li>George Lebl wrote <a
				125	href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	126	for IBM developerWorks</a> about using libxml.</li>
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	127	<li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
				128	file</a></li>
				129	<li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
				130	starting a new project using libxml you should really use the 2.x
				131	version.</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	132	<li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	133	archive</a>.</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	134	</ol>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	135
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	136	<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard	4c3a203	1999-11-19 17:46:26 +0000	[diff] [blame]	137
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	138	<p>Well, bugs or missing features are always possible, and I will make a
				139	point of fixing them in a timely fashion. The best way to report a bug is to
				140	use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome
				141	bug tracking database</a> (make sure to use the "libxml" module name). I look
				142	at reports there regularly and it's good to have a reminder when a bug is
				143	still open. Check the <a
				144	href="http://bugzilla.gnome.org/bugwritinghelp.html">instructions on
				145	reporting bugs</a> and be sure to specify that the bug is for the package
				146	libxml.</p>
Daniel Veillard	4c3a203	1999-11-19 17:46:26 +0000	[diff] [blame]	147
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	148	<p>There is also a mailing-list <a
Daniel Veillard	3197f16	2001-04-04 00:40:08 +0000	[diff] [blame]	149	href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
				150	href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	151	href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
				152	please visit the <a
				153	href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
				154	follow the instructions. <strong>Do not send code, I won't debug it</strong>
				155	(but patches are really appreciated!).</p>
Daniel Veillard	234547b	2001-07-05 09:46:10 +0000	[diff] [blame]	156
				157	<p>Check the following too before posting:</p>
				158	<ul>
				159	<li>make sure you are <a href="ftp://xmlsoft.org/">using a recent
				160	version</a>, and that the problem still shows up in those</li>
				161	<li>check the <a href="http://mail.gnome.org/archives/xml/">list
				162	archives</a> to see if the problem was reported already, in this case
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	163	there is probably a fix available, similary check the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&product=libxslt&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&email1=&emailtype1=substring&emailassigned_to1=1&emailreporter1=1&emailcc1=1&emaillongdesc1=1&email2=&emailtype2=substring&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emaillongdesc2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&form_name=query">registered
				164	open bugs</a></li>
Daniel Veillard	234547b	2001-07-05 09:46:10 +0000	[diff] [blame]	165	<li>make sure you can reproduce the bug with xmllint or one of the test
				166	programs found in source in the distribution</li>
				167	<li>Please send the command showing the error as well as the input (as an
				168	attachement)</li>
				169	</ul>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	170
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	171	<p>Alternatively, you can just send the bug to the <a
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	172	href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	173	related I will approve it.. Please do not send me mail directly especially
				174	for portability problem, it makes things really harder to track and in some
				175	cases I'm not the best person to answer a given question, ask the list
				176	instead.</p>
Daniel Veillard	4c3a203	1999-11-19 17:46:26 +0000	[diff] [blame]	177
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	178	<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	179	probably be processed faster.</p>
				180
				181	<p>If you're looking for help, a quick look at <a
				182	href="http://xmlsoft.org/messages/#407">the list archive</a> may actually
				183	provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard	6f0adb5	2000-07-03 11:41:26 +0000	[diff] [blame]	184	questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	185	documentantion</a> is not as polished as I would like (i need to learn more
				186	about Docbook), but it's a good starting point.</p>
				187
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	188	<h2><a name="help">How to help</a></h2>
				189
				190	<p>You can help the project in various ways, the best thing to do first is to
				191	subscribe to the mailing-list as explained before, check the <a
				192	href="http://xmlsoft.org/messages/">archives </a>and the <a
				193	href="http://bugs.gnome.org/db/pa/lgnome-xml.html">Gnome bug
				194	database:</a>:</p>
				195	<ol>
				196	<li>provide patches when you find problems</li>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	197	<li>provide the diffs when you port libxml to a new platform. They may not
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	198	be integrated in all cases but help pinpointing portability problems
				199	and</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	200	<li>provide documentation fixes (either as patches to the code comments or
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	201	as HTML diffs).</li>
				202	<li>provide new documentations pieces (translations, examples, etc ...)</li>
				203	<li>Check the TODO file and try to close one of the items</li>
				204	<li>take one of the points raised in the archive or the bug database and
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	205	provide a fix. <a href="mailto:Daniel.Veillard@imag.fr">Get in touch with
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	206	me </a>before to avoid synchronization problems and check that the
				207	suggested fix will fit in nicely :-)</li>
				208	</ol>
				209
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	210	<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	211
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	212	<p>The latest versions of libxml can be found on <a
Daniel Veillard	20c8cf2	2001-06-26 22:47:36 +0000	[diff] [blame]	213	href="ftp://xmlsoft.org/">xmlsoft.org</a> (<a
				214	href="ftp://speakeasy.rpmfind.net/pub/libxml/">Seattle</a>, <a
				215	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]	216	href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	217	as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard	306be99	2000-07-03 12:38:45 +0000	[diff] [blame]	218	archive</a> or <a
Daniel Veillard	a41123c	2001-04-22 19:31:20 +0000	[diff] [blame]	219	href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM
				220	packages</a>. (NOTE that you need both the <a
Daniel Veillard	c19fccc	2000-07-03 11:52:01 +0000	[diff] [blame]	221	href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
				222	href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	223	packages installed to compile applications using libxml.)</p>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	224
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	225	<p><a name="Snapshot">Snapshot:</a></p>
				226	<ul>
				227	<li>Code from the W3C cvs base libxml <a
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	228	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]	229	<li>Docs, content of the web site, the list archive included <a
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	230	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]	231	</ul>
				232
				233	<p><a name="Contribs">Contribs:</a></p>
				234
				235	<p>I do accept external contributions, especially if compiling on another
				236	platform, get in touch with me to upload the package. I will keep them in the
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	237	<a href="ftp://xmlsoft.org/contribs/">contrib directory</a></p>
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	238
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	239	<p>Libxml is also available from CVS:</p>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	240	<ul>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	241	<li><p>The <a
				242	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]	243	CVS base</a>. Check the <a
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	244	href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a>
				245	page; the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	246	</li>
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	247	<li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	248	</ul>
				249
				250	<h2><a name="News">News</a></h2>
				251
Daniel Veillard	944b5ff	1999-12-15 19:08:24 +0000	[diff] [blame]	252	<h3>CVS only : check the <a
				253	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]	254	for a really accurate description</h3>
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	255
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	256	<p>Items floating around but not actively worked on, get in touch with me if
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	257	you want to test those</p>
				258	<ul>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	259	<li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done
				260	as a separate C library on top of libxml called libxslt</li>
Daniel Veillard	28929b2	2000-11-13 18:22:49 +0000	[diff] [blame]	261	<li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a
				262	href="http://www.w3.org/TR/xinclude">XInclude</a></li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	263	<li>(seeems working but delayed from release) parsing/import of Docbook
				264	SGML docs</li>
				265	</ul>
				266
				267	<h3>2.4.0: July 10 2001</h3>
				268	<ul>
				269	<li>Fixed a few bugs in XPath, validation, and tree handling.</li>
				270	<li>Fixed XML Base implementation, added a coupel of examples to the
				271	regression tests</li>
				272	<li>A bit of cleanup</li>
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	273	</ul>
				274
Daniel Veillard	5b43fde	2001-07-05 23:31:40 +0000	[diff] [blame]	275	<h3>2.3.14: July 5 2001</h3>
				276	<ul>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	277	<li>fixed some entities problems and reduce mem requirement when
				278	substituing them</li>
Daniel Veillard	5b43fde	2001-07-05 23:31:40 +0000	[diff] [blame]	279	<li>lots of improvements in the XPath queries interpreter can be
				280	substancially faster</li>
				281	<li>Makefiles and configure cleanups</li>
				282	<li>Fixes to XPath variable eval, and compare on empty node set</li>
				283	<li>HTML tag closing bug fixed</li>
				284	<li>Fixed an URI reference computating problem when validating</li>
				285	</ul>
				286
Daniel Veillard	2adbb51	2001-06-28 16:20:36 +0000	[diff] [blame]	287	<h3>2.3.13: June 28 2001</h3>
				288	<ul>
				289	<li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
				290	<li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
				291	</ul>
				292
				293	<h3>1.8.14: June 28 2001</h3>
				294	<ul>
				295	<li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
				296	<li>Small Makefile fix</li>
				297	</ul>
				298
Daniel Veillard	1164810	2001-06-26 16:08:24 +0000	[diff] [blame]	299	<h3>2.3.12: June 26 2001</h3>
				300	<ul>
				301	<li>lots of cleanup</li>
				302	<li>a couple of validation fix</li>
				303	<li>fixed line number counting</li>
				304	<li>fixed serious problems in the XInclude processing</li>
				305	<li>added support for UTF8 BOM at beginning of entities</li>
				306	<li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
				307	miscompile uri.c (William), Thomas Leitner provided a fix for the
				308	optimizer on Tru64</li>
				309	<li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
				310	compilation on Windows MSC</li>
				311	<li>update of libxml-doc.el (Felix Natter)</li>
				312	<li>fixed 2 bugs in URI normalization code</li>
				313	</ul>
				314
Daniel Veillard	e3c81b5	2001-06-17 14:50:34 +0000	[diff] [blame]	315	<h3>2.3.11: June 17 2001</h3>
				316	<ul>
				317	<li>updates to trio, Makefiles and configure should fix some portability
				318	problems (alpha)</li>
				319	<li>fixed some HTML serialization problems (pre, script, and block/inline
				320	handling), added encoding aware APIs, cleanup of this code</li>
				321	<li>added xmlHasNsProp()</li>
				322	<li>implemented a specific PI for encoding support in the DocBook SGML
				323	parser</li>
				324	<li>some XPath fixes (-Infinity, / as a function parameter and namespaces
				325	node selection)</li>
				326	<li>fixed a performance problem and an error in the validation code</li>
				327	<li>fixed XInclude routine to implement the recursive behaviour</li>
				328	<li>fixed xmlFreeNode problem when libxml is included statically twice</li>
				329	<li>added --version to xmllint for bug reports</li>
				330	</ul>
				331
Daniel Veillard	2e4f188	2001-06-01 10:11:57 +0000	[diff] [blame]	332	<h3>2.3.10: June 1 2001</h3>
				333	<ul>
				334	<li>fixed the SGML catalog support</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	335	<li>a number of reported bugs got fixed, in XPath, iconv detection,
				336	XInclude processing</li>
Daniel Veillard	2e4f188	2001-06-01 10:11:57 +0000	[diff] [blame]	337	<li>XPath string function should now handle unicode correctly</li>
				338	</ul>
				339
Daniel Veillard	4623acd	2001-05-19 15:13:15 +0000	[diff] [blame]	340	<h3>2.3.9: May 19 2001</h3>
				341
				342	<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
				343	<ul>
				344	<li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
				345	<li>some serious speed optimisation again</li>
				346	<li>some documentation cleanups</li>
				347	<li>trying to get better linking on solaris (-R)</li>
				348	<li>XPath API cleanup from Thomas Broyer</li>
				349	<li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
				350	xmlValidGetValidElements()</li>
				351	<li>Added an INSTALL file</li>
				352	<li>Attribute removal added to API: #54433</li>
				353	<li>added a basic support for SGML catalogs</li>
				354	<li>fixed xmlKeepBlanksDefault(0) API</li>
				355	<li>bugfix in xmlNodeGetLang()</li>
				356	<li>fixed a small configure portability problem</li>
				357	<li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
				358	</ul>
				359
Daniel Veillard	a265af7	2001-05-14 11:13:58 +0000	[diff] [blame]	360	<h3>1.8.13: May 14 2001</h3>
				361	<ul>
				362	<li>bugfixes release of the old libxml1 branch used by Gnome</li>
				363	</ul>
				364
Daniel Veillard	3bbbe6f	2001-05-03 11:15:37 +0000	[diff] [blame]	365	<h3>2.3.8: May 3 2001</h3>
				366	<ul>
				367	<li>Integrated an SGML DocBook parser for the Gnome project</li>
				368	<li>Fixed a few things in the HTML parser</li>
				369	<li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
				370	point portability issue</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	371	<li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
				372	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]	373	<li>incorporated more Windows cleanup</li>
				374	<li>added xmlSaveFormatFile()</li>
				375	<li>fixed problems in copying nodes with entities references (gdome)</li>
				376	<li>removed some troubles surrounding the new validation module</li>
				377	</ul>
				378
Daniel Veillard	a41123c	2001-04-22 19:31:20 +0000	[diff] [blame]	379	<h3>2.3.7: April 22 2001</h3>
				380	<ul>
				381	<li>lots of small bug fixes, corrected XPointer</li>
				382	<li>Non determinist content model validation support</li>
				383	<li>added xmlDocCopyNode for gdome2</li>
				384	<li>revamped the way the HTML parser handles end of tags</li>
				385	<li>XPath: corrctions of namespacessupport and number formatting</li>
				386	<li>Windows: Igor Zlatkovic patches for MSC compilation</li>
				387	<li>HTML ouput fixes from P C Chow and William M. Brack</li>
				388	<li>Improved validation speed sensible for DocBook</li>
				389	<li>fixed a big bug with ID declared in external parsed entities</li>
				390	<li>portability fixes, update of Trio from Bjorn Reese</li>
				391	</ul>
				392
Daniel Veillard	afc7311	2001-04-11 11:51:41 +0000	[diff] [blame]	393	<h3>2.3.6: April 8 2001</h3>
				394	<ul>
				395	<li>Code cleanup using extreme gcc compiler warning options, found and
				396	cleared half a dozen potential problem</li>
				397	<li>the Eazel team found an XML parser bug</li>
				398	<li>cleaned up the user of some of the string formatting function. used the
				399	trio library code to provide the one needed when the platform is missing
				400	them</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	401	<li>xpath: removed a memory leak and fixed the predicate evaluation
				402	problem, extended the testsuite and cleaned up the result. XPointer seems
				403	broken ...</li>
Daniel Veillard	afc7311	2001-04-11 11:51:41 +0000	[diff] [blame]	404	</ul>
				405
Daniel Veillard	56a4cb8	2001-03-24 17:00:36 +0000	[diff] [blame]	406	<h3>2.3.5: Mar 23 2001</h3>
				407	<ul>
				408	<li>Biggest change is separate parsing and evaluation of XPath expressions,
				409	there is some new APIs for this too</li>
				410	<li>included a number of bug fixes(XML push parser, 51876, notations,
				411	52299)</li>
				412	<li>Fixed some portability issues</li>
				413	</ul>
				414
Daniel Veillard	e356c28	2001-03-10 12:32:04 +0000	[diff] [blame]	415	<h3>2.3.4: Mar 10 2001</h3>
				416	<ul>
				417	<li>Fixed bugs #51860 and #51861</li>
				418	<li>Added a global variable xmlDefaultBufferSize to allow default buffer
				419	size to be application tunable.</li>
				420	<li>Some cleanup in the validation code, still a bug left and this part
				421	should probably be rewritten to support ambiguous content model :-\</li>
				422	<li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
				423	parser</li>
				424	<li>Fixed another bug in xmlNodeGetContent()</li>
				425	<li>Bjorn fixed XPath node collection and Number formatting</li>
				426	<li>Fixed a loop reported in the HTML parsing</li>
				427	<li>blank space are reported even if the Dtd content model proves that they
				428	are formatting spaces, this is for XmL conformance</li>
				429	</ul>
				430
Daniel Veillard	b402c07	2001-03-01 17:28:58 +0000	[diff] [blame]	431	<h3>2.3.3: Mar 1 2001</h3>
				432	<ul>
				433	<li>small change in XPath for XSLT</li>
				434	<li>documentation cleanups</li>
				435	<li>fix in validation by Gary Pennington</li>
				436	<li>serious parsing performances improvements</li>
				437	</ul>
				438
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	439	<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard	7168110	2001-02-24 17:48:53 +0000	[diff] [blame]	440	<ul>
				441	<li>chasing XPath bugs, found a bunch, completed some TODO</li>
				442	<li>fixed a Dtd parsing bug</li>
				443	<li>fixed a bug in xmlNodeGetContent</li>
				444	<li>ID/IDREF support partly rewritten by Gary Pennington</li>
				445	</ul>
				446
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	447	<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard	6e6a6cc	2001-02-15 15:55:44 +0000	[diff] [blame]	448	<ul>
				449	<li>some XPath and HTML bug fixes for XSLT</li>
				450	<li>small extension of the hash table interfaces for DOM gdome2
				451	implementation</li>
				452	<li>A few bug fixes</li>
				453	</ul>
				454
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	455	<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]	456	<ul>
				457	<li>Lots of XPath bug fixes</li>
				458	<li>Add a mode with Dtd lookup but without validation error reporting for
				459	XSLT</li>
				460	<li>Add support for text node without escaping (XSLT)</li>
				461	<li>bug fixes for xmlCheckFilename</li>
				462	<li>validation code bug fixes from Gary Pennington</li>
				463	<li>Patch from Paul D. Smith correcting URI path normalization</li>
				464	<li>Patch to allow simultaneous install of libxml-devel and
				465	libxml2-devel</li>
				466	<li>the example Makefile is now fixed</li>
				467	<li>added HTML to the RPM packages</li>
				468	<li>tree copying bugfixes</li>
				469	<li>updates to Windows makefiles</li>
				470	<li>optimisation patch from Bjorn Reese</li>
				471	</ul>
				472
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	473	<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard	503b893	2001-01-05 06:36:31 +0000	[diff] [blame]	474	<ul>
				475	<li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
				476	<li>added htmlHandleOmittedElem()</li>
				477	<li>Applied Bjorn Reese's IPV6 first patch</li>
				478	<li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	479	<li>added XPointer xmlns() new scheme support</li>
Daniel Veillard	503b893	2001-01-05 06:36:31 +0000	[diff] [blame]	480	</ul>
				481
Daniel Veillard	2ddd23d	2000-11-25 10:42:19 +0000	[diff] [blame]	482	<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard	9d343c4	2000-11-25 10:12:43 +0000	[diff] [blame]	483	<ul>
				484	<li>Fix the Windows problems of 2.2.8</li>
				485	<li>integrate OpenVMS patches</li>
				486	<li>better handling of some nasty HTML input</li>
				487	<li>Improved the XPointer implementation</li>
				488	<li>integrate a number of provided patches</li>
				489	</ul>
				490
Daniel Veillard	2ddd23d	2000-11-25 10:42:19 +0000	[diff] [blame]	491	<h3>2.2.9: Nov 25 2000</h3>
				492	<ul>
				493	<li>erroneous release :-(</li>
				494	</ul>
				495
Daniel Veillard	28929b2	2000-11-13 18:22:49 +0000	[diff] [blame]	496	<h3>2.2.8: Nov 13 2000</h3>
				497	<ul>
				498	<li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
				499	support</li>
				500	<li>Patch in conditional section handling</li>
				501	<li>updated MS compiler project</li>
				502	<li>fixed some XPath problems</li>
				503	<li>added an URI escaping function</li>
				504	<li>some other bug fixes</li>
				505	</ul>
				506
				507	<h3>2.2.7: Oct 31 2000</h3>
				508	<ul>
				509	<li>added message redirection</li>
				510	<li>XPath improvements (thanks TOM !)</li>
				511	<li>xmlIOParseDTD() added</li>
				512	<li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
				513	<li>some cleanup of the Makefile, autoconf and the distribution content</li>
				514	</ul>
				515
Daniel Veillard	29a11cc	2000-10-25 13:32:39 +0000	[diff] [blame]	516	<h3>2.2.6: Oct 25 2000:</h3>
				517	<ul>
				518	<li>Added an hash table module, migrated a number of internal structure to
				519	those</li>
				520	<li>Fixed a posteriori validation problems</li>
				521	<li>HTTP module cleanups</li>
				522	<li>HTML parser improvements (tag errors, script/style handling, attribute
				523	normalization)</li>
				524	<li>coalescing of adjacent text nodes</li>
				525	<li>couple of XPath bug fixes, exported the internal API</li>
				526	</ul>
				527
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	528	<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard	4c3a203	1999-11-19 17:46:26 +0000	[diff] [blame]	529	<ul>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	530	<li>XPointer implementation and testsuite</li>
				531	<li>Lot of XPath fixes, added variable and functions registration, more
				532	tests</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	533	<li>Portability fixes, lots of enhancements toward an easy Windows build
				534	and release</li>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	535	<li>Late validation fixes</li>
				536	<li>Integrated a lot of contributed patches</li>
				537	<li>added memory management docs</li>
Daniel Veillard	ab8500d	2000-10-15 21:06:19 +0000	[diff] [blame]	538	<li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard	189446d	2000-10-13 10:23:06 +0000	[diff] [blame]	539	</ul>
				540
				541	<h3>2.2.4: Oct 1 2000:</h3>
				542	<ul>
				543	<li>main XPath problem fixed</li>
				544	<li>Integrated portability patches for Windows</li>
				545	<li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	546	</ul>
				547
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	548	<h3>2.2.3: Sep 17 2000</h3>
				549	<ul>
				550	<li>bug fixes</li>
				551	<li>cleanup of entity handling code</li>
				552	<li>overall review of all loops in the parsers, all sprintf usage has been
				553	checked too</li>
				554	<li>Far better handling of larges Dtd. Validating against Docbook XML Dtd
				555	works smoothly now.</li>
				556	</ul>
				557
				558	<h3>1.8.10: Sep 6 2000</h3>
				559	<ul>
				560	<li>bug fix release for some Gnome projects</li>
				561	</ul>
				562
				563	<h3>2.2.2: August 12 2000</h3>
Daniel Veillard	786d7c8	2000-08-12 23:38:57 +0000	[diff] [blame]	564	<ul>
				565	<li>mostly bug fixes</li>
Daniel Veillard	ec78c0f	2000-08-25 10:25:23 +0000	[diff] [blame]	566	<li>started adding routines to access xml parser context options</li>
Daniel Veillard	786d7c8	2000-08-12 23:38:57 +0000	[diff] [blame]	567	</ul>
				568
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	569	<h3>2.2.1: July 21 2000</h3>
Daniel Veillard	a2679fa	2000-07-22 02:38:15 +0000	[diff] [blame]	570	<ul>
				571	<li>a purely bug fixes release</li>
				572	<li>fixed an encoding support problem when parsing from a memory block</li>
				573	<li>fixed a DOCTYPE parsing problem</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	574	<li>removed a bug in the function allowing to override the memory
				575	allocation routines</li>
Daniel Veillard	a2679fa	2000-07-22 02:38:15 +0000	[diff] [blame]	576	</ul>
				577
Daniel Veillard	d5f97f8	2000-09-17 16:38:14 +0000	[diff] [blame]	578	<h3>2.2.0: July 14 2000</h3>
Daniel Veillard	94e9060	2000-07-17 14:38:19 +0000	[diff] [blame]	579	<ul>
				580	<li>applied a lot of portability fixes</li>
				581	<li>better encoding support/cleanup and saving (content is now always
				582	encoded in UTF-8)</li>
				583	<li>the HTML parser now correctly handles encodings</li>
				584	<li>added xmlHasProp()</li>
				585	<li>fixed a serious problem with &#38;</li>
				586	<li>propagated the fix to FTP client</li>
				587	<li>cleanup, bugfixes, etc ...</li>
				588	<li>Added a page about <a href="encoding.html">libxml Internationalization
				589	support</a></li>
				590	</ul>
				591
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	592	<h3>1.8.9: July 9 2000</h3>
				593	<ul>
				594	<li>fixed the spec the RPMs should be better</li>
				595	<li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
				596	rpmfind users problem</li>
				597	</ul>
				598
Daniel Veillard	6388e17	2000-07-03 16:07:19 +0000	[diff] [blame]	599	<h3>2.1.1: July 1 2000</h3>
				600	<ul>
				601	<li>fixes a couple of bugs in the 2.1.0 packaging</li>
				602	<li>improvements on the HTML parser</li>
				603	</ul>
				604
Daniel Veillard	3f6f7f6	2000-06-30 17:58:25 +0000	[diff] [blame]	605	<h3>2.1.0 and 1.8.8: June 29 2000</h3>
				606	<ul>
				607	<li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
				608	<a href="upgrade.html">new instructions</a>. It fixes a nasty problem
				609	about &#38; charref parsing</li>
				610	<li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
				611	also contains numerous fixes and enhancements:
				612	<ul>
				613	<li>added xmlStopParser() to stop parsing</li>
				614	<li>improved a lot parsing speed when there is large CDATA blocs</li>
				615	<li>includes XPath patches provided by Picdar Technology</li>
				616	<li>tried to fix as much as possible DtD validation and namespace
				617	related problems</li>
				618	<li>output to a given encoding has been added/tested</li>
				619	<li>lot of various fixes</li>
				620	</ul>
				621	</li>
				622	</ul>
				623
Daniel Veillard	e0aed30	2000-04-16 08:52:20 +0000	[diff] [blame]	624	<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	625	<ul>
				626	<li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillard	e0aed30	2000-04-16 08:52:20 +0000	[diff] [blame]	627	idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
				628	scheduled for Apr 3 the relase occured only on Apr 12 due to massive
				629	workload.</li>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	630	<li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillard	e0aed30	2000-04-16 08:52:20 +0000	[diff] [blame]	631	$prefix/include/gnome-xml), they also are referenced by
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	632	<pre>#include <libxml/xxx.h></pre>
Daniel Veillard	e0aed30	2000-04-16 08:52:20 +0000	[diff] [blame]	633	<p>instead of</p>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	634	<pre>#include "xxx.h"</pre>
				635	</li>
Daniel Veillard	8f62198	2000-03-20 13:07:15 +0000	[diff] [blame]	636	<li>a new URI module for parsing URIs and following strictly RFC 2396</li>
				637	<li>the memory allocation routines used by libxml can now be overloaded
				638	dynamically by using xmlMemSetup()</li>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	639	<li>The previously CVS only tool tester has been renamed
				640	<strong>xmllint</strong> and is now installed as part of the libxml2
				641	package</li>
Daniel Veillard	e0aed30	2000-04-16 08:52:20 +0000	[diff] [blame]	642	<li>The I/O interface has been revamped. There is now ways to plug in
				643	specific I/O modules, either at the URI scheme detection level using
				644	xmlRegisterInputCallbacks() or by passing I/O functions when creating a
				645	parser context using xmlCreateIOParserCtxt()</li>
				646	<li>there is a C preprocessor macro LIBXML_VERSION providing the version
				647	number of the libxml module in use</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	648	<li>a number of optional features of libxml can now be excluded at
				649	configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillard	edfb29b	2000-03-14 19:59:05 +0000	[diff] [blame]	650	</ul>
				651
				652	<h3>2.0.0beta: Mar 14 2000</h3>
				653	<ul>
				654	<li>This is a first Beta release of libxml version 2</li>
Daniel Veillard	e356c28	2001-03-10 12:32:04 +0000	[diff] [blame]	655	<li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
				656	FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
				657	RPMs</li>
Daniel Veillard	edfb29b	2000-03-14 19:59:05 +0000	[diff] [blame]	658	<li>This version is now the head in the Gnome CVS base, the old one is
				659	available under the tag LIB_XML_1_X</li>
				660	<li>This includes a very large set of changes. Froma programmatic point of
				661	view applications should not have to be modified too much, check the <a
				662	href="upgrade.html">upgrade page</a></li>
				663	<li>Some interfaces may changes (especially a bit about encoding).</li>
				664	<li>the updates includes:
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	665	<ul>
Daniel Veillard	edfb29b	2000-03-14 19:59:05 +0000	[diff] [blame]	666	<li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
				667	handled now</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	668	<li>Better handling of entities, especially well formedness checking
				669	and proper PEref extensions in external subsets</li>
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	670	<li>DTD conditional sections</li>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	671	<li>Validation now correcly handle entities content</li>
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	672	<li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
				673	structures to accomodate DOM</a></li>
Daniel Veillard	6c8b117	2000-03-01 00:40:41 +0000	[diff] [blame]	674	</ul>
				675	</li>
Daniel Veillard	edfb29b	2000-03-14 19:59:05 +0000	[diff] [blame]	676	<li>Serious progress were made toward compliance, <a
				677	href="conf/result.html">here are the result of the test</a> against the
				678	OASIS testsuite (except the japanese tests since I don't support that
				679	encoding yet). This URL is rebuilt every couple of hours using the CVS
				680	head version.</li>
Daniel Veillard	e41f2b7	2000-01-30 20:00:07 +0000	[diff] [blame]	681	</ul>
				682
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	683	<h3>1.8.7: Mar 6 2000</h3>
				684	<ul>
				685	<li>This is a bug fix release:</li>
				686	<li>It is possible to disable the ignorable blanks heuristic used by
				687	libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	688	that for adherence to XML spec, this behaviour will be disabled by
				689	default in 2.x . The same function will allow to keep compatibility for
				690	old code.</li>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	691	<li>Blanks in <a> </a> constructs are not ignored anymore,
				692	avoiding heuristic is really the Right Way :-\</li>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	693	<li>The unchecked use of snprintf which was breaking libxml-1.8.6
				694	compilation on some platforms has been fixed</li>
				695	<li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
				696	URIs</li>
				697	</ul>
				698
Daniel Veillard	e41f2b7	2000-01-30 20:00:07 +0000	[diff] [blame]	699	<h3>1.8.6: Jan 31 2000</h3>
				700	<ul>
				701	<li>added a nanoFTP transport module, debugged until the new version of <a
				702	href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
				703	it without troubles</li>
Daniel Veillard	da07c34	2000-01-25 18:31:22 +0000	[diff] [blame]	704	</ul>
				705
				706	<h3>1.8.5: Jan 21 2000</h3>
				707	<ul>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	708	<li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	709	href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
				710	XML spec)</li>
Daniel Veillard	461a66c	2000-01-18 18:01:01 +0000	[diff] [blame]	711	<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]	712	<li>Jody Goldberg <jgoldberg@home.com> provided another patch trying
				713	to solve the zlib checks problems</li>
Daniel Veillard	461a66c	2000-01-18 18:01:01 +0000	[diff] [blame]	714	<li>The current state in gnome CVS base is expected to ship as 1.8.5 with
				715	gnumeric soon</li>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	716	</ul>
				717
				718	<h3>1.8.4: Jan 13 2000</h3>
				719	<ul>
				720	<li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
				721	<li>all exit() call should have been removed from libxml</li>
				722	<li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
				723	<li>added newDocFragment()</li>
Daniel Veillard	f84f71f	2000-01-05 19:54:23 +0000	[diff] [blame]	724	</ul>
				725
				726	<h3>1.8.3: Jan 5 2000</h3>
				727	<ul>
				728	<li>a Push interface for the XML and HTML parsers</li>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	729	<li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard	dbfd641	1999-12-28 16:35:14 +0000	[diff] [blame]	730	<li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard	437b87b	2000-01-03 17:30:46 +0000	[diff] [blame]	731	<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]	732	<li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
				733	<li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard	437b87b	2000-01-03 17:30:46 +0000	[diff] [blame]	734	<li>External entity loading code has been revamped, now it uses
Daniel Veillard	f84f71f	2000-01-05 19:54:23 +0000	[diff] [blame]	735	xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard	437b87b	2000-01-03 17:30:46 +0000	[diff] [blame]	736	<li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard	5cb5ab8	1999-12-21 15:35:29 +0000	[diff] [blame]	737	</ul>
				738
				739	<h3>1.8.2: Dec 21 1999</h3>
				740	<ul>
Daniel Veillard	b24054a	1999-12-18 15:32:46 +0000	[diff] [blame]	741	<li>I got another problem with includes and C++, I hope this issue is fixed
				742	for good this time</li>
Daniel Veillard	5cb5ab8	1999-12-21 15:35:29 +0000	[diff] [blame]	743	<li>Added a few tree modification functions: xmlReplaceNode,
				744	xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
				745	xmlDocSetRootElement</li>
				746	<li>Tried to improve the HTML output with help from <a
				747	href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillard	e4e5131	1999-12-18 15:32:46 +0000	[diff] [blame]	748	</ul>
Daniel Veillard	b24054a	1999-12-18 15:32:46 +0000	[diff] [blame]	749
Daniel Veillard	e4e5131	1999-12-18 15:32:46 +0000	[diff] [blame]	750	<h3>1.8.1: Dec 18 1999</h3>
				751	<ul>
				752	<li>various patches to avoid troubles when using libxml with C++ compilers
				753	the "namespace" keyword and C escaping in include files</li>
				754	<li>a problem in one of the core macros IS_CHAR was corrected</li>
				755	<li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
				756	and more specifically the Dia application</li>
Daniel Veillard	944b5ff	1999-12-15 19:08:24 +0000	[diff] [blame]	757	<li>fixed a posteriori validation (validation after parsing, or by using a
				758	Dtd not specified in the original document)</li>
Daniel Veillard	b24054a	1999-12-18 15:32:46 +0000	[diff] [blame]	759	<li>fixed a bug in</li>
Daniel Veillard	10a2c65	1999-12-12 13:03:50 +0000	[diff] [blame]	760	</ul>
				761
				762	<h3>1.8.0: Dec 12 1999</h3>
				763	<ul>
				764	<li>cleanup, especially memory wise</li>
				765	<li>the parser should be more reliable, especially the HTML one, it should
				766	not crash, whatever the input !</li>
				767	<li>Integrated various patches, especially a speedup improvement for large
				768	dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
				769	configure with --with-buffers to enable them.</li>
				770	<li>attribute normalization, oops should have been added long ago !</li>
				771	<li>attributes defaulted from Dtds should be available, xmlSetProp() now
				772	does entities escapting by default.</li>
Daniel Veillard	4c3a203	1999-11-19 17:46:26 +0000	[diff] [blame]	773	</ul>
Daniel Veillard	3500838	1999-10-25 13:15:52 +0000	[diff] [blame]	774
				775	<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	776	<ul>
Daniel Veillard	3500838	1999-10-25 13:15:52 +0000	[diff] [blame]	777	<li>Lots of HTML improvement</li>
				778	<li>Fixed some errors when saving both XML and HTML</li>
				779	<li>More examples, the regression tests should now look clean</li>
				780	<li>Fixed a bug with contiguous charref</li>
				781	</ul>
				782
				783	<h3>1.7.3: Sep 29 1999</h3>
				784	<ul>
				785	<li>portability problems fixed</li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	786	<li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard	3500838	1999-10-25 13:15:52 +0000	[diff] [blame]	787	were it's not available, fixed</li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	788	</ul>
				789
				790	<h3>1.7.1: Sep 24 1999</h3>
				791	<ul>
				792	<li>The basic type for strings manipulated by libxml has been renamed in
				793	1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	794	is that CHAR was conflicting with a predefined type on Windows. However
				795	on non WIN32 environment, compatibility is provided by the way of a
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	796	<strong>#define </strong>.</li>
				797	<li>Changed another error : the use of a structure field called errno, and
				798	leading to troubles on platforms where it's a macro</li>
				799	</ul>
				800
				801	<h3>1.7.0: sep 23 1999</h3>
				802	<ul>
				803	<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]	804	href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	805	<li>Added an errno to report errors by another mean than a simple printf
				806	like callback</li>
				807	<li>Finished ID/IDREF support and checking when validation</li>
				808	<li>Serious memory leaks fixed (there is now a <a
Daniel Veillard	9cb5ff4	2001-01-29 08:22:21 +0000	[diff] [blame]	809	href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	810	<li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
				811	implementation</li>
				812	<li>Added an HTML parser front-end</li>
				813	</ul>
				814
				815	<h2><a name="XML">XML</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	816
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	817	<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]	818	markup-based structured documents. Here is <a name="example">an example XML
				819	document</a>:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	820	<pre><?xml version="1.0"?>
				821	<EXAMPLE prop1="gnome is great" prop2="&amp; linux too">
				822	<head>
				823	<title>Welcome to Gnome</title>
				824	</head>
				825	<chapter>
				826	<title>The Linux adventure</title>
				827	<p>bla bla bla ...</p>
				828	<image href="linus.gif"/>
				829	<p>...</p>
				830	</chapter>
				831	</EXAMPLE></pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	832
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	833	<p>The first line specifies that it's an XML document and gives useful
				834	information about its encoding. Then the document is a text format whose
				835	structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	836	to be closed</strong>. XML is pedantic about this. However, if a tag is empty
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	837	(no content), a single tag can serve as both the opening and closing tag if
				838	it ends with <code>/></code> rather than with <code>></code>. Note
				839	that, for example, the image tag has no content (just an attribute) and is
				840	closed by ending the tag with <code>/></code>.</p>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	841
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	842	<p>XML can be applied sucessfully to a wide range of uses, from long term
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	843	structured document maintenance (where it follows the steps of SGML) to
				844	simple data encoding mechanisms like configuration file formatting (glade),
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	845	spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
				846	it is used to encode remote calls between a client and a server.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	847
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	848	<h2><a name="XSLT">XSLT</a></h2>
				849
Daniel Veillard	6e6a6cc	2001-02-15 15:55:44 +0000	[diff] [blame]	850	<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
				851
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	852	<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
				853	language for transforming XML documents into other XML documents (or
				854	HTML/textual output).</p>
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	855
				856	<p>A separate library called libxslt is being built on top of libxml2. This
				857	module "libxslt" can be found in the Gnome CVS base too.</p>
				858
Daniel Veillard	383b147	2001-01-23 11:39:52 +0000	[diff] [blame]	859	<p>You can check the <a
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	860	href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a>
				861	supported and the progresses on the <a
Daniel Veillard	8268716	2001-01-22 15:32:01 +0000	[diff] [blame]	862	href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p>
				863
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	864	<h2>An overview of libxml architecture</h2>
				865
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	866	<p>Libxml is made of multiple components; some of them are optional, and most
				867	of the block interfaces are public. The main components are:</p>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	868	<ul>
				869	<li>an Input/Output layer</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	870	<li>FTP and HTTP client layers (optional)</li>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	871	<li>an Internationalization layer managing the encodings support</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	872	<li>a URI module</li>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	873	<li>the XML parser and its basic SAX interface</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	874	<li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	875	<li>a SAX tree module to build an in-memory DOM representation</li>
				876	<li>a tree module to manipulate the DOM representation</li>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	877	<li>a validation module using the DOM representation (optional)</li>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	878	<li>an XPath module for global lookup in a DOM representation
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	879	(optional)</li>
				880	<li>a debug module (optional)</li>
Daniel Veillard	4540be4	2000-08-19 16:40:28 +0000	[diff] [blame]	881	</ul>
				882
				883	<p>Graphically this gives the following:</p>
				884
				885	<p><img src="libxml.gif" alt="a graphical view of the various"></p>
				886
				887	<p></p>
				888
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	889	<h2><a name="tree">The tree output</a></h2>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	890
				891	<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]	892	returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	893	<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard	306be99	2000-07-03 12:38:45 +0000	[diff] [blame]	894	as the file name, the document type, and a <strong>children</strong> pointer
				895	which is the root of the document (or more exactly the first child under the
				896	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]	897	chained in double-linked lists of siblings and with a children<->parent
Daniel Veillard	306be99	2000-07-03 12:38:45 +0000	[diff] [blame]	898	relationship. An xmlNode can also carry properties (a chain of xmlAttr
				899	structures). An attribute may have a value which is a list of TEXT or
				900	ENTITY_REF nodes.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	901
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	902	<p>Here is an example (erroneous with respect to the XML spec since there
				903	should be only one ELEMENT under the root):</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	904
				905	<p><img src="structure.gif" alt=" structure.gif "></p>
				906
				907	<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]	908	called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	909	prints them back as parsed. This is useful for detecting errors both in XML
				910	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]	911	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]	912	result with the <a href="#example">example</a> given before:</p>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	913	<pre>DOCUMENT
				914	version=1.0
				915	standalone=true
				916	ELEMENT EXAMPLE
				917	ATTRIBUTE prop1
				918	TEXT
				919	content=gnome is great
				920	ATTRIBUTE prop2
				921	ENTITY_REF
				922	TEXT
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	923	content= linux too
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	924	ELEMENT head
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	925	ELEMENT title
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	926	TEXT
				927	content=Welcome to Gnome
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	928	ELEMENT chapter
				929	ELEMENT title
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	930	TEXT
				931	content=The Linux adventure
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	932	ELEMENT p
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	933	TEXT
				934	content=bla bla bla ...
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	935	ELEMENT image
				936	ATTRIBUTE href
				937	TEXT
				938	content=linus.gif
				939	ELEMENT p
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	940	TEXT
				941	content=...</pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	942
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	943	<p>This should be useful for learning the internal representation model.</p>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	944
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	945	<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	946
Daniel Veillard	402e8c8	2000-02-29 22:57:47 +0000	[diff] [blame]	947	<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]	948	memory. In that case (and if you don't expect to save back the XML document
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	949	loaded using libxml), it's better to use the SAX interface of libxml. SAX is
				950	a <strong>callback-based interface</strong> to the parser. Before parsing,
				951	the application layer registers a customized set of callbacks which are
				952	called by the library as it progresses through the XML input.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	953
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	954	<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]	955	libxml, see the <a
				956	href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
				957	documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	958	Henstridge</a>.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	959
				960	<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
				961	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]	962	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]	963	distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	964	testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	965	<pre>SAX.setDocumentLocator()
				966	SAX.startDocument()
				967	SAX.getEntity(amp)
				968	SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp; linux too')
				969	SAX.characters( , 3)
				970	SAX.startElement(head)
				971	SAX.characters( , 4)
				972	SAX.startElement(title)
				973	SAX.characters(Welcome to Gnome, 16)
				974	SAX.endElement(title)
				975	SAX.characters( , 3)
				976	SAX.endElement(head)
				977	SAX.characters( , 3)
				978	SAX.startElement(chapter)
				979	SAX.characters( , 4)
				980	SAX.startElement(title)
				981	SAX.characters(The Linux adventure, 19)
				982	SAX.endElement(title)
				983	SAX.characters( , 4)
				984	SAX.startElement(p)
				985	SAX.characters(bla bla bla ..., 15)
				986	SAX.endElement(p)
				987	SAX.characters( , 4)
				988	SAX.startElement(image, href='linus.gif')
				989	SAX.endElement(image)
				990	SAX.characters( , 4)
				991	SAX.startElement(p)
				992	SAX.characters(..., 3)
				993	SAX.endElement(p)
				994	SAX.characters( , 3)
				995	SAX.endElement(chapter)
				996	SAX.characters( , 1)
				997	SAX.endElement(EXAMPLE)
				998	SAX.endDocument()</pre>
				999
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1000	<p>Most of the other interfaces of libxml are based on the DOM tree-building
				1001	facility, so nearly everything up to the end of this document presupposes the
				1002	use of the standard DOM tree build. Note that the DOM tree itself is built by
				1003	a set of registered default callbacks, without internal specific
				1004	interface.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1005
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1006	<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1007
				1008	<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1009	using the XML library from the C language. It is not intended to be
				1010	extensive. I hope the automatically generated documents will provide the
				1011	completeness required, but as a separate set of documents. The interfaces of
				1012	the XML library are by principle low level, there is nearly zero abstraction.
				1013	Those interested in a higher level API should <a href="#DOM">look at
				1014	DOM</a>.</p>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	1015
Daniel Veillard	9cb5ff4	2001-01-29 08:22:21 +0000	[diff] [blame]	1016	<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
				1017	separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1018	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]	1019
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1020	<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1021
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1022	<p>Usually, the first thing to do is to read an XML input. The parser accepts
				1023	documents either from in-memory strings or from files. The functions are
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1024	defined in "parser.h":</p>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1025	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1026	<dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1027	<dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1028	</dd>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1029	</dl>
				1030	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1031	<dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1032	<dd><p>Parse an XML document contained in a (possibly compressed)
				1033	file.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1034	</dd>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1035	</dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1036
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1037	<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]	1038	failure).</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1039
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1040	<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1041
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1042	<p>In order for the application to keep the control when the document is
				1043	being fetched (which is common for GUI based programs) libxml provides a push
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1044	interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1045	<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
				1046	void *user_data,
				1047	const char *chunk,
				1048	int size,
				1049	const char *filename);
				1050	int xmlParseChunk (xmlParserCtxtPtr ctxt,
				1051	const char *chunk,
				1052	int size,
				1053	int terminate);</pre>
				1054
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1055	<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]	1056	<pre> FILE *f;
				1057
				1058	f = fopen(filename, "r");
				1059	if (f != NULL) {
				1060	int res, size = 1024;
				1061	char chars[1024];
				1062	xmlParserCtxtPtr ctxt;
				1063
				1064	res = fread(chars, 1, 4, f);
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1065	if (res > 0) {
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1066	ctxt = xmlCreatePushParserCtxt(NULL, NULL,
				1067	chars, res, filename);
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1068	while ((res = fread(chars, 1, size, f)) > 0) {
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1069	xmlParseChunk(ctxt, chars, res, 0);
				1070	}
				1071	xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1072	doc = ctxt->myDoc;
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1073	xmlFreeParserCtxt(ctxt);
				1074	}
				1075	}</pre>
				1076
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1077	<p>The HTML parser embedded into libxml also has a push interface; the
				1078	functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1079
				1080	<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
				1081
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1082	<p>The tree-building interface makes the parser memory-hungry, first loading
				1083	the document in memory and then building the tree itself. Reading a document
				1084	without building the tree is possible using the SAX interfaces (see SAX.h and
				1085	<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]	1086	Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1087	limited to SAX: just use the two first arguments of
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1088	<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	1089
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1090	<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1091
				1092	<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]	1093	there is a set of functions dedicated to building new elements. (These are
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1094	also described in <libxml/tree.h>.) For example, here is a piece of
				1095	code that produces the XML document used in the previous examples:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1096	<pre> #include <libxml/tree.h>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	1097	xmlDocPtr doc;
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1098	xmlNodePtr tree, subtree;
				1099
				1100	doc = xmlNewDoc("1.0");
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1101	doc->children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
				1102	xmlSetProp(doc->children, "prop1", "gnome is great");
				1103	xmlSetProp(doc->children, "prop2", "& linux too");
				1104	tree = xmlNewChild(doc->children, NULL, "head", NULL);
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1105	subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1106	tree = xmlNewChild(doc->children, NULL, "chapter", NULL);
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1107	subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
				1108	subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
				1109	subtree = xmlNewChild(tree, NULL, "image", NULL);
				1110	xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1111
				1112	<p>Not really rocket science ...</p>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1113
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1114	<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1115
Daniel Veillard	9cb5ff4	2001-01-29 08:22:21 +0000	[diff] [blame]	1116	<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1117	code has access to the internal structure of all the elements of the tree.
				1118	The names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard	306be99	2000-07-03 12:38:45 +0000	[diff] [blame]	1119	<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1120	<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard	0142b84	2000-01-14 14:45:24 +0000	[diff] [blame]	1121	example:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1122	<pre><code>doc->children->children->children</code></pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1123
				1124	<p>points to the title element,</p>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1125	<pre>doc->children->children->next->children->children</pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1126
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1127	<p>points to the text node containing the chapter title "The Linux
				1128	adventure".</p>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1129
Daniel Veillard	b24054a	1999-12-18 15:32:46 +0000	[diff] [blame]	1130	<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]	1131	present before the document root, so <code>doc->children</code> may point
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1132	to an element which is not the document Root Element; a function
Daniel Veillard	5cb5ab8	1999-12-21 15:35:29 +0000	[diff] [blame]	1133	<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillard	b24054a	1999-12-18 15:32:46 +0000	[diff] [blame]	1134
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1135	<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1136
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1137	<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard	9cb5ff4	2001-01-29 08:22:21 +0000	[diff] [blame]	1138	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]	1139	<dl>
Daniel Veillard	dd6b367	1999-09-23 22:19:22 +0000	[diff] [blame]	1140	<dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
				1141	xmlChar *value);</code></dt>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1142	<dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
				1143	The value can be NULL.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1144	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1145	</dl>
				1146	<dl>
Daniel Veillard	dd6b367	1999-09-23 22:19:22 +0000	[diff] [blame]	1147	<dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1148	*name);</code></dt>
Daniel Veillard	c92c304	2000-09-29 02:42:04 +0000	[diff] [blame]	1149	<dd><p>This function returns a pointer to new copy of the property
				1150	content. Note that the user must deallocate the result.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1151	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1152	</dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1153
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1154	<p>Two functions are provided for reading and writing the text associated
				1155	with elements:</p>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1156	<dl>
Daniel Veillard	dd6b367	1999-09-23 22:19:22 +0000	[diff] [blame]	1157	<dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1158	*value);</code></dt>
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1159	<dd><p>This function takes an "external" string and converts it to one
				1160	text node or possibly to a list of entity and text nodes. All
				1161	non-predefined entity references like &Gnome; will be stored
				1162	internally as entity nodes, hence the result of the function may not be
				1163	a single node.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1164	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1165	</dl>
				1166	<dl>
Daniel Veillard	dd6b367	1999-09-23 22:19:22 +0000	[diff] [blame]	1167	<dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1168	inLine);</code></dt>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1169	<dd><p>This function is the inverse of
				1170	<code>xmlStringGetNodeList()</code>. It generates a new string
				1171	containing the content of the text and entity nodes. Note the extra
				1172	argument inLine. If this argument is set to 1, the function will expand
				1173	entity references. For example, instead of returning the &Gnome;
				1174	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]	1175	"GNU Network Object Model Environment").</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1176	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1177	</dl>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1178
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1179	<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1180
				1181	<p>Basically 3 options are possible:</p>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1182	<dl>
Daniel Veillard	dd6b367	1999-09-23 22:19:22 +0000	[diff] [blame]	1183	<dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1184	*size);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1185	<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]	1186	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1187	</dl>
				1188	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1189	<dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1190	<dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1191	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1192	</dl>
				1193	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1194	<dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1195	<dd><p>Saves the document to a file. In this case, the compression
				1196	interface is triggered if it has been turned on.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1197	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1198	</dl>
Daniel Veillard	10c6a8f	1998-10-28 01:00:12 +0000	[diff] [blame]	1199
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1200	<h3><a name="Compressio">Compression</a></h3>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1201
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1202	<p>The library transparently handles compression when doing file-based
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1203	accesses. The level of compression on saves can be turned on either globally
				1204	or individually for one file:</p>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1205	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1206	<dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1207	<dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1208	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1209	</dl>
				1210	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1211	<dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1212	<dd><p>Sets the document compression ratio.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1213	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1214	</dl>
				1215	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1216	<dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1217	<dd><p>Gets the default compression ratio.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1218	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1219	</dl>
				1220	<dl>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1221	<dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1222	<dd><p>Sets the default compression ratio.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1223	</dd>
Daniel Veillard	25940b7	1998-10-29 05:51:30 +0000	[diff] [blame]	1224	</dl>
				1225
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1226	<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1227
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1228	<p>Entities in principle are similar to simple C macros. An entity defines an
				1229	abbreviation for a given string that you can reuse many times throughout the
				1230	content of your document. Entities are especially useful when a given string
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1231	may occur frequently within a document, or to confine the change needed to a
				1232	document to a restricted area in the internal subset of the document (at the
				1233	beginning). Example:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1234	<pre>1 <?xml version="1.0"?>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1235	2 <!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1236	3 <!ENTITY xml "Extensible Markup Language">
				1237	4 ]>
				1238	5 <EXAMPLE>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1239	6 &xml;
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1240	7 </EXAMPLE></pre>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1241
				1242	<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]	1243	its name with '&' and following it by ';' without any spaces added. There
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1244	are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1245	predefined meaning in some parts of the xml document content:
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1246	<strong>&lt;</strong> for the character '<', <strong>&gt;</strong>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1247	for the character '>', <strong>&apos;</strong> for the character ''',
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1248	<strong>&quot;</strong> for the character '"', and
				1249	<strong>&amp;</strong> for the character '&'.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1250
				1251	<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]	1252	substitute an entity's content so that you can see the replacement text in
				1253	your application. Or you may prefer to keep entity references as such in the
				1254	content to be able to save the document back without losing this usually
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1255	precious information (if the user went through the pain of explicitly
				1256	defining entities, he may have a a rather negative attitude if you blindly
				1257	susbtitute them as saving time). The <a
Daniel Veillard	9cb5ff4	2001-01-29 08:22:21 +0000	[diff] [blame]	1258	href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1259	function allows you to check and change the behaviour, which is to not
				1260	substitute entities by default.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1261
				1262	<p>Here is the DOM tree built by libxml for the previous document in the
				1263	default case:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1264	<pre>/gnome/src/gnome-xml -> ./xmllint --debug test/ent1
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1265	DOCUMENT
				1266	version=1.0
				1267	ELEMENT EXAMPLE
				1268	TEXT
				1269	content=
				1270	ENTITY_REF
				1271	INTERNAL_GENERAL_ENTITY xml
				1272	content=Extensible Markup Language
				1273	TEXT
				1274	content=</pre>
				1275
				1276	<p>And here is the result when substituting entities:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1277	<pre>/gnome/src/gnome-xml -> ./tester --debug --noent test/ent1
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1278	DOCUMENT
				1279	version=1.0
				1280	ELEMENT EXAMPLE
				1281	TEXT
				1282	content= Extensible Markup Language</pre>
				1283
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1284	<p>So, entities or no entities? Basically, it depends on your use case. I
				1285	suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1286	entities in your XML document or data if you are not willing to handle the
				1287	entity references elements in the DOM tree.</p>
				1288
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1289	<p>Note that at save time libxml enforces the conversion of the predefined
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1290	entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1291	transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard	88f00ae	2000-03-02 00:15:55 +0000	[diff] [blame]	1292	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]	1293	finding them in the input).</p>
				1294
Daniel Veillard	7b9c4b7	2000-08-25 16:26:50 +0000	[diff] [blame]	1295	<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1296	on top of the libxml SAX interface is difficult!!! If you plan to use
Daniel Veillard	7b9c4b7	2000-08-25 16:26:50 +0000	[diff] [blame]	1297	non-predefined entities in your documents, then the learning cuvre to handle
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1298	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]	1299	strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard	8c6d6af	2000-08-25 17:14:13 +0000	[diff] [blame]	1300	deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard	7b9c4b7	2000-08-25 16:26:50 +0000	[diff] [blame]	1301
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1302	<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1303
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	1304	<p>The libxml library implements <a
				1305	href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
				1306	recognizing namespace contructs in the input, and does namespace lookup
				1307	automatically when building the DOM tree. A namespace declaration is
				1308	associated with an in-memory structure and all elements or attributes within
				1309	that namespace point to it. Hence testing the namespace is a simple and fast
				1310	equality operation at the user level.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1311
Daniel Veillard	f13e1ed	2000-03-06 07:41:49 +0000	[diff] [blame]	1312	<p>I suggest that people using libxml use a namespace, and declare it in the
				1313	root element of their document as the default namespace. Then they don't need
				1314	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]	1315	refinement and merging of data from different sources. This doesn't increase
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1316	the size of the XML output significantly, but significantly increases its
				1317	value in the long-term. Example:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1318	<pre><mydoc xmlns="http://mydoc.example.org/schemas/">
				1319	<elem1>...</elem1>
				1320	<elem2>...</elem2>
				1321	</mydoc></pre>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1322
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1323	<p>The namespace value has to be an absolute URL, but the URL doesn't have to
				1324	point to any existing resource on the Web. It will bind all the element and
				1325	atributes with that URL. I suggest to use an URL within a domain you control,
				1326	and that the URL should contain some kind of version information if possible.
				1327	For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good
				1328	namespace scheme.</p>
Daniel Veillard	ec30341	2000-03-24 13:41:54 +0000	[diff] [blame]	1329
				1330	<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]	1331	version-independent prefix is installed on the root element of your document,
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1332	and if the version information don't match something you know, warn the user
				1333	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]	1334	namespace checking on the prefix value. <foo:text> may be exactly the
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1335	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]	1336	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]	1337	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]	1338	<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1339	prefix and its URI.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1340
				1341	<p>@@Interfaces@@</p>
				1342
				1343	<p>@@Examples@@</p>
				1344
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1345	<p>Usually people object to using namespaces together with validity checking.
				1346	I will try to make sure that using namespaces won't break validity checking,
				1347	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]	1348	suggest adding namespaces to your document. A default namespace scheme
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1349	<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1350	flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1351	from multiple DTDs will certainly break current validation schemes. I will
				1352	try to provide ways to do this, but this may not be portable or
				1353	standardized.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1354
Daniel Veillard	2f4dfc4	1999-09-24 14:03:48 +0000	[diff] [blame]	1355	<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1356
				1357	<p>Well what is validation and what is a DTD ?</p>
				1358
				1359	<p>Validation is the process of checking a document against a set of
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1360	construction rules; a <strong>DTD</strong> (Document Type Definition) is such
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1361	a set of rules.</p>
				1362
				1363	<p>The validation process and building DTDs are the two most difficult parts
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1364	of the XML life cycle. Briefly a DTD defines all the possibles element to be
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1365	found within your document, what is the formal shape of your document tree
				1366	(by defining the allowed content of an element, either text, a regular
				1367	expression for the allowed list of children, or mixed content i.e. both text
				1368	and children). The DTD also defines the allowed attributes for all elements
				1369	and the types of the attributes. For more detailed information, I suggest
				1370	that you read the related parts of the XML specification, the examples found
				1371	under gnome-xml/test/valid/dtd and any of the large number of books available
				1372	on XML. The dia example in gnome-xml/test/valid should be both simple and
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1373	complete enough to allow you to build your own.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1374
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1375	<p>A word of warning, building a good DTD which will fit the needs of your
				1376	application in the long-term is far from trivial; however, the extra level of
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1377	quality it can ensure is well worth the price for some sets of applications
				1378	or if you already have already a DTD defined for your application field.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1379
				1380	<p>The validation is not completely finished but in a (very IMHO) usable
				1381	state. Until a real validation interface is defined the way to do it is to
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1382	define and set the <strong>xmlDoValidityCheckingDefaultValue</strong>
				1383	external variable to 1, this will of course be changed at some point:</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1384
				1385	<p>extern int xmlDoValidityCheckingDefaultValue;</p>
				1386
				1387	<p>...</p>
				1388
				1389	<p>xmlDoValidityCheckingDefaultValue = 1;</p>
				1390
				1391	<p></p>
				1392
				1393	<p>To handle external entities, use the function
				1394	<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
				1395	link in you HTTP/FTP/Entities database library to the standard libxml
				1396	core.</p>
				1397
				1398	<p>@@interfaces@@</p>
				1399
Daniel Veillard	3500838	1999-10-25 13:15:52 +0000	[diff] [blame]	1400	<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1401
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1402	<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
				1403	Object Model</em>; this is an API for accessing XML or HTML structured
				1404	documents. Native support for DOM in Gnome is on the way (module gnome-dom),
				1405	and will be based on gnome-xml. This will be a far cleaner interface to
				1406	manipulate XML files within Gnome since it won't expose the internal
				1407	structure.</p>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1408
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1409	<p>The current DOM implementation on top of libxml is the <a
Daniel Veillard	a47fb3d	2001-03-25 17:23:49 +0000	[diff] [blame]	1410	href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
				1411	is a full DOM interface, thanks to Paolo Casarini, check the <a
				1412	href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
				1413	informations.</p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1414
Daniel Veillard	3500838	1999-10-25 13:15:52 +0000	[diff] [blame]	1415	<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]	1416
				1417	<p>Here is a real size example, where the actual content of the application
				1418	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]	1419	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]	1420	storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
				1421	base</a>:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1422	<pre><?xml version="1.0"?>
				1423	<gjob:Helping xmlns:gjob="http://www.gnome.org/some-location">
				1424	<gjob:Jobs>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1425
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1426	<gjob:Job>
				1427	<gjob:Project ID="3"/>
				1428	<gjob:Application>GBackup</gjob:Application>
				1429	<gjob:Category>Development</gjob:Category>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1430
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1431	<gjob:Update>
				1432	<gjob:Status>Open</gjob:Status>
				1433	<gjob:Modified>Mon, 07 Jun 1999 20:27:45 -0400 MET DST</gjob:Modified>
				1434	<gjob:Salary>USD 0.00</gjob:Salary>
				1435	</gjob:Update>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1436
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1437	<gjob:Developers>
				1438	<gjob:Developer>
				1439	</gjob:Developer>
				1440	</gjob:Developers>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1441
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1442	<gjob:Contact>
				1443	<gjob:Person>Nathan Clemons</gjob:Person>
				1444	<gjob:Email>nathan@windsofstorm.net</gjob:Email>
				1445	<gjob:Company>
				1446	</gjob:Company>
				1447	<gjob:Organisation>
				1448	</gjob:Organisation>
				1449	<gjob:Webpage>
				1450	</gjob:Webpage>
				1451	<gjob:Snailmail>
				1452	</gjob:Snailmail>
				1453	<gjob:Phone>
				1454	</gjob:Phone>
				1455	</gjob:Contact>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1456
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1457	<gjob:Requirements>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1458	The program should be released as free software, under the GPL.
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1459	</gjob:Requirements>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1460
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1461	<gjob:Skills>
				1462	</gjob:Skills>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1463
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1464	<gjob:Details>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1465	A GNOME based system that will allow a superuser to configure
				1466	compressed and uncompressed files and/or file systems to be backed
				1467	up with a supported media in the system. This should be able to
				1468	perform via find commands generating a list of files that are passed
				1469	to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
				1470	or via operations performed on the filesystem itself. Email
				1471	notification and GUI status display very important.
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1472	</gjob:Details>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1473
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1474	</gjob:Job>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1475
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1476	</gjob:Jobs>
				1477	</gjob:Helping></pre>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1478
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1479	<p>While loading the XML file into an internal DOM tree is a matter of
				1480	calling only a couple of functions, browsing the tree to gather the ata and
				1481	generate the internal structures is harder, and more error prone.</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1482
				1483	<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1484	structure. For example, the ordering of the attributes is not significant,
				1485	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]	1486	depend on the order of the children of a given node, unless it really makes
				1487	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]	1488	<pre>/*
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1489	* A person record
				1490	*/
				1491	typedef struct person {
				1492	char *name;
				1493	char *email;
				1494	char *company;
				1495	char *organisation;
				1496	char *smail;
				1497	char *webPage;
				1498	char *phone;
				1499	} person, *personPtr;
				1500
				1501	/*
				1502	* And the code needed to parse it
				1503	*/
				1504	personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
				1505	personPtr ret = NULL;
				1506
				1507	DEBUG("parsePerson\n");
				1508	/*
				1509	* allocate the struct
				1510	*/
				1511	ret = (personPtr) malloc(sizeof(person));
				1512	if (ret == NULL) {
				1513	fprintf(stderr,"out of memory\n");
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1514	return(NULL);
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1515	}
				1516	memset(ret, 0, sizeof(person));
				1517
				1518	/* We don't care what the top level element name is */
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1519	cur = cur->xmlChildrenNode;
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1520	while (cur != NULL) {
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1521	if ((!strcmp(cur->name, "Person")) && (cur->ns == ns))
				1522	ret->name = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
				1523	if ((!strcmp(cur->name, "Email")) && (cur->ns == ns))
				1524	ret->email = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
				1525	cur = cur->next;
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1526	}
				1527
				1528	return(ret);
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1529	}</pre>
				1530
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1531	<p>Here are a couple of things to notice:</p>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1532	<ul>
Daniel Veillard	91e9d58	2001-02-26 07:31:12 +0000	[diff] [blame]	1533	<li>Usually a recursive parsing style is the more convenient one: XML data
				1534	is by nature subject to repetitive constructs and usually exibits highly
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1535	stuctured patterns.</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1536	<li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
				1537	i.e. the pointer to the global XML document and the namespace reserved to
				1538	the application. Document wide information are needed for example to
				1539	decode entities and it's a good coding practice to define a namespace for
				1540	your application set of data and test that the element and attributes
				1541	you're analyzing actually pertains to your application space. This is
				1542	done by a simple equality test (cur->ns == ns).</li>
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1543	<li>To retrieve text and attributes value, you can use the function
				1544	<em>xmlNodeListGetString</em> to gather all the text and entity reference
				1545	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]	1546	</ul>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1547
				1548	<p>Here is another piece of code used to parse another level of the
				1549	structure:</p>
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1550	<pre>#include <libxml/tree.h>
Daniel Veillard	361d845	2000-04-03 19:48:13 +0000	[diff] [blame]	1551	/*
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1552	* a Description for a Job
				1553	*/
				1554	typedef struct job {
				1555	char *projectID;
				1556	char *application;
				1557	char *category;
				1558	personPtr contact;
				1559	int nbDevelopers;
				1560	personPtr developers[100]; /* using dynamic alloc is left as an exercise */
				1561	} job, *jobPtr;
				1562
				1563	/*
				1564	* And the code needed to parse it
				1565	*/
				1566	jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
				1567	jobPtr ret = NULL;
				1568
				1569	DEBUG("parseJob\n");
				1570	/*
				1571	* allocate the struct
				1572	*/
				1573	ret = (jobPtr) malloc(sizeof(job));
				1574	if (ret == NULL) {
				1575	fprintf(stderr,"out of memory\n");
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1576	return(NULL);
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1577	}
				1578	memset(ret, 0, sizeof(job));
				1579
				1580	/* We don't care what the top level element name is */
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1581	cur = cur->xmlChildrenNode;
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1582	while (cur != NULL) {
				1583
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1584	if ((!strcmp(cur->name, "Project")) && (cur->ns == ns)) {
				1585	ret->projectID = xmlGetProp(cur, "ID");
				1586	if (ret->projectID == NULL) {
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1587	fprintf(stderr, "Project has no ID\n");
				1588	}
				1589	}
Daniel Veillard	60979bd	2000-07-10 12:17:33 +0000	[diff] [blame]	1590	if ((!strcmp(cur->name, "Application")) && (cur->ns == ns))
				1591	ret->application = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
				1592	if ((!strcmp(cur->name, "Category")) && (cur->ns == ns))
				1593	ret->category = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
				1594	if ((!strcmp(cur->name, "Contact")) && (cur->ns == ns))
				1595	ret->contact = parsePerson(doc, ns, cur);
				1596	cur = cur->next;
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1597	}
				1598
				1599	return(ret);
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1600	}</pre>
Daniel Veillard	14fff06	1999-06-22 21:49:07 +0000	[diff] [blame]	1601
Daniel Veillard	ec70e91	2001-02-26 20:10:45 +0000	[diff] [blame]	1602	<p>Once you are used to it, writing this kind of code is quite simple, but
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1603	boring. Ultimately, it could be possble to write stubbers taking either C
				1604	data structure definitions, a set of XML examples or an XML DTD and produce
				1605	the code needed to import and export the content between C data and XML
				1606	storage. This is left as an exercise to the reader :-)</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1607
Daniel Veillard	6f0adb5	2000-07-03 11:41:26 +0000	[diff] [blame]	1608	<p>Feel free to use <a href="example/gjobread.c">the code for the full C
				1609	parsing example</a> as a template, it is also available with Makefile in the
				1610	Gnome CVS base under gnome-xml/example</p>
Daniel Veillard	b05deb7	1999-08-10 19:04:08 +0000	[diff] [blame]	1611
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	1612	<h2><a name="Contributi">Contributions</a></h2>
				1613	<ul>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1614	<li><a href="mailto:ari@lusis.org">Ari Johnson</a>
				1615	provides a C++ wrapper for libxml:
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	1616	<p>Website: <a
				1617	href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
				1618	<p>Download: <a
				1619	href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
				1620	</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1621	<li><a href="mailto:doolin@cs.utk.edu">David Doolin</a>
				1622	provides a precompiled Windows version
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	1623	<p><a
Daniel Veillard	c5d6434	2001-06-24 12:13:24 +0000	[diff] [blame]	1624	href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a>
				1625	(older). The distribution now includes projects and makefiles for Windows
				1626	compiler contributed by various people.</p>
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	1627	</li>
Daniel Veillard	e356c28	2001-03-10 12:32:04 +0000	[diff] [blame]	1628	<li><a
				1629	href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1630	Sergeant</a>
				1631	developped <a href="http://axkit.org/download/">XML::LibXSLT</a>, a perl
				1632	wrapper for libxml2/libxslt as part of the <a
				1633	href="http://axkit.com/">AxKit XML application server</a></li>
				1634	<li><a href="mailto:fnatter@gmx.net">Felix Natter</a>
				1635	and <a href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
Daniel Veillard	ca98976	2001-06-23 17:39:29 +0000	[diff] [blame]	1636	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]	1637	documentation</li>
Daniel Veillard	09ab7e1	2001-07-10 15:49:44 +0000	[diff] [blame]	1638	<li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a>
				1639	provided <a href="http://xmlsoft.org/messages/0488.html">man
				1640	pages</a></li>
Daniel Veillard	5168dbf	2001-07-07 00:18:23 +0000	[diff] [blame]	1641	<li>there is a module for <a
				1642	href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
				1643	in OpenNSD/AOLServer</a></li>
Daniel Veillard	c310d56	2000-06-23 18:32:15 +0000	[diff] [blame]	1644	</ul>
				1645
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1646	<p></p>
				1647
Daniel Veillard	33a6780	2001-03-07 09:44:02 +0000	[diff] [blame]	1648	<p><a href="mailto:Daniel.Veillard@imag.fr">Daniel Veillard</a></p>
Daniel Veillard	c8eab3a	1999-09-04 18:27:23 +0000	[diff] [blame]	1649
Daniel Veillard	8c2ecaf	2001-07-10 17:53:07 +0000	[diff] [blame^]	1650	<p>$Id: xml.html,v 1.101 2001/07/10 15:49:42 veillard Exp $</p>
Daniel Veillard	ccb0963	1998-10-27 06:21:04 +0000	[diff] [blame]	1651	</body>
				1652	</html>