diff options
Diffstat (limited to 'doc/xml.html')
| -rw-r--r-- | doc/xml.html | 5046 |
1 files changed, 2530 insertions, 2516 deletions
diff --git a/doc/xml.html b/doc/xml.html index 72a0a9c..a25b8d0 100644 --- a/doc/xml.html +++ b/doc/xml.html @@ -3,42 +3,42 @@ <html> <head> <title>The XML C parser and toolkit of Gnome</title> - <meta name="GENERATOR" content="amaya 8.8.5, see http://www.w3.org/Amaya/"> - <meta http-equiv="content-type" content="text/html"> + <meta name="GENERATOR" content="amaya 8.5, see http://www.w3.org/Amaya/"> + <meta http-equiv="Content-Type" content="text/html"> </head> <body bgcolor="#ffffff"> <h1 align="center">The XML C parser and toolkit of Gnome</h1> -<h1>Note: this is the flat content of the <a -href="index.html">website</a></h1> +<h1>Note: this is the flat content of the <a href="index.html">web +site</a></h1> <h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1> <p></p> <p -style="text-align: right; font-style: italic; font-size: 10pt">"Programmingwithlibxml2 -is like the thrilling embrace of an exotic stranger." <a -href="http://diveintomark.org/archives/2004/02/18/libxml2">MarkPilgrim</a></p> - -<p>Libxml2 is the XML C parser and toolkit developed for the Gnomeproject(but -usable outside of the Gnome platform), it is free softwareavailableunder the -<a -href="http://www.opensource.org/licenses/mit-license.html">MITLicense</a>.XML -itself is a metalanguage to design markup languages, i.e.text languagewhere -semantic and structure are added to the content usingextra -"markup"information enclosed between angle brackets. HTML is the -mostwell-knownmarkup language. Though the library is written in C <a -href="python.html">avariety of language bindings</a>make it available inother -environments.</p> - -<p>Libxml2 is known to be very portable, the library should build -andworkwithout serious troubles on a variety of systems (Linux, -Unix,Windows,CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, ...)</p> - -<p>Libxml2 implements a number of existing standards related -tomarkuplanguages:</p> +style="text-align: right; font-style: italic; font-size: 10pt">"Programming +with libxml2 is like the thrilling embrace of an exotic stranger." <a +href="http://diveintomark.org/archives/2004/02/18/libxml2">Mark +Pilgrim</a></p> + +<p>Libxml2 is the XML C parser and toolkit developed for the Gnome project +(but usable outside of the Gnome platform), it is free software available +under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT +License</a>. XML itself is a metalanguage to design markup languages, i.e. +text language where semantic and structure are added to the content using +extra "markup" information enclosed between angle brackets. HTML is the most +well-known markup language. Though the library is written in C <a +href="python.html">a variety of language bindings</a> make it available in +other environments.</p> + +<p>Libxml2 is known to be very portable, the library should build and work +without serious troubles on a variety of systems (Linux, Unix, Windows, +CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, ...)</p> + +<p>Libxml2 implements a number of existing standards related to markup +languages:</p> <ul> <li>the XML standard: <a href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li> @@ -46,9 +46,8 @@ tomarkuplanguages:</p> href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li> <li>XML Base: <a href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li> - <li><a - href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC2396</a>:Uniform - Resource Identifiers <a + <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a> : + Uniform Resource Identifiers <a href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li> <li>XML Path Language (XPath) 1.0: <a href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li> @@ -59,67 +58,63 @@ tomarkuplanguages:</p> <li>XML Inclusions (XInclude) Version 1.0: <a href="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</a></li> <li>ISO-8859-x encodings, as well as <a - href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a>[UTF-8]and<a - href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>[UTF-16]Unicode - encodings, and more if using iconv support</li> + href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8] + and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a> + [UTF-16] Unicode encodings, and more if using iconv support</li> <li>part of SGML Open Technical Resolution TR9401:1997</li> <li>XML Catalogs Working Draft 06 August 2001: <a 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> <li>Canonical XML Version 1.0: <a - href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a>andthe - Exclusive XML Canonicalization CR draft <a + href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a> + and the Exclusive XML Canonicalization CR draft <a href="http://www.w3.org/TR/xml-exc-c14n">http://www.w3.org/TR/xml-exc-c14n</a></li> <li>Relax NG, ISO/IEC 19757-2:2003, <a 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> <li>W3C XML Schemas Part 2: Datatypes <a - href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC - 02May2001</a></li> - <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a>Working - Draft7April 2004</li> + href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC 02 May + 2001</a></li> + <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a> Working Draft 7 + April 2004</li> </ul> -<p>In most cases libxml2 tries to implement the specifications in -arelativelystrictly compliant way. As of release 2.4.16, libxml2 passed -all1800+ testsfrom the <a -href="http://www.oasis-open.org/committees/xml-conformance/">OASIS -XMLTestsSuite</a>.</p> +<p>In most cases libxml2 tries to implement the specifications in a +relatively strictly compliant way. As of release 2.4.16, libxml2 passed all +1800+ tests from the <a +href="http://www.oasis-open.org/committees/xml-conformance/">OASIS XML Tests +Suite</a>.</p> -<p>To some extent libxml2 provides support for the -followingadditionalspecifications but doesn't claim to implement them -completely:</p> +<p>To some extent libxml2 provides support for the following additional +specifications but doesn't claim to implement them completely:</p> <ul> <li>Document Object Model (DOM) <a - href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>thedocument - model, but it doesn't implement the API itself, gdome2 doesthison top of - libxml2</li> - <li><a - href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC959</a>:libxml2 - implements a basic FTP client code</li> - <li><a - href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC1945</a>:HTTP/1.0, - again a basic HTTP client code</li> - <li>SAX: a SAX2 like interface and a minimal SAX1 - implementationcompatiblewith early expat versions</li> + href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a> + the document model, but it doesn't implement the API itself, gdome2 does + this on top of libxml2</li> + <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a> : + libxml2 implements a basic FTP client code</li> + <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a> : + HTTP/1.0, again a basic HTTP client code</li> + <li>SAX: a SAX2 like interface and a minimal SAX1 implementation compatible + with early expat versions</li> </ul> <p>A partial implementation of <a -href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas -Part1:Structure</a>is being worked on but it would be far too early to -makeanyconformance statement about it at the moment.</p> +href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas Part +1: Structure</a> is being worked on but it would be far too early to make any +conformance statement about it at the moment.</p> <p>Separate documents:</p> <ul> - <li><a href="http://xmlsoft.org/XSLT/">the libxslt - page</a>providinganimplementation of XSLT 1.0 and common extensions like - EXSLTforlibxml2</li> - <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 - page</a>:a standard DOM2 implementation for libxml2</li> - <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec - page</a>:animplementation of <a - href="http://www.w3.org/TR/xmldsig-core/">W3CXMLDigital Signature</a>for - libxml2</li> - <li>also check the related links section below for more related - andactiveprojects.</li> + <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a> providing an + implementation of XSLT 1.0 and common extensions like EXSLT for + libxml2</li> + <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page</a> + : a standard DOM2 implementation for libxml2</li> + <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec page</a>: an + implementation of <a href="http://www.w3.org/TR/xmldsig-core/">W3C XML + Digital Signature</a> for libxml2</li> + <li>also check the related links section below for more related and active + projects.</li> </ul> <!----------------<p>Results of the <a href="http://xmlbench.sourceforge.net/results/benchmark/index.html">xmlbench @@ -134,42 +129,43 @@ alt="benchmark results for Expat Xerces libxml2 Oracle and Sun toolkits"></p> <h2><a name="Introducti">Introduction</a></h2> <p>This document describes libxml, the <a -href="http://www.w3.org/XML/">XML</a>C parser and toolkit developed for the<a -href="http://www.gnome.org/">Gnome</a>project. <a -href="http://www.w3.org/XML/">XML is a standard</a>for -buildingtag-basedstructured documents/data.</p> +href="http://www.w3.org/XML/">XML</a> C parser and toolkit developed for the +<a href="http://www.gnome.org/">Gnome</a> project. <a +href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based +structured documents/data.</p> <p>Here are some key points about libxml:</p> <ul> - <li>Libxml2 exports Push (progressive) and Pull (blocking) - typeparserinterfaces for both XML and HTML.</li> - <li>Libxml2 can do DTD validation at parse time, using a - parseddocumentinstance, or with an arbitrary DTD.</li> + <li>Libxml2 exports Push (progressive) and Pull (blocking) type parser + interfaces for both XML and HTML.</li> + <li>Libxml2 can do DTD validation at parse time, using a parsed document + instance, or with an arbitrary DTD.</li> <li>Libxml2 includes complete <a href="http://www.w3.org/TR/xpath">XPath</a>, <a - href="http://www.w3.org/TR/xptr">XPointer</a>and <a - href="http://www.w3.org/TR/xinclude">XInclude</a>implementations.</li> - <li>It is written in plain C, making as few assumptions as - possible,andsticking closely to ANSI C/POSIX for easy embedding. - WorksonLinux/Unix/Windows, ported to a number of other platforms.</li> - <li>Basic support for HTTP and FTP client allowing applications - tofetchremote resources.</li> + href="http://www.w3.org/TR/xptr">XPointer</a> and <a + href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li> + <li>It is written in plain C, making as few assumptions as possible, and + sticking closely to ANSI C/POSIX for easy embedding. Works on + Linux/Unix/Windows, ported to a number of other platforms.</li> + <li>Basic support for HTTP and FTP client allowing applications to fetch + remote resources.</li> <li>The design is modular, most of the extensions can be compiled out.</li> <li>The internal document representation is as close as possible to the <a - href="http://www.w3.org/DOM/">DOM</a>interfaces.</li> + href="http://www.w3.org/DOM/">DOM</a> interfaces.</li> <li>Libxml2 also has a <a - href="http://www.megginson.com/SAX/index.html">SAX like - interface</a>;theinterface is designed to be compatible with <a + href="http://www.megginson.com/SAX/index.html">SAX like interface</a>; + the interface is designed to be compatible with <a href="http://www.jclark.com/xml/expat.html">Expat</a>.</li> <li>This library is released under the <a - href="http://www.opensource.org/licenses/mit-license.html">MITLicense</a>.See - the Copyright file in the distribution for the precisewording.</li> + href="http://www.opensource.org/licenses/mit-license.html">MIT + License</a>. See the Copyright file in the distribution for the precise + wording.</li> </ul> -<p>Warning: unless you are forced to because your application links -withaGnome-1.X library requiring it, <strong><span -style="background-color: #FF0000">Do Not Use -libxml1</span></strong>,uselibxml2</p> +<p>Warning: unless you are forced to because your application links with a +Gnome-1.X library requiring it, <strong><span +style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use +libxml2</p> <h2><a name="FAQ">FAQ</a></h2> @@ -185,63 +181,67 @@ libxml1</span></strong>,uselibxml2</p> <ol> <li><em>Licensing Terms for libxml</em> <p>libxml2 is released under the <a - href="http://www.opensource.org/licenses/mit-license.html">MITLicense</a>;see - the file Copyright in the distribution for the precisewording</p> + href="http://www.opensource.org/licenses/mit-license.html">MIT + License</a>; see the file Copyright in the distribution for the precise + wording</p> </li> <li><em>Can I embed libxml2 in a proprietary application ?</em> - <p>Yes. The MIT License allows you to keep proprietary the changesyoumade - to libxml, but it would be graceful to send-back bug fixesandimprovements - as patches for possible incorporation in themaindevelopment tree.</p> + <p>Yes. The MIT License allows you to keep proprietary the changes you + made to libxml, but it would be graceful to send-back bug fixes and + improvements as patches for possible incorporation in the main + development tree.</p> </li> </ol> <h3><a name="Installati">Installation</a></h3> <ol> - <li><strong><span style="background-color: #FF0000">Do - NotUselibxml1</span></strong>, use libxml2</li> - <li><em>Where can I get libxml</em>? + <li><strong><span style="background-color: #FF0000">Do Not Use + libxml1</span></strong>, use libxml2</li> + <li><em>Where can I get libxml</em> ? <p>The original distribution comes from <a - href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>or <a + href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p> - <p>Most Linux and BSD distributions include libxml, this is - probablythesafer way for end-users to use libxml.</p> + <p>Most Linux and BSD distributions include libxml, this is probably the + safer way for end-users to use libxml.</p> <p>David Doolin provides precompiled Windows versions at <a href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/ ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p> </li> <li><em>I see libxml and libxml2 releases, which one should I install ?</em> <ul> - <li>If you are not constrained by backward compatibility - issueswithexisting applications, install libxml2 only</li> - <li>If you are not doing development, you can safely - installboth.Usually the packages <a - href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a>and <a - href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a>arecompatible(this - is not the case for development packages).</li> - <li>If you are a developer and your system provides - separatepackagingfor shared libraries and the development components, - it ispossibleto install libxml and libxml2, and also <a - href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>and<a - href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>toofor - libxml2 >= 2.3.0</li> - <li>If you are developing a new application, please - developagainstlibxml2(-devel)</li> + <li>If you are not constrained by backward compatibility issues with + existing applications, install libxml2 only</li> + <li>If you are not doing development, you can safely install both. + Usually the packages <a + href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a + href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are + compatible (this is not the case for development packages).</li> + <li>If you are a developer and your system provides separate packaging + for shared libraries and the development components, it is possible + to install libxml and libxml2, and also <a + href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a> + and <a + href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a> + too for libxml2 >= 2.3.0</li> + <li>If you are developing a new application, please develop against + libxml2(-devel)</li> </ul> </li> <li><em>I can't install the libxml package, it conflicts with libxml0</em> - <p>You probably have an old libxml0 package used to provide - thesharedlibrary for libxml.so.0, you can probably safely remove it. - Thelibxmlpackages provided on <a - href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>providelibxml.so.0</p> + <p>You probably have an old libxml0 package used to provide the shared + library for libxml.so.0, you can probably safely remove it. The libxml + packages provided on <a + href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> provide + libxml.so.0</p> </li> - <li><em>I can't install the libxml(2) RPM package due - tofaileddependencies</em> - <p>The most generic solution is to re-fetch the latest src.rpm - ,andrebuild it locally with</p> + <li><em>I can't install the libxml(2) RPM package due to failed + dependencies</em> + <p>The most generic solution is to re-fetch the latest src.rpm , and + rebuild it locally with</p> <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p> - <p>If everything goes well it will generate two binary rpm - packages(oneproviding the shared libs and xmllint, and the other one, - the-develpackage, providing includes, static libraries and scripts needed - tobuildapplications with libxml(2)) that you can install locally.</p> + <p>If everything goes well it will generate two binary rpm packages (one + providing the shared libs and xmllint, and the other one, the -devel + package, providing includes, static libraries and scripts needed to build + applications with libxml(2)) that you can install locally.</p> </li> </ol> @@ -256,121 +256,123 @@ libxml1</span></strong>,uselibxml2</p> <p><code>./configure [possible options]</code></p> <p><code>make</code></p> <p><code>make install</code></p> - <p>At that point you may have to rerun ldconfig or a similar - utilitytoupdate your list of installed shared libs.</p> + <p>At that point you may have to rerun ldconfig or a similar utility to + update your list of installed shared libs.</p> </li> <li><em>What other libraries are needed to compile/install libxml2 ?</em> - <p>Libxml2 does not require any other library, the normal C ANSIAPIshould - be sufficient (please report any violation to this rule youmayfind).</p> - <p>However if found at configuration time libxml2 will detect and - usethefollowing libs:</p> + <p>Libxml2 does not require any other library, the normal C ANSI API + should be sufficient (please report any violation to this rule you may + find).</p> + <p>However if found at configuration time libxml2 will detect and use the + following libs:</p> <ul> - <li><a - href="http://www.info-zip.org/pub/infozip/zlib/">libz</a>:ahighly - portable and available widely compression library.</li> - <li>iconv: a powerful character encoding conversion library. - Itisincluded by default in recent glibc libraries, so it doesn't - needtobe installed specifically on Linux. It now seems a <a - href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">partofthe - official UNIX</a>specification. Here is one <a - href="http://www.gnu.org/software/libiconv/">implementation - ofthelibrary</a>which source can be found <a + <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a + highly portable and available widely compression library.</li> + <li>iconv: a powerful character encoding conversion library. It is + included by default in recent glibc libraries, so it doesn't need to + be installed specifically on Linux. It now seems a <a + href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part + of the official UNIX</a> specification. Here is one <a + href="http://www.gnu.org/software/libiconv/">implementation of the + library</a> which source can be found <a href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li> </ul> </li> <li><em>Make check fails on some platforms</em> - <p>Sometimes the regression tests' results don't completely matchthevalue - produced by the parser, and the makefile uses diff to printthedelta. On - some platforms the diff return breaks the compilationprocess;if the diff - is small this is probably not a serious problem.</p> - <p>Sometimes (especially on Solaris) make checks fail due tolimitationsin - make. Try using GNU-make instead.</p> + <p>Sometimes the regression tests' results don't completely match the + value produced by the parser, and the makefile uses diff to print the + delta. On some platforms the diff return breaks the compilation process; + if the diff is small this is probably not a serious problem.</p> + <p>Sometimes (especially on Solaris) make checks fail due to limitations + in make. Try using GNU-make instead.</p> </li> <li><em>I use the CVS version and there is no configure script</em> - <p>The configure script (and other Makefiles) are generated. - Usetheautogen.sh script to regenerate the configure script - andMakefiles,like:</p> + <p>The configure script (and other Makefiles) are generated. Use the + autogen.sh script to regenerate the configure script and Makefiles, + like:</p> <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p> </li> <li><em>I have troubles when running make tests with gcc-3.0</em> - <p>It seems the initial release of gcc-3.0 has a problem withtheoptimizer - which miscompiles the URI module. Please useanothercompiler.</p> + <p>It seems the initial release of gcc-3.0 has a problem with the + optimizer which miscompiles the URI module. Please use another + compiler.</p> </li> </ol> -<h3><a name="Developer">Developer</a>corner</h3> +<h3><a name="Developer">Developer</a> corner</h3> <ol> <li><em>Troubles compiling or linking programs using libxml2</em> - <p>Usually the problem comes from the fact that the compiler - doesn'tgetthe right compilation or linking flags. There is a small - shellscript<code>xml2-config</code>which is installed as part of - libxml2usualinstall process which provides those flags. Use</p> + <p>Usually the problem comes from the fact that the compiler doesn't get + the right compilation or linking flags. There is a small shell script + <code>xml2-config</code> which is installed as part of libxml2 usual + install process which provides those flags. Use</p> <p><code>xml2-config --cflags</code></p> <p>to get the compilation flags and</p> <p><code>xml2-config --libs</code></p> - <p>to get the linker flags. Usually this is done directly fromtheMakefile - as:</p> + <p>to get the linker flags. Usually this is done directly from the + Makefile as:</p> <p><code>CFLAGS=`xml2-config --cflags`</code></p> <p><code>LIBS=`xml2-config --libs`</code></p> </li> - <li><em>I want to install my own copy of libxml2 in my home - directoryandlink my programs against it, but it doesn't work</em> - <p>There are many different ways to accomplish this. Here is one waytodo - this under Linux. Suppose your home directory - is<code>/home/user.</code>Then:</p> + <li><em>I want to install my own copy of libxml2 in my home directory and + link my programs against it, but it doesn't work</em> + <p>There are many different ways to accomplish this. Here is one way to + do this under Linux. Suppose your home directory is <code>/home/user. + </code>Then:</p> <ul> <li>Create a subdirectory, let's call it <code>myxml</code></li> <li>unpack the libxml2 distribution into that subdirectory</li> - <li>chdir into the unpacked - distribution(<code>/home/user/myxml/libxml2</code>)</li> - <li>configure the library using the - "<code>--prefix</code>"switch,specifying an installation - subdirectoryin<code>/home/user/myxml</code>, e.g. - <p><code>./configure - --prefix/home/user/myxml/xmlinst</code>{otherconfiguration - options}</p> + <li>chdir into the unpacked distribution + (<code>/home/user/myxml/libxml2 </code>)</li> + <li>configure the library using the "<code>--prefix</code>" switch, + specifying an installation subdirectory in + <code>/home/user/myxml</code>, e.g. + <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other + configuration options}</p> </li> - <li>now run <code>make</code>followed by <code>make install</code></li> - <li>At this point, the installation subdirectory contains - thecomplete"private" include files, library files and binary - programfiles (e.g.xmllint), located in - <p><code>/home/user/myxml/xmlinst/lib,/home/user/myxml/xmlinst/include</code>and - <code>/home/user/myxml/xmlinst/bin</code></p> + <li>now run <code>make</code> followed by <code>make install</code></li> + <li>At this point, the installation subdirectory contains the complete + "private" include files, library files and binary program files (e.g. + xmllint), located in + <p><code>/home/user/myxml/xmlinst/lib, + /home/user/myxml/xmlinst/include </code> and <code> + /home/user/myxml/xmlinst/bin</code></p> respectively.</li> - <li>In order to use this "private" library, you should first add - ittothe beginning of your default PATH (so that your own - privateprogramfiles such as xmllint will be used instead of the - normalsystemones). To do this, the Bash command would be + <li>In order to use this "private" library, you should first add it to + the beginning of your default PATH (so that your own private program + files such as xmllint will be used instead of the normal system + ones). To do this, the Bash command would be <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p> </li> - <li>Now suppose you have a program <code>test1.c</code>that - youwouldlike to compile with your "private" library. Simply compile - itusingthe command + <li>Now suppose you have a program <code>test1.c</code> that you would + like to compile with your "private" library. Simply compile it using + the command <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p> - Note that, because your PATH has been set - with<code>/home/user/myxml/xmlinst/bin</code>at the beginning, - thexml2-configprogram which you just installed will be used instead - ofthe systemdefault one, and this will <em>automatically</em>get - thecorrectlibraries linked with your program.</li> + Note that, because your PATH has been set with <code> + /home/user/myxml/xmlinst/bin</code> at the beginning, the xml2-config + program which you just installed will be used instead of the system + default one, and this will <em>automatically</em> get the correct + libraries linked with your program.</li> </ul> </li> <p></p> <li><em>xmlDocDump() generates output on one line.</em> - <p>Libxml2 will not <strong>invent</strong>spaces in the content - ofadocument since <strong>all spaces in the content of a - documentaresignificant</strong>. If you build a tree from the API - andwantindentation:</p> + <p>Libxml2 will not <strong>invent</strong> spaces in the content of a + document since <strong>all spaces in the content of a document are + significant</strong>. If you build a tree from the API and want + indentation:</p> <ol> <li>the correct way is to generate those yourself too.</li> - <li>the dangerous way is to ask libxml2 to add those blanks - toyourcontent <strong>modifying the content of your document - intheprocess</strong>. The result may not be what you expect. - Thereis<strong>NO</strong>way to guarantee that such a - modificationwon'taffect other parts of the content of your document. - See <a - href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault()</a>and<a - href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile()</a></li> + <li>the dangerous way is to ask libxml2 to add those blanks to your + content <strong>modifying the content of your document in the + process</strong>. The result may not be what you expect. There is + <strong>NO</strong> way to guarantee that such a modification won't + affect other parts of the content of your document. See <a + href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault + ()</a> and <a + href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile + ()</a></li> </ol> </li> <li>Extra nodes in the document: @@ -380,10 +382,10 @@ libxml1</span></strong>,uselibxml2</p> <NODE CommFlag="0"/> <NODE CommFlag="1"/> </PLAN></pre> - <p><em>after parsing it with - thefunctionpxmlDoc=xmlParseFile(...);</em></p> - <p><em>I want to the get the content of the first node (node - withtheCommFlag="0")</em></p> + <p><em>after parsing it with the function + pxmlDoc=xmlParseFile(...);</em></p> + <p><em>I want to the get the content of the first node (node with the + CommFlag="0")</em></p> <p><em>so I did it as following;</em></p> <pre>xmlNodePtr pnode; pnode=pxmlDoc->children->children;</pre> @@ -391,70 +393,70 @@ pnode=pxmlDoc->children->children;</pre> <pre>pnode=pxmlDoc->children->children->next;</pre> <p><em>then it works. Can someone explain it to me.</em></p> <p></p> - <p>In XML all characters in the content of the document - aresignificant<strong>including blanks and formatting - linebreaks</strong>.</p> - <p>The extra nodes you are wondering about are just that, text - nodeswiththe formatting spaces which are part of the document but that - peopletendto forget. There is a function <a - href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault()</a>toremove - those at parse time, but that's an heuristic, and itsuse should belimited - to cases where you are certain there is nomixed-content in - thedocument.</p> + <p>In XML all characters in the content of the document are significant + <strong>including blanks and formatting line breaks</strong>.</p> + <p>The extra nodes you are wondering about are just that, text nodes with + the formatting spaces which are part of the document but that people tend + to forget. There is a function <a + href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault + ()</a> to remove those at parse time, but that's an heuristic, and its + use should be limited to cases where you are certain there is no + mixed-content in the document.</p> </li> - <li><em>I get compilation errors of existing code like - whenaccessing<strong>root</strong>or <strong>child - fields</strong>ofnodes.</em> - <p>You are compiling code developed for libxml version 1 and - usingalibxml2 development environment. Either switch back to libxml v1 - develoreven better fix the code to compile with libxml2 (or both) by <a + <li><em>I get compilation errors of existing code like when accessing + <strong>root</strong> or <strong>child fields</strong> of nodes.</em> + <p>You are compiling code developed for libxml version 1 and using a + libxml2 development environment. Either switch back to libxml v1 devel or + even better fix the code to compile with libxml2 (or both) by <a href="upgrade.html">following the instructions</a>.</p> </li> - <li><em>I get compilation errors about - nonexisting<strong>xmlRootNode</strong>or<strong>xmlChildrenNode</strong>fields.</em> + <li><em>I get compilation errors about non existing + <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong> + fields.</em> <p>The source code you are using has been <a - href="upgrade.html">upgraded</a>to be able to compile with both - libxmlandlibxml2, but you need to install a more recent - version:libxml(-devel)>= 1.8.8 or libxml2(-devel) >= 2.1.0</p> + href="upgrade.html">upgraded</a> to be able to compile with both libxml + and libxml2, but you need to install a more recent version: + libxml(-devel) >= 1.8.8 or libxml2(-devel) >= 2.1.0</p> </li> <li><em>XPath implementation looks seriously broken</em> - <p>XPath implementation prior to 2.3.0 was really incomplete. Upgrade - toarecent version, there are no known bugs in the current version.</p> + <p>XPath implementation prior to 2.3.0 was really incomplete. Upgrade to + a recent version, there are no known bugs in the current version.</p> </li> <li><em>The example provided in the web page does not compile.</em> - <p>It's hard to maintain the documentation in sync with - thecode<grin/> ...</p> - <p>Check the previous points 1/ and 2/ raised before, and - pleasesendpatches.</p> + <p>It's hard to maintain the documentation in sync with the code + <grin/> ...</p> + <p>Check the previous points 1/ and 2/ raised before, and please send + patches.</p> </li> - <li><em>Where can I get more examples and information than provided - ontheweb page?</em> - <p>Ideally a libxml2 book would be nice. I have no such plan ... - Butyoucan:</p> + <li><em>Where can I get more examples and information than provided on the + web page?</em> + <p>Ideally a libxml2 book would be nice. I have no such plan ... But you + can:</p> <ul> - <li>check more deeply the <a - href="html/libxml-lib.html">existinggenerated doc</a></li> - <li>have a look at <a href="examples/index.html">the - setofexamples</a>.</li> - <li>look for examples of use for libxml2 function using the - Gnomecode.For example the following will query the full Gnome CVS - base fortheuse of the <strong>xmlAddChild()</strong>function: + <li>check more deeply the <a href="html/libxml-lib.html">existing + generated doc</a></li> + <li>have a look at <a href="examples/index.html">the set of + examples</a>.</li> + <li>look for examples of use for libxml2 function using the Gnome code. + For example the following will query the full Gnome CVS base for the + use of the <strong>xmlAddChild()</strong> function: <p><a href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p> - <p>This may be slow, a large hardware donation to the - gnomeprojectcould cure this :-)</p> + <p>This may be slow, a large hardware donation to the gnome project + could cure this :-)</p> </li> <li><a - href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gnome-xml">Browsethelibxml2 - source</a>, I try to write code as clean and documentedaspossible, so - looking at it may be helpful. In particular the codeofxmllint.c and - of the various testXXX.c test programs shouldprovidegood examples of - how to do things with the library.</li> + href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gnome-xml">Browse + the libxml2 source</a> , I try to write code as clean and documented + as possible, so looking at it may be helpful. In particular the code + of xmllint.c and of the various testXXX.c test programs should + provide good examples of how to do things with the library.</li> </ul> </li> <li>What about C++ ? - <p>libxml2 is written in pure C in order to allow easy reuse on anumberof - platforms, including embedded systems. I don't intend to converttoC++.</p> + <p>libxml2 is written in pure C in order to allow easy reuse on a number + of platforms, including embedded systems. I don't intend to convert to + C++.</p> <p>There is however a C++ wrapper which may fulfill your needs:</p> <ul> <li>by Ari Johnson <ari@btigate.com>: @@ -472,11 +474,12 @@ pnode=pxmlDoc->children->children;</pre> </ul> </li> <li>How to validate a document a posteriori ? - <p>It is possible to validate documents which had not been - validatedatinitial parsing time or documents which have been built - fromscratchusing the API. Use the <a - href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>function.It - is also possible to simply add a DTD to an existingdocument:</p> + <p>It is possible to validate documents which had not been validated at + initial parsing time or documents which have been built from scratch + using the API. Use the <a + href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a> + function. It is also possible to simply add a DTD to an existing + document:</p> <pre>xmlDocPtr doc; /* your existing document */ xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */ @@ -488,10 +491,10 @@ xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */ </pre> </li> <li>So what is this funky "xmlChar" used all the time? - <p>It is a null terminated sequence of utf-8 characters. And - onlyutf-8!You need to convert strings encoded in different ways to - utf-8beforepassing them to the API. This can be accomplished with the - iconvlibraryfor instance.</p> + <p>It is a null terminated sequence of utf-8 characters. And only utf-8! + You need to convert strings encoded in different ways to utf-8 before + passing them to the API. This can be accomplished with the iconv library + for instance.</p> </li> <li>etc ...</li> </ol> @@ -502,193 +505,190 @@ xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */ <p>There are several on-line resources related to using libxml:</p> <ol> - <li>Use the <a href="search.php">search engine</a>to lookupinformation.</li> + <li>Use the <a href="search.php">search engine</a> to look up + information.</li> <li>Check the <a href="FAQ.html">FAQ.</a></li> - <li>Check the <a - href="http://xmlsoft.org/html/libxml-lib.html">extensivedocumentation</a>automaticallyextracted - from code comments.</li> - <li>Look at the documentation about <a - href="encoding.html">libxmlinternationalization support</a>.</li> - <li>This page provides a global overview and <a - href="example.html">someexamples</a>on how to use libxml.</li> + <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive + documentation</a> automatically extracted from code comments.</li> + <li>Look at the documentation about <a href="encoding.html">libxml + internationalization support</a>.</li> + <li>This page provides a global overview and <a href="example.html">some + examples</a> on how to use libxml.</li> <li><a href="examples/index.html">Code examples</a></li> - <li>John Fleck's libxml2 tutorial: <a - href="tutorial/index.html">html</a>or<a - href="tutorial/xmltutorial.pdf">pdf</a>.</li> + <li>John Fleck's libxml2 tutorial: <a href="tutorial/index.html">html</a> + or <a href="tutorial/xmltutorial.pdf">pdf</a>.</li> <li>If you need to parse large files, check the <a - href="xmlreader.html">xmlReader</a>API tutorial</li> - <li><a href="mailto:james@daa.com.au">James Henstridge</a>wrote <a - href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">somenicedocumentation</a>explaining - how to use the libxml SAX interface.</li> + href="xmlreader.html">xmlReader</a> API tutorial</li> + <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a + href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice + documentation</a> explaining how to use the libxml SAX interface.</li> <li>George Lebl wrote <a - href="http://www-106.ibm.com/developerworks/library/l-gnome3/">anarticlefor - IBM developerWorks</a>about using libxml.</li> - <li>Check <a - href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">theTODOfile</a>.</li> - <li>Read the <a href="upgrade.html">1.x to 2.x upgrade - path</a>description.If you are starting a new project using libxml you - shouldreally use the2.x version.</li> + href="http://www-106.ibm.com/developerworks/library/l-gnome3/">an article + for IBM developerWorks</a> about using libxml.</li> + <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO + file</a>.</li> + <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a> + description. If you are starting a new project using libxml you should + really use the 2.x version.</li> <li>And don't forget to look at the <a href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li> </ol> <h2><a name="Reporting">Reporting bugs and getting help</a></h2> -<p>Well, bugs or missing features are always possible, and I will make -apointof fixing them in a timely fashion. The best way to report a bug is -touse the<a -href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnomebugtracking -database</a>(make sure to use the "libxml2" module name). Ilook atreports -there regularly and it's good to have a reminder when a bugis stillopen. Be -sure to specify that the bug is for the package libxml2.</p> +<p>Well, bugs or missing features are always possible, and I will make a +point of fixing them in a timely fashion. The best way to report a bug is to +use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome +bug tracking database</a> (make sure to use the "libxml2" module name). I +look at reports there regularly and it's good to have a reminder when a bug +is still open. Be sure to specify that the bug is for the package libxml2.</p> -<p>For small problems you can try to get help on IRC, the #xml -channelonirc.gnome.org (port 6667) usually have a few person subscribed which -mayhelp(but there is no garantee and if a real issue is raised it should go -onthemailing-list for archival).</p> +<p>For small problems you can try to get help on IRC, the #xml channel on +irc.gnome.org (port 6667) usually have a few person subscribed which may help +(but there is no garantee and if a real issue is raised it should go on the +mailing-list for archival).</p> <p>There is also a mailing-list <a -href="mailto:xml@gnome.org">xml@gnome.org</a>for libxml, with an <a -href="http://mail.gnome.org/archives/xml/">on-line archive</a>(<a -href="http://xmlsoft.org/messages">old</a>). To subscribe to this -list,pleasevisit the <a -href="http://mail.gnome.org/mailman/listinfo/xml">associatedWeb</a>page -andfollow the instructions. <strong>Do not send code, I won'tdebug -it</strong>(but patches are really appreciated!).</p> - -<p>Please note that with the current amount of virus and SPAM, sending -mailtothe list without being subscribed won't work. There is *far too -manybounces*(in the order of a thousand a day !) I cannot approve them -manuallyanymore.If your mail to the list bounced waiting for administrator -approval,it isLOST ! Repost it and fix the problem triggering the error. Also -pleasenotethat <span style="color: #FF0000; background-color: #FFFFFF">emails -withalegal warning asking to not copy or redistribute freely the -informationstheycontain</span>are <strong>NOT</strong>acceptable for the -mailing-list,suchmail will as much as possible be discarded automatically, -and are lesslikelyto be answered if they made it to the list, <strong>DO -NOT</strong>post tothe list from an email address where such legal -requirements areautomaticallyadded, get private paying support if you can't -shareinformations.</p> - -<p>Check the following <strong><span -style="color: #FF0000">beforeposting</span></strong>:</p> -<ul> - <li>Read the <a href="FAQ.html">FAQ</a>and <a - href="search.php">usethesearch engine</a>to get information related to - your problem.</li> - <li>Make sure you are <a href="ftp://xmlsoft.org/libxml2/">using - arecentversion</a>, and that the problem still shows up in a - recentversion.</li> - <li>Check the <a - href="http://mail.gnome.org/archives/xml/">listarchives</a>to see if - theproblem was reported already. In this casethere is probably a - fixavailable, similarly check the <a - href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registeredopenbugs</a>.</li> - <li>Make sure you can reproduce the bug with xmllint or one of - thetestprograms found in source in the distribution.</li> - <li>Please send the command showing the error as well as the input - (asanattachment)</li> +href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a +href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a +href="http://xmlsoft.org/messages">old</a>). To subscribe to this list, +please visit the <a +href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and +follow the instructions. <strong>Do not send code, I won't debug it</strong> +(but patches are really appreciated!).</p> + +<p>Please note that with the current amount of virus and SPAM, sending mail +to the list without being subscribed won't work. There is *far too many +bounces* (in the order of a thousand a day !) I cannot approve them manually +anymore. If your mail to the list bounced waiting for administrator approval, +it is LOST ! Repost it and fix the problem triggering the error. Also please +note that <span style="color: #FF0000; background-color: #FFFFFF">emails with +a legal warning asking to not copy or redistribute freely the informations +they contain</span> are <strong>NOT</strong> acceptable for the mailing-list, +such mail will as much as possible be discarded automatically, and are less +likely to be answered if they made it to the list, <strong>DO NOT</strong> +post to the list from an email address where such legal requirements are +automatically added, get private paying support if you can't share +informations.</p> + +<p>Check the following <strong><span style="color: #FF0000">before +posting</span></strong>:</p> +<ul> + <li>Read the <a href="FAQ.html">FAQ</a> and <a href="search.php">use the + search engine</a> to get information related to your problem.</li> + <li>Make sure you are <a href="ftp://xmlsoft.org/libxml2/">using a recent + version</a>, and that the problem still shows up in a recent version.</li> + <li>Check the <a href="http://mail.gnome.org/archives/xml/">list + archives</a> to see if the problem was reported already. In this case + there is probably a fix available, similarly check the <a + href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registered + open bugs</a>.</li> + <li>Make sure you can reproduce the bug with xmllint or one of the test + programs found in source in the distribution.</li> + <li>Please send the command showing the error as well as the input (as an + attachment)</li> </ul> <p>Then send the bug with associated information to reproduce it to the <a -href="mailto:xml@gnome.org">xml@gnome.org</a>list; if it's -reallylibxmlrelated I will approve it. Please do not send mail to me -directly, itmakesthings really hard to track and in some cases I am not the -best persontoanswer a given question, ask on the list.</p> +href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml +related I will approve it. Please do not send mail to me directly, it makes +things really hard to track and in some cases I am not the best person to +answer a given question, ask on the list.</p> <p>To <span style="color: #E50000">be really clear about support</span>:</p> <ul> - <li>Support or help <span style="color: #E50000">requests MUST be senttothe - list or on bugzilla</span>in case of problems, so that theQuestionand - Answers can be shared publicly. Failing to do so carries - theimplicitmessage "I want free support but I don't want to share - thebenefits withothers" and is not welcome. I will automatically - Carbon-Copythexml@gnome.org mailing list for any technical reply made - about libxml2orlibxslt.</li> - <li>There is <span style="color: #E50000">no garantee of - support</span>,ifyour question remains unanswered after a week, repost - it, making sureyougave all the detail needed and the information - requested.</li> - <li>Failing to provide information as requested or double checking - firstforprior feedback also carries the implicit message "the time of - thelibrarymaintainers is less valuable than my time" and might not - bewelcome.</li> -</ul> - -<p>Of course, bugs reported with a suggested patch for fixing -themwillprobably be processed faster than those without.</p> + <li>Support or help <span style="color: #E50000">requests MUST be sent to + the list or on bugzilla</span> in case of problems, so that the Question + and Answers can be shared publicly. Failing to do so carries the implicit + message "I want free support but I don't want to share the benefits with + others" and is not welcome. I will automatically Carbon-Copy the + xml@gnome.org mailing list for any technical reply made about libxml2 or + libxslt.</li> + <li>There is <span style="color: #E50000">no garantee of support</span>, if + your question remains unanswered after a week, repost it, making sure you + gave all the detail needed and the information requested.</li> + <li>Failing to provide information as requested or double checking first + for prior feedback also carries the implicit message "the time of the + library maintainers is less valuable than my time" and might not be + welcome.</li> +</ul> + +<p>Of course, bugs reported with a suggested patch for fixing them will +probably be processed faster than those without.</p> <p>If you're looking for help, a quick look at <a -href="http://mail.gnome.org/archives/xml/">the list -archive</a>mayactuallyprovide the answer. I usually send source samples when -answeringlibxml2usage questions. The <a -href="http://xmlsoft.org/html/book1.html">auto-generateddocumentation</a>isnot -as polished as I would like (i need to learn moreabout DocBook), butit's a -good starting point.</p> +href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually +provide the answer. I usually send source samples when answering libxml2 +usage questions. The <a +href="http://xmlsoft.org/html/book1.html">auto-generated documentation</a> is +not as polished as I would like (i need to learn more about DocBook), but +it's a good starting point.</p> <h2><a name="help">How to help</a></h2> -<p>You can help the project in various ways, the best thing to do first -istosubscribe to the mailing-list as explained before, check the <a +<p>You can help the project in various ways, the best thing to do first is to +subscribe to the mailing-list as explained before, check the <a href="http://mail.gnome.org/archives/xml/">archives </a>and the <a -href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnomebugdatabase</a>:</p> +href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug +database</a>:</p> <ol> <li>Provide patches when you find problems.</li> - <li>Provide the diffs when you port libxml2 to a new platform. They - maynotbe integrated in all cases but help pinpointing - portabilityproblemsand</li> - <li>Provide documentation fixes (either as patches to the code commentsoras - HTML diffs).</li> - <li>Provide new documentations pieces (translations, examples, etc...).</li> + <li>Provide the diffs when you port libxml2 to a new platform. They may not + be integrated in all cases but help pinpointing portability problems + and</li> + <li>Provide documentation fixes (either as patches to the code comments or + as HTML diffs).</li> + <li>Provide new documentations pieces (translations, examples, etc + ...).</li> <li>Check the TODO file and try to close one of the items.</li> - <li>Take one of the points raised in the archive or the bug - databaseandprovide a fix. <a href="mailto:daniel@veillard.com">Get in - touch withme</a>before to avoid synchronization problems and check that - thesuggestedfix will fit in nicely :-)</li> + <li>Take one of the points raised in the archive or the bug database and + provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me + </a>before to avoid synchronization problems and check that the suggested + fix will fit in nicely :-)</li> </ol> <h2><a name="Downloads">Downloads</a></h2> <p>The latest versions of libxml2 can be found on the <a -href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>server ( <a +href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> server ( <a href="http://xmlsoft.org/sources/">HTTP</a>, <a -href="ftp://xmlsoft.org/libxml2/">FTP</a>and rsync are available), there -isalsomirrors (<a -href="ftp://ftp.planetmirror.com/pub/xmlsoft/">Australia</a>(<a +href="ftp://xmlsoft.org/libxml2/">FTP</a> and rsync are available), there is also +mirrors (<a href="ftp://ftp.planetmirror.com/pub/xmlsoft/">Australia</a>( <a href="http://xmlsoft.planetmirror.com/">Web</a>), <a href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a -href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a>as <a -href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">source -archive</a>,Antonin Sprinzl also provide <a -href="ftp://gd.tuwien.ac.at/pub/libxml/">amirror in Austria</a>. (NOTE -thatyou need both the <a -href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a>and <a -href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>packagesinstalled -to compile applications using libxml.)</p> +href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> as <a +href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">source archive</a> +, Antonin Sprinzl also provide <a href="ftp://gd.tuwien.ac.at/pub/libxml/">a +mirror in Austria</a>. (NOTE that you need both the <a +href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a +href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a> +packages installed to compile applications using libxml.)</p> <p>You can find all the history of libxml(2) and libxslt releases in the <a -href="http://xmlsoft.org/sources/old/">old</a>directory. -TheprecompiledWindows binaries made by Igor Zlatovic are available in the <a -href="http://xmlsoft.org/sources/win32/">win32</a>directory.</p> +href="http://xmlsoft.org/sources/old/">old</a> directory. The precompiled +Windows binaries made by Igor Zlatovic are available in the <a +href="http://xmlsoft.org/sources/win32/">win32</a> directory.</p> <p>Binary ports:</p> <ul> <li>Red Hat RPMs for i386 are available directly on <a - href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM - willcompile onany architecture supported by Red Hat.</li> - <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a>is - nowthemaintainer of the Windows port, <a - href="http://www.zlatkovic.com/projects/libxml/index.html">heprovidesbinaries</a>.</li> + href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM will compile on + any architecture supported by Red Hat.</li> + <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the + maintainer of the Windows port, <a + href="http://www.zlatkovic.com/projects/libxml/index.html">he provides + binaries</a>.</li> <li>Blastwave provides <a - href="http://www.blastwave.org/packages.php/libxml2">Solarisbinaries</a>.</li> - <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a>provides <a - href="http://www.explain.com.au/oss/libxml2xslt.html">Mac - OsXbinaries</a>.</li> + href="http://www.blastwave.org/packages.php/libxml2">Solaris + binaries</a>.</li> + <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> provides <a + href="http://www.explain.com.au/oss/libxml2xslt.html">Mac Os X + binaries</a>.</li> <li>The HP-UX porting center provides <a href="http://hpux.connect.org.uk/hppd/hpux/Gnome/">HP-UX binaries</a></li> <li>Bull provides precompiled <a - href="http://gnome.bullfreeware.com/new_index.html">RPMs forAIX</a>aspatr - of their GNOME packages</li> + href="http://gnome.bullfreeware.com/new_index.html">RPMs for AIX</a> as + patr of their GNOME packages</li> </ul> <p>If you know other supported binary ports, please <a @@ -704,37 +704,89 @@ href="http://veillard.com/">contact me</a>.</p> <p><a name="Contribs">Contributions:</a></p> -<p>I do accept external contributions, especially if compiling -onanotherplatform, get in touch with the list to upload the package, -wrappersforvarious languages have been provided, and can be found in the <a +<p>I do accept external contributions, especially if compiling on another +platform, get in touch with the list to upload the package, wrappers for +various languages have been provided, and can be found in the <a href="python.html">bindings section</a></p> <p>Libxml2 is also available from CVS:</p> <ul> - <li><p>The <a - href="http://cvs.gnome.org/viewcvs/libxml2/">GnomeCVSbase</a>. Check the - <a href="http://developer.gnome.org/tools/cvs.html">Gnome CVS - Tools</a>page;the CVS module is <b>libxml2</b>.</p> + <li><p>The <a href="http://cvs.gnome.org/viewcvs/libxml2/">Gnome CVS + base</a>. Check the <a + href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> + page; the CVS module is <b>libxml2</b>.</p> </li> - <li>The <strong>libxslt</strong>module is also present there</li> + <li>The <strong>libxslt</strong> module is also present there</li> </ul> <h2><a name="News">Releases</a></h2> -<p>Items not finished and worked on, get in touch with the list if you -wanttohelp those</p> +<p>Items not finished and worked on, get in touch with the list if you want +to help those</p> <ul> <li>More testing on RelaxNG</li> - <li>Finishing up <a - href="http://www.w3.org/TR/xmlschema-1/">XMLSchemas</a></li> + <li>Finishing up <a href="http://www.w3.org/TR/xmlschema-1/">XML + Schemas</a></li> </ul> -<p>The <a href="ChangeLog.html">change log</a>describes the recents -commitstothe <a href="http://cvs.gnome.org/viewcvs/libxml2/">CVS</a>code -base.</p> +<p>The <a href="ChangeLog.html">change log</a> describes the recents commits +to the <a href="http://cvs.gnome.org/viewcvs/libxml2/">CVS</a> code base.</p> <p>There is the list of public releases:</p> +<h3>2.6.27: Oct 25 2006</h3> +<ul> + <li>Portability fixes: file names on windows (Roland Schwingel, + Emelyanov Alexey), windows compile fixup (Rob Richards), + AIX iconv() is apparently case sensitive</li> + <li>improvements: Python XPath types mapping (Nic Ferrier), XPath optimization + (Kasimier), add xmlXPathCompiledEvalToBoolean (Kasimier), Python node + equality and comparison (Andreas Pakulat), xmlXPathCollectAndTest + improvememt (Kasimier), expose if library was compiled with zlib + support (Andrew Nosenko), cache for xmlSchemaIDCMatcher structs + (Kasimier), xmlTextConcat should work with comments and PIs (Rob + Richards), export htmlNewParserCtxt needed by Michael Day, refactoring + of catalog entity loaders (Michael Day), add XPointer support to + python bindings (Ross Reedstrom, Brian West and Stefan Anca), + try to sort out most file path to URI conversions and xmlPathToUri, + add --html --memory case to xmllint</li> + <li>building fix: fix --with-minimum (Felipe Contreras), VMS fix, + const'ification of HTML parser structures (Matthias Clasen), + portability fix (Emelyanov Alexey), wget autodetection (Peter + Breitenlohner), remove the build path recorded in the python + shared module, separate library flags for shared and static builds + (Mikhail Zabaluev), fix --with-minimum --with-sax1 builds, fix + --with-minimum --with-schemas builds</li> + <li>bug fix: xmlGetNodePath fix (Kasimier), xmlDOMWrapAdoptNode and + attribute (Kasimier), crash when using the recover mode, + xmlXPathEvalExpr problem (Kasimier), xmlXPathCompExprAdd bug (Kasimier), + missing destry in xmlFreeRMutex (Andrew Nosenko), XML Schemas fixes + (Kasimier), warning on entities processing, XHTML script and style + serialization (Kasimier), python generator for long types, bug in + xmlSchemaClearValidCtxt (Bertrand Fritsch), xmlSchemaXPathEvaluate + allocation bug (Marton Illes), error message end of line (Rob Richards), + fix attribute serialization in writer (Rob Richards), PHP4 DTD validation + crasher, parser safety patch (Ben Darnell), _private context propagation + when parsing entities (with Michael Day), fix entities behaviour when + using SAX, URI to file path fix (Mikhail Zabaluev), disapearing validity + context, arg error in SAX callback (Mike Hommey), fix mixed-content + autodetect when using --noblanks, fix xmlIOParseDTD error handling, + fix bug in xmlSplitQName on special Names, fix Relax-NG element content + validation bug, fix xmlReconciliateNs bug, fix potential attribute + XML parsing bug, fix line/column accounting in XML parser, chunking bug + in the HTML parser on script, try to detect obviously buggy HTML + meta encoding indications, bugs with encoding BOM and xmlSaveDoc, + HTML entities in attributes parsing, HTML minimized attribute values, + htmlReadDoc and htmlReadIO were broken, error handling bug in + xmlXPathEvalExpression (Olaf Walkowiak), fix a problem in + htmlCtxtUseOptions, xmlNewInputFromFile could leak (Marius Konitzer), + bug on misformed SSD regexps (Christopher Boumenot) + </li> + <li>documentation: warning about XML_PARSE_COMPACT (Kasimier Buchcik), + fix xmlXPathCastToString documentation, improve man pages for + xmllitn and xmlcatalog (Daniel Leidert), fixed comments of a few + functions</li> +</ul> <h3>2.6.26: Jun 6 2006</h3> <ul> <li>portability fixes: Python detection (Joseph Sacco), compilation @@ -755,450 +807,442 @@ base.</p> <h3>2.6.24: Apr 28 2006</h3> <ul> - <li>Portability fixes: configure on Windows, testapi compile - onwindows(Kasimier Buchcik, venkat naidu), Borland C++ 6 compile - (EricZurcher),HP-UX compiler workaround (Rick Jones), xml2-config - bugfix,gcc-4.1cleanups, Python detection scheme (Joseph Sacco), UTF-8 - file pathsonWindows (Roland Schwingel).</li> - <li>Improvements: xmlDOMWrapReconcileNamespaces - xmlDOMWrapCloneNode(KasimierBuchcik), XML catalog debugging (Rick Jones), - update to Unicode4.01.</li> - <li>Bug fixes: xmlParseChunk() problem in 2.6.23, - xmlParseInNodeContext()onHTML docs, URI behaviour on Windows (Rob - Richards), comment streamingbug,xmlParseComment (with William Brack), - regexp bug fixes (DV &YouriGolovanov), xmlGetNodePath on text/CDATA - (Kasimier),one Relax-NGinterleave bug, xmllint --path and --valid,XSD - bugfixes (Kasimier),remove debugleft in Python bindings (Nic Ferrier), - xmlCatalogAdd bug(Martin Cole),xmlSetProp fixes (Rob Richards), HTML - IDness (RobRichards), a largenumber of cleanups and small fixes based on - Coverityreports, bugin character ranges, Unicode tables const (Aivars - Kalvans),schemasfix (Stefan Kost), xmlRelaxNGParse - errordeallocation,xmlSchemaAddSchemaDoc error deallocation, error - handling onunallowedcode point, ixmllint --nonet to never reach the net - (GaryCoady),line break in writer after end PI (Jason Viers).</li> + <li>Portability fixes: configure on Windows, testapi compile on windows + (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher), + HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1 + cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on + Windows (Roland Schwingel). + </li> + <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier + Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li> + <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext() + on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming + bug, xmlParseComment (with William Brack), regexp bug fixes (DV & + Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier), + one Relax-NG interleave bug, xmllint --path and --valid, + XSD bugfixes (Kasimier), remove debug + left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole), + xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large + number of cleanups and small fixes based on Coverity reports, bug + in character ranges, Unicode tables const (Aivars Kalvans), schemas + fix (Stefan Kost), xmlRelaxNGParse error deallocation, + xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed + code point, ixmllint --nonet to never reach the net (Gary Coady), + line break in writer after end PI (Jason Viers). </li> <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li> <li>New features: Relax NG structure error handlers.</li> </ul> <h3>2.6.23: Jan 5 2006</h3> <ul> - <li>portability fixes: Windows (Rob Richards), getaddrinfo on - Windows(KoljaNowak, Rob Richards), icc warnings (Kjartan - Maraas),--with-minimumcompilation fixes (William Brack), error case - handling fixon Solaris(Albert Chin), don't use 'list' as parameter name - reported bySamuel DiazGarcia, more old Unices portability fixes (Albert - Chin),MinGW compilation(Mark Junker), HP-UX compiler warnings - (RickJones),</li> - <li>code cleanup: xmlReportError (Adrian Mouat), removexmlBufferClose(Geert - Jansen), unreachable code (Oleksandr Kononenko),refactoringparsing code - (Bjorn Reese)</li> - <li>bug fixes: xmlBuildRelativeURI and empty path - (WilliamBrack),combinatory explosion and performances in regexp code, - leakinxmlTextReaderReadString(), xmlStringLenDecodeEntities - problem(MassimoMorara), Identity Constraints bugs and a segfault - (KasimierBuchcik),XPath pattern based evaluation bugs (DV - &Kasimier),xmlSchemaContentModelDump() memory leak (Kasimier), - potentialleak inxmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() - misuseofvsnprintf (William Brack), XHTML serialization fix (Rob - Richards),CRLFsplit problem (William), issues with non-namespaced - attributesinxmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() - (RobRichards),HTML parsing of script, Python must not output to stdout - (NicFerrier),exclusive C14N namespace visibility (Aleksey Sanin), - XSDdataypetotalDigits bug (Kasimier Buchcik), error handling when writing - toanxmlBuffer (Rob Richards), runtest schemas error not - reported(HisashiFujinaka), signed/unsigned problem in date/time code - (AlbertChin), fixXSI driven XSD validation (Kasimier), parsing of - xs:decimal(Kasimier),fix DTD writer output (Rob Richards), leak - inxmlTextReaderReadInnerXml(Gary Coady), regexp bug affecting - schemas(Kasimier), configuration ofruntime debugging - (Kasimier),xmlNodeBufGetContent bug on entity refs(Oleksandr - Kononenko),xmlRegExecPushString2 bug (Sreeni Nair),compilation and build - fixes(Michael Day), removed dependancies onxmlSchemaValidError - (Kasimier), bugwith <xml:foo/>, more XPathpattern based evaluation - fixes(Kasimier)</li> - <li>improvements: XSD Schemas redefinitions/restrictions - (KasimierBuchcik),node copy checks and fix for attribute (Rob Richards), - countedtransitionbug in regexps, ctxt->standalone = -2 to indicate - nostandaloneattribute was found, add - xmlSchemaSetParserStructuredErrors()(KasimierBuchcik), add - xmlTextReaderSchemaValidateCtxt() to API(Kasimier), handlegzipped HTTP - resources (Gary Coady), addhtmlDocDumpMemoryFormat. (RobRichards),</li> - <li>documentation: typo (Michael Day), libxml man page (Albert - Chin),savefunction to XML buffer (Geert Jansen), small doc fix - (AronStansvik),</li> + <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows + (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas), + --with-minimum compilation fixes (William Brack), error case handling fix + on Solaris (Albert Chin), don't use 'list' as parameter name reported by + Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin), + MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick + Jones),</li> + <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose + (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring + parsing code (Bjorn Reese)</li> + <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack), + combinatory explosion and performances in regexp code, leak in + xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo + Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik), + XPath pattern based evaluation bugs (DV & Kasimier), + xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in + xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of + vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF + split problem (William), issues with non-namespaced attributes in + xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards), + HTML parsing of script, Python must not output to stdout (Nic Ferrier), + exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype + totalDigits bug (Kasimier Buchcik), error handling when writing to an + xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi + Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix + XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier), + fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml + (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of + runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs + (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair), + compilation and build fixes (Michael Day), removed dependancies on + xmlSchemaValidError (Kasimier), bug with <xml:foo/>, more XPath + pattern based evaluation fixes (Kasimier)</li> + <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier + Buchcik), node copy checks and fix for attribute (Rob Richards), counted + transition bug in regexps, ctxt->standalone = -2 to indicate no + standalone attribute was found, add xmlSchemaSetParserStructuredErrors() + (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API + (Kasimier), handle gzipped HTTP resources (Gary Coady), add + htmlDocDumpMemoryFormat. (Rob Richards),</li> + <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save + function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li> </ul> <h3>2.6.22: Sep 12 2005</h3> <ul> <li>build fixes: compile without schematron (Stéphane Bidoul)</li> - <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg - Paraschenko)i,CDATApush parser bug, xmlElemDump problem with XHTML1 - doc,XML_FEATURE_xxxclash with expat headers renamed XML_WITH_xxx, fix - someoutput formattingfor meta element (Rob Richards), script and - styleXHTML1 serialization(David Madore), Attribute derivation fixups in - XSD(Kasimier Buchcik),better IDC error reports (Kasimier Buchcik)</li> - <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob - Richards),addXML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements - preparingforderive (Kasimier Buchcik).</li> - <li>documentation: generation of gtk-doc like docs, - integrationwithdevhelp.</li> + <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i, + CDATA push parser bug, xmlElemDump problem with XHTML1 doc, + XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some + output formatting for meta element (Rob Richards), script and style + XHTML1 serialization (David Madore), Attribute derivation fixups in XSD + (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li> + <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add + XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for + derive (Kasimier Buchcik).</li> + <li>documentation: generation of gtk-doc like docs, integration with + devhelp.</li> </ul> <h3>2.6.21: Sep 4 2005</h3> <ul> - <li>build fixes: Cygwin portability fixes (Gerrit P. - Haase),callingconvention problems on Windows (Marcus Boerger), cleanups - based onLinus'sparse tool, update of win32/configure.js (Rob Richards), - removewarningson Windows(Marcus Boerger), compilation without SAX1, - detectionof thePython binary, use $GCC inestad of $CC = 'gcc' (Andrew - W.Nosenko),compilation/link with threads and old gcc, compile problem - byC370 onZ/OS,</li> - <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML - UTF-8bug(Jiri Netolicky), XPath NaN compare bug (William - Brack),htmlParseScriptpotential bug, Schemas regexp handling of spaces, - Base64Schemascomparisons NIST passes, automata build error - xsd:all,xmlGetNodePath fornamespaced attributes (Alexander Pohoyda), - xmlSchemasforeign namespaceshandling, XML Schemas facet comparison - (KupriyanovAnatolij),xmlSchemaPSimpleTypeErr error report (Kasimier - Buchcik), xml:namespaceahndling in Schemas (Kasimier), empty model group - in Schemas(Kasimier),wilcard in Schemas (Kasimier), URI composition - (William),xs:anyType inSchemas (Kasimier), Python resolver emmitting - errormessages directly,Python xmlAttr.parent (Jakub Piotr Clapa), trying - tofix the file path/URIconversion, xmlTextReaderGetAttribute fix - (RobRichards),xmlSchemaFreeAnnot memleak (Kasimier), HTML - UTF-8serialization, streamingXPath, Schemas determinism detection - problem,XInclude bug, Schemascontext type (Dean Hill), validation fix - (DerekPoon),xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), - Schemastype fix(Kuba Nowakowski), UTF-8 parser bug, error in - encodinghandling,xmlGetLineNo fixes, bug on entities handling, entity - nameextraction inerror handling with XInclude, text nodes in HTML body - tags(Gary Coady),xml:id and IDness at the treee level fixes, XPath - streamingpatternsbugs.</li> - <li>improvements: structured interfaces for schemas and RNG - errorreports(Marcus Boerger), optimization of the char data inner - loopparsing(thanks to Behdad Esfahbod for the idea), schematron - validationthoughnot finished yet, xmlSaveOption to omit XML declaration, - keyrefmatcherror reports (Kasimier), formal expression handling code - notpluggedyet, more lax mode for the HTML parser, parser - XML_PARSE_COMPACToptionfor text nodes allocation.</li> + <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling + convention problems on Windows (Marcus Boerger), cleanups based on Linus' + sparse tool, update of win32/configure.js (Rob Richards), remove warnings + on Windows(Marcus Boerger), compilation without SAX1, detection of the + Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko), + compilation/link with threads and old gcc, compile problem by C370 on + Z/OS,</li> + <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8 + bug (Jiri Netolicky), XPath NaN compare bug (William Brack), + htmlParseScript potential bug, Schemas regexp handling of spaces, Base64 + Schemas comparisons NIST passes, automata build error xsd:all, + xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas + foreign namespaces handling, XML Schemas facet comparison (Kupriyanov + Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml: + namespace ahndling in Schemas (Kasimier), empty model group in Schemas + (Kasimier), wilcard in Schemas (Kasimier), URI composition (William), + xs:anyType in Schemas (Kasimier), Python resolver emmitting error + messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to + fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob + Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8 + serialization, streaming XPath, Schemas determinism detection problem, + XInclude bug, Schemas context type (Dean Hill), validation fix (Derek + Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas + type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling, + xmlGetLineNo fixes, bug on entities handling, entity name extraction in + error handling with XInclude, text nodes in HTML body tags (Gary Coady), + xml:id and IDness at the treee level fixes, XPath streaming patterns + bugs.</li> + <li>improvements: structured interfaces for schemas and RNG error reports + (Marcus Boerger), optimization of the char data inner loop parsing + (thanks to Behdad Esfahbod for the idea), schematron validation though + not finished yet, xmlSaveOption to omit XML declaration, keyref match + error reports (Kasimier), formal expression handling code not plugged + yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option + for text nodes allocation.</li> <li>documentation: xmllint man page had --nonet duplicated</li> </ul> <h3>2.6.20: Jul 10 2005</h3> <ul> - <li>build fixes: Windows build (Rob Richards), Mingw - compilation(IgorZlatkovic), Windows Makefile (Igor), gcc warnings - (Kasimierandandriy@google.com), use gcc weak references to pthread to - avoidthepthread dependancy on Linux, compilation problem (Steve - Nairn),compilingof subset (Morten Welinder), IPv6/ss_family compilation - (WilliamBrack),compilation when disabling parts of the library, - standalonetestdistribution.</li> - <li>bug fixes: bug in lang(), memory cleanup on errors (William - Brack),HTTPquery strings (Aron Stansvik), memory leak in DTD - (William),integeroverflow in XPath (William), nanoftp buffer size, - pattern "." apthfixup(Kasimier), leak in tree reported by Malcolm Rowe, - replaceNodepatch(Brent Hendricks), CDATA with NULL content (Mark Vakoc), - xml:basefixupon XInclude (William), pattern fixes (William), attribute - buginexclusive c14n (Aleksey Sanin), xml:space and xml:lang with - SAX2(RobRichards), namespace trouble in complex parsing (Malcolm Rowe), - XSDtypeQNames fixes (Kasimier), XPath streaming fixups (William), - RelaxNGbug(Rob Richards), Schemas for Schemas fixes (Kasimier), removal - of ID(RobRichards), a small RelaxNG leak, HTML parsing in push mode - bug(JamesBursa), failure to detect UTF-8 parsing bugs in - CDATAsections,areBlanks() heuristic failure, duplicate attributes in - DTDbug(William).</li> - <li>improvements: lot of work on Schemas by Kasimier Buchcik - bothonconformance and streaming, Schemas validation messages - (KasimierBuchcik,Matthew Burgess), namespace removal at the python - level(BrentHendricks), Update to new Schemas regression tests - fromW3C/Nist(Kasimier), xmlSchemaValidateFile() (Kasimier), - implementationofxmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml - (JamesWert),standalone test framework and programs, new DOM - importAPIsxmlDOMWrapReconcileNamespaces() - xmlDOMWrapAdoptNode()andxmlDOMWrapRemoveNode(), extension of xmllint - capabilities for SAXandSchemas regression tests, xmlStopParser() - available in pull modetoo,ienhancement to xmllint --shell namespaces - support, Windows port ofthestandalone testing tools (Kasimier - andWilliam),xmlSchemaValidateStream() xmlSchemaSAXPlug() - andxmlSchemaSAXUnplug() SAXSchemas APIs, Schemas xmlReader support.</li> + <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor + Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and + andriy@google.com), use gcc weak references to pthread to avoid the + pthread dependancy on Linux, compilation problem (Steve Nairn), compiling + of subset (Morten Welinder), IPv6/ss_family compilation (William Brack), + compilation when disabling parts of the library, standalone test + distribution.</li> + <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack), + HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer + overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup + (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch + (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup + on XInclude (William), pattern fixes (William), attribute bug in + exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob + Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type + QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug + (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob + Richards), a small RelaxNG leak, HTML parsing in push mode bug (James + Bursa), failure to detect UTF-8 parsing bugs in CDATA sections, + areBlanks() heuristic failure, duplicate attributes in DTD bug + (William).</li> + <li>improvements: lot of work on Schemas by Kasimier Buchcik both on + conformance and streaming, Schemas validation messages (Kasimier Buchcik, + Matthew Burgess), namespace removal at the python level (Brent + Hendricks), Update to new Schemas regression tests from W3C/Nist + (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of + xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert), + standalone test framework and programs, new DOM import APIs + xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and + xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and + Schemas regression tests, xmlStopParser() available in pull mode too, + ienhancement to xmllint --shell namespaces support, Windows port of the + standalone testing tools (Kasimier and William), + xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX + Schemas APIs, Schemas xmlReader support.</li> </ul> <h3>2.6.19: Apr 02 2005</h3> <ul> - <li>build fixes: drop .la from RPMs, --with-minimum build - fix(WilliamBrack), use XML_SOCKLEN_T instead of SOCKLEN_T because it - breakswith AIX5.3 compiler, fixed elfgcchack.h generation and PLT - reductioncode onLinux/ELF/gcc4</li> - <li>bug fixes: schemas type decimal fixups (William Brack), - xmmlintreturncode (Gerry Murphy), small schemas fixes (Matthew Burgess - andGUYFabrice), workaround "DAV:" namespace brokeness in c14n - (AlekseySanin),segfault in Schemas (Kasimier Buchcik), Schemas - attributevalidation(Kasimier), Prop related functions and - xmlNewNodeEatName (RobRichards),HTML serialization of name attribute on a - elements, Pythonerror handlersleaks and improvement (Brent Hendricks), - uninitializedvariable inencoding code, Relax-NG validation bug, potential - crashifgnorableWhitespace is NULL, xmlSAXParseDoc and - xmlParseDocsignatures,switched back to assuming UTF-8 in case no encoding - is givenatserialization time</li> - <li>improvements: lot of work on Schemas by Kasimier Buchcik - onfacetschecking and also mixed handling.</li> + <li>build fixes: drop .la from RPMs, --with-minimum build fix (William + Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX + 5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on + Linux/ELF/gcc4</li> + <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return + code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY + Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin), + segfault in Schemas (Kasimier Buchcik), Schemas attribute validation + (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards), + HTML serialization of name attribute on a elements, Python error handlers + leaks and improvement (Brent Hendricks), uninitialized variable in + encoding code, Relax-NG validation bug, potential crash if + gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures, + switched back to assuming UTF-8 in case no encoding is given at + serialization time</li> + <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets + checking and also mixed handling.</li> <li></li> </ul> <h3>2.6.18: Mar 13 2005</h3> <ul> - <li>build fixes: warnings (Peter Breitenlohner), - testapi.cgeneration,Bakefile support (Francesco Montorsi), Windows - compilation(Joel Reed),some gcc4 fixes, HP-UX portability fixes (Rick - Jones).</li> - <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), - pushandxmlreader stopping on non-fatal errors, thread support - fordictionnariesreference counting (Gary Coady), internal subset and - pushproblem, URLsaved in xmlCopyDoc, various schemas bug fixes - (Kasimier),Python pathsfixup (Stephane Bidoul), xmlGetNodePath and - namespaces,xmlSetNsProp fix(Mike Hommey), warning should not count as - error (WilliamBrack),xmlCreatePushParser empty chunk, XInclude parser - flags (William),cleanupFTP and HTTP code to reuse the uri parsing and - IPv6(William),xmlTextWriterStartAttributeNS fix (Rob - Richards),XMLLINT_INDENT beingempty (William), xmlWriter bugs (Rob - Richards),multithreading on Windows(Rich Salz), xmlSearchNsByHref fix - (Kasimier),Python binding leak (BrentHendricks), aliasing bug exposed by - gcc4 ons390, xmlTextReaderNext bug(Rob Richards), Schemas decimal type - fixes(William Brack),xmlByteConsumed static buffer (Ben Maurer).</li> - <li>improvement: speedup parsing comments and DTDs, dictionnary - supportforhash tables, Schemas Identity constraints (Kasimier), - streamingXPathsubset, xmlTextReaderReadString added (Bjorn Reese), - Schemascanonicalvalues handling (Kasimier), add - xmlTextReaderByteConsumed(AronStansvik),</li> + <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation, + Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed), + some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li> + <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and + xmlreader stopping on non-fatal errors, thread support for dictionnaries + reference counting (Gary Coady), internal subset and push problem, URL + saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths + fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix + (Mike Hommey), warning should not count as error (William Brack), + xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup + FTP and HTTP code to reuse the uri parsing and IPv6 (William), + xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being + empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows + (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent + Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug + (Rob Richards), Schemas decimal type fixes (William Brack), + xmlByteConsumed static buffer (Ben Maurer).</li> + <li>improvement: speedup parsing comments and DTDs, dictionnary support for + hash tables, Schemas Identity constraints (Kasimier), streaming XPath + subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical + values handling (Kasimier), add xmlTextReaderByteConsumed (Aron + Stansvik),</li> <li>Documentation: Wiki support (Joel Reed)</li> </ul> <h3>2.6.17: Jan 16 2005</h3> <ul> - <li>build fixes: Windows, warnings removal (William - Brack),maintainer-cleandependency(William), build in a different - directory(William), fixing--with-minimum configure build (William), BeOS - build(Marcin Konicki),Python-2.4 detection (William), compilation on AIX - (DanMcNichol)</li> - <li>bug fixes: xmlTextReaderHasAttributes (Rob - Richards),xmlCtxtReadFile()to use the catalog(s), loop on output (William - Brack),XPath memory leak,ID deallocation problem (Steve Shepard), - debugDumpNodecrash (William),warning not using error callback (William), - xmlStopParserbug (William),UTF-16 with BOM on DTDs (William), namespace - bug on emptyelements inpush mode (Rob Richards), line and col - computations fixups(AlekseySanin), xmlURIEscape fix (William), - xmlXPathErr on bad range(William),patterns with too many steps, bug in - RNG choice optimization,line numbersometimes missing.</li> - <li>improvements: XSD Schemas (Kasimier Buchcik), pythongenerator(William), - xmlUTF8Strpos speedup (William), unicode Pythonstrings(William), XSD - error reports (Kasimier Buchcik), Python __str__callserialize().</li> - <li>new APIs: added xmlDictExists(), GetLineNumber and - GetColumnNumberforthe xmlReader (Aleksey Sanin), Dynamic Shared Libraries - APIs (mostlyJoelReed), error extraction API from regexps, new XMLSave - option forformat(Phil Shafer)</li> - <li>documentation: site improvement (John Fleck), FAQ entries(William).</li> + <li>build fixes: Windows, warnings removal (William Brack), + maintainer-clean dependency(William), build in a different directory + (William), fixing --with-minimum configure build (William), BeOS build + (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan + McNichol)</li> + <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile() + to use the catalog(s), loop on output (William Brack), XPath memory leak, + ID deallocation problem (Steve Shepard), debugDumpNode crash (William), + warning not using error callback (William), xmlStopParser bug (William), + UTF-16 with BOM on DTDs (William), namespace bug on empty elements in + push mode (Rob Richards), line and col computations fixups (Aleksey + Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William), + patterns with too many steps, bug in RNG choice optimization, line number + sometimes missing.</li> + <li>improvements: XSD Schemas (Kasimier Buchcik), python generator + (William), xmlUTF8Strpos speedup (William), unicode Python strings + (William), XSD error reports (Kasimier Buchcik), Python __str__ call + serialize().</li> + <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for + the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel + Reed), error extraction API from regexps, new XMLSave option for format + (Phil Shafer)</li> + <li>documentation: site improvement (John Fleck), FAQ entries + (William).</li> </ul> <h3>2.6.16: Nov 10 2004</h3> <ul> - <li>general hardening and bug fixing crossing all the API based - onnewautomated regression testing</li> + <li>general hardening and bug fixing crossing all the API based on new + automated regression testing</li> <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li> - <li>bug fixes: problem with XML::Libxml reported by Petr - Pajas,encodingconversion functions return values, UTF-8 bug affecting - XPathreported byMarkus Bertheau, catalog problem with NULL entries - (WilliamBrack)</li> - <li>documentation: fix to xmllint man page, some API - functiondescritpionwere updated.</li> - <li>improvements: DTD validation APIs provided at the Python - level(BrentHendricks)</li> + <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding + conversion functions return values, UTF-8 bug affecting XPath reported by + Markus Bertheau, catalog problem with NULL entries (William Brack)</li> + <li>documentation: fix to xmllint man page, some API function descritpion + were updated.</li> + <li>improvements: DTD validation APIs provided at the Python level (Brent + Hendricks)</li> </ul> <h3>2.6.15: Oct 27 2004</h3> <ul> <li>security fixes on the nanoftp and nanohttp modules</li> - <li>build fixes: xmllint detection bug in configure, building - outsidethesource tree (Thomas Fitzsimmons)</li> - <li>bug fixes: HTML parser on broken ASCII chars in names - (William),Pythonpaths (Malcolm Tredinnick), xmlHasNsProp and default - namespace(William),saving to python file objects (Malcolm Tredinnick), - DTD lookupfix(Malcolm), save back <group> in catalogs (William), - treebuildfixes (DV and Rob Richards), Schemas memory bug, structured - errorhandleron Python 64bits, thread local memory deallocation, memory - leakreportedby Volker Roth, xmlValidateDtd in the presence of an - internalsubset,entities and _private problem (William), - xmlBuildRelativeURIerror(William).</li> - <li>improvements: better XInclude error reports (William), - treedebuggingmodule and tests, convenience functions at the Reader - API(GrahamBennett), add support for PI in the HTML parser.</li> + <li>build fixes: xmllint detection bug in configure, building outside the + source tree (Thomas Fitzsimmons)</li> + <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python + paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William), + saving to python file objects (Malcolm Tredinnick), DTD lookup fix + (Malcolm), save back <group> in catalogs (William), tree build + fixes (DV and Rob Richards), Schemas memory bug, structured error handler + on Python 64bits, thread local memory deallocation, memory leak reported + by Volker Roth, xmlValidateDtd in the presence of an internal subset, + entities and _private problem (William), xmlBuildRelativeURI error + (William).</li> + <li>improvements: better XInclude error reports (William), tree debugging + module and tests, convenience functions at the Reader API (Graham + Bennett), add support for PI in the HTML parser.</li> </ul> <h3>2.6.14: Sep 29 2004</h3> <ul> - <li>build fixes: configure paths for xmllint and - xsltproc,compilationwithout HTML parser, compilation warning cleanups - (WilliamBrack &Malcolm Tredinnick), VMS makefile update (Craig - Berry),</li> - <li>bug fixes: xmlGetUTF8Char (William Brack), QName - properties(KasimierBuchcik), XInclude testing, Notation - serialization,UTF8ToISO8859xtranscoding (Mark Itzcovitz), lots of XML - Schemas cleanupand fixes(Kasimier), ChangeLog cleanup (Stepan Kasal), - memory fixes (MarkVakoc),handling of failed realloc(), out of bound array - adressing inSchemasdate handling, Python space/tabs cleanups (Malcolm - Tredinnick),NMTOKENSE20 validation fix (Malcolm),</li> - <li>improvements: added W3C XML Schemas testsuite (Kasimier - Buchcik),addxmlSchemaValidateOneElement (Kasimier), Python - exceptionhierearchy(Malcolm Tredinnick), Python libxml2 driver - improvement(MalcolmTredinnick), Schemas support - forxsi:schemaLocation,xsi:noNamespaceSchemaLocation, xsi:type - (KasimierBuchcik)</li> + <li>build fixes: configure paths for xmllint and xsltproc, compilation + without HTML parser, compilation warning cleanups (William Brack & + Malcolm Tredinnick), VMS makefile update (Craig Berry),</li> + <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier + Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x + transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes + (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc), + handling of failed realloc(), out of bound array adressing in Schemas + date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS + E20 validation fix (Malcolm),</li> + <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add + xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy + (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm + Tredinnick), Schemas support for xsi:schemaLocation, + xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li> </ul> <h3>2.6.13: Aug 31 2004</h3> <ul> - <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag withgcc,Solaris - compiler warning, fixing RPM BuildRequires,</li> - <li>fixes: DTD loading on Windows (Igor), Schemas error - reportsAPIs(Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 - (WilliamBrackand Julius Mittenzwei), Schemas facet check (Kasimier), - defaultnamespaceproblem (William), Schemas hexbinary empty values, - encodingerror couldgenrate a serialization loop.</li> - <li>Improvements: Schemas validity improvements (Kasimier), added - --pathand--load-trace options to xmllint</li> + <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc, + Solaris compiler warning, fixing RPM BuildRequires,</li> + <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs + (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack + and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace + problem (William), Schemas hexbinary empty values, encoding error could + genrate a serialization loop.</li> + <li>Improvements: Schemas validity improvements (Kasimier), added --path + and --load-trace options to xmllint</li> <li>documentation: tutorial update (John Fleck)</li> </ul> <h3>2.6.12: Aug 22 2004</h3> <ul> - <li>build fixes: fix --with-minimum, elfgcchack.h - fixes(PeterBreitenlohner), perl path lookup (William), diff on - Solaris(AlbertChin), some 64bits cleanups.</li> - <li>Python: avoid a warning with 2.3 (William Brack), tab and - spacemixes(William), wrapper generator fixes (William), Cygwin support - (GerritP.Haase), node wrapper fix (Marc-Antoine Parent), XML - Schemassupport(Torkel Lyng)</li> + <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter + Breitenlohner), perl path lookup (William), diff on Solaris (Albert + Chin), some 64bits cleanups.</li> + <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes + (William), wrapper generator fixes (William), Cygwin support (Gerrit P. + Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support + (Torkel Lyng)</li> <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li> - <li>fixes: RVT fixes (William), XPath context resets bug - (William),memorydebug (Steve Hay), catalog white space handling - (PeterBreitenlohner),xmlReader state after attribute reading - (William),structured errorhandler (William), XInclude generated xml:base - fixup(William), Windowsmemory reallocation problem (Steve Hay), Out of - Memoryconditionshandling (William and Olivier Andrieu), htmlNewDoc() - charsetbug,htmlReadMemory init (William), a posteriori validation - DTDbase(William), notations serialization missing, - xmlGetNodePath(Dodji),xmlCheckUTF8 (Diego Tartara), missing line numbers - onentity(William)</li> - <li>improvements: DocBook catalog build scrip (William), - xmlcatalogtool(Albert Chin), xmllint --c14n option, no_proxy environment - (MikeHommey),xmlParseInNodeContext() addition, extend xmllint --shell, - allowXIncludeto not generate start/end nodes, extend xmllint --version - toinclude CVStag (William)</li> - <li>documentation: web pages fixes, validity API docs fixes(William)schemas - API fix (Eric Haszlakiewicz), xmllint man page (JohnFleck)</li> + <li>fixes: RVT fixes (William), XPath context resets bug (William), memory + debug (Steve Hay), catalog white space handling (Peter Breitenlohner), + xmlReader state after attribute reading (William), structured error + handler (William), XInclude generated xml:base fixup (William), Windows + memory reallocation problem (Steve Hay), Out of Memory conditions + handling (William and Olivier Andrieu), htmlNewDoc() charset bug, + htmlReadMemory init (William), a posteriori validation DTD base + (William), notations serialization missing, xmlGetNodePath (Dodji), + xmlCheckUTF8 (Diego Tartara), missing line numbers on entity + (William)</li> + <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool + (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey), + xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude + to not generate start/end nodes, extend xmllint --version to include CVS + tag (William)</li> + <li>documentation: web pages fixes, validity API docs fixes (William) + schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li> </ul> <h3>2.6.11: July 5 2004</h3> <ul> - <li>Schemas: a lot of changes and improvements by Kasimier - Buchcikforattributes, namespaces and simple types.</li> - <li>build fixes: --with-minimum (William Brack), some gcccleanup(William), - --with-thread-alloc (William)</li> - <li>portability: Windows binary package change (Igor Zlatkovic),Catalogpath - on Windows</li> - <li>documentation: update to the tutorial (John Fleck), xmllint - returncode(John Fleck), man pages (Ville Skytta),</li> - <li>bug fixes: C14N bug serializing namespaces (Aleksey - Sanin),testSAXproperly initialize the library (William), empty node set - inXPath(William), xmlSchemas errors (William), invalid charref - problempointedby Morus Walter, XInclude xml:base generation (William), - Relax-NGbugwith div processing (William), XPointer and - xml:baseproblem(William),Reader and entities, xmllint return code for - schemas(William), readerstreaming problem (Steve Ball), DTD - serializationproblem (William),libxml.m4 fixes (Mike Hommey), do not - providedestructors as methods onPython classes, xmlReader buffer bug, - Pythonbindings memory interfacesimprovement (with Stéphane Bidoul), Fixed - thepush parser to be back tosynchronous behaviour.</li> - <li>improvement: custom per-thread I/O enhancement (Rob - Richards),registernamespace in debug shell (Stefano Debenedetti), Python - basedregressiontest for non-Unix users (William), dynamically increase - thenumber ofXPath extension functions in Python and fix a memory - leak(Marc-AntoineParent and William)</li> - <li>performance: hack done with Arjan van de Ven to reduce ELF - footprintandgenerated code on Linux, plus use gcc runtime profiling to - optimizethecode generated in the RPM packages.</li> + <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for + attributes, namespaces and simple types.</li> + <li>build fixes: --with-minimum (William Brack), some gcc cleanup + (William), --with-thread-alloc (William)</li> + <li>portability: Windows binary package change (Igor Zlatkovic), Catalog + path on Windows</li> + <li>documentation: update to the tutorial (John Fleck), xmllint return code + (John Fleck), man pages (Ville Skytta),</li> + <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX + properly initialize the library (William), empty node set in XPath + (William), xmlSchemas errors (William), invalid charref problem pointed + by Morus Walter, XInclude xml:base generation (William), Relax-NG bug + with div processing (William), XPointer and xml:base problem(William), + Reader and entities, xmllint return code for schemas (William), reader + streaming problem (Steve Ball), DTD serialization problem (William), + libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on + Python classes, xmlReader buffer bug, Python bindings memory interfaces + improvement (with Stéphane Bidoul), Fixed the push parser to be back to + synchronous behaviour.</li> + <li>improvement: custom per-thread I/O enhancement (Rob Richards), register + namespace in debug shell (Stefano Debenedetti), Python based regression + test for non-Unix users (William), dynamically increase the number of + XPath extension functions in Python and fix a memory leak (Marc-Antoine + Parent and William)</li> + <li>performance: hack done with Arjan van de Ven to reduce ELF footprint + and generated code on Linux, plus use gcc runtime profiling to optimize + the code generated in the RPM packages.</li> </ul> <h3>2.6.10: May 17 2004</h3> <ul> <li>Web page generated for ChangeLog</li> <li>build fixes: --without-html problems, make check without make all</li> - <li>portability: problem with xpath.c on Windows (MSC and - Borland),memcmpvs. strncmp on Solaris, XPath tests on Windows (Mark - Vakoc), C++ donotuse "list" as parameter name, make tests work with - Python 1.5(EdDavis),</li> - <li>improvements: made xmlTextReaderMode public, small - buffersresizing(Morten Welinder), add --maxmem option to - xmllint,addxmlPopInputCallback() for Matt Sergeant, refactoring - ofserializationescaping, added escaping customization</li> - <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp - bugs(WilliamBrack), xmlReader end of stream problem, node deregistration - withreader,URI escaping and filemanes, XHTML1 formatting (Nick - Wellnhofer),regexptransition reduction (William), various XSD Schemas - fixes(KasimierBuchcik), XInclude fallback problem (William), weird - problemswith DTD(William), structured error handler callback context - (William),reversexmlEncodeSpecialChars() behaviour back to escaping - '"'</li> + <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp + vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not + use "list" as parameter name, make tests work with Python 1.5 (Ed + Davis),</li> + <li>improvements: made xmlTextReaderMode public, small buffers resizing + (Morten Welinder), add --maxmem option to xmllint, add + xmlPopInputCallback() for Matt Sergeant, refactoring of serialization + escaping, added escaping customization</li> + <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William + Brack), xmlReader end of stream problem, node deregistration with reader, + URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp + transition reduction (William), various XSD Schemas fixes (Kasimier + Buchcik), XInclude fallback problem (William), weird problems with DTD + (William), structured error handler callback context (William), reverse + xmlEncodeSpecialChars() behaviour back to escaping '"'</li> </ul> <h3>2.6.9: Apr 18 2004</h3> <ul> <li>implement xml:id Working Draft, relaxed XPath id() checking</li> - <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and - CDATA(DaveBeckett), Relax-NG compilation (William Brack), Regexp - patches(withWilliam), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed - problem(withWilliam), Relax-NG name classes compares (William), - XIncludeduplicatefallback (William), external DTD encoding detection - (William), aDTDvalidation bug (William), xmlReader Close() fix, - recusiveextentionschemas</li> - <li>improvements: use xmlRead* APIs in test tools (Mark - Vakoc),indentingsave optimization, better handle IIS broken HTTP - redirectbehaviour (IanHummel), HTML parser frameset (James Bursa), - libxml2-pythonRPMdependancy, XML Schemas union support (Kasimier - Buchcik), warningremovalclanup (William), keep ChangeLog compressed when - installing fromRPMs</li> - <li>documentation: examples and xmlDocDumpMemory docs (John - Fleck),newexample (load, xpath, modify, save), xmlCatalogDump() - comments,</li> - <li>Windows: Borland C++ builder (Eric Zurcher), work - aroundMicrosoftcompiler NaN handling bug (Mark Vakoc)</li> + <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave + Beckett), Relax-NG compilation (William Brack), Regexp patches (with + William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with + William), Relax-NG name classes compares (William), XInclude duplicate + fallback (William), external DTD encoding detection (William), a DTD + validation bug (William), xmlReader Close() fix, recusive extention + schemas</li> + <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting + save optimization, better handle IIS broken HTTP redirect behaviour (Ian + Hummel), HTML parser frameset (James Bursa), libxml2-python RPM + dependancy, XML Schemas union support (Kasimier Buchcik), warning removal + clanup (William), keep ChangeLog compressed when installing from RPMs</li> + <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new + example (load, xpath, modify, save), xmlCatalogDump() comments,</li> + <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft + compiler NaN handling bug (Mark Vakoc)</li> </ul> <h3>2.6.8: Mar 23 2004</h3> <ul> <li>First step of the cleanup of the serialization code and APIs</li> - <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling - fixes(AdamDickmeiss), anyURI for "" (John Belmonte)</li> + <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam + Dickmeiss), anyURI for "" (John Belmonte)</li> <li>Python: Canonicalization C14N support added (Anthony Carrico)</li> <li>xmlDocCopyNode() extension (William)</li> - <li>Relax-NG: fix when processing XInclude results - (William),externalreference in interleave (William), missing error - on<choice>failure (William), memory leak in schemas - datatypefacets.</li> + <li>Relax-NG: fix when processing XInclude results (William), external + reference in interleave (William), missing error on <choice> + failure (William), memory leak in schemas datatype facets.</li> <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li> - <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey - andWilliamBrack), no ID errors if using HTML_PARSE_NOERROR, - xmlcatalogfallbacks toURI on SYSTEM lookup failure, XInclude parse - flagsinheritance (William),XInclude and XPointer fixes for entities - (William),XML parser bugreported by Holger Rauch, nanohttp fd leak - (William),regexps chargroups '-' handling (William), dictionnary - reference countingproblems,do not close stderr.</li> + <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William + Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to + URI on SYSTEM lookup failure, XInclude parse flags inheritance (William), + XInclude and XPointer fixes for entities (William), XML parser bug + reported by Holger Rauch, nanohttp fd leak (William), regexps char + groups '-' handling (William), dictionnary reference counting problems, + do not close stderr.</li> <li>performance patches from Petr Pajas</li> <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li> - <li>compilation and portability fixes: --without-valid, - catalogcleanups(Peter Breitenlohner), MingW patch (Roland - Schwingel),cross-compilationto Windows (Christophe de Vienne), - --with-html-dirfixup (Julio MerinoVidal), Windows build (Eric - Zurcher)</li> + <li>compilation and portability fixes: --without-valid, catalog cleanups + (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation + to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino + Vidal), Windows build (Eric Zurcher)</li> </ul> <h3>2.6.7: Feb 23 2004</h3> @@ -1207,64 +1251,63 @@ base.</p> <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li> <li>XPath optimization (Petr Pajas)</li> <li>DTD ID handling optimization</li> - <li>bugfixes: xpath number with > 19 fractional (William - Brack),pushmode with unescaped '>' characters, fix xmllint --stream - --timing,fixxmllint --memory --stream memory - usage,xmlAttrSerializeTxtContenthandling NULL, trying to fix - Relax-NG/Perlinterface.</li> + <li>bugfixes: xpath number with > 19 fractional (William Brack), push + mode with unescaped '>' characters, fix xmllint --stream --timing, fix + xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent + handling NULL, trying to fix Relax-NG/Perl interface.</li> <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li> <li>Added relaxng option to xmllint --shell</li> </ul> <h3>2.6.6: Feb 12 2004</h3> <ul> - <li>nanohttp and nanoftp: buffer overflow error on URI parsing - (IgorandWilliam) reported by Yuuichi Teranishi</li> - <li>bugfixes: make test and path issues, xmlWriter - attributeserialization(William Brack), xmlWriter indentation (William), - schemasvalidation(Eric Haszlakiewicz), XInclude dictionnaries issues - (Williamand OlegParaschenko), XInclude empty fallback (William), HTML - warnings(William),XPointer in XInclude (William), Python - namespaceserialization,isolat1ToUTF8 bound error (Alfred Mickautsch), - output ofparameterentities in internal subset (William), internal subset - bug inpush mode,<xs:all> fix (Alexey Sarytchev)</li> - <li>Build: fix for automake-1.8 (Alexander Winston), warningsremoval(Philip - Ludlam), SOCKLEN_T detection fixes (Daniel Richard),fix--with-minimum - configuration.</li> + <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and + William) reported by Yuuichi Teranishi</li> + <li>bugfixes: make test and path issues, xmlWriter attribute serialization + (William Brack), xmlWriter indentation (William), schemas validation + (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg + Paraschenko), XInclude empty fallback (William), HTML warnings (William), + XPointer in XInclude (William), Python namespace serialization, + isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter + entities in internal subset (William), internal subset bug in push mode, + <xs:all> fix (Alexey Sarytchev)</li> + <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal + (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix + --with-minimum configuration.</li> <li>XInclude: allow the 2001 namespace without warning.</li> - <li>Documentation: missing example/index.html (John - Fleck),versiondependancies (John Fleck)</li> + <li>Documentation: missing example/index.html (John Fleck), version + dependancies (John Fleck)</li> <li>reader API: structured error reporting (Steve Ball)</li> - <li>Windows compilation: mingw, msys (Mikhail - Grushinskiy),functionprototype (Cameron Johnson), MSVC6 compiler - warnings,_WINSOCKAPI_patch</li> - <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte - offestininput.</li> + <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function + prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_ + patch</li> + <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in + input.</li> </ul> <h3>2.6.5: Jan 25 2004</h3> <ul> - <li>Bugfixes: dictionnaries for schemas (William Brack), - regexpsegfault(William), xs:all problem (William), a number of - XPointerbugfixes(William), xmllint error go to stderr, DTD validation - problemwithnamespace, memory leak (William), SAX1 cleanup and minimal - optionsfixes(Mark Vadoc), parser context reset on error (Shaun McCance), - XPathunionevaluation problem (William) , xmlReallocLoc with NULL - (AlekseySanin),XML Schemas double free (Steve Ball), XInclude with no - href,argumentcallbacks order for XPath callbacks (Frederic Peters)</li> - <li>Documentation: python scripts (William Brack), xslt - stylesheets(JohnFleck), doc (Sven Zimmerman), I/O example.</li> - <li>Python bindings: fixes (William), enum support - (StéphaneBidoul),structured error reporting (Stéphane Bidoul)</li> - <li>XInclude: various fixes for conformance, problem related - todictionnaryreferences (William & me), recursion (William)</li> - <li>xmlWriter: indentation (Lucas Brasilino), memory - leaks(AlfredMickautsch),</li> + <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault + (William), xs:all problem (William), a number of XPointer bugfixes + (William), xmllint error go to stderr, DTD validation problem with + namespace, memory leak (William), SAX1 cleanup and minimal options fixes + (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union + evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin), + XML Schemas double free (Steve Ball), XInclude with no href, argument + callbacks order for XPath callbacks (Frederic Peters)</li> + <li>Documentation: python scripts (William Brack), xslt stylesheets (John + Fleck), doc (Sven Zimmerman), I/O example.</li> + <li>Python bindings: fixes (William), enum support (Stéphane Bidoul), + structured error reporting (Stéphane Bidoul)</li> + <li>XInclude: various fixes for conformance, problem related to dictionnary + references (William & me), recursion (William)</li> + <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred + Mickautsch),</li> <li>xmlSchemas: normalizedString datatype (John Belmonte)</li> <li>code cleanup for strings functions (William)</li> <li>Windows: compiler patches (Mark Vakoc)</li> - <li>Parser optimizations, a few new XPath and dictionnary APIs - forfutureXSLT optimizations.</li> + <li>Parser optimizations, a few new XPath and dictionnary APIs for future + XSLT optimizations.</li> </ul> <h3>2.6.4: Dec 24 2003</h3> @@ -1272,41 +1315,41 @@ base.</p> <li>Windows build fixes (Igor Zlatkovic)</li> <li>Some serious XInclude problems reported by Oleg Paraschenko and</li> <li>Unix and Makefile packaging fixes (me, William Brack,</li> - <li>Documentation improvements (John Fleck, William Brack), - examplefix(Lucas Brasilino)</li> - <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath - handlingofNULL strings (William Brack) , API building reader or - parserfromfiledescriptor should not close it, changed XPath sorting to - bestableagain (William Brack), xmlGetNodePath() generating - '(null)'(WilliamBrack), DTD validation and namespace bug (William Brack), - XMLSchemasdouble inclusion behaviour</li> + <li>Documentation improvements (John Fleck, William Brack), example fix + (Lucas Brasilino)</li> + <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of + NULL strings (William Brack) , API building reader or parser from + filedescriptor should not close it, changed XPath sorting to be stable + again (William Brack), xmlGetNodePath() generating '(null)' (William + Brack), DTD validation and namespace bug (William Brack), XML Schemas + double inclusion behaviour</li> </ul> <h3>2.6.3: Dec 10 2003</h3> <ul> <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li> - <li>added a repository of examples, examples from Aleksey - Sanin,DodjiSeketeli, Alfred Mickautsch</li> - <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher,Mingw(Kenneth - Haley)</li> + <li>added a repository of examples, examples from Aleksey Sanin, Dodji + Seketeli, Alfred Mickautsch</li> + <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw + (Kenneth Haley)</li> <li>Unicode range checking (William Brack)</li> <li>code cleanup (William Brack)</li> <li>Python bindings: doc (John Fleck), bug fixes</li> <li>UTF-16 cleanup and BOM issues (William Brack)</li> - <li>bug fixes: ID and xmlReader validation, XPath (William - Brack),xmlWriter(Alfred Mickautsch), hash.h inclusion problem, HTML - parser(James Bursa),attribute defaulting and validation, some - serializationcleanups,XML_GET_LINE macro, memory debug when using threads - (WilliamBrack),serialization of attributes and entities content, - xmlWriter(DanielSchulman)</li> - <li>XInclude bugfix, new APIs and update to the last version - includingthenamespace change.</li> - <li>XML Schemas improvements: include (Robert Stepanek), importandnamespace - handling, fixed the regression tests troubles, addedexamplesbased on Eric - van der Vlist book, regexp fixes</li> - <li>preliminary pattern support for streaming (needed - forschemasconstraints), added xmlTextReaderPreservePattern() to - collectsubdocumentwhen streaming.</li> + <li>bug fixes: ID and xmlReader validation, XPath (William Brack), + xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser + (James Bursa), attribute defaulting and validation, some serialization + cleanups, XML_GET_LINE macro, memory debug when using threads (William + Brack), serialization of attributes and entities content, xmlWriter + (Daniel Schulman)</li> + <li>XInclude bugfix, new APIs and update to the last version including the + namespace change.</li> + <li>XML Schemas improvements: include (Robert Stepanek), import and + namespace handling, fixed the regression tests troubles, added examples + based on Eric van der Vlist book, regexp fixes</li> + <li>preliminary pattern support for streaming (needed for schemas + constraints), added xmlTextReaderPreservePattern() to collect subdocument + when streaming.</li> <li>various fixes in the structured error handling</li> </ul> @@ -1322,108 +1365,107 @@ base.</p> <li>a posteriori DTD validation fixes</li> <li>xmlReader bug fixes: Walker fixes, python bindings</li> <li>fixed xmlStopParser() to really stop the parser and errors</li> - <li>always generate line numbers when using the new xmlReadxxxfunctions</li> + <li>always generate line numbers when using the new xmlReadxxx + functions</li> <li>added XInclude support to the xmlReader interface</li> <li>implemented XML_PARSE_NONET parser option</li> <li>DocBook XSLT processing bug fixed</li> <li>HTML serialization for <p> elements (William Brack and me)</li> <li>XPointer failure in XInclude are now handled as resource errors</li> - <li>fixed xmllint --html to use the HTML serializer on output(added--xmlout - to implement the previous behaviour of saving it using - theXMLserializer)</li> + <li>fixed xmllint --html to use the HTML serializer on output (added + --xmlout to implement the previous behaviour of saving it using the XML + serializer)</li> </ul> <h3>2.6.1: Oct 28 2003</h3> <ul> <li>Mostly bugfixes after the big 2.6.0 changes</li> - <li>Unix compilation patches: libxml.m4 (Patrick Welche), - warningscleanup(William Brack)</li> - <li>Windows compilation patches (Joachim Bauch, Stephane - Bidoul,IgorZlatkovic)</li> + <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup + (William Brack)</li> + <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor + Zlatkovic)</li> <li>xmlWriter bugfix (Alfred Mickautsch)</li> <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li> - <li>context reset: error state reset, push parser reset (GrahamBennett)</li> + <li>context reset: error state reset, push parser reset (Graham + Bennett)</li> <li>context reuse: generate errors if file is not readable</li> - <li>defaulted attributes for element coming from internal - entities(StephaneBidoul)</li> + <li>defaulted attributes for element coming from internal entities + (Stephane Bidoul)</li> <li>Python: tab and spaces mix (William Brack)</li> <li>Error handler could crash in DTD validation in 2.6.0</li> <li>xmlReader: do not use the document or element _private field</li> <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li> - <li>general bug fixes: mandatory encoding in text decl, - serializingDocumentFragment nodes, xmlSearchNs 2.6.0 problem (Kasimier - Buchcik),XPath errorsnot reported, slow HTML parsing of large - documents.</li> + <li>general bug fixes: mandatory encoding in text decl, serializing + Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik), + XPath errors not reported, slow HTML parsing of large documents.</li> </ul> <h3>2.6.0: Oct 20 2003</h3> <ul> - <li>Major revision release: should be API and ABI compatible but got alotof - change</li> - <li>Increased the library modularity, far more options can be strippedout,a - --with-minimum configuration will weight around 160KBytes</li> - <li>Use per parser and per document dictionnary, allocate names - andsmalltext nodes from the dictionnary</li> - <li>Switch to a SAX2 like parser rewrote most of the XML - parsercore,provides namespace resolution and defaulted attributes, - minimizememoryallocations and copies, namespace checking and specific - errorhandling,immutable buffers, make predefined entities static - structures,etc...</li> - <li>rewrote all the error handling in the library, all errors - canbeintercepted at a structured level, with - preciseinformationavailable.</li> - <li>New simpler and more generic XML and HTML parser APIs, - allowingtoeasilly modify the parsing options and reuse parser context - formultipleconsecutive documents.</li> - <li>Similar new APIs for the xmlReader, for options and reuse, - providednewfunctions to access content as const strings, use them - forPythonbindings</li> - <li>a lot of other smaller API improvements: xmlStrPrintf - (AlekseySanin),Walker i.e. reader on a document tree based on Alfred - Mickautschcode,make room in nodes for line numbers, reference counting - and futurePSVIextensions, generation of character ranges to be checked - withfasteralgorithm (William), xmlParserMaxDepth (Crutcher - Dunnavant),bufferaccess</li> + <li>Major revision release: should be API and ABI compatible but got a lot + of change</li> + <li>Increased the library modularity, far more options can be stripped out, + a --with-minimum configuration will weight around 160KBytes</li> + <li>Use per parser and per document dictionnary, allocate names and small + text nodes from the dictionnary</li> + <li>Switch to a SAX2 like parser rewrote most of the XML parser core, + provides namespace resolution and defaulted attributes, minimize memory + allocations and copies, namespace checking and specific error handling, + immutable buffers, make predefined entities static structures, etc...</li> + <li>rewrote all the error handling in the library, all errors can be + intercepted at a structured level, with precise information + available.</li> + <li>New simpler and more generic XML and HTML parser APIs, allowing to + easilly modify the parsing options and reuse parser context for multiple + consecutive documents.</li> + <li>Similar new APIs for the xmlReader, for options and reuse, provided new + functions to access content as const strings, use them for Python + bindings</li> + <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin), + Walker i.e. reader on a document tree based on Alfred Mickautsch code, + make room in nodes for line numbers, reference counting and future PSVI + extensions, generation of character ranges to be checked with faster + algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer + access</li> <li>New xmlWriter API provided by Alfred Mickautsch</li> <li>Schemas: base64 support by Anthony Carrico</li> - <li>Parser<->HTTP integration fix, proper processing of - theMime-Typeand charset informations if available.</li> - <li>Relax-NG: bug fixes including the one reported by Martijn - FaassenandzeroOrMore, better error reporting.</li> - <li>Python bindings (Stéphane Bidoul), never use stdout forerrorsoutput</li> - <li>Portability: all the headers have macros for export - andcallingconvention definitions (Igor Zlatkovic), VMS update (Craig - A.Berry),Windows: threads (Jesse Pelton), Borland compiler (Eric - Zurcher,Igor),Mingw (Igor), typos (Mark Vakoc), beta version - (StephaneBidoul),warning cleanups on AIX and MIPS compilers (William - Brack), BeOS(Marcin'Shard' Konicki)</li> - <li>Documentation fixes and README (William Brack), search - fix(William),tutorial updates (John Fleck), namespace docs (Stefan - Kost)</li> - <li>Bug fixes: xmlCleanupParser (Dave Beckett), - threadinguninitializedmutexes, HTML doctype lowercase, SAX/IO - (William),compression detectionand restore (William), attribute - declaration in DTDs(William), namespaceon attribute in HTML output - (William), input filename(Rob Richards),namespace DTD validation, - xmlReplaceNode (Chris Ryland),I/O callbacks(Markus Keim), CDATA - serialization (Shaun McCance),xmlReader (PeterDerr), high codepoint - charref like &#x10FFFF;, bufferaccess in pushmode (Justin Fletcher), - TLS threads on Windows (JessePelton), XPath bug(William), - xmlCleanupParser (Marc Liyanage), CDATAoutput (William), HTTPerror - handling.</li> - <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 - forcompattesting, --nodict for building without tree dictionnary, - --nocdatatoreplace CDATA by text, --nsclean to remove - surperfluousnamespacedeclarations</li> + <li>Parser<->HTTP integration fix, proper processing of the Mime-Type + and charset informations if available.</li> + <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and + zeroOrMore, better error reporting.</li> + <li>Python bindings (Stéphane Bidoul), never use stdout for errors + output</li> + <li>Portability: all the headers have macros for export and calling + convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry), + Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor), + Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul), + warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin + 'Shard' Konicki)</li> + <li>Documentation fixes and README (William Brack), search fix (William), + tutorial updates (John Fleck), namespace docs (Stefan Kost)</li> + <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized + mutexes, HTML doctype lowercase, SAX/IO (William), compression detection + and restore (William), attribute declaration in DTDs (William), namespace + on attribute in HTML output (William), input filename (Rob Richards), + namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks + (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter + Derr), high codepoint charref like &#x10FFFF;, buffer access in push + mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug + (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP + error handling.</li> + <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat + testing, --nodict for building without tree dictionnary, --nocdata to + replace CDATA by text, --nsclean to remove surperfluous namespace + declarations</li> <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li> - <li>a lot of profiling and tuning of the code, speedup - patchforxmlSearchNs() by Luca Padovani. The xmlReader should do - farlessallocation and it speed should get closer to SAX. Chris - Andersonworkedon speeding and cleaning up repetitive checking code.</li> + <li>a lot of profiling and tuning of the code, speedup patch for + xmlSearchNs() by Luca Padovani. The xmlReader should do far less + allocation and it speed should get closer to SAX. Chris Anderson worked + on speeding and cleaning up repetitive checking code.</li> <li>cleanup of "make tests"</li> <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li> - <li>deactivated the broken docBook SGML parser code and plugged - theXMLparser instead.</li> + <li>deactivated the broken docBook SGML parser code and plugged the XML + parser instead.</li> </ul> <h3>2.5.11: Sep 9 2003</h3> @@ -1440,8 +1482,8 @@ base.</p> <ul> <li>Windows Makefiles (William Brack)</li> <li>UTF-16 support fixes (Mark Itzcovitz)</li> - <li>Makefile and portability (William Brack) automake, Linux alpha, - MingwonWindows (Mikhail Grushinskiy)</li> + <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw + on Windows (Mikhail Grushinskiy)</li> <li>HTML parser (Oliver Stoeneberg)</li> <li>XInclude performance problem reported by Kevin Ruscoe</li> <li>XML parser performance problem reported by Grant Goodale</li> @@ -1451,13 +1493,13 @@ base.</p> <h3>2.5.9: Aug 9 2003</h3> <ul> - <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), - Windowsbuild(Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter - Sobisch),threading(Rob Richards), hexBinary type (), UTF-16 BOM - (DodjiSeketeli),xmlReader, Relax-NG schemas compilation, namespace - handling,EXSLT (SeanGriffin), HTML parsing problem (William Brack), DTD - validationfor mixedcontent + namespaces, HTML serialization, - libraryinitialization,progressive HTML parser</li> + <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build + (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading + (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli), + xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean + Griffin), HTML parsing problem (William Brack), DTD validation for mixed + content + namespaces, HTML serialization, library initialization, + progressive HTML parser</li> <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li> <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li> <li>doc fixes and improvements (John Fleck)</li> @@ -1465,85 +1507,86 @@ base.</p> <li>couple of new UTF-8 helper functions (William Brack)</li> <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li> <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li> - <li>general compilation/warning cleanup Solaris/HP-UX/...(WilliamBrack)</li> + <li>general compilation/warning cleanup Solaris/HP-UX/... (William + Brack)</li> </ul> <h3>2.5.8: Jul 6 2003</h3> <ul> - <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 - save(MarkItzcovitz), UTF-8 checking, URI saving, error printing - (WilliamBrack),PI related memleak, compilation without schemas or without - xpath(JoergSchmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem - withDTDs,rpm problem on , i86_64, removed a few compilation problems - from2.5.7,xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li> + <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark + Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack), + PI related memleak, compilation without schemas or without xpath (Joerg + Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs, + rpm problem on , i86_64, removed a few compilation problems from 2.5.7, + xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li> <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li> <li>William Brack fixed multithreading lock problems</li> <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li> - <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), - threading(StéphaneBidoul)</li> + <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane + Bidoul)</li> <li>A few W3C Schemas Structure improvements</li> <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li> - <li>Python bindings for thread globals (Stéphane Bidoul), - andmethod/classgenerator</li> + <li>Python bindings for thread globals (Stéphane Bidoul), and method/class + generator</li> <li>added --nonet option to xmllint</li> <li>documentation improvements (John Fleck)</li> </ul> <h3>2.5.7: Apr 25 2003</h3> <ul> - <li>Relax-NG: Compiling to regexp and streaming validation on top - ofthexmlReader interface, added to xmllint --stream</li> + <li>Relax-NG: Compiling to regexp and streaming validation on top of the + xmlReader interface, added to xmllint --stream</li> <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li> <li>Support for large files: RGN validated a 4.5GB instance</li> <li>Thread support is now configured in by default</li> - <li>Fixes: update of the Trio code (Bjorn), WXS Date and - Durationfixes(Charles Bozeman), DTD and namespaces (Brent Hendricks), - HTML pushparserand zero bytes handling, some missing Windows file - pathconversions,behaviour of the parser and validator in the presence of - "outof memory"error conditions</li> - <li>extended the API to be able to plug a garbage - collectingmemoryallocator, added xmlMallocAtomic() and modified - theallocationsaccordingly.</li> - <li>Performances: removed excessive malloc() calls, speedup of the - pushandxmlReader interfaces, removed excessive thread locking</li> + <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes + (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser + and zero bytes handling, some missing Windows file path conversions, + behaviour of the parser and validator in the presence of "out of memory" + error conditions</li> + <li>extended the API to be able to plug a garbage collecting memory + allocator, added xmlMallocAtomic() and modified the allocations + accordingly.</li> + <li>Performances: removed excessive malloc() calls, speedup of the push and + xmlReader interfaces, removed excessive thread locking</li> <li>Documentation: man page (John Fleck), xmlReader documentation</li> <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li> </ul> <h3>2.5.6: Apr 1 2003</h3> <ul> - <li>Fixed W3C XML Schemas datatype, should be compliant now exceptforbinHex - and base64 which are not supported yet.</li> - <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large - docsandXInclude entities handling, encoding detection on external - subsets,XMLSchemas bugs and memory leaks, HTML parser (James Bursa)</li> + <li>Fixed W3C XML Schemas datatype, should be compliant now except for + binHex and base64 which are not supported yet.</li> + <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and + XInclude entities handling, encoding detection on external subsets, XML + Schemas bugs and memory leaks, HTML parser (James Bursa)</li> <li>portability: python/trio (Albert Chin), Sun compiler warnings</li> <li>documentation: added --relaxng option to xmllint man page (John)</li> - <li>improved error reporting: xml:space, start/end tag mismatches, - RelaxNGerrors</li> + <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG + errors</li> </ul> <h3>2.5.5: Mar 24 2003</h3> <ul> - <li>Lot of fixes on the Relax NG implementation. More - testingincludingDocBook and TEI examples.</li> + <li>Lot of fixes on the Relax NG implementation. More testing including + DocBook and TEI examples.</li> <li>Increased the support for W3C XML Schemas datatype</li> <li>Several bug fixes in the URI handling layer</li> - <li>Bug fixes: HTML parser, xmlReader, DTD validation, - XPath,encodingconversion, line counting in the parser.</li> + <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding + conversion, line counting in the parser.</li> <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li> <li>Fixed the RPM spec file name</li> </ul> <h3>2.5.4: Feb 20 2003</h3> <ul> - <li>Conformance testing and lot of fixes on Relax NG - andXIncludeimplementation</li> + <li>Conformance testing and lot of fixes on Relax NG and XInclude + implementation</li> <li>Implementation of XPointer element() scheme</li> - <li>Bug fixes: XML parser, XInclude entities merge, validity - checkingonnamespaces, - <p>2 serialization bugs, node info generation problems, a - DTDregexpgeneration problem.</p> + <li>Bug fixes: XML parser, XInclude entities merge, validity checking on + namespaces, + <p>2 serialization bugs, node info generation problems, a DTD regexp + generation problem.</p> </li> <li>Portability: windows updates and path canonicalization (Igor)</li> <li>A few typo fixes (Kjartan Maraas)</li> @@ -1552,11 +1595,11 @@ base.</p> <h3>2.5.3: Feb 10 2003</h3> <ul> - <li>RelaxNG and XML Schemas datatypes improvements, and added afirstversion - of RelaxNG Python bindings</li> - <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API - fixforserializing namespace nodes, encoding conversion - bug,XHTML1serialization</li> + <li>RelaxNG and XML Schemas datatypes improvements, and added a first + version of RelaxNG Python bindings</li> + <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for + serializing namespace nodes, encoding conversion bug, XHTML1 + serialization</li> <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li> </ul> @@ -1564,17 +1607,17 @@ base.</p> <ul> <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li> <li>Schemas support now compiled in by default.</li> - <li>Bug fixes: DTD validation, namespace checking, XInclude - andentities,delegateURI in XML Catalogs, HTML parser, XML reader - (StéphaneBidoul),XPath parser and evaluation, UTF8ToUTF8 serialization, - XMLreader memoryconsumption, HTML parser, HTML serialization in the - presenceofnamespaces</li> + <li>Bug fixes: DTD validation, namespace checking, XInclude and entities, + delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul), + XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory + consumption, HTML parser, HTML serialization in the presence of + namespaces</li> <li>added an HTML API to check elements and attributes.</li> - <li>Documentation improvement, PDF for the tutorial (John Fleck),docpatches - (Stefan Kost)</li> + <li>Documentation improvement, PDF for the tutorial (John Fleck), doc + patches (Stefan Kost)</li> <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li> - <li>Added python bindings for XPointer, contextual error - reporting(StéphaneBidoul)</li> + <li>Added python bindings for XPointer, contextual error reporting + (Stéphane Bidoul)</li> <li>URI/file escaping problems (Stefano Zacchiroli)</li> </ul> @@ -1587,19 +1630,20 @@ base.</p> <h3>2.5.0: Jan 6 2003</h3> <ul> - <li>New <a href="xmlreader.html">XmltextReader interface</a>based on - C#API(with help of Stéphane Bidoul)</li> + <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C# + API (with help of Stéphane Bidoul)</li> <li>Windows: more exports, including the new API (Igor)</li> <li>XInclude fallback fix</li> - <li>Python: bindings for the new API, packaging - (StéphaneBidoul),drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), - fixes,speedupand iterators for Python-2.2 (Hannu Krosing)</li> - <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint manupdate(John)</li> + <li>Python: bindings for the new API, packaging (Stéphane Bidoul), + drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup + and iterators for Python-2.2 (Hannu Krosing)</li> + <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update + (John)</li> <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li> <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li> <li>Entities handling fixes</li> - <li>new API to optionally track node creation and - deletion(LukasSchroeder)</li> + <li>new API to optionally track node creation and deletion (Lukas + Schroeder)</li> <li>Added documentation for the XmltextReader interface and some <a href="guidelines.html">XML guidelines</a></li> </ul> @@ -1607,24 +1651,23 @@ base.</p> <h3>2.4.30: Dec 12 2002</h3> <ul> <li>2.4.29 broke the python bindings, rereleasing</li> - <li>Improvement/fixes of the XML API generator, and couple of - minorcodefixes.</li> + <li>Improvement/fixes of the XML API generator, and couple of minor code + fixes.</li> </ul> <h3>2.4.29: Dec 11 2002</h3> <ul> - <li>Windows fixes (Igor): Windows CE port, pthread linking, - pythonbindings(Stéphane Bidoul), Mingw (Magnus Henoch), and export - listupdates</li> + <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings + (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li> <li>Fix for prev in python bindings (ERDI Gergo)</li> <li>Fix for entities handling (Marcus Clarke)</li> - <li>Refactored the XML and HTML dumps to a single code path, - fixedXHTML1dump</li> + <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1 + dump</li> <li>Fix for URI parsing when handling URNs with fragment identifiers</li> <li>Fix for HTTP URL escaping problem</li> <li>added an TextXmlReader (C#) like API (work in progress)</li> - <li>Rewrote the API in XML generation script, includes a C parser - andsavesmore informations needed for C# bindings</li> + <li>Rewrote the API in XML generation script, includes a C parser and saves + more informations needed for C# bindings</li> </ul> <h3>2.4.28: Nov 22 2002</h3> @@ -1641,15 +1684,15 @@ base.</p> <h3>2.4.27: Nov 17 2002</h3> <ul> <li>fixes for the Python bindings</li> - <li>a number of bug fixes: SGML catalogs,xmlParseBalancedChunkMemory(),HTML - parser, Schemas (Charles Bozeman),document fragment support(Christian - Glahn), xmlReconciliateNs (BrianStafford), XPointer,xmlFreeNode(), - xmlSAXParseMemory (Peter Jones),xmlGetNodePath (PetrPajas), entities - processing</li> + <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(), + HTML parser, Schemas (Charles Bozeman), document fragment support + (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer, + xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr + Pajas), entities processing</li> <li>added grep to xmllint --shell</li> <li>VMS update patch from Craig A. Berry</li> - <li>cleanup of the Windows build with support for more - compilers(Igor),better thread support on Windows</li> + <li>cleanup of the Windows build with support for more compilers (Igor), + better thread support on Windows</li> <li>cleanup of Unix Makefiles and spec file</li> <li>Improvements to the documentation (John Fleck)</li> </ul> @@ -1657,27 +1700,27 @@ base.</p> <h3>2.4.26: Oct 18 2002</h3> <ul> <li>Patches for Windows CE port, improvements on Windows paths handling</li> - <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() - ,HTMLserialization, Namespace compliance, and a number of - smallproblems</li> + <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() , + HTML serialization, Namespace compliance, and a number of small + problems</li> </ul> <h3>2.4.25: Sep 26 2002</h3> <ul> - <li>A number of bug fixes: XPath, validation, Python bindings, DOM - andtree,xmlI/O, Html</li> + <li>A number of bug fixes: XPath, validation, Python bindings, DOM and + tree, xmlI/O, Html</li> <li>Serious rewrite of XInclude</li> - <li>Made XML Schemas regexp part of the default build and APIs, smallfixand - improvement of the regexp core</li> + <li>Made XML Schemas regexp part of the default build and APIs, small fix + and improvement of the regexp core</li> <li>Changed the validation code to reuse XML Schemas regexp APIs</li> - <li>Better handling of Windows file paths, improvement of - Makefiles(Igor,Daniel Gehriger, Mark Vakoc)</li> - <li>Improved the python I/O bindings, the tests, added resolver - andregexpAPIs</li> + <li>Better handling of Windows file paths, improvement of Makefiles (Igor, + Daniel Gehriger, Mark Vakoc)</li> + <li>Improved the python I/O bindings, the tests, added resolver and regexp + APIs</li> <li>New logos from Marc Liyanage</li> <li>Tutorial improvements: John Fleck, Christopher Harris</li> - <li>Makefile: Fixes for AMD x86_64 (Mandrake), - DESTDIR(ChristopheMerlet)</li> + <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe + Merlet)</li> <li>removal of all stderr/perror use for error reporting</li> <li>Better error reporting: XPath and DTD validation</li> <li>update of the trio portability layer (Bjorn Reese)</li> @@ -1686,8 +1729,8 @@ base.</p> <p><strong>2.4.24: Aug 22 2002</strong></p> <ul> <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li> - <li>Python binding fixes: makefiles (William), generator, rpm - build,x86-64(fcrozat)</li> + <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64 + (fcrozat)</li> <li>HTML <style> and boolean attributes serializer fixes</li> <li>C14N improvements by Aleksey</li> <li>doc cleanups: Rick Jones</li> @@ -1701,38 +1744,38 @@ base.</p> <li>c14n fixes, testsuite and performances: Aleksey Sanin</li> <li>added xmlDocFormatDump: Chema Celorio</li> <li>new tutorial: John Fleck</li> - <li>new hash functions and performances: Sander Vesik, portability - fixfromPeter Jacobi</li> - <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XMLandHTML - parsers, ID lookup function</li> + <li>new hash functions and performances: Sander Vesik, portability fix from + Peter Jacobi</li> + <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and + HTML parsers, ID lookup function</li> <li>removal of all remaining sprintf: Aleksey Sanin</li> </ul> <h3>2.4.22: May 27 2002</h3> <ul> - <li>a number of bug fixes: configure scripts, base handling, - parser,memoryusage, HTML parser, XPath, documentation - (ChristianCornelssen),indentation, URI parsing</li> - <li>Optimizations for XMLSec, fixing and making public some of - thenetworkprotocol handlers (Aleksey)</li> + <li>a number of bug fixes: configure scripts, base handling, parser, memory + usage, HTML parser, XPath, documentation (Christian Cornelssen), + indentation, URI parsing</li> + <li>Optimizations for XMLSec, fixing and making public some of the network + protocol handlers (Aleksey)</li> <li>performance patch from Gary Pennington</li> - <li>Charles Bozeman provided date and time support for - XMLSchemasdatatypes</li> + <li>Charles Bozeman provided date and time support for XML Schemas + datatypes</li> </ul> <h3>2.4.21: Apr 29 2002</h3> -<p>This release is both a bug fix release and also contains the -earlyXMLSchemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a>and -<a href="http://www.w3.org/TR/xmlschema-2/">datatypes</a>code, -beware,allinterfaces are likely to change, there is huge holes, it is clearly -a workinprogress and don't even think of putting this code in a -productionsystem,it's actually not compiled in by default. The real fixes -are:</p> +<p>This release is both a bug fix release and also contains the early XML +Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a +href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all +interfaces are likely to change, there is huge holes, it is clearly a work in +progress and don't even think of putting this code in a production system, +it's actually not compiled in by default. The real fixes are:</p> <ul> <li>a couple of bugs or limitations introduced in 2.4.20</li> <li>patches for Borland C++ and MSC by Igor</li> - <li>some fixes on XPath strings and conformance patches by RichardJinks</li> + <li>some fixes on XPath strings and conformance patches by Richard + Jinks</li> <li>patch from Aleksey for the ExcC14N specification</li> <li>OSF/1 bug fix by Bjorn</li> </ul> @@ -1741,14 +1784,14 @@ are:</p> <ul> <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li> <li>XPath conformance testing by Richard Jinks</li> - <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, - pythonbindings,libxml.m4</li> + <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings, + libxml.m4</li> </ul> <h3>2.4.19: Mar 25 2002</h3> <ul> - <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin - toUTF8encoder</li> + <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8 + encoder</li> <li>portability fixes in the HTTP code</li> <li>memory allocation checks using valgrind, and profiling tests</li> <li>revamp of the Windows build and Makefiles</li> @@ -1756,8 +1799,8 @@ are:</p> <h3>2.4.18: Mar 18 2002</h3> <ul> - <li>bug fixes: tree, SAX, canonicalization, - validation,portability,XPath</li> + <li>bug fixes: tree, SAX, canonicalization, validation, portability, + XPath</li> <li>removed the --with-buffer option it was becoming unmaintainable</li> <li>serious cleanup of the Python makefiles</li> <li>speedup patch to XPath very effective for DocBook stylesheets</li> @@ -1766,18 +1809,17 @@ are:</p> <h3>2.4.17: Mar 8 2002</h3> <ul> - <li>a lot of bug fixes, including "namespace nodes have no - parentsinXPath"</li> - <li>fixed/improved the Python wrappers, added more examples - andmoreregression tests, XPath extension functions can now - returnnode-sets</li> + <li>a lot of bug fixes, including "namespace nodes have no parents in + XPath"</li> + <li>fixed/improved the Python wrappers, added more examples and more + regression tests, XPath extension functions can now return node-sets</li> <li>added the XML Canonicalization support from Aleksey Sanin</li> </ul> <h3>2.4.16: Feb 20 2002</h3> <ul> - <li>a lot of bug fixes, most of them were triggered by the XMLTestsuitefrom - OASIS and W3C. Compliance has been significantlyimproved.</li> + <li>a lot of bug fixes, most of them were triggered by the XML Testsuite + from OASIS and W3C. Compliance has been significantly improved.</li> <li>a couple of portability fixes too.</li> </ul> @@ -1791,40 +1833,40 @@ are:</p> <h3>2.4.14: Feb 8 2002</h3> <ul> <li>Change of License to the <a - href="http://www.opensource.org/licenses/mit-license.html">MITLicense</a>basicallyfor - integration in XFree86 codebase, and removingconfusion around theprevious - dual-licensing</li> - <li>added Python bindings, beta software but should already - bequitecomplete</li> - <li>a large number of fixes and cleanups, especially for - alltreemanipulations</li> - <li>cleanup of the headers, generation of a reference API - definitioninXML</li> + href="http://www.opensource.org/licenses/mit-license.html">MIT + License</a> basically for integration in XFree86 codebase, and removing + confusion around the previous dual-licensing</li> + <li>added Python bindings, beta software but should already be quite + complete</li> + <li>a large number of fixes and cleanups, especially for all tree + manipulations</li> + <li>cleanup of the headers, generation of a reference API definition in + XML</li> </ul> <h3>2.4.13: Jan 14 2002</h3> <ul> <li>update of the documentation: John Fleck and Charlie Bozeman</li> <li>cleanup of timing code from Justin Fletcher</li> - <li>fixes for Windows and initial thread support on Win32: Igor - andSergueiNarojnyi</li> + <li>fixes for Windows and initial thread support on Win32: Igor and Serguei + Narojnyi</li> <li>Cygwin patch from Robert Collins</li> <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li> </ul> <h3>2.4.12: Dec 7 2001</h3> <ul> - <li>a few bug fixes: thread (Gary Pennington), xmllint - (GeertKloosterman),XML parser (Robin Berjon), XPointer (Danny Jamshy), - I/Ocleanups(robert)</li> + <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman), + XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups + (robert)</li> <li>Eric Lavigne contributed project files for MacOS</li> <li>some makefiles cleanups</li> </ul> <h3>2.4.11: Nov 26 2001</h3> <ul> - <li>fixed a couple of errors in the includes, fixed a few bugs, - somecodecleanups</li> + <li>fixed a couple of errors in the includes, fixed a few bugs, some code + cleanups</li> <li>xmllint man pages improvement by Heiko Rupp</li> <li>updated VMS build instructions from John A Fotheringham</li> <li>Windows Makefiles updates from Igor</li> @@ -1835,8 +1877,8 @@ are:</p> <li>URI escaping fix (Joel Young)</li> <li>added xmlGetNodePath() (for paths or XPointers generation)</li> <li>Fixes namespace handling problems when using DTD and validation</li> - <li>improvements on xmllint: Morus Walter patches for --format - and--encode,Stefan Kost and Heiko Rupp improvements on the --shell</li> + <li>improvements on xmllint: Morus Walter patches for --format and + --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li> <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li> <li>fixes to the HTML parser</li> </ul> @@ -1849,8 +1891,8 @@ are:</p> <h3>2.4.8: Nov 4 2001</h3> <ul> - <li>fixed SGML catalogs broken in previous release, - updatedxmlcatalogtool</li> + <li>fixed SGML catalogs broken in previous release, updated xmlcatalog + tool</li> <li>fixed a compile errors and some includes troubles.</li> </ul> @@ -1858,8 +1900,8 @@ are:</p> <ul> <li>exported some debugging interfaces</li> <li>serious rewrite of the catalog code</li> - <li>integrated Gary Pennington thread safety patch, added - configureoptionand regression tests</li> + <li>integrated Gary Pennington thread safety patch, added configure option + and regression tests</li> <li>removed an HTML parser bug</li> <li>fixed a couple of potentially serious validation bugs</li> <li>integrated the SGML DocBook support in xmllint</li> @@ -1883,19 +1925,20 @@ are:</p> <h3>2.4.5: Sep 14 2001</h3> <ul> <li>Remove a few annoying bugs in 2.4.4</li> - <li>forces the HTML serializer to output decimal charrefs since - someversionof Netscape can't handle hexadecimal ones</li> + <li>forces the HTML serializer to output decimal charrefs since some + version of Netscape can't handle hexadecimal ones</li> </ul> <h3>1.8.16: Sep 14 2001</h3> <ul> - <li>maintenance release of the old libxml1 branch, couple of - bugandportability fixes</li> + <li>maintenance release of the old libxml1 branch, couple of bug and + portability fixes</li> </ul> <h3>2.4.4: Sep 12 2001</h3> <ul> - <li>added --convert to xmlcatalog, bug fixes and cleanups of XMLCatalog</li> + <li>added --convert to xmlcatalog, bug fixes and cleanups of XML + Catalog</li> <li>a few bug fixes and some portability changes</li> <li>some documentation cleanups</li> </ul> @@ -1929,17 +1972,17 @@ are:</p> <h3>2.4.0: July 10 2001</h3> <ul> <li>Fixed a few bugs in XPath, validation, and tree handling.</li> - <li>Fixed XML Base implementation, added a couple of examples - totheregression tests</li> + <li>Fixed XML Base implementation, added a couple of examples to the + regression tests</li> <li>A bit of cleanup</li> </ul> <h3>2.3.14: July 5 2001</h3> <ul> - <li>fixed some entities problems and reduce memory - requirementwhensubstituting them</li> - <li>lots of improvements in the XPath queries interpreter - canbesubstantially faster</li> + <li>fixed some entities problems and reduce memory requirement when + substituting them</li> + <li>lots of improvements in the XPath queries interpreter can be + substantially faster</li> <li>Makefiles and configure cleanups</li> <li>Fixes to XPath variable eval, and compare on empty node set</li> <li>HTML tag closing bug fixed</li> @@ -1965,27 +2008,26 @@ are:</p> <li>fixed line number counting</li> <li>fixed serious problems in the XInclude processing</li> <li>added support for UTF8 BOM at beginning of entities</li> - <li>fixed a strange gcc optimizer bugs in xpath handling of - float,gcc-3.0miscompile uri.c (William), Thomas Leitner provided a fix - fortheoptimizer on Tru64</li> - <li>incorporated Yon Derek and Igor Zlatkovic fixes and - improvementsforcompilation on Windows MSC</li> + <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0 + miscompile uri.c (William), Thomas Leitner provided a fix for the + optimizer on Tru64</li> + <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for + compilation on Windows MSC</li> <li>update of libxml-doc.el (Felix Natter)</li> <li>fixed 2 bugs in URI normalization code</li> </ul> <h3>2.3.11: June 17 2001</h3> <ul> - <li>updates to trio, Makefiles and configure should fix - someportabilityproblems (alpha)</li> - <li>fixed some HTML serialization problems (pre, script, - andblock/inlinehandling), added encoding aware APIs, cleanup of - thiscode</li> + <li>updates to trio, Makefiles and configure should fix some portability + problems (alpha)</li> + <li>fixed some HTML serialization problems (pre, script, and block/inline + handling), added encoding aware APIs, cleanup of this code</li> <li>added xmlHasNsProp()</li> - <li>implemented a specific PI for encoding support in the - DocBookSGMLparser</li> - <li>some XPath fixes (-Infinity, / as a function parameter - andnamespacesnode selection)</li> + <li>implemented a specific PI for encoding support in the DocBook SGML + parser</li> + <li>some XPath fixes (-Infinity, / as a function parameter and namespaces + node selection)</li> <li>fixed a performance problem and an error in the validation code</li> <li>fixed XInclude routine to implement the recursive behaviour</li> <li>fixed xmlFreeNode problem when libxml is included statically twice</li> @@ -1995,8 +2037,8 @@ are:</p> <h3>2.3.10: June 1 2001</h3> <ul> <li>fixed the SGML catalog support</li> - <li>a number of reported bugs got fixed, in XPath, iconv - detection,XIncludeprocessing</li> + <li>a number of reported bugs got fixed, in XPath, iconv detection, + XInclude processing</li> <li>XPath string function should now handle unicode correctly</li> </ul> @@ -2009,8 +2051,8 @@ are:</p> <li>some documentation cleanups</li> <li>trying to get better linking on Solaris (-R)</li> <li>XPath API cleanup from Thomas Broyer</li> - <li>Validation bug fixed #54631, added a patch from Gary - Pennington,fixedxmlValidGetValidElements()</li> + <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed + xmlValidGetValidElements()</li> <li>Added an INSTALL file</li> <li>Attribute removal added to API: #54433</li> <li>added a basic support for SGML catalogs</li> @@ -2029,10 +2071,10 @@ are:</p> <ul> <li>Integrated an SGML DocBook parser for the Gnome project</li> <li>Fixed a few things in the HTML parser</li> - <li>Fixed some XPath bugs raised by XSLT use, tried to fix thefloatingpoint - portability issue</li> - <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s - forDOM+validationusing the XML REC as input and a 700MHz celeron).</li> + <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating + point portability issue</li> + <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for + DOM+validation using the XML REC as input and a 700MHz celeron).</li> <li>incorporated more Windows cleanup</li> <li>added xmlSaveFormatFile()</li> <li>fixed problems in copying nodes with entities references (gdome)</li> @@ -2055,41 +2097,40 @@ are:</p> <h3>2.3.6: April 8 2001</h3> <ul> - <li>Code cleanup using extreme gcc compiler warning options, - foundandcleared half a dozen potential problem</li> + <li>Code cleanup using extreme gcc compiler warning options, found and + cleared half a dozen potential problem</li> <li>the Eazel team found an XML parser bug</li> - <li>cleaned up the user of some of the string formatting function. - usedthetrio library code to provide the one needed when the platform - ismissingthem</li> - <li>xpath: removed a memory leak and fixed the predicate - evaluationproblem,extended the testsuite and cleaned up the result. - XPointer seemsbroken...</li> + <li>cleaned up the user of some of the string formatting function. used the + trio library code to provide the one needed when the platform is missing + them</li> + <li>xpath: removed a memory leak and fixed the predicate evaluation + problem, extended the testsuite and cleaned up the result. XPointer seems + broken ...</li> </ul> <h3>2.3.5: Mar 23 2001</h3> <ul> - <li>Biggest change is separate parsing and evaluation of - XPathexpressions,there is some new APIs for this too</li> - <li>included a number of bug fixes(XML push parser, - 51876,notations,52299)</li> + <li>Biggest change is separate parsing and evaluation of XPath expressions, + there is some new APIs for this too</li> + <li>included a number of bug fixes(XML push parser, 51876, notations, + 52299)</li> <li>Fixed some portability issues</li> </ul> <h3>2.3.4: Mar 10 2001</h3> <ul> <li>Fixed bugs #51860 and #51861</li> - <li>Added a global variable xmlDefaultBufferSize to allow defaultbuffersize - to be application tunable.</li> - <li>Some cleanup in the validation code, still a bug left and - thispartshould probably be rewritten to support ambiguous content - model:-\</li> - <li>Fix a couple of serious bugs introduced or raised by changes - in2.3.3parser</li> + <li>Added a global variable xmlDefaultBufferSize to allow default buffer + size to be application tunable.</li> + <li>Some cleanup in the validation code, still a bug left and this part + should probably be rewritten to support ambiguous content model :-\</li> + <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3 + parser</li> <li>Fixed another bug in xmlNodeGetContent()</li> <li>Bjorn fixed XPath node collection and Number formatting</li> <li>Fixed a loop reported in the HTML parsing</li> - <li>blank space are reported even if the Dtd content model proves - thattheyare formatting spaces, this is for XML conformance</li> + <li>blank space are reported even if the Dtd content model proves that they + are formatting spaces, this is for XML conformance</li> </ul> <h3>2.3.3: Mar 1 2001</h3> @@ -2111,21 +2152,22 @@ are:</p> <h3>2.3.1: Feb 15 2001</h3> <ul> <li>some XPath and HTML bug fixes for XSLT</li> - <li>small extension of the hash table interfaces for - DOMgdome2implementation</li> + <li>small extension of the hash table interfaces for DOM gdome2 + implementation</li> <li>A few bug fixes</li> </ul> <h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3> <ul> <li>Lots of XPath bug fixes</li> - <li>Add a mode with Dtd lookup but without validation error - reportingforXSLT</li> + <li>Add a mode with Dtd lookup but without validation error reporting for + XSLT</li> <li>Add support for text node without escaping (XSLT)</li> <li>bug fixes for xmlCheckFilename</li> <li>validation code bug fixes from Gary Pennington</li> <li>Patch from Paul D. Smith correcting URI path normalization</li> - <li>Patch to allow simultaneous install of libxml-develandlibxml2-devel</li> + <li>Patch to allow simultaneous install of libxml-devel and + libxml2-devel</li> <li>the example Makefile is now fixed</li> <li>added HTML to the RPM packages</li> <li>tree copying bugfixes</li> @@ -2158,8 +2200,8 @@ are:</p> <h3>2.2.8: Nov 13 2000</h3> <ul> - <li>First version of <a - href="http://www.w3.org/TR/xinclude">XInclude</a>support</li> + <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a> + support</li> <li>Patch in conditional section handling</li> <li>updated MS compiler project</li> <li>fixed some XPath problems</li> @@ -2178,12 +2220,12 @@ are:</p> <h3>2.2.6: Oct 25 2000:</h3> <ul> - <li>Added an hash table module, migrated a number of internal - structuretothose</li> + <li>Added an hash table module, migrated a number of internal structure to + those</li> <li>Fixed a posteriori validation problems</li> <li>HTTP module cleanups</li> - <li>HTML parser improvements (tag errors, script/style - handling,attributenormalization)</li> + <li>HTML parser improvements (tag errors, script/style handling, attribute + normalization)</li> <li>coalescing of adjacent text nodes</li> <li>couple of XPath bug fixes, exported the internal API</li> </ul> @@ -2191,10 +2233,10 @@ are:</p> <h3>2.2.5: Oct 15 2000:</h3> <ul> <li>XPointer implementation and testsuite</li> - <li>Lot of XPath fixes, added variable and functions - registration,moretests</li> - <li>Portability fixes, lots of enhancements toward an easy Windows - buildandrelease</li> + <li>Lot of XPath fixes, added variable and functions registration, more + tests</li> + <li>Portability fixes, lots of enhancements toward an easy Windows build + and release</li> <li>Late validation fixes</li> <li>Integrated a lot of contributed patches</li> <li>added memory management docs</li> @@ -2212,10 +2254,10 @@ are:</p> <ul> <li>bug fixes</li> <li>cleanup of entity handling code</li> - <li>overall review of all loops in the parsers, all sprintf usage - hasbeenchecked too</li> - <li>Far better handling of larges Dtd. Validating against DocBook - XMLDtdworks smoothly now.</li> + <li>overall review of all loops in the parsers, all sprintf usage has been + checked too</li> + <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd + works smoothly now.</li> </ul> <h3>1.8.10: Sep 6 2000</h3> @@ -2234,29 +2276,29 @@ are:</p> <li>a purely bug fixes release</li> <li>fixed an encoding support problem when parsing from a memory block</li> <li>fixed a DOCTYPE parsing problem</li> - <li>removed a bug in the function allowing to override the - memoryallocationroutines</li> + <li>removed a bug in the function allowing to override the memory + allocation routines</li> </ul> <h3>2.2.0: July 14 2000</h3> <ul> <li>applied a lot of portability fixes</li> - <li>better encoding support/cleanup and saving (content is nowalwaysencoded - in UTF-8)</li> + <li>better encoding support/cleanup and saving (content is now always + encoded in UTF-8)</li> <li>the HTML parser now correctly handles encodings</li> <li>added xmlHasProp()</li> <li>fixed a serious problem with &#38;</li> <li>propagated the fix to FTP client</li> <li>cleanup, bugfixes, etc ...</li> - <li>Added a page about <a - href="encoding.html">libxmlInternationalizationsupport</a></li> + <li>Added a page about <a href="encoding.html">libxml Internationalization + support</a></li> </ul> <h3>1.8.9: July 9 2000</h3> <ul> <li>fixed the spec the RPMs should be better</li> - <li>fixed a serious bug in the FTP implementation, released 1.8.9 - tosolverpmfind users problem</li> + <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve + rpmfind users problem</li> </ul> <h3>2.1.1: July 1 2000</h3> @@ -2267,17 +2309,17 @@ are:</p> <h3>2.1.0 and 1.8.8: June 29 2000</h3> <ul> - <li>1.8.8 is mostly a commodity package for upgrading to libxml2accordingto - <a href="upgrade.html">new instructions</a>. It fixes a nastyproblemabout - &#38; charref parsing</li> - <li>2.1.0 also ease the upgrade from libxml v1 to the recent version.italso - contains numerous fixes and enhancements: + <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according + to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem + about &#38; charref parsing</li> + <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it + also contains numerous fixes and enhancements: <ul> <li>added xmlStopParser() to stop parsing</li> <li>improved a lot parsing speed when there is large CDATA blocs</li> <li>includes XPath patches provided by Picdar Technology</li> - <li>tried to fix as much as possible DTD validation andnamespacerelated - problems</li> + <li>tried to fix as much as possible DTD validation and namespace + related problems</li> <li>output to a given encoding has been added/tested</li> <li>lot of various fixes</li> </ul> @@ -2286,97 +2328,96 @@ are:</p> <h3>2.0.0: Apr 12 2000</h3> <ul> - <li>First public release of libxml2. If you are using libxml, it's - agoodidea to check the 1.x to 2.x upgrade instructions. NOTE: - whileinitiallyscheduled for Apr 3 the release occurred only on Apr 12 due - tomassiveworkload.</li> - <li>The include are now located under $prefix/include/libxml - (insteadof$prefix/include/gnome-xml), they also are referenced by + <li>First public release of libxml2. If you are using libxml, it's a good + idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially + scheduled for Apr 3 the release occurred only on Apr 12 due to massive + workload.</li> + <li>The include are now located under $prefix/include/libxml (instead of + $prefix/include/gnome-xml), they also are referenced by <pre>#include <libxml/xxx.h></pre> <p>instead of</p> <pre>#include "xxx.h"</pre> </li> <li>a new URI module for parsing URIs and following strictly RFC 2396</li> - <li>the memory allocation routines used by libxml can now - beoverloadeddynamically by using xmlMemSetup()</li> - <li>The previously CVS only tool tester has - beenrenamed<strong>xmllint</strong>and is now installed as part of - thelibxml2package</li> - <li>The I/O interface has been revamped. There is now ways to - pluginspecific I/O modules, either at the URI scheme detection - levelusingxmlRegisterInputCallbacks() or by passing I/O functions - whencreating aparser context using xmlCreateIOParserCtxt()</li> - <li>there is a C preprocessor macro LIBXML_VERSION providing - theversionnumber of the libxml module in use</li> - <li>a number of optional features of libxml can now be excluded - atconfiguretime (FTP/HTTP/HTML/XPath/Debug)</li> + <li>the memory allocation routines used by libxml can now be overloaded + dynamically by using xmlMemSetup()</li> + <li>The previously CVS only tool tester has been renamed + <strong>xmllint</strong> and is now installed as part of the libxml2 + package</li> + <li>The I/O interface has been revamped. There is now ways to plug in + specific I/O modules, either at the URI scheme detection level using + xmlRegisterInputCallbacks() or by passing I/O functions when creating a + parser context using xmlCreateIOParserCtxt()</li> + <li>there is a C preprocessor macro LIBXML_VERSION providing the version + number of the libxml module in use</li> + <li>a number of optional features of libxml can now be excluded at + configure time (FTP/HTTP/HTML/XPath/Debug)</li> </ul> <h3>2.0.0beta: Mar 14 2000</h3> <ul> <li>This is a first Beta release of libxml version 2</li> - <li>It's available only from<a - href="ftp://xmlsoft.org/libxml2/">xmlsoft.orgFTP</a>, it's packaged - aslibxml2-2.0.0beta and available as tar andRPMs</li> - <li>This version is now the head in the Gnome CVS base, the old - oneisavailable under the tag LIB_XML_1_X</li> - <li>This includes a very large set of changes. From a programmatic - pointofview applications should not have to be modified too much, check - the<a href="upgrade.html">upgrade page</a></li> + <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org + FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and + RPMs</li> + <li>This version is now the head in the Gnome CVS base, the old one is + available under the tag LIB_XML_1_X</li> + <li>This includes a very large set of changes. From a programmatic point + of view applications should not have to be modified too much, check the + <a href="upgrade.html">upgrade page</a></li> <li>Some interfaces may changes (especially a bit about encoding).</li> <li>the updates includes: <ul> - <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) - seemscorrectlyhandled now</li> - <li>Better handling of entities, especially well-formedness - checkingandproper PEref extensions in external subsets</li> + <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly + handled now</li> + <li>Better handling of entities, especially well-formedness checking + and proper PEref extensions in external subsets</li> <li>DTD conditional sections</li> <li>Validation now correctly handle entities content</li> - <li><a - href="http://rpmfind.net/tools/gdome/messages/0039.html">changestructuresto - accommodate DOM</a></li> + <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change + structures to accommodate DOM</a></li> </ul> </li> <li>Serious progress were made toward compliance, <a - href="conf/result.html">here are the result of the - test</a>againsttheOASIS testsuite (except the Japanese tests since I - don't supportthatencoding yet). This URL is rebuilt every couple of hours - using theCVShead version.</li> + href="conf/result.html">here are the result of the test</a> against the + OASIS testsuite (except the Japanese tests since I don't support that + encoding yet). This URL is rebuilt every couple of hours using the CVS + head version.</li> </ul> <h3>1.8.7: Mar 6 2000</h3> <ul> <li>This is a bug fix release:</li> - <li>It is possible to disable the ignorable blanks heuristic - usedbylibxml-1.x, a new function xmlKeepBlanksDefault(0) will allow - this.Notethat for adherence to XML spec, this behaviour will be - disabledbydefault in 2.x . The same function will allow to keep - compatibilityforold code.</li> - <li>Blanks in <a> </a> constructs are not - ignoredanymore,avoiding heuristic is really the Right Way :-\</li> - <li>The unchecked use of snprintf which was breakinglibxml-1.8.6compilation - on some platforms has been fixed</li> - <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping - whenprocessingURIs</li> + <li>It is possible to disable the ignorable blanks heuristic used by + libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note + that for adherence to XML spec, this behaviour will be disabled by + default in 2.x . The same function will allow to keep compatibility for + old code.</li> + <li>Blanks in <a> </a> constructs are not ignored anymore, + avoiding heuristic is really the Right Way :-\</li> + <li>The unchecked use of snprintf which was breaking libxml-1.8.6 + compilation on some platforms has been fixed</li> + <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing + URIs</li> </ul> <h3>1.8.6: Jan 31 2000</h3> <ul> <li>added a nanoFTP transport module, debugged until the new version of <a - href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a>canuseit - without troubles</li> + href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use + it without troubles</li> </ul> <h3>1.8.5: Jan 21 2000</h3> <ul> <li>adding APIs to parse a well balanced chunk of XML (production <a - href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a>of - theXMLspec)</li> + href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the + XML spec)</li> <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li> - <li>Jody Goldberg <jgoldberg@home.com> provided another patchtryingto - solve the zlib checks problems</li> - <li>The current state in gnome CVS base is expected to ship as - 1.8.5withgnumeric soon</li> + <li>Jody Goldberg <jgoldberg@home.com> provided another patch trying + to solve the zlib checks problems</li> + <li>The current state in gnome CVS base is expected to ship as 1.8.5 with + gnumeric soon</li> </ul> <h3>1.8.4: Jan 13 2000</h3> @@ -2395,47 +2436,45 @@ are:</p> <li>fixed the DTD parsing code to work with the xhtml DTD</li> <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li> <li>Fixed bugs in xmlNewNs()</li> - <li>External entity loading code has been revamped, now - itusesxmlLoadExternalEntity(), some fix on entities processing - wereadded</li> + <li>External entity loading code has been revamped, now it uses + xmlLoadExternalEntity(), some fix on entities processing were added</li> <li>cleaned up WIN32 includes of socket stuff</li> </ul> <h3>1.8.2: Dec 21 1999</h3> <ul> - <li>I got another problem with includes and C++, I hope this issue - isfixedfor good this time</li> - <li>Added a few tree modification - functions:xmlReplaceNode,xmlAddPrevSibling, xmlAddNextSibling, - xmlNodeSetNameandxmlDocSetRootElement</li> + <li>I got another problem with includes and C++, I hope this issue is fixed + for good this time</li> + <li>Added a few tree modification functions: xmlReplaceNode, + xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and + xmlDocSetRootElement</li> <li>Tried to improve the HTML output with help from <a href="mailto:clahey@umich.edu">Chris Lahey</a></li> </ul> <h3>1.8.1: Dec 18 1999</h3> <ul> - <li>various patches to avoid troubles when using libxml with - C++compilersthe "namespace" keyword and C escaping in include files</li> + <li>various patches to avoid troubles when using libxml with C++ compilers + the "namespace" keyword and C escaping in include files</li> <li>a problem in one of the core macros IS_CHAR was corrected</li> - <li>fixed a bug introduced in 1.8.0 breaking default - namespaceprocessing,and more specifically the Dia application</li> - <li>fixed a posteriori validation (validation after parsing, or by - usingaDtd not specified in the original document)</li> + <li>fixed a bug introduced in 1.8.0 breaking default namespace processing, + and more specifically the Dia application</li> + <li>fixed a posteriori validation (validation after parsing, or by using a + Dtd not specified in the original document)</li> <li>fixed a bug in</li> </ul> <h3>1.8.0: Dec 12 1999</h3> <ul> <li>cleanup, especially memory wise</li> - <li>the parser should be more reliable, especially the HTML one, - itshouldnot crash, whatever the input !</li> - <li>Integrated various patches, especially a speedup improvement - forlargedataset from <a - href="mailto:cnygard@bellatlantic.net">CarlNygard</a>,configure with - --with-buffers to enable them.</li> + <li>the parser should be more reliable, especially the HTML one, it should + not crash, whatever the input !</li> + <li>Integrated various patches, especially a speedup improvement for large + dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>, + configure with --with-buffers to enable them.</li> <li>attribute normalization, oops should have been added long ago !</li> - <li>attributes defaulted from DTDs should be available, xmlSetProp()nowdoes - entities escaping by default.</li> + <li>attributes defaulted from DTDs should be available, xmlSetProp() now + does entities escaping by default.</li> </ul> <h3>1.7.4: Oct 25 1999</h3> @@ -2449,40 +2488,40 @@ are:</p> <h3>1.7.3: Sep 29 1999</h3> <ul> <li>portability problems fixed</li> - <li>snprintf was used unconditionally, leading to link problems - onsystemwere it's not available, fixed</li> + <li>snprintf was used unconditionally, leading to link problems on system + were it's not available, fixed</li> </ul> <h3>1.7.1: Sep 24 1999</h3> <ul> - <li>The basic type for strings manipulated by libxml has been - renamedin1.7.1 from <strong>CHAR</strong>to <strong>xmlChar</strong>. - Thereasonis that CHAR was conflicting with a predefined type on - Windows.Howeveron non WIN32 environment, compatibility is provided by the - way ofa<strong>#define </strong>.</li> - <li>Changed another error : the use of a structure field called - errno,andleading to troubles on platforms where it's a macro</li> + <li>The basic type for strings manipulated by libxml has been renamed in + 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason + is that CHAR was conflicting with a predefined type on Windows. However + on non WIN32 environment, compatibility is provided by the way of a + <strong>#define </strong>.</li> + <li>Changed another error : the use of a structure field called errno, and + leading to troubles on platforms where it's a macro</li> </ul> <h3>1.7.0: Sep 23 1999</h3> <ul> <li>Added the ability to fetch remote DTD or parsed entities, see the <a - href="html/libxml-nanohttp.html">nanohttp</a>module.</li> - <li>Added an errno to report errors by another mean than a simpleprintflike - callback</li> + href="html/libxml-nanohttp.html">nanohttp</a> module.</li> + <li>Added an errno to report errors by another mean than a simple printf + like callback</li> <li>Finished ID/IDREF support and checking when validation</li> <li>Serious memory leaks fixed (there is now a <a - href="html/libxml-xmlmemory.html">memory wrapper</a>module)</li> - <li>Improvement of <a - href="http://www.w3.org/TR/xpath">XPath</a>implementation</li> + href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li> + <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a> + implementation</li> <li>Added an HTML parser front-end</li> </ul> <h2><a name="XML">XML</a></h2> -<p><a href="http://www.w3.org/TR/REC-xml">XML is astandard</a>formarkup-based -structured documents. Here is <a name="example">an example -XMLdocument</a>:</p> +<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for +markup-based structured documents. Here is <a name="example">an example XML +document</a>:</p> <pre><?xml version="1.0"?> <EXAMPLE prop1="gnome is great" prop2="&amp; linux too"> <head> @@ -2496,146 +2535,141 @@ XMLdocument</a>:</p> </chapter> </EXAMPLE></pre> -<p>The first line specifies that it is an XML document and -givesusefulinformation about its encoding. Then the rest of the document is -atextformat whose structure is specified by tags between -brackets.<strong>Eachtag opened has to be closed</strong>. XML is pedantic -about this.However, ifa tag is empty (no content), a single tag can serve as -both theopening andclosing tag if it ends with <code>/></code>rather -thanwith<code>></code>. Note that, for example, the image tag has no -content(justan attribute) and is closed by ending the tag -with<code>/></code>.</p> - -<p>XML can be applied successfully to a wide range of tasks, ranging -fromlongterm structured document maintenance (where it follows the steps -ofSGML) tosimple data encoding mechanisms like configuration file -formatting(glade),spreadsheets (gnumeric), or even shorter lived documents -such asWebDAV whereit is used to encode remote calls between a client and -aserver.</p> +<p>The first line specifies that it is an XML document and gives useful +information about its encoding. Then the rest of the document is a text +format whose structure is specified by tags between brackets. <strong>Each +tag opened has to be closed</strong>. XML is pedantic about this. However, if +a tag is empty (no content), a single tag can serve as both the opening and +closing tag if it ends with <code>/></code> rather than with +<code>></code>. Note that, for example, the image tag has no content (just +an attribute) and is closed by ending the tag with <code>/></code>.</p> + +<p>XML can be applied successfully to a wide range of tasks, ranging from +long term structured document maintenance (where it follows the steps of +SGML) to simple data encoding mechanisms like configuration file formatting +(glade), spreadsheets (gnumeric), or even shorter lived documents such as +WebDAV where it is used to encode remote calls between a client and a +server.</p> <h2><a name="XSLT">XSLT</a></h2> <p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p> -<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is -alanguagefor transforming XML documents into other XML documents -(orHTML/textualoutput).</p> +<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a +language for transforming XML documents into other XML documents (or +HTML/textual output).</p> -<p>A separate library called libxslt is available implementing -XSLT-1.0forlibxml2. This module "libxslt" too can be found in the Gnome CVS -base.</p> +<p>A separate library called libxslt is available implementing XSLT-1.0 for +libxml2. This module "libxslt" too can be found in the Gnome CVS base.</p> <p>You can check the progresses on the libxslt <a href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p> <h2><a name="Python">Python and bindings</a></h2> -<p>There are a number of language bindings and wrappers available -forlibxml2,the list below is not exhaustive. Please contact the <a -href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>(<a -href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) inorder -toget updates to this list or to discuss the specific topic of -libxml2orlibxslt wrappers or bindings:</p> -<ul> - <li><a - href="http://libxmlplusplus.sourceforge.net/">Libxml++</a>seemsthemost - up-to-date C++ bindings for libxml2, check the <a - href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>andthe - <a +<p>There are a number of language bindings and wrappers available for +libxml2, the list below is not exhaustive. Please contact the <a +href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a> +(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in +order to get updates to this list or to discuss the specific topic of libxml2 +or libxslt wrappers or bindings:</p> +<ul> + <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the + most up-to-date C++ bindings for libxml2, check the <a + href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a> + and the <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li> - <li>There is another <a - href="http://libgdome-cpp.berlios.de/">C++wrapperbased on the gdome2 - bindings</a>maintained by Tobias Peters.</li> + <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper + based on the gdome2 bindings</a> maintained by Tobias Peters.</li> <li>and a third C++ wrapper by Peter Jones <pjones@pmade.org> <p>Website: <a href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p> </li> <li><a - href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">MattSergeant</a>developed<a - href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl - wrapperforlibxml2/libxslt as part of the <a - href="http://axkit.com/">AxKitXMLapplication server</a>.</li> + href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt + Sergeant</a> developed <a + href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for + libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML + application server</a>.</li> <li>If you're interested into scripting XML processing, have a look at <a - href="http://xsh.sourceforge.net/">XSH</a>an XML editing shell - basedonLibxml2 Perl bindings.</li> - <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave - Kuhlman</a>providesanearlier version of the libxml/libxslt <a + href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on + Libxml2 Perl bindings.</li> + <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an + earlier version of the libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li> <li>Gopal.V and Peter Minten develop <a - href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a - setofC# libxml2 bindings.</li> + href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of + C# libxml2 bindings.</li> <li>Petr Kozelka provides <a - href="http://sourceforge.net/projects/libxml2-pas">Pascal units - togluelibxml2</a>with Kylix, Delphi and other Pascal compilers.</li> + href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue + libxml2</a> with Kylix, Delphi and other Pascal compilers.</li> <li>Uwe Fechner also provides <a - href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, - aDOM2implementation for Kylix2/D5/D6 from Borland.</li> - <li>There is <a href="http://libxml.rubyforge.org/">bindings forRuby</a>and - libxml2 bindings are also available in Ruby through the <a - href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a>modulemaintainedby - Tobias Peters.</li> + href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2 + implementation for Kylix2/D5/D6 from Borland.</li> + <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a> + and libxml2 bindings are also available in Ruby through the <a + href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module + maintained by Tobias Peters.</li> <li>Steve Ball and contributors maintains <a - href="http://tclxml.sourceforge.net/">libxml2 and libxslt - bindingsforTcl</a>.</li> + href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for + Tcl</a>.</li> <li>libxml2 and libxslt is the default XML library for PHP5.</li> + <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is + an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and + libxslt as part of GNU ClasspathX project.</li> + <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for + <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li> <li><a - href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a>isaneffort - to create a 100% JAXP-compatible Java wrapper for libxml2andlibxslt as - part of GNU ClasspathX project.</li> - <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, - lookfor<a - href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li> - <li><a - href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>provides<a - href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLibosax</a>.This - is an osax for Mac OS X with a set of commands toimplement inAppleScript - the XML DOM, XPATH and XSLT. Also includescommands forProperty-lists - (Apple's fast lookup table XML format.)</li> + href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a> + provides <a + href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib + osax</a>. This is an osax for Mac OS X with a set of commands to + implement in AppleScript the XML DOM, XPATH and XSLT. Also includes + commands for Property-lists (Apple's fast lookup table XML format.)</li> <li>Francesco Montorsi developped <a - href="https://sourceforge.net/project/showfiles.php?group_id=51305&package_id=45182">wxXml2</a>wrappersthat - interface libxml2, allowing wxWidgets applications toload/save/editXML - instances.</li> -</ul> - -<p>The distribution includes a set of Python bindings, which are -guaranteedtobe maintained as part of the library in the future, though -thePythoninterface have not yet reached the completeness of the C API.</p> - -<p>Note that some of the Python purist dislike the default set -ofPythonbindings, rather than complaining I suggest they have a look at <a -href="http://codespeak.net/lxml/">lxml the more pythonic bindings -forlibxml2and libxslt</a>and <a -href="http://codespeak.net/mailman/listinfo/lxml-dev">helpMartijnFaassen</a>complete -those.</p> - -<p><a -href="mailto:stephane.bidoul@softwareag.com">StéphaneBidoul</a>maintains <a -href="http://users.skynet.be/sbi/libxml-python/">aWindows portof the Python -bindings</a>.</p> - -<p>Note to people interested in building bindings, the API is formalized as<a -href="libxml2-api.xml">an XML API description file</a>which allows -toautomatea large part of the Python bindings, this includes -functiondescriptions,enums, structures, typedefs, etc... The Python script -used tobuild thebindings is python/generator.py in the source -distribution.</p> + href="https://sourceforge.net/project/showfiles.php?group_id=51305&package_id=45182">wxXml2</a> + wrappers that interface libxml2, allowing wxWidgets applications to + load/save/edit XML instances.</li> +</ul> + +<p>The distribution includes a set of Python bindings, which are guaranteed +to be maintained as part of the library in the future, though the Python +interface have not yet reached the completeness of the C API.</p> + +<p>Note that some of the Python purist dislike the default set of Python +bindings, rather than complaining I suggest they have a look at <a +href="http://codespeak.net/lxml/">lxml the more pythonic bindings for libxml2 +and libxslt</a> and <a +href="http://codespeak.net/mailman/listinfo/lxml-dev">help Martijn +Faassen</a> complete those.</p> + +<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a> +maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port +of the Python bindings</a>.</p> + +<p>Note to people interested in building bindings, the API is formalized as +<a href="libxml2-api.xml">an XML API description file</a> which allows to +automate a large part of the Python bindings, this includes function +descriptions, enums, structures, typedefs, etc... The Python script used to +build the bindings is python/generator.py in the source distribution.</p> <p>To install the Python bindings there are 2 options:</p> <ul> <li>If you use an RPM based distribution, simply install the <a - href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-pythonRPM</a>(andif - needed the <a - href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-pythonRPM</a>).</li> - <li>Otherwise use the <a - href="ftp://xmlsoft.org/libxml2/python/">libxml2-pythonmoduledistribution</a>corresponding - to your installed version oflibxml2 andlibxslt. Note that to install it - you will need both libxml2and libxsltinstalled and run "python setup.py - build install" in themodule tree.</li> + href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python + RPM</a> (and if needed the <a + href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python + RPM</a>).</li> + <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python + module distribution</a> corresponding to your installed version of + libxml2 and libxslt. Note that to install it you will need both libxml2 + and libxslt installed and run "python setup.py build install" in the + module tree.</li> </ul> -<p>The distribution includes a set of examples and regression tests -forthepython bindings in the <code>python/tests</code>directory. Here -aresomeexcerpts from those tests:</p> +<p>The distribution includes a set of examples and regression tests for the +python bindings in the <code>python/tests</code> directory. Here are some +excerpts from those tests:</p> <h3>tst.py:</h3> @@ -2656,33 +2690,32 @@ if child.name != "foo": sys.exit(1) doc.freeDoc()</pre> -<p>The Python module is called libxml2; parseFile is the -equivalentofxmlParseFile (most of the bindings are automatically generated, -and thexmlprefix is removed and the casing convention are kept). All node -seen atthebinding level share the same subset of accessors:</p> -<ul> - <li><code>name</code>: returns the node name</li> - <li><code>type</code>: returns a string indicating the node type</li> - <li><code>content</code>: returns the content of the node, it is - basedonxmlNodeGetContent() and hence is recursive.</li> - <li><code>parent</code>, - <code>children</code>,<code>last</code>,<code>next</code>, - <code>prev</code>,<code>doc</code>,<code>properties</code>: pointing to - the associatedelement in the tree,those may return None in case no such - linkexists.</li> -</ul> - -<p>Also note the need to explicitly deallocate documents with -freeDoc().Reference counting for libxml2 trees would need quite a lot of -worktofunction properly, and rather than risk memory leaks if -notimplementedcorrectly it sounds safer to have an explicit function to free -atree. Thewrapper python objects like doc, root or child are -themautomatically garbagecollected.</p> +<p>The Python module is called libxml2; parseFile is the equivalent of +xmlParseFile (most of the bindings are automatically generated, and the xml +prefix is removed and the casing convention are kept). All node seen at the +binding level share the same subset of accessors:</p> +<ul> + <li><code>name</code> : returns the node name</li> + <li><code>type</code> : returns a string indicating the node type</li> + <li><code>content</code> : returns the content of the node, it is based on + xmlNodeGetContent() and hence is recursive.</li> + <li><code>parent</code> , <code>children</code>, <code>last</code>, + <code>next</code>, <code>prev</code>, <code>doc</code>, + <code>properties</code>: pointing to the associated element in the tree, + those may return None in case no such link exists.</li> +</ul> + +<p>Also note the need to explicitly deallocate documents with freeDoc() . +Reference counting for libxml2 trees would need quite a lot of work to +function properly, and rather than risk memory leaks if not implemented +correctly it sounds safer to have an explicit function to free a tree. The +wrapper python objects like doc, root or child are them automatically garbage +collected.</p> <h3>validate.py:</h3> -<p>This test check the validation interfaces and redirection -oferrormessages:</p> +<p>This test check the validation interfaces and redirection of error +messages:</p> <pre>import libxml2 #deactivate error messages from the validation @@ -2700,19 +2733,19 @@ doc.freeDoc() if valid != 0: print "validity check failed"</pre> -<p>The first thing to notice is the call to registerErrorHandler(), -itdefinesa new error handler global to the library. It is used to avoid -seeingtheerror messages when trying to validate the invalid document.</p> +<p>The first thing to notice is the call to registerErrorHandler(), it +defines a new error handler global to the library. It is used to avoid seeing +the error messages when trying to validate the invalid document.</p> -<p>The main interest of that test is the creation of a parser -contextwithcreateFileParserCtxt() and how the behaviour can be changed -beforecallingparseDocument() . Similarly the informations resulting from -theparsing phaseare also available using context methods.</p> +<p>The main interest of that test is the creation of a parser context with +createFileParserCtxt() and how the behaviour can be changed before calling +parseDocument() . Similarly the informations resulting from the parsing phase +are also available using context methods.</p> -<p>Contexts like nodes are defined as class and the libxml2 wrappers mapstheC -function interfaces in terms of objects method as much as possible.Thebest to -get a complete view of what methods are supported is to look atthelibxml2.py -module containing all the wrappers.</p> +<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the +C function interfaces in terms of objects method as much as possible. The +best to get a complete view of what methods are supported is to look at the +libxml2.py module containing all the wrappers.</p> <h3>push.py:</h3> @@ -2725,21 +2758,19 @@ doc = ctxt.doc() doc.freeDoc()</pre> -<p>The context is created with a special call based -onthexmlCreatePushParser() from the C library. The first argument is -anoptionalSAX callback object, then the initial set of data, the length and -thename ofthe resource in case URI-References need to be computed by -theparser.</p> +<p>The context is created with a special call based on the +xmlCreatePushParser() from the C library. The first argument is an optional +SAX callback object, then the initial set of data, the length and the name of +the resource in case URI-References need to be computed by the parser.</p> -<p>Then the data are pushed using the parseChunk() method, the -lastcallsetting the third argument terminate to 1.</p> +<p>Then the data are pushed using the parseChunk() method, the last call +setting the third argument terminate to 1.</p> <h3>pushSAX.py:</h3> -<p>this test show the use of the event based parsing interfaces. In -thiscasethe parser does not build a document, but provides callback -informationasthe parser makes progresses analyzing the data being -provided:</p> +<p>this test show the use of the event based parsing interfaces. In this case +the parser does not build a document, but provides callback information as +the parser makes progresses analyzing the data being provided:</p> <pre>import libxml2 log = "" @@ -2790,18 +2821,17 @@ if log != reference: print "Error got: %s" % log print "Expected: %s" % reference</pre> -<p>The key object in that test is the handler, it provides a number -ofentrypoints which can be called by the parser as it makes progresses -toindicatethe information set obtained. The full set of callback is larger -thanwhatthe callback class in that specific example implements (see -theSAXdefinition for a complete list). The wrapper will only call those -suppliedbythe object when activated. The startElement receives the names of -theelementand a dictionary containing the attributes carried by this -element.</p> +<p>The key object in that test is the handler, it provides a number of entry +points which can be called by the parser as it makes progresses to indicate +the information set obtained. The full set of callback is larger than what +the callback class in that specific example implements (see the SAX +definition for a complete list). The wrapper will only call those supplied by +the object when activated. The startElement receives the names of the element +and a dictionary containing the attributes carried by this element.</p> -<p>Also note that the reference string generated from the callback -showsasingle character call even though the string "bar" is passed to -theparserfrom 2 different call to parseChunk()</p> +<p>Also note that the reference string generated from the callback shows a +single character call even though the string "bar" is passed to the parser +from 2 different call to parseChunk()</p> <h3>xpath.py:</h3> @@ -2820,19 +2850,18 @@ if res[0].name != "doc" or res[1].name != "foo": doc.freeDoc() ctxt.xpathFreeContext()</pre> -<p>This test parses a file, then create an XPath context to -evaluateXPathexpression on it. The xpathEval() method execute an XPath query -andreturnsthe result mapped in a Python way. String and numbers are -nativelyconverted,and node sets are returned as a tuple of libxml2 Python -nodeswrappers. Likethe document, the XPath context need to be freed -explicitly,also not thatthe result of the XPath query may point back to the -documenttree and hencethe document must be freed after the result of the -query isused.</p> +<p>This test parses a file, then create an XPath context to evaluate XPath +expression on it. The xpathEval() method execute an XPath query and returns +the result mapped in a Python way. String and numbers are natively converted, +and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like +the document, the XPath context need to be freed explicitly, also not that +the result of the XPath query may point back to the document tree and hence +the document must be freed after the result of the query is used.</p> <h3>xpathext.py:</h3> -<p>This test shows how to extend the XPath engine with functions -writteninpython:</p> +<p>This test shows how to extend the XPath engine with functions written in +python:</p> <pre>import libxml2 def foo(ctx, x): @@ -2847,14 +2876,13 @@ if res != 2: doc.freeDoc() ctxt.xpathFreeContext()</pre> -<p>Note how the extension function is registered with the context -(butthatpart is not yet finalized, this may change slightly in the -future).</p> +<p>Note how the extension function is registered with the context (but that +part is not yet finalized, this may change slightly in the future).</p> <h3>tstxpath.py:</h3> -<p>This test is similar to the previous one but shows how -theextensionfunction can access the XPath evaluation context:</p> +<p>This test is similar to the previous one but shows how the extension +function can access the XPath evaluation context:</p> <pre>def foo(ctx, x): global called @@ -2866,9 +2894,9 @@ theextensionfunction can access the XPath evaluation context:</p> called = ctxt.function() return x + 1</pre> -<p>All the interfaces around the XPath parser(or rather evaluation)contextare -not finalized, but it should be sufficient to do contextual workat -theevaluation point.</p> +<p>All the interfaces around the XPath parser(or rather evaluation) context +are not finalized, but it should be sufficient to do contextual work at the +evaluation point.</p> <h3>Memory debugging:</h3> @@ -2885,15 +2913,15 @@ else: print "Memory leak %d bytes" % (libxml2.debugMemory(1)) libxml2.dumpMemory()</pre> -<p>Those activate the memory debugging interface of libxml2 whereallallocated -block in the library are tracked. The prologue then cleans upthelibrary state -and checks that all allocated memory has been freed. If notitcalls -dumpMemory() which saves that list in a <code>.memdump</code>file.</p> +<p>Those activate the memory debugging interface of libxml2 where all +allocated block in the library are tracked. The prologue then cleans up the +library state and checks that all allocated memory has been freed. If not it +calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p> <h2><a name="architecture">libxml2 architecture</a></h2> -<p>Libxml2 is made of multiple components; some of them are optional, -andmostof the block interfaces are public. The main components are:</p> +<p>Libxml2 is made of multiple components; some of them are optional, and +most of the block interfaces are public. The main components are:</p> <ul> <li>an Input/Output layer</li> <li>FTP and HTTP client layers (optional)</li> @@ -2904,7 +2932,8 @@ andmostof the block interfaces are public. The main components are:</p> <li>a SAX tree module to build an in-memory DOM representation</li> <li>a tree module to manipulate the DOM representation</li> <li>a validation module using the DOM representation (optional)</li> - <li>an XPath module for global lookup in a DOM representation(optional)</li> + <li>an XPath module for global lookup in a DOM representation + (optional)</li> <li>a debug module (optional)</li> </ul> @@ -2916,29 +2945,28 @@ andmostof the block interfaces are public. The main components are:</p> <h2><a name="tree">The tree output</a></h2> -<p>The parser returns a tree built during the document analysis. -Thevaluereturned is an <strong>xmlDocPtr</strong>(i.e., a pointer -toan<strong>xmlDoc</strong>structure). This structure contains -informationsuchas the file name, the document type, and -a<strong>children</strong>pointerwhich is the root of the document (or -moreexactly the first child under theroot which is the document). The tree -ismade of <strong>xmlNode</strong>s,chained in double-linked lists of -siblingsand with a children<->parentrelationship. An xmlNode can also -carryproperties (a chain of xmlAttrstructures). An attribute may have a -valuewhich is a list of TEXT orENTITY_REF nodes.</p> +<p>The parser returns a tree built during the document analysis. The value +returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an +<strong>xmlDoc</strong> structure). This structure contains information such +as the file name, the document type, and a <strong>children</strong> pointer +which is the root of the document (or more exactly the first child under the +root which is the document). The tree is made of <strong>xmlNode</strong>s, +chained in double-linked lists of siblings and with a children<->parent +relationship. An xmlNode can also carry properties (a chain of xmlAttr +structures). An attribute may have a value which is a list of TEXT or +ENTITY_REF nodes.</p> -<p>Here is an example (erroneous with respect to the XML spec -sincethereshould be only one ELEMENT under the root):</p> +<p>Here is an example (erroneous with respect to the XML spec since there +should be only one ELEMENT under the root):</p> <p><img src="structure.gif" alt=" structure.gif "></p> -<p>In the source package there is a small program (not installed -bydefault)called <strong>xmllint</strong>which parses XML files given -asargument andprints them back as parsed. This is useful for detecting -errorsboth in XMLcode and in the XML parser itself. It has an -option<strong>--debug</strong>which prints the actual in-memory structure of -thedocument; here is theresult with the <a -href="#example">example</a>givenbefore:</p> +<p>In the source package there is a small program (not installed by default) +called <strong>xmllint</strong> which parses XML files given as argument and +prints them back as parsed. This is useful for detecting errors both in XML +code and in the XML parser itself. It has an option <strong>--debug</strong> +which prints the actual in-memory structure of the document; here is the +result with the <a href="#example">example</a> given before:</p> <pre>DOCUMENT version=1.0 standalone=true @@ -2973,23 +3001,24 @@ standalone=true <h2><a name="interface">The SAX interface</a></h2> -<p>Sometimes the DOM tree output is just too large to fit -reasonablyintomemory. In that case (and if you don't expect to save back the -XMLdocumentloaded using libxml), it's better to use the SAX interface of -libxml.SAX isa <strong>callback-based interface</strong>to the parser. -Beforeparsing,the application layer registers a customized set of callbacks -whicharecalled by the library as it progresses through the XML input.</p> - -<p>To get more detailed step-by-step guidance on using the SAX -interfaceoflibxml, see the <a -href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nicedocumentation</a>.writtenby -<a href="mailto:james@daa.com.au">JamesHenstridge</a>.</p> - -<p>You can debug the SAX behaviour by using -the<strong>testSAX</strong>program located in the gnome-xml module (it's -usuallynot shipped in thebinary packages of libxml, but you can find it in -the tarsourcedistribution). Here is the sequence of callbacks that would be -reportedbytestSAX when parsing the example XML document shown earlier:</p> +<p>Sometimes the DOM tree output is just too large to fit reasonably into +memory. In that case (and if you don't expect to save back the XML document +loaded using libxml), it's better to use the SAX interface of libxml. SAX is +a <strong>callback-based interface</strong> to the parser. Before parsing, +the application layer registers a customized set of callbacks which are +called by the library as it progresses through the XML input.</p> + +<p>To get more detailed step-by-step guidance on using the SAX interface of +libxml, see the <a +href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice +documentation</a>.written by <a href="mailto:james@daa.com.au">James +Henstridge</a>.</p> + +<p>You can debug the SAX behaviour by using the <strong>testSAX</strong> +program located in the gnome-xml module (it's usually not shipped in the +binary packages of libxml, but you can find it in the tar source +distribution). Here is the sequence of callbacks that would be reported by +testSAX when parsing the example XML document shown earlier:</p> <pre>SAX.setDocumentLocator() SAX.startDocument() SAX.getEntity(amp) @@ -3025,11 +3054,11 @@ SAX.characters( , 1) SAX.endElement(EXAMPLE) SAX.endDocument()</pre> -<p>Most of the other interfaces of libxml2 are based on the -DOMtree-buildingfacility, so nearly everything up to the end of this -documentpresupposes theuse of the standard DOM tree build. Note that the DOM -treeitself is built bya set of registered default callbacks, without -internalspecificinterface.</p> +<p>Most of the other interfaces of libxml2 are based on the DOM tree-building +facility, so nearly everything up to the end of this document presupposes the +use of the standard DOM tree build. Note that the DOM tree itself is built by +a set of registered default callbacks, without internal specific +interface.</p> <h2><a name="Validation">Validation & DTDs</a></h2> @@ -3053,70 +3082,67 @@ internalspecificinterface.</p> <p>Well what is validation and what is a DTD ?</p> -<p>DTD is the acronym for Document Type Definition. This is a -descriptionofthe content for a family of XML files. This is part of the -XML1.0specification, and allows one to describe and verify that a -givendocumentinstance conforms to the set of rules detailing its structure -andcontent.</p> +<p>DTD is the acronym for Document Type Definition. This is a description of +the content for a family of XML files. This is part of the XML 1.0 +specification, and allows one to describe and verify that a given document +instance conforms to the set of rules detailing its structure and content.</p> -<p>Validation is the process of checking a document against a -DTD(moregenerally against a set of construction rules).</p> +<p>Validation is the process of checking a document against a DTD (more +generally against a set of construction rules).</p> -<p>The validation process and building DTDs are the two most difficultpartsof -the XML life cycle. Briefly a DTD defines all the possible elementsto befound -within your document, what is the formal shape of your documenttree(by -defining the allowed content of an element; either text, aregularexpression -for the allowed list of children, or mixed content i.e.both textand -children). The DTD also defines the valid attributes for allelements andthe -types of those attributes.</p> +<p>The validation process and building DTDs are the two most difficult parts +of the XML life cycle. Briefly a DTD defines all the possible elements to be +found within your document, what is the formal shape of your document tree +(by defining the allowed content of an element; either text, a regular +expression for the allowed list of children, or mixed content i.e. both text +and children). The DTD also defines the valid attributes for all elements and +the types of those attributes.</p> <h3><a name="definition1">The definition</a></h3> -<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a>(<a -href="http://www.xml.com/axml/axml.html">Tim Bray's annotated -versionofRev1</a>):</p> +<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a +href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of +Rev1</a>):</p> <ul> - <li><a - href="http://www.w3.org/TR/REC-xml#elemdecls">Declaringelements</a></li> - <li><a - href="http://www.w3.org/TR/REC-xml#attdecls">Declaringattributes</a></li> + <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring + elements</a></li> + <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring + attributes</a></li> </ul> -<p>(unfortunately) all this is inherited from the SGML world, the -syntaxisancient...</p> +<p>(unfortunately) all this is inherited from the SGML world, the syntax is +ancient...</p> <h3><a name="Simple1">Simple rules</a></h3> -<p>Writing DTDs can be done in many ways. The rules to build them if -youneedsomething permanent or something which can evolve over time can -beradicallydifferent. Really complex DTDs like DocBook ones are flexible -butquiteharder to design. I will just focus on DTDs for a formats with a -fixedsimplestructure. It is just a set of basic rules, and definitely -notexhaustive norusable for complex DTD design.</p> +<p>Writing DTDs can be done in many ways. The rules to build them if you need +something permanent or something which can evolve over time can be radically +different. Really complex DTDs like DocBook ones are flexible but quite +harder to design. I will just focus on DTDs for a formats with a fixed simple +structure. It is just a set of basic rules, and definitely not exhaustive nor +usable for complex DTD design.</p> <h4><a name="reference1">How to reference a DTD from a document</a>:</h4> -<p>Assuming the top element of the document is <code>spec</code>and the -dtdisplaced in the file <code>mydtd</code>in the -subdirectory<code>dtds</code>ofthe directory from where the document were -loaded:</p> +<p>Assuming the top element of the document is <code>spec</code> and the dtd +is placed in the file <code>mydtd</code> in the subdirectory +<code>dtds</code> of the directory from where the document were loaded:</p> <p><code><!DOCTYPE spec SYSTEM "dtds/mydtd"></code></p> <p>Notes:</p> <ul> <li>The system string is actually an URI-Reference (as defined in <a - href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can - useafull URL string indicating the location of your DTD on the Web. This - isareally good thing to do if you want others to validate - yourdocument.</li> - <li>It is also possible to associate a <code>PUBLIC</code>identifier(amagic - string) so that the DTD is looked up in catalogs on the clientsidewithout - having to locate it on the web.</li> - <li>A DTD contains a set of element and attribute declarations, - buttheydon't define what the root of the document should be. This - isexplicitlytold to the parser/validator as the first element - ofthe<code>DOCTYPE</code>declaration.</li> + href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a + full URL string indicating the location of your DTD on the Web. This is a + really good thing to do if you want others to validate your document.</li> + <li>It is also possible to associate a <code>PUBLIC</code> identifier (a + magic string) so that the DTD is looked up in catalogs on the client side + without having to locate it on the web.</li> + <li>A DTD contains a set of element and attribute declarations, but they + don't define what the root of the document should be. This is explicitly + told to the parser/validator as the first element of the + <code>DOCTYPE</code> declaration.</li> </ul> <h4><a name="Declaring2">Declaring elements</a>:</h4> @@ -3125,29 +3151,29 @@ loaded:</p> <p><code><!ELEMENT spec (front, body, back?)></code></p> -<p>It also expresses that the spec element contains one<code>front</code>,one -<code>body</code>and one optional<code>back</code>children elements inthis -order. The declaration of oneelement of the structure and its contentare done -in a single declaration.Similarly the following -declares<code>div1</code>elements:</p> +<p>It also expresses that the spec element contains one <code>front</code>, +one <code>body</code> and one optional <code>back</code> children elements in +this order. The declaration of one element of the structure and its content +are done in a single declaration. Similarly the following declares +<code>div1</code> elements:</p> <p><code><!ELEMENT div1 (head, (p | list | note)*, div2?)></code></p> -<p>which means div1 contains one <code>head</code>then a series -ofoptional<code>p</code>, <code>list</code>s and <code>note</code>s and -thenanoptional <code>div2</code>. And last but not least an element -cancontaintext:</p> +<p>which means div1 contains one <code>head</code> then a series of optional +<code>p</code>, <code>list</code>s and <code>note</code>s and then an +optional <code>div2</code>. And last but not least an element can contain +text:</p> <p><code><!ELEMENT b (#PCDATA)></code></p> -<p><code>b</code>contains text or being of mixed content (text and -elementsinno particular order):</p> +<p><code>b</code> contains text or being of mixed content (text and elements +in no particular order):</p> <p><code><!ELEMENT p (#PCDATA|a|ul|b|i|em)*></code></p> -<p><code>p </code>can contain text or -<code>a</code>,<code>ul</code>,<code>b</code>, <code>i </code>or -<code>em</code>elements inno particularorder.</p> +<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>, +<code>b</code>, <code>i </code>or <code>em</code> elements in no particular +order.</p> <h4><a name="Declaring1">Declaring attributes</a>:</h4> @@ -3155,82 +3181,83 @@ elementsinno particular order):</p> <p><code><!ATTLIST termdef name CDATA #IMPLIED></code></p> -<p>means that the element <code>termdef</code>can have -a<code>name</code>attribute containing text (<code>CDATA</code>) and which -isoptional(<code>#IMPLIED</code>). The attribute value can also be -definedwithin aset:</p> +<p>means that the element <code>termdef</code> can have a <code>name</code> +attribute containing text (<code>CDATA</code>) and which is optional +(<code>#IMPLIED</code>). The attribute value can also be defined within a +set:</p> -<p><code><!ATTLIST list -type(bullets|ordered|glossary)"ordered"></code></p> +<p><code><!ATTLIST list type (bullets|ordered|glossary) +"ordered"></code></p> -<p>means <code>list</code>element have a <code>type</code>attribute -with3allowed values "bullets", "ordered" or "glossary" and which -defaultto"ordered" if the attribute is not explicitly specified.</p> +<p>means <code>list</code> element have a <code>type</code> attribute with 3 +allowed values "bullets", "ordered" or "glossary" and which default to +"ordered" if the attribute is not explicitly specified.</p> -<p>The content type of an attribute can be -text(<code>CDATA</code>),anchor/reference/references(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>),entity(ies)(<code>ENTITY</code>/<code>ENTITIES</code>) -orname(s)(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following -definesthat a<code>chapter</code>element can have an -optional<code>id</code>attributeof type <code>ID</code>, usable for reference -fromattribute of typeIDREF:</p> +<p>The content type of an attribute can be text (<code>CDATA</code>), +anchor/reference/references +(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies) +(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s) +(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a +<code>chapter</code> element can have an optional <code>id</code> attribute +of type <code>ID</code>, usable for reference from attribute of type +IDREF:</p> <p><code><!ATTLIST chapter id ID #IMPLIED></code></p> -<p>The last value of an attribute definition can -be<code>#REQUIRED</code>meaning that the attribute has to be -given,<code>#IMPLIED</code>meaning that it is optional, or the default -value(possibly prefixed by<code>#FIXED</code>if it is the only allowed).</p> +<p>The last value of an attribute definition can be <code>#REQUIRED +</code>meaning that the attribute has to be given, <code>#IMPLIED</code> +meaning that it is optional, or the default value (possibly prefixed by +<code>#FIXED</code> if it is the only allowed).</p> <p>Notes:</p> <ul> - <li>Usually the attributes pertaining to a given element are declared - inasingle expression, but it is just a convention adopted by a lot - ofDTDwriters: + <li>Usually the attributes pertaining to a given element are declared in a + single expression, but it is just a convention adopted by a lot of DTD + writers: <pre><!ATTLIST termdef id ID #REQUIRED name CDATA #IMPLIED></pre> - <p>The previous construct defines - both<code>id</code>and<code>name</code>attributes for the - element<code>termdef</code>.</p> + <p>The previous construct defines both <code>id</code> and + <code>name</code> attributes for the element <code>termdef</code>.</p> </li> </ul> <h3><a name="Some1">Some examples</a></h3> -<p>The directory <code>test/valid/dtds/</code>in the -libxml2distributioncontains some complex DTD examples. The example in -thefile<code>test/valid/dia.xml</code>shows an XML file where the simple -DTDisdirectly included within the document.</p> +<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution +contains some complex DTD examples. The example in the file +<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is +directly included within the document.</p> <h3><a name="validate1">How to validate</a></h3> -<p>The simplest way is to use the xmllint program included with -libxml.The<code>--valid</code>option turns-on validation of the files given -asinput.For example the following validates a copy of the first revision of -theXML1.0 specification:</p> +<p>The simplest way is to use the xmllint program included with libxml. The +<code>--valid</code> option turns-on validation of the files given as input. +For example the following validates a copy of the first revision of the XML +1.0 specification:</p> <p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p> <p>the -- noout is used to disable output of the resulting tree.</p> -<p>The <code>--dtdvalid dtd</code>allows validation of the -document(s)againsta given DTD.</p> +<p>The <code>--dtdvalid dtd</code> allows validation of the document(s) +against a given DTD.</p> <p>Libxml2 exports an API to handle DTDs and validation, check the <a -href="http://xmlsoft.org/html/libxml-valid.html">associateddescription</a>.</p> +href="http://xmlsoft.org/html/libxml-valid.html">associated +description</a>.</p> <h3><a name="Other1">Other resources</a></h3> -<p>DTDs are as old as SGML. So there may be a number of examples -on-line,Iwill just list one for now, others pointers welcome:</p> +<p>DTDs are as old as SGML. So there may be a number of examples on-line, I +will just list one for now, others pointers welcome:</p> <ul> <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li> </ul> -<p>I suggest looking at the examples found under test/valid/dtd and any -ofthelarge number of books available on XML. The dia example in -test/validshouldbe both simple and complete enough to allow you to build your -own.</p> +<p>I suggest looking at the examples found under test/valid/dtd and any of +the large number of books available on XML. The dia example in test/valid +should be both simple and complete enough to allow you to build your own.</p> <p></p> @@ -3248,182 +3275,180 @@ own.</p> <h3><a name="General3">General overview</a></h3> <p>The module <code><a -href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>providesthe -interfaces to the libxml2 memory system:</p> +href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code> +provides the interfaces to the libxml2 memory system:</p> <ul> - <li>libxml2 does not use the libc memory allocator directly - butxmlFree(),xmlMalloc() and xmlRealloc()</li> - <li>those routines can be reallocated to a specific set of - routine,bydefault the libc ones i.e. free(), malloc() and realloc()</li> + <li>libxml2 does not use the libc memory allocator directly but xmlFree(), + xmlMalloc() and xmlRealloc()</li> + <li>those routines can be reallocated to a specific set of routine, by + default the libc ones i.e. free(), malloc() and realloc()</li> <li>the xmlmemory.c module includes a set of debugging routine</li> </ul> <h3><a name="setting">Setting libxml2 set of memory routines</a></h3> -<p>It is sometimes useful to not use the default memory allocator, -eitherfordebugging, analysis or to implement a specific behaviour on -memorymanagement(like on embedded systems). Two function calls are available -to doso:</p> +<p>It is sometimes useful to not use the default memory allocator, either for +debugging, analysis or to implement a specific behaviour on memory management +(like on embedded systems). Two function calls are available to do so:</p> <ul> + <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet + ()</a> which return the current set of functions in use by the parser</li> <li><a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet()</a>whichreturn - the current set of functions in use by the parser</li> - <li><a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>whichallow - to set up a new set of memory allocation functions</li> + href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a> + which allow to set up a new set of memory allocation functions</li> </ul> -<p>Of course a call to xmlMemSetup() should probably be done beforecallingany -other libxml2 routines (unless you are sure your allocationsroutines -arecompatibles).</p> +<p>Of course a call to xmlMemSetup() should probably be done before calling +any other libxml2 routines (unless you are sure your allocations routines are +compatibles).</p> <h3><a name="cleanup">Cleaning up after parsing</a></h3> -<p>Libxml2 is not stateless, there is a few set of memory -structuresneedingallocation before the parser is fully functional (some -encodingstructuresfor example). This also mean that once parsing is finished -there isa tinyamount of memory (a few hundred bytes) which can be recollected -if youdon'treuse the parser immediately:</p> +<p>Libxml2 is not stateless, there is a few set of memory structures needing +allocation before the parser is fully functional (some encoding structures +for example). This also mean that once parsing is finished there is a tiny +amount of memory (a few hundred bytes) which can be recollected if you don't +reuse the parser immediately:</p> <ul> - <li><a - href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser()</a>isa - centralized routine to free the parsing states. Note that - itwon'tdeallocate any produced tree if any (use the xmlFreeDoc() - andrelatedroutines for this).</li> - <li><a - href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser()</a>isthe - dual routine allowing to preallocate the parsing statewhich can beuseful - for example to avoid initialization reentrancyproblems when usinglibxml2 - in multithreaded applications</li> + <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser + ()</a> is a centralized routine to free the parsing states. Note that it + won't deallocate any produced tree if any (use the xmlFreeDoc() and + related routines for this).</li> + <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser + ()</a> is the dual routine allowing to preallocate the parsing state + which can be useful for example to avoid initialization reentrancy + problems when using libxml2 in multithreaded applications</li> </ul> -<p>Generally xmlCleanupParser() is safe, if needed the state will berebuildat -the next invocation of parser routines, but be careful of theconsequencesin -multithreaded applications.</p> +<p>Generally xmlCleanupParser() is safe, if needed the state will be rebuild +at the next invocation of parser routines, but be careful of the consequences +in multithreaded applications.</p> <h3><a name="Debugging">Debugging routines</a></h3> -<p>When configured using --with-mem-debug flag (off by default), libxml2usesa -set of memory allocation debugging routines keeping track of -allallocatedblocks and the location in the code where the routine was called. -Acouple ofother debugging routines allow to dump the memory allocated infos -toa fileor call a specific routine when a given block number is allocated:</p> +<p>When configured using --with-mem-debug flag (off by default), libxml2 uses +a set of memory allocation debugging routines keeping track of all allocated +blocks and the location in the code where the routine was called. A couple of +other debugging routines allow to dump the memory allocated infos to a file +or call a specific routine when a given block number is allocated:</p> <ul> <li><a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a><a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>and<a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>arethe - memory debugging replacement allocation routines</li> - <li><a - href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump()</a>dumpsall - the informations about the allocated memory block leftsin - the<code>.memdump</code>file</li> -</ul> - -<p>When developing libxml2 memory debug is enabled, the tests -programscallxmlMemoryDump () and the "make test" regression tests will check -foranymemory leak during the full regression test sequence, this helps -alotensuring that libxml2 does not leak memory and bullet -proofmemoryallocations use (some libc implementations are known to be far -toopermissiveresulting in major portability problems!).</p> - -<p>If the .memdump reports a leak, it displays the allocation functionandalso -tries to give some informations about the content and structure -oftheallocated blocks left. This is sufficient in most cases to find -theculprit,but not always. Assuming the allocation problem is reproducible, -itispossible to find more easily:</p> + href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a> + <a + href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a> + and <a + href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a> + are the memory debugging replacement allocation routines</li> + <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump + ()</a> dumps all the informations about the allocated memory block lefts + in the <code>.memdump</code> file</li> +</ul> + +<p>When developing libxml2 memory debug is enabled, the tests programs call +xmlMemoryDump () and the "make test" regression tests will check for any +memory leak during the full regression test sequence, this helps a lot +ensuring that libxml2 does not leak memory and bullet proof memory +allocations use (some libc implementations are known to be far too permissive +resulting in major portability problems!).</p> + +<p>If the .memdump reports a leak, it displays the allocation function and +also tries to give some informations about the content and structure of the +allocated blocks left. This is sufficient in most cases to find the culprit, +but not always. Assuming the allocation problem is reproducible, it is +possible to find more easily:</p> <ol> <li>write down the block number xxxx not allocated</li> - <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , - theeasiestwhen using GDB is to simply give the command + <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest + when using GDB is to simply give the command <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p> <p>before running the program.</p> </li> - <li>run the program under a debugger and set a - breakpointonxmlMallocBreakpoint() a specific function called when this - preciseblockis allocated</li> - <li>when the breakpoint is reached you can then do a fine analysis - oftheallocation an step to see the condition resulting in - themissingdeallocation.</li> + <li>run the program under a debugger and set a breakpoint on + xmlMallocBreakpoint() a specific function called when this precise block + is allocated</li> + <li>when the breakpoint is reached you can then do a fine analysis of the + allocation an step to see the condition resulting in the missing + deallocation.</li> </ol> -<p>I used to use a commercial tool to debug libxml2 memory problems -butafternoticing that it was not detecting memory leaks that simple -mechanismwasused and proved extremely efficient until now. Lately I have also -used <a href="http://developer.kde.org/~sewardj/">valgrind</a>with quite -somesuccess,it is tied to the i386 architecture since it works by emulating -theprocessorand instruction set, it is slow but extremely efficient, i.e. -itspot memoryusage errors in a very precise way.</p> +<p>I used to use a commercial tool to debug libxml2 memory problems but after +noticing that it was not detecting memory leaks that simple mechanism was +used and proved extremely efficient until now. Lately I have also used <a +href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some +success, it is tied to the i386 architecture since it works by emulating the +processor and instruction set, it is slow but extremely efficient, i.e. it +spot memory usage errors in a very precise way.</p> <h3><a name="General4">General memory requirements</a></h3> -<p>How much libxml2 memory require ? It's hard to tell in average itdependsof -a number of things:</p> -<ul> - <li>the parser itself should work in a fixed amount of memory, - exceptforinformation maintained about the stacks of names and - entitieslocations.The I/O and encoding handlers will probably account for - a fewKBytes.This is true for both the XML and HTML parser (though the - HTMLparserneed more state).</li> - <li>If you are generating the DOM tree then memory requirements - willgrownearly linear with the size of the data. In general for - abalancedtextual document the internal memory requirement is about 4 - timesthesize of the UTF8 serialization of this document (example - theXML-1.0recommendation is a bit more of 150KBytes and takes 650KBytes - ofmainmemory when parsed). Validation will add a amount of memory - requiredformaintaining the external Dtd state which should be linear - withthecomplexity of the content model defined by the Dtd</li> - <li>If you need to work with fixed memory requirements or don't needthefull - DOM tree then using the <a href="xmlreader.html">xmlReaderinterface</a>is - probably the best way toproceed, it still allows tovalidate or operate on - subset of the tree ifneeded.</li> - <li>If you don't care about the advanced features of libxml2likevalidation, - DOM, XPath or XPointer, don't use entities, need to workwithfixed memory - requirements, and try to get the fastest parsingpossiblethen the SAX - interface should be used, but it has knownrestrictions.</li> +<p>How much libxml2 memory require ? It's hard to tell in average it depends +of a number of things:</p> +<ul> + <li>the parser itself should work in a fixed amount of memory, except for + information maintained about the stacks of names and entities locations. + The I/O and encoding handlers will probably account for a few KBytes. + This is true for both the XML and HTML parser (though the HTML parser + need more state).</li> + <li>If you are generating the DOM tree then memory requirements will grow + nearly linear with the size of the data. In general for a balanced + textual document the internal memory requirement is about 4 times the + size of the UTF8 serialization of this document (example the XML-1.0 + recommendation is a bit more of 150KBytes and takes 650KBytes of main + memory when parsed). Validation will add a amount of memory required for + maintaining the external Dtd state which should be linear with the + complexity of the content model defined by the Dtd</li> + <li>If you need to work with fixed memory requirements or don't need the + full DOM tree then using the <a href="xmlreader.html">xmlReader + interface</a> is probably the best way to proceed, it still allows to + validate or operate on subset of the tree if needed.</li> + <li>If you don't care about the advanced features of libxml2 like + validation, DOM, XPath or XPointer, don't use entities, need to work with + fixed memory requirements, and try to get the fastest parsing possible + then the SAX interface should be used, but it has known restrictions.</li> </ul> <p></p> <h2><a name="Encodings">Encodings support</a></h2> -<p>If you are not really familiar with Internationalization (usual -shortcutisI18N) , Unicode, characters and glyphs, I suggest you read a <a -href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>byTim -Bray on Unicode and why you should care about it.</p> +<p>If you are not really familiar with Internationalization (usual shortcut +is I18N) , Unicode, characters and glyphs, I suggest you read a <a +href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a> +by Tim Bray on Unicode and why you should care about it.</p> -<p>If you don't understand why <b>it does not make sense to have -astringwithout knowing what encoding it uses</b>, then as Joel Spolsky said -<a href="http://www.joelonsoftware.com/articles/Unicode.html">please do -notwriteanother line of code until you finish reading that article.</a>. It -isaprerequisite to understand this page, and avoid a lot of -problemswithlibxml2, XML or text processing in general.</p> +<p>If you don't understand why <b>it does not make sense to have a string +without knowing what encoding it uses</b>, then as Joel Spolsky said <a +href="http://www.joelonsoftware.com/articles/Unicode.html">please do not +write another line of code until you finish reading that article.</a>. It is +a prerequisite to understand this page, and avoid a lot of problems with +libxml2, XML or text processing in general.</p> <p>Table of Content:</p> <ol> - <li><a href="encoding.html#What">What does internationalization - supportmean?</a></li> - <li><a href="encoding.html#internal">The internal encoding, - howandwhy</a></li> + <li><a href="encoding.html#What">What does internationalization support + mean ?</a></li> + <li><a href="encoding.html#internal">The internal encoding, how and + why</a></li> <li><a href="encoding.html#implemente">How is it implemented ?</a></li> <li><a href="encoding.html#Default">Default supported encodings</a></li> - <li><a href="encoding.html#extend">How to extend theexistingsupport</a></li> + <li><a href="encoding.html#extend">How to extend the existing + support</a></li> </ol> <h3><a name="What">What does internationalization support mean ?</a></h3> -<p>XML was designed from the start to allow the support of any charactersetby -using Unicode. Any conformant XML parser has to support the UTF-8andUTF-16 -default encodings which can both express the full unicode ranges.UTF8is a -variable length encoding whose greatest points are to reuse thesameencoding -for ASCII and to save space for Western encodings, but it is abitmore complex -to handle in practice. UTF-16 use 2 bytes per character(andsometimes combines -two pairs), it makes implementation easier, but looksabit overkill for -Western languages encoding. Moreover the XMLspecificationallows the document -to be encoded in other encodings at thecondition thatthey are clearly labeled -as such. For example the following isa wellformedXML document encoded in -ISO-8859-1 and using accentuated lettersthat weFrench like for both markup -and content:</p> +<p>XML was designed from the start to allow the support of any character set +by using Unicode. Any conformant XML parser has to support the UTF-8 and +UTF-16 default encodings which can both express the full unicode ranges. UTF8 +is a variable length encoding whose greatest points are to reuse the same +encoding for ASCII and to save space for Western encodings, but it is a bit +more complex to handle in practice. UTF-16 use 2 bytes per character (and +sometimes combines two pairs), it makes implementation easier, but looks a +bit overkill for Western languages encoding. Moreover the XML specification +allows the document to be encoded in other encodings at the condition that +they are clearly labeled as such. For example the following is a wellformed +XML document encoded in ISO-8859-1 and using accentuated letters that we +French like for both markup and content:</p> <pre><?xml version="1.0" encoding="ISO-8859-1"?> <très>là</très></pre> @@ -3433,18 +3458,18 @@ and content:</p> <li>informations about it's encoding are saved</li> <li>it can be modified</li> <li>it can be saved in its original encoding</li> - <li>it can also be saved in another encoding supported by - libxml2(forexample straight UTF8 or even an ASCII form)</li> + <li>it can also be saved in another encoding supported by libxml2 (for + example straight UTF8 or even an ASCII form)</li> </ul> -<p>Another very important point is that the whole libxml2 API, -withtheexception of a few routines to read with a specific encoding or save -toaspecific encoding, is completely agnostic about the original encoding -ofthedocument.</p> +<p>Another very important point is that the whole libxml2 API, with the +exception of a few routines to read with a specific encoding or save to a +specific encoding, is completely agnostic about the original encoding of the +document.</p> -<p>It should be noted too that the HTML parser embedded in libxml2 nowobeythe -same rules too, the following document will be (as of 2.2.2) handledinan -internationalized fashion by libxml2 too:</p> +<p>It should be noted too that the HTML parser embedded in libxml2 now obey +the same rules too, the following document will be (as of 2.2.2) handled in +an internationalized fashion by libxml2 too:</p> <pre><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <html lang="fr"> @@ -3457,75 +3482,73 @@ internationalized fashion by libxml2 too:</p> <h3><a name="internal">The internal encoding, how and why</a></h3> -<p>One of the core decisions was to force all documents to be converted -toadefault internal encoding, and that encoding to be UTF-8, here -aretherationales for those choices:</p> -<ul> - <li>keeping the native encoding in the internal form would force - thelibxmlusers (or the code associated) to be fully aware of the encoding - oftheoriginal document, for examples when adding a text node to - adocument,the content would have to be provided in the document - encoding,i.e. theclient code would have to check it before hand, make - sure it'sconformantto the encoding, etc ... Very hard in practice, though - in somespecificcases this may make sense.</li> - <li>the second decision was which encoding. From the XML spec only - UTF8andUTF16 really makes sense as being the two only encodings for - whichthereis mandatory support. UCS-4 (32 bits fixed size encoding) - couldbeconsidered an intelligent choice too since it's a direct - Unicodemappingsupport. I selected UTF-8 on the basis of efficiency - andcompatibilitywith surrounding software: +<p>One of the core decisions was to force all documents to be converted to a +default internal encoding, and that encoding to be UTF-8, here are the +rationales for those choices:</p> +<ul> + <li>keeping the native encoding in the internal form would force the libxml + users (or the code associated) to be fully aware of the encoding of the + original document, for examples when adding a text node to a document, + the content would have to be provided in the document encoding, i.e. the + client code would have to check it before hand, make sure it's conformant + to the encoding, etc ... Very hard in practice, though in some specific + cases this may make sense.</li> + <li>the second decision was which encoding. From the XML spec only UTF8 and + UTF16 really makes sense as being the two only encodings for which there + is mandatory support. UCS-4 (32 bits fixed size encoding) could be + considered an intelligent choice too since it's a direct Unicode mapping + support. I selected UTF-8 on the basis of efficiency and compatibility + with surrounding software: <ul> - <li>UTF-8 while a bit more complex to convert from/to (i.e.slightlymore - costly to import and export CPU wise) is also far morecompactthan - UTF-16 (and UCS-4) for a majority of the documents I seeit usedfor - right now (RPM RDF catalogs, advogato data, variousconfigurationfile - formats, etc.) and the key point for today'scomputerarchitecture is - efficient uses of caches. If one nearlydouble thememory requirement - to store the same amount of data, thiswill trashcaches (main - memory/external caches/internal caches) and mytake isthat this harms - the system far more than the CPU requirementsneededfor the conversion - to UTF-8</li> - <li>Most of libxml2 version 1 users were using it with - straightASCIImost of the time, doing the conversion with an - internalencodingrequiring all their code to be rewritten was a - seriousshow-stopperfor using UTF-16 or UCS-4.</li> - <li>UTF-8 is being used as the de-facto internal encoding - standardforrelated code like the <a - href="http://www.pango.org/">pango</a>upcoming Gnome text widget, - anda lot of Unix code (yet another placewhere Unix programmer base - takesa different approach from Microsoft- they are using UTF-16)</li> + <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly + more costly to import and export CPU wise) is also far more compact + than UTF-16 (and UCS-4) for a majority of the documents I see it used + for right now (RPM RDF catalogs, advogato data, various configuration + file formats, etc.) and the key point for today's computer + architecture is efficient uses of caches. If one nearly double the + memory requirement to store the same amount of data, this will trash + caches (main memory/external caches/internal caches) and my take is + that this harms the system far more than the CPU requirements needed + for the conversion to UTF-8</li> + <li>Most of libxml2 version 1 users were using it with straight ASCII + most of the time, doing the conversion with an internal encoding + requiring all their code to be rewritten was a serious show-stopper + for using UTF-16 or UCS-4.</li> + <li>UTF-8 is being used as the de-facto internal encoding standard for + related code like the <a href="http://www.pango.org/">pango</a> + upcoming Gnome text widget, and a lot of Unix code (yet another place + where Unix programmer base takes a different approach from Microsoft + - they are using UTF-16)</li> </ul> </li> </ul> <p>What does this mean in practice for the libxml2 user:</p> <ul> - <li>xmlChar, the libxml2 data type is a byte, those bytes must - beassembledas UTF-8 valid strings. The proper way to terminate an xmlChar - *stringis simply to append 0 byte, as usual.</li> - <li>One just need to make sure that when using chars outside the - ASCIIset,the values has been properly converted to UTF-8</li> + <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled + as UTF-8 valid strings. The proper way to terminate an xmlChar * string + is simply to append 0 byte, as usual.</li> + <li>One just need to make sure that when using chars outside the ASCII set, + the values has been properly converted to UTF-8</li> </ul> <h3><a name="implemente">How is it implemented ?</a></h3> -<p>Let's describe how all this works within libxml, basically -theI18N(internationalization) support get triggered only during I/O -operation,i.e.when reading a document or saving one. Let's look first at -thereadingsequence:</p> +<p>Let's describe how all this works within libxml, basically the I18N +(internationalization) support get triggered only during I/O operation, i.e. +when reading a document or saving one. Let's look first at the reading +sequence:</p> <ol> - <li>when a document is processed, we usually don't know the - encoding,asimple heuristic allows to detect UTF-16 and UCS-4 from - encodingswherethe ASCII range (0-0x7F) maps with ASCII</li> - <li>the xml declaration if available is parsed, including - theencodingdeclaration. At that point, if the autodetected encoding - isdifferentfrom the one declared a call to xmlSwitchEncoding() - isissued.</li> - <li>If there is no encoding declaration, then the input has to be - ineitherUTF-8 or UTF-16, if it is not then at some point when - processingtheinput, the converter/checker of UTF-8 form will raise an - encodingerror.You may end-up with a garbled document, or no document at - all !Example: + <li>when a document is processed, we usually don't know the encoding, a + simple heuristic allows to detect UTF-16 and UCS-4 from encodings where + the ASCII range (0-0x7F) maps with ASCII</li> + <li>the xml declaration if available is parsed, including the encoding + declaration. At that point, if the autodetected encoding is different + from the one declared a call to xmlSwitchEncoding() is issued.</li> + <li>If there is no encoding declaration, then the input has to be in either + UTF-8 or UTF-16, if it is not then at some point when processing the + input, the converter/checker of UTF-8 form will raise an encoding error. + You may end-up with a garbled document, or no document at all ! Example: <pre>~/XML -> ./xmllint err.xml err.xml:1: error: Input is not proper UTF-8, indicate encoding ! <très>là</très> @@ -3534,58 +3557,58 @@ err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C <très>là</très> ^</pre> </li> - <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize - it,andthen search the default registered encoding converters for - thatencoding.If it's not within the default set and iconv() support has - beencompiledit, it will ask iconv for such an encoder. If this fails then - theparserwill report an error and stops processing: + <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and + then search the default registered encoding converters for that encoding. + If it's not within the default set and iconv() support has been compiled + it, it will ask iconv for such an encoder. If this fails then the parser + will report an error and stops processing: <pre>~/XML -> ./xmllint err2.xml err2.xml:1: error: Unsupported encoding UnsupportedEnc <?xml version="1.0" encoding="UnsupportedEnc"?> ^</pre> </li> - <li>From that point the encoder processes progressively the input - (itisplugged as a front-end to the I/O module) for that entity. - Itcapturesand converts on-the-fly the document to be parsed to UTF-8. - Theparseritself just does UTF-8 checking of this input and - processittransparently. The only difference is that the encoding - informationhasbeen added to the parsing context (more precisely to - theinputcorresponding to this entity).</li> - <li>The result (when using DOM) is an internal form completely in - UTF-8withjust an encoding information on the document node.</li> + <li>From that point the encoder processes progressively the input (it is + plugged as a front-end to the I/O module) for that entity. It captures + and converts on-the-fly the document to be parsed to UTF-8. The parser + itself just does UTF-8 checking of this input and process it + transparently. The only difference is that the encoding information has + been added to the parsing context (more precisely to the input + corresponding to this entity).</li> + <li>The result (when using DOM) is an internal form completely in UTF-8 + with just an encoding information on the document node.</li> </ol> -<p>Ok then what happens when saving the document (assuming -youcollected/builtan xmlDoc DOM like structure) ? It depends on the -functioncalled,xmlSaveFile() will just try to save in the original -encoding,whilexmlSaveFileTo() and xmlSaveFileEnc() can optionally save to -agivenencoding:</p> +<p>Ok then what happens when saving the document (assuming you +collected/built an xmlDoc DOM like structure) ? It depends on the function +called, xmlSaveFile() will just try to save in the original encoding, while +xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given +encoding:</p> <ol> - <li>if no encoding is given, libxml2 will look for an - encodingvalueassociated to the document and if it exists will try to save - tothatencoding, + <li>if no encoding is given, libxml2 will look for an encoding value + associated to the document and if it exists will try to save to that + encoding, <p>otherwise everything is written in the internal form, i.e. UTF-8</p> </li> - <li>so if an encoding was specified, either at the API level or - onthedocument, libxml2 will again canonicalize the encoding name, - lookupfor aconverter in the registered set or through iconv. If not - foundthefunction will return an error code</li> - <li>the converter is placed before the I/O buffer layer, as another - kindofbuffer, then libxml2 will simply push the UTF-8 serialization - tothroughthat buffer, which will then progressively be converted and - pushedontothe I/O layer.</li> - <li>It is possible that the converter code fails on some input, - forexampletrying to push an UTF-8 encoded Chinese character through - theUTF-8 toISO-8859-1 converter won't work. Since the encoders - areprogressive theywill just report the error and the number of - bytesconverted, at thatpoint libxml2 will decode the offending - character,remove it from thebuffer and replace it with the associated - charRefencoding &#123; andresume the conversion. This guarantees that - anydocument will be savedwithout losses (except for markup names where - thisis not legal, this isa problem in the current version, in practice - avoidusing non-asciicharacters for tag or attribute names). A special - "ascii"encoding nameis used to save documents to a pure ascii form can be - usedwhenportability is really crucial</li> + <li>so if an encoding was specified, either at the API level or on the + document, libxml2 will again canonicalize the encoding name, lookup for a + converter in the registered set or through iconv. If not found the + function will return an error code</li> + <li>the converter is placed before the I/O buffer layer, as another kind of + buffer, then libxml2 will simply push the UTF-8 serialization to through + that buffer, which will then progressively be converted and pushed onto + the I/O layer.</li> + <li>It is possible that the converter code fails on some input, for example + trying to push an UTF-8 encoded Chinese character through the UTF-8 to + ISO-8859-1 converter won't work. Since the encoders are progressive they + will just report the error and the number of bytes converted, at that + point libxml2 will decode the offending character, remove it from the + buffer and replace it with the associated charRef encoding &#123; and + resume the conversion. This guarantees that any document will be saved + without losses (except for markup names where this is not legal, this is + a problem in the current version, in practice avoid using non-ascii + characters for tag or attribute names). A special "ascii" encoding name + is used to save documents to a pure ascii form can be used when + portability is really crucial</li> </ol> <p>Here are a few examples based on the same test document:</p> @@ -3594,51 +3617,52 @@ agivenencoding:</p> <très>là</très> ~/XML -> ./xmllint --encode UTF-8 isolat1 <?xml version="1.0" encoding="UTF-8"?> -<très>là </très> +<très>là </très> ~/XML -> </pre> -<p>The same processing is applied (and reuse most of the code) for -HTMLI18Nprocessing. Looking up and modifying the content encoding is a -bitmoredifficult since it is located in a <meta> tag under -the<head>,so a couple of functions htmlGetMetaEncoding() -andhtmlSetMetaEncoding() havebeen provided. The parser also attempts to -switchencoding on the fly whendetecting such a tag on input. Except for that -theprocessing is the same(and again reuses the same code).</p> +<p>The same processing is applied (and reuse most of the code) for HTML I18N +processing. Looking up and modifying the content encoding is a bit more +difficult since it is located in a <meta> tag under the <head>, +so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have +been provided. The parser also attempts to switch encoding on the fly when +detecting such a tag on input. Except for that the processing is the same +(and again reuses the same code).</p> <h3><a name="Default">Default supported encodings</a></h3> -<p>libxml2 has a set of default converters for the followingencodings(located -in encoding.c):</p> +<p>libxml2 has a set of default converters for the following encodings +(located in encoding.c):</p> <ol> <li>UTF-8 is supported by default (null handlers)</li> <li>UTF-16, both little and big endian</li> <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li> <li>ASCII, useful mostly for saving</li> - <li>HTML, a specific handler for the conversion of UTF-8 to ASCII - withHTMLpredefined entities like &copy; for the Copyright sign.</li> + <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML + predefined entities like &copy; for the Copyright sign.</li> </ol> -<p>More over when compiled on an Unix platform with iconv support the -fullsetof encodings supported by iconv can be instantly be used by libxml. On -alinuxmachine with glibc-2.1 the list of supported encodings and aliases -fill3 fullpages, and include UCS-4, the full set of ISO-Latin encodings, and -thevariousJapanese ones.</p> +<p>More over when compiled on an Unix platform with iconv support the full +set of encodings supported by iconv can be instantly be used by libxml. On a +linux machine with glibc-2.1 the list of supported encodings and aliases fill +3 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the +various Japanese ones.</p> -<p>To convert from the UTF-8 values returned from the API to -anotherencodingthen it is possible to use the function provided from <a -href="html/libxml-encoding.html">the encoding module</a>like <a -href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or -usethePOSIX <a -href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>APIdirectly.</p> +<p>To convert from the UTF-8 values returned from the API to another encoding +then it is possible to use the function provided from <a +href="html/libxml-encoding.html">the encoding module</a> like <a +href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the +POSIX <a +href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a> +API directly.</p> <h4>Encoding aliases</h4> -<p>From 2.2.3, libxml2 has support to register encoding names aliases.Thegoal -is to be able to parse document whose encoding is supported butwherethe name -differs (for example from the default set of names acceptedbyiconv). The -following functions allow to register and handle new aliasesforexisting -encodings. Once registered libxml2 will automatically lookupthealiases when -handling a document:</p> +<p>From 2.2.3, libxml2 has support to register encoding names aliases. The +goal is to be able to parse document whose encoding is supported but where +the name differs (for example from the default set of names accepted by +iconv). The following functions allow to register and handle new aliases for +existing encodings. Once registered libxml2 will automatically lookup the +aliases when handling a document:</p> <ul> <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li> <li>int xmlDelEncodingAlias(const char *alias);</li> @@ -3648,14 +3672,14 @@ handling a document:</p> <h3><a name="extend">How to extend the existing support</a></h3> -<p>Well adding support for new encoding, or overriding one of -theencoders(assuming it is buggy) should not be hard, just write input -andoutputconversion routines to/from UTF-8, and register -themusingxmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they -willbecalled automatically if the parser(s) encounter such an -encodingname(register it uppercase, this will help). The description of -theencoders,their arguments and expected return values are described in -theencoding.hheader.</p> +<p>Well adding support for new encoding, or overriding one of the encoders +(assuming it is buggy) should not be hard, just write input and output +conversion routines to/from UTF-8, and register them using +xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be +called automatically if the parser(s) encounter such an encoding name +(register it uppercase, this will help). The description of the encoders, +their arguments and expected return values are described in the encoding.h +header.</p> <h2><a name="IO">I/O Interfaces</a></h2> @@ -3672,92 +3696,91 @@ theencoding.hheader.</p> <h3><a name="General1">General overview</a></h3> <p>The module <code><a -href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code>providestheinterfaces -to the libxml2 I/O system. This consists of 4 main parts:</p> -<ul> - <li>Entities loader, this is a routine which tries to fetch - theentities(files) based on their PUBLIC and SYSTEM identifiers. The - defaultloaderdon't look at the public identifier since libxml2 do not - maintainacatalog. You can redefine you own entity loader - byusing<code>xmlGetExternalEntityLoader()</code>and<code>xmlSetExternalEntityLoader()</code>.<a - href="#entities">Check theexample</a>.</li> - <li>Input I/O buffers which are a commodity structure used by - theparser(s)input layer to handle fetching the informations to feed - theparser. Thisprovides buffering and is also a placeholder where - theencodingconverters to UTF8 are piggy-backed.</li> - <li>Output I/O buffers are similar to the Input ones and fulfillsimilartask - but when generating a serialization from a tree.</li> - <li>A mechanism to register sets of I/O callbacks and associate - themwithspecific naming schemes like the protocol part of the URIs. - <p>This affect the default I/O operations and allows to use - specificI/Ohandlers for certain names.</p> +href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides +the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p> +<ul> + <li>Entities loader, this is a routine which tries to fetch the entities + (files) based on their PUBLIC and SYSTEM identifiers. The default loader + don't look at the public identifier since libxml2 do not maintain a + catalog. You can redefine you own entity loader by using + <code>xmlGetExternalEntityLoader()</code> and + <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the + example</a>.</li> + <li>Input I/O buffers which are a commodity structure used by the parser(s) + input layer to handle fetching the informations to feed the parser. This + provides buffering and is also a placeholder where the encoding + converters to UTF8 are piggy-backed.</li> + <li>Output I/O buffers are similar to the Input ones and fulfill similar + task but when generating a serialization from a tree.</li> + <li>A mechanism to register sets of I/O callbacks and associate them with + specific naming schemes like the protocol part of the URIs. + <p>This affect the default I/O operations and allows to use specific I/O + handlers for certain names.</p> </li> </ul> -<p>The general mechanism used when loading -http://rpmfind.net/xml.htmlforexample in the HTML parser is the following:</p> +<p>The general mechanism used when loading http://rpmfind.net/xml.html for +example in the HTML parser is the following:</p> <ol> - <li>The default entity loader - calls<code>xmlNewInputFromFile()</code>withthe parsing context and the - URIstring.</li> - <li>the URI string is checked against the existing registered - handlersusingtheir match() callback function, if the HTTP module was - compiledin, it isregistered and its match() function will succeeds</li> - <li>the open() function of the handler is called and if - successfulwillreturn an I/O Input buffer</li> - <li>the parser will the start reading from this buffer - andprogressivelyfetch information from the resource, calling the - read()function of thehandler until the resource is exhausted</li> - <li>if an encoding change is detected it will be installed on - theinputbuffer, providing buffering and efficient use of - theconversionroutines</li> - <li>once the parser has finished, the close() function of the - handleriscalled once and the Input buffer and associated - resourcesaredeallocated.</li> + <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with + the parsing context and the URI string.</li> + <li>the URI string is checked against the existing registered handlers + using their match() callback function, if the HTTP module was compiled + in, it is registered and its match() function will succeeds</li> + <li>the open() function of the handler is called and if successful will + return an I/O Input buffer</li> + <li>the parser will the start reading from this buffer and progressively + fetch information from the resource, calling the read() function of the + handler until the resource is exhausted</li> + <li>if an encoding change is detected it will be installed on the input + buffer, providing buffering and efficient use of the conversion + routines</li> + <li>once the parser has finished, the close() function of the handler is + called once and the Input buffer and associated resources are + deallocated.</li> </ol> -<p>The user defined callbacks are checked first to allow overriding -ofthedefault libxml2 I/O routines.</p> +<p>The user defined callbacks are checked first to allow overriding of the +default libxml2 I/O routines.</p> <h3><a name="basic">The basic buffer type</a></h3> -<p>All the buffer manipulation handling is done -usingthe<code>xmlBuffer</code>type define in <code><a -href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a></code>which -isaresizable memory buffer. The buffer allocation strategy can be selected -tobeeither best-fit or use an exponential doubling one (CPU vs. -memoryusetrade-off). The values -are<code>XML_BUFFER_ALLOC_EXACT</code>and<code>XML_BUFFER_ALLOC_DOUBLEIT</code>,and -can be set individually or on asystem wide basis -using<code>xmlBufferSetAllocationScheme()</code>. A numberof functions allows -tomanipulate buffers with names starting -withthe<code>xmlBuffer...</code>prefix.</p> +<p>All the buffer manipulation handling is done using the +<code>xmlBuffer</code> type define in <code><a +href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a +resizable memory buffer. The buffer allocation strategy can be selected to be +either best-fit or use an exponential doubling one (CPU vs. memory use +trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and +<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a +system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number +of functions allows to manipulate buffers with names starting with the +<code>xmlBuffer...</code> prefix.</p> <h3><a name="Input">Input I/O handlers</a></h3> -<p>An Input I/O handler is a -simplestructure<code>xmlParserInputBuffer</code>containing a context -associated totheresource (file descriptor, or pointer to a protocol handler), -the read()andclose() callbacks to use and an xmlBuffer. And extra xmlBuffer -and acharsetencoding handler are also present to support charset -conversionwhenneeded.</p> +<p>An Input I/O handler is a simple structure +<code>xmlParserInputBuffer</code> containing a context associated to the +resource (file descriptor, or pointer to a protocol handler), the read() and +close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset +encoding handler are also present to support charset conversion when +needed.</p> <h3><a name="Output">Output I/O handlers</a></h3> -<p>An Output handler <code>xmlOutputBuffer</code>is completely similar -toanInput one except the callbacks are write() and close().</p> +<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an +Input one except the callbacks are write() and close().</p> <h3><a name="entities">The entities loader</a></h3> -<p>The entity loader resolves requests for new entities and create -inputsforthe parser. Creating an input from a filename or an URI string -isdonethrough the xmlNewInputFromFile() routine. The default entity loader -donothandle the PUBLIC identifier associated with an entity (if any). So -itjustcalls xmlNewInputFromFile() with the SYSTEM identifier (which -ismandatory inXML).</p> +<p>The entity loader resolves requests for new entities and create inputs for +the parser. Creating an input from a filename or an URI string is done +through the xmlNewInputFromFile() routine. The default entity loader do not +handle the PUBLIC identifier associated with an entity (if any). So it just +calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in +XML).</p> -<p>If you want to hook up a catalog mechanism then you simply need -tooverridethe default entity loader, here is an example:</p> +<p>If you want to hook up a catalog mechanism then you simply need to +override the default entity loader, here is an example:</p> <pre>#include <libxml/xmlIO.h> xmlExternalEntityLoader defaultLoader = NULL; @@ -3791,29 +3814,29 @@ int main(..) { <h3><a name="Example2">Example of customized I/O</a></h3> -<p>This example come from <a -href="http://xmlsoft.org/messages/0708.html">areal use case</a>,xmlDocDump() -closes the FILE * passed by the applicationand this was aproblem. The <a -href="http://xmlsoft.org/messages/0711.html">solution</a>wasto redefine anew -output handler with the closing call deactivated:</p> +<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a +real use case</a>, xmlDocDump() closes the FILE * passed by the application +and this was a problem. The <a +href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a +new output handler with the closing call deactivated:</p> <ol> - <li>First define a new I/O output allocator where the output don't - closethefile: + <li>First define a new I/O output allocator where the output don't close + the file: <pre>xmlOutputBufferPtr xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) { - xmlOutputBufferPtr ret; - - if (xmlOutputCallbackInitialized == 0) - xmlRegisterDefaultOutputCallbacks(); - - if (file == NULL) return(NULL); - ret = xmlAllocOutputBuffer(encoder); - if (ret != NULL) { - ret->context = file; - ret->writecallback = xmlFileWrite; - ret->closecallback = NULL; /* No close callback */ - } - return(ret); + xmlOutputBufferPtr ret; + + if (xmlOutputCallbackInitialized == 0) + xmlRegisterDefaultOutputCallbacks(); + + if (file == NULL) return(NULL); + ret = xmlAllocOutputBuffer(encoder); + if (ret != NULL) { + ret->context = file; + ret->writecallback = xmlFileWrite; + ret->closecallback = NULL; /* No close callback */ + } + return(ret); } </pre> </li> <li>And then use it to save the document: @@ -3842,92 +3865,90 @@ res = xmlSaveFileTo(output, doc, NULL); <li><a href="#reference">How to tune catalog usage</a></li> <li><a href="#validate">How to debug catalog processing</a></li> <li><a href="#Declaring">How to create and maintain catalogs</a></li> - <li><a href="#implemento">The implementor corner quick review - oftheAPI</a></li> + <li><a href="#implemento">The implementor corner quick review of the + API</a></li> <li><a href="#Other">Other resources</a></li> </ol> <h3><a name="General2">General overview</a></h3> -<p>What is a catalog? Basically it's a lookup mechanism used when an -entity(afile or a remote resource) references another entity. The catalog -lookupisinserted between the moment the reference is recognized by the -software(XMLparser, stylesheet processing, or even images referenced for -inclusionin arendering) and the time where loading that resource is -actuallystarted.</p> +<p>What is a catalog? Basically it's a lookup mechanism used when an entity +(a file or a remote resource) references another entity. The catalog lookup +is inserted between the moment the reference is recognized by the software +(XML parser, stylesheet processing, or even images referenced for inclusion +in a rendering) and the time where loading that resource is actually +started.</p> <p>It is basically used for 3 things:</p> <ul> - <li>mapping from "logical" names, the public identifiers and a - moreconcretename usable for download (and URI). For example it can - associatethelogical name + <li>mapping from "logical" names, the public identifiers and a more + concrete name usable for download (and URI). For example it can associate + the logical name <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p> - <p>of the DocBook 4.1.2 XML DTD with the actual URL where it - canbedownloaded</p> + <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be + downloaded</p> <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p> </li> - <li>remapping from a given URL to another one, like an - HTTPindirectionsaying that + <li>remapping from a given URL to another one, like an HTTP indirection + saying that <p>"http://www.oasis-open.org/committes/tr.xsl"</p> <p>should really be looked at</p> <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p> </li> - <li>providing a local cache mechanism allowing to load - theentitiesassociated to public identifiers or remote resources, this is - areallyimportant feature for any significant deployment of XML or - SGMLsince itallows to avoid the aleas and delays associated to - fetchingremoteresources.</li> + <li>providing a local cache mechanism allowing to load the entities + associated to public identifiers or remote resources, this is a really + important feature for any significant deployment of XML or SGML since it + allows to avoid the aleas and delays associated to fetching remote + resources.</li> </ul> <h3><a name="definition">The definitions</a></h3> <p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p> <ul> - <li>the older SGML catalogs, the official spec is SGML - OpenTechnicalResolution TR9401:1997, but is better understood by reading - <a href="http://www.jclark.com/sp/catalog.htm">the SP - Catalogpage</a>fromJames Clark. This is relatively old and not the - preferredmode ofoperation of libxml.</li> - <li><a - href="http://www.oasis-open.org/committees/entity/spec.html">XMLCatalogs</a>isfar - more flexible, more recent, uses an XML syntax andshould scale - quitebetter. This is the default option of libxml.</li> + <li>the older SGML catalogs, the official spec is SGML Open Technical + Resolution TR9401:1997, but is better understood by reading <a + href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from + James Clark. This is relatively old and not the preferred mode of + operation of libxml.</li> + <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML + Catalogs</a> is far more flexible, more recent, uses an XML syntax and + should scale quite better. This is the default option of libxml.</li> </ul> <p></p> <h3><a name="Simple">Using catalog</a></h3> -<p>In a normal environment libxml2 will by default check the presence -ofacatalog in /etc/xml/catalog, and assuming it has been -correctlypopulated,the processing is completely transparent to the document -user. Totake aconcrete example, suppose you are authoring a DocBook document, -thisonestarts with the following DOCTYPE definition:</p> +<p>In a normal environment libxml2 will by default check the presence of a +catalog in /etc/xml/catalog, and assuming it has been correctly populated, +the processing is completely transparent to the document user. To take a +concrete example, suppose you are authoring a DocBook document, this one +starts with the following DOCTYPE definition:</p> <pre><?xml version='1.0'?> <!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN" "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"></pre> -<p>When validating the document with libxml, the catalog will -beautomaticallyconsulted to lookup the public identifier "-//Norman -Walsh//DTDDocBk XMLV3.1.4//EN" and the -systemidentifier"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if -theseentities havebeen installed on your system and the catalogs actually -point tothem, libxmlwill fetch them from the local disk.</p> +<p>When validating the document with libxml, the catalog will be +automatically consulted to lookup the public identifier "-//Norman Walsh//DTD +DocBk XML V3.1.4//EN" and the system identifier +"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have +been installed on your system and the catalogs actually point to them, libxml +will fetch them from the local disk.</p> -<p style="font-size: 10pt"><strong>Note</strong>: Really don't usethisDOCTYPE -example it's a really old version, but is fine as an example.</p> +<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this +DOCTYPE example it's a really old version, but is fine as an example.</p> -<p>Libxml2 will check the catalog each time that it is requested to -loadanentity, this includes DTD, external parsed entities, stylesheets, etc -...Ifyour system is correctly configured all the authoring phase -andprocessingshould use only local files, even if your document stays -portablebecause ituses the canonical public and system ID, referencing the -remotedocument.</p> +<p>Libxml2 will check the catalog each time that it is requested to load an +entity, this includes DTD, external parsed entities, stylesheets, etc ... If +your system is correctly configured all the authoring phase and processing +should use only local files, even if your document stays portable because it +uses the canonical public and system ID, referencing the remote document.</p> <h3><a name="Some">Some examples:</a></h3> -<p>Here is a couple of fragments from XML Catalogs used in -libxml2earlyregression tests in <code>test/catalogs</code>:</p> +<p>Here is a couple of fragments from XML Catalogs used in libxml2 early +regression tests in <code>test/catalogs</code> :</p> <pre><?xml version="1.0"?> <!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" @@ -3937,21 +3958,22 @@ libxml2earlyregression tests in <code>test/catalogs</code>:</p> uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/> ...</pre> -<p>This is the beginning of a catalog for DocBook 4.1.2, XML -Catalogsarewritten in XML, there is a specific namespace for -catalogelements"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry -inthiscatalog is a <code>public</code>mapping it allows to associate -aPublicIdentifier with an URI.</p> +<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are +written in XML, there is a specific namespace for catalog elements +"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this +catalog is a <code>public</code> mapping it allows to associate a Public +Identifier with an URI.</p> <pre>... <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/" rewritePrefix="file:///usr/share/xml/docbook/"/> ...</pre> -<p>A <code>rewriteSystem</code>is a very powerful instruction, it saysthatany -URI starting with a given prefix should be looked at anotherURIconstructed by -replacing the prefix with an new one. In effect this actslikea cache system -for a full area of the Web. In practice it is extremelyusefulwith a file -prefix if you have installed a copy of those resources onyourlocal system.</p> +<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that +any URI starting with a given prefix should be looked at another URI +constructed by replacing the prefix with an new one. In effect this acts like +a cache system for a full area of the Web. In practice it is extremely useful +with a file prefix if you have installed a copy of those resources on your +local system.</p> <pre>... <delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //" catalog="file:///usr/share/xml/docbook.xml"/> @@ -3965,29 +3987,29 @@ prefix if you have installed a copy of those resources onyourlocal system.</p> catalog="file:///usr/share/xml/docbook.xml"/> ...</pre> -<p>Delegation is the core features which allows to build a tree -ofcatalogs,easier to maintain than a single catalog, based on -PublicIdentifier, SystemIdentifier or URI prefixes it instructs the -catalogsoftware to look upentries in another resource. This feature allow to -buildhierarchies ofcatalogs, the set of entries presented should be -sufficient toredirect theresolution of all DocBook references to the specific -catalogin<code>/usr/share/xml/docbook.xml</code>this one in turn could -delegateallreferences for DocBook 4.2.1 to a specific catalog installed at -the sametimeas the DocBook resources on the local machine.</p> +<p>Delegation is the core features which allows to build a tree of catalogs, +easier to maintain than a single catalog, based on Public Identifier, System +Identifier or URI prefixes it instructs the catalog software to look up +entries in another resource. This feature allow to build hierarchies of +catalogs, the set of entries presented should be sufficient to redirect the +resolution of all DocBook references to the specific catalog in +<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all +references for DocBook 4.2.1 to a specific catalog installed at the same time +as the DocBook resources on the local machine.</p> <h3><a name="reference">How to tune catalog usage:</a></h3> -<p>The user can change the default catalog behaviour by redirecting -queriestoits own set of catalogs, this can be done by -settingthe<code>XML_CATALOG_FILES</code>environment variable to a list of -catalogs,anempty one should deactivate loading the -default<code>/etc/xml/catalog</code>default catalog</p> +<p>The user can change the default catalog behaviour by redirecting queries +to its own set of catalogs, this can be done by setting the +<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an +empty one should deactivate loading the default <code>/etc/xml/catalog</code> +default catalog</p> <h3><a name="validate">How to debug catalog processing:</a></h3> -<p>Setting up the <code>XML_DEBUG_CATALOG</code>environment variable -willmakelibxml2 output debugging informations for each catalog -operations,forexample:</p> +<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will +make libxml2 output debugging informations for each catalog operations, for +example:</p> <pre>orchis:~/XML -> xmllint --memory --noout test/ent2 warning: failed to load external entity "title.xml" orchis:~/XML -> export XML_DEBUG_CATALOG= @@ -3998,24 +4020,24 @@ warning: failed to load external entity "title.xml" Catalogs cleanup orchis:~/XML -> </pre> -<p>The test/ent2 references an entity, running the parser from memorymakesthe -base URI unavailable and the the "title.xml" entity cannot beloaded.Setting -up the debug environment variable allows to detect that anattempt ismade to -load the <code>/etc/xml/catalog</code>but since it's notpresent theresolution -fails.</p> +<p>The test/ent2 references an entity, running the parser from memory makes +the base URI unavailable and the the "title.xml" entity cannot be loaded. +Setting up the debug environment variable allows to detect that an attempt is +made to load the <code>/etc/xml/catalog</code> but since it's not present the +resolution fails.</p> -<p>But the most advanced way to debug XML catalog processing is to -usethe<strong>xmlcatalog</strong>command shipped with libxml2, it allows -toloadcatalogs and make resolution queries to see what is going on. This -isalsoused for the regression tests:</p> +<p>But the most advanced way to debug XML catalog processing is to use the +<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load +catalogs and make resolution queries to see what is going on. This is also +used for the regression tests:</p> <pre>orchis:~/XML -> ./xmlcatalog test/catalogs/docbook.xml \ "-//OASIS//DTD DocBook XML V4.1.2//EN" http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd orchis:~/XML -> </pre> -<p>For debugging what is going on, adding one -v flags increase -theverbositylevel to indicate the processing done (adding a second flag -alsoindicatewhat elements are recognized at parsing):</p> +<p>For debugging what is going on, adding one -v flags increase the verbosity +level to indicate the processing done (adding a second flag also indicate +what elements are recognized at parsing):</p> <pre>orchis:~/XML -> ./xmlcatalog -v test/catalogs/docbook.xml \ "-//OASIS//DTD DocBook XML V4.1.2//EN" Parsing catalog test/catalogs/docbook.xml's content @@ -4024,8 +4046,8 @@ http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd Catalogs cleanup orchis:~/XML -> </pre> -<p>A shell interface is also available to debug and process -multiplequeries(and for regression tests):</p> +<p>A shell interface is also available to debug and process multiple queries +(and for regression tests):</p> <pre>orchis:~/XML -> ./xmlcatalog -shell test/catalogs/docbook.xml \ "-//OASIS//DTD DocBook XML V4.1.2//EN" > help @@ -4044,14 +4066,14 @@ http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd > quit orchis:~/XML -> </pre> -<p>This should be sufficient for most debugging purpose, this wasactuallyused -heavily to debug the XML Catalog implementation itself.</p> +<p>This should be sufficient for most debugging purpose, this was actually +used heavily to debug the XML Catalog implementation itself.</p> -<h3><a name="Declaring">How to create and maintain</a>catalogs:</h3> +<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3> -<p>Basically XML Catalogs are XML files, you can either use XML toolstomanage -them or use <strong>xmlcatalog</strong>for this. The basic stepisto create a -catalog the -create option provide this facility:</p> +<p>Basically XML Catalogs are XML files, you can either use XML tools to +manage them or use <strong>xmlcatalog</strong> for this. The basic step is +to create a catalog the -create option provide this facility:</p> <pre>orchis:~/XML -> ./xmlcatalog --create tst.xml <?xml version="1.0"?> <!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" @@ -4059,10 +4081,10 @@ catalog the -create option provide this facility:</p> <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/> orchis:~/XML -> </pre> -<p>By default xmlcatalog does not overwrite the original catalog and -savetheresult on the standard output, this can be overridden using -the-nooutoption. The <code>-add</code>command allows to add entries -inthecatalog:</p> +<p>By default xmlcatalog does not overwrite the original catalog and save the +result on the standard output, this can be overridden using the -noout +option. The <code>-add</code> command allows to add entries in the +catalog:</p> <pre>orchis:~/XML -> ./xmlcatalog --noout --create --add "public" \ "-//OASIS//DTD DocBook XML V4.1.2//EN" \ http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml @@ -4076,12 +4098,12 @@ orchis:~/XML -> cat tst.xml </catalog> orchis:~/XML -> </pre> -<p>The <code>-add</code>option will always take 3 parameters even if -someofthe XML Catalog constructs (like nextCatalog) will have only -asingleargument, just pass a third empty string, it will be ignored.</p> +<p>The <code>-add</code> option will always take 3 parameters even if some of +the XML Catalog constructs (like nextCatalog) will have only a single +argument, just pass a third empty string, it will be ignored.</p> -<p>Similarly the <code>-del</code>option remove matching entries -fromthecatalog:</p> +<p>Similarly the <code>-del</code> option remove matching entries from the +catalog:</p> <pre>orchis:~/XML -> ./xmlcatalog --del \ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml <?xml version="1.0"?> @@ -4090,158 +4112,156 @@ fromthecatalog:</p> <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/> orchis:~/XML -> </pre> -<p>The catalog is now empty. Note that the matching -of<code>-del</code>isexact and would have worked in a similar fashion with -thePublic IDstring.</p> +<p>The catalog is now empty. Note that the matching of <code>-del</code> is +exact and would have worked in a similar fashion with the Public ID +string.</p> -<p>This is rudimentary but should be sufficient to manage a not -toocomplexcatalog tree of resources.</p> +<p>This is rudimentary but should be sufficient to manage a not too complex +catalog tree of resources.</p> -<h3><a name="implemento">The implementor corner quick review -oftheAPI:</a></h3> +<h3><a name="implemento">The implementor corner quick review of the +API:</a></h3> -<p>First, and like for every other module of libxml, there is -anautomaticallygenerated <a href="html/libxml-catalog.html">API page -forcatalogsupport</a>.</p> +<p>First, and like for every other module of libxml, there is an +automatically generated <a href="html/libxml-catalog.html">API page for +catalog support</a>.</p> <p>The header for the catalog interfaces should be included as:</p> <pre>#include <libxml/catalog.h></pre> -<p>The API is voluntarily kept very simple. First it is not -obviousthatapplications really need access to it since it is the default -behaviouroflibxml2 (Note: it is possible to completely override libxml2 -defaultcatalogby using <a -href="html/libxml-parser.html">xmlSetExternalEntityLoader</a>toplug -anapplication specific resolver).</p> +<p>The API is voluntarily kept very simple. First it is not obvious that +applications really need access to it since it is the default behaviour of +libxml2 (Note: it is possible to completely override libxml2 default catalog +by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to +plug an application specific resolver).</p> <p>Basically libxml2 support 2 catalog lists:</p> <ul> <li>the default one, global shared by all the application</li> - <li>a per-document catalog, this one is built if the document - usesthe<code>oasis-xml-catalog</code>PIs to specify its own catalog list, - itisassociated to the parser context and destroyed when the - parsingcontextis destroyed.</li> + <li>a per-document catalog, this one is built if the document uses the + <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is + associated to the parser context and destroyed when the parsing context + is destroyed.</li> </ul> <p>the document one will be used first if it exists.</p> <h4>Initialization routines:</h4> -<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() -shouldbeused at startup to initialize the catalog, if the catalog -shouldbeinitialized with specific values xmlLoadCatalog() -orxmlLoadCatalogs()should be called before xmlInitializeCatalog() which -wouldotherwise do adefault initialization first.</p> +<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be +used at startup to initialize the catalog, if the catalog should be +initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs() +should be called before xmlInitializeCatalog() which would otherwise do a +default initialization first.</p> -<p>The xmlCatalogAddLocal() call is used by the parser to grow thedocumentown -catalog list if needed.</p> +<p>The xmlCatalogAddLocal() call is used by the parser to grow the document +own catalog list if needed.</p> <h4>Preferences setup:</h4> -<p>The XML Catalog spec requires the possibility to select -defaultpreferencesbetween public and system -delegation,xmlCatalogSetDefaultPrefer() allowsthis, xmlCatalogSetDefaults() -andxmlCatalogGetDefaults() allow to control ifXML Catalogs resolution -shouldbe forbidden, allowed for global catalog, fordocument catalog or both, -thedefault is to allow both.</p> +<p>The XML Catalog spec requires the possibility to select default +preferences between public and system delegation, +xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and +xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should +be forbidden, allowed for global catalog, for document catalog or both, the +default is to allow both.</p> -<p>And of course xmlCatalogSetDebug() allows to generate -debugmessages(through the xmlGenericError() mechanism).</p> +<p>And of course xmlCatalogSetDebug() allows to generate debug messages +(through the xmlGenericError() mechanism).</p> <h4>Querying routines:</h4> -<p>xmlCatalogResolve(), -xmlCatalogResolveSystem(),xmlCatalogResolvePublic()and xmlCatalogResolveURI() -are relatively explicitif you read the XMLCatalog specification they -correspond to section 7algorithms, they shouldalso work if you have loaded an -SGML catalog with asimplified semantic.</p> +<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic() +and xmlCatalogResolveURI() are relatively explicit if you read the XML +Catalog specification they correspond to section 7 algorithms, they should +also work if you have loaded an SGML catalog with a simplified semantic.</p> -<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the -samebutoperate on the document catalog list</p> +<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but +operate on the document catalog list</p> <h4>Cleanup and Miscellaneous:</h4> -<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal()isthe -per-document equivalent.</p> +<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is +the per-document equivalent.</p> -<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically -modifythefirst catalog in the global list, and xmlCatalogDump() allows to -dumpacatalog state, those routines are primarily designed for xmlcatalog, -I'mnotsure that exposing more complex interfaces (like navigation ones) -wouldbereally useful.</p> +<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the +first catalog in the global list, and xmlCatalogDump() allows to dump a +catalog state, those routines are primarily designed for xmlcatalog, I'm not +sure that exposing more complex interfaces (like navigation ones) would be +really useful.</p> -<p>The xmlParseCatalogFile() is a function used to load XML Catalogfiles,it's -similar as xmlParseFile() except it bypass all catalog lookups,it'sprovided -because this functionality may be useful for client tools.</p> +<p>The xmlParseCatalogFile() is a function used to load XML Catalog files, +it's similar as xmlParseFile() except it bypass all catalog lookups, it's +provided because this functionality may be useful for client tools.</p> <h4>threaded environments:</h4> -<p>Since the catalog tree is built progressively, some care has been -takentotry to avoid troubles in multithreaded environments. The code is -nowthreadsafe assuming that the libxml2 library has been compiled -withthreadssupport.</p> +<p>Since the catalog tree is built progressively, some care has been taken to +try to avoid troubles in multithreaded environments. The code is now thread +safe assuming that the libxml2 library has been compiled with threads +support.</p> <p></p> <h3><a name="Other">Other resources</a></h3> -<p>The XML Catalog specification is relatively recent so there -isn'tmuchliterature to point at:</p> +<p>The XML Catalog specification is relatively recent so there isn't much +literature to point at:</p> <ul> <li>You can find a good rant from Norm Walsh about <a - href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">theneedfor - catalogs</a>, it provides a lot of context informations even ifIdon't - agree with everything presented. Norm also wrote a morerecentarticle <a - href="http://wwws.sun.com/software/xml/developers/resolver/article/">XMLentitiesand - URI resolvers</a>describing them.</li> - <li>An <a - href="http://home.ccil.org/~cowan/XML/XCatalog.html">oldXMLcatalog - proposal</a>from John Cowan</li> - <li>The <a href="http://www.rddl.org/">Resource - DirectoryDescriptionLanguage</a>(RDDL) another catalog system but more - orientedtowardproviding metadata for XML namespaces.</li> + href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the + need for catalogs</a>, it provides a lot of context informations even if + I don't agree with everything presented. Norm also wrote a more recent + article <a + href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML + entities and URI resolvers</a> describing them.</li> + <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML + catalog proposal</a> from John Cowan</li> + <li>The <a href="http://www.rddl.org/">Resource Directory Description + Language</a> (RDDL) another catalog system but more oriented toward + providing metadata for XML namespaces.</li> <li>the page from the OASIS Technical <a - href="http://www.oasis-open.org/committees/entity/">Committee - onEntityResolution</a>who maintains XML Catalog, you will find pointers - tothespecification update, some background and pointers to - otherstoolsproviding XML Catalog support</li> - <li>There is a <a href="buildDocBookCatalog">shell script</a>to - generateXMLCatalogs for DocBook 4.1.2 . If it can write to the - /etc/xml/directory,it will set-up /etc/xml/catalog and /etc/xml/docbook - based ontheresources found on the system. Otherwise it will just - create~/xmlcatalogand ~/dbkxmlcatalog and doing: + href="http://www.oasis-open.org/committees/entity/">Committee on Entity + Resolution</a> who maintains XML Catalog, you will find pointers to the + specification update, some background and pointers to others tools + providing XML Catalog support</li> + <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate + XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/ + directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on + the resources found on the system. Otherwise it will just create + ~/xmlcatalog and ~/dbkxmlcatalog and doing: <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p> - <p>should allow to process DocBook documentations withoutrequiringnetwork - accesses for the DTD or stylesheets</p> + <p>should allow to process DocBook documentations without requiring + network accesses for the DTD or stylesheets</p> </li> - <li>I have uploaded <a - href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">asmalltarball</a>containing - XML Catalogs for DocBook 4.1.2 which seemsto workfine for me too</li> - <li>The <a - href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalogmanualpage</a></li> + <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a + small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems + to work fine for me too</li> + <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog + manual page</a></li> </ul> -<p>If you have suggestions for corrections or additions, simply contactme:</p> +<p>If you have suggestions for corrections or additions, simply contact +me:</p> <h2><a name="library">The parser interfaces</a></h2> -<p>This section is directly intended to help programmers -gettingbootstrappedusing the XML tollkit from the C language. It is not -intended tobeextensive. I hope the automatically generated documents will -providethecompleteness required, but as a separate set of documents. The -interfacesofthe XML parser are by principle low level, Those interested in a -higherlevelAPI should <a href="#DOM">look at DOM</a>.</p> +<p>This section is directly intended to help programmers getting bootstrapped +using the XML tollkit from the C language. It is not intended to be +extensive. I hope the automatically generated documents will provide the +completeness required, but as a separate set of documents. The interfaces of +the XML parser are by principle low level, Those interested in a higher level +API should <a href="#DOM">look at DOM</a>.</p> -<p>The <a href="html/libxml-parser.html">parser interfaces -forXML</a>areseparated from the <a -href="html/libxml-htmlparser.html">HTMLparserinterfaces</a>. Let's have a -look at how the XML parser can becalled:</p> +<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are +separated from the <a href="html/libxml-htmlparser.html">HTML parser +interfaces</a>. Let's have a look at how the XML parser can be called:</p> <h3><a name="Invoking">Invoking the parser : the pull method</a></h3> -<p>Usually, the first thing to do is to read an XML input. The -parseracceptsdocuments either from in-memory strings or from files. The -functionsaredefined in "parser.h":</p> +<p>Usually, the first thing to do is to read an XML input. The parser accepts +documents either from in-memory strings or from files. The functions are +defined in "parser.h":</p> <dl> <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt> <dd><p>Parse a null-terminated string containing the document.</p> @@ -4249,18 +4269,20 @@ functionsaredefined in "parser.h":</p> </dl> <dl> <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt> - <dd><p>Parse an XML document contained in a (possibly compressed)file.</p> + <dd><p>Parse an XML document contained in a (possibly compressed) + file.</p> </dd> </dl> -<p>The parser returns a pointer to the document structure (or NULL in -caseoffailure).</p> +<p>The parser returns a pointer to the document structure (or NULL in case of +failure).</p> <h3 id="Invoking1">Invoking the parser: the push method</h3> -<p>In order for the application to keep the control when the document -isbeingfetched (which is common for GUI based programs) libxml2 provides -apushinterface, too, as of version 1.8.3. Here are the interfacefunctions:</p> +<p>In order for the application to keep the control when the document is +being fetched (which is common for GUI based programs) libxml2 provides a +push interface, too, as of version 1.8.3. Here are the interface +functions:</p> <pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax, void *user_data, const char *chunk, @@ -4293,26 +4315,25 @@ int xmlParseChunk (xmlParserCtxtPtr ctxt, } }</pre> -<p>The HTML parser embedded into libxml2 also has a push -interface;thefunctions are just prefixed by "html" rather than "xml".</p> +<p>The HTML parser embedded into libxml2 also has a push interface; the +functions are just prefixed by "html" rather than "xml".</p> <h3 id="Invoking2">Invoking the parser: the SAX interface</h3> -<p>The tree-building interface makes the parser memory-hungry, -firstloadingthe document in memory and then building the tree itself. Reading -adocumentwithout building the tree is possible using the SAX interfaces -(seeSAX.h and<a -href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">JamesHenstridge'sdocumentation</a>). -Note also that the push interface can belimited to SAX:just use the two first -arguments of<code>xmlCreatePushParserCtxt()</code>.</p> +<p>The tree-building interface makes the parser memory-hungry, first loading +the document in memory and then building the tree itself. Reading a document +without building the tree is possible using the SAX interfaces (see SAX.h and +<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James +Henstridge's documentation</a>). Note also that the push interface can be +limited to SAX: just use the two first arguments of +<code>xmlCreatePushParserCtxt()</code>.</p> <h3><a name="Building">Building a tree from scratch</a></h3> -<p>The other way to get an XML tree in memory is by building -it.Basicallythere is a set of functions dedicated to building new -elements.(These arealso described in <libxml/tree.h>.) For example, -here is apiece ofcode that produces the XML document used in the previous -examples:</p> +<p>The other way to get an XML tree in memory is by building it. Basically +there is a set of functions dedicated to building new elements. (These are +also described in <libxml/tree.h>.) For example, here is a piece of +code that produces the XML document used in the previous examples:</p> <pre> #include <libxml/tree.h> xmlDocPtr doc; xmlNodePtr tree, subtree; @@ -4333,65 +4354,66 @@ examples:</p> <h3><a name="Traversing">Traversing the tree</a></h3> -<p>Basically by <a href="html/libxml-tree.html">including"tree.h"</a>yourcode -has access to the internal structure of all the elementsof the tree.The names -should be somewhat simple -like<strong>parent</strong>,<strong>children</strong>, -<strong>next</strong>,<strong>prev</strong>,<strong>properties</strong>, -etc... For example, stillwith the previousexample:</p> +<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your +code has access to the internal structure of all the elements of the tree. +The names should be somewhat simple like <strong>parent</strong>, +<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>, +<strong>properties</strong>, etc... For example, still with the previous +example:</p> <pre><code>doc->children->children->children</code></pre> <p>points to the title element,</p> <pre>doc->children->children->next->children->children</pre> -<p>points to the text node containing the chapter title -"TheLinuxadventure".</p> +<p>points to the text node containing the chapter title "The Linux +adventure".</p> -<p><strong>NOTE</strong>: XML allows <em>PI</em>s and -<em>comments</em>tobepresent before the document root, so -<code>doc->children</code>maypointto an element which is not the document -Root Element; afunction<code>xmlDocGetRootElement()</code>was added for this -purpose.</p> +<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be +present before the document root, so <code>doc->children</code> may point +to an element which is not the document Root Element; a function +<code>xmlDocGetRootElement()</code> was added for this purpose.</p> <h3><a name="Modifying">Modifying the tree</a></h3> -<p>Functions are provided for reading and writing the document content.Hereis -an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p> +<p>Functions are provided for reading and writing the document content. Here +is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p> <dl> - <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar - *name,constxmlChar *value);</code></dt> - <dd><p>This sets (or changes) an attribute carried by an ELEMENT - node.Thevalue can be NULL.</p> + <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const + xmlChar *value);</code></dt> + <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. + The value can be NULL.</p> </dd> </dl> <dl> - <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, - constxmlChar*name);</code></dt> - <dd><p>This function returns a pointer to new copy of thepropertycontent. - Note that the user must deallocate the result.</p> + <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar + *name);</code></dt> + <dd><p>This function returns a pointer to new copy of the property + content. Note that the user must deallocate the result.</p> </dd> </dl> -<p>Two functions are provided for reading and writing the text -associatedwithelements:</p> +<p>Two functions are provided for reading and writing the text associated +with elements:</p> <dl> - <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, - constxmlChar*value);</code></dt> - <dd><p>This function takes an "external" string and converts it toonetext - node or possibly to a list of entity and text nodes.Allnon-predefined - entity references like &Gnome; will bestoredinternally as entity - nodes, hence the result of the function maynot bea single node.</p> + <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar + *value);</code></dt> + <dd><p>This function takes an "external" string and converts it to one + text node or possibly to a list of entity and text nodes. All + non-predefined entity references like &Gnome; will be stored + internally as entity nodes, hence the result of the function may not be + a single node.</p> </dd> </dl> <dl> - <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr - list,intinLine);</code></dt> - <dd><p>This function is the inverseof<code>xmlStringGetNodeList()</code>. - It generates a newstringcontaining the content of the text and entity - nodes. Note theextraargument inLine. If this argument is set to 1, the - function willexpandentity references. For example, instead of - returning the&Gnome;XML encoding in the string, it will substitute - it with itsvalue (say,"GNU Network Object Model Environment").</p> + <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int + inLine);</code></dt> + <dd><p>This function is the inverse of + <code>xmlStringGetNodeList()</code>. It generates a new string + containing the content of the text and entity nodes. Note the extra + argument inLine. If this argument is set to 1, the function will expand + entity references. For example, instead of returning the &Gnome; + XML encoding in the string, it will substitute it with its value (say, + "GNU Network Object Model Environment").</p> </dd> </dl> @@ -4399,8 +4421,8 @@ associatedwithelements:</p> <p>Basically 3 options are possible:</p> <dl> - <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, - xmlChar**mem,int*size);</code></dt> + <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int + *size);</code></dt> <dd><p>Returns a buffer into which the document has been saved.</p> </dd> </dl> @@ -4411,16 +4433,16 @@ associatedwithelements:</p> </dl> <dl> <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt> - <dd><p>Saves the document to a file. In this case, - thecompressioninterface is triggered if it has been turned on.</p> + <dd><p>Saves the document to a file. In this case, the compression + interface is triggered if it has been turned on.</p> </dd> </dl> <h3><a name="Compressio">Compression</a></h3> -<p>The library transparently handles compression when -doingfile-basedaccesses. The level of compression on saves can be turned on -eithergloballyor individually for one file:</p> +<p>The library transparently handles compression when doing file-based +accesses. The level of compression on saves can be turned on either globally +or individually for one file:</p> <dl> <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt> <dd><p>Gets the document compression ratio (0-9).</p> @@ -4444,12 +4466,12 @@ eithergloballyor individually for one file:</p> <h2><a name="Entities">Entities or no entities</a></h2> -<p>Entities in principle are similar to simple C macros. An entity -definesanabbreviation for a given string that you can reuse many times -throughoutthecontent of your document. Entities are especially useful when a -givenstringmay occur frequently within a document, or to confine the change -neededto adocument to a restricted area in the internal subset of the -document (atthebeginning). Example:</p> +<p>Entities in principle are similar to simple C macros. An entity defines an +abbreviation for a given string that you can reuse many times throughout the +content of your document. Entities are especially useful when a given string +may occur frequently within a document, or to confine the change needed to a +document to a restricted area in the internal subset of the document (at the +beginning). Example:</p> <pre>1 <?xml version="1.0"?> 2 <!DOCTYPE EXAMPLE SYSTEM "example.dtd" [ 3 <!ENTITY xml "Extensible Markup Language"> @@ -4458,29 +4480,28 @@ document (atthebeginning). Example:</p> 6 &xml; 7 </EXAMPLE></pre> -<p>Line 3 declares the xml entity. Line 6 uses the xml entity, byprefixingits -name with '&' and following it by ';' without any spacesadded. Thereare 5 -predefined entities in libxml2 allowing you to escapecharacters -withpredefined meaning in some parts of the xml -documentcontent:<strong>&lt;</strong>for the character -'<',<strong>&gt;</strong>for the character -'>',<strong>&apos;</strong>for the -character''',<strong>&quot;</strong>for the character -'"',and<strong>&amp;</strong>for the character '&'.</p> - -<p>One of the problems related to entities is that you may want the -parsertosubstitute an entity's content so that you can see the replacement -textinyour application. Or you may prefer to keep entity references as such -inthecontent to be able to save the document back without losing -thisusuallyprecious information (if the user went through the pain -ofexplicitlydefining entities, he may have a a rather negative attitude if -youblindlysubstitute them as saving time). The <a -href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>functionallows -you to check and change the behaviour, which is to notsubstituteentities by -default.</p> - -<p>Here is the DOM tree built by libxml2 for the previous document -inthedefault case:</p> +<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing +its name with '&' and following it by ';' without any spaces added. There +are 5 predefined entities in libxml2 allowing you to escape characters with +predefined meaning in some parts of the xml document content: +<strong>&lt;</strong> for the character '<', <strong>&gt;</strong> +for the character '>', <strong>&apos;</strong> for the character ''', +<strong>&quot;</strong> for the character '"', and +<strong>&amp;</strong> for the character '&'.</p> + +<p>One of the problems related to entities is that you may want the parser to +substitute an entity's content so that you can see the replacement text in +your application. Or you may prefer to keep entity references as such in the +content to be able to save the document back without losing this usually +precious information (if the user went through the pain of explicitly +defining entities, he may have a a rather negative attitude if you blindly +substitute them as saving time). The <a +href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a> +function allows you to check and change the behaviour, which is to not +substitute entities by default.</p> + +<p>Here is the DOM tree built by libxml2 for the previous document in the +default case:</p> <pre>/gnome/src/gnome-xml -> ./xmllint --debug test/ent1 DOCUMENT version=1.0 @@ -4501,63 +4522,62 @@ version=1.0 TEXT content= Extensible Markup Language</pre> -<p>So, entities or no entities? Basically, it depends on your use -case.Isuggest that you keep the non-substituting default behaviour and -avoidusingentities in your XML document or data if you are not willing to -handletheentity references elements in the DOM tree.</p> - -<p>Note that at save time libxml2 enforces the conversion of -thepredefinedentities where necessary to prevent well-formedness problems, -andwill alsotransparently replace those with chars (i.e. it will not -generateentityreference elements in the DOM tree or call the reference() SAX -callbackwhenfinding them in the input).</p> - -<p><span style="background-color: #FF0000">WARNING</span>: handlingentitieson -top of the libxml2 SAX interface is difficult!!! If you plan -tousenon-predefined entities in your documents, then the learning curve -tohandlethen using the SAX API may be long. If you plan to use -complexdocuments, Istrongly suggest you consider using the DOM interface -instead andlet libxmldeal with the complexity rather than trying to do it -yourself.</p> +<p>So, entities or no entities? Basically, it depends on your use case. I +suggest that you keep the non-substituting default behaviour and avoid using +entities in your XML document or data if you are not willing to handle the +entity references elements in the DOM tree.</p> + +<p>Note that at save time libxml2 enforces the conversion of the predefined +entities where necessary to prevent well-formedness problems, and will also +transparently replace those with chars (i.e. it will not generate entity +reference elements in the DOM tree or call the reference() SAX callback when +finding them in the input).</p> + +<p><span style="background-color: #FF0000">WARNING</span>: handling entities +on top of the libxml2 SAX interface is difficult!!! If you plan to use +non-predefined entities in your documents, then the learning curve to handle +then using the SAX API may be long. If you plan to use complex documents, I +strongly suggest you consider using the DOM interface instead and let libxml +deal with the complexity rather than trying to do it yourself.</p> <h2><a name="Namespaces">Namespaces</a></h2> <p>The libxml2 library implements <a -href="http://www.w3.org/TR/REC-xml-names/">XML -namespaces</a>supportbyrecognizing namespace constructs in the input, and -does namespacelookupautomatically when building the DOM tree. A namespace -declarationisassociated with an in-memory structure and all elements or -attributeswithinthat namespace point to it. Hence testing the namespace is a -simple andfastequality operation at the user level.</p> - -<p>I suggest that people using libxml2 use a namespace, and declare it -intheroot element of their document as the default namespace. Then they -don'tneedto use the prefix in the content but we will have a basis for -futuresemanticrefinement and merging of data from different sources. This -doesn'tincreasethe size of the XML output significantly, but significantly -increasesitsvalue in the long-term. Example:</p> +href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by +recognizing namespace constructs in the input, and does namespace lookup +automatically when building the DOM tree. A namespace declaration is +associated with an in-memory structure and all elements or attributes within +that namespace point to it. Hence testing the namespace is a simple and fast +equality operation at the user level.</p> + +<p>I suggest that people using libxml2 use a namespace, and declare it in the +root element of their document as the default namespace. Then they don't need +to use the prefix in the content but we will have a basis for future semantic +refinement and merging of data from different sources. This doesn't increase +the size of the XML output significantly, but significantly increases its +value in the long-term. Example:</p> <pre><mydoc xmlns="http://mydoc.example.org/schemas/"> <elem1>...</elem1> <elem2>...</elem2> </mydoc></pre> -<p>The namespace value has to be an absolute URL, but the URL doesn't -havetopoint to any existing resource on the Web. It will bind all the -elementandattributes with that URL. I suggest to use an URL within a -domainyoucontrol, and that the URL should contain some kind of version -informationifpossible. For example, -<code>"http://www.gnome.org/gnumeric/1.0/"</code>isagood namespace scheme.</p> - -<p>Then when you load a file, make sure that a namespace -carryingtheversion-independent prefix is installed on the root element of -yourdocument,and if the version information don't match something you know, -warnthe userand be liberal in what you accept as the input. Also do *not* try -tobasenamespace checking on the prefix value. <foo:text> may be -exactlythesame as <bar:text> in another document. What really matters -is theURIassociated with the element or the attribute, not the prefix string -(whichisjust a shortcut for the full URI). In libxml, element and attributes -havean<code>ns</code>field pointing to an xmlNs structure detailing -thenamespaceprefix and its URI.</p> +<p>The namespace value has to be an absolute URL, but the URL doesn't have to +point to any existing resource on the Web. It will bind all the element and +attributes with that URL. I suggest to use an URL within a domain you +control, and that the URL should contain some kind of version information if +possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a +good namespace scheme.</p> + +<p>Then when you load a file, make sure that a namespace carrying the +version-independent prefix is installed on the root element of your document, +and if the version information don't match something you know, warn the user +and be liberal in what you accept as the input. Also do *not* try to base +namespace checking on the prefix value. <foo:text> may be exactly the +same as <bar:text> in another document. What really matters is the URI +associated with the element or the attribute, not the prefix string (which is +just a shortcut for the full URI). In libxml, element and attributes have an +<code>ns</code> field pointing to an xmlNs structure detailing the namespace +prefix and its URI.</p> <p>@@Interfaces@@</p> <pre>xmlNodePtr node; @@ -4567,163 +4587,158 @@ if(!strncmp(node->name,"mytag",5) ... }</pre> -<p>Usually people object to using namespaces together with validitychecking.I -will try to make sure that using namespaces won't break validitychecking,so -even if you plan to use or currently are using validation Istronglysuggest -adding namespaces to your document. A default -namespacescheme<code>xmlns="http://...."</code>should not break validity even -onlessflexible parsers. Using namespaces to mix and differentiate -contentcomingfrom multiple DTDs will certainly break current validation -schemes. Tochecksuch documents one needs to use schema-validation, which is -supportedinlibxml2 as well. See <a -href="http://www.relaxng.org/">relagx-ng</a>and <a +<p>Usually people object to using namespaces together with validity checking. +I will try to make sure that using namespaces won't break validity checking, +so even if you plan to use or currently are using validation I strongly +suggest adding namespaces to your document. A default namespace scheme +<code>xmlns="http://...."</code> should not break validity even on less +flexible parsers. Using namespaces to mix and differentiate content coming +from multiple DTDs will certainly break current validation schemes. To check +such documents one needs to use schema-validation, which is supported in +libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p> <h2><a name="Upgrading">Upgrading 1.x code</a></h2> <p>Incompatible changes:</p> -<p>Version 2 of libxml2 is the first version introducing -seriousbackwardincompatible changes. The main goals were:</p> +<p>Version 2 of libxml2 is the first version introducing serious backward +incompatible changes. The main goals were:</p> <ul> - <li>a general cleanup. A number of mistakes inherited from the - veryearlyversions couldn't be changed due to compatibility - constraints.Examplethe "childs" element in the nodes.</li> - <li>Uniformization of the various nodes, at least for their header - andlinkparts (doc, parent, children, prev, next), the goal is - asimplerprogramming model and simplifying the task of the - DOMimplementors.</li> - <li>better conformances to the XML specification, for example version1.xhad - an heuristic to try to detect ignorable white spaces. As a resulttheSAX - event generated were ignorableWhitespace() while the - specrequirescharacter() in that case. This also mean that a number of - DOMnodecontaining blank text may populate the DOM tree which were - notpresentbefore.</li> + <li>a general cleanup. A number of mistakes inherited from the very early + versions couldn't be changed due to compatibility constraints. Example + the "childs" element in the nodes.</li> + <li>Uniformization of the various nodes, at least for their header and link + parts (doc, parent, children, prev, next), the goal is a simpler + programming model and simplifying the task of the DOM implementors.</li> + <li>better conformances to the XML specification, for example version 1.x + had an heuristic to try to detect ignorable white spaces. As a result the + SAX event generated were ignorableWhitespace() while the spec requires + character() in that case. This also mean that a number of DOM node + containing blank text may populate the DOM tree which were not present + before.</li> </ul> <h3>How to fix libxml-1.x code:</h3> -<p>So client code of libxml designed to run with version 1.x may have -tobechanged to compile against version 2.x of libxml. Here is a list -ofchangesthat I have collected, they may not be sufficient, so in case you -findotherchange which are required, <a -href="mailto:Daniel.Veillard@w3.org">dropme amail</a>:</p> +<p>So client code of libxml designed to run with version 1.x may have to be +changed to compile against version 2.x of libxml. Here is a list of changes +that I have collected, they may not be sufficient, so in case you find other +change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a +mail</a>:</p> <ol> - <li>The package name have changed from libxml to libxml2, the librarynameis - now -lxml2 . There is a new xml2-config script which should beused - toselect the right parameters libxml2</li> - <li>Node <strong>childs</strong>field has - beenrenamed<strong>children</strong>so s/childs/children/g should - beapplied(probability of having "childs" anywhere else is close to 0+</li> - <li>The document don't have anymore a <strong>root</strong>element - ithasbeen replaced by <strong>children</strong>and usually you will - getalist of element here. For example a Dtd element for the - internalsubsetand it's declaration may be found in that list, as well - asprocessinginstructions or comments found before or after the - documentroot element.Use <strong>xmlDocGetRootElement(doc)</strong>to get - theroot element ofa document. Alternatively if you are sure to not - referenceDTDs nor havePIs or comments before or after the - rootelements/->root/->children/g will probably do it.</li> - <li>The white space issue, this one is more complex, unless special - caseofvalidating parsing, the line breaks and spaces usually used - forindentingand formatting the document content becomes significant. So - theyarereported by SAX and if your using the DOM tree, corresponding - nodesaregenerated. Too approach can be taken: + <li>The package name have changed from libxml to libxml2, the library name + is now -lxml2 . There is a new xml2-config script which should be used to + select the right parameters libxml2</li> + <li>Node <strong>childs</strong> field has been renamed + <strong>children</strong> so s/childs/children/g should be applied + (probability of having "childs" anywhere else is close to 0+</li> + <li>The document don't have anymore a <strong>root</strong> element it has + been replaced by <strong>children</strong> and usually you will get a + list of element here. For example a Dtd element for the internal subset + and it's declaration may be found in that list, as well as processing + instructions or comments found before or after the document root element. + Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of + a document. Alternatively if you are sure to not reference DTDs nor have + PIs or comments before or after the root element + s/->root/->children/g will probably do it.</li> + <li>The white space issue, this one is more complex, unless special case of + validating parsing, the line breaks and spaces usually used for indenting + and formatting the document content becomes significant. So they are + reported by SAX and if your using the DOM tree, corresponding nodes are + generated. Too approach can be taken: <ol> - <li>lazy one, use the - compatibilitycall<strong>xmlKeepBlanksDefault(0)</strong>but be aware - that youarerelying on a special (and possibly broken) set of - heuristicsoflibxml to detect ignorable blanks. Don't complain if it - breaksormake your application not 100% clean w.r.t. to it's - input.</li> - <li>the Right Way: change you code to accept - possiblyinsignificantblanks characters, or have your tree populated - withweird blank textnodes. You can spot them using the - commodityfunction<strong>xmlIsBlankNode(node)</strong>returning 1 for - suchblanknodes.</li> + <li>lazy one, use the compatibility call + <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are + relying on a special (and possibly broken) set of heuristics of + libxml to detect ignorable blanks. Don't complain if it breaks or + make your application not 100% clean w.r.t. to it's input.</li> + <li>the Right Way: change you code to accept possibly insignificant + blanks characters, or have your tree populated with weird blank text + nodes. You can spot them using the commodity function + <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank + nodes.</li> </ol> - <p>Note also that with the new default the output functions don't - addanyextra indentation when saving a tree in order to be able to - roundtrip(read and save) without inflating the document with - extraformattingchars.</p> + <p>Note also that with the new default the output functions don't add any + extra indentation when saving a tree in order to be able to round trip + (read and save) without inflating the document with extra formatting + chars.</p> </li> - <li>The include path has changed to $prefix/libxml/ and - theincludesthemselves uses this new prefix in includes instructions... - Ifyou areusing (as expected) the + <li>The include path has changed to $prefix/libxml/ and the includes + themselves uses this new prefix in includes instructions... If you are + using (as expected) the <pre>xml2-config --cflags</pre> - <p>output to generate you compile commands this will probably work - outofthe box</p> + <p>output to generate you compile commands this will probably work out of + the box</p> </li> - <li>xmlDetectCharEncoding takes an extra argument indicating the - lengthinbyte of the head of the document available for character - detection.</li> + <li>xmlDetectCharEncoding takes an extra argument indicating the length in + byte of the head of the document available for character detection.</li> </ol> <h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3> -<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have beenreleasedto -allow smooth upgrade of existing libxml v1code whileretainingcompatibility. -They offers the following:</p> +<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released +to allow smooth upgrade of existing libxml v1code while retaining +compatibility. They offers the following:</p> <ol> - <li>similar include naming, one - shoulduse<strong>#include<libxml/...></strong>in both cases.</li> - <li>similar identifiers defined via macros for the child and - rootfields:respectively<strong>xmlChildrenNode</strong>and<strong>xmlRootNode</strong></li> - <li>a new macro <strong>LIBXML_TEST_VERSION</strong>which should - beinsertedonce in the client code</li> + <li>similar include naming, one should use + <strong>#include<libxml/...></strong> in both cases.</li> + <li>similar identifiers defined via macros for the child and root fields: + respectively <strong>xmlChildrenNode</strong> and + <strong>xmlRootNode</strong></li> + <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be + inserted once in the client code</li> </ol> -<p>So the roadmap to upgrade your existing libxml applications -isthefollowing:</p> +<p>So the roadmap to upgrade your existing libxml applications is the +following:</p> <ol> <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li> - <li>find all occurrences where the xmlDoc <strong>root</strong>field - isusedand change it to <strong>xmlRootNode</strong></li> - <li>similarly find all occurrences where - thexmlNode<strong>childs</strong>field is used and change - itto<strong>xmlChildrenNode</strong></li> - <li>add a <strong>LIBXML_TEST_VERSION</strong>macro somewhere - inyour<strong>main()</strong>or in the library init entry point</li> + <li>find all occurrences where the xmlDoc <strong>root</strong> field is + used and change it to <strong>xmlRootNode</strong></li> + <li>similarly find all occurrences where the xmlNode + <strong>childs</strong> field is used and change it to + <strong>xmlChildrenNode</strong></li> + <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your + <strong>main()</strong> or in the library init entry point</li> <li>Recompile, check compatibility, it should still work</li> - <li>Change your configure script to look first for xml2-config and - fallbackusing xml-config . Use the --cflags and --libs output of the - commandasthe Include and Linking parameters needed to use libxml.</li> - <li>install libxml2-2.3.x and libxml2-devel-2.3.x - (libxml-1.8.yandlibxml-devel-1.8.y can be kept simultaneously)</li> - <li>remove your config.cache, relaunch your configuration - mechanism,andrecompile, if steps 2 and 3 were done right it should - compileas-is</li> - <li>Test that your application is still running correctly, if not thismaybe - due to extra empty nodes due to formating spaces being kept - inlibxml2contrary to libxml1, in that case insert - xmlKeepBlanksDefault(1)in yourcode before calling the parser - (nextto<strong>LIBXML_TEST_VERSION</strong>is a fine place).</li> + <li>Change your configure script to look first for xml2-config and fall + back using xml-config . Use the --cflags and --libs output of the command + as the Include and Linking parameters needed to use libxml.</li> + <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and + libxml-devel-1.8.y can be kept simultaneously)</li> + <li>remove your config.cache, relaunch your configuration mechanism, and + recompile, if steps 2 and 3 were done right it should compile as-is</li> + <li>Test that your application is still running correctly, if not this may + be due to extra empty nodes due to formating spaces being kept in libxml2 + contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your + code before calling the parser (next to + <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li> </ol> <p>Following those steps should work. It worked for some of my own code.</p> -<p>Let me put some emphasis on the fact that there is far more -changesfromlibxml 1.x to 2.x than the ones you may have to patch for. The -overallcodehas been considerably cleaned up and the conformance to the -XMLspecificationhas been drastically improved too. Don't take those changes -asan excuse tonot upgrade, it may cost a lot on the long term ...</p> +<p>Let me put some emphasis on the fact that there is far more changes from +libxml 1.x to 2.x than the ones you may have to patch for. The overall code +has been considerably cleaned up and the conformance to the XML specification +has been drastically improved too. Don't take those changes as an excuse to +not upgrade, it may cost a lot on the long term ...</p> <h2><a name="Thread">Thread safety</a></h2> -<p>Starting with 2.4.7, libxml2 makes provisions to ensure -thatconcurrentthreads can safely work in parallel parsing different -documents.There ishowever a couple of things to do to ensure it:</p> +<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent +threads can safely work in parallel parsing different documents. There is +however a couple of things to do to ensure it:</p> <ul> <li>configure the library accordingly using the --with-threads options</li> - <li>call xmlInitParser() in the "main" thread before using any ofthelibxml2 - API (except possibly selecting a different memoryallocator)</li> + <li>call xmlInitParser() in the "main" thread before using any of the + libxml2 API (except possibly selecting a different memory allocator)</li> </ul> -<p>Note that the thread safety cannot be ensured for multiple -threadssharingthe same document, the locking must be done at the application -level,libxmlexports a basic mutex and reentrant mutexes API -in<libxml/threads.h>.The parts of the library checked for thread -safetyare:</p> +<p>Note that the thread safety cannot be ensured for multiple threads sharing +the same document, the locking must be done at the application level, libxml +exports a basic mutex and reentrant mutexes API in <libxml/threads.h>. +The parts of the library checked for thread safety are:</p> <ul> <li>concurrent loading</li> <li>file access resolution</li> @@ -4735,31 +4750,31 @@ safetyare:</p> <li>memory handling</li> </ul> -<p>XPath is supposed to be thread safe now, but this -wasn'ttestedseriously.</p> +<p>XPath is supposed to be thread safe now, but this wasn't tested +seriously.</p> <h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2> -<p><a href="http://www.w3.org/DOM/">DOM</a>stands for the -<em>DocumentObjectModel</em>; this is an API for accessing XML or HTML -structureddocuments.Native support for DOM in Gnome is on the way (module -gnome-dom),and will bebased on gnome-xml. This will be a far cleaner -interface tomanipulate XMLfiles within Gnome since it won't expose the -internalstructure.</p> +<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document +Object Model</em>; this is an API for accessing XML or HTML structured +documents. Native support for DOM in Gnome is on the way (module gnome-dom), +and will be based on gnome-xml. This will be a far cleaner interface to +manipulate XML files within Gnome since it won't expose the internal +structure.</p> <p>The current DOM implementation on top of libxml2 is the <a -href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>,thisis -a full DOM interface, thanks to Paolo Casarini, check the <a -href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 -homepage</a>formoreinformations.</p> +href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this +is a full DOM interface, thanks to Paolo Casarini, check the <a +href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more +informations.</p> <h2><a name="Example"></a><a name="real">A real example</a></h2> -<p>Here is a real size example, where the actual content of -theapplicationdata is not kept in the DOM tree but uses internal structures. -Itis based ona proposal to keep a database of jobs related to Gnome, with -anXML basedstorage structure. Here is an <a href="gjobs.xml">XML -encodedjobsbase</a>:</p> +<p>Here is a real size example, where the actual content of the application +data is not kept in the DOM tree but uses internal structures. It is based on +a proposal to keep a database of jobs related to Gnome, with an XML based +storage structure. Here is an <a href="gjobs.xml">XML encoded jobs +base</a>:</p> <pre><?xml version="1.0"?> <gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"> <gjob:Jobs> @@ -4817,16 +4832,15 @@ encodedjobsbase</a>:</p> </gjob:Jobs> </gjob:Helping></pre> -<p>While loading the XML file into an internal DOM tree is a matter -ofcallingonly a couple of functions, browsing the tree to gather the data -andgeneratethe internal structures is harder, and more error prone.</p> +<p>While loading the XML file into an internal DOM tree is a matter of +calling only a couple of functions, browsing the tree to gather the data and +generate the internal structures is harder, and more error prone.</p> -<p>The suggested principle is to be tolerant with respect to -theinputstructure. For example, the ordering of the attributes is -notsignificant,the XML specification is clear about it. It's also usually a -goodidea not todepend on the order of the children of a given node, unless -itreally makesthings harder. Here is some code to parse the information for -aperson:</p> +<p>The suggested principle is to be tolerant with respect to the input +structure. For example, the ordering of the attributes is not significant, +the XML specification is clear about it. It's also usually a good idea not to +depend on the order of the children of a given node, unless it really makes +things harder. Here is some code to parse the information for a person:</p> <pre>/* * A person record */ @@ -4872,24 +4886,23 @@ DEBUG("parsePerson\n"); <p>Here are a couple of things to notice:</p> <ul> - <li>Usually a recursive parsing style is the more convenient one: XMLdatais - by nature subject to repetitive constructs and usually - exhibitshighlystructured patterns.</li> - <li>The two arguments of type <em>xmlDocPtr</em>and - <em>xmlNsPtr</em>,i.e.the pointer to the global XML document and the - namespace reserved totheapplication. Document wide information are needed - for example todecodeentities and it's a good coding practice to define a - namespace foryourapplication set of data and test that the element and - attributesyou'reanalyzing actually pertains to your application space. - This isdone by asimple equality test (cur->ns == ns).</li> - <li>To retrieve text and attributes value, you can use - thefunction<em>xmlNodeListGetString</em>to gather all the text and - entityreferencenodes generated by the DOM output and produce an single - textstring.</li> -</ul> - -<p>Here is another piece of code used to parse another level -ofthestructure:</p> + <li>Usually a recursive parsing style is the more convenient one: XML data + is by nature subject to repetitive constructs and usually exhibits highly + structured patterns.</li> + <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, + i.e. the pointer to the global XML document and the namespace reserved to + the application. Document wide information are needed for example to + decode entities and it's a good coding practice to define a namespace for + your application set of data and test that the element and attributes + you're analyzing actually pertains to your application space. This is + done by a simple equality test (cur->ns == ns).</li> + <li>To retrieve text and attributes value, you can use the function + <em>xmlNodeListGetString</em> to gather all the text and entity reference + nodes generated by the DOM output and produce an single text string.</li> +</ul> + +<p>Here is another piece of code used to parse another level of the +structure:</p> <pre>#include <libxml/tree.h> /* * a Description for a Job @@ -4942,58 +4955,59 @@ DEBUG("parseJob\n"); return(ret); }</pre> -<p>Once you are used to it, writing this kind of code is quite -simple,butboring. Ultimately, it could be possible to write stubbers taking -eitherCdata structure definitions, a set of XML examples or an XML DTD -andproducethe code needed to import and export the content between C data -andXMLstorage. This is left as an exercise to the reader :-)</p> +<p>Once you are used to it, writing this kind of code is quite simple, but +boring. Ultimately, it could be possible to write stubbers taking either C +data structure definitions, a set of XML examples or an XML DTD and produce +the code needed to import and export the content between C data and XML +storage. This is left as an exercise to the reader :-)</p> -<p>Feel free to use <a href="example/gjobread.c">the code for the -fullCparsing example</a>as a template, it is also available with Makefile -intheGnome CVS base under gnome-xml/example</p> +<p>Feel free to use <a href="example/gjobread.c">the code for the full C +parsing example</a> as a template, it is also available with Makefile in the +Gnome CVS base under gnome-xml/example</p> <h2><a name="Contributi">Contributions</a></h2> <ul> - <li>Bjorn Reese, William Brack and Thomas Broyer have provided a - numberofpatches, Gary Pennington worked on the validation API, - threadingsupportand Solaris port.</li> + <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of + patches, Gary Pennington worked on the validation API, threading support + and Solaris port.</li> <li>John Fleck helps maintaining the documentation and man pages.</li> - <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a>is - nowthemaintainer of the Windows port, <a - href="http://www.zlatkovic.com/projects/libxml/index.html">heprovidesbinaries</a></li> - <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a>provides<a - href="http://garypennington.net/libxml2/">Solaris binaries</a></li> + <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the + maintainer of the Windows port, <a + href="http://www.zlatkovic.com/projects/libxml/index.html">he provides + binaries</a></li> + <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides + <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li> <li><a - href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">MattSergeant</a>developed<a - href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl - wrapperforlibxml2/libxslt as part of the <a - href="http://axkit.com/">AxKitXMLapplication server</a></li> - <li><a href="mailto:fnatter@gmx.net">Felix Natter</a>and <a - href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a>provide <a - href="libxml-doc.el">an emacs module</a>to lookup - libxml(2)functionsdocumentation</li> - <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a>provided <a + href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt + Sergeant</a> developed <a + href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for + libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML + application server</a></li> + <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a + href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a + href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions + documentation</li> + <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a href="http://xmlsoft.org/messages/0488.html">man pages</a></li> <li>there is a module for <a - href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxsltsupportin - OpenNSD/AOLServer</a></li> - <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave - Kuhlman</a>providedthefirst version of libxml/libxslt <a + href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support + in OpenNSD/AOLServer</a></li> + <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the + first version of libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li> <li>Petr Kozelka provides <a - href="http://sourceforge.net/projects/libxml2-pas">Pascal units - togluelibxml2</a>with Kylix and Delphi and other Pascal compilers</li> - <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a>implemented the<a - href="http://www.w3.org/Signature/">XML Canonicalization and - XMLDigitalSignature</a><a - href="http://www.aleksey.com/xmlsec/">implementations forlibxml2</a></li> - <li><a href="mailto:Steve.Ball@explain.com.au">SteveBall</a>andcontributors - maintain <a href="http://tclxml.sourceforge.net/">tclbindings for libxml2 - andlibxslt</a>, as well as <a - href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a>a GUI - forxmllintand <a - href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>a GUIfor - xsltproc.</li> + href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue + libxml2</a> with Kylix and Delphi and other Pascal compilers</li> + <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the + <a href="http://www.w3.org/Signature/">XML Canonicalization and XML + Digital Signature</a> <a + href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li> + <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and + contributors maintain <a href="http://tclxml.sourceforge.net/">tcl + bindings for libxml2 and libxslt</a>, as well as <a + href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for + xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a> + a GUI for xsltproc.</li> </ul> <p></p> |