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

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