Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 0b28e88eb9285def35d2f1201a932014b717c3d3 / . / doc / FAQ.html
blob: 1213039eea2ab60792da769a33f75cc9dd519da4 [file] [log] [blame]
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]2<html>
3<head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
Daniel Veillardc332dab2002-03-29 14:08:27 +0000[diff] [blame]5<link rel="SHORTCUT ICON" href="/favicon.ico">
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]6<style type="text/css"><!--
Daniel Veillard373a4752002-02-21 14:46:29 +0000[diff] [blame]7TD {font-family: Verdana,Arial,Helvetica}
8BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
9H1 {font-family: Verdana,Arial,Helvetica}
10H2 {font-family: Verdana,Arial,Helvetica}
11H3 {font-family: Verdana,Arial,Helvetica}
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]12A:link, A:visited, A:active { text-decoration: underline }
13--></style>
14<title>FAQ</title>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]15</head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]16<body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
17<table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
18<td width="180">
19<a href="http://www.gnome.org/"><img src="smallfootonly.gif" alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a>
20</td>
21<td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
22<h1>The XML C library for Gnome</h1>
23<h2>FAQ</h2>
24</td></tr></table></td></tr></table></td>
25</tr></table>
26<table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
27<td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
28<table width="100%" border="0" cellspacing="1" cellpadding="3">
29<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]30<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]31<li><a href="index.html">Home</a></li>
32<li><a href="intro.html">Introduction</a></li>
33<li><a href="FAQ.html">FAQ</a></li>
34<li><a href="docs.html">Documentation</a></li>
35<li><a href="bugs.html">Reporting bugs and getting help</a></li>
36<li><a href="help.html">How to help</a></li>
37<li><a href="downloads.html">Downloads</a></li>
38<li><a href="news.html">News</a></li>
Daniel Veillard7b602b42002-01-08 13:26:00 +0000[diff] [blame]39<li><a href="XMLinfo.html">XML</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]40<li><a href="XSLT.html">XSLT</a></li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]41<li><a href="python.html">Python and bindings</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]42<li><a href="architecture.html">libxml architecture</a></li>
43<li><a href="tree.html">The tree output</a></li>
44<li><a href="interface.html">The SAX interface</a></li>
45<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
46<li><a href="xmlmem.html">Memory Management</a></li>
47<li><a href="encoding.html">Encodings support</a></li>
48<li><a href="xmlio.html">I/O Interfaces</a></li>
49<li><a href="catalog.html">Catalog support</a></li>
50<li><a href="library.html">The parser interfaces</a></li>
51<li><a href="entities.html">Entities or no entities</a></li>
52<li><a href="namespaces.html">Namespaces</a></li>
53<li><a href="upgrade.html">Upgrading 1.x code</a></li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]54<li><a href="threads.html">Thread safety</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]55<li><a href="DOM.html">DOM Principles</a></li>
56<li><a href="example.html">A real example</a></li>
57<li><a href="contribs.html">Contributions</a></li>
Daniel Veillardfc59c092002-06-05 14:48:26 +0000[diff] [blame]58<li><a href="tutorial/index.html">Tutorial</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]59<li>
60<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
61</li>
62</ul></td></tr>
63</table>
64<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]65<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
66<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardf8592562002-01-23 17:58:17 +0000[diff] [blame]67<li><a href="APIchunk0.html">Alphabetic</a></li>
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]68<li><a href="APIconstructors.html">Constructors</a></li>
69<li><a href="APIfunctions.html">Functions/Types</a></li>
70<li><a href="APIfiles.html">Modules</a></li>
71<li><a href="APIsymbols.html">Symbols</a></li>
72</ul></td></tr>
73</table>
74<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]75<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]76<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]77<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
78<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
Daniel Veillard4a859202002-01-08 11:49:22 +0000[diff] [blame]79<li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]80<li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]81<li><a href="ftp://xmlsoft.org/">FTP</a></li>
82<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
Daniel Veillarddb9dfd92001-11-26 17:25:02 +0000[diff] [blame]83<li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]84<li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]85<li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&amp;product=libxml2">Bug Tracker</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]86</ul></td></tr>
87</table>
88</td></tr></table></td>
89<td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]90<p>Table of Contents:</p>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]91<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]92<li><a href="FAQ.html#License">License(s)</a></li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]93 <li><a href="FAQ.html#Installati">Installation</a></li>
94 <li><a href="FAQ.html#Compilatio">Compilation</a></li>
95 <li><a href="FAQ.html#Developer">Developer corner</a></li>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]96</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]97<h3>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]98<a name="License">License</a>(s)</h3>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]99<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]100<li>
101<em>Licensing Terms for libxml</em>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]102 <p>libxml is released under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]103 License</a>; see the file Copyright in the distribution for the precise
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]104 wording</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]105 </li>
106 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]107<em>Can I embed libxml in a proprietary application ?</em>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]108 <p>Yes. The MIT License allows you to keep proprietary the changes
109 you made to libxml, but it would be graceful to send-back bug fixes
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]110 and improvements as patches for possible incorporation in the main
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]111 development tree.</p>
112 </li>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]113</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]114<h3><a name="Installati">Installation</a></h3>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]115<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]116<li>Unless you are forced to because your application links with a Gnome
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]117 library requiring it, <strong><span style="background-color: #FF0000">Do
118 Not Use libxml1</span></strong>, use libxml2</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]119 <li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]120<em>Where can I get libxml</em> ?
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]121 <p>The original distribution comes from <a href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> or <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">gnome.org</a>
122</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]123 <p>Most Linux and BSD distributions include libxml, this is probably the
124 safer way for end-users to use libxml.</p>
125 <p>David Doolin provides precompiled Windows versions at <a href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/%20%20%20%20%20%20%20%20%20">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]126</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]127 </li>
128 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]129<em>I see libxml and libxml2 releases, which one should I install ?</em>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]130 <ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]131<li>If you are not constrained by backward compatibility issues
132 with existing applications, install libxml2 only</li>
133 <li>If you are not doing development, you can safely install both.
134 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
135 compatible (this is not the case for development packages).</li>
136 <li>If you are a developer and your system provides separate packaging
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]137 for shared libraries and the development components, it is possible
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]138 to install libxml and libxml2, and also <a href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
139 and <a href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
Daniel Veillard480363b2001-03-16 22:04:15 +0000[diff] [blame]140 too for libxml2 &gt;= 2.3.0</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]141 <li>If you are developing a new application, please develop against
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]142 libxml2(-devel)</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]143 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]144</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]145 <li>
146<em>I can't install the libxml package, it conflicts with libxml0</em>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]147 <p>You probably have an old libxml0 package used to provide the shared
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]148 library for libxml.so.0, you can probably safely remove it. The
149 libxml packages provided on <a href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> provide
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]150 libxml.so.0</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]151 </li>
152 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]153<em>I can't install the libxml(2) RPM package due to failed
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]154 dependencies</em>
155 <p>The most generic solution is to re-fetch the latest src.rpm , and
Daniel Veillardc654d602001-05-01 12:42:26 +0000[diff] [blame]156 rebuild it locally with</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]157 <p>
158<code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
159 <p>If everything goes well it will generate two binary rpm packages (one providing
160 the shared libs and xmllint, and the other one, the -devel package,
Daniel Veillardc654d602001-05-01 12:42:26 +0000[diff] [blame]161 providing includes, static libraries and scripts needed to build
162 applications with libxml(2)) that you can install locally.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]163 </li>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]164</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]165<h3><a name="Compilatio">Compilation</a></h3>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]166<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]167<li>
168<em>What is the process to compile libxml ?</em>
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]169 <p>As most UNIX libraries libxml follows the &quot;standard&quot;:</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]170 <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
171 <p><code>cd libxml-xxxx</code></p>
172 <p><code>./configure --help</code></p>
173 <p>to see the options, then the compilation/installation proper</p>
174 <p><code>./configure [possible options]</code></p>
175 <p><code>make</code></p>
176 <p><code>make install</code></p>
177 <p>At that point you may have to rerun ldconfig or a similar utility to
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]178 update your list of installed shared libs.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]179 </li>
180 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]181<em>What other libraries are needed to compile/install libxml ?</em>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]182 <p>Libxml does not require any other library, the normal C ANSI API
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]183 should be sufficient (please report any violation to this rule you may
184 find).</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]185 <p>However if found at configuration time libxml will detect and use the
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]186 following libs:</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]187 <ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]188<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]189<a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]190 highly portable and available widely compression library.</li>
191 <li>iconv: a powerful character encoding conversion library. It is
192 included by default in recent glibc libraries, so it doesn't need to
193 be installed specifically on Linux. It now seems a <a href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]194 of the official UNIX</a> specification. Here is one <a href="http://clisp.cons.org/~haible/packages-libiconv.html">implementation
195 of the library</a> which source can be found <a href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]196 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]197</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]198 <li>
199<em>Make check fails on some platforms</em>
200 <p>Sometimes the regression tests' results don't completely match the value
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]201 produced by the parser, and the makefile uses diff to print the delta. On
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]202 some platforms the diff return breaks the compilation process; if the
Daniel Veillarde46182c2002-02-12 14:29:11 +0000[diff] [blame]203 diff is small this is probably not a serious problem.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]204 <p>Sometimes (especially on Solaris) make checks fail due to limitations
Daniel Veillarde46182c2002-02-12 14:29:11 +0000[diff] [blame]205 in make. Try using GNU-make instead.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]206 </li>
207 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]208<em>I use the CVS version and there is no configure script</em>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]209 <p>The configure script (and other Makefiles) are generated. Use the autogen.sh
210 script to regenerate the configure script and Makefiles, like:</p>
211 <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
212 </li>
213 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]214<em>I have troubles when running make tests with gcc-3.0</em>
Daniel Veillard7b06bcb2001-06-22 16:03:51 +0000[diff] [blame]215 <p>It seems the initial release of gcc-3.0 has a problem with the
216 optimizer which miscompiles the URI module. Please use another
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]217 compiler.</p>
218 </li>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]219</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]220<h3>
221<a name="Developer">Developer</a> corner</h3>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]222<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]223<li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]224<em>xmlDocDump() generates output on one line.</em>
225 <p>Libxml will not <strong>invent</strong> spaces in the content of a
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]226 document since <strong>all spaces in the content of a document are
227 significant</strong>. If you build a tree from the API and want
228 indentation:</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]229 <ol>
230<li>the correct way is to generate those yourself too.</li>
231 <li>the dangerous way is to ask libxml to add those blanks to your
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]232 content <strong>modifying the content of your document in the
233 process</strong>. The result may not be what you expect. There is
234 <strong>NO</strong> way to guarantee that such a modification won't
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]235 affect other parts of the content of your document. See <a href="http://xmlsoft.org/html/libxml-parser.html#XMLKEEPBLANKSDEFAULT">xmlKeepBlanksDefault
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]236 ()</a> and <a href="http://xmlsoft.org/html/libxml-tree.html#XMLSAVEFORMATFILE">xmlSaveFormatFile
237 ()</a>
238</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]239 </ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]240</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]241 <li>Extra nodes in the document:
Daniel Veillard62bccd52001-02-10 09:40:10 +0000[diff] [blame]242 <p><em>For a XML file as below:</em></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]243 <pre>&lt;?xml version=&quot;1.0&quot;?&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]244&lt;PLAN xmlns=&quot;http://www.argus.ca/autotest/1.0/&quot;&gt;
245&lt;NODE CommFlag=&quot;0&quot;/&gt;
246&lt;NODE CommFlag=&quot;1&quot;/&gt;
Daniel Veillard62bccd52001-02-10 09:40:10 +0000[diff] [blame]247&lt;/PLAN&gt;</pre>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]248 <p><em>after parsing it with the function
Daniel Veillard480363b2001-03-16 22:04:15 +0000[diff] [blame]249 pxmlDoc=xmlParseFile(...);</em></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]250 <p><em>I want to the get the content of the first node (node with the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]251 CommFlag=&quot;0&quot;)</em></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]252 <p><em>so I did it as following;</em></p>
253 <pre>xmlNodePtr pnode;
Daniel Veillard62bccd52001-02-10 09:40:10 +0000[diff] [blame]254pnode=pxmlDoc-&gt;children-&gt;children;</pre>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]255 <p><em>but it does not work. If I change it to</em></p>
256 <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
257 <p><em>then it works. Can someone explain it to me.</em></p>
258 <p>
259 <p>In XML all characters in the content of the document are significant
Daniel Veillard7f41b3e2001-02-10 09:35:37 +0000[diff] [blame]260 <strong>including blanks and formatting line breaks</strong>.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]261 <p>The extra nodes you are wondering about are just that, text nodes with
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]262 the formatting spaces which are part of the document but that people tend
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]263 to forget. There is a function <a href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
Daniel Veillard7f41b3e2001-02-10 09:35:37 +0000[diff] [blame]264 ()</a> to remove those at parse time, but that's an heuristic, and its
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]265 use should be limited to cases where you are certain there is no
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]266 mixed-content in the document.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]267 </li>
268 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]269<em>I get compilation errors of existing code like when accessing
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]270 <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
Daniel Veillard3f3b4f32001-03-13 15:12:39 +0000[diff] [blame]271 <p>You are compiling code developed for libxml version 1 and using a
272 libxml2 development environment. Either switch back to libxml v1 devel or
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]273 even better fix the code to compile with libxml2 (or both) by <a href="upgrade.html">following the instructions</a>.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]274 </li>
275 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]276<em>I get compilation errors about non existing
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]277 <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]278 fields.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]279 <p>The source code you are using has been <a href="upgrade.html">upgraded</a> to be able to compile with both libxml
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]280 and libxml2, but you need to install a more recent version:
281 libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]282 </li>
283 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]284<em>XPath implementation looks seriously broken</em>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]285 <p>XPath implementation prior to 2.3.0 was really incomplete. Upgrade to
286 a recent version, there are no known bugs in the current version.</p>
287 </li>
288 <li>
289<em>The example provided in the web page does not compile.</em>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]290 <p>It's hard to maintain the documentation in sync with the code
Daniel Veillarde9202a02000-10-16 16:58:19 +0000[diff] [blame]291 &lt;grin/&gt; ...</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]292 <p>Check the previous points 1/ and 2/ raised before, and please send
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]293 patches.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]294 </li>
295 <li>
296<em>Where can I get more examples and information than privoded on the web
297 page?</em>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]298 <p>Ideally a libxml book would be nice. I have no such plan ... But you
299 can:</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]300 <ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]301<li>check more deeply the <a href="html/libxml-lib.html">existing
302 generated doc</a>
303</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]304 <li>look for examples of use for libxml function using the Gnome code.
305 For example the following will query the full Gnome CVS base for the
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]306 use of the <strong>xmlAddChild()</strong> function:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]307 <p><a href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]308 <p>This may be slow, a large hardware donation to the gnome project
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]309 could cure this :-)</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]310 </li>
311 <li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]312<a href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Browse
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]313 the libxml source</a> , I try to write code as clean and documented
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]314 as possible, so looking at it may be helpful. In particular the code of
315 xmllint.c and of the various testXXX.c test programs should provide
316 good examples of how to do things with the library.</li>
317 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]318</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]319 <li>What about C++ ?
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]320 <p>libxml is written in pure C in order to allow easy reuse on a number
321 of platforms, including embedded systems. I don't intend to convert to
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]322 C++.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]323 <p>There are however a few C++ wrappers which may fulfill your needs:</p>
324 <ul>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]325<li>by Ari Johnson &lt;ari@btigate.com&gt;:
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]326 <p>Website: <a href="http://lusis.org/~ari/xml%2B%2B/">http://lusis.org/~ari/xml++/</a>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]327</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]328 <p>Download: <a href="http://lusis.org/~ari/xml%2B%2B/libxml%2B%2B.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]329</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]330 </li>
331 <li>by Peter Jones &lt;pjones@pmade.org&gt;
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]332 <p>Website: <a href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a>
333</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]334 </li>
335 </ul>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]336</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]337 <li>How to validate a document a posteriori ?
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]338 <p>It is possible to validate documents which had not been validated at
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]339 initial parsing time or documents which have been built from scratch using
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]340 the API. Use the <a href="http://xmlsoft.org/html/libxml-valid.html#XMLVALIDATEDTD">xmlValidateDtd()</a>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]341 function. It is also possible to simply add a DTD to an existing
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]342 document:</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]343 <pre>xmlDocPtr doc; /* your existing document */
344xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
345
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]346 dtd-&gt;name = xmlStrDup((xmlChar*)&quot;root_name&quot;); /* use the given root */
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]347
Daniel Veillarde9202a02000-10-16 16:58:19 +0000[diff] [blame]348 doc-&gt;intSubset = dtd;
349 if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
350 else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]351 </pre>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame^]352 </li>
353 <li>etc ...</li>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]354</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]355<p>
Daniel Veillard3f4c40f2002-02-13 09:19:28 +0000[diff] [blame]356<p><a href="bugs.html">Daniel Veillard</a></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]357</td></tr></table></td></tr></table></td></tr></table></td>
358</tr></table></td></tr></table>
Daniel Veillardaf743792000-07-01 11:49:28 +0000[diff] [blame]359</body>
360</html>