doc/xml.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2     "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>The XML C parser and toolkit of Gnome</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
   7 </head>
   8 <body bgcolor="#ffffff">
   9 <h1 align="center">The XML C parser and toolkit of Gnome</h1>
  10
  11 <h1>Note: this is the flat content of the <a href="index.html">web
  12 site</a></h1>
  13
  14 <h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1>
  15
  16 <p></p>
  17
  18 <p
  19 style="text-align: right; font-style: italic; font-size: 10pt">"Programming
  20 with libxml2 is like the thrilling embrace of an exotic stranger." <a
  21 href="http://diveintomark.org/archives/2004/02/18/libxml2">Mark
  22 Pilgrim</a></p>
  23
  24 <p>Libxml2 is the XML C parser and toolkit developed for the Gnome project
  25 (but usable outside of the Gnome platform), it is free software available
  26 under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
  27 License</a>. XML itself is a metalanguage to design markup languages, i.e.
  28 text language where semantic and structure are added to the content using
  29 extra "markup" information enclosed between angle brackets. HTML is the most
  30 well-known markup language. Though the library is written in C <a
  31 href="python.html">a variety of language bindings</a> make it available in
  32 other environments.</p>
  33
  34 <p>Libxml2 is known to be very portable, the library should build and work
  35 without serious troubles on a variety of systems (Linux, Unix, Windows,
  36 CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, VxWorks, ...)</p>
  37
  38 <p>Libxml2 implements a number of existing standards related to markup
  39 languages:</p>
  40 <ul>
  41   <li>the XML standard: <a
  42     href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li>
  43   <li>Namespaces in XML: <a
  44     href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li>
  45   <li>XML Base: <a
  46     href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li>
  47   <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a> :
  48     Uniform Resource Identifiers <a
  49     href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li>
  50   <li>XML Path Language (XPath) 1.0: <a
  51     href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li>
  52   <li>HTML4 parser: <a
  53     href="http://www.w3.org/TR/html401/">http://www.w3.org/TR/html401/</a></li>
  54   <li>XML Pointer Language (XPointer) Version 1.0: <a
  55     href="http://www.w3.org/TR/xptr">http://www.w3.org/TR/xptr</a></li>
  56   <li>XML Inclusions (XInclude) Version 1.0: <a
  57     href="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</a></li>
  58   <li>ISO-8859-x encodings, as well as <a
  59     href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8]
  60     and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>
  61     [UTF-16] Unicode encodings, and more if using iconv support</li>
  62   <li>part of SGML Open Technical Resolution TR9401:1997</li>
  63   <li>XML Catalogs Working Draft 06 August 2001: <a
  64     href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html">http://www.oasis-open.org/committees/entity/spec-2001-08-06.html</a></li>
  65   <li>Canonical XML Version 1.0: <a
  66     href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a>
  67     and the Exclusive XML Canonicalization CR draft <a
  68     href="http://www.w3.org/TR/xml-exc-c14n">http://www.w3.org/TR/xml-exc-c14n</a></li>
  69   <li>Relax NG, ISO/IEC 19757-2:2003, <a
  70     href="http://www.oasis-open.org/committees/relax-ng/spec-20011203.html">http://www.oasis-open.org/committees/relax-ng/spec-20011203.html</a></li>
  71   <li>W3C XML Schemas Part 2: Datatypes <a
  72     href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC 02 May
  73     2001</a></li>
  74   <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a> Working Draft 7
  75     April 2004</li>
  76 </ul>
  77
  78 <p>In most cases libxml2 tries to implement the specifications in a
  79 relatively strictly compliant way. As of release 2.4.16, libxml2 passed all
  80 1800+ tests from the <a
  81 href="http://www.oasis-open.org/committees/xml-conformance/">OASIS XML Tests
  82 Suite</a>.</p>
  83
  84 <p>To some extent libxml2 provides support for the following additional
  85 specifications but doesn't claim to implement them completely:</p>
  86 <ul>
  87   <li>Document Object Model (DOM) <a
  88     href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>
  89     the document model, but it doesn't implement the API itself, gdome2 does
  90     this on top of libxml2</li>
  91   <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a> :
  92     libxml2 implements a basic FTP client code</li>
  93   <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a> :
  94     HTTP/1.0, again a basic HTTP client code</li>
  95   <li>SAX: a SAX2 like interface and a minimal SAX1 implementation compatible
  96     with early expat versions</li>
  97 </ul>
  98
  99 <p>A partial implementation of <a
 100 href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas Part
 101 1: Structure</a> is being worked on but it would be far too early to make any
 102 conformance statement about it at the moment.</p>
 103
 104 <p>Separate documents:</p>
 105 <ul>
 106   <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a> providing an
 107     implementation of XSLT 1.0 and common extensions like EXSLT for
 108   libxml2</li>
 109   <li><a href="http://gdome2.cs.unibo.it/">the gdome2 page</a>
 110     : a standard DOM2 implementation for libxml2</li>
 111   <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec page</a>: an
 112     implementation of <a href="http://www.w3.org/TR/xmldsig-core/">W3C XML
 113     Digital Signature</a> for libxml2</li>
 114   <li>also check the related links section for more related and active
 115     projects.</li>
 116 </ul>
 117 <p> Hosting sponsored by <a href="http://www.aoemedia.de/opensource-cms.html"
 118 >Open Source CMS services</a> from AOE media.</p>
 119
 120 <p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
 121
 122 <h2><a name="Introducti">Introduction</a></h2>
 123
 124 <p>This document describes libxml, the <a
 125 href="http://www.w3.org/XML/">XML</a> C parser and toolkit developed for the
 126 <a href="http://www.gnome.org/">Gnome</a> project. <a
 127 href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
 128 structured documents/data.</p>
 129
 130 <p>Here are some key points about libxml:</p>
 131 <ul>
 132   <li>Libxml2 exports Push (progressive) and Pull (blocking) type parser
 133     interfaces for both XML and HTML.</li>
 134   <li>Libxml2 can do DTD validation at parse time, using a parsed document
 135     instance, or with an arbitrary DTD.</li>
 136   <li>Libxml2 includes complete <a
 137     href="http://www.w3.org/TR/xpath">XPath</a>, <a
 138     href="http://www.w3.org/TR/xptr">XPointer</a> and <a
 139     href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
 140   <li>It is written in plain C, making as few assumptions as possible, and
 141     sticking closely to ANSI C/POSIX for easy embedding. Works on
 142     Linux/Unix/Windows, ported to a number of other platforms.</li>
 143   <li>Basic support for HTTP and FTP client allowing applications to fetch
 144     remote resources.</li>
 145   <li>The design is modular, most of the extensions can be compiled out.</li>
 146   <li>The internal document representation is as close as possible to the <a
 147     href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
 148   <li>Libxml2 also has a <a
 149     href="http://www.megginson.com/SAX/index.html">SAX like interface</a>;
 150     the interface is designed to be compatible with <a
 151     href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
 152   <li>This library is released under the <a
 153     href="http://www.opensource.org/licenses/mit-license.html">MIT
 154     License</a>. See the Copyright file in the distribution for the precise
 155     wording.</li>
 156 </ul>
 157
 158 <p>Warning: unless you are forced to because your application links with a
 159 Gnome-1.X library requiring it,  <strong><span
 160 style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
 161 libxml2</p>
 162
 163 <h2><a name="FAQ">FAQ</a></h2>
 164
 165 <p>Table of Contents:</p>
 166 <ul>
 167   <li><a href="FAQ.html#License">License(s)</a></li>
 168   <li><a href="FAQ.html#Installati">Installation</a></li>
 169   <li><a href="FAQ.html#Compilatio">Compilation</a></li>
 170   <li><a href="FAQ.html#Developer">Developer corner</a></li>
 171 </ul>
 172
 173 <h3><a name="License">License</a>(s)</h3>
 174 <ol>
 175   <li><em>Licensing Terms for libxml</em>
 176     <p>libxml2 is released under the <a
 177     href="http://www.opensource.org/licenses/mit-license.html">MIT
 178     License</a>; see the file Copyright in the distribution for the precise
 179     wording</p>
 180   </li>
 181   <li><em>Can I embed libxml2 in a proprietary application ?</em>
 182     <p>Yes. The MIT License allows you to keep proprietary the changes you
 183     made to libxml, but it would be graceful to send-back bug fixes and
 184     improvements as patches for possible incorporation in the main
 185     development tree.</p>
 186   </li>
 187 </ol>
 188
 189 <h3><a name="Installati">Installation</a></h3>
 190 <ol>
 191   <li><strong><span style="background-color: #FF0000">Do Not Use
 192     libxml1</span></strong>, use libxml2</li>
 193   <p></p>
 194   <li><em>Where can I get libxml</em> ?
 195     <p>The original distribution comes from <a
 196     href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a
 197     href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
 198     <p>Most Linux and BSD distributions include libxml, this is probably the
 199     safer way for end-users to use libxml.</p>
 200     <p>David Doolin provides precompiled Windows versions at <a
 201     href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/         ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
 202   </li>
 203   <p></p>
 204   <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
 205     <ul>
 206       <li>If you are not constrained by backward compatibility issues with
 207         existing applications, install libxml2 only</li>
 208       <li>If you are not doing development, you can safely install both.
 209         Usually the packages <a
 210         href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a
 211         href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
 212         compatible (this is not the case for development packages).</li>
 213       <li>If you are a developer and your system provides separate packaging
 214         for shared libraries and the development components, it is possible
 215         to install libxml and libxml2, and also <a
 216         href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
 217         and <a
 218         href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
 219         too for libxml2 &gt;= 2.3.0</li>
 220       <li>If you are developing a new application, please develop against
 221         libxml2(-devel)</li>
 222     </ul>
 223   </li>
 224   <li><em>I can't install the libxml package, it conflicts with libxml0</em>
 225     <p>You probably have an old libxml0 package used to provide the shared
 226     library for libxml.so.0, you can probably safely remove it. The libxml
 227     packages provided on <a
 228     href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> provide
 229     libxml.so.0</p>
 230   </li>
 231   <li><em>I can't install the libxml(2) RPM package due to failed
 232     dependencies</em>
 233     <p>The most generic solution is to re-fetch the latest src.rpm , and
 234     rebuild it locally with</p>
 235     <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
 236     <p>If everything goes well it will generate two binary rpm packages (one
 237     providing the shared libs and xmllint, and the other one, the -devel
 238     package, providing includes, static libraries and scripts needed to build
 239     applications with libxml(2)) that you can install locally.</p>
 240   </li>
 241 </ol>
 242
 243 <h3><a name="Compilatio">Compilation</a></h3>
 244 <ol>
 245   <li><em>What is the process to compile libxml2 ?</em>
 246     <p>As most UNIX libraries libxml2 follows the "standard":</p>
 247     <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
 248     <p><code>cd libxml-xxxx</code></p>
 249     <p><code>./configure --help</code></p>
 250     <p>to see the options, then the compilation/installation proper</p>
 251     <p><code>./configure [possible options]</code></p>
 252     <p><code>make</code></p>
 253     <p><code>make install</code></p>
 254     <p>At that point you may have to rerun ldconfig or a similar utility to
 255     update your list of installed shared libs.</p>
 256   </li>
 257   <li><em>What other libraries are needed to compile/install libxml2 ?</em>
 258     <p>Libxml2 does not require any other library, the normal C ANSI API
 259     should be sufficient (please report any violation to this rule you may
 260     find).</p>
 261     <p>However if found at configuration time libxml2 will detect and use the
 262     following libs:</p>
 263     <ul>
 264       <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
 265         highly portable and available widely compression library.</li>
 266       <li>iconv: a powerful character encoding conversion library. It is
 267         included by default in recent glibc libraries, so it doesn't need to
 268         be installed specifically on Linux. It now seems a <a
 269         href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
 270         of the official UNIX</a> specification. Here is one <a
 271         href="http://www.gnu.org/software/libiconv/">implementation of the
 272         library</a> which source can be found <a
 273         href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
 274     </ul>
 275   </li>
 276   <p></p>
 277   <li><em>Make check fails on some platforms</em>
 278     <p>Sometimes the regression tests' results don't completely match the
 279     value produced by the parser, and the makefile uses diff to print the
 280     delta. On some platforms the diff return breaks the compilation process;
 281     if the diff is small this is probably not a serious problem.</p>
 282     <p>Sometimes (especially on Solaris) make checks fail due to limitations
 283     in make. Try using GNU-make instead.</p>
 284   </li>
 285   <li><em>I use the SVN version and there is no configure script</em>
 286     <p>The configure script (and other Makefiles) are generated. Use the
 287     autogen.sh script to regenerate the configure script and Makefiles,
 288     like:</p>
 289     <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
 290   </li>
 291   <li><em>I have troubles when running make tests with gcc-3.0</em>
 292     <p>It seems the initial release of gcc-3.0 has a problem with the
 293     optimizer which miscompiles the URI module. Please use another
 294     compiler.</p>
 295   </li>
 296 </ol>
 297
 298 <h3><a name="Developer">Developer</a> corner</h3>
 299 <ol>
 300   <li><em>Troubles compiling or linking programs using libxml2</em>
 301     <p>Usually the problem comes from the fact that the compiler doesn't get
 302     the right compilation or linking flags. There is a small shell script
 303     <code>xml2-config</code> which is installed as part of libxml2 usual
 304     install process which provides those flags. Use</p>
 305     <p><code>xml2-config --cflags</code></p>
 306     <p>to get the compilation flags and</p>
 307     <p><code>xml2-config --libs</code></p>
 308     <p>to get the linker flags. Usually this is done directly from the
 309     Makefile as:</p>
 310     <p><code>CFLAGS=`xml2-config --cflags`</code></p>
 311     <p><code>LIBS=`xml2-config --libs`</code></p>
 312   </li>
 313   <li><em>I want to install my own copy of libxml2 in my home directory and
 314     link my programs against it, but it doesn't work</em>
 315     <p>There are many different ways to accomplish this.  Here is one way to
 316     do this under Linux.  Suppose your home directory is <code>/home/user.
 317     </code>Then:</p>
 318     <ul>
 319       <li>Create a subdirectory, let's call it <code>myxml</code></li>
 320       <li>unpack the libxml2 distribution into that subdirectory</li>
 321       <li>chdir into the unpacked distribution
 322         (<code>/home/user/myxml/libxml2 </code>)</li>
 323       <li>configure the library using the "<code>--prefix</code>" switch,
 324         specifying an installation subdirectory in
 325         <code>/home/user/myxml</code>, e.g.
 326         <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other
 327         configuration options}</p>
 328       </li>
 329       <li>now run <code>make</code> followed by <code>make install</code></li>
 330       <li>At this point, the installation subdirectory contains the complete
 331         "private" include files, library files and binary program files (e.g.
 332         xmllint), located in
 333         <p><code>/home/user/myxml/xmlinst/lib,
 334         /home/user/myxml/xmlinst/include </code> and <code>
 335         /home/user/myxml/xmlinst/bin</code></p>
 336         respectively.</li>
 337       <li>In order to use this "private" library, you should first add it to
 338         the beginning of your default PATH (so that your own private program
 339         files such as xmllint will be used instead of the normal system
 340         ones).  To do this, the Bash command would be
 341         <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p>
 342       </li>
 343       <li>Now suppose you have a program <code>test1.c</code> that you would
 344         like to compile with your "private" library.  Simply compile it using
 345         the command
 346         <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p>
 347         Note that, because your PATH has been set with <code>
 348         /home/user/myxml/xmlinst/bin</code> at the beginning, the xml2-config
 349         program which you just installed will be used instead of the system
 350         default one, and this will <em>automatically</em> get the correct
 351         libraries linked with your program.</li>
 352     </ul>
 353   </li>
 354
 355   <p></p>
 356   <li><em>xmlDocDump() generates output on one line.</em>
 357     <p>Libxml2 will not <strong>invent</strong> spaces in the content of a
 358     document since <strong>all spaces in the content of a document are
 359     significant</strong>. If you build a tree from the API and want
 360     indentation:</p>
 361     <ol>
 362       <li>the correct way is to generate those yourself too.</li>
 363       <li>the dangerous way is to ask libxml2 to add those blanks to your
 364         content <strong>modifying the content of your document in the
 365         process</strong>. The result may not be what you expect. There is
 366         <strong>NO</strong> way to guarantee that such a modification won't
 367         affect other parts of the content of your document. See <a
 368         href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault
 369         ()</a> and <a
 370         href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile
 371         ()</a></li>
 372     </ol>
 373   </li>
 374   <p></p>
 375   <li><em>Extra nodes in the document:</em>
 376     <p><em>For an XML file as below:</em></p>
 377     <pre>&lt;?xml version="1.0"?&gt;
 378 &lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
 379 &lt;NODE CommFlag="0"/&gt;
 380 &lt;NODE CommFlag="1"/&gt;
 381 &lt;/PLAN&gt;</pre>
 382     <p><em>after parsing it with the function
 383     pxmlDoc=xmlParseFile(...);</em></p>
 384     <p><em>I want to the get the content of the first node (node with the
 385     CommFlag="0")</em></p>
 386     <p><em>so I did it as following;</em></p>
 387     <pre>xmlNodePtr pnode;
 388 pnode=pxmlDoc-&gt;children-&gt;children;</pre>
 389     <p><em>but it does not work. If I change it to</em></p>
 390     <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
 391     <p><em>then it works.  Can someone explain it to me.</em></p>
 392     <p></p>
 393     <p>In XML all characters in the content of the document are significant
 394     <strong>including blanks and formatting line breaks</strong>.</p>
 395     <p>The extra nodes you are wondering about are just that, text nodes with
 396     the formatting spaces which are part of the document but that people tend
 397     to forget. There is a function <a
 398     href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
 399     ()</a>  to remove those at parse time, but that's an heuristic, and its
 400     use should be limited to cases where you are certain there is no
 401     mixed-content in the document.</p>
 402   </li>
 403   <li><em>I get compilation errors of existing code like when accessing
 404     <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
 405     <p>You are compiling code developed for libxml version 1 and using a
 406     libxml2 development environment. Either switch back to libxml v1 devel or
 407     even better fix the code to compile with libxml2 (or both) by <a
 408     href="upgrade.html">following the instructions</a>.</p>
 409   </li>
 410   <li><em>I get compilation errors about non existing
 411     <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
 412     fields.</em>
 413     <p>The source code you are using has been <a
 414     href="upgrade.html">upgraded</a> to be able to compile with both libxml
 415     and libxml2, but you need to install a more recent version:
 416     libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
 417   </li>
 418   <li><em>Random crashes in threaded applications</em>
 419     <p>Read and follow all advices on the <a href="threads.html">thread
 420     safety</a> page, and make 100% sure you never call xmlCleanupParser()
 421     while the library or an XML document might still be in use by another
 422     thread.</p>
 423   </li>
 424   <li><em>The example provided in the web page does not compile.</em>
 425     <p>It's hard to maintain the documentation in sync with the code
 426     &lt;grin/&gt; ...</p>
 427     <p>Check the previous points 1/ and 2/ raised before, and please send
 428     patches.</p>
 429   </li>
 430   <li><em>Where can I get more examples and information than provided on the
 431     web page?</em>
 432     <p>Ideally a libxml2 book would be nice. I have no such plan ... But you
 433     can:</p>
 434     <ul>
 435       <li>check more deeply the <a href="html/libxml-lib.html">existing
 436         generated doc</a></li>
 437       <li>have a look at <a href="examples/index.html">the set of
 438         examples</a>.</li>
 439       <li>look for examples of use for libxml2 function using the Gnome code
 440           or by asking on Google.</li>
 441       <li><a
 442         href="http://svn.gnome.org/viewvc/libxml2/trunk/">Browse
 443         the libxml2 source</a> , I try to write code as clean and documented
 444         as possible, so looking at it may be helpful. In particular the code
 445         of <a href="http://svn.gnome.org/viewvc/libxml2/trunk/xmllint.c?view=markup">xmllint.c</a> and of the various testXXX.c test programs should
 446         provide good examples of how to do things with the library.</li>
 447     </ul>
 448   </li>
 449   <p></p>
 450   <li><em>What about C++ ?</em>
 451     <p>libxml2 is written in pure C in order to allow easy reuse on a number
 452     of platforms, including embedded systems. I don't intend to convert to
 453     C++.</p>
 454     <p>There is however a C++ wrapper which may fulfill your needs:</p>
 455     <ul>
 456       <li>by Ari Johnson &lt;ari@btigate.com&gt;:
 457         <p>Website: <a
 458         href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
 459         <p>Download: <a
 460         href="http://sourceforge.net/project/showfiles.php?group_id=12999">http://sourceforge.net/project/showfiles.php?group_id=12999</a></p>
 461       </li>
 462     </ul>
 463   </li>
 464   <li><em>How to validate a document a posteriori ?</em>
 465     <p>It is possible to validate documents which had not been validated at
 466     initial parsing time or documents which have been built from scratch
 467     using the API. Use the <a
 468     href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>
 469     function. It is also possible to simply add a DTD to an existing
 470     document:</p>
 471     <pre>xmlDocPtr doc; /* your existing document */
 472 xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
 473
 474         dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
 475
 476         doc-&gt;intSubset = dtd;
 477         if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
 478         else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
 479           </pre>
 480   </li>
 481   <li><em>So what is this funky "xmlChar" used all the time?</em>
 482     <p>It is a null terminated sequence of utf-8 characters. And only utf-8!
 483     You need to convert strings encoded in different ways to utf-8 before
 484     passing them to the API.  This can be accomplished with the iconv library
 485     for instance.</p>
 486   </li>
 487   <li>etc ...</li>
 488 </ol>
 489
 490 <p></p>
 491
 492 <h2><a name="Documentat">Developer Menu</a></h2>
 493
 494 <p>There are several on-line resources related to using libxml:</p>
 495 <ol>
 496   <li>Use the <a href="search.php">search engine</a> to look up
 497   information.</li>
 498   <li>Check the <a href="FAQ.html">FAQ.</a></li>
 499   <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
 500     documentation</a> automatically extracted from code comments.</li>
 501   <li>Look at the documentation about <a href="encoding.html">libxml
 502     internationalization support</a>.</li>
 503   <li>This page provides a global overview and <a href="example.html">some
 504     examples</a> on how to use libxml.</li>
 505   <li><a href="examples/index.html">Code examples</a></li>
 506   <li>John Fleck's libxml2 tutorial: <a href="tutorial/index.html">html</a>
 507     or <a href="tutorial/xmltutorial.pdf">pdf</a>.</li>
 508   <li>If you need to parse large files, check the <a
 509     href="xmlreader.html">xmlReader</a> API tutorial</li>
 510   <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
 511     href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
 512     documentation</a> explaining how to use the libxml SAX interface.</li>
 513   <li>George Lebl wrote <a
 514     href="http://www-106.ibm.com/developerworks/library/l-gnome3/">an article
 515     for IBM developerWorks</a> about using libxml.</li>
 516   <li>Check <a href="http://svn.gnome.org/viewvc/libxml2/trunk/TODO?view=markup">the TODO
 517     file</a>.</li>
 518   <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>
 519     description. If you are starting a new project using libxml you should
 520     really use the 2.x version.</li>
 521   <li>And don't forget to look at the <a
 522     href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li>
 523 </ol>
 524
 525 <h2><a name="Reporting">Reporting bugs and getting help</a></h2>
 526
 527 <p>Well, bugs or missing features are always possible, and I will make a
 528 point of fixing them in a timely fashion. The best way to report a bug is to
 529 use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome
 530 bug tracking database</a> (make sure to use the "libxml2" module name). I
 531 look at reports there regularly and it's good to have a reminder when a bug
 532 is still open. Be sure to specify that the bug is for the package libxml2.</p>
 533
 534 <p>For small problems you can try to get help on IRC, the #xml channel on
 535 irc.gnome.org (port 6667) usually have a few person subscribed which may help
 536 (but there is no guarantee and if a real issue is raised it should go on the
 537 mailing-list for archival).</p>
 538
 539 <p>There is also a mailing-list <a
 540 href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an  <a
 541 href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
 542 href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
 543 please visit the <a
 544 href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
 545 follow the instructions. <strong>Do not send code, I won't debug it</strong>
 546 (but patches are really appreciated!).</p>
 547
 548 <p>Please note that with the current amount of virus and SPAM, sending mail
 549 to the list without being subscribed won't work. There is *far too many
 550 bounces* (in the order of a thousand a day !) I cannot approve them manually
 551 anymore. If your mail to the list bounced waiting for administrator approval,
 552 it is LOST ! Repost it and fix the problem triggering the error. Also please
 553 note that <span style="color: #FF0000; background-color: #FFFFFF">emails with
 554 a legal warning asking to not copy or redistribute freely the information
 555 they contain</span> are <strong>NOT</strong> acceptable for the mailing-list,
 556 such mail will as much as possible be discarded automatically, and are less
 557 likely to be answered if they made it to the list, <strong>DO NOT</strong>
 558 post to the list from an email address where such legal requirements are
 559 automatically added, get private paying support if you can't share
 560 information.</p>
 561
 562 <p>Check the following <strong><span style="color: #FF0000">before
 563 posting</span></strong>:</p>
 564 <ul>
 565   <li>Read the <a href="FAQ.html">FAQ</a> and <a href="search.php">use the
 566     search engine</a> to get information related to your problem.</li>
 567   <li>Make sure you are <a href="ftp://xmlsoft.org/libxml2/">using a recent
 568     version</a>, and that the problem still shows up in a recent version.</li>
 569   <li>Check the <a href="http://mail.gnome.org/archives/xml/">list
 570     archives</a> to see if the problem was reported already. In this case
 571     there is probably a fix available, similarly check the <a
 572     href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registered
 573     open bugs</a>.</li>
 574   <li>Make sure you can reproduce the bug with xmllint or one of the test
 575     programs found in source in the distribution.</li>
 576   <li>Please send the command showing the error as well as the input (as an
 577     attachment)</li>
 578 </ul>
 579
 580 <p>Then send the bug with associated information to reproduce it to the <a
 581 href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
 582 related I will approve it. Please do not send mail to me directly, it makes
 583 things really hard to track and in some cases I am not the best person to
 584 answer a given question, ask on the list.</p>
 585
 586 <p>To <span style="color: #E50000">be really clear about support</span>:</p>
 587 <ul>
 588   <li>Support or help <span style="color: #E50000">requests MUST be sent to
 589     the list or on bugzilla</span> in case of problems, so that the Question
 590     and Answers can be shared publicly. Failing to do so carries the implicit
 591     message "I want free support but I don't want to share the benefits with
 592     others" and is not welcome. I will automatically Carbon-Copy the
 593     xml@gnome.org mailing list for any technical reply made about libxml2 or
 594     libxslt.</li>
 595   <li>There is <span style="color: #E50000">no guarantee of support</span>. If
 596     your question remains unanswered after a week, repost it, making sure you
 597     gave all the detail needed and the information requested.</li>
 598   <li>Failing to provide information as requested or double checking first
 599     for prior feedback also carries the implicit message "the time of the
 600     library maintainers is less valuable than my time" and might not be
 601     welcome.</li>
 602 </ul>
 603
 604 <p>Of course, bugs reported with a suggested patch for fixing them will
 605 probably be processed faster than those without.</p>
 606
 607 <p>If you're looking for help, a quick look at <a
 608 href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
 609 provide the answer. I usually send source samples when answering libxml2
 610 usage questions. The <a
 611 href="http://xmlsoft.org/html/book1.html">auto-generated documentation</a> is
 612 not as polished as I would like (i need to learn more about DocBook), but
 613 it's a good starting point.</p>
 614
 615 <h2><a name="help">How to help</a></h2>
 616
 617 <p>You can help the project in various ways, the best thing to do first is to
 618 subscribe to the mailing-list as explained before, check the <a
 619 href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
 620 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug
 621 database</a>:</p>
 622 <ol>
 623   <li>Provide patches when you find problems.</li>
 624   <li>Provide the diffs when you port libxml2 to a new platform. They may not
 625     be integrated in all cases but help pinpointing portability problems
 626   and</li>
 627   <li>Provide documentation fixes (either as patches to the code comments or
 628     as HTML diffs).</li>
 629   <li>Provide new documentations pieces (translations, examples, etc
 630   ...).</li>
 631   <li>Check the TODO file and try to close one of the items.</li>
 632   <li>Take one of the points raised in the archive or the bug database and
 633     provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
 634     </a>before to avoid synchronization problems and check that the suggested
 635     fix will fit in nicely :-)</li>
 636 </ol>
 637
 638 <h2><a name="Downloads">Downloads</a></h2>
 639
 640 <p>The latest versions of libxml2 can be found on the <a
 641 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> server ( <a
 642 href="ftp://xmlsoft.org/libxml2/">FTP</a> and rsync are available), there are also
 643 mirrors (<a href="ftp://fr.rpmfind.net/pub/libxml/">France</a> and
 644 Antonin Sprinzl also provide <a href="ftp://gd.tuwien.ac.at/pub/libxml/">a
 645 mirror in Austria</a>). (NOTE that you need both the <a
 646 href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
 647 href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
 648 packages installed to compile applications using libxml if using RPMs.)</p>
 649
 650 <p>You can find all the history of libxml(2) and libxslt releases in the <a
 651 href="http://xmlsoft.org/sources/old/">old</a> directory. The precompiled
 652 Windows binaries made by Igor Zlatovic are available in the <a
 653 href="http://xmlsoft.org/sources/win32/">win32</a> directory.</p>
 654
 655 <p>Binary ports:</p>
 656 <ul>
 657   <li>RPMs for x86_64 are available directly on <a
 658     href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM will compile on
 659     any architecture supported.</li>
 660   <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
 661     maintainer of the Windows port, <a
 662     href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
 663     binaries</a>.</li>
 664   <li>OpenCSW provides <a
 665     href="http://opencsw.org/packages/libxml2">Solaris
 666   binaries</a>.</li>
 667   <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> provides <a
 668     href="http://www.explain.com.au/oss/libxml2xslt.html">Mac Os X
 669     binaries</a>.</li>
 670   <li>The HP-UX porting center provides <a
 671     href="http://hpux.connect.org.uk/hppd/hpux/Gnome/">HP-UX binaries</a></li>
 672   <li>Bull provides precompiled <a
 673     href="http://gnome.bullfreeware.com/new_index.html">RPMs for AIX</a> as
 674     patr of their GNOME packages</li>
 675 </ul>
 676
 677 <p>If you know other supported binary ports, please <a
 678 href="http://veillard.com/">contact me</a>.</p>
 679
 680 <p><a name="Snapshot">Snapshot:</a></p>
 681 <ul>
 682   <li>Code from the GNOME GIT base libxml2 module, updated hourly <a
 683     href="ftp://xmlsoft.org/libxml2/libxml2-git-snapshot.tar.gz">libxml2-git-snapshot.tar.gz</a>.</li>
 684   <li>Docs, content of the web site, the list archive included <a
 685     href="ftp://xmlsoft.org/libxml2/libxml-docs.tar.gz">libxml-docs.tar.gz</a>.</li>
 686 </ul>
 687
 688 <p><a name="Contribs">Contributions:</a></p>
 689
 690 <p>I do accept external contributions, especially if compiling on another
 691 platform,  get in touch with the list to upload the package, wrappers for
 692 various languages have been provided, and can be found in the <a
 693 href="python.html">bindings section</a></p>
 694
 695 <p>Libxml2 is also available from GIT:</p>
 696 <ul>
 697   <li><p>See <a href="http://git.gnome.org/browse/libxml2/">libxml2 Git web</a>.
 698          To checkout a local tree use:</p>
 699        <pre>git clone git://git.gnome.org/libxml2</pre>
 700   </li>
 701   <li>The <strong>libxslt</strong> module is also present
 702       <a href="http://git.gnome.org/browse/libxslt/">there</a>.</li>
 703 </ul>
 704
 705 <h2><a name="News">Releases</a></h2>
 706
 707 <p>Items not finished and worked on, get in touch with the list if you want
 708 to help those</p>
 709 <ul>
 710   <li>More testing on RelaxNG</li>
 711   <li>Finishing up <a href="http://www.w3.org/TR/xmlschema-1/">XML
 712   Schemas</a></li>
 713 </ul>
 714
 715 <p>The <a href="ChangeLog.html">change log</a> describes the recents commits
 716 to the <a href="http://svn.gnome.org/viewvc/libxml2/trunk/">SVN</a> code base.</p>
 717
 718 <p>Here is the list of public releases:</p>
 719
 720 <h3>2.8.0: May 23 2012</h3>
 721 <ul>
 722   <li>Features:
 723 - add lzma compression support (Anders F Bjorklund)
 724   </li>
 725
 726   <li>Documentation:
 727     xmlcatalog: Add uri and delegateURI to possible add types in man page. (Ville Skyttä),
 728     Update README.tests (Daniel Veillard),
 729     URI handling code is not OOM resilient (Daniel Veillard),
 730     Fix an error in comment (Daniel Veillard),
 731     Fixed bug #617016 (Daniel Mustieles),
 732     Fixed two typos in the README document (Daniel Neel),
 733     add generated html files (Anders F Bjorklund),
 734     Clarify the need to use xmlFreeNode after xmlUnlinkNode (Daniel Veillard),
 735     Improve documentation a bit (Daniel Veillard),
 736     Updated URL for lxml python bindings (Daniel Veillard)
 737   </li>
 738
 739   <li>Portability:
 740     Restore code for Windows compilation (Daniel Veillard),
 741     Remove git error message during configure (Christian Dywan),
 742     xmllint: Build fix for endTimer if !defined(HAVE_GETTIMEOFDAY) (Patrick R. Gansterer),
 743     remove a bashism in confgure.in (John Hein),
 744     undef ERROR if already defined (Patrick R. Gansterer),
 745     Fix library problems with mingw-w64 (Michael Cronenworth),
 746     fix windows build. ifdef addition from bug 666491 makes no sense (Rob Richards),
 747     prefer native threads on win32 (Sam Thursfield),
 748     Allow to compile with Visual Studio 2010 (Thomas Lemm),
 749     Fix mingw's snprintf configure check (Andoni Morales),
 750     fixed a 64bit big endian issue (Marcus Meissner),
 751     Fix portability failure if netdb.h lacks NO_ADDRESS (Daniel Veillard),
 752     Fix windows build from lzma addition (Rob Richards),
 753     autogen: Only check for libtoolize (Colin Walters),
 754     Fix the Windows build files (Patrick von Reth),
 755     634846 Remove a linking option breaking Windows VC10 (Daniel Veillard),
 756     599241 fix an initialization problem on Win64 (Andrew W. Nosenko),
 757     fix win build (Rob Richards)
 758   </li>
 759
 760   <li>Bug fixes:
 761     Part for rand_r checking missing (Daniel Veillard),
 762     Cleanup on randomization (Daniel Veillard),
 763     Fix undefined reference in python module (Pacho Ramos),
 764     Fix a race in xmlNewInputStream (Daniel Veillard),
 765     Fix weird streaming RelaxNG errors (Noam),
 766     Fix various bugs in new code raised by the API checking (Daniel Veillard),
 767     Fix various problems with "make dist" (Daniel Veillard),
 768     Fix a memory leak in the xzlib code (Daniel Veillard),
 769     HTML parser error with &lt;noscript&gt; in the &lt;head&gt; (Denis Pauk),
 770     XSD: optional element in complex type extension (Remi Gacogne),
 771     Fix html serialization error and htmlSetMetaEncoding() (Daniel Veillard),
 772     Fix a wrong return value in previous patch (Daniel Veillard),
 773     Fix an uninitialized variable use (Daniel Veillard),
 774     Fix a compilation problem with --minimum (Brandon Slack),
 775     Remove redundant and ungarded include of resolv.h (Daniel Veillard),
 776     xinclude with parse="text" does not use the entity loader (Shaun McCance),
 777     Allow to parse 1 byte HTML files (Denis Pauk),
 778     Patch that fixes the skipping of the HTML_PARSE_NOIMPLIED flag (Martin Schröder),
 779     Avoid memory leak if xmlParserInputBufferCreateIO fails (Lin Yi-Li),
 780     Prevent an infinite loop when dumping a node with encoding problems (Timothy Elliott),
 781     xmlParseNodeInContext problems with an empty document (Tim Elliott),
 782     HTML element position is not detected propperly (Pavel Andrejs),
 783     Fix an off by one pointer access (Jüri Aedla),
 784     Try to fix a problem with entities in SAX mode (Daniel Veillard),
 785     Fix a crash with xmllint --path on empty results (Daniel Veillard),
 786     Fixed bug #667946 (Daniel Mustieles),
 787     Fix a logic error in Schemas Component Constraints (Ryan Sleevi),
 788     Fix a wrong enum type use in Schemas Types (Nico Weber),
 789     Fix SAX2 builder in case of undefined attributes namespace (Daniel Veillard),
 790     Fix SAX2 builder in case of undefined element namespaces (Daniel Veillard),
 791     fix reference to STDOUT_FILENO on MSVC (Tay Ray Chuan),
 792     fix a pair of possible out of array char references (Daniel Veillard),
 793     Fix an allocation error when copying entities (Daniel Veillard),
 794     Make sure the parser returns when getting a Stop order (Chris Evans),
 795     Fix some potential problems on reallocation failures(parser.c) (Xia Xinfeng),
 796     Fix a schema type duration comparison overflow (Daniel Veillard),
 797     Fix an unimplemented part in RNG value validation (Daniel Veillard),
 798     Fix missing error status in XPath evaluation (Daniel Veillard),
 799     Hardening of XPath evaluation (Daniel Veillard),
 800     Fix an off by one error in encoding (Daniel Veillard),
 801     Fix RELAX NG include bug #655288 (Shaun McCance),
 802     Fix XSD validation bug #630130 (Toyoda Eizi),
 803     Fix some potential problems on reallocation failures (Chris Evans),
 804     __xmlRaiseError: fix use of the structured callback channel (Dmitry V. Levin),
 805     __xmlRaiseError: fix the structured callback channel's data initialization (Dmitry V. Levin),
 806     Fix memory corruption when xmlParseBalancedChunkMemoryInternal is called from xmlParseBalancedChunk (Rob Richards),
 807     Small fix for previous commit (Daniel Veillard),
 808     Fix a potential freeing error in XPath (Daniel Veillard),
 809     Fix a potential memory access error (Daniel Veillard),
 810     Reactivate the shared library versionning script (Daniel Veillard)
 811   </li>
 812
 813   <li>Improvements:
 814     use mingw C99 compatible functions {v}snprintf instead those from MSVC runtime (Roumen Petrov),
 815     New symbols added for the next release (Daniel Veillard),
 816     xmlTextReader bails too quickly on error (Andy Lutomirski),
 817     Use a hybrid allocation scheme in xmlNodeSetContent (Conrad Irwin),
 818     Use buffers when constructing string node lists. (Conrad Irwin),
 819     Add HTML parser support for HTML5 meta charset encoding declaration (Denis Pauk),
 820     wrong message for double hyphen in comment XML error (Bryan Henderson),
 821     Fix "make tst" to grab lzma lib too (Daniel Veillard),
 822     Add "whereis" command to xmllint shell (Ryan),
 823     Improve xmllint shell (Ryan),
 824     add function xmlTextReaderRelaxNGValidateCtxt() (Noam Postavsky),
 825     Add --system support to autogen.sh (Daniel Veillard),
 826     Add hash randomization to hash and dict structures (Daniel Veillard),
 827     included xzlib in dist (Anders F Bjorklund),
 828     move xz/lzma helpers to separate included files (Anders F Bjorklund),
 829     add generated devhelp files (Anders F Bjorklund),
 830     add XML_WITH_LZMA to api (Anders F Bjorklund),
 831     autogen.sh: Honor NOCONFIGURE environment variable (Colin Walters),
 832     Improve the error report on undefined REFs (Daniel Veillard),
 833     Add exception for new W3C PI xml-model (Daniel Veillard),
 834     Add options to ignore the internal encoding (Daniel Veillard),
 835     testapi: use the right type for the check (Stefan Kost),
 836     various: handle return values of write calls (Stefan Kost),
 837     testWriter: xmlTextWriterWriteFormatElement wants an int instead of a long int (Stefan Kost),
 838     runxmlconf: update to latest testsuite version (Stefan Kost),
 839     configure: add -Wno-long-long to CFLAGS (Stefan Kost),
 840     configure: support silent automake rules if possible (Stefan Kost),
 841     xmlmemory: add a cast as size_t has no portable printf modifier (Stefan Kost),
 842     __xmlRaiseError: remove redundant schannel initialization (Dmitry V. Levin),
 843     __xmlRaiseError: do cheap code check early (Dmitry V. Levin)
 844   </li>
 845
 846   <li>Cleanups:
 847     Cleanups before 2.8.0-rc2 (Daniel Veillard),
 848     Avoid an extra operation (Daniel Veillard),
 849     Remove vestigial de-ANSI-fication support. (Javier Jardón),
 850     autogen.sh: Fix typo (Javier Jardón),
 851     Do not use unsigned but unsigned int (Daniel Veillard),
 852     Remove two references to u_short (Daniel Veillard),
 853     Fix -Wempty-body warning from clang (Nico Weber),
 854     Cleanups of lzma support (Daniel Veillard),
 855     Augment the list of ignored files (Daniel Veillard),
 856     python: remove unused variable (Stefan Kost),
 857     python: flag two unused args (Stefan Kost),
 858     configure: acconfig.h is deprecated since autoconf-2.50 (Stefan Kost),
 859     xpath: remove unused variable (Stefan Kost)
 860   </li>
 861 </ul>
 862 <h3>2.7.8: Nov 4 2010</h3>
 863 <ul>
 864   <li> Features:
 865     480323 add code to plug in ICU converters by default (Giuseppe Iuculano),
 866     Add xmlSaveOption XML_SAVE_WSNONSIG (Adam Spragg)
 867   </li>
 868   <li> Documentation:
 869     Fix devhelp documentation installation (Mike Hommey),
 870     Fix web site encoding problems (Daniel Veillard),
 871     Fix a couple of typo in HTML parser error messages (Michael Day),
 872     Forgot to update the news page for 0.7.7 (Daniel Veillard)
 873   </li>
 874   <li> Portability:
 875     607273 Fix python detection on MSys/Windows (LRN),
 876     614087 Fix Socket API usage to allow Windows64 compilation (Ozkan Sezer),
 877     Fix compilation with Clang (Koop Mast),
 878     Fix Win32 build (Rob Richards)
 879   </li>
 880   <li> Bug Fixes:
 881     595789 fix a remaining potential Solaris problem (Daniel Veillard),
 882     617468 fix progressive HTML parsing with style using "'" (Denis Pauk),
 883     616478 Fix xmllint shell write command (Gwenn Kahz),
 884     614005 Possible erroneous HTML parsing on unterminated script (Pierre Belzile),
 885     627987 Fix XSD IDC errors in imported schemas (Jim Panetta),
 886     629325 XPath rounding errors first cleanup (Phil Shafer),
 887     630140 fix iso995x encoding error (Daniel Veillard),
 888     make sure htmlCtxtReset do reset the disableSAX field (Daniel Veillard),
 889     Fix a change of semantic on XPath preceding and following axis (Daniel Veillard),
 890     Fix a potential segfault due to weak symbols on pthreads (Mike Hommey),
 891     Fix a leak in XPath compilation (Daniel Veillard),
 892     Fix the semantic of XPath axis for namespace/attribute context nodes (Daniel Veillard),
 893     Avoid a descriptor leak in catalog loading code (Carlo Bramini),
 894     Fix a small bug in XPath evaluation code (Marius Wachtler),
 895     Fix handling of XML-1.0 XML namespace declaration (Daniel Veillard),
 896     Fix errors in XSD double validation check (Csaba Raduly),
 897     Fix handling of apos in URIs (Daniel Veillard),
 898     xmlTextReaderReadOuterXml should handle DTD (Rob Richards),
 899     Autogen.sh needs to create m4 directory (Rob Richards)
 900   </li>
 901   <li> Improvements:
 902     606592 update language ID parser to RFC 5646 (Daniel Veillard),
 903     Sort python generated stubs (Mike Hommey),
 904     Add an HTML parser option to avoid a default doctype (Daniel Veillard)
 905   </li>
 906   <li> Cleanups:
 907     618831 don't ship generated files in git (Adrian Bunk),
 908     Switch from the obsolete mkinstalldirs to AC_PROG_MKDIR_P (Adrian Bunk),
 909     Various cleanups on encoding handling (Daniel Veillard),
 910     Fix xmllint to use format=1 for default formatting (Adam Spragg),
 911     Force _xmlSaveCtxt.format to be 0 or 1 (Adam Spragg),
 912     Cleanup encoding pointer comparison (Nikolay Sivov),
 913     Small code cleanup on previous patch (Daniel Veillard)
 914   </li>
 915 </ul>
 916 <h3>2.7.7: Mar 15 2010</h3>
 917 <ul>
 918   <li> Improvements:
 919     Adding a --xpath option to xmllint (Daniel Veillard),
 920     Make HTML parser non-recursive (Eugene Pimenov)
 921   </li>
 922   <li> Portability:
 923     relaxng.c: cast to allow compilation with sun studio 11 (Ben Walton),
 924     Fix build failure on Sparc solaris (Roumen Petrov),
 925     use autoreconf in autogen.sh (Daniel Veillard),
 926     Fix build with mingw (Roumen Petrov),
 927     Upgrade some of the configure and autogen (Daniel Veillard),
 928     Fix relaxNG tests in runtest for Windows runtest.c: initialize ret (Rob Richards),
 929     Fix a const warning in xmlNodeSetBase (Martin Trappel),
 930     Fix python generator to not use deprecated xmllib (Daniel Veillard),
 931     Update some automake files (Daniel Veillard),
 932     598785 Fix nanohttp on Windows (spadix)
 933   </li>
 934   <li> Bug Fixes:
 935     libxml violates the zlib interface and crashes (Mark Adler),
 936     Fix broken escape behaviour in regexp ranges (Daniel Veillard),
 937     Fix  missing win32 libraries in libxml-2.0.pc (Volker Grabsch),
 938     Fix detection of python linker flags (Daniel Macks),
 939     fix build error in libxml2/python (Paul Smith),
 940     ChunkParser: Incorrect decoding of small xml files (Raul Hudea),
 941     htmlCheckEncoding doesn't update input-end after shrink (Eugene Pimenov),
 942     Fix a missing #ifdef (Daniel Veillard),
 943     Fix encoding selection for xmlParseInNodeContext (Daniel Veillard),
 944     xmlPreviousElementSibling mistake (FranÃ§ois Delyon),
 945     608773 add a missing check in xmlGROW (Daniel Veillard),
 946     Fix xmlParseInNodeContext for HTML content (Daniel Veillard),
 947     Fix lost namespace when copying node * tree.c: reconcile namespace if not found (Rob Richards),
 948     Fix some missing commas in HTML element lists (Eugene Pimenov),
 949     Correct variable type to unsigned (Nikolay Sivov),
 950     Recognize ID attribute in HTML without DOCTYPE (Daniel Veillard),
 951     Fix memory leak in xmlXPathEvalExpression() (Martin),
 952     Fix an init bug in global.c (Kai Henning),
 953     Fix xmlNodeSetBase() comment (Daniel Veillard),
 954     Fix broken escape behaviour in regexp ranges (Daniel Veillard),
 955     Don't give default HTML boolean attribute values in parser (Daniel Veillard),
 956     xmlCtxtResetLastError should reset ctxt-errNo (Daniel Veillard)
 957   </li>
 958   <li> Cleanups:
 959     Cleanup a couple of weirdness in HTML parser (Eugene Pimenov)
 960   </li>
 961 </ul>
 962 <h3>2.7.6: Oct  6 2009</h3>
 963 <ul>
 964   <li> Bug Fixes:
 965      Restore thread support in default configuration (Andrew W. Nosenko),
 966      URI with no path parsing problem (Daniel Veillard),
 967      Minor patch for conditional defines in threads.c (Eric Zurcher)
 968   </li>
 969 </ul>
 970 <h3>2.7.5: Sep 24 2009</h3>
 971 <ul>
 972   <li> Bug Fixes:
 973     Restore behavior of --with-threads without argument (Andrew W. Nosenko),
 974     Fix memory leak when doc is NULL (Rob Richards),
 975     595792 fixing a RelaxNG bug introduced in 2.7.4 (Daniel Veillard),
 976     Fix a Relaxng bug raised by libvirt test suite (Daniel Veillard),
 977     Fix a parsing problem with little data at startup (Daniel Veillard),
 978     link python module with python library (Frederic Crozat),
 979     594874 Forgot an fclose in xmllint (Daniel Veillard)
 980   </li>
 981   <li> Cleanup:
 982     Adding symbols.xml to EXTRA_DIST (Daniel Veillard)
 983   </li>
 984 </ul>
 985 <h3>2.7.4: Sep 10 2009</h3>
 986 <ul>
 987   <li>Improvements:
 988     Switch to GIT (GNOME),
 989     Add symbol versioning to libxml2 shared libs (Daniel Veillard)
 990   </li>
 991   <li>Portability:
 992     593857 try to work around thread pbm MinGW 4.4 (Daniel Veillard),
 993     594250 rename ATTRIBUTE_ALLOC_SIZE to avoid clashes (Daniel Veillard),
 994     Fix Windows build * relaxng.c: fix windows build (Rob Richards),
 995     Fix the globals.h to use XMLPUBFUN (Paul Smith),
 996     Problem with extern extern in header (Daniel Veillard),
 997     Add -lnetwork for compiling on Haiku (Scott McCreary),
 998     Runtest portability patch for Solaris (Tim Rice),
 999     Small patch to accomodate the Haiku OS (Scott McCreary),
