libxml2/doc/FAQ.html

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