1000     584605 package VxWorks folder in the distribution (Daniel Veillard),
1001     574017 Realloc too expensive on most platform (Daniel Veillard),
1002     Fix windows build (Rob Richards),
1003     545579 doesn't compile without schema support (Daniel Veillard),
1004     xmllint use xmlGetNodePath when not compiled in (Daniel Veillard),
1005     Try to avoid __imp__xmlFree link trouble on msys (Daniel Veillard),
1006     Allow to select the threading system on Windows (LRN),
1007     Fix Solaris binary links, cleanups (Daniel Veillard),
1008     Bug 571059 â\80\93 MSVC doesn't work with the bakefile (Intron),
1009     fix ATTRIBUTE_PRINTF header clash (Belgabor and Mike Hommey),
1010     fixes for Borland/CodeGear/Embarcadero compilers (Eric Zurcher)
1011   </li>
1012   <li>Documentation:
1013     544910 typo: "renciliateNs" (Leonid Evdokimov),
1014     Add VxWorks to list of OSes (Daniel Veillard),
1015     Regenerate the documentation and update for git (Daniel Veillard),
1016     560524 Â¿ xmlTextReaderLocalName description (Daniel Veillard),
1017     Added sponsoring by AOE media for the server (Daniel Veillard),
1018     updated URLs for GNOME (Vincent Lefevre),
1019     more warnings about xmlCleanupThreads and xmlCleanupParser (Daniel Veillard)
1020   </li>
1021   <li>Bug fixes:
1022     594514 memory leaks - duplicate initialization (MOD),
1023     Wrong block opening in htmlNodeDumpOutputInternal (Daniel Veillard),
1024     492317 Fix  Relax-NG validation problems (Daniel Veillard),
1025     558452 fight with reg test and error report (Daniel Veillard),
1026     558452 RNG compilation of optional multiple child (Daniel Veillard),
1027     579746 XSD validation not correct / nilable groups (Daniel Veillard),
1028     502960 provide namespace stack when parsing entity (Daniel Veillard),
1029     566012 part 2 fix regresion tests and push mode (Daniel Veillard),
1030     566012 autodetected encoding and encoding conflict (Daniel Veillard),
1031     584220 xpointer(/) and xinclude problems (Daniel Veillard),
1032     587663 Incorrect Attribute-Value Normalization (Daniel Veillard),
1033     444994 HTML chunked failure for attribute with &lt;&gt; (Daniel Veillard),
1034     Fix end of buffer char being split in XML parser (Daniel Veillard),
1035     Non ASCII character may be split at buffer end (Adiel Mittmann),
1036     440226 Add xmlXIncludeProcessTreeFlagsData API (Stefan Behnel),
1037     572129 speed up parsing of large HTML text nodes (Markus Kull),
1038     Fix HTML parsing with 0 character in CDATA (Daniel Veillard),
1039     Fix SetGenericErrorFunc and SetStructured clash (Wang Lam),
1040     566012  Incomplete EBCDIC parsing support (Martin Kogler),
1041     541335 HTML avoid creating 2 head or 2 body element (Daniel Veillard),
1042     541237 error correcting missing end tags in HTML (Daniel Veillard),
1043     583439 missing line numbers in push mode (Daniel Veillard),
1044     587867 xmllint --html --xmlout serializing as HTML (Daniel Veillard),
1045     559501 avoid select and use poll for nanohttp (Raphael Prevost),
1046     559410 -  Regexp bug on (...)? constructs (Daniel Veillard),
1047     Fix a small problem on previous HTML parser patch (Daniel Veillard),
1048     592430 -  HTML parser runs into endless loop (Daniel Veillard),
1049     447899 potential double free in xmlFreeTextReader (Daniel Veillard),
1050     446613 small validation bug mixed content with NS (Daniel Veillard),
1051     Fix the problem of revalidating a doc with RNG (Daniel Veillard),
1052     Fix xmlKeepBlanksDefault to not break indent (Nick Wellnhofer),
1053     512131 refs from externalRef part need to be added (Daniel Veillard),
1054     512131 crash in xmlRelaxNGValidateFullElement (Daniel Veillard),
1055     588441 allow '.' in HTML Names even if invalid (Daniel Veillard),
1056     582913 Fix htmlSetMetaEncoding() to be nicer (Daniel Veillard),
1057     579317 Try to find the HTML encoding information (Daniel Veillard),
1058     575875 don't output charset=html (Daniel Veillard),
1059     571271 fix semantic of xsd:all with minOccurs=0 (Daniel Veillard),
1060     570702 fix a bug in regexp determinism checking (Daniel Veillard),
1061     567619 xmlValidateNotationUse missing param test (Daniel Veillard),
1062     574393 Â¿ utf-8 filename magic for compressed files (Hans Breuer),
1063     Fix a couple of problems in the parser (Daniel Veillard),
1064     585505 Â¿ Document ids and refs populated by XSD (Wayne Jensen),
1065     582906 XSD validating multiple imports of the same schema (Jason Childs),
1066     Bug 582887 Â¿ problems validating complex schemas (Jason Childs),
1067     Bug 579729 Â¿ fix XSD schemas parsing crash (Miroslav Bajtos),
1068     576368 Â¿ htmlChunkParser with special attributes (Jiri Netolicky),
1069     Bug 565747 Â¿ relax anyURI data character checking (Vincent Lefevre),
1070     Preserve attributes of include start on tree copy (Petr Pajas),
1071     Skip silently unrecognized XPointer schemes (Jakub Wilk),
1072     Fix leak on SAX1, xmllint --sax1 option and debug (Daniel Veillard),
1073     potential NULL dereference on non-glibc (Jim Meyering),
1074     Fix an XSD validation crash (Daniel Veillard),
1075     Fix a regression in streaming entities support (Daniel Veillard),
1076     Fix a couple of ABI issues with C14N 1.1 (Aleksey Sanin),
1077     Aleksey Sanin support for c14n 1.1 (Aleksey Sanin),
1078     reader bug fix with entities (Daniel Veillard),
1079     use options from current parser ctxt for external entities (Rob Richards),
1080     581612 use %s to printf strings (Christian Persch),
1081     584605 change the threading initialization sequence (Igor Novoseltsev),
1082     580705 keep line numbers in HTML parser (Aaron Patterson),
1083     581803 broken HTML table attributes init (Roland Steiner),
1084     do not set error code in xmlNsWarn (Rob Richards),
1085     564217 fix structured error handling problems,
1086     reuse options from current parser for entities (Rob Richards),
1087     xmlXPathRegisterNs should not allow enpty prefixes (Daniel Veillard),
1088     add a missing check in xmlAddSibling (Kris Breuker),
1089     avoid leaks on errors (Jinmei Tatuya)
1090   </li>
1091   <li>Cleanup:
1092     Chasing dead assignments reported by clang-scan (Daniel Veillard),
1093     A few more safety cleanup raised by scan (Daniel Veillard),
1094     Fixing assorted potential problems raised by scan (Daniel Veillard),
1095     Potential uninitialized arguments raised by scan (Daniel Veillard),
1096     Fix a bunch of scan 'dead increments' and cleanup (Daniel Veillard),
1097     Remove a pedantic warning (Daniel Veillard),
1098     555833 always use rm -f in uninstall-local (Daniel Veillard),
1099     542394 xmlRegisterOutputCallbacks MAX_INPUT_CALLBACK (Daniel Veillard),
1100     Autoregenerate libxml2.syms automated checkings (Daniel Veillard),
1101     Make xmlRecoverDoc const (Martin Trappel) (Daniel Veillard),
1102     Both args of xmlStrcasestr are const (Daniel Veillard),
1103     hide the nbParse* variables used for debugging (Mike Hommey),
1104     570806 changed include of config.h (William M. Brack),
1105     cleanups and error reports when xmlTextWriterVSprintf fails (Jinmei Tatuya)
1106   </li>
1107 </ul>
1108 <h3>2.7.3: Jan 18 2009</h3>
1109 <ul>
1110   <li>Build fix: fix build when HTML support is not included.</li>
1111   <li>Bug fixes: avoid memory overflow in gigantic text nodes,
1112       indentation problem on the writed (Rob Richards),
1113       xmlAddChildList pointer problem (Rob Richards and Kevin Milburn),
1114       xmlAddChild problem with attribute (Rob Richards and Kris Breuker),
1115       avoid a memory leak in an edge case (Daniel Zimmermann),
1116       deallocate some pthread data (Alex Ott).</li>
1117   <li>Improvements: configure option to avoid rebuilding docs (Adrian Bunk),
1118       limit text nodes to 10MB max by default, add element traversal
1119       APIs, add a parser option to enable pre 2.7 SAX behavior (Rob Richards),
1120       add gcc malloc checking (Marcus Meissner), add gcc printf like functions
1121       parameters checking (Marcus Meissner).</li>
1122 </ul>
1123 <h3>2.7.2: Oct 3 2008</h3>
1124 <ul>
1125     <li>Portability fix: fix solaris compilation problem, fix compilation
1126         if XPath is not configured in</li>
1127     <li>Bug fixes: nasty entity bug introduced in 2.7.0, restore old behaviour
1128         when saving an HTML doc with an xml dump function, HTML UTF-8 parsing
1129         bug, fix reader custom error handlers (Riccardo Scussat)
1130     <li>Improvement: xmlSave options for more flexibility to save as
1131         XML/HTML/XHTML, handle leading BOM in HTML documents</li>
1132 </ul>
1133
1134 <h3>2.7.1: Sep 1 2008</h3>
1135 <ul>
1136     <li>Portability fix: Borland C fix (Moritz Both)</li>
1137     <li>Bug fixes: python serialization wrappers, XPath QName corner
1138         case handking and leaks (Martin)</li>
1139     <li>Improvement: extend the xmlSave to handle HTML documents and trees</li>
1140     <li>Cleanup: python serialization wrappers</li>
1141 </ul>
1142
1143 <h3>2.7.0: Aug 30 2008</h3>
1144 <ul>
1145   <li>Documentation: switch ChangeLog to UTF-8, improve mutithreads and
1146       xmlParserCleanup docs</li>
1147   <li>Portability fixes: Older Win32 platforms (Rob Richards), MSVC
1148       porting fix (Rob Richards), Mac OS X regression tests (Sven Herzberg),
1149       non GNUCC builds (Rob Richards), compilation on Haiku (Andreas FÃ¤rber)
1150       </li>
1151   <li>Bug fixes: various realloc problems (Ashwin), potential double-free
1152       (Ashwin), regexp crash, icrash with invalid whitespace facets (Rob
1153       Richards), pattern fix when streaming (William Brack), various XML
1154       parsing and validation fixes based on the W3C regression tests, reader
1155       tree skipping function fix (Ashwin), Schemas regexps escaping fix
1156       (Volker Grabsch), handling of entity push errors (Ashwin), fix a slowdown
1157       when encoder cant serialize characters on output</li>
1158   <li>Code cleanup: compilation fix without the reader, without the output
1159       (Robert Schwebel), python whitespace (Martin), many space/tabs cleanups,
1160       serious cleanup of the entity handling code</li>
1161   <li>Improvement: switch parser to XML-1.0 5th edition, add parsing flags
1162       for old versions, switch URI parsing to RFC 3986,
1163       add xmlSchemaValidCtxtGetParserCtxt (Holger Kaelberer),
1164       new hashing functions for dictionnaries (based on Stefan Behnel work),
1165       improve handling of misplaced html/head/body in HTML parser, better
1166       regression test tools and code coverage display, better algorithms
1167       to detect various versions of the billion laughts attacks, make
1168       arbitrary parser limits avoidable as a parser option</li>
1169 </ul>
1170 <h3>2.6.32: Apr 8 2008</h3>
1171 <ul>
1172   <li>Documentation: returning heap memory to kernel (Wolfram Sang),
1173       trying to clarify xmlCleanupParser() use, xmlXPathContext improvement
1174       (Jack Jansen), improve the *Recover* functions documentation,
1175       XmlNodeType doc link fix (Martijn Arts)</li>
1176   <li>Bug fixes: internal subset memory leak (Ashwin), avoid problem with
1177       paths starting with // (Petr Sumbera), streaming XSD validation callback
1178       patches (Ashwin), fix redirection on port other than 80 (William Brack),
1179       SAX2 leak (Ashwin), XInclude fragment of own document (Chris Ryan),
1180       regexp bug with '.' (Andrew Tosh), flush the writer at the end of the
1181       document (Alfred Mickautsch), output I/O bug fix (William Brack),
1182       writer CDATA output after a text node (Alex Khesin), UTF-16 encoding
1183       detection (William Brack), fix handling of empty CDATA nodes for Safari
1184       team, python binding problem with namespace nodes, improve HTML parsing
1185       (Arnold Hendriks), regexp automata build bug, memory leak fix (Vasily
1186       Chekalkin), XSD test crash, weird system parameter entity parsing problem,
1187       allow save to file:///X:/ windows paths, various attribute normalisation
1188       problems, externalSubsetSplit fix (Ashwin), attribute redefinition in
1189       the DTD (Ashwin), fix in char ref parsing check (Alex Khesin), many
1190       out of memory handling fixes (Ashwin), XPath out of memory handling fixes
1191       (Alvaro Herrera), various realloc problems (Ashwin), UCS4 encoding
1192       conversion buffer size (Christian Fruth), problems with EatName
1193       functions on memory errors, BOM handling in external parsed entities
1194       (Mark Rowe)</li>
1195   <li>Code cleanup: fix build under VS 2008 (David Wimsey), remove useless
1196       mutex in xmlDict (Florent Guilian), Mingw32 compilation fix (Carlo
1197       Bramini), Win and MacOS EOL cleanups (Florent Guiliani), iconv need
1198       a const detection (Roumen Petrov), simplify xmlSetProp (Julien Charbon),
1199       cross compilation fixes for Mingw (Roumen Petrov), SCO Openserver build
1200       fix (Florent Guiliani), iconv uses const on Win32 (Rob Richards),
1201       duplicate code removal (Ashwin), missing malloc test and error reports
1202       (Ashwin), VMS makefile fix (Tycho Hilhorst)</li>
1203   <li>improvements: better plug of schematron in the normal error handling
1204       (Tobias Minich)</li>
1205 </ul>
1206
1207 <h3>2.6.31: Jan 11 2008</h3>
1208 <ul>
1209   <li>Security fix: missing of checks in UTF-8 parsing</li>
1210   <li>Bug fixes: regexp bug, dump attribute from XHTML document, fix
1211       xmlFree(NULL) to not crash in debug mode, Schematron parsing crash
1212       (Rob Richards), global lock free on Windows (Marc-Antoine Ruel),
1213       XSD crash due to double free (Rob Richards), indentation fix in
1214       xmlTextWriterFullEndElement (Felipe Pena), error in attribute type
1215       parsing if attribute redeclared, avoid crash in hash list scanner if
1216       deleting elements, column counter bug fix (Christian Schmidt),
1217       HTML embed element saving fix (Stefan Behnel), avoid -L/usr/lib
1218       output from xml2-config (Fred Crozat), avoid an xmllint crash
1219       (Stefan Kost), don't stop HTML parsing on out of range chars.
1220       </li>
1221   <li>Code cleanup: fix open() call third argument, regexp cut'n paste
1222       copy error, unused variable in __xmlGlobalInitMutexLock (Hannes Eder),
1223       some make distcheck realted fixes (John Carr)</li>
1224   <li>Improvements: HTTP Header: includes port number (William Brack),
1225       testURI --debug option, </li>
1226 </ul>
1227 <h3>2.6.30: Aug 23 2007</h3>
1228 <ul>
1229   <li>Portability: Solaris crash on error handling, windows path fixes
1230       (Roland Schwarz and Rob Richards), mingw build (Roland Schwarz)</li>
1231   <li>Bugfixes: xmlXPathNodeSetSort problem (William Brack), leak when
1232       reusing a writer for a new document (Dodji Seketeli), Schemas
1233       xsi:nil handling patch (Frank Gross), relative URI build problem
1234       (Patrik Fimml), crash in xmlDocFormatDump, invalid char in comment
1235       detection bug, fix disparity with xmlSAXUserParseMemory, automata
1236       generation for complex regexp counts problems, Schemas IDC import
1237       problems (Frank Gross), xpath predicate evailation error handling
1238       (William Brack)</li>
1239 </ul>
1240 <h3>2.6.29: Jun 12 2007</h3>
1241 <ul>
1242   <li>Portability: patches from Andreas Stricke for WinCEi,
1243       fix compilation warnings (William Brack), avoid warnings on Apple OS/X
1244       (Wendy Doyle and Mark Rowe), Windows compilation and threading
1245       improvements (Rob Richards), compilation against old Python versions,
1246       new GNU tar changes (Ryan Hill)</li>
1247   <li>Documentation: xmlURIUnescapeString comment, </li>
1248   <li>Bugfixes: xmlBufferAdd problem (Richard Jones), 'make valgrind'
1249       flag fix (Richard Jones), regexp interpretation of \,
1250       htmlCreateDocParserCtxt (Jean-Daniel Dupas), configure.in
1251       typo (Bjorn Reese), entity content failure, xmlListAppend() fix
1252       (Georges-AndrÃ© Silber), XPath number serialization (William Brack),
1253       nanohttp gzipped stream fix (William Brack and Alex Cornejo),
1254       xmlCharEncFirstLine typo (Mark Rowe), uri bug (FranÃ§ois Delyon),
1255       XPath string value of PI nodes (William Brack), XPath node set
1256       sorting bugs (William Brack), avoid outputting namespace decl
1257       dups in the writer (Rob Richards), xmlCtxtReset bug, UTF-8 encoding
1258       error handling, recustion on next in catalogs, fix a Relax-NG crash,
1259       workaround wrong file: URIs, htmlNodeDumpFormatOutput on attributes,
1260       invalid character in attribute detection bug, big comments before
1261       internal subset streaming bug, HTML parsing of attributes with : in
1262       the name, IDness of name in HTML (Dagfinn I. MannsÃ¥ker) </li>
1263   <li>Improvement: keep URI query parts in raw form (Richard Jones),
1264       embed tag support in HTML (Michael Day) </li>
1265 </ul>
1266
1267 <h3>2.6.28: Apr 17 2007</h3>
1268 <ul>
1269   <li>Documentation: comment fixes (Markus Keim), xpath comments fixes too
1270       (James Dennett)</li>
1271   <li>Bug fixes: XPath bug (William Brack), HTML parser autoclose stack usage
1272       (Usamah Malik), various regexp bug fixes (DV and William), path conversion
1273       on Windows (Igor Zlatkovic), htmlCtxtReset fix (Michael Day), XPath
1274       principal node of axis bug, HTML serialization of some codepoint
1275       (Steven Rainwater), user data propagation in XInclude (Michael Day),
1276       standalone and XML decl detection (Michael Day), Python id ouptut
1277       for some id, fix the big python string memory leak, URI parsing fixes
1278       (StÃ©phane Bidoul and William), long comments parsing bug (William),
1279       concurrent threads initialization (Ted Phelps), invalid char
1280       in text XInclude (William), XPath memory leak (William), tab in
1281       python problems (Andreas Hanke), XPath node comparison error
1282       (Oleg Paraschenko), cleanup patch for reader (Julien Reichel),
1283       XML Schemas attribute group (William), HTML parsing problem (William),
1284       fix char 0x2d in regexps (William), regexp quantifier range with
1285       min occurs of 0 (William), HTML script/style parsing (Mike Day)</li>
1286   <li>Improvement: make xmlTextReaderSetup() public</li>
1287   <li>Compilation and postability: fix a missing include problem (William),
1288       __ss_familly on AIX again (BjÃ¶rn Wiberg), compilation without zlib
1289       (Michael Day), catalog patch for Win32 (Christian Ehrlicher),
1290       Windows CE fixes (Andreas Stricke)</li>
1291   <li>Various CVS to SVN infrastructure changes</li>
1292 </ul>
1293 <h3>2.6.27: Oct 25 2006</h3>
1294 <ul>
1295   <li>Portability fixes: file names on windows (Roland Schwingel,
1296       Emelyanov Alexey), windows compile fixup (Rob Richards),
1297       AIX iconv() is apparently case sensitive</li>
1298   <li>improvements: Python XPath types mapping (Nic Ferrier), XPath optimization
1299       (Kasimier), add xmlXPathCompiledEvalToBoolean (Kasimier), Python node
1300       equality and comparison (Andreas Pakulat), xmlXPathCollectAndTest
1301       improvememt (Kasimier), expose if library was compiled with zlib
1302       support (Andrew Nosenko), cache for xmlSchemaIDCMatcher structs
1303       (Kasimier), xmlTextConcat should work with comments and PIs (Rob
1304       Richards), export htmlNewParserCtxt needed by Michael Day, refactoring
1305       of catalog entity loaders (Michael Day), add XPointer support to
1306       python bindings (Ross Reedstrom, Brian West and Stefan Anca),
1307       try to sort out most file path to URI conversions and xmlPathToUri,
1308       add --html --memory case to xmllint</li>
1309   <li>building fix: fix --with-minimum (Felipe Contreras), VMS fix,
1310       const'ification of HTML parser structures (Matthias Clasen),
1311       portability fix (Emelyanov Alexey), wget autodetection (Peter
1312       Breitenlohner),  remove the build path recorded in the python
1313       shared module, separate library flags for shared and static builds
1314       (Mikhail Zabaluev), fix --with-minimum --with-sax1 builds, fix
1315       --with-minimum --with-schemas builds</li>
1316   <li>bug fix: xmlGetNodePath fix (Kasimier), xmlDOMWrapAdoptNode and
1317       attribute (Kasimier), crash when using the recover mode,
1318       xmlXPathEvalExpr problem (Kasimier), xmlXPathCompExprAdd bug (Kasimier),
1319       missing destry in xmlFreeRMutex (Andrew Nosenko), XML Schemas fixes
1320       (Kasimier), warning on entities processing, XHTML script and style
1321       serialization (Kasimier), python generator for long types, bug in
1322       xmlSchemaClearValidCtxt (Bertrand Fritsch), xmlSchemaXPathEvaluate
1323       allocation bug (Marton Illes), error message end of line (Rob Richards),
1324       fix attribute serialization in writer (Rob Richards), PHP4 DTD validation
1325       crasher, parser safety patch (Ben Darnell), _private context propagation
1326       when parsing entities (with Michael Day), fix entities behaviour when
1327       using SAX, URI to file path fix (Mikhail Zabaluev), disapearing validity
1328       context, arg error in SAX callback (Mike Hommey), fix mixed-content
1329       autodetect when using --noblanks, fix xmlIOParseDTD error handling,
1330       fix bug in xmlSplitQName on special Names, fix Relax-NG element content
1331       validation bug, fix xmlReconciliateNs bug, fix potential attribute
1332       XML parsing bug, fix line/column accounting in XML parser, chunking bug
1333       in the HTML parser on script, try to detect obviously buggy HTML
1334       meta encoding indications, bugs with encoding BOM and xmlSaveDoc,
1335       HTML entities in attributes parsing, HTML minimized attribute values,
1336       htmlReadDoc and htmlReadIO were broken, error handling bug in
1337       xmlXPathEvalExpression (Olaf Walkowiak), fix a problem in
1338       htmlCtxtUseOptions, xmlNewInputFromFile could leak (Marius Konitzer),
1339       bug on misformed SSD regexps (Christopher Boumenot)
1340       </li>
1341   <li>documentation: warning about XML_PARSE_COMPACT (Kasimier Buchcik),
1342       fix xmlXPathCastToString documentation, improve man pages for
1343       xmllitn and xmlcatalog (Daniel Leidert), fixed comments of a few
1344       functions</li>
1345 </ul>
1346 <h3>2.6.26: Jun 6 2006</h3>
1347 <ul>
1348   <li>portability fixes: Python detection (Joseph Sacco), compilation
1349     error(William Brack and Graham Bennett), LynxOS patch (Olli Savia)</li>
1350   <li>bug fixes: encoding buffer problem, mix of code and data in
1351     xmlIO.c(Kjartan Maraas), entities in XSD validation (Kasimier Buchcik),
1352     variousXSD validation fixes (Kasimier), memory leak in pattern (Rob
1353     Richards andKasimier), attribute with colon in name (Rob Richards), XPath
1354     leak inerror reporting (Aleksey Sanin), XInclude text include of
1355     selfdocument.</li>
1356   <li>improvements: Xpath optimizations (Kasimier), XPath object
1357     cache(Kasimier)</li>
1358 </ul>
1359
1360 <h3>2.6.25: Jun 6 2006:</h3>
1361
1362 <p>Do not use or package 2.6.25</p>
1363
1364 <h3>2.6.24: Apr 28 2006</h3>
1365 <ul>
1366   <li>Portability fixes: configure on Windows, testapi compile on windows
1367       (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher),
1368       HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1
1369       cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on
1370       Windows (Roland Schwingel).
1371       </li>
1372   <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier
1373       Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li>
1374   <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext()
1375       on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming
1376       bug, xmlParseComment (with William Brack), regexp bug fixes (DV &amp;
1377       Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier),
1378       one Relax-NG interleave bug, xmllint --path and --valid,
1379       XSD bugfixes (Kasimier), remove debug
1380       left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole),
1381       xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large
1382       number of cleanups and small fixes based on Coverity reports, bug
1383       in character ranges, Unicode tables const (Aivars Kalvans), schemas
1384       fix (Stefan Kost), xmlRelaxNGParse error deallocation,
1385       xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed
1386       code point, ixmllint --nonet to never reach the net (Gary Coady),
1387       line break in writer after end PI (Jason Viers). </li>
1388   <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li>
1389   <li>New features: Relax NG structure error handlers.</li>
1390 </ul>
1391
1392 <h3>2.6.23: Jan 5 2006</h3>
1393 <ul>
1394   <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows
1395     (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas),
1396     --with-minimum compilation fixes (William Brack), error case handling fix
1397     on Solaris (Albert Chin), don't use 'list' as parameter name reported by
1398     Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin),
1399     MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick
1400   Jones),</li>
1401   <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose
1402     (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring
1403     parsing code (Bjorn Reese)</li>
1404   <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack),
1405     combinatory explosion and performances in regexp code, leak in
1406     xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo
1407     Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik),
1408     XPath pattern based evaluation bugs (DV &amp; Kasimier),
1409     xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in
1410     xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of
1411     vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF
1412     split problem (William), issues with non-namespaced attributes in
1413     xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards),
1414     HTML parsing of script, Python must not output to stdout (Nic Ferrier),
1415     exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype
1416     totalDigits bug (Kasimier Buchcik), error handling when writing to an
1417     xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi
1418     Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix
1419     XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier),
1420     fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml
1421     (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of
1422     runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs
1423     (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair),
1424     compilation and build fixes (Michael Day), removed dependancies on
1425     xmlSchemaValidError (Kasimier), bug with &lt;xml:foo/&gt;, more XPath
1426     pattern based evaluation fixes (Kasimier)</li>
1427   <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier
1428     Buchcik), node copy checks and fix for attribute (Rob Richards), counted
1429     transition bug in regexps, ctxt-&gt;standalone = -2 to indicate no
1430     standalone attribute was found, add xmlSchemaSetParserStructuredErrors()
1431     (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API
1432     (Kasimier), handle gzipped HTTP resources (Gary Coady), add
1433     htmlDocDumpMemoryFormat. (Rob Richards),</li>
1434   <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save
1435     function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li>
1436 </ul>
1437
1438 <h3>2.6.22: Sep 12 2005</h3>
1439 <ul>
1440   <li>build fixes: compile without schematron (StÃ©phane Bidoul)</li>
1441   <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i,
1442     CDATA push parser bug, xmlElemDump problem with XHTML1 doc,
1443     XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some
1444     output formatting for meta element (Rob Richards), script and style
1445     XHTML1 serialization (David Madore), Attribute derivation fixups in XSD
1446     (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li>
1447   <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add
1448     XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for
1449     derive (Kasimier Buchcik).</li>
1450   <li>documentation: generation of gtk-doc like docs, integration with
1451     devhelp.</li>
1452 </ul>
1453
1454 <h3>2.6.21: Sep 4 2005</h3>
1455 <ul>
1456   <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling
1457     convention problems on Windows (Marcus Boerger), cleanups based on Linus'
1458     sparse tool, update of win32/configure.js (Rob Richards), remove warnings
1459     on Windows(Marcus Boerger), compilation without SAX1, detection of the
1460     Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko),
1461     compilation/link with threads and old gcc, compile problem by C370 on
1462     Z/OS,</li>
1463   <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8
1464     bug (Jiri Netolicky), XPath NaN compare bug (William Brack),
1465     htmlParseScript potential bug, Schemas regexp handling of spaces, Base64
1466     Schemas comparisons NIST passes, automata build error xsd:all,
1467     xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas
1468     foreign namespaces handling, XML Schemas facet comparison (Kupriyanov
1469     Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml:
1470     namespace ahndling in Schemas (Kasimier), empty model group in Schemas
1471     (Kasimier), wilcard in Schemas (Kasimier), URI composition (William),
1472     xs:anyType in Schemas (Kasimier), Python resolver emmitting error
1473     messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to
1474     fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob
1475     Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8
1476     serialization, streaming XPath, Schemas determinism detection problem,
1477     XInclude bug, Schemas context type (Dean Hill), validation fix (Derek
1478     Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas
1479     type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling,
1480     xmlGetLineNo fixes, bug on entities handling, entity name extraction in
1481     error handling with XInclude, text nodes in HTML body tags (Gary Coady),
1482     xml:id and IDness at the treee level fixes, XPath streaming patterns
1483   bugs.</li>
1484   <li>improvements: structured interfaces for schemas and RNG error reports
1485     (Marcus Boerger), optimization of the char data inner loop parsing
1486     (thanks to Behdad Esfahbod for the idea), schematron validation though
1487     not finished yet, xmlSaveOption to omit XML declaration, keyref match
1488     error reports (Kasimier), formal expression handling code not plugged
1489     yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option
1490     for text nodes allocation.</li>
1491   <li>documentation: xmllint man page had --nonet duplicated</li>
1492 </ul>
1493
1494 <h3>2.6.20: Jul 10 2005</h3>
1495 <ul>
1496   <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor
1497     Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and
1498     andriy@google.com), use gcc weak references to pthread to avoid the
1499     pthread dependancy on Linux, compilation problem (Steve Nairn), compiling
1500     of subset (Morten Welinder), IPv6/ss_family compilation (William Brack),
1501     compilation when disabling parts of the library, standalone test
1502     distribution.</li>
1503   <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack),
1504     HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer
1505     overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup
1506     (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch
1507     (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup
1508     on XInclude (William), pattern fixes (William), attribute bug in
1509     exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob
1510     Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type
1511     QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug
1512     (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob
1513     Richards), a small RelaxNG leak, HTML parsing in push mode bug (James
1514     Bursa), failure to detect UTF-8 parsing bugs in CDATA sections,
1515     areBlanks() heuristic failure, duplicate attributes in DTD bug
1516   (William).</li>
1517   <li>improvements: lot of work on Schemas by Kasimier Buchcik both on
1518     conformance and streaming, Schemas validation messages (Kasimier Buchcik,
1519     Matthew Burgess), namespace removal at the python level (Brent
1520     Hendricks), Update to new Schemas regression tests from W3C/Nist
1521     (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of
1522     xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert),
1523     standalone test framework and programs, new DOM import APIs
1524     xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and
1525     xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and
1526     Schemas regression tests, xmlStopParser() available in pull mode too,
1527     ienhancement to xmllint --shell namespaces support, Windows port of the
1528     standalone testing tools (Kasimier and William),
1529     xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX
1530     Schemas APIs, Schemas xmlReader support.</li>
1531 </ul>
1532
1533 <h3>2.6.19: Apr 02 2005</h3>
1534 <ul>
1535   <li>build fixes: drop .la from RPMs, --with-minimum build fix (William
1536     Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX
1537     5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on
1538     Linux/ELF/gcc4</li>
1539   <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return
1540     code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY
1541     Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin),
1542     segfault in Schemas (Kasimier Buchcik), Schemas attribute validation
1543     (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards),
1544     HTML serialization of name attribute on a elements, Python error handlers
1545     leaks and improvement (Brent Hendricks), uninitialized variable in
1546     encoding code, Relax-NG validation bug, potential crash if
1547     gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures,
1548     switched back to assuming UTF-8 in case no encoding is given at
1549     serialization time</li>
1550   <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets
1551     checking and also mixed handling.</li>
1552   <li></li>
1553 </ul>
1554
1555 <h3>2.6.18: Mar 13 2005</h3>
1556 <ul>
1557   <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation,
1558     Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed),
1559     some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li>
1560   <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and
1561     xmlreader stopping on non-fatal errors, thread support for dictionnaries
1562     reference counting (Gary Coady), internal subset and push problem, URL
1563     saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths
1564     fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix
1565     (Mike Hommey), warning should not count as error (William Brack),
1566     xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup
1567     FTP and HTTP code to reuse the uri parsing and IPv6 (William),
1568     xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being
1569     empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows
1570     (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent
1571     Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug
1572     (Rob Richards), Schemas decimal type fixes (William Brack),
1573     xmlByteConsumed static buffer (Ben Maurer).</li>
1574   <li>improvement: speedup parsing comments and DTDs, dictionnary support for
1575     hash tables, Schemas Identity constraints (Kasimier), streaming XPath
1576     subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical
1577     values handling (Kasimier), add xmlTextReaderByteConsumed (Aron
1578   Stansvik),</li>
1579   <li>Documentation: Wiki support (Joel Reed)</li>
1580 </ul>
1581
1582 <h3>2.6.17: Jan 16 2005</h3>
1583 <ul>
1584   <li>build fixes: Windows, warnings removal (William Brack),
1585     maintainer-clean dependency(William), build in a different directory
1586     (William), fixing --with-minimum configure build (William), BeOS build
1587     (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan
1588     McNichol)</li>
1589   <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
1590     to use the catalog(s), loop on output (William Brack), XPath memory leak,
1591     ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
1592     warning not using error callback (William), xmlStopParser bug (William),
1593     UTF-16 with BOM on DTDs (William), namespace bug on empty elements in
1594     push mode (Rob Richards), line and col computations fixups (Aleksey
1595     Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
1596     patterns with too many steps, bug in RNG choice optimization, line number
1597     sometimes missing.</li>
1598   <li>improvements: XSD Schemas (Kasimier Buchcik), python generator
1599     (William), xmlUTF8Strpos speedup (William), unicode Python strings
1600     (William), XSD error reports (Kasimier Buchcik), Python __str__ call
1601     serialize().</li>
1602   <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for
1603     the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel
1604     Reed), error extraction API from regexps, new XMLSave option for format
1605     (Phil Shafer)</li>
1606   <li>documentation: site improvement (John Fleck), FAQ entries
1607   (William).</li>
1608 </ul>
1609
1610 <h3>2.6.16: Nov 10 2004</h3>
1611 <ul>
1612   <li>general hardening and bug fixing crossing all the API based on new
1613     automated regression testing</li>
1614   <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
1615   <li>bug fixes: problem with XML::Libxml reported by Petr Pajas,  encoding
1616     conversion functions return values, UTF-8 bug affecting XPath reported by
1617     Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
1618   <li>documentation: fix to xmllint man page, some API function descritpion
1619     were updated.</li>
1620   <li>improvements: DTD validation APIs provided at the Python level (Brent
1621     Hendricks)</li>
1622 </ul>
1623
1624 <h3>2.6.15: Oct 27 2004</h3>
1625 <ul>
1626   <li>security fixes on the nanoftp and nanohttp modules</li>
1627   <li>build fixes: xmllint detection bug in configure, building outside the
1628     source tree (Thomas Fitzsimmons)</li>
1629   <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
1630     paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
1631     saving to python file objects (Malcolm Tredinnick), DTD lookup fix
1632     (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
1633     fixes (DV and Rob Richards), Schemas memory bug, structured error handler
1634     on Python 64bits, thread local memory deallocation, memory leak reported
1635     by Volker Roth, xmlValidateDtd in the presence of an internal subset,
1636     entities and _private problem (William), xmlBuildRelativeURI error
1637     (William).</li>
1638   <li>improvements: better XInclude error reports (William), tree debugging
1639     module and tests, convenience functions at the Reader API (Graham
1640     Bennett), add support for PI in the HTML parser.</li>
1641 </ul>
1642
1643 <h3>2.6.14: Sep 29 2004</h3>
1644 <ul>
1645   <li>build fixes: configure paths for xmllint and xsltproc, compilation
1646     without HTML parser, compilation warning cleanups (William Brack &amp;
1647     Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
1648   <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
1649     Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
1650     transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
1651     (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
1652     handling of failed realloc(), out of bound array adressing in Schemas
1653     date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
1654     E20 validation fix (Malcolm),</li>
1655   <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
1656     xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
1657     (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
1658     Tredinnick), Schemas support for xsi:schemaLocation,
1659     xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
1660 </ul>
1661
1662 <h3>2.6.13: Aug 31 2004</h3>
1663 <ul>
1664   <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
1665     Solaris compiler warning, fixing RPM BuildRequires,</li>
1666   <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
1667     (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
1668     and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
1669     problem (William), Schemas hexbinary empty values, encoding error could
1670     genrate a serialization loop.</li>
1671   <li>Improvements: Schemas validity improvements (Kasimier), added --path
1672     and --load-trace options to xmllint</li>
1673   <li>documentation: tutorial update (John Fleck)</li>
1674 </ul>
1675
1676 <h3>2.6.12: Aug 22 2004</h3>
1677 <ul>
1678   <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
1679     Breitenlohner), perl path lookup (William), diff on Solaris (Albert
1680     Chin), some 64bits cleanups.</li>
1681   <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
1682     (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
1683     Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
1684     (Torkel Lyng)</li>
1685   <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
1686   <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
1687     debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
1688     xmlReader state after attribute reading (William), structured error
1689     handler (William), XInclude generated xml:base fixup (William), Windows
1690     memory reallocation problem (Steve Hay), Out of Memory conditions
1691     handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
1692     htmlReadMemory init (William), a posteriori validation DTD base
1693     (William), notations serialization missing, xmlGetNodePath (Dodji),
1694     xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
1695   (William)</li>
1696   <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
1697     (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
1698     xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
1699     to not generate start/end nodes, extend xmllint --version to include CVS
1700     tag (William)</li>
1701   <li>documentation: web pages fixes, validity API docs fixes (William)
1702     schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
1703 </ul>
1704
1705 <h3>2.6.11: July 5 2004</h3>
1706 <ul>
1707   <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
1708     attributes, namespaces and simple types.</li>
1709   <li>build fixes: --with-minimum (William Brack),  some gcc cleanup
1710     (William), --with-thread-alloc (William)</li>
1711   <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
1712     path on Windows</li>
1713   <li>documentation: update to the tutorial (John Fleck), xmllint return code
1714     (John Fleck), man pages (Ville Skytta),</li>
1715   <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
1716     properly initialize the library (William), empty node set in XPath
1717     (William), xmlSchemas errors (William), invalid charref problem pointed
1718     by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
1719     with div processing (William), XPointer and xml:base problem(William),
1720     Reader and entities, xmllint return code for schemas (William), reader
1721     streaming problem (Steve Ball), DTD serialization problem (William),
1722     libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
1723     Python classes, xmlReader buffer bug, Python bindings memory interfaces
1724     improvement (with StÃ©phane Bidoul), Fixed the push parser to be back to
1725     synchronous behaviour.</li>
1726   <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
1727     namespace in debug shell (Stefano Debenedetti), Python based regression
1728     test for non-Unix users (William), dynamically increase the number of
1729     XPath extension functions in Python and fix a memory leak (Marc-Antoine
1730     Parent and William)</li>
1731   <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
1732     and generated code on Linux, plus use gcc runtime profiling to optimize
1733     the code generated in the RPM packages.</li>
1734 </ul>
1735
1736 <h3>2.6.10: May 17 2004</h3>
1737 <ul>
1738   <li>Web page generated for ChangeLog</li>
1739   <li>build fixes: --without-html problems, make check without make all</li>
1740   <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
1741     vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
1742     use "list" as parameter name, make tests work with Python 1.5 (Ed
1743   Davis),</li>
1744   <li>improvements: made xmlTextReaderMode public, small buffers resizing
1745     (Morten Welinder), add --maxmem option to xmllint, add
1746     xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
1747     escaping, added escaping customization</li>
1748   <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
1749     Brack), xmlReader end of stream problem, node deregistration with reader,
1750     URI escaping and filemanes,  XHTML1 formatting (Nick Wellnhofer), regexp
1751     transition reduction (William), various XSD Schemas fixes (Kasimier
1752     Buchcik), XInclude fallback problem (William), weird problems with DTD
1753     (William), structured error handler callback context (William), reverse
1754     xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
1755 </ul>
1756
1757 <h3>2.6.9: Apr 18 2004</h3>
1758 <ul>
1759   <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
1760   <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
1761     Beckett), Relax-NG compilation (William Brack), Regexp patches (with
1762     William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
1763     William), Relax-NG name classes compares (William), XInclude duplicate
1764     fallback (William), external DTD encoding detection (William), a DTD
1765     validation bug (William), xmlReader Close() fix, recusive extention
1766     schemas</li>
1767   <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
1768     save optimization, better handle IIS broken HTTP redirect  behaviour (Ian
1769     Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
1770     dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
1771     clanup (William), keep ChangeLog compressed when installing from RPMs</li>
1772   <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
1773     example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
1774   <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
1775     compiler NaN handling bug (Mark Vakoc)</li>
1776 </ul>
1777
1778 <h3>2.6.8: Mar 23 2004</h3>
1779 <ul>
1780   <li>First step of the cleanup of the serialization code and APIs</li>
1781   <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
1782     Dickmeiss), anyURI for "" (John Belmonte)</li>
1783   <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
1784   <li>xmlDocCopyNode() extension (William)</li>
1785   <li>Relax-NG: fix when processing XInclude results (William), external
1786     reference in interleave (William), missing error on &lt;choice&gt;
1787     failure (William), memory leak in schemas datatype facets.</li>
1788   <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
1789   <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
1790     Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
1791     URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
1792     XInclude and XPointer fixes for entities (William), XML parser bug
1793     reported by Holger Rauch, nanohttp fd leak (William),  regexps char
1794     groups '-' handling (William), dictionnary reference counting problems,
1795     do not close stderr.</li>
1796   <li>performance patches from Petr Pajas</li>
1797   <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
1798   <li>compilation and portability fixes: --without-valid, catalog cleanups
1799     (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
1800     to Windows (Christophe de Vienne),  --with-html-dir fixup (Julio Merino
1801     Vidal), Windows build (Eric Zurcher)</li>
1802 </ul>
1803
1804 <h3>2.6.7: Feb 23 2004</h3>
1805 <ul>
1806   <li>documentation: tutorial updates (John Fleck), benchmark results</li>
1807   <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
1808   <li>XPath optimization (Petr Pajas)</li>
1809   <li>DTD ID handling optimization</li>
1810   <li>bugfixes: xpath number with  &gt; 19 fractional (William Brack), push
1811     mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
1812     xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
1813     handling NULL, trying to fix Relax-NG/Perl interface.</li>
1814   <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
1815   <li>Added relaxng option to xmllint --shell</li>
1816 </ul>
1817
1818 <h3>2.6.6: Feb 12 2004</h3>
1819 <ul>
1820   <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
1821     William) reported by Yuuichi Teranishi</li>
1822   <li>bugfixes: make test and path issues, xmlWriter attribute serialization
1823     (William Brack), xmlWriter indentation (William), schemas validation
1824     (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
1825     Paraschenko), XInclude empty fallback (William), HTML warnings (William),
1826     XPointer in XInclude (William), Python namespace serialization,
1827     isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
1828     entities in internal subset (William), internal subset bug in push mode,
1829     &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
1830   <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
1831     (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
1832     --with-minimum configuration.</li>
1833   <li>XInclude: allow the 2001 namespace without warning.</li>
1834   <li>Documentation: missing example/index.html (John Fleck), version
1835     dependancies (John Fleck)</li>
1836   <li>reader API: structured error reporting (Steve Ball)</li>
1837   <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
1838     prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
1839   patch</li>
1840   <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
1841     input.</li>
1842 </ul>
1843
1844 <h3>2.6.5: Jan 25 2004</h3>
1845 <ul>
1846   <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
1847     (William), xs:all problem (William), a number of XPointer bugfixes
1848     (William), xmllint error go to stderr, DTD validation problem with
1849     namespace, memory leak (William), SAX1 cleanup and minimal options fixes
1850     (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
1851     evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
1852     XML Schemas double free (Steve Ball), XInclude with no href, argument
1853     callbacks order for XPath callbacks (Frederic Peters)</li>
1854   <li>Documentation: python scripts (William Brack), xslt stylesheets (John
1855     Fleck), doc (Sven Zimmerman), I/O example.</li>
1856   <li>Python bindings: fixes (William), enum support (StÃ©phane Bidoul),
1857     structured error reporting (StÃ©phane Bidoul)</li>
1858   <li>XInclude: various fixes for conformance, problem related to dictionnary
1859     references (William &amp; me), recursion (William)</li>
1860   <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
1861     Mickautsch),</li>
1862   <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
1863   <li>code cleanup for strings functions (William)</li>
1864   <li>Windows: compiler patches (Mark Vakoc)</li>
1865   <li>Parser optimizations, a few new XPath and dictionnary APIs for future
1866     XSLT optimizations.</li>
1867 </ul>
1868
1869 <h3>2.6.4: Dec 24 2003</h3>
1870 <ul>
1871   <li>Windows build fixes (Igor Zlatkovic)</li>
1872   <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
1873   <li>Unix and Makefile packaging fixes (me, William Brack,</li>
1874   <li>Documentation improvements (John Fleck, William Brack), example fix
1875     (Lucas Brasilino)</li>
1876   <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
1877     NULL strings (William Brack) , API building reader or parser from
1878     filedescriptor should not close it, changed XPath sorting to be stable
1879     again (William Brack), xmlGetNodePath() generating '(null)' (William
1880     Brack), DTD validation and namespace bug (William Brack), XML Schemas
1881     double inclusion behaviour</li>
1882 </ul>
1883
1884 <h3>2.6.3: Dec 10 2003</h3>
1885 <ul>
1886   <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
1887   <li>added a repository of examples, examples from Aleksey Sanin, Dodji
1888     Seketeli, Alfred Mickautsch</li>
1889   <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
1890     (Kenneth Haley)</li>
1891   <li>Unicode range checking (William Brack)</li>
1892   <li>code cleanup (William Brack)</li>
1893   <li>Python bindings: doc (John Fleck),  bug fixes</li>
1894   <li>UTF-16 cleanup and BOM issues (William Brack)</li>
1895   <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
1896     xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
1897     (James Bursa), attribute defaulting and validation, some serialization
1898     cleanups, XML_GET_LINE macro, memory debug when using threads (William
1899     Brack), serialization of attributes and entities content, xmlWriter
1900     (Daniel Schulman)</li>
1901   <li>XInclude bugfix, new APIs and update to the last version including the
1902     namespace change.</li>
1903   <li>XML Schemas improvements: include (Robert Stepanek), import and
1904     namespace handling, fixed the regression tests troubles, added examples
1905     based on Eric van der Vlist book, regexp fixes</li>
1906   <li>preliminary pattern support for streaming (needed for schemas
1907     constraints), added xmlTextReaderPreservePattern() to collect subdocument
1908     when streaming.</li>
1909   <li>various fixes in the structured error handling</li>
1910 </ul>
1911
1912 <h3>2.6.2: Nov 4 2003</h3>
1913 <ul>
1914   <li>XPath context unregistration fixes</li>
1915   <li>text node coalescing fixes (Mark Lilback)</li>
1916   <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
1917   <li>BeOS patches (Marcin 'Shard' Konicki)</li>
1918   <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
1919   <li>compilation fixes (Mark Vakoc)</li>
1920   <li>stdin parsing fix (William Brack)</li>
1921   <li>a posteriori DTD validation fixes</li>
1922   <li>xmlReader bug fixes: Walker fixes, python bindings</li>
1923   <li>fixed xmlStopParser() to really stop the parser and errors</li>
1924   <li>always generate line numbers when using the new xmlReadxxx
1925   functions</li>
1926   <li>added XInclude support to the xmlReader interface</li>
1927   <li>implemented XML_PARSE_NONET parser option</li>
1928   <li>DocBook XSLT processing bug fixed</li>
1929   <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
1930   <li>XPointer failure in XInclude are now handled as resource errors</li>
1931   <li>fixed xmllint --html to use the HTML serializer on output (added
1932     --xmlout to implement the previous behaviour of saving it using the XML
1933     serializer)</li>
1934 </ul>
1935
1936 <h3>2.6.1: Oct 28 2003</h3>
1937 <ul>
1938   <li>Mostly bugfixes after the big 2.6.0 changes</li>
1939   <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
1940     (William Brack)</li>
1941   <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
1942     Zlatkovic)</li>
1943   <li>xmlWriter bugfix (Alfred Mickautsch)</li>
1944   <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
1945   <li>context reset: error state reset, push parser reset (Graham
1946   Bennett)</li>
1947   <li>context reuse: generate errors if file is not readable</li>
1948   <li>defaulted attributes for element coming from internal entities
1949     (Stephane Bidoul)</li>
1950   <li>Python: tab and spaces mix (William Brack)</li>
1951   <li>Error handler could crash in DTD validation in 2.6.0</li>
1952   <li>xmlReader: do not use the document or element _private field</li>
1953   <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
1954   <li>general bug fixes: mandatory encoding in text decl, serializing
1955     Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
1956     XPath errors not reported,  slow HTML parsing of large documents.</li>
1957 </ul>
1958
1959 <h3>2.6.0: Oct 20 2003</h3>
1960 <ul>
1961   <li>Major revision release: should be API and ABI compatible but got a lot
1962     of change</li>
1963   <li>Increased the library modularity, far more options can be stripped out,
1964     a --with-minimum configuration will weight around 160KBytes</li>
1965   <li>Use per parser and per document dictionnary, allocate names and small
1966     text nodes from the dictionnary</li>
1967   <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
1968     provides namespace resolution and defaulted attributes, minimize memory
1969     allocations and copies, namespace checking and specific error handling,
1970     immutable buffers, make predefined entities static structures, etc...</li>
1971   <li>rewrote all the error handling in the library, all errors can be
1972     intercepted at a structured level, with precise information
1973   available.</li>
1974   <li>New simpler and more generic XML and HTML parser APIs, allowing to
1975     easilly modify the parsing options and reuse parser context for multiple
1976     consecutive documents.</li>
1977   <li>Similar new APIs for the xmlReader, for options and reuse, provided new
1978     functions to access content as const strings, use them for Python
1979   bindings</li>
1980   <li>a  lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
1981     Walker i.e. reader on a document tree based on Alfred Mickautsch code,
1982     make room in nodes for line numbers, reference counting and future PSVI
1983     extensions, generation of character ranges to be checked with faster
1984     algorithm (William),  xmlParserMaxDepth (Crutcher Dunnavant), buffer
1985     access</li>
1986   <li>New xmlWriter API provided by Alfred Mickautsch</li>
1987   <li>Schemas: base64 support by Anthony Carrico</li>
1988   <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
1989     and charset information if available.</li>
1990   <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
1991     zeroOrMore, better error reporting.</li>
1992   <li>Python bindings (StÃ©phane Bidoul), never use stdout for errors
1993   output</li>
1994   <li>Portability: all the headers have macros for export and calling
1995     convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
1996     Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher,  Igor),
1997     Mingw (Igor), typos (Mark Vakoc),  beta version (Stephane Bidoul),
1998     warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
1999     'Shard' Konicki)</li>
2000   <li>Documentation fixes and README (William Brack), search fix (William),
2001     tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
2002   <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
2003     mutexes, HTML doctype lowercase,  SAX/IO (William), compression detection
2004     and restore (William), attribute declaration in DTDs (William), namespace
2005     on attribute in HTML output (William), input filename (Rob Richards),
2006     namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
2007     (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
2008     Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
2009     mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
2010     (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
2011     error handling.</li>
2012   <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
2013     testing,  --nodict for building without tree dictionnary, --nocdata to
2014     replace CDATA by text, --nsclean to remove surperfluous  namespace
2015     declarations</li>
2016   <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
2017   <li>a lot of profiling and tuning of the code, speedup patch for
2018     xmlSearchNs() by Luca Padovani. The xmlReader should do far less
2019     allocation and it speed should get closer to SAX. Chris Anderson worked
2020     on speeding and cleaning up repetitive checking code.</li>
2021   <li>cleanup of "make tests"</li>
2022   <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
2023   <li>deactivated the broken docBook SGML parser code and plugged the XML
2024     parser instead.</li>
2025 </ul>
2026
2027 <h3>2.5.11: Sep 9 2003</h3>
2028
2029 <p>A bugfix only release:</p>
2030 <ul>
2031   <li>risk of crash in Relax-NG</li>
2032   <li>risk of crash when using multithreaded programs</li>
2033 </ul>
2034
2035 <h3>2.5.10: Aug 15 2003</h3>
2036
2037 <p>A bugfixes only release</p>
2038 <ul>
2039   <li>Windows Makefiles (William Brack)</li>
2040   <li>UTF-16 support fixes (Mark Itzcovitz)</li>
2041   <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
2042     on Windows (Mikhail Grushinskiy)</li>
2043   <li>HTML parser (Oliver Stoeneberg)</li>
2044   <li>XInclude performance problem reported by Kevin Ruscoe</li>
2045   <li>XML parser performance problem reported by Grant Goodale</li>
2046   <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
2047   <li>and a couple other cleanup</li>
2048 </ul>
2049
2050 <h3>2.5.9: Aug 9 2003</h3>
2051 <ul>
2052   <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
2053     (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
2054     (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
2055     xmlReader, Relax-NG schemas compilation, namespace handling,  EXSLT (Sean
2056     Griffin), HTML parsing problem (William Brack), DTD validation for mixed
2057     content + namespaces, HTML serialization, library initialization,
2058     progressive HTML parser</li>
2059   <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
2060   <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
2061   <li>doc fixes and improvements (John Fleck)</li>
2062   <li>configure flag for -with-fexceptions when embedding in C++</li>
2063   <li>couple of new UTF-8 helper functions (William Brack)</li>
2064   <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
2065   <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
2066   <li>general compilation/warning cleanup Solaris/HP-UX/... (William
2067   Brack)</li>
2068 </ul>
2069
2070 <h3>2.5.8: Jul 6 2003</h3>
2071 <ul>
2072   <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
2073     Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
2074     PI related memleak, compilation without schemas or without xpath (Joerg
2075     Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
2076     rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
2077     xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
2078   <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
2079   <li>William Brack fixed multithreading lock problems</li>
2080   <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
2081   <li>Windows fixes (Igor Zlatkovic,  Eric Zurcher), threading (StÃ©phane
2082     Bidoul)</li>
2083   <li>A few W3C Schemas Structure improvements</li>
2084   <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
2085   <li>Python bindings for thread globals (StÃ©phane Bidoul), and method/class
2086     generator</li>
2087   <li>added --nonet option to xmllint</li>
2088   <li>documentation improvements (John Fleck)</li>
2089 </ul>
2090
2091 <h3>2.5.7: Apr 25 2003</h3>
2092 <ul>
2093   <li>Relax-NG: Compiling to regexp and streaming validation on top of the
2094     xmlReader interface, added to xmllint --stream</li>
2095   <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
2096   <li>Support for large files: RGN validated a 4.5GB instance</li>
2097   <li>Thread support is now configured in by default</li>
2098   <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
2099     (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
2100     and zero bytes handling, some missing Windows file path conversions,
2101     behaviour of the parser and validator in the presence of "out of memory"
2102     error conditions</li>
2103   <li>extended the API to be able to plug a garbage collecting memory
2104     allocator, added xmlMallocAtomic() and modified the allocations
2105     accordingly.</li>
2106   <li>Performances: removed excessive malloc() calls, speedup of the push and
2107     xmlReader interfaces, removed excessive thread locking</li>
2108   <li>Documentation: man page (John Fleck), xmlReader documentation</li>
2109   <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
2110 </ul>
2111
2112 <h3>2.5.6: Apr 1 2003</h3>
2113 <ul>
2114   <li>Fixed W3C XML Schemas datatype, should be compliant now except for
2115     binHex and base64 which are not supported yet.</li>
2116   <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
2117     XInclude entities handling, encoding detection on external subsets, XML
2118     Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
2119   <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
2120   <li>documentation: added --relaxng option to xmllint man page (John)</li>
2121   <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
2122     errors</li>
2123 </ul>
2124
2125 <h3>2.5.5: Mar 24 2003</h3>
2126 <ul>
2127   <li>Lot of fixes on the Relax NG implementation. More testing including
2128     DocBook and TEI examples.</li>
2129   <li>Increased the support for W3C XML Schemas datatype</li>
2130   <li>Several bug fixes in the URI handling layer</li>
2131   <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
2132     conversion, line counting in the parser.</li>
2133   <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
2134   <li>Fixed the RPM spec file name</li>
2135 </ul>
2136
2137 <h3>2.5.4: Feb 20 2003</h3>
2138 <ul>
2139   <li>Conformance testing and lot of fixes on Relax NG and XInclude
2140     implementation</li>
2141   <li>Implementation of XPointer element() scheme</li>
2142   <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
2143     namespaces,
2144     <p>2 serialization bugs, node info generation problems, a DTD regexp
2145     generation problem.</p>
2146   </li>
2147   <li>Portability: windows updates and path canonicalization (Igor)</li>
2148   <li>A few typo fixes (Kjartan Maraas)</li>
2149   <li>Python bindings generator fixes (Stephane Bidoul)</li>
2150 </ul>
2151
2152 <h3>2.5.3: Feb 10 2003</h3>
2153 <ul>
2154   <li>RelaxNG and XML Schemas datatypes improvements, and added a first
2155     version of RelaxNG Python bindings</li>
2156   <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
2157     serializing namespace nodes, encoding conversion bug, XHTML1
2158   serialization</li>
2159   <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
2160 </ul>
2161
2162 <h3>2.5.2: Feb 5 2003</h3>
2163 <ul>
2164   <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
2165   <li>Schemas support now compiled in by default.</li>
2166   <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
2167     delegateURI in XML Catalogs, HTML parser, XML reader (StÃ©phane Bidoul),
2168     XPath parser and evaluation,  UTF8ToUTF8 serialization, XML reader memory
2169     consumption, HTML parser, HTML serialization in the presence of
2170   namespaces</li>
2171   <li>added an HTML API to check elements and attributes.</li>
2172   <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
2173     patches (Stefan Kost)</li>
2174   <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
2175   <li>Added python bindings for XPointer, contextual error reporting
2176     (StÃ©phane Bidoul)</li>
2177   <li>URI/file escaping problems (Stefano Zacchiroli)</li>
2178 </ul>
2179
2180 <h3>2.5.1: Jan 8 2003</h3>
2181 <ul>
2182   <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
2183   <li>documentation updates (John)</li>
2184   <li>a couple of XmlTextReader fixes</li>
2185 </ul>
2186
2187 <h3>2.5.0: Jan 6 2003</h3>
2188 <ul>
2189   <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
2190     API (with help of StÃ©phane Bidoul)</li>
2191   <li>Windows: more exports, including the new API (Igor)</li>
2192   <li>XInclude fallback fix</li>
2193   <li>Python: bindings for the new API, packaging (StÃ©phane Bidoul),
2194     drv_libxml2.py Python xml.sax driver (StÃ©phane Bidoul), fixes, speedup
2195     and iterators for Python-2.2 (Hannu Krosing)</li>
2196   <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
2197   (John)</li>
2198   <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
2199   <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
2200   <li>Entities handling fixes</li>
2201   <li>new API to optionally track node creation and deletion (Lukas
2202   Schroeder)</li>
2203   <li>Added documentation for the XmltextReader interface and some <a
2204     href="guidelines.html">XML guidelines</a></li>
2205 </ul>
2206
2207 <h3>2.4.30: Dec 12 2002</h3>
2208 <ul>
2209   <li>2.4.29 broke the python bindings, rereleasing</li>
2210   <li>Improvement/fixes of the XML API generator, and couple of minor code
2211     fixes.</li>
2212 </ul>
2213
2214 <h3>2.4.29: Dec 11 2002</h3>
2215 <ul>
2216   <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
2217     (StÃ©phane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
2218   <li>Fix for prev in python bindings (ERDI Gergo)</li>
2219   <li>Fix for entities handling (Marcus Clarke)</li>
2220   <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
2221     dump</li>
2222   <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
2223   <li>Fix for HTTP URL escaping problem</li>
2224   <li>added an TextXmlReader (C#) like API (work in progress)</li>
2225   <li>Rewrote the API in XML generation script, includes a C parser and saves
2226     more information needed for C# bindings</li>
2227 </ul>
2228
2229 <h3>2.4.28: Nov 22 2002</h3>
2230 <ul>
2231   <li>a couple of python binding fixes</li>
2232   <li>2 bug fixes in the XML push parser</li>
2233   <li>potential memory leak removed (Martin Stoilov)</li>
2234   <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
2235   <li>added encoding support for XInclude parse="text"</li>
2236   <li>autodetection of XHTML1 and specific serialization rules added</li>
2237   <li>nasty threading bug fixed (William Brack)</li>
2238 </ul>
2239
2240 <h3>2.4.27: Nov 17 2002</h3>
2241 <ul>
2242   <li>fixes for the Python bindings</li>
2243   <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
2244     HTML parser,  Schemas (Charles Bozeman), document fragment support
2245     (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
2246     xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
2247     Pajas), entities processing</li>
2248   <li>added grep to xmllint --shell</li>
2249   <li>VMS update patch from Craig A. Berry</li>
2250   <li>cleanup of the Windows build with support for more compilers (Igor),
2251     better thread support on Windows</li>
2252   <li>cleanup of Unix Makefiles and spec file</li>
2253   <li>Improvements to the documentation (John Fleck)</li>
2254 </ul>
2255
2256 <h3>2.4.26: Oct 18 2002</h3>
2257 <ul>
2258   <li>Patches for Windows CE port, improvements on Windows paths handling</li>
2259   <li>Fixes to the validation  code (DTD and Schemas), xmlNodeGetPath() ,
2260     HTML serialization, Namespace compliance,  and a number of small
2261   problems</li>
2262 </ul>
2263
2264 <h3>2.4.25: Sep 26 2002</h3>
2265 <ul>
2266   <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
2267     tree, xmlI/O,  Html</li>
2268   <li>Serious rewrite of XInclude</li>
2269   <li>Made XML Schemas regexp part of the default build and APIs, small fix
2270     and improvement of the regexp core</li>
2271   <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
2272   <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
2273     Daniel Gehriger, Mark Vakoc)</li>
2274   <li>Improved the python I/O bindings, the tests, added resolver and regexp
2275     APIs</li>
2276   <li>New logos from Marc Liyanage</li>
2277   <li>Tutorial improvements: John Fleck, Christopher Harris</li>
2278   <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
2279   Merlet)</li>
2280   <li>removal of all stderr/perror use for error reporting</li>
2281   <li>Better error reporting: XPath and DTD validation</li>
2282   <li>update of the trio portability layer (Bjorn Reese)</li>
2283 </ul>
2284
2285 <p><strong>2.4.24: Aug 22 2002</strong></p>
2286 <ul>
2287   <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
2288   <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
2289     (fcrozat)</li>
2290   <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
2291   <li>C14N improvements by Aleksey</li>
2292   <li>doc cleanups: Rick Jones</li>
2293   <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
2294   <li>XInclude: implementation of fallback and xml:base fixup added</li>
2295 </ul>
2296
2297 <h3>2.4.23: July 6 2002</h3>
2298 <ul>
2299   <li>performances patches: Peter Jacobi</li>
2300   <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
2301   <li>added xmlDocFormatDump: Chema Celorio</li>
2302   <li>new tutorial: John Fleck</li>
2303   <li>new hash functions and performances: Sander Vesik, portability fix from
2304     Peter Jacobi</li>
2305   <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
2306     HTML parsers, ID lookup function</li>
2307   <li>removal of all remaining sprintf: Aleksey Sanin</li>
2308 </ul>
2309
2310 <h3>2.4.22: May 27 2002</h3>
2311 <ul>
2312   <li>a number of bug fixes: configure scripts, base handling, parser, memory
2313     usage, HTML parser, XPath, documentation (Christian Cornelssen),
2314     indentation, URI parsing</li>
2315   <li>Optimizations for XMLSec, fixing and making public some of the network
2316     protocol handlers (Aleksey)</li>
2317   <li>performance patch from Gary Pennington</li>
2318   <li>Charles Bozeman provided date and time support for XML Schemas
2319   datatypes</li>
2320 </ul>
2321
2322 <h3>2.4.21: Apr 29 2002</h3>
2323
2324 <p>This release is both a bug fix release and also contains the early XML
2325 Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
2326 href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
2327 interfaces are likely to change, there is huge holes, it is clearly a work in
2328 progress and don't even think of putting this code in a production system,
2329 it's actually not compiled in by default. The real fixes are:</p>
2330 <ul>
2331   <li>a couple of bugs or limitations introduced in 2.4.20</li>
2332   <li>patches for Borland C++ and MSC by Igor</li>
2333   <li>some fixes on XPath strings and conformance patches by Richard
2334   Jinks</li>
2335   <li>patch from Aleksey for the ExcC14N specification</li>
2336   <li>OSF/1 bug fix by Bjorn</li>
2337 </ul>
2338
2339 <h3>2.4.20: Apr 15 2002</h3>
2340 <ul>
2341   <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
2342   <li>XPath conformance testing by Richard Jinks</li>
2343   <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
2344     libxml.m4</li>
2345 </ul>
2346
2347 <h3>2.4.19: Mar 25 2002</h3>
2348 <ul>
2349   <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
2350     encoder</li>
2351   <li>portability fixes in the HTTP code</li>
2352   <li>memory allocation checks using valgrind, and profiling tests</li>
2353   <li>revamp of the Windows build and Makefiles</li>
2354 </ul>
2355
2356 <h3>2.4.18: Mar 18 2002</h3>
2357 <ul>
2358   <li>bug fixes: tree, SAX, canonicalization, validation, portability,
2359   XPath</li>
2360   <li>removed the --with-buffer option it was becoming unmaintainable</li>
2361   <li>serious cleanup of the Python makefiles</li>
2362   <li>speedup patch to XPath very effective for DocBook stylesheets</li>
2363   <li>Fixes for Windows build, cleanup of the documentation</li>
2364 </ul>
2365
2366 <h3>2.4.17: Mar 8 2002</h3>
2367 <ul>
2368   <li>a lot of bug fixes, including "namespace nodes have no parents in
2369   XPath"</li>
2370   <li>fixed/improved the Python wrappers, added more examples and more
2371     regression tests, XPath extension functions can now return node-sets</li>
2372   <li>added the XML Canonicalization support from Aleksey Sanin</li>
2373 </ul>
2374
2375 <h3>2.4.16: Feb 20 2002</h3>
2376 <ul>
2377   <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
2378     from OASIS and W3C. Compliance has been significantly improved.</li>
2379   <li>a couple of portability fixes too.</li>
2380 </ul>
2381
2382 <h3>2.4.15: Feb 11 2002</h3>
2383 <ul>
2384   <li>Fixed the Makefiles, especially the python module ones</li>
2385   <li>A few bug fixes and cleanup</li>
2386   <li>Includes cleanup</li>
2387 </ul>
2388
2389 <h3>2.4.14: Feb 8 2002</h3>
2390 <ul>
2391   <li>Change of License to the <a
2392     href="http://www.opensource.org/licenses/mit-license.html">MIT
2393     License</a> basically for integration in XFree86 codebase, and removing
2394     confusion around the previous dual-licensing</li>
2395   <li>added Python bindings, beta software but should already be quite
2396     complete</li>
2397   <li>a large number of fixes and cleanups, especially for all tree
2398     manipulations</li>
2399   <li>cleanup of the headers, generation of a reference API definition in
2400   XML</li>
2401 </ul>
2402
2403 <h3>2.4.13: Jan 14 2002</h3>
2404 <ul>
2405   <li>update of the documentation: John Fleck and Charlie Bozeman</li>
2406   <li>cleanup of timing code from Justin Fletcher</li>
2407   <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
2408     Narojnyi</li>
2409   <li>Cygwin patch from Robert Collins</li>
2410   <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
2411 </ul>
2412
2413 <h3>2.4.12: Dec 7 2001</h3>
2414 <ul>
2415   <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
2416     XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
2417   (robert)</li>
2418   <li>Eric Lavigne contributed project files for MacOS</li>
2419   <li>some makefiles cleanups</li>
2420 </ul>
2421
2422 <h3>2.4.11: Nov 26 2001</h3>
2423 <ul>
2424   <li>fixed a couple of errors in the includes, fixed a few bugs, some code
2425     cleanups</li>
2426   <li>xmllint man pages improvement by Heiko Rupp</li>
2427   <li>updated VMS build instructions from John A Fotheringham</li>
2428   <li>Windows Makefiles updates from Igor</li>
2429 </ul>
2430
2431 <h3>2.4.10: Nov 10 2001</h3>
2432 <ul>
2433   <li>URI escaping fix (Joel Young)</li>
2434   <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
2435   <li>Fixes namespace handling problems when using DTD and validation</li>
2436   <li>improvements on xmllint: Morus Walter patches for --format and
2437     --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
2438   <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
2439   <li>fixes to the HTML parser</li>
2440 </ul>
2441
2442 <h3>2.4.9: Nov 6 2001</h3>
2443 <ul>
2444   <li>fixes more catalog bugs</li>
2445   <li>avoid a compilation problem, improve xmlGetLineNo()</li>
2446 </ul>
2447
2448 <h3>2.4.8: Nov 4 2001</h3>
2449 <ul>
2450   <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
2451   tool</li>
2452   <li>fixed a compile errors and some includes troubles.</li>
2453 </ul>
2454
2455 <h3>2.4.7: Oct 30 2001</h3>
2456 <ul>
2457   <li>exported some debugging interfaces</li>
2458   <li>serious rewrite of the catalog code</li>
2459   <li>integrated Gary Pennington thread safety patch, added configure option
2460     and regression tests</li>
2461   <li>removed an HTML parser bug</li>
2462   <li>fixed a couple of potentially serious validation bugs</li>
2463   <li>integrated the SGML DocBook support in xmllint</li>
2464   <li>changed the nanoftp anonymous login passwd</li>
2465   <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
2466   <li>general bug fixes</li>
2467   <li>updated xmllint man page by John Fleck</li>
2468   <li>some VMS and Windows updates</li>
2469 </ul>
2470
2471 <h3>2.4.6: Oct 10 2001</h3>
2472 <ul>
2473   <li>added an updated man pages by John Fleck</li>
2474   <li>portability and configure fixes</li>
2475   <li>an infinite loop on the HTML parser was removed (William)</li>
2476   <li>Windows makefile patches from Igor</li>
2477   <li>fixed half a dozen bugs reported for libxml or libxslt</li>
2478   <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
2479 </ul>
2480
2481 <h3>2.4.5: Sep 14 2001</h3>
2482 <ul>
2483   <li>Remove a few annoying bugs in 2.4.4</li>
2484   <li>forces the HTML serializer to output decimal charrefs since some
2485     version of Netscape can't handle hexadecimal ones</li>
2486 </ul>
2487
2488 <h3>1.8.16: Sep 14 2001</h3>
2489 <ul>
2490   <li>maintenance release of the old libxml1 branch, couple of bug and
2491     portability fixes</li>
2492 </ul>
2493
2494 <h3>2.4.4: Sep 12 2001</h3>
2495 <ul>
2496   <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
2497   Catalog</li>
2498   <li>a few bug fixes and some portability changes</li>
2499   <li>some documentation cleanups</li>
2500 </ul>
2501
2502 <h3>2.4.3:  Aug 23 2001</h3>
2503 <ul>
2504   <li>XML Catalog support see the doc</li>
2505   <li>New NaN/Infinity floating point code</li>
2506   <li>A few bug fixes</li>
2507 </ul>
2508
2509 <h3>2.4.2:  Aug 15 2001</h3>
2510 <ul>
2511   <li>adds xmlLineNumbersDefault() to control line number generation</li>
2512   <li>lot of bug fixes</li>
2513   <li>the Microsoft MSC projects files should now be up to date</li>
2514   <li>inheritance of namespaces from DTD defaulted attributes</li>
2515   <li>fixes a serious potential security bug</li>
2516   <li>added a --format option to xmllint</li>
2517 </ul>
2518
2519 <h3>2.4.1:  July 24 2001</h3>
2520 <ul>
2521   <li>possibility to keep line numbers in the tree</li>
2522   <li>some computation NaN fixes</li>
2523   <li>extension of the XPath API</li>
2524   <li>cleanup for alpha and ia64 targets</li>
2525   <li>patch to allow saving through HTTP PUT or POST</li>
2526 </ul>
2527
2528 <h3>2.4.0: July 10 2001</h3>
2529 <ul>
2530   <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
2531   <li>Fixed XML Base implementation, added a couple of examples to the
2532     regression tests</li>
2533   <li>A bit of cleanup</li>
2534 </ul>
2535
2536 <h3>2.3.14: July 5 2001</h3>
2537 <ul>
2538   <li>fixed some entities problems and reduce memory requirement when
2539     substituting them</li>
2540   <li>lots of improvements in the XPath queries interpreter can be
2541     substantially faster</li>
2542   <li>Makefiles and configure cleanups</li>
2543   <li>Fixes to XPath variable eval, and compare on empty node set</li>
2544   <li>HTML tag closing bug fixed</li>
2545   <li>Fixed an URI reference computation problem when validating</li>
2546 </ul>
2547
2548 <h3>2.3.13: June 28 2001</h3>
2549 <ul>
2550   <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
2551   <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
2552 </ul>
2553
2554 <h3>1.8.14: June 28 2001</h3>
2555 <ul>
2556   <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
2557   <li>Small Makefile fix</li>
2558 </ul>
2559
2560 <h3>2.3.12: June 26 2001</h3>
2561 <ul>
2562   <li>lots of cleanup</li>
2563   <li>a couple of validation fix</li>
2564   <li>fixed line number counting</li>
2565   <li>fixed serious problems in the XInclude processing</li>
2566   <li>added support for UTF8 BOM at beginning of entities</li>
2567   <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
2568     miscompile uri.c (William), Thomas Leitner provided a fix for the
2569     optimizer on Tru64</li>
2570   <li>incorporated Yon Derek and Igor Zlatkovic  fixes and improvements for
2571     compilation on Windows MSC</li>
2572   <li>update of libxml-doc.el (Felix Natter)</li>
2573   <li>fixed 2 bugs in URI normalization code</li>
2574 </ul>
2575
2576 <h3>2.3.11: June 17 2001</h3>
2577 <ul>
2578   <li>updates to trio, Makefiles and configure should fix some portability
2579     problems (alpha)</li>
2580   <li>fixed some HTML serialization problems (pre, script, and block/inline
2581     handling), added encoding aware APIs, cleanup of this code</li>
2582   <li>added xmlHasNsProp()</li>
2583   <li>implemented a specific PI for encoding support in the DocBook SGML
2584     parser</li>
2585   <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
2586     node selection)</li>
2587   <li>fixed a performance problem and an error in the validation code</li>
2588   <li>fixed XInclude routine to implement the recursive behaviour</li>
2589   <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
2590   <li>added --version to xmllint for bug reports</li>
2591 </ul>
2592
2593 <h3>2.3.10: June 1 2001</h3>
2594 <ul>
2595   <li>fixed the SGML catalog support</li>
2596   <li>a number of reported bugs got fixed, in XPath, iconv detection,
2597     XInclude processing</li>
2598   <li>XPath string function should now handle unicode correctly</li>
2599 </ul>
2600
2601 <h3>2.3.9: May 19 2001</h3>
2602
2603 <p>Lots of bugfixes, and added a basic SGML catalog support:</p>
2604 <ul>
2605   <li>HTML push bugfix #54891 and another patch from Jonas BorgstrÃ¶m</li>
2606   <li>some serious speed optimization again</li>
2607   <li>some documentation cleanups</li>
2608   <li>trying to get better linking on Solaris (-R)</li>
2609   <li>XPath API cleanup from Thomas Broyer</li>
2610   <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
2611     xmlValidGetValidElements()</li>
2612   <li>Added an INSTALL file</li>
2613   <li>Attribute removal added to API: #54433</li>
2614   <li>added a basic support for SGML catalogs</li>
2615   <li>fixed xmlKeepBlanksDefault(0) API</li>
2616   <li>bugfix in xmlNodeGetLang()</li>
2617   <li>fixed a small configure portability problem</li>
2618   <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
2619 </ul>
2620
2621 <h3>1.8.13: May 14 2001</h3>
2622 <ul>
2623   <li>bugfixes release of the old libxml1 branch used by Gnome</li>
2624 </ul>
2625
2626 <h3>2.3.8: May 3 2001</h3>
2627 <ul>
2628   <li>Integrated an SGML DocBook parser for the Gnome project</li>
2629   <li>Fixed a few things in the HTML parser</li>
2630   <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
2631     point portability issue</li>
2632   <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
2633     DOM+validation using the XML REC as input and a 700MHz celeron).</li>
2634   <li>incorporated more Windows cleanup</li>
2635   <li>added xmlSaveFormatFile()</li>
2636   <li>fixed problems in copying nodes with entities references (gdome)</li>
2637   <li>removed some troubles surrounding the new validation module</li>
2638 </ul>
2639
2640 <h3>2.3.7: April 22 2001</h3>
2641 <ul>
2642   <li>lots of small bug fixes, corrected XPointer</li>
2643   <li>Non deterministic content model validation support</li>
2644   <li>added xmlDocCopyNode for gdome2</li>
2645   <li>revamped the way the HTML parser handles end of tags</li>
2646   <li>XPath: corrections of namespaces support and number formatting</li>
2647   <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
2648   <li>HTML output fixes from P C Chow and William M. Brack</li>
2649   <li>Improved validation speed sensible for DocBook</li>
2650   <li>fixed a big bug with ID declared in external parsed entities</li>
2651   <li>portability fixes, update of Trio from Bjorn Reese</li>
2652 </ul>
2653
2654 <h3>2.3.6: April 8 2001</h3>
2655 <ul>
2656   <li>Code cleanup using extreme gcc compiler warning options, found and
2657     cleared half a dozen potential problem</li>
2658   <li>the Eazel team found an XML parser bug</li>
2659   <li>cleaned up the user of some of the string formatting function. used the
2660     trio library code to provide the one needed when the platform is missing
2661     them</li>
2662   <li>xpath: removed a memory leak and fixed the predicate evaluation
2663     problem, extended the testsuite and cleaned up the result. XPointer seems
2664     broken ...</li>
2665 </ul>
2666
2667 <h3>2.3.5: Mar 23 2001</h3>
2668 <ul>
2669   <li>Biggest change is separate parsing and evaluation of XPath expressions,
2670     there is some new APIs for this too</li>
2671   <li>included a number of bug fixes(XML push parser, 51876, notations,
2672   52299)</li>
2673   <li>Fixed some portability issues</li>
2674 </ul>
2675
2676 <h3>2.3.4: Mar 10 2001</h3>
2677 <ul>
2678   <li>Fixed bugs #51860 and #51861</li>
2679   <li>Added a global variable xmlDefaultBufferSize to allow default buffer
2680     size to be application tunable.</li>
2681   <li>Some cleanup in the validation code, still a bug left and this part
2682     should probably be rewritten to support ambiguous content model :-\</li>
2683   <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
2684     parser</li>
2685   <li>Fixed another bug in xmlNodeGetContent()</li>
2686   <li>Bjorn fixed XPath node collection and Number formatting</li>
2687   <li>Fixed a loop reported in the HTML parsing</li>
2688   <li>blank space are reported even if the Dtd content model proves that they
2689     are formatting spaces, this is for XML conformance</li>
2690 </ul>
2691
2692 <h3>2.3.3: Mar 1 2001</h3>
2693 <ul>
2694   <li>small change in XPath for XSLT</li>
2695   <li>documentation cleanups</li>
2696   <li>fix in validation by Gary Pennington</li>
2697   <li>serious parsing performances improvements</li>
2698 </ul>
2699
2700 <h3>2.3.2: Feb 24 2001</h3>
2701 <ul>
2702   <li>chasing XPath bugs, found a bunch, completed some TODO</li>
2703   <li>fixed a Dtd parsing bug</li>
2704   <li>fixed a bug in xmlNodeGetContent</li>
2705   <li>ID/IDREF support partly rewritten by Gary Pennington</li>
2706 </ul>
2707
2708 <h3>2.3.1: Feb 15 2001</h3>
2709 <ul>
2710   <li>some XPath and HTML bug fixes for XSLT</li>
2711   <li>small extension of the hash table interfaces for DOM gdome2
2712     implementation</li>
2713   <li>A few bug fixes</li>
2714 </ul>
2715
2716 <h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3>
2717 <ul>
2718   <li>Lots of XPath bug fixes</li>
2719   <li>Add a mode with Dtd lookup but without validation error reporting for
2720     XSLT</li>
2721   <li>Add support for text node without escaping (XSLT)</li>
2722   <li>bug fixes for xmlCheckFilename</li>
2723   <li>validation code bug fixes from Gary Pennington</li>
2724   <li>Patch from Paul D. Smith correcting URI path normalization</li>
2725   <li>Patch to allow simultaneous install of libxml-devel and
2726   libxml2-devel</li>
2727   <li>the example Makefile is now fixed</li>
2728   <li>added HTML to the RPM packages</li>
2729   <li>tree copying bugfixes</li>
2730   <li>updates to Windows makefiles</li>
2731   <li>optimization patch from Bjorn Reese</li>
2732 </ul>
2733
2734 <h3>2.2.11: Jan 4 2001</h3>
2735 <ul>
2736   <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
2737   <li>added htmlHandleOmittedElem()</li>
2738   <li>Applied Bjorn Reese's IPV6 first patch</li>
2739   <li>Applied Paul D. Smith patches for validation of XInclude results</li>
2740   <li>added XPointer xmlns() new scheme support</li>
2741 </ul>
2742
2743 <h3>2.2.10: Nov 25 2000</h3>
2744 <ul>
2745   <li>Fix the Windows problems of 2.2.8</li>
2746   <li>integrate OpenVMS patches</li>
2747   <li>better handling of some nasty HTML input</li>
2748   <li>Improved the XPointer implementation</li>
2749   <li>integrate a number of provided patches</li>
2750 </ul>
2751
2752 <h3>2.2.9: Nov 25 2000</h3>
2753 <ul>
2754   <li>erroneous release :-(</li>
2755 </ul>
2756
2757 <h3>2.2.8: Nov 13 2000</h3>
2758 <ul>
2759   <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
2760     support</li>
2761   <li>Patch in conditional section handling</li>
2762   <li>updated MS compiler project</li>
2763   <li>fixed some XPath problems</li>
2764   <li>added an URI escaping function</li>
2765   <li>some other bug fixes</li>
2766 </ul>
2767
2768 <h3>2.2.7: Oct 31 2000</h3>
2769 <ul>
2770   <li>added message redirection</li>
2771   <li>XPath improvements (thanks TOM !)</li>
2772   <li>xmlIOParseDTD() added</li>
2773   <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
2774   <li>some cleanup of the Makefile, autoconf and the distribution content</li>
2775 </ul>
2776
2777 <h3>2.2.6: Oct 25 2000:</h3>
2778 <ul>
2779   <li>Added an hash table module, migrated a number of internal structure to
2780     those</li>
2781   <li>Fixed a posteriori validation problems</li>
2782   <li>HTTP module cleanups</li>
2783   <li>HTML parser improvements (tag errors, script/style handling, attribute
2784     normalization)</li>
2785   <li>coalescing of adjacent text nodes</li>
2786   <li>couple of XPath bug fixes, exported the internal API</li>
2787 </ul>
2788
2789 <h3>2.2.5: Oct 15 2000:</h3>
2790 <ul>
2791   <li>XPointer implementation and testsuite</li>
2792   <li>Lot of XPath fixes, added variable and functions registration, more
2793     tests</li>
2794   <li>Portability fixes, lots of enhancements toward an easy Windows build
2795     and release</li>
2796   <li>Late validation fixes</li>
2797   <li>Integrated a lot of contributed patches</li>
2798   <li>added memory management docs</li>
2799   <li>a performance problem when using large buffer seems fixed</li>
2800 </ul>
2801
2802 <h3>2.2.4: Oct 1 2000:</h3>
2803 <ul>
2804   <li>main XPath problem fixed</li>
2805   <li>Integrated portability patches for Windows</li>
2806   <li>Serious bug fixes on the URI and HTML code</li>
2807 </ul>
2808
2809 <h3>2.2.3: Sep 17 2000</h3>
2810 <ul>
2811   <li>bug fixes</li>
2812   <li>cleanup of entity handling code</li>
2813   <li>overall review of all loops in the parsers, all sprintf usage has been
2814     checked too</li>
2815   <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
2816     works smoothly now.</li>
2817 </ul>
2818
2819 <h3>1.8.10: Sep 6 2000</h3>
2820 <ul>
2821   <li>bug fix release for some Gnome projects</li>
2822 </ul>
2823
2824 <h3>2.2.2: August 12 2000</h3>
2825 <ul>
2826   <li>mostly bug fixes</li>
2827   <li>started adding routines to access xml parser context options</li>
2828 </ul>
2829
2830 <h3>2.2.1: July 21 2000</h3>
2831 <ul>
2832   <li>a purely bug fixes release</li>
2833   <li>fixed an encoding support problem when parsing from a memory block</li>
2834   <li>fixed a DOCTYPE parsing problem</li>
2835   <li>removed a bug in the function allowing to override the memory
2836     allocation routines</li>
2837 </ul>
2838
2839 <h3>2.2.0: July 14 2000</h3>
2840 <ul>
2841   <li>applied a lot of portability fixes</li>
2842   <li>better encoding support/cleanup and saving (content is now always
2843     encoded in UTF-8)</li>
2844   <li>the HTML parser now correctly handles encodings</li>
2845   <li>added xmlHasProp()</li>
2846   <li>fixed a serious problem with &amp;#38;</li>
2847   <li>propagated the fix to FTP client</li>
2848   <li>cleanup, bugfixes, etc ...</li>
2849   <li>Added a page about <a href="encoding.html">libxml Internationalization
2850     support</a></li>
2851 </ul>
2852
2853 <h3>1.8.9:  July 9 2000</h3>
2854 <ul>
2855   <li>fixed the spec the RPMs should be better</li>
2856   <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
2857     rpmfind users problem</li>
2858 </ul>
2859
2860 <h3>2.1.1: July 1 2000</h3>
2861 <ul>
2862   <li>fixes a couple of bugs in the 2.1.0 packaging</li>
2863   <li>improvements on the HTML parser</li>
2864 </ul>
2865
2866 <h3>2.1.0 and 1.8.8: June 29 2000</h3>
2867 <ul>
2868   <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
2869     to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
2870     about &amp;#38; charref parsing</li>
2871   <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
2872     also contains numerous fixes and enhancements:
2873     <ul>
2874       <li>added xmlStopParser() to stop parsing</li>
2875       <li>improved a lot parsing speed when there is large CDATA blocs</li>
2876       <li>includes XPath patches provided by Picdar Technology</li>
2877       <li>tried to fix as much as possible DTD validation and namespace
2878         related problems</li>
2879       <li>output to a given encoding has been added/tested</li>
2880       <li>lot of various fixes</li>
2881     </ul>
2882   </li>
2883 </ul>
2884
2885 <h3>2.0.0: Apr 12 2000</h3>
2886 <ul>
2887   <li>First public release of libxml2. If you are using libxml, it's a good
2888     idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
2889     scheduled for Apr 3 the release occurred only on Apr 12 due to massive
2890     workload.</li>
2891   <li>The include are now located under $prefix/include/libxml (instead of
2892     $prefix/include/gnome-xml), they also are referenced by
2893     <pre>#include &lt;libxml/xxx.h&gt;</pre>
2894     <p>instead of</p>
2895     <pre>#include "xxx.h"</pre>
2896   </li>
2897   <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
2898   <li>the memory allocation routines used by libxml can now be overloaded
2899     dynamically by using xmlMemSetup()</li>
2900   <li>The previously CVS only tool tester has been renamed
2901     <strong>xmllint</strong> and is now installed as part of the libxml2
2902     package</li>
2903   <li>The I/O interface has been revamped. There is now ways to plug in
2904     specific I/O modules, either at the URI scheme detection level using
2905     xmlRegisterInputCallbacks()  or by passing I/O functions when creating a
2906     parser context using xmlCreateIOParserCtxt()</li>
2907   <li>there is a C preprocessor macro LIBXML_VERSION providing the version
2908     number of the libxml module in use</li>
2909   <li>a number of optional features of libxml can now be excluded at
2910     configure time (FTP/HTTP/HTML/XPath/Debug)</li>
2911 </ul>
2912
2913 <h3>2.0.0beta: Mar 14 2000</h3>
2914 <ul>
2915   <li>This is a first Beta release of libxml version 2</li>
2916   <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org
2917     FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
2918   RPMs</li>
2919   <li>This version is now the head in the Gnome CVS base, the old one is
2920     available under the tag LIB_XML_1_X</li>
2921   <li>This includes a very large set of changes. From a  programmatic point
2922     of view applications should not have to be modified too much, check the
2923     <a href="upgrade.html">upgrade page</a></li>
2924   <li>Some interfaces may changes (especially a bit about encoding).</li>
2925   <li>the updates includes:
2926     <ul>
2927       <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
2928         handled now</li>
2929       <li>Better handling of entities, especially well-formedness checking
2930         and proper PEref extensions in external subsets</li>
2931       <li>DTD conditional sections</li>
2932       <li>Validation now correctly handle entities content</li>
2933       <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
2934         structures to accommodate DOM</a></li>
2935     </ul>
2936   </li>
2937   <li>Serious progress were made toward compliance, <a
2938     href="conf/result.html">here are the result of the test</a> against the
2939     OASIS testsuite (except the Japanese tests since I don't support that
2940     encoding yet). This URL is rebuilt every couple of hours using the CVS
2941     head version.</li>
2942 </ul>
2943
2944 <h3>1.8.7: Mar 6 2000</h3>
2945 <ul>
2946   <li>This is a bug fix release:</li>
2947   <li>It is possible to disable the ignorable blanks heuristic used by
2948     libxml-1.x, a new function  xmlKeepBlanksDefault(0) will allow this. Note
2949     that for adherence to XML spec, this behaviour will be disabled by
2950     default in 2.x . The same function will allow to keep compatibility for
2951     old code.</li>
2952   <li>Blanks in &lt;a&gt;  &lt;/a&gt; constructs are not ignored anymore,
2953     avoiding heuristic is really the Right Way :-\</li>
2954   <li>The unchecked use of snprintf which was breaking libxml-1.8.6
2955     compilation on some platforms has been fixed</li>
2956   <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
2957   URIs</li>
2958 </ul>
2959
2960 <h3>1.8.6: Jan 31 2000</h3>
2961 <ul>
2962   <li>added a nanoFTP transport module, debugged until the new version of <a
2963     href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
2964     it without troubles</li>
2965 </ul>
2966
2967 <h3>1.8.5: Jan 21 2000</h3>
2968 <ul>
2969   <li>adding APIs to parse a well balanced chunk of XML (production <a
2970     href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
2971     XML spec)</li>
2972   <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
2973   <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
2974     to solve the zlib checks problems</li>
2975   <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
2976     gnumeric soon</li>
2977 </ul>
2978
2979 <h3>1.8.4: Jan 13 2000</h3>
2980 <ul>
2981   <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
2982   <li>all exit() call should have been removed from libxml</li>
2983   <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
2984   <li>added newDocFragment()</li>
2985 </ul>
2986
2987 <h3>1.8.3: Jan 5 2000</h3>
2988 <ul>
2989   <li>a Push interface for the XML and HTML parsers</li>
2990   <li>a shell-like interface to the document tree (try tester --shell :-)</li>
2991   <li>lots of bug fixes and improvement added over XMas holidays</li>
2992   <li>fixed the DTD parsing code to work with the xhtml DTD</li>
2993   <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
2994   <li>Fixed bugs in xmlNewNs()</li>
2995   <li>External entity loading code has been revamped, now it uses
2996     xmlLoadExternalEntity(), some fix on entities processing were added</li>
2997   <li>cleaned up WIN32 includes of socket stuff</li>
2998 </ul>
2999
3000 <h3>1.8.2: Dec 21 1999</h3>
3001 <ul>
3002   <li>I got another problem with includes and C++, I hope this issue is fixed
3003     for good this time</li>
3004   <li>Added a few tree modification functions: xmlReplaceNode,
3005     xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
3006     xmlDocSetRootElement</li>
3007   <li>Tried to improve the HTML output with help from <a
3008     href="mailto:clahey@umich.edu">Chris Lahey</a></li>
3009 </ul>
3010
3011 <h3>1.8.1: Dec 18 1999</h3>
3012 <ul>
3013   <li>various patches to avoid troubles when using libxml with C++ compilers
3014     the "namespace" keyword and C escaping in include files</li>
3015   <li>a problem in one of the core macros IS_CHAR was corrected</li>
3016   <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
3017     and more specifically the Dia application</li>
3018   <li>fixed a posteriori validation (validation after parsing, or by using a
3019     Dtd not specified in the original document)</li>
3020   <li>fixed a bug in</li>
3021 </ul>
3022
3023 <h3>1.8.0: Dec 12 1999</h3>
3024 <ul>
3025   <li>cleanup, especially memory wise</li>
3026   <li>the parser should be more reliable, especially the HTML one, it should
3027     not crash, whatever the input !</li>
3028   <li>Integrated various patches, especially a speedup improvement for large
3029     dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
3030     configure with --with-buffers to enable them.</li>
3031   <li>attribute normalization, oops should have been added long ago !</li>
3032   <li>attributes defaulted from DTDs should be available, xmlSetProp() now
3033     does entities escaping by default.</li>
3034 </ul>
3035
3036 <h3>1.7.4: Oct 25 1999</h3>
3037 <ul>
3038   <li>Lots of HTML improvement</li>
3039   <li>Fixed some errors when saving both XML and HTML</li>
3040   <li>More examples, the regression tests should now look clean</li>
3041   <li>Fixed a bug with contiguous charref</li>
3042 </ul>
3043
3044 <h3>1.7.3: Sep 29 1999</h3>
3045 <ul>
3046   <li>portability problems fixed</li>
3047   <li>snprintf was used unconditionally, leading to link problems on system
3048     were it's not available, fixed</li>
3049 </ul>
3050
3051 <h3>1.7.1: Sep 24 1999</h3>
3052 <ul>
3053   <li>The basic type for strings manipulated by libxml has been renamed in
3054     1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
3055     is that CHAR was conflicting with a predefined type on Windows. However
3056     on non WIN32 environment, compatibility is provided by the way of  a
3057     <strong>#define </strong>.</li>
3058   <li>Changed another error : the use of a structure field called errno, and
3059     leading to troubles on platforms where it's a macro</li>
3060 </ul>
3061
3062 <h3>1.7.0: Sep 23 1999</h3>
3063 <ul>
3064   <li>Added the ability to fetch remote DTD or parsed entities, see the <a
3065     href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
3066   <li>Added an errno to report errors by another mean than a simple printf
3067     like callback</li>
3068   <li>Finished ID/IDREF support and checking when validation</li>
3069   <li>Serious memory leaks fixed (there is now a <a
3070     href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
3071   <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
3072     implementation</li>
3073   <li>Added an HTML parser front-end</li>
3074 </ul>
3075
3076 <h2><a name="XML">XML</a></h2>
3077
3078 <p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
3079 markup-based structured documents. Here is <a name="example">an example XML
3080 document</a>:</p>
3081 <pre>&lt;?xml version="1.0"?&gt;
3082 &lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
3083   &lt;head&gt;
3084    &lt;title&gt;Welcome to Gnome&lt;/title&gt;
3085   &lt;/head&gt;
3086   &lt;chapter&gt;
3087    &lt;title&gt;The Linux adventure&lt;/title&gt;
3088    &lt;p&gt;bla bla bla ...&lt;/p&gt;
3089    &lt;image href="linus.gif"/&gt;
3090    &lt;p&gt;...&lt;/p&gt;
3091   &lt;/chapter&gt;
3092 &lt;/EXAMPLE&gt;</pre>
3093
3094 <p>The first line specifies that it is an XML document and gives useful
3095 information about its encoding.  Then the rest of the document is a text
3096 format whose structure is specified by tags between brackets. <strong>Each
3097 tag opened has to be closed</strong>. XML is pedantic about this. However, if
3098 a tag is empty (no content), a single tag can serve as both the opening and
3099 closing tag if it ends with <code>/&gt;</code> rather than with
3100 <code>&gt;</code>. Note that, for example, the image tag has no content (just
3101 an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
3102
3103 <p>XML can be applied successfully to a wide range of tasks, ranging from
3104 long term structured document maintenance (where it follows the steps of
3105 SGML) to simple data encoding mechanisms like configuration file formatting
3106 (glade), spreadsheets (gnumeric), or even shorter lived documents such as
3107 WebDAV where it is used to encode remote calls between a client and a
3108 server.</p>
3109
3110 <h2><a name="XSLT">XSLT</a></h2>
3111
3112 <p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
3113
3114 <p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>,  is a
3115 language for transforming XML documents into other XML documents (or
3116 HTML/textual output).</p>
3117
3118 <p>A separate library called libxslt is available implementing XSLT-1.0 for
3119 libxml2. This module "libxslt" too can be found in the Gnome SVN base.</p>
3120
3121 <p>You can check the progresses on the libxslt <a
3122 href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p>
3123
3124 <h2><a name="Python">Python and bindings</a></h2>
3125
3126 <p>There are a number of language bindings and wrappers available for
3127 libxml2, the list below is not exhaustive. Please contact the <a
3128 href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
3129 (<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
3130 order to get updates to this list or to discuss the specific topic of libxml2
3131 or libxslt wrappers or bindings:</p>
3132 <ul>
3133   <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
3134     most up-to-date C++ bindings for libxml2, check the <a
3135     href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
3136     and the <a
3137     href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
3138   <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
3139     based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
3140   <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
3141     <p>Website: <a
3142     href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
3143   </li>
3144   <li>XML::LibXML <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXML">Perl
3145       bindings</a> are available on CPAN, as well as XML::LibXSLT
3146       <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXSLT">Perl libxslt
3147       bindings</a>.</li>
3148   <li>If you're interested into scripting XML processing, have a look at <a
3149     href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
3150     Libxml2 Perl bindings.</li>
3151   <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
3152     earlier version of the libxml/libxslt <a
3153     href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
3154   <li>Gopal.V and Peter Minten develop <a
3155     href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
3156     C# libxml2 bindings.</li>
3157   <li>Petr Kozelka provides <a
3158     href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
3159     libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
3160   <li>Uwe Fechner also provides <a
3161     href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
3162     implementation for Kylix2/D5/D6 from Borland.</li>
3163   <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a>
3164     and libxml2 bindings are also available in Ruby through the <a
3165     href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
3166     maintained by Tobias Peters.</li>
3167   <li>Steve Ball and contributors maintains <a
3168     href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
3169     Tcl</a>.</li>
3170   <li>libxml2 and libxslt are the default XML libraries for PHP5.</li>
3171   <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
3172     an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
3173     libxslt as part of GNU ClasspathX project.</li>
3174   <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
3175     <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
3176   <li><a
3177     href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
3178     provides <a
3179     href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
3180     osax</a>. This is an osax for Mac OS X with a set of commands to
3181     implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
3182     commands for Property-lists (Apple's fast lookup table XML format.)</li>
3183   <li>Francesco Montorsi developped <a
3184     href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
3185     wrappers that interface libxml2, allowing wxWidgets applications to
3186     load/save/edit XML instances.</li>
3187 </ul>
3188
3189 <p>The distribution includes a set of Python bindings, which are guaranteed
3190 to be maintained as part of the library in the future, though the Python
3191 interface have not yet reached the completeness of the C API.</p>
3192
3193 <p>Note that some of the Python purist dislike the default set of Python
3194 bindings, rather than complaining I suggest they have a look at <a
3195 href="http://lxml.de/">lxml the more pythonic bindings for libxml2
3196 and libxslt</a> and <a
3197 href="http://lxml.de/mailinglist/">check the mailing-list</a>.</p>
3198
3199 <p><a href="mailto:stephane.bidoul@softwareag.com">StÃ©phane Bidoul</a>
3200 maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
3201 of the Python bindings</a>.</p>
3202
3203 <p>Note to people interested in building bindings, the API is formalized as
3204 <a href="libxml2-api.xml">an XML API description file</a> which allows to
3205 automate a large part of the Python bindings, this includes function
3206 descriptions, enums, structures, typedefs, etc... The Python script used to
3207 build the bindings is python/generator.py in the source distribution.</p>
3208
3209 <p>To install the Python bindings there are 2 options:</p>
3210 <ul>
3211   <li>If you use an RPM based distribution, simply install the <a
3212     href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
3213     RPM</a> (and if needed the <a
3214     href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
3215     RPM</a>).</li>
3216   <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
3217     module distribution</a> corresponding to your installed version of
3218     libxml2 and libxslt. Note that to install it you will need both libxml2
3219     and libxslt installed and run "python setup.py build install" in the
3220     module tree.</li>
3221 </ul>
3222
3223 <p>The distribution includes a set of examples and regression tests for the
3224 python bindings in the <code>python/tests</code> directory. Here are some
3225 excerpts from those tests:</p>
3226
3227 <h3>tst.py:</h3>
3228
3229 <p>This is a basic test of the file interface and DOM navigation:</p>
3230 <pre>import libxml2, sys
3231
3232 doc = libxml2.parseFile("tst.xml")
3233 if doc.name != "tst.xml":
3234     print "doc.name failed"
3235     sys.exit(1)
3236 root = doc.children
3237 if root.name != "doc":
3238     print "root.name failed"
3239     sys.exit(1)
3240 child = root.children
3241 if child.name != "foo":
3242     print "child.name failed"
3243     sys.exit(1)
3244 doc.freeDoc()</pre>
3245
3246 <p>The Python module is called libxml2; parseFile is the equivalent of
3247 xmlParseFile (most of the bindings are automatically generated, and the xml
3248 prefix is removed and the casing convention are kept). All node seen at the
3249 binding level share the same subset of accessors:</p>
3250 <ul>
3251   <li><code>name</code> : returns the node name</li>
3252   <li><code>type</code> : returns a string indicating the node type</li>
3253   <li><code>content</code> : returns the content of the node, it is based on
3254     xmlNodeGetContent() and hence is recursive.</li>
3255   <li><code>parent</code> , <code>children</code>, <code>last</code>,
3256     <code>next</code>, <code>prev</code>, <code>doc</code>,
3257     <code>properties</code>: pointing to the associated element in the tree,
3258     those may return None in case no such link exists.</li>
3259 </ul>
3260
3261 <p>Also note the need to explicitly deallocate documents with freeDoc() .
3262 Reference counting for libxml2 trees would need quite a lot of work to
3263 function properly, and rather than risk memory leaks if not implemented
3264 correctly it sounds safer to have an explicit function to free a tree. The
3265 wrapper python objects like doc, root or child are them automatically garbage
3266 collected.</p>
3267
3268 <h3>validate.py:</h3>
3269
3270 <p>This test check the validation interfaces and redirection of error
3271 messages:</p>
3272 <pre>import libxml2
3273
3274 #deactivate error messages from the validation
3275 def noerr(ctx, str):
3276     pass
3277
3278 libxml2.registerErrorHandler(noerr, None)
3279
3280 ctxt = libxml2.createFileParserCtxt("invalid.xml")
3281 ctxt.validate(1)
3282 ctxt.parseDocument()
3283 doc = ctxt.doc()
3284 valid = ctxt.isValid()
3285 doc.freeDoc()
3286 if valid != 0:
3287     print "validity check failed"</pre>
3288
3289 <p>The first thing to notice is the call to registerErrorHandler(), it
3290 defines a new error handler global to the library. It is used to avoid seeing
3291 the error messages when trying to validate the invalid document.</p>
3292
3293 <p>The main interest of that test is the creation of a parser context with
3294 createFileParserCtxt() and how the behaviour can be changed before calling
3295 parseDocument() . Similarly the information resulting from the parsing phase
3296 is also available using context methods.</p>
3297
3298 <p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
3299 C function interfaces in terms of objects method as much as possible. The
3300 best to get a complete view of what methods are supported is to look at the
3301 libxml2.py module containing all the wrappers.</p>
3302
3303 <h3>push.py:</h3>
3304
3305 <p>This test show how to activate the push parser interface:</p>
3306 <pre>import libxml2
3307
3308 ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
3309 ctxt.parseChunk("/&gt;", 2, 1)
3310 doc = ctxt.doc()
3311
3312 doc.freeDoc()</pre>
3313
3314 <p>The context is created with a special call based on the
3315 xmlCreatePushParser() from the C library. The first argument is an optional
3316 SAX callback object, then the initial set of data, the length and the name of
3317 the resource in case URI-References need to be computed by the parser.</p>
3318
3319 <p>Then the data are pushed using the parseChunk() method, the last call
3320 setting the third argument terminate to 1.</p>
3321
3322 <h3>pushSAX.py:</h3>
3323
3324 <p>this test show the use of the event based parsing interfaces. In this case
3325 the parser does not build a document, but provides callback information as
3326 the parser makes progresses analyzing the data being provided:</p>
3327 <pre>import libxml2
3328 log = ""
3329
3330 class callback:
3331     def startDocument(self):
3332         global log
3333         log = log + "startDocument:"
3334
3335     def endDocument(self):
3336         global log
3337         log = log + "endDocument:"
3338
3339     def startElement(self, tag, attrs):
3340         global log
3341         log = log + "startElement %s %s:" % (tag, attrs)
3342
3343     def endElement(self, tag):
3344         global log
3345         log = log + "endElement %s:" % (tag)
3346
3347     def characters(self, data):
3348         global log
3349         log = log + "characters: %s:" % (data)
3350
3351     def warning(self, msg):
3352         global log
3353         log = log + "warning: %s:" % (msg)
3354
3355     def error(self, msg):
3356         global log
3357         log = log + "error: %s:" % (msg)
3358
3359     def fatalError(self, msg):
3360         global log
3361         log = log + "fatalError: %s:" % (msg)
3362
3363 handler = callback()
3364
3365 ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
3366 chunk = " url='tst'&gt;b"
3367 ctxt.parseChunk(chunk, len(chunk), 0)
3368 chunk = "ar&lt;/foo&gt;"
3369 ctxt.parseChunk(chunk, len(chunk), 1)
3370
3371 reference = "startDocument:startElement foo {'url': 'tst'}:" + \
3372             "characters: bar:endElement foo:endDocument:"
3373 if log != reference:
3374     print "Error got: %s" % log
3375     print "Expected: %s" % reference</pre>
3376
3377 <p>The key object in that test is the handler, it provides a number of entry
3378 points which can be called by the parser as it makes progresses to indicate
3379 the information set obtained. The full set of callback is larger than what
3380 the callback class in that specific example implements (see the SAX
3381 definition for a complete list). The wrapper will only call those supplied by
3382 the object when activated. The startElement receives the names of the element
3383 and a dictionary containing the attributes carried by this element.</p>
3384
3385 <p>Also note that the reference string generated from the callback shows a
3386 single character call even though the string "bar" is passed to the parser
3387 from 2 different call to parseChunk()</p>
3388
3389 <h3>xpath.py:</h3>
3390
3391 <p>This is a basic test of XPath wrappers support</p>
3392 <pre>import libxml2
3393
3394 doc = libxml2.parseFile("tst.xml")
3395 ctxt = doc.xpathNewContext()
3396 res = ctxt.xpathEval("//*")
3397 if len(res) != 2:
3398     print "xpath query: wrong node set size"
3399     sys.exit(1)
3400 if res[0].name != "doc" or res[1].name != "foo":
3401     print "xpath query: wrong node set value"
3402     sys.exit(1)
3403 doc.freeDoc()
3404 ctxt.xpathFreeContext()</pre>
3405
3406 <p>This test parses a file, then create an XPath context to evaluate XPath
3407 expression on it. The xpathEval() method execute an XPath query and returns
3408 the result mapped in a Python way. String and numbers are natively converted,
3409 and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
3410 the document, the XPath context need to be freed explicitly, also not that
3411 the result of the XPath query may point back to the document tree and hence
3412 the document must be freed after the result of the query is used.</p>
3413
3414 <h3>xpathext.py:</h3>
3415
3416 <p>This test shows how to extend the XPath engine with functions written in
3417 python:</p>
3418 <pre>import libxml2
3419
3420 def foo(ctx, x):
3421     return x + 1
3422
3423 doc = libxml2.parseFile("tst.xml")
3424 ctxt = doc.xpathNewContext()
3425 libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
3426 res = ctxt.xpathEval("foo(1)")
3427 if res != 2:
3428     print "xpath extension failure"
3429 doc.freeDoc()
3430 ctxt.xpathFreeContext()</pre>
3431
3432 <p>Note how the extension function is registered with the context (but that
3433 part is not yet finalized, this may change slightly in the future).</p>
3434
3435 <h3>tstxpath.py:</h3>
3436
3437 <p>This test is similar to the previous one but shows how the extension
3438 function can access the XPath evaluation context:</p>
3439 <pre>def foo(ctx, x):
3440     global called
3441
3442     #
3443     # test that access to the XPath evaluation contexts
3444     #
3445     pctxt = libxml2.xpathParserContext(_obj=ctx)
3446     ctxt = pctxt.context()
3447     called = ctxt.function()
3448     return x + 1</pre>
3449
3450 <p>All the interfaces around the XPath parser(or rather evaluation) context
3451 are not finalized, but it should be sufficient to do contextual work at the
3452 evaluation point.</p>
3453
3454 <h3>Memory debugging:</h3>
3455
3456 <p>last but not least, all tests starts with the following prologue:</p>
3457 <pre>#memory debug specific
3458 libxml2.debugMemory(1)</pre>
3459
3460 <p>and ends with the following epilogue:</p>
3461 <pre>#memory debug specific
3462 libxml2.cleanupParser()
3463 if libxml2.debugMemory(1) == 0:
3464     print "OK"
3465 else:
3466     print "Memory leak %d bytes" % (libxml2.debugMemory(1))
3467     libxml2.dumpMemory()</pre>
3468
3469 <p>Those activate the memory debugging interface of libxml2 where all
3470 allocated block in the library are tracked. The prologue then cleans up the
3471 library state and checks that all allocated memory has been freed. If not it
3472 calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
3473
3474 <h2><a name="architecture">libxml2 architecture</a></h2>
3475
3476 <p>Libxml2 is made of multiple components; some of them are optional, and
3477 most of the block interfaces are public. The main components are:</p>
3478 <ul>
3479   <li>an Input/Output layer</li>
3480   <li>FTP and HTTP client layers (optional)</li>
3481   <li>an Internationalization layer managing the encodings support</li>
3482   <li>a URI module</li>
3483   <li>the XML parser and its basic SAX interface</li>
3484   <li>an HTML parser using the same SAX interface (optional)</li>
3485   <li>a SAX tree module to build an in-memory DOM representation</li>
3486   <li>a tree module to manipulate the DOM representation</li>
3487   <li>a validation module using the DOM representation (optional)</li>
3488   <li>an XPath module for global lookup in a DOM representation
3489   (optional)</li>
3490   <li>a debug module (optional)</li>
3491 </ul>
3492
3493 <p>Graphically this gives the following:</p>
3494
3495 <p><img src="libxml.gif" alt="a graphical view of the various"></p>
3496
3497 <p></p>
3498
3499 <h2><a name="tree">The tree output</a></h2>
3500
3501 <p>The parser returns a tree built during the document analysis. The value
3502 returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
3503 <strong>xmlDoc</strong> structure). This structure contains information such
3504 as the file name, the document type, and a <strong>children</strong> pointer
3505 which is the root of the document (or more exactly the first child under the
3506 root which is the document). The tree is made of <strong>xmlNode</strong>s,
3507 chained in double-linked lists of siblings and with a children&lt;-&gt;parent
3508 relationship. An xmlNode can also carry properties (a chain of xmlAttr
3509 structures). An attribute may have a value which is a list of TEXT or
3510 ENTITY_REF nodes.</p>
3511
3512 <p>Here is an example (erroneous with respect to the XML spec since there
3513 should be only one ELEMENT under the root):</p>
3514
3515 <p><img src="structure.gif" alt=" structure.gif "></p>
3516
3517 <p>In the source package there is a small program (not installed by default)
3518 called <strong>xmllint</strong> which parses XML files given as argument and
3519 prints them back as parsed. This is useful for detecting errors both in XML
3520 code and in the XML parser itself. It has an option <strong>--debug</strong>
3521 which prints the actual in-memory structure of the document; here is the
3522 result with the <a href="#example">example</a> given before:</p>
3523 <pre>DOCUMENT
3524 version=1.0
3525 standalone=true
3526   ELEMENT EXAMPLE
3527     ATTRIBUTE prop1
3528       TEXT
3529       content=gnome is great
3530     ATTRIBUTE prop2
3531       ENTITY_REF
3532       TEXT
3533       content= linux too
3534     ELEMENT head
3535       ELEMENT title
3536         TEXT
3537         content=Welcome to Gnome
3538     ELEMENT chapter
3539       ELEMENT title
3540         TEXT
3541         content=The Linux adventure
3542       ELEMENT p
3543         TEXT
3544         content=bla bla bla ...
3545       ELEMENT image
3546         ATTRIBUTE href
3547           TEXT
3548           content=linus.gif
3549       ELEMENT p
3550         TEXT
3551         content=...</pre>
3552
3553 <p>This should be useful for learning the internal representation model.</p>
3554
3555 <h2><a name="interface">The SAX interface</a></h2>
3556
3557 <p>Sometimes the DOM tree output is just too large to fit reasonably into
3558 memory. In that case (and if you don't expect to save back the XML document
3559 loaded using libxml), it's better to use the SAX interface of libxml. SAX is
3560 a <strong>callback-based interface</strong> to the parser. Before parsing,
3561 the application layer registers a customized set of callbacks which are
3562 called by the library as it progresses through the XML input.</p>
3563
3564 <p>To get more detailed step-by-step guidance on using the SAX interface of
3565 libxml, see the <a
3566 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
3567 documentation</a>.written by <a href="mailto:james@daa.com.au">James
3568 Henstridge</a>.</p>
3569
3570 <p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
3571 program located in the gnome-xml module (it's usually not shipped in the
3572 binary packages of libxml, but you can find it in the tar source
3573 distribution). Here is the sequence of callbacks that would be reported by
3574 testSAX when parsing the example XML document shown earlier:</p>
3575 <pre>SAX.setDocumentLocator()
3576 SAX.startDocument()
3577 SAX.getEntity(amp)
3578 SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
3579 SAX.characters(   , 3)
3580 SAX.startElement(head)
3581 SAX.characters(    , 4)
3582 SAX.startElement(title)
3583 SAX.characters(Welcome to Gnome, 16)
3584 SAX.endElement(title)
3585 SAX.characters(   , 3)
3586 SAX.endElement(head)
3587 SAX.characters(   , 3)
3588 SAX.startElement(chapter)
3589 SAX.characters(    , 4)
3590 SAX.startElement(title)
3591 SAX.characters(The Linux adventure, 19)
3592 SAX.endElement(title)
3593 SAX.characters(    , 4)
3594 SAX.startElement(p)
3595 SAX.characters(bla bla bla ..., 15)
3596 SAX.endElement(p)
3597 SAX.characters(    , 4)
3598 SAX.startElement(image, href='linus.gif')
3599 SAX.endElement(image)
3600 SAX.characters(    , 4)
3601 SAX.startElement(p)
3602 SAX.characters(..., 3)
3603 SAX.endElement(p)
3604 SAX.characters(   , 3)
3605 SAX.endElement(chapter)
3606 SAX.characters( , 1)
3607 SAX.endElement(EXAMPLE)
3608 SAX.endDocument()</pre>
3609
3610 <p>Most of the other interfaces of libxml2 are based on the DOM tree-building
3611 facility, so nearly everything up to the end of this document presupposes the
3612 use of the standard DOM tree build. Note that the DOM tree itself is built by
3613 a set of registered default callbacks, without internal specific
3614 interface.</p>
3615
3616 <h2><a name="Validation">Validation &amp; DTDs</a></h2>
3617
3618 <p>Table of Content:</p>
3619 <ol>
3620   <li><a href="#General5">General overview</a></li>
3621   <li><a href="#definition">The definition</a></li>
3622   <li><a href="#Simple">Simple rules</a>
3623     <ol>
3624       <li><a href="#reference">How to reference a DTD from a document</a></li>
3625       <li><a href="#Declaring">Declaring elements</a></li>
3626       <li><a href="#Declaring1">Declaring attributes</a></li>
3627     </ol>
3628   </li>
3629   <li><a href="#Some">Some examples</a></li>
3630   <li><a href="#validate">How to validate</a></li>
3631   <li><a href="#Other">Other resources</a></li>
3632 </ol>
3633
3634 <h3><a name="General5">General overview</a></h3>
3635
3636 <p>Well what is validation and what is a DTD ?</p>
3637
3638 <p>DTD is the acronym for Document Type Definition. This is a description of
3639 the content for a family of XML files. This is part of the XML 1.0
3640 specification, and allows one to describe and verify that a given document
3641 instance conforms to the set of rules detailing its structure and content.</p>
3642
3643 <p>Validation is the process of checking a document against a DTD (more
3644 generally against a set of construction rules).</p>
3645
3646 <p>The validation process and building DTDs are the two most difficult parts
3647 of the XML life cycle. Briefly a DTD defines all the possible elements to be
3648 found within your document, what is the formal shape of your document tree
3649 (by defining the allowed content of an element; either text, a regular
3650 expression for the allowed list of children, or mixed content i.e. both text
3651 and children). The DTD also defines the valid attributes for all elements and
3652 the types of those attributes.</p>
3653
3654 <h3><a name="definition1">The definition</a></h3>
3655
3656 <p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
3657 href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
3658 Rev1</a>):</p>
3659 <ul>
3660   <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
3661   elements</a></li>
3662   <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
3663   attributes</a></li>
3664 </ul>
3665
3666 <p>(unfortunately) all this is inherited from the SGML world, the syntax is
3667 ancient...</p>
3668
3669 <h3><a name="Simple1">Simple rules</a></h3>
3670
3671 <p>Writing DTDs can be done in many ways. The rules to build them if you need
3672 something permanent or something which can evolve over time can be radically
3673 different. Really complex DTDs like DocBook ones are flexible but quite
3674 harder to design. I will just focus on DTDs for a formats with a fixed simple
3675 structure. It is just a set of basic rules, and definitely not exhaustive nor
3676 usable for complex DTD design.</p>
3677
3678 <h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
3679
3680 <p>Assuming the top element of the document is <code>spec</code> and the dtd
3681 is placed in the file <code>mydtd</code> in the subdirectory
3682 <code>dtds</code> of the directory from where the document were loaded:</p>
3683
3684 <p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
3685
3686 <p>Notes:</p>
3687 <ul>
3688   <li>The system string is actually an URI-Reference (as defined in <a
3689     href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
3690     full URL string indicating the location of your DTD on the Web. This is a
3691     really good thing to do if you want others to validate your document.</li>
3692   <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
3693     magic string) so that the DTD is looked up in catalogs on the client side
3694     without having to locate it on the web.</li>
3695   <li>A DTD contains a set of element and attribute declarations, but they
3696     don't define what the root of the document should be. This is explicitly
3697     told to the parser/validator as the first element of the
3698     <code>DOCTYPE</code> declaration.</li>
3699 </ul>
3700
3701 <h4><a name="Declaring2">Declaring elements</a>:</h4>
3702
3703 <p>The following declares an element <code>spec</code>:</p>
3704
3705 <p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
3706
3707 <p>It also expresses that the spec element contains one <code>front</code>,
3708 one <code>body</code> and one optional <code>back</code> children elements in
3709 this order. The declaration of one element of the structure and its content
3710 are done in a single declaration. Similarly the following declares
3711 <code>div1</code> elements:</p>
3712
3713 <p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
3714
3715 <p>which means div1 contains one <code>head</code> then a series of optional
3716 <code>p</code>, <code>list</code>s and <code>note</code>s and then an
3717 optional <code>div2</code>. And last but not least an element can contain
3718 text:</p>
3719
3720 <p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
3721
3722 <p><code>b</code> contains text or being of mixed content (text and elements
3723 in no particular order):</p>
3724
3725 <p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
3726
3727 <p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
3728 <code>b</code>, <code>i </code>or <code>em</code> elements in no particular
3729 order.</p>
3730
3731 <h4><a name="Declaring1">Declaring attributes</a>:</h4>
3732
3733 <p>Again the attributes declaration includes their content definition:</p>
3734
3735 <p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
3736
3737 <p>means that the element <code>termdef</code> can have a <code>name</code>
3738 attribute containing text (<code>CDATA</code>) and which is optional
3739 (<code>#IMPLIED</code>). The attribute value can also be defined within a
3740 set:</p>
3741
3742 <p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
3743 "ordered"&gt;</code></p>
3744
3745 <p>means <code>list</code> element have a <code>type</code> attribute with 3
3746 allowed values "bullets", "ordered" or "glossary" and which default to
3747 "ordered" if the attribute is not explicitly specified.</p>
3748
3749 <p>The content type of an attribute can be text (<code>CDATA</code>),
3750 anchor/reference/references
3751 (<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
3752 (<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
3753 (<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
3754 <code>chapter</code> element can have an optional <code>id</code> attribute
3755 of type <code>ID</code>, usable for reference from attribute of type
3756 IDREF:</p>
3757
3758 <p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
3759
3760 <p>The last value of an attribute definition can be <code>#REQUIRED
3761 </code>meaning that the attribute has to be given, <code>#IMPLIED</code>
3762 meaning that it is optional, or the default value (possibly prefixed by
3763 <code>#FIXED</code> if it is the only allowed).</p>
3764
3765 <p>Notes:</p>
3766 <ul>
3767   <li>Usually the attributes pertaining to a given element are declared in a
3768     single expression, but it is just a convention adopted by a lot of DTD
3769     writers:
3770     <pre>&lt;!ATTLIST termdef
3771           id      ID      #REQUIRED
3772           name    CDATA   #IMPLIED&gt;</pre>
3773     <p>The previous construct defines both <code>id</code> and
3774     <code>name</code> attributes for the element <code>termdef</code>.</p>
3775   </li>
3776 </ul>
3777
3778 <h3><a name="Some1">Some examples</a></h3>
3779
3780 <p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
3781 contains some complex DTD examples. The example in the file
3782 <code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
3783 directly included within the document.</p>
3784
3785 <h3><a name="validate1">How to validate</a></h3>
3786
3787 <p>The simplest way is to use the xmllint program included with libxml. The
3788 <code>--valid</code> option turns-on validation of the files given as input.
3789 For example the following validates a copy of the first revision of the XML
3790 1.0 specification:</p>
3791
3792 <p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
3793
3794 <p>the -- noout is used to disable output of the resulting tree.</p>
3795
3796 <p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
3797 against a given DTD.</p>
3798
3799 <p>Libxml2 exports an API to handle DTDs and validation, check the <a
3800 href="http://xmlsoft.org/html/libxml-valid.html">associated
3801 description</a>.</p>
3802
3803 <h3><a name="Other1">Other resources</a></h3>
3804
3805 <p>DTDs are as old as SGML. So there may be a number of examples on-line, I
3806 will just list one for now, others pointers welcome:</p>
3807 <ul>
3808   <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
3809 </ul>
3810
3811 <p>I suggest looking at the examples found under test/valid/dtd and any of
3812 the large number of books available on XML. The dia example in test/valid
3813 should be both simple and complete enough to allow you to build your own.</p>
3814
3815 <p></p>
3816
3817 <h2><a name="Memory">Memory Management</a></h2>
3818
3819 <p>Table of Content:</p>
3820 <ol>
3821   <li><a href="#General3">General overview</a></li>
3822   <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
3823   <li><a href="#cleanup">Cleaning up after using the library</a></li>
3824   <li><a href="#Debugging">Debugging routines</a></li>
3825   <li><a href="#General4">General memory requirements</a></li>
3826   <li><a href="#Compacting">Returning memory to the kernel</a></li>
3827 </ol>
3828
3829 <h3><a name="General3">General overview</a></h3>
3830
3831 <p>The module <code><a
3832 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
3833 provides the interfaces to the libxml2 memory system:</p>
3834 <ul>
3835   <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
3836     xmlMalloc() and xmlRealloc()</li>
3837   <li>those routines can be reallocated to a specific set of routine, by
3838     default the libc ones i.e. free(), malloc() and realloc()</li>
3839   <li>the xmlmemory.c module includes a set of debugging routine</li>
3840 </ul>
3841
3842 <h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
3843
3844 <p>It is sometimes useful to not use the default memory allocator, either for
3845 debugging, analysis or to implement a specific behaviour on memory management
3846 (like on embedded systems). Two function calls are available to do so:</p>
3847 <ul>
3848   <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
3849     ()</a> which return the current set of functions in use by the parser</li>
3850   <li><a
3851     href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
3852     which allow to set up a new set of memory allocation functions</li>
3853 </ul>
3854
3855 <p>Of course a call to xmlMemSetup() should probably be done before calling
3856 any other libxml2 routines (unless you are sure your allocations routines are
3857 compatibles).</p>
3858
3859 <h3><a name="cleanup">Cleaning up after using the library</a></h3>
3860
3861 <p>Libxml2 is not stateless, there is a few set of memory structures needing
3862 allocation before the parser is fully functional (some encoding structures
3863 for example). This also mean that once parsing is finished there is a tiny
3864 amount of memory (a few hundred bytes) which can be recollected if you don't
3865 reuse the library or any document built with it:</p>
3866 <ul>
3867   <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
3868     ()</a> is a centralized routine to free the library state and data. Note
3869     that it won't deallocate any produced tree if any (use the xmlFreeDoc()
3870     and related routines for this). This should be called only when the library
3871     is not used anymore.</li>
3872   <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
3873     ()</a> is the dual routine allowing to preallocate the parsing state
3874     which can be useful for example to avoid initialization reentrancy
3875     problems when using libxml2 in multithreaded applications</li>
3876 </ul>
3877
3878 <p>Generally xmlCleanupParser() is safe assuming no parsing is ongoing and
3879 no document is still being used, if needed the state will be rebuild at the
3880 next invocation of parser routines (or by xmlInitParser()), but be careful
3881 of the consequences in multithreaded applications.</p>
3882
3883 <h3><a name="Debugging">Debugging routines</a></h3>
3884
3885 <p>When configured using --with-mem-debug flag (off by default), libxml2 uses
3886 a set of memory allocation debugging routines keeping track of all allocated
3887 blocks and the location in the code where the routine was called. A couple of
3888 other debugging routines allow to dump the memory allocated infos to a file
3889 or call a specific routine when a given block number is allocated:</p>
3890 <ul>
3891   <li><a
3892     href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
3893     <a
3894     href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
3895     and <a
3896     href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
3897     are the memory debugging replacement allocation routines</li>
3898   <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
3899     ()</a> dumps all the information about the allocated memory block lefts
3900     in the <code>.memdump</code> file</li>
3901 </ul>
3902
3903 <p>When developing libxml2 memory debug is enabled, the tests programs call
3904 xmlMemoryDump () and the "make test" regression tests will check for any
3905 memory leak during the full regression test sequence, this helps a lot
3906 ensuring that libxml2  does not leak memory and bullet proof memory
3907 allocations use (some libc implementations are known to be far too permissive
3908 resulting in major portability problems!).</p>
3909
3910 <p>If the .memdump reports a leak, it displays the allocation function and
3911 also tries to give some information about the content and structure of the
3912 allocated blocks left. This is sufficient in most cases to find the culprit,
3913 but not always. Assuming the allocation problem is reproducible, it is
3914 possible to find more easily:</p>
3915 <ol>
3916   <li>write down the block number xxxx not allocated</li>
3917   <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
3918     when using GDB is to simply give the command
3919     <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
3920     <p>before running the program.</p>
3921   </li>
3922   <li>run the program under a debugger and set a breakpoint on
3923     xmlMallocBreakpoint() a specific function called when this precise block
3924     is allocated</li>
3925   <li>when the breakpoint is reached you can then do a fine analysis of the
3926     allocation an step  to see the condition resulting in the missing
3927     deallocation.</li>
3928 </ol>
3929
3930 <p>I used to use a commercial tool to debug libxml2 memory problems but after
3931 noticing that it was not detecting memory leaks that simple mechanism was
3932 used and proved extremely efficient until now. Lately I have also used <a
3933 href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
3934 success, it is tied to the i386 architecture since it works by emulating the
3935 processor and instruction set, it is slow but  extremely efficient, i.e. it
3936 spot memory usage errors in a very precise way.</p>
3937
3938 <h3><a name="General4">General memory requirements</a></h3>
3939
3940 <p>How much libxml2 memory require ? It's hard to tell in average it depends
3941 of a number of things:</p>
3942 <ul>
3943   <li>the parser itself should work  in a fixed amount of memory, except for
3944     information maintained about the stacks of names and  entities locations.
3945     The I/O and encoding handlers will probably account for a few KBytes.
3946     This is true for both the XML and HTML parser (though the HTML parser
3947     need more state).</li>
3948   <li>If you are generating the DOM tree then memory requirements will grow
3949     nearly linear with the size of the data. In general for a balanced
3950     textual document the internal memory requirement is about 4 times the
3951     size of the UTF8 serialization of this document (example the XML-1.0
3952     recommendation is a bit more of 150KBytes and takes 650KBytes of main
3953     memory when parsed). Validation will add a amount of memory required for
3954     maintaining the external Dtd state which should be linear with the
3955     complexity of the content model defined by the Dtd</li>
3956   <li>If you need to work with fixed memory requirements or don't need the
3957     full DOM tree then using the <a href="xmlreader.html">xmlReader
3958     interface</a> is probably the best way to proceed, it still allows to
3959     validate or operate on subset of the tree if needed.</li>
3960   <li>If you don't care about the advanced features of libxml2 like
3961     validation, DOM, XPath or XPointer, don't use entities, need to work with
3962     fixed memory requirements, and try to get the fastest parsing possible
3963     then the SAX interface should be used, but it has known restrictions.</li>
3964 </ul>
3965
3966 <p></p>
3967 <h3><a name="Compacting">Returning memory to the kernel</a></h3>
3968
3969 <p>You may encounter that your process using libxml2 does not have a
3970 reduced memory usage although you freed the trees. This is because
3971 libxml2 allocates memory in a number of small chunks. When freeing one
3972 of those chunks, the OS may decide that giving this little memory back
3973 to the kernel will cause too much overhead and delay the operation. As
3974 all chunks are this small, they get actually freed but not returned to
3975 the kernel. On systems using glibc, there is a function call
3976 "malloc_trim" from malloc.h which does this missing operation (note that
3977 it is allowed to fail). Thus, after freeing your tree you may simply try
3978 "malloc_trim(0);" to really get the memory back. If your OS does not
3979 provide malloc_trim, try searching for a similar function.</p>
3980 <p></p>
3981
3982 <h2><a name="Encodings">Encodings support</a></h2>
3983
3984 <p>If you are not really familiar with Internationalization (usual shortcut
3985 is I18N) , Unicode, characters and glyphs, I suggest you read a <a
3986 href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
3987 by Tim Bray on Unicode and why you should care about it.</p>
3988
3989 <p>If you don't understand why <b>it does not make sense to have a string
3990 without knowing what encoding it uses</b>, then as Joel Spolsky said <a
3991 href="http://www.joelonsoftware.com/articles/Unicode.html">please do not
3992 write another line of code until you finish reading that article.</a>. It is
3993 a prerequisite to understand this page, and avoid a lot of problems with
3994 libxml2, XML or text processing in general.</p>
3995
3996 <p>Table of Content:</p>
3997 <ol>
3998   <li><a href="encoding.html#What">What does internationalization support
3999     mean ?</a></li>
4000   <li><a href="encoding.html#internal">The internal encoding, how and
4001   why</a></li>
4002   <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
4003   <li><a href="encoding.html#Default">Default supported encodings</a></li>
4004   <li><a href="encoding.html#extend">How to extend the existing
4005   support</a></li>
4006 </ol>
4007
4008 <h3><a name="What">What does internationalization support mean ?</a></h3>
4009
4010 <p>XML was designed from the start to allow the support of any character set
4011 by using Unicode. Any conformant XML parser has to support the UTF-8 and
4012 UTF-16 default encodings which can both express the full unicode ranges. UTF8
4013 is a variable length encoding whose greatest points are to reuse the same
4014 encoding for ASCII and to save space for Western encodings, but it is a bit
4015 more complex to handle in practice. UTF-16 use 2 bytes per character (and
4016 sometimes combines two pairs), it makes implementation easier, but looks a
4017 bit overkill for Western languages encoding. Moreover the XML specification
4018 allows the document to be encoded in other encodings at the condition that
4019 they are clearly labeled as such. For example the following is a wellformed
4020 XML document encoded in ISO-8859-1 and using accentuated letters that we
4021 French like for both markup and content:</p>
4022 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
4023 &lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;</pre>
4024
4025 <p>Having internationalization support in libxml2 means the following:</p>
4026 <ul>
4027   <li>the document is properly parsed</li>
4028   <li>information about it's encoding is saved</li>
4029   <li>it can be modified</li>
4030   <li>it can be saved in its original encoding</li>
4031   <li>it can also be saved in another encoding supported by libxml2 (for
4032     example straight UTF8 or even an ASCII form)</li>
4033 </ul>
4034
4035 <p>Another very important point is that the whole libxml2 API, with the
4036 exception of a few routines to read with a specific encoding or save to a
4037 specific encoding, is completely agnostic about the original encoding of the
4038 document.</p>
4039
4040 <p>It should be noted too that the HTML parser embedded in libxml2 now obey
4041 the same rules too, the following document will be (as of 2.2.2) handled  in
4042 an internationalized fashion by libxml2 too:</p>
4043 <pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
4044                       "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
4045 &lt;html lang="fr"&gt;
4046 &lt;head&gt;
4047   &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
4048 &lt;/head&gt;
4049 &lt;body&gt;
4050 &lt;p&gt;W3C cr&eacute;e des standards pour le Web.&lt;/body&gt;
4051 &lt;/html&gt;</pre>
4052
4053 <h3><a name="internal">The internal encoding, how and why</a></h3>
4054
4055 <p>One of the core decisions was to force all documents to be converted to a
4056 default internal encoding, and that encoding to be UTF-8, here are the
4057 rationales for those choices:</p>
4058 <ul>
4059   <li>keeping the native encoding in the internal form would force the libxml
4060     users (or the code associated) to be fully aware of the encoding of the
4061     original document, for examples when adding a text node to a document,
4062     the content would have to be provided in the document encoding, i.e. the
4063     client code would have to check it before hand, make sure it's conformant
4064     to the encoding, etc ... Very hard in practice, though in some specific
4065     cases this may make sense.</li>
4066   <li>the second decision was which encoding. From the XML spec only UTF8 and
4067     UTF16 really makes sense as being the two only encodings for which there
4068     is mandatory support. UCS-4 (32 bits fixed size encoding) could be
4069     considered an intelligent choice too since it's a direct Unicode mapping
4070     support. I selected UTF-8 on the basis of efficiency and compatibility
4071     with surrounding software:
4072     <ul>
4073       <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
4074         more costly to import and export CPU wise) is also far more compact
4075         than UTF-16 (and UCS-4) for a majority of the documents I see it used
4076         for right now (RPM RDF catalogs, advogato data, various configuration
4077         file formats, etc.) and the key point for today's computer
4078         architecture is efficient uses of caches. If one nearly double the
4079         memory requirement to store the same amount of data, this will trash
4080         caches (main memory/external caches/internal caches) and my take is
4081         that this harms the system far more than the CPU requirements needed
4082         for the conversion to UTF-8</li>
4083       <li>Most of libxml2 version 1 users were using it with straight ASCII
4084         most of the time, doing the conversion with an internal encoding
4085         requiring all their code to be rewritten was a serious show-stopper
4086         for using UTF-16 or UCS-4.</li>
4087       <li>UTF-8 is being used as the de-facto internal encoding standard for
4088         related code like the <a href="http://www.pango.org/">pango</a>
4089         upcoming Gnome text widget, and a lot of Unix code (yet another place
4090         where Unix programmer base takes a different approach from Microsoft
4091         - they are using UTF-16)</li>
4092     </ul>
4093   </li>
4094 </ul>
4095
4096 <p>What does this mean in practice for the libxml2 user:</p>
4097 <ul>
4098   <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
4099     as UTF-8 valid strings. The proper way to terminate an xmlChar * string
4100     is simply to append 0 byte, as usual.</li>
4101   <li>One just need to make sure that when using chars outside the ASCII set,
4102     the values has been properly converted to UTF-8</li>
4103 </ul>
4104
4105 <h3><a name="implemente">How is it implemented ?</a></h3>
4106
4107 <p>Let's describe how all this works within libxml, basically the I18N
4108 (internationalization) support get triggered only during I/O operation, i.e.
4109 when reading a document or saving one. Let's look first at the reading
4110 sequence:</p>
4111 <ol>
4112   <li>when a document is processed, we usually don't know the encoding, a
4113     simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
4114     the ASCII range (0-0x7F) maps with ASCII</li>
4115   <li>the xml declaration if available is parsed, including the encoding
4116     declaration. At that point, if the autodetected encoding is different
4117     from the one declared a call to xmlSwitchEncoding() is issued.</li>
4118   <li>If there is no encoding declaration, then the input has to be in either
4119     UTF-8 or UTF-16, if it is not then at some point when processing the
4120     input, the converter/checker of UTF-8 form will raise an encoding error.
4121     You may end-up with a garbled document, or no document at all ! Example:
4122     <pre>~/XML -&gt; ./xmllint err.xml
4123 err.xml:1: error: Input is not proper UTF-8, indicate encoding !
4124 &lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
4125    ^
4126 err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
4127 &lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
4128    ^</pre>
4129   </li>
4130   <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
4131     then search the default registered encoding converters for that encoding.
4132     If it's not within the default set and iconv() support has been compiled
4133     it, it will ask iconv for such an encoder. If this fails then the parser
4134     will report an error and stops processing:
4135     <pre>~/XML -&gt; ./xmllint err2.xml
4136 err2.xml:1: error: Unsupported encoding UnsupportedEnc
4137 &lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
4138                                              ^</pre>
4139   </li>
4140   <li>From that point the encoder processes progressively the input (it is
4141     plugged as a front-end to the I/O module) for that entity. It captures
4142     and converts on-the-fly the document to be parsed to UTF-8. The parser
4143     itself just does UTF-8 checking of this input and process it
4144     transparently. The only difference is that the encoding information has
4145     been added to the parsing context (more precisely to the input
4146     corresponding to this entity).</li>
4147   <li>The result (when using DOM) is an internal form completely in UTF-8
4148     with just an encoding information on the document node.</li>
4149 </ol>
4150
4151 <p>Ok then what happens when saving the document (assuming you
4152 collected/built an xmlDoc DOM like structure) ? It depends on the function
4153 called, xmlSaveFile() will just try to save in the original encoding, while
4154 xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
4155 encoding:</p>
4156 <ol>
4157   <li>if no encoding is given, libxml2 will look for an encoding value
4158     associated to the document and if it exists will try to save to that
4159     encoding,
4160     <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
4161   </li>
4162   <li>so if an encoding was specified, either at the API level or on the
4163     document, libxml2 will again canonicalize the encoding name, lookup for a
4164     converter in the registered set or through iconv. If not found the
4165     function will return an error code</li>
4166   <li>the converter is placed before the I/O buffer layer, as another kind of
4167     buffer, then libxml2 will simply push the UTF-8 serialization to through
4168     that buffer, which will then progressively be converted and pushed onto
4169     the I/O layer.</li>
4170   <li>It is possible that the converter code fails on some input, for example
4171     trying to push an UTF-8 encoded Chinese character through the UTF-8 to
4172     ISO-8859-1 converter won't work. Since the encoders are progressive they
4173     will just report the error and the number of bytes converted, at that
4174     point libxml2 will decode the offending character, remove it from the
4175     buffer and replace it with the associated charRef encoding &amp;#123; and
4176     resume the conversion. This guarantees that any document will be saved
4177     without losses (except for markup names where this is not legal, this is
4178     a problem in the current version, in practice avoid using non-ascii
4179     characters for tag or attribute names). A special "ascii" encoding name
4180     is used to save documents to a pure ascii form can be used when
4181     portability is really crucial</li>
4182 </ol>
4183
4184 <p>Here are a few examples based on the same test document and assumin a
4185 terminal using ISO-8859-1 as the text encoding:</p>
4186 <pre>~/XML -&gt; ./xmllint isolat1
4187 &lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
4188 &lt;tr&egrave;s&gt;lÃ &lt;/tr&egrave;s&gt;
4189 ~/XML -&gt; ./xmllint --encode UTF-8 isolat1
4190 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
4191 &lt;trÃ¨s&gt;lÃ &nbsp;&lt;/trÃ¨s&gt;
4192 ~/XML -&gt; </pre>
4193
4194 <p>The same processing is applied (and reuse most of the code) for HTML I18N
4195 processing. Looking up and modifying the content encoding is a bit more
4196 difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
4197 so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
4198 been provided. The parser also attempts to switch encoding on the fly when
4199 detecting such a tag on input. Except for that the processing is the same
4200 (and again reuses the same code).</p>
4201
4202 <h3><a name="Default">Default supported encodings</a></h3>
4203
4204 <p>libxml2 has a set of default converters for the following encodings
4205 (located in encoding.c):</p>
4206 <ol>
4207   <li>UTF-8 is supported by default (null handlers)</li>
4208   <li>UTF-16, both little and big endian</li>
4209   <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
4210   <li>ASCII, useful mostly for saving</li>
4211   <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
4212     predefined entities like &amp;copy; for the Copyright sign.</li>
4213 </ol>
4214
4215 <p>More over when compiled on an Unix platform with iconv support the full
4216 set of encodings supported by iconv can be instantly be used by libxml. On a
4217 linux machine with glibc-2.1 the list of supported encodings and aliases fill
4218 3 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
4219 various Japanese ones.</p>
4220
4221 <p>To convert from the UTF-8 values returned from the API to another encoding
4222 then it is possible to use the function provided from <a
4223 href="html/libxml-encoding.html">the encoding module</a> like <a
4224 href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the
4225 POSIX <a
4226 href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>
4227 API directly.</p>
4228
4229 <h4>Encoding aliases</h4>
4230
4231 <p>From 2.2.3, libxml2 has support to register encoding names aliases. The
4232 goal is to be able to parse document whose encoding is supported but where
4233 the name differs (for example from the default set of names accepted by
4234 iconv). The following functions allow to register and handle new aliases for
4235 existing encodings. Once registered libxml2 will automatically lookup the
4236 aliases when handling a document:</p>
4237 <ul>
4238   <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
4239   <li>int xmlDelEncodingAlias(const char *alias);</li>
4240   <li>const char * xmlGetEncodingAlias(const char *alias);</li>
4241   <li>void xmlCleanupEncodingAliases(void);</li>
4242 </ul>
4243
4244 <h3><a name="extend">How to extend the existing support</a></h3>
4245
4246 <p>Well adding support for new encoding, or overriding one of the encoders
4247 (assuming it is buggy) should not be hard, just write input and output
4248 conversion routines to/from UTF-8, and register them using
4249 xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx),  and they will be
4250 called automatically if the parser(s) encounter such an encoding name
4251 (register it uppercase, this will help). The description of the encoders,
4252 their arguments and expected return values are described in the encoding.h
4253 header.</p>
4254
4255 <h2><a name="IO">I/O Interfaces</a></h2>
4256
4257 <p>Table of Content:</p>
4258 <ol>
4259   <li><a href="#General1">General overview</a></li>
4260   <li><a href="#basic">The basic buffer type</a></li>
4261   <li><a href="#Input">Input I/O handlers</a></li>
4262   <li><a href="#Output">Output I/O handlers</a></li>
4263   <li><a href="#entities">The entities loader</a></li>
4264   <li><a href="#Example2">Example of customized I/O</a></li>
4265 </ol>
4266
4267 <h3><a name="General1">General overview</a></h3>
4268
4269 <p>The module <code><a
4270 href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
4271 the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
4272 <ul>
4273   <li>Entities loader, this is a routine which tries to fetch the entities
4274     (files) based on their PUBLIC and SYSTEM identifiers. The default loader
4275     don't look at the public identifier since libxml2 do not maintain a
4276     catalog. You can redefine you own entity loader by using
4277     <code>xmlGetExternalEntityLoader()</code> and
4278     <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
4279     example</a>.</li>
4280   <li>Input I/O buffers which are a commodity structure used by the parser(s)
4281     input layer to handle fetching the information to feed the parser. This
4282     provides buffering and is also a placeholder where the encoding
4283     converters to UTF8 are piggy-backed.</li>
4284   <li>Output I/O buffers are similar to the Input ones and fulfill similar
4285     task but when generating a serialization from a tree.</li>
4286   <li>A mechanism to register sets of I/O callbacks and associate them with
4287     specific naming schemes like the protocol part of the URIs.
4288     <p>This affect the default I/O operations and allows to use specific I/O
4289     handlers for certain names.</p>
4290   </li>
4291 </ul>
4292
4293 <p>The general mechanism used when loading http://rpmfind.net/xml.html for
4294 example in the HTML parser is the following:</p>
4295 <ol>
4296   <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
4297     the parsing context and the URI string.</li>
4298   <li>the URI string is checked against the existing registered handlers
4299     using their match() callback function, if the HTTP module was compiled
4300     in, it is registered and its match() function will succeeds</li>
4301   <li>the open() function of the handler is called and if successful will
4302     return an I/O Input buffer</li>
4303   <li>the parser will the start reading from this buffer and progressively
4304     fetch information from the resource, calling the read() function of the
4305     handler until the resource is exhausted</li>
4306   <li>if an encoding change is detected it will be installed on the input
4307     buffer, providing buffering and efficient use of the conversion
4308   routines</li>
4309   <li>once the parser has finished, the close() function of the handler is
4310     called once and the Input buffer and associated resources are
4311   deallocated.</li>
4312 </ol>
4313
4314 <p>The user defined callbacks are checked first to allow overriding of the
4315 default libxml2 I/O routines.</p>
4316
4317 <h3><a name="basic">The basic buffer type</a></h3>
4318
4319 <p>All the buffer manipulation handling is done using the
4320 <code>xmlBuffer</code> type define in <code><a
4321 href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
4322 resizable memory buffer. The buffer allocation strategy can be selected to be
4323 either best-fit or use an exponential doubling one (CPU vs. memory use
4324 trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
4325 <code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
4326 system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
4327 of functions allows to manipulate buffers with names starting with the
4328 <code>xmlBuffer...</code> prefix.</p>
4329
4330 <h3><a name="Input">Input I/O handlers</a></h3>
4331
4332 <p>An Input I/O handler is a simple structure
4333 <code>xmlParserInputBuffer</code> containing a context associated to the
4334 resource (file descriptor, or pointer to a protocol handler), the read() and
4335 close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
4336 encoding handler are also present to support charset conversion when
4337 needed.</p>
4338
4339 <h3><a name="Output">Output I/O handlers</a></h3>
4340
4341 <p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
4342 Input one except the callbacks are write() and close().</p>
4343
4344 <h3><a name="entities">The entities loader</a></h3>
4345
4346 <p>The entity loader resolves requests for new entities and create inputs for
4347 the parser. Creating an input from a filename or an URI string is done
4348 through the xmlNewInputFromFile() routine.  The default entity loader do not
4349 handle the PUBLIC identifier associated with an entity (if any). So it just
4350 calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
4351 XML).</p>
4352
4353 <p>If you want to hook up a catalog mechanism then you simply need to
4354 override the default entity loader, here is an example:</p>
4355 <pre>#include &lt;libxml/xmlIO.h&gt;
4356
4357 xmlExternalEntityLoader defaultLoader = NULL;
4358
4359 xmlParserInputPtr
4360 xmlMyExternalEntityLoader(const char *URL, const char *ID,
4361                                xmlParserCtxtPtr ctxt) {
4362     xmlParserInputPtr ret;
4363     const char *fileID = NULL;
4364     /* lookup for the fileID depending on ID */
4365
4366     ret = xmlNewInputFromFile(ctxt, fileID);
4367     if (ret != NULL)
4368         return(ret);
4369     if (defaultLoader != NULL)
4370         ret = defaultLoader(URL, ID, ctxt);
4371     return(ret);
4372 }
4373
4374 int main(..) {
4375     ...
4376
4377     /*
4378      * Install our own entity loader
4379      */
4380     defaultLoader = xmlGetExternalEntityLoader();
4381     xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
4382
4383     ...
4384 }</pre>
4385
4386 <h3><a name="Example2">Example of customized I/O</a></h3>
4387
4388 <p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
4389 real use case</a>,  xmlDocDump() closes the FILE * passed by the application
4390 and this was a problem. The <a
4391 href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
4392 new output handler with the closing call deactivated:</p>
4393 <ol>
4394   <li>First define a new I/O output allocator where the output don't close
4395     the file:
4396     <pre>xmlOutputBufferPtr
4397 xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
4398 &nbsp;&nbsp;&nbsp;&nbsp;xmlOutputBufferPtr ret;
4399 &nbsp;&nbsp;&nbsp;&nbsp;
4400 &nbsp;&nbsp;&nbsp;&nbsp;if (xmlOutputCallbackInitialized == 0)
4401 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlRegisterDefaultOutputCallbacks();
4402
4403 &nbsp;&nbsp;&nbsp;&nbsp;if (file == NULL) return(NULL);
4404 &nbsp;&nbsp;&nbsp;&nbsp;ret = xmlAllocOutputBuffer(encoder);
4405 &nbsp;&nbsp;&nbsp;&nbsp;if (ret != NULL) {
4406 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;context = file;
4407 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;writecallback = xmlFileWrite;
4408 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;closecallback = NULL;  /* No close callback */
4409 &nbsp;&nbsp;&nbsp;&nbsp;}
4410 &nbsp;&nbsp;&nbsp;&nbsp;return(ret);
4411 } </pre>
4412   </li>
4413   <li>And then use it to save the document:
4414     <pre>FILE *f;
4415 xmlOutputBufferPtr output;
4416 xmlDocPtr doc;
4417 int res;
4418
4419 f = ...
4420 doc = ....
4421
4422 output = xmlOutputBufferCreateOwn(f, NULL);
4423 res = xmlSaveFileTo(output, doc, NULL);
4424     </pre>
4425   </li>
4426 </ol>
4427
4428 <h2><a name="Catalog">Catalog support</a></h2>
4429
4430 <p>Table of Content:</p>
4431 <ol>
4432   <li><a href="General2">General overview</a></li>
4433   <li><a href="#definition">The definition</a></li>
4434   <li><a href="#Simple">Using catalogs</a></li>
4435   <li><a href="#Some">Some examples</a></li>
4436   <li><a href="#reference">How to tune  catalog usage</a></li>
4437   <li><a href="#validate">How to debug catalog processing</a></li>
4438   <li><a href="#Declaring">How to create and maintain catalogs</a></li>
4439   <li><a href="#implemento">The implementor corner quick review of the
4440   API</a></li>
4441   <li><a href="#Other">Other resources</a></li>
4442 </ol>
4443
4444 <h3><a name="General2">General overview</a></h3>
4445
4446 <p>What is a catalog? Basically it's a lookup mechanism used when an entity
4447 (a file or a remote resource) references another entity. The catalog lookup
4448 is inserted between the moment the reference is recognized by the software
4449 (XML parser, stylesheet processing, or even images referenced for inclusion
4450 in a rendering) and the time where loading that resource is actually
4451 started.</p>
4452
4453 <p>It is basically used for 3 things:</p>
4454 <ul>
4455   <li>mapping from "logical" names, the public identifiers and a more
4456     concrete name usable for download (and URI). For example it can associate
4457     the logical name
4458     <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
4459     <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
4460     downloaded</p>
4461     <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
4462   </li>
4463   <li>remapping from a given URL to another one, like an HTTP indirection
4464     saying that
4465     <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
4466     <p>should really be looked at</p>
4467     <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
4468   </li>
4469   <li>providing a local cache mechanism allowing to load the entities
4470     associated to public identifiers or remote resources, this is a really
4471     important feature for any significant deployment of XML or SGML since it
4472     allows to avoid the aleas and delays associated to fetching remote
4473     resources.</li>
4474 </ul>
4475
4476 <h3><a name="definition">The definitions</a></h3>
4477
4478 <p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
4479 <ul>
4480   <li>the older SGML catalogs, the official spec is  SGML Open Technical
4481     Resolution TR9401:1997, but is better understood by reading <a
4482     href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
4483     James Clark. This is relatively old and not the preferred mode of
4484     operation of libxml.</li>
4485   <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
4486     Catalogs</a> is far more flexible, more recent, uses an XML syntax and
4487     should scale quite better. This is the default option of libxml.</li>
4488 </ul>
4489
4490 <p></p>
4491
4492 <h3><a name="Simple">Using catalog</a></h3>
4493
4494 <p>In a normal environment libxml2 will by default check the presence of a
4495 catalog in /etc/xml/catalog, and assuming it has been correctly populated,
4496 the processing is completely transparent to the document user. To take a
4497 concrete example, suppose you are authoring a DocBook document, this one
4498 starts with the following DOCTYPE definition:</p>
4499 <pre>&lt;?xml version='1.0'?&gt;
4500 &lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
4501           "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
4502
4503 <p>When validating the document with libxml, the catalog will be
4504 automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
4505 DocBk XML V3.1.4//EN" and the system identifier
4506 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
4507 been installed on your system and the catalogs actually point to them, libxml
4508 will fetch them from the local disk.</p>
4509
4510 <p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
4511 DOCTYPE example it's a really old version, but is fine as an example.</p>
4512
4513 <p>Libxml2 will check the catalog each time that it is requested to load an
4514 entity, this includes DTD, external parsed entities, stylesheets, etc ... If
4515 your system is correctly configured all the authoring phase and processing
4516 should use only local files, even if your document stays portable because it
4517 uses the canonical public and system ID, referencing the remote document.</p>
4518
4519 <h3><a name="Some">Some examples:</a></h3>
4520
4521 <p>Here is a couple of fragments from XML Catalogs used in libxml2 early
4522 regression tests in <code>test/catalogs</code> :</p>
4523 <pre>&lt;?xml version="1.0"?&gt;
4524 &lt;!DOCTYPE catalog PUBLIC
4525    "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4526    "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4527 &lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4528   &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4529    uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4530 ...</pre>
4531
4532 <p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
4533 written in XML,  there is a specific namespace for catalog elements
4534 "urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
4535 catalog is a <code>public</code> mapping it allows to associate a Public
4536 Identifier with an URI.</p>
4537 <pre>...
4538     &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4539                    rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
4540 ...</pre>
4541
4542 <p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
4543 any URI starting with a given prefix should be looked at another  URI
4544 constructed by replacing the prefix with an new one. In effect this acts like
4545 a cache system for a full area of the Web. In practice it is extremely useful
4546 with a file prefix if you have installed a copy of those resources on your
4547 local system.</p>
4548 <pre>...
4549 &lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
4550                 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4551 &lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
4552                 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4553 &lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
4554                 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4555 &lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4556                 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4557 &lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
4558                 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4559 ...</pre>
4560
4561 <p>Delegation is the core features which allows to build a tree of catalogs,
4562 easier to maintain than a single catalog, based on Public Identifier, System
4563 Identifier or URI prefixes it instructs the catalog software to look up
4564 entries in another resource. This feature allow to build hierarchies of
4565 catalogs, the set of entries presented should be sufficient to redirect the
4566 resolution of all DocBook references to the specific catalog in
4567 <code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
4568 references for DocBook 4.2.1 to a specific catalog installed at the same time
4569 as the DocBook resources on the local machine.</p>
4570
4571 <h3><a name="reference">How to tune catalog usage:</a></h3>
4572
4573 <p>The user can change the default catalog behaviour by redirecting queries
4574 to its own set of catalogs, this can be done by setting the
4575 <code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
4576 empty one should deactivate loading the default <code>/etc/xml/catalog</code>
4577 default catalog</p>
4578
4579 <h3><a name="validate">How to debug catalog processing:</a></h3>
4580
4581 <p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
4582 make libxml2 output debugging information for each catalog operations, for
4583 example:</p>
4584 <pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4585 warning: failed to load external entity "title.xml"
4586 orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
4587 orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4588 Failed to parse catalog /etc/xml/catalog
4589 Failed to parse catalog /etc/xml/catalog
4590 warning: failed to load external entity "title.xml"
4591 Catalogs cleanup
4592 orchis:~/XML -&gt; </pre>
4593
4594 <p>The test/ent2 references an entity, running the parser from memory makes
4595 the base URI unavailable and the the "title.xml" entity cannot be loaded.
4596 Setting up the debug environment variable allows to detect that an attempt is
4597 made to load the <code>/etc/xml/catalog</code> but since it's not present the
4598 resolution fails.</p>
4599
4600 <p>But the most advanced way to debug XML catalog processing is to use the
4601 <strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
4602 catalogs and make resolution queries to see what is going on. This is also
4603 used for the regression tests:</p>
4604 <pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
4605                    "-//OASIS//DTD DocBook XML V4.1.2//EN"
4606 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4607 orchis:~/XML -&gt; </pre>
4608
4609 <p>For debugging what is going on, adding one -v flags increase the verbosity
4610 level to indicate the processing done (adding a second flag also indicate
4611 what elements are recognized at parsing):</p>
4612 <pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
4613                    "-//OASIS//DTD DocBook XML V4.1.2//EN"
4614 Parsing catalog test/catalogs/docbook.xml's content
4615 Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
4616 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4617 Catalogs cleanup
4618 orchis:~/XML -&gt; </pre>
4619
4620 <p>A shell interface is also available to debug and process multiple queries
4621 (and for regression tests):</p>
4622 <pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
4623                    "-//OASIS//DTD DocBook XML V4.1.2//EN"
4624 &gt; help
4625 Commands available:
4626 public PublicID: make a PUBLIC identifier lookup
4627 system SystemID: make a SYSTEM identifier lookup
4628 resolve PublicID SystemID: do a full resolver lookup
4629 add 'type' 'orig' 'replace' : add an entry
4630 del 'values' : remove values
4631 dump: print the current catalog state
4632 debug: increase the verbosity level
4633 quiet: decrease the verbosity level
4634 exit:  quit the shell
4635 &gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
4636 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4637 &gt; quit
4638 orchis:~/XML -&gt; </pre>
4639
4640 <p>This should be sufficient for most debugging purpose, this was actually
4641 used heavily to debug the XML Catalog implementation itself.</p>
4642
4643 <h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
4644
4645 <p>Basically XML Catalogs are XML files, you can either use XML tools to
4646 manage them or use  <strong>xmlcatalog</strong> for this. The basic step is
4647 to create a catalog the -create option provide this facility:</p>
4648 <pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
4649 &lt;?xml version="1.0"?&gt;
4650 &lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4651          "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4652 &lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4653 orchis:~/XML -&gt; </pre>
4654
4655 <p>By default xmlcatalog does not overwrite the original catalog and save the
4656 result on the standard output, this can be overridden using the -noout
4657 option. The <code>-add</code> command allows to add entries in the
4658 catalog:</p>
4659 <pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
4660   "-//OASIS//DTD DocBook XML V4.1.2//EN" \
4661   http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
4662 orchis:~/XML -&gt; cat tst.xml
4663 &lt;?xml version="1.0"?&gt;
4664 &lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
4665   "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4666 &lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4667 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4668         uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4669 &lt;/catalog&gt;
4670 orchis:~/XML -&gt; </pre>
4671
4672 <p>The <code>-add</code> option will always take 3 parameters even if some of
4673 the XML Catalog constructs (like nextCatalog) will have only a single
4674 argument, just pass a third empty string, it will be ignored.</p>
4675
4676 <p>Similarly the <code>-del</code> option remove matching entries from the
4677 catalog:</p>
4678 <pre>orchis:~/XML -&gt; ./xmlcatalog --del \
4679   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
4680 &lt;?xml version="1.0"?&gt;
4681 &lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4682     "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4683 &lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4684 orchis:~/XML -&gt; </pre>
4685
4686 <p>The catalog is now empty. Note that the matching of <code>-del</code> is
4687 exact and would have worked in a similar fashion with the Public ID
4688 string.</p>
4689
4690 <p>This is rudimentary but should be sufficient to manage a not too complex
4691 catalog tree of resources.</p>
4692
4693 <h3><a name="implemento">The implementor corner quick review of the
4694 API:</a></h3>
4695
4696 <p>First, and like for every other module of libxml, there is an
4697 automatically generated <a href="html/libxml-catalog.html">API page for
4698 catalog support</a>.</p>
4699
4700 <p>The header for the catalog interfaces should be included as:</p>
4701 <pre>#include &lt;libxml/catalog.h&gt;</pre>
4702
4703 <p>The API is voluntarily kept very simple. First it is not obvious that
4704 applications really need access to it since it is the default behaviour of
4705 libxml2 (Note: it is possible to completely override libxml2 default catalog
4706 by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
4707 plug an application specific resolver).</p>
4708
4709 <p>Basically libxml2 support 2 catalog lists:</p>
4710 <ul>
4711   <li>the default one, global shared by all the application</li>
4712   <li>a per-document catalog, this one is built if the document uses the
4713     <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
4714     associated to the parser context and destroyed when the parsing context
4715     is destroyed.</li>
4716 </ul>
4717
4718 <p>the document one will be used first if it exists.</p>
4719
4720 <h4>Initialization routines:</h4>
4721
4722 <p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
4723 used at startup to initialize the catalog, if the catalog should be
4724 initialized with specific values xmlLoadCatalog()  or xmlLoadCatalogs()
4725 should be called before xmlInitializeCatalog() which would otherwise do a
4726 default initialization first.</p>
4727
4728 <p>The xmlCatalogAddLocal() call is used by the parser to grow the document
4729 own catalog list if needed.</p>
4730
4731 <h4>Preferences setup:</h4>
4732
4733 <p>The XML Catalog spec requires the possibility to select default
4734 preferences between  public and system delegation,
4735 xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
4736 xmlCatalogGetDefaults() allow to control  if XML Catalogs resolution should
4737 be forbidden, allowed for global catalog, for document catalog or both, the
4738 default is to allow both.</p>
4739
4740 <p>And of course xmlCatalogSetDebug() allows to generate debug messages
4741 (through the xmlGenericError() mechanism).</p>
4742
4743 <h4>Querying routines:</h4>
4744
4745 <p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
4746 and xmlCatalogResolveURI() are relatively explicit if you read the XML
4747 Catalog specification they correspond to section 7 algorithms, they should
4748 also work if you have loaded an SGML catalog with a simplified semantic.</p>
4749
4750 <p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
4751 operate on the document catalog list</p>
4752
4753 <h4>Cleanup and Miscellaneous:</h4>
4754
4755 <p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
4756 the per-document equivalent.</p>
4757
4758 <p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
4759 first catalog in the global list, and xmlCatalogDump() allows to dump a
4760 catalog state, those routines are primarily designed for xmlcatalog, I'm not
4761 sure that exposing more complex interfaces (like navigation ones) would be
4762 really useful.</p>
4763
4764 <p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
4765 it's similar as xmlParseFile() except it bypass all catalog lookups, it's
4766 provided because this functionality may be useful for client tools.</p>
4767
4768 <h4>threaded environments:</h4>
4769
4770 <p>Since the catalog tree is built progressively, some care has been taken to
4771 try to avoid troubles in multithreaded environments. The code is now thread
4772 safe assuming that the libxml2 library has been compiled with threads
4773 support.</p>
4774
4775 <p></p>
4776
4777 <h3><a name="Other">Other resources</a></h3>
4778
4779 <p>The XML Catalog specification is relatively recent so there isn't much
4780 literature to point at:</p>
4781 <ul>
4782   <li>You can find a good rant from Norm Walsh about <a
4783     href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
4784     need for catalogs</a>, it provides a lot of context information even if
4785     I don't agree with everything presented. Norm also wrote a more recent
4786     article <a
4787     href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
4788     entities and URI resolvers</a> describing them.</li>
4789   <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
4790     catalog proposal</a> from John Cowan</li>
4791   <li>The <a href="http://www.rddl.org/">Resource Directory Description
4792     Language</a> (RDDL) another catalog system but more oriented toward
4793     providing metadata for XML namespaces.</li>
4794   <li>the page from the OASIS Technical <a
4795     href="http://www.oasis-open.org/committees/entity/">Committee on Entity
4796     Resolution</a> who maintains XML Catalog, you will find pointers to the
4797     specification update, some background and pointers to others tools
4798     providing XML Catalog support</li>
4799   <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
4800     XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
4801     directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
4802     the resources found on the system. Otherwise it will just create
4803     ~/xmlcatalog and ~/dbkxmlcatalog and doing:
4804     <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
4805     <p>should allow to process DocBook documentations without requiring
4806     network accesses for the DTD or stylesheets</p>
4807   </li>
4808   <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
4809     small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
4810     to work fine for me too</li>
4811   <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
4812     manual page</a></li>
4813 </ul>
4814
4815 <p>If you have suggestions for corrections or additions, simply contact
4816 me:</p>
4817
4818 <h2><a name="library">The parser interfaces</a></h2>
4819
4820 <p>This section is directly intended to help programmers getting bootstrapped
4821 using the XML tollkit from the C language. It is not intended to be
4822 extensive. I hope the automatically generated documents will provide the
4823 completeness required, but as a separate set of documents. The interfaces of
4824 the XML parser are by principle low level, Those interested in a higher level
4825 API should <a href="#DOM">look at DOM</a>.</p>
4826
4827 <p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
4828 separated from the <a href="html/libxml-htmlparser.html">HTML parser
4829 interfaces</a>.  Let's have a look at how the XML parser can be called:</p>
4830
4831 <h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
4832
4833 <p>Usually, the first thing to do is to read an XML input. The parser accepts
4834 documents either from in-memory strings or from files.  The functions are
4835 defined in "parser.h":</p>
4836 <dl>
4837   <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
4838     <dd><p>Parse a null-terminated string containing the document.</p>
4839     </dd>
4840 </dl>
4841 <dl>
4842   <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
4843     <dd><p>Parse an XML document contained in a (possibly compressed)
4844       file.</p>
4845     </dd>
4846 </dl>
4847
4848 <p>The parser returns a pointer to the document structure (or NULL in case of
4849 failure).</p>
4850
4851 <h3 id="Invoking1">Invoking the parser: the push method</h3>
4852
4853 <p>In order for the application to keep the control when the document is
4854 being fetched (which is common for GUI based programs) libxml2 provides a
4855 push interface, too, as of version 1.8.3. Here are the interface
4856 functions:</p>
4857 <pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
4858                                          void *user_data,
4859                                          const char *chunk,
4860                                          int size,
4861                                          const char *filename);
4862 int              xmlParseChunk          (xmlParserCtxtPtr ctxt,
4863                                          const char *chunk,
4864                                          int size,
4865                                          int terminate);</pre>
4866
4867 <p>and here is a simple example showing how to use the interface:</p>
4868 <pre>            FILE *f;
4869
4870             f = fopen(filename, "r");
4871             if (f != NULL) {
4872                 int res, size = 1024;
4873                 char chars[1024];
4874                 xmlParserCtxtPtr ctxt;
4875
4876                 res = fread(chars, 1, 4, f);
4877                 if (res &gt; 0) {
4878                     ctxt = xmlCreatePushParserCtxt(NULL, NULL,
4879                                 chars, res, filename);
4880                     while ((res = fread(chars, 1, size, f)) &gt; 0) {
4881                         xmlParseChunk(ctxt, chars, res, 0);
4882                     }
4883                     xmlParseChunk(ctxt, chars, 0, 1);
4884                     doc = ctxt-&gt;myDoc;
4885                     xmlFreeParserCtxt(ctxt);
4886                 }
4887             }</pre>
4888
4889 <p>The HTML parser embedded into libxml2 also has a push interface; the
4890 functions are just prefixed by "html" rather than "xml".</p>
4891
4892 <h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
4893
4894 <p>The tree-building interface makes the parser memory-hungry, first loading
4895 the document in memory and then building the tree itself. Reading a document
4896 without building the tree is possible using the SAX interfaces (see SAX.h and
4897 <a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
4898 Henstridge's documentation</a>). Note also that the push interface can be
4899 limited to SAX: just use the two first arguments of
4900 <code>xmlCreatePushParserCtxt()</code>.</p>
4901
4902 <h3><a name="Building">Building a tree from scratch</a></h3>
4903
4904 <p>The other way to get an XML tree in memory is by building it. Basically
4905 there is a set of functions dedicated to building new elements. (These are
4906 also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
4907 code that produces the XML document used in the previous examples:</p>
4908 <pre>    #include &lt;libxml/tree.h&gt;
4909     xmlDocPtr doc;
4910     xmlNodePtr tree, subtree;
4911
4912     doc = xmlNewDoc("1.0");
4913     doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
4914     xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
4915     xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
4916     tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
4917     subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
4918     tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
4919     subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
4920     subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
4921     subtree = xmlNewChild(tree, NULL, "image", NULL);
4922     xmlSetProp(subtree, "href", "linus.gif");</pre>
4923
4924 <p>Not really rocket science ...</p>
4925
4926 <h3><a name="Traversing">Traversing the tree</a></h3>
4927
4928 <p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
4929 code has access to the internal structure of all the elements of the tree.
4930 The names should be somewhat simple like <strong>parent</strong>,
4931 <strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
4932 <strong>properties</strong>, etc... For example, still with the previous
4933 example:</p>
4934 <pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
4935
4936 <p>points to the title element,</p>
4937 <pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
4938
4939 <p>points to the text node containing the chapter title "The Linux
4940 adventure".</p>
4941
4942 <p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
4943 present before the document root, so <code>doc-&gt;children</code> may point
4944 to an element which is not the document Root Element; a function
4945 <code>xmlDocGetRootElement()</code> was added for this purpose.</p>
4946
4947 <h3><a name="Modifying">Modifying the tree</a></h3>
4948
4949 <p>Functions are provided for reading and writing the document content. Here
4950 is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
4951 <dl>
4952   <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
4953   xmlChar *value);</code></dt>
4954     <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
4955       The value can be NULL.</p>
4956     </dd>
4957 </dl>
4958 <dl>
4959   <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
4960   *name);</code></dt>
4961     <dd><p>This function returns a pointer to new copy of the property
4962       content. Note that the user must deallocate the result.</p>
4963     </dd>
4964 </dl>
4965
4966 <p>Two functions are provided for reading and writing the text associated
4967 with elements:</p>
4968 <dl>
4969   <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
4970   *value);</code></dt>
4971     <dd><p>This function takes an "external" string and converts it to one
4972       text node or possibly to a list of entity and text nodes. All
4973       non-predefined entity references like &amp;Gnome; will be stored
4974       internally as entity nodes, hence the result of the function may not be
4975       a single node.</p>
4976     </dd>
4977 </dl>
4978 <dl>
4979   <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
4980   inLine);</code></dt>
4981     <dd><p>This function is the inverse of
4982       <code>xmlStringGetNodeList()</code>. It generates a new string
4983       containing the content of the text and entity nodes. Note the extra
4984       argument inLine. If this argument is set to 1, the function will expand
4985       entity references.  For example, instead of returning the &amp;Gnome;
4986       XML encoding in the string, it will substitute it with its value (say,
4987       "GNU Network Object Model Environment").</p>
4988     </dd>
4989 </dl>
4990
4991 <h3><a name="Saving">Saving a tree</a></h3>
4992
4993 <p>Basically 3 options are possible:</p>
4994 <dl>
4995   <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
4996   *size);</code></dt>
4997     <dd><p>Returns a buffer into which the document has been saved.</p>
4998     </dd>
4999 </dl>
5000 <dl>
5001   <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
5002     <dd><p>Dumps a document to an open file descriptor.</p>
5003     </dd>
5004 </dl>
5005 <dl>
5006   <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
5007     <dd><p>Saves the document to a file. In this case, the compression
5008       interface is triggered if it has been turned on.</p>
5009     </dd>
5010 </dl>
5011
5012 <h3><a name="Compressio">Compression</a></h3>
5013
5014 <p>The library transparently handles compression when doing file-based
5015 accesses. The level of compression on saves can be turned on either globally
5016 or individually for one file:</p>
5017 <dl>
5018   <dt><code>int  xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
5019     <dd><p>Gets the document compression ratio (0-9).</p>
5020     </dd>
5021 </dl>
5022 <dl>
5023   <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
5024     <dd><p>Sets the document compression ratio.</p>
5025     </dd>
5026 </dl>
5027 <dl>
5028   <dt><code>int  xmlGetCompressMode(void);</code></dt>
5029     <dd><p>Gets the default compression ratio.</p>
5030     </dd>
5031 </dl>
5032 <dl>
5033   <dt><code>void xmlSetCompressMode(int mode);</code></dt>
5034     <dd><p>Sets the default compression ratio.</p>
5035     </dd>
5036 </dl>
5037
5038 <h2><a name="Entities">Entities or no entities</a></h2>
5039
5040 <p>Entities in principle are similar to simple C macros. An entity defines an
5041 abbreviation for a given string that you can reuse many times throughout the
5042 content of your document. Entities are especially useful when a given string
5043 may occur frequently within a document, or to confine the change needed to a
5044 document to a restricted area in the internal subset of the document (at the
5045 beginning). Example:</p>
5046 <pre>1 &lt;?xml version="1.0"?&gt;
5047 2 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
5048 3 &lt;!ENTITY xml "Extensible Markup Language"&gt;
5049 4 ]&gt;
5050 5 &lt;EXAMPLE&gt;
5051 6    &amp;xml;
5052 7 &lt;/EXAMPLE&gt;</pre>
5053
5054 <p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
5055 its name with '&amp;' and following it by ';' without any spaces added. There
5056 are 5 predefined entities in libxml2 allowing you to escape characters with
5057 predefined meaning in some parts of the xml document content:
5058 <strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
5059 for the character '&gt;',  <strong>&amp;apos;</strong> for the character ''',
5060 <strong>&amp;quot;</strong> for the character '"', and
5061 <strong>&amp;amp;</strong> for the character '&amp;'.</p>
5062
5063 <p>One of the problems related to entities is that you may want the parser to
5064 substitute an entity's content so that you can see the replacement text in
5065 your application. Or you may prefer to keep entity references as such in the
5066 content to be able to save the document back without losing this usually
5067 precious information (if the user went through the pain of explicitly
5068 defining entities, he may have a a rather negative attitude if you blindly
5069 substitute them as saving time). The <a
5070 href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
5071 function allows you to check and change the behaviour, which is to not
5072 substitute entities by default.</p>
5073
5074 <p>Here is the DOM tree built by libxml2 for the previous document in the
5075 default case:</p>
5076 <pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
5077 DOCUMENT
5078 version=1.0
5079    ELEMENT EXAMPLE
5080      TEXT
5081      content=
5082      ENTITY_REF
5083        INTERNAL_GENERAL_ENTITY xml
5084        content=Extensible Markup Language
5085      TEXT
5086      content=</pre>
5087
5088 <p>And here is the result when substituting entities:</p>
5089 <pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
5090 DOCUMENT
5091 version=1.0
5092    ELEMENT EXAMPLE
5093      TEXT
5094      content=     Extensible Markup Language</pre>
5095
5096 <p>So, entities or no entities? Basically, it depends on your use case. I
5097 suggest that you keep the non-substituting default behaviour and avoid using
5098 entities in your XML document or data if you are not willing to handle the
5099 entity references elements in the DOM tree.</p>
5100
5101 <p>Note that at save time libxml2 enforces the conversion of the predefined
5102 entities where necessary to prevent well-formedness problems, and will also
5103 transparently replace those with chars (i.e. it will not generate entity
5104 reference elements in the DOM tree or call the reference() SAX callback when
5105 finding them in the input).</p>
5106
5107 <p><span style="background-color: #FF0000">WARNING</span>: handling entities
5108 on top of the libxml2 SAX interface is difficult!!! If you plan to use
5109 non-predefined entities in your documents, then the learning curve to handle
5110 then using the SAX API may be long. If you plan to use complex documents, I
5111 strongly suggest you consider using the DOM interface instead and let libxml
5112 deal with the complexity rather than trying to do it yourself.</p>
5113
5114 <h2><a name="Namespaces">Namespaces</a></h2>
5115
5116 <p>The libxml2 library implements <a
5117 href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
5118 recognizing namespace constructs in the input, and does namespace lookup
5119 automatically when building the DOM tree. A namespace declaration is
5120 associated with an in-memory structure and all elements or attributes within
5121 that namespace point to it. Hence testing the namespace is a simple and fast
5122 equality operation at the user level.</p>
5123
5124 <p>I suggest that people using libxml2 use a namespace, and declare it in the
5125 root element of their document as the default namespace. Then they don't need
5126 to use the prefix in the content but we will have a basis for future semantic
5127 refinement and  merging of data from different sources. This doesn't increase
5128 the size of the XML output significantly, but significantly increases its
5129 value in the long-term. Example:</p>
5130 <pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
5131    &lt;elem1&gt;...&lt;/elem1&gt;
5132    &lt;elem2&gt;...&lt;/elem2&gt;
5133 &lt;/mydoc&gt;</pre>
5134
5135 <p>The namespace value has to be an absolute URL, but the URL doesn't have to
5136 point to any existing resource on the Web. It will bind all the element and
5137 attributes with that URL. I suggest to use an URL within a domain you
5138 control, and that the URL should contain some kind of version information if
5139 possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
5140 good namespace scheme.</p>
5141
5142 <p>Then when you load a file, make sure that a namespace carrying the
5143 version-independent prefix is installed on the root element of your document,
5144 and if the version information don't match something you know, warn the user
5145 and be liberal in what you accept as the input. Also do *not* try to base
5146 namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
5147 same as &lt;bar:text&gt; in another document. What really matters is the URI
5148 associated with the element or the attribute, not the prefix string (which is
5149 just a shortcut for the full URI). In libxml, element and attributes have an
5150 <code>ns</code> field pointing to an xmlNs structure detailing the namespace
5151 prefix and its URI.</p>
5152
5153 <p>@@Interfaces@@</p>
5154 <pre>xmlNodePtr node;
5155 if(!strncmp(node-&gt;name,"mytag",5)
5156   &amp;&amp; node-&gt;ns
5157   &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
5158   ...
5159 }</pre>
5160
5161 <p>Usually people object to using namespaces together with validity checking.
5162 I will try to make sure that using namespaces won't break validity checking,
5163 so even if you plan to use or currently are using validation I strongly
5164 suggest adding namespaces to your document. A default namespace scheme
5165 <code>xmlns="http://...."</code> should not break validity even on less
5166 flexible parsers. Using namespaces to mix and differentiate content coming
5167 from multiple DTDs will certainly break current validation schemes. To check
5168 such documents one needs to use schema-validation, which is supported in
5169 libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
5170 href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
5171
5172 <h2><a name="Upgrading">Upgrading 1.x code</a></h2>
5173
5174 <p>Incompatible changes:</p>
5175
5176 <p>Version 2 of libxml2 is the first version introducing serious backward
5177 incompatible changes. The main goals were:</p>
5178 <ul>
5179   <li>a general cleanup. A number of mistakes inherited from the very early
5180     versions couldn't be changed due to compatibility constraints. Example
5181     the "childs" element in the nodes.</li>
5182   <li>Uniformization of the various nodes, at least for their header and link
5183     parts (doc, parent, children, prev, next), the goal is a simpler
5184     programming model and simplifying the task of the DOM implementors.</li>
5185   <li>better conformances to the XML specification, for example version 1.x
5186     had an heuristic to try to detect ignorable white spaces. As a result the
5187     SAX event generated were ignorableWhitespace() while the spec requires
5188     character() in that case. This also mean that a number of DOM node
5189     containing blank text may populate the DOM tree which were not present
5190     before.</li>
5191 </ul>
5192
5193 <h3>How to fix libxml-1.x code:</h3>
5194
5195 <p>So client code of libxml designed to run with version 1.x may have to be
5196 changed to compile against version 2.x of libxml. Here is a list of changes
5197 that I have collected, they may not be sufficient, so in case you find other
5198 change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
5199 mail</a>:</p>
5200 <ol>
5201   <li>The package name have changed from libxml to libxml2, the library name
5202     is now -lxml2 . There is a new xml2-config script which should be used to
5203     select the right parameters libxml2</li>
5204   <li>Node <strong>childs</strong> field has been renamed
5205     <strong>children</strong> so s/childs/children/g should be  applied
5206     (probability of having "childs" anywhere else is close to 0+</li>
5207   <li>The document don't have anymore a <strong>root</strong> element it has
5208     been replaced by <strong>children</strong> and usually you will get a
5209     list of element here. For example a Dtd element for the internal subset
5210     and it's declaration may be found in that list, as well as processing
5211     instructions or comments found before or after the document root element.
5212     Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
5213     a document. Alternatively if you are sure to not reference DTDs nor have
5214     PIs or comments before or after the root element
5215     s/-&gt;root/-&gt;children/g will probably do it.</li>
5216   <li>The white space issue, this one is more complex, unless special case of
5217     validating parsing, the line breaks and spaces usually used for indenting
5218     and formatting the document content becomes significant. So they are
5219     reported by SAX and if your using the DOM tree, corresponding nodes are
5220     generated. Too approach can be taken:
5221     <ol>
5222       <li>lazy one, use the compatibility call
5223         <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
5224         relying on a special (and possibly broken) set of heuristics of
5225         libxml to detect ignorable blanks. Don't complain if it breaks or
5226         make your application not 100% clean w.r.t. to it's input.</li>
5227       <li>the Right Way: change you code to accept possibly insignificant
5228         blanks characters, or have your tree populated with weird blank text
5229         nodes. You can spot them using the commodity function
5230         <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
5231         nodes.</li>
5232     </ol>
5233     <p>Note also that with the new default the output functions don't add any
5234     extra indentation when saving a tree in order to be able to round trip
5235     (read and save) without inflating the document with extra formatting
5236     chars.</p>
5237   </li>
5238   <li>The include path has changed to $prefix/libxml/ and the includes
5239     themselves uses this new prefix in includes instructions... If you are
5240     using (as expected) the
5241     <pre>xml2-config --cflags</pre>
5242     <p>output to generate you compile commands this will probably work out of
5243     the box</p>
5244   </li>
5245   <li>xmlDetectCharEncoding takes an extra argument indicating the length in
5246     byte of the head of the document available for character detection.</li>
5247 </ol>
5248
5249 <h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
5250
5251 <p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
5252 to allow smooth upgrade of existing libxml v1code while retaining
5253 compatibility. They offers the following:</p>
5254 <ol>
5255   <li>similar include naming, one should use
5256     <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
5257   <li>similar identifiers defined via macros for the child and root fields:
5258     respectively <strong>xmlChildrenNode</strong> and
5259     <strong>xmlRootNode</strong></li>
5260   <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
5261     inserted once in the client code</li>
5262 </ol>
5263
5264 <p>So the roadmap to upgrade your existing libxml applications is the
5265 following:</p>
5266 <ol>
5267   <li>install the  libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
5268   <li>find all occurrences where the xmlDoc <strong>root</strong> field is
5269     used and change it to <strong>xmlRootNode</strong></li>
5270   <li>similarly find all occurrences where the xmlNode
5271     <strong>childs</strong> field is used and change it to
5272     <strong>xmlChildrenNode</strong></li>
5273   <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
5274     <strong>main()</strong> or in the library init entry point</li>
5275   <li>Recompile, check compatibility, it should still work</li>
5276   <li>Change your configure script to look first for xml2-config and fall
5277     back using xml-config . Use the --cflags and --libs output of the command
5278     as the Include and Linking parameters needed to use libxml.</li>
5279   <li>install libxml2-2.3.x and  libxml2-devel-2.3.x (libxml-1.8.y and
5280     libxml-devel-1.8.y can be kept simultaneously)</li>
5281   <li>remove your config.cache, relaunch your configuration mechanism, and
5282     recompile, if steps 2 and 3 were done right it should compile as-is</li>
5283   <li>Test that your application is still running correctly, if not this may
5284     be due to extra empty nodes due to formating spaces being kept in libxml2
5285     contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
5286     code before calling the parser (next to
5287     <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
5288 </ol>
5289
5290 <p>Following those steps should work. It worked for some of my own code.</p>
5291
5292 <p>Let me put some emphasis on the fact that there is far more changes from
5293 libxml 1.x to 2.x than the ones you may have to patch for. The overall code
5294 has been considerably cleaned up and the conformance to the XML specification
5295 has been drastically improved too. Don't take those changes as an excuse to
5296 not upgrade, it may cost a lot on the long term ...</p>
5297
5298 <h2><a name="Thread">Thread safety</a></h2>
5299
5300 <p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
5301 threads can safely work in parallel parsing different documents. There is
5302 however a couple of things to do to ensure it:</p>
5303 <ul>
5304   <li>configure the library accordingly using the --with-threads options</li>
5305   <li>call xmlInitParser() in the "main" thread before using any of the
5306     libxml2 API (except possibly selecting a different memory allocator)</li>
5307 </ul>
5308
5309 <p>Note that the thread safety cannot be ensured for multiple threads sharing
5310 the same document, the locking must be done at the application level, libxml
5311 exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
5312 The parts of the library checked for thread safety are:</p>
5313 <ul>
5314   <li>concurrent loading</li>
5315   <li>file access resolution</li>
5316   <li>catalog access</li>
5317   <li>catalog building</li>
5318   <li>entities lookup/accesses</li>
5319   <li>validation</li>
5320   <li>global variables per-thread override</li>
5321   <li>memory handling</li>
5322 </ul>
5323
5324 <p>XPath has been tested for threaded usage on non-modified document
5325    for example when using libxslt, but make 100% sure the documents
5326    are accessed read-only !</p>
5327
5328 <h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
5329
5330 <p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
5331 Object Model</em>; this is an API for accessing XML or HTML structured
5332 documents. Native support for DOM in Gnome is on the way (module gnome-dom),
5333 and will be based on gnome-xml. This will be a far cleaner interface to
5334 manipulate XML files within Gnome since it won't expose the internal
5335 structure.</p>
5336
5337 <p>The current DOM implementation on top of libxml2 is the <a
5338 href="http://svn.gnome.org/viewvc/gdome2/trunk/">gdome2 Gnome module</a>, this
5339 is a full DOM interface, thanks to Paolo Casarini, check the <a
5340 href="http://gdome2.cs.unibo.it/">Gdome2 homepage</a> for more
5341 information.</p>
5342
5343 <h2><a name="Example"></a><a name="real">A real example</a></h2>
5344
5345 <p>Here is a real size example, where the actual content of the application
5346 data is not kept in the DOM tree but uses internal structures. It is based on
5347 a proposal to keep a database of jobs related to Gnome, with an XML based
5348 storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
5349 base</a>:</p>
5350 <pre>&lt;?xml version="1.0"?&gt;
5351 &lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
5352   &lt;gjob:Jobs&gt;
5353
5354     &lt;gjob:Job&gt;
5355       &lt;gjob:Project ID="3"/&gt;
5356       &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
5357       &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
5358
5359       &lt;gjob:Update&gt;
5360         &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
5361         &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
5362         &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
5363       &lt;/gjob:Update&gt;
5364
5365       &lt;gjob:Developers&gt;
5366         &lt;gjob:Developer&gt;
5367         &lt;/gjob:Developer&gt;
5368       &lt;/gjob:Developers&gt;
5369
5370       &lt;gjob:Contact&gt;
5371         &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
5372         &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
5373         &lt;gjob:Company&gt;
5374         &lt;/gjob:Company&gt;
5375         &lt;gjob:Organisation&gt;
5376         &lt;/gjob:Organisation&gt;
5377         &lt;gjob:Webpage&gt;
5378         &lt;/gjob:Webpage&gt;
5379         &lt;gjob:Snailmail&gt;
5380         &lt;/gjob:Snailmail&gt;
5381         &lt;gjob:Phone&gt;
5382         &lt;/gjob:Phone&gt;
5383       &lt;/gjob:Contact&gt;
5384
5385       &lt;gjob:Requirements&gt;
5386       The program should be released as free software, under the GPL.
5387       &lt;/gjob:Requirements&gt;
5388
5389       &lt;gjob:Skills&gt;
5390       &lt;/gjob:Skills&gt;
5391
5392       &lt;gjob:Details&gt;
5393       A GNOME based system that will allow a superuser to configure
5394       compressed and uncompressed files and/or file systems to be backed
5395       up with a supported media in the system.  This should be able to
5396       perform via find commands generating a list of files that are passed
5397       to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
5398       or via operations performed on the filesystem itself. Email
5399       notification and GUI status display very important.
5400       &lt;/gjob:Details&gt;
5401
5402     &lt;/gjob:Job&gt;
5403
5404   &lt;/gjob:Jobs&gt;
5405 &lt;/gjob:Helping&gt;</pre>
5406
5407 <p>While loading the XML file into an internal DOM tree is a matter of
5408 calling only a couple of functions, browsing the tree to gather the data and
5409 generate the internal structures is harder, and more error prone.</p>
5410
5411 <p>The suggested principle is to be tolerant with respect to the input
5412 structure. For example, the ordering of the attributes is not significant,
5413 the XML specification is clear about it. It's also usually a good idea not to
5414 depend on the order of the children of a given node, unless it really makes
5415 things harder. Here is some code to parse the information for a person:</p>
5416 <pre>/*
5417  * A person record
5418  */
5419 typedef struct person {
5420     char *name;
5421     char *email;
5422     char *company;
5423     char *organisation;
5424     char *smail;
5425     char *webPage;
5426     char *phone;
5427 } person, *personPtr;
5428
5429 /*
5430  * And the code needed to parse it
5431  */
5432 personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5433     personPtr ret = NULL;
5434
5435 DEBUG("parsePerson\n");
5436     /*
5437      * allocate the struct
5438      */
5439     ret = (personPtr) malloc(sizeof(person));
5440     if (ret == NULL) {
5441         fprintf(stderr,"out of memory\n");
5442         return(NULL);
5443     }
5444     memset(ret, 0, sizeof(person));
5445
5446     /* We don't care what the top level element name is */
5447     cur = cur-&gt;xmlChildrenNode;
5448     while (cur != NULL) {
5449         if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
5450             ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5451         if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
5452             ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5453         cur = cur-&gt;next;
5454     }
5455
5456     return(ret);
5457 }</pre>
5458
5459 <p>Here are a couple of things to notice:</p>
5460 <ul>
5461   <li>Usually a recursive parsing style is the more convenient one: XML data
5462     is by nature subject to repetitive constructs and usually exhibits highly
5463     structured patterns.</li>
5464   <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
5465     i.e. the pointer to the global XML document and the namespace reserved to
5466     the application. Document wide information are needed for example to
5467     decode entities and it's a good coding practice to define a namespace for
5468     your application set of data and test that the element and attributes
5469     you're analyzing actually pertains to your application space. This is
5470     done by a simple equality test (cur-&gt;ns == ns).</li>
5471   <li>To retrieve text and attributes value, you can use the function
5472     <em>xmlNodeListGetString</em> to gather all the text and entity reference
5473     nodes generated by the DOM output and produce an single text string.</li>
5474 </ul>
5475
5476 <p>Here is another piece of code used to parse another level of the
5477 structure:</p>
5478 <pre>#include &lt;libxml/tree.h&gt;
5479 /*
5480  * a Description for a Job
5481  */
5482 typedef struct job {
5483     char *projectID;
5484     char *application;
5485     char *category;
5486     personPtr contact;
5487     int nbDevelopers;
5488     personPtr developers[100]; /* using dynamic alloc is left as an exercise */
5489 } job, *jobPtr;
5490
5491 /*
5492  * And the code needed to parse it
5493  */
5494 jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5495     jobPtr ret = NULL;
5496
5497 DEBUG("parseJob\n");
5498     /*
5499      * allocate the struct
5500      */
5501     ret = (jobPtr) malloc(sizeof(job));
5502     if (ret == NULL) {
5503         fprintf(stderr,"out of memory\n");
5504         return(NULL);
5505     }
5506     memset(ret, 0, sizeof(job));
5507
5508     /* We don't care what the top level element name is */
5509     cur = cur-&gt;xmlChildrenNode;
5510     while (cur != NULL) {
5511
5512         if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
5513             ret-&gt;projectID = xmlGetProp(cur, "ID");
5514             if (ret-&gt;projectID == NULL) {
5515                 fprintf(stderr, "Project has no ID\n");
5516             }
5517         }
5518         if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
5519             ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5520         if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
5521             ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5522         if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
5523             ret-&gt;contact = parsePerson(doc, ns, cur);
5524         cur = cur-&gt;next;
5525     }
5526
5527     return(ret);
5528 }</pre>
5529
5530 <p>Once you are used to it, writing this kind of code is quite simple, but
5531 boring. Ultimately, it could be possible to write stubbers taking either C
5532 data structure definitions, a set of XML examples or an XML DTD and produce
5533 the code needed to import and export the content between C data and XML
5534 storage. This is left as an exercise to the reader :-)</p>
5535
5536 <p>Feel free to use <a href="example/gjobread.c">the code for the full C
5537 parsing example</a> as a template, it is also available with Makefile in the
5538 Gnome SVN base under libxml2/example</p>
5539
5540 <h2><a name="Contributi">Contributions</a></h2>
5541 <ul>
5542   <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
5543     patches, Gary Pennington worked on the validation API, threading support
5544     and Solaris port.</li>
5545   <li>John Fleck helps maintaining the documentation and man pages.</li>
5546   <li><a href="mailto:igor@zlatkovic.com">Igor  Zlatkovic</a> is now the
5547     maintainer of the Windows port, <a
5548     href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
5549     binaries</a></li>
5550   <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
5551     <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
5552   <li><a
5553     href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
5554     Sergeant</a> developed <a
5555     href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
5556     libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
5557     application server</a></li>
5558   <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
5559     href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
5560     href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
5561     documentation</li>
5562   <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
5563     href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
5564   <li>there is a module for <a
5565     href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
5566     in OpenNSD/AOLServer</a></li>
5567   <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
5568     first version of libxml/libxslt <a
5569     href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
5570   <li>Petr Kozelka provides <a
5571     href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
5572     libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
5573   <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
5574     <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
5575     Digital Signature</a> <a
5576     href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
5577   <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and
5578     contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
5579     bindings for libxml2 and libxslt</a>, as well as <a
5580     href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
5581     xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
5582     a GUI for xsltproc.</li>
5583 </ul>
5584
5585 <p></p>
5586 </body>
5587 </html>