Daniel Veillard | 43d3f61 | 2001-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 Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 2 | <html> |
| 3 | <head> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 4 | <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"> |
Daniel Veillard | c332dab | 2002-03-29 14:08:27 +0000 | [diff] [blame] | 5 | <link rel="SHORTCUT ICON" href="/favicon.ico"> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 6 | <style type="text/css"><!-- |
Daniel Veillard | 373a475 | 2002-02-21 14:46:29 +0000 | [diff] [blame] | 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} |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 12 | A:link, A:visited, A:active { text-decoration: underline } |
| 13 | --></style> |
| 14 | <title>FAQ</title> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 15 | </head> |
Daniel Veillard | b8cfbd1 | 2001-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 Veillard | 8acca11 | 2002-01-21 09:52:27 +0000 | [diff] [blame] | 30 | <tr><td bgcolor="#fffacd"><ul> |
Daniel Veillard | b8cfbd1 | 2001-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 Veillard | 7b602b4 | 2002-01-08 13:26:00 +0000 | [diff] [blame] | 39 | <li><a href="XMLinfo.html">XML</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 40 | <li><a href="XSLT.html">XSLT</a></li> |
Daniel Veillard | 6dbcaf8 | 2002-02-20 14:37:47 +0000 | [diff] [blame] | 41 | <li><a href="python.html">Python and bindings</a></li> |
Daniel Veillard | b8cfbd1 | 2001-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 & 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 Veillard | 52dcab3 | 2001-10-30 12:51:17 +0000 | [diff] [blame] | 54 | <li><a href="threads.html">Thread safety</a></li> |
Daniel Veillard | b8cfbd1 | 2001-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> |
| 58 | <li> |
| 59 | <a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a> |
| 60 | </li> |
| 61 | </ul></td></tr> |
| 62 | </table> |
| 63 | <table width="100%" border="0" cellspacing="1" cellpadding="3"> |
Daniel Veillard | 3bf65be | 2002-01-23 12:36:34 +0000 | [diff] [blame] | 64 | <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr> |
| 65 | <tr><td bgcolor="#fffacd"><ul> |
Daniel Veillard | f859256 | 2002-01-23 17:58:17 +0000 | [diff] [blame] | 66 | <li><a href="APIchunk0.html">Alphabetic</a></li> |
Daniel Veillard | 3bf65be | 2002-01-23 12:36:34 +0000 | [diff] [blame] | 67 | <li><a href="APIconstructors.html">Constructors</a></li> |
| 68 | <li><a href="APIfunctions.html">Functions/Types</a></li> |
| 69 | <li><a href="APIfiles.html">Modules</a></li> |
| 70 | <li><a href="APIsymbols.html">Symbols</a></li> |
| 71 | </ul></td></tr> |
| 72 | </table> |
| 73 | <table width="100%" border="0" cellspacing="1" cellpadding="3"> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 74 | <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr> |
Daniel Veillard | 8acca11 | 2002-01-21 09:52:27 +0000 | [diff] [blame] | 75 | <tr><td bgcolor="#fffacd"><ul> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 76 | <li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li> |
| 77 | <li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li> |
Daniel Veillard | 4a85920 | 2002-01-08 11:49:22 +0000 | [diff] [blame] | 78 | <li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li> |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 79 | <li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 80 | <li><a href="ftp://xmlsoft.org/">FTP</a></li> |
| 81 | <li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li> |
Daniel Veillard | db9dfd9 | 2001-11-26 17:25:02 +0000 | [diff] [blame] | 82 | <li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li> |
Daniel Veillard | e6d8e20 | 2002-05-02 06:11:10 +0000 | [diff] [blame^] | 83 | <li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li> |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 84 | <li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&product=libxml2">Bug Tracker</a></li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 85 | </ul></td></tr> |
| 86 | </table> |
| 87 | </td></tr></table></td> |
| 88 | <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 Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 89 | <p>Table of Content:</p> |
| 90 | <ul> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 91 | <li><a href="FAQ.html#Licence">Licence(s)</a></li> |
| 92 | <li><a href="FAQ.html#Installati">Installation</a></li> |
| 93 | <li><a href="FAQ.html#Compilatio">Compilation</a></li> |
| 94 | <li><a href="FAQ.html#Developer">Developer corner</a></li> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 95 | </ul> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 96 | <h3> |
| 97 | <a name="Licence">Licence</a>(s)</h3> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 98 | <ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 99 | <li> |
| 100 | <em>Licensing Terms for libxml</em> |
Daniel Veillard | c575b99 | 2002-02-08 13:28:40 +0000 | [diff] [blame] | 101 | <p>libxml is released under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT |
| 102 | Licence</a>, see the file Copyright in the distribution for the precise |
| 103 | wording</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 104 | </li> |
| 105 | <li> |
| 106 | <em>Can I embed libxml in a proprietary application ?</em> |
Daniel Veillard | c575b99 | 2002-02-08 13:28:40 +0000 | [diff] [blame] | 107 | <p>Yes. The MIT Licence allows you to also keep proprietary the changes |
| 108 | you made to libxml, but it would be graceful to provide back bugfixes and |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 109 | improvements as patches for possible incorporation in the main |
| 110 | development tree</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 111 | </li> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 112 | </ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 113 | <h3><a name="Installati">Installation</a></h3> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 114 | <ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 115 | <li>Unless you are forced to because your application links with a Gnome |
Daniel Veillard | e0c1d72 | 2001-03-21 10:28:36 +0000 | [diff] [blame] | 116 | library requiring it, <strong><span style="background-color: #FF0000">Do |
| 117 | Not Use libxml1</span></strong>, use libxml2</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 118 | <li> |
Daniel Veillard | af43f63 | 2002-03-08 15:05:20 +0000 | [diff] [blame] | 119 | <em>Where can I get libxml</em> ? |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 120 | <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> |
| 121 | </p> |
| 122 | <p>Most linux and Bsd distribution includes libxml, this is probably the |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 123 | safer way for end-users</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 124 | <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> |
| 125 | </p> |
| 126 | </li> |
| 127 | <li> |
| 128 | <em>I see libxml and libxml2 releases, which one should I install ?</em> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 129 | <ul> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 130 | <li>If you are not concerned by any existing backward compatibility |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 131 | with existing application, install libxml2 only</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 132 | <li>If you are not doing development, you can safely install both. |
| 133 | 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 |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 134 | compatible (this is not the case for development packages)</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 135 | <li>If you are a developer and your system provides separate packaging |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 136 | for shared libraries and the development components, it is possible |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 137 | to install libxml and libxml2, and also <a href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a> |
| 138 | and <a href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a> |
Daniel Veillard | 480363b | 2001-03-16 22:04:15 +0000 | [diff] [blame] | 139 | too for libxml2 >= 2.3.0</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 140 | <li>If you are developing a new application, please develop against |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 141 | libxml2(-devel)</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 142 | </ul> |
| 143 | </li> |
| 144 | <li> |
| 145 | <em>I can't install the libxml package it conflicts with libxml0</em> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 146 | <p>You probably have an old libxml0 package used to provide the shared |
| 147 | library for libxml.so.0, you can probably safely remove it. Anyway the |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 148 | libxml packages provided on <a href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> provides |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 149 | libxml.so.0</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 150 | </li> |
| 151 | <li> |
| 152 | <em>I can't install the libxml(2) RPM package due to failed |
Daniel Veillard | c654d60 | 2001-05-01 12:42:26 +0000 | [diff] [blame] | 153 | dependancies</em> |
| 154 | <p>The most generic solution is to refetch the latest src.rpm , and |
| 155 | rebuild it locally with</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 156 | <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code></p> |
| 157 | <p>if everything goes well it will generate two binary rpm (one providing |
Daniel Veillard | c654d60 | 2001-05-01 12:42:26 +0000 | [diff] [blame] | 158 | the shared libs and xmllint, and the other one, the -devel package |
| 159 | providing includes, static libraries and scripts needed to build |
| 160 | applications with libxml(2)) that you can install locally.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 161 | </li> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 162 | </ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 163 | <h3><a name="Compilatio">Compilation</a></h3> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 164 | <ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 165 | <li> |
| 166 | <em>What is the process to compile libxml ?</em> |
| 167 | <p>As most UNIX libraries libxml follows the "standard":</p> |
| 168 | <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p> |
| 169 | <p><code>cd libxml-xxxx</code></p> |
| 170 | <p><code>./configure --help</code></p> |
| 171 | <p>to see the options, then the compilation/installation proper</p> |
| 172 | <p><code>./configure [possible options]</code></p> |
| 173 | <p><code>make</code></p> |
| 174 | <p><code>make install</code></p> |
| 175 | <p>At that point you may have to rerun ldconfig or similar utility to |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 176 | update your list of installed shared libs.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 177 | </li> |
| 178 | <li> |
| 179 | <em>What other libraries are needed to compile/install libxml ?</em> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 180 | <p>Libxml does not requires any other library, the normal C ANSI API |
| 181 | should be sufficient (please report any violation to this rule you may |
| 182 | find).</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 183 | <p>However if found at configuration time libxml will detect and use the |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 184 | following libs:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 185 | <ul> |
| 186 | <li> |
Daniel Veillard | af43f63 | 2002-03-08 15:05:20 +0000 | [diff] [blame] | 187 | <a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a |
| 188 | highly portable and available widely compression library</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 189 | <li>iconv: a powerful character encoding conversion library. It's |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 190 | included by default on recent glibc libraries, so it doesn't need to |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 191 | be installed specifically on linux. It seems it's now <a href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part |
| 192 | of the official UNIX</a> specification. Here is one <a href="http://clisp.cons.org/~haible/packages-libiconv.html">implementation |
| 193 | of the library</a> which source can be found <a href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li> |
| 194 | </ul> |
| 195 | </li> |
| 196 | <li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 197 | <em>make check fails on some platforms</em> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 198 | <p>Sometime the regression tests results don't completely match the value |
| 199 | produced by the parser, and the makefile uses diff to print the delta. On |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 200 | some platforms the diff return breaks the compilation process, if the |
Daniel Veillard | e46182c | 2002-02-12 14:29:11 +0000 | [diff] [blame] | 201 | diff is small this is probably not a serious problem.</p> |
| 202 | <p>Sometimes (especially on Solaris) make checks fails due to limitations |
| 203 | in make. Try using GNU-make instead.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 204 | </li> |
| 205 | <li> |
| 206 | <em>I use the CVS version and there is no configure script</em> |
Daniel Veillard | 6761eee | 2001-06-11 10:29:38 +0000 | [diff] [blame] | 207 | <p>The configure (and other Makefiles) are generated. Use the autogen.sh |
| 208 | script to regenerate the configure and Makefiles, like:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 209 | <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p> |
| 210 | </li> |
| 211 | <li> |
| 212 | <em>I have troubles when running make tests with gcc-3.0</em> |
Daniel Veillard | 7b06bcb | 2001-06-22 16:03:51 +0000 | [diff] [blame] | 213 | <p>It seems the initial release of gcc-3.0 has a problem with the |
| 214 | optimizer which miscompiles the URI module. Please use another |
| 215 | compiler</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 216 | </li> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 217 | </ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 218 | <h3> |
| 219 | <a name="Developer">Developer</a> corner</h3> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 220 | <ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 221 | <li> |
| 222 | <em>xmlDocDump() generates output on one line</em> |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 223 | <p>libxml will not <strong>invent</strong> spaces in the content of a |
| 224 | document since <strong>all spaces in the content of a document are |
| 225 | significant</strong>. If you build a tree from the API and want |
| 226 | indentation:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 227 | <ol> |
| 228 | <li>the correct way is to generate those yourself too</li> |
| 229 | <li>the dangerous way is to ask libxml to add those blanks to your |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 230 | content <strong>modifying the content of your document in the |
| 231 | process</strong>. The result may not be what you expect. There is |
| 232 | <strong>NO</strong> way to guarantee that such a modification won't |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 233 | impact other part of the content of your document. See <a href="http://xmlsoft.org/html/libxml-parser.html#XMLKEEPBLANKSDEFAULT">xmlKeepBlanksDefault |
| 234 | ()</a> and <a href="http://xmlsoft.org/html/libxml-tree.html#XMLSAVEFORMATFILE">xmlSaveFormatFile |
| 235 | ()</a> |
| 236 | </li> |
| 237 | </ol> |
| 238 | </li> |
| 239 | <li>Extra nodes in the document: |
Daniel Veillard | 62bccd5 | 2001-02-10 09:40:10 +0000 | [diff] [blame] | 240 | <p><em>For a XML file as below:</em></p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 241 | <pre><?xml version="1.0"?> |
| 242 | <PLAN xmlns="http://www.argus.ca/autotest/1.0/"> |
| 243 | <NODE CommFlag="0"/> |
| 244 | <NODE CommFlag="1"/> |
Daniel Veillard | 62bccd5 | 2001-02-10 09:40:10 +0000 | [diff] [blame] | 245 | </PLAN></pre> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 246 | <p><em>after parsing it with the function |
Daniel Veillard | 480363b | 2001-03-16 22:04:15 +0000 | [diff] [blame] | 247 | pxmlDoc=xmlParseFile(...);</em></p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 248 | <p><em>I want to the get the content of the first node (node with the |
| 249 | CommFlag="0")</em></p> |
| 250 | <p><em>so I did it as following;</em></p> |
| 251 | <pre>xmlNodePtr pode; |
Daniel Veillard | 62bccd5 | 2001-02-10 09:40:10 +0000 | [diff] [blame] | 252 | pnode=pxmlDoc->children->children;</pre> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 253 | <p><em>but it does not work. If I change it to</em></p> |
| 254 | <pre>pnode=pxmlDoc->children->children->next;</pre> |
| 255 | <p><em>then it works. Can someone explain it to me.</em></p> |
| 256 | <p> |
| 257 | <p>In XML all characters in the content of the document are significant |
Daniel Veillard | 7f41b3e | 2001-02-10 09:35:37 +0000 | [diff] [blame] | 258 | <strong>including blanks and formatting line breaks</strong>.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 259 | <p>The extra nodes you are wondering about are just that, text nodes with |
Daniel Veillard | 7f41b3e | 2001-02-10 09:35:37 +0000 | [diff] [blame] | 260 | the formatting spaces wich are part of the document but that people tend |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 261 | to forget. There is a function <a href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault |
Daniel Veillard | 7f41b3e | 2001-02-10 09:35:37 +0000 | [diff] [blame] | 262 | ()</a> to remove those at parse time, but that's an heuristic, and its |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 263 | use should be limited to case where you are sure there is no |
| 264 | mixed-content in the document.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 265 | </li> |
| 266 | <li> |
| 267 | <em>I get compilation errors of existing code like when accessing |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 268 | <strong>root</strong> or <strong>childs fields</strong> of nodes</em> |
Daniel Veillard | 3f3b4f3 | 2001-03-13 15:12:39 +0000 | [diff] [blame] | 269 | <p>You are compiling code developed for libxml version 1 and using a |
| 270 | libxml2 development environment. Either switch back to libxml v1 devel or |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 271 | even better fix the code to compile with libxml2 (or both) by <a href="upgrade.html">following the instructions</a>.</p> |
| 272 | </li> |
| 273 | <li> |
| 274 | <em>I get compilation errors about non existing |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 275 | <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong> |
| 276 | fields</em> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 277 | <p>The source code you are using has been <a href="upgrade.html">upgraded</a> to be able to compile with both libxml |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 278 | and libxml2, but you need to install a more recent version: |
| 279 | libxml(-devel) >= 1.8.8 or libxml2(-devel) >= 2.1.0</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 280 | </li> |
| 281 | <li> |
| 282 | <em>XPath implementation looks seriously broken</em> |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 283 | <p>XPath implementation prior to 2.3.0 was really incomplete, upgrade to |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 284 | a recent version, there is no known bug in the current version.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 285 | </li> |
| 286 | <li> |
| 287 | <em>The example provided in the web page does not compile</em> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 288 | <p>It's hard to maintain the documentation in sync with the code |
Daniel Veillard | e9202a0 | 2000-10-16 16:58:19 +0000 | [diff] [blame] | 289 | <grin/> ...</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 290 | <p>Check the previous points 1/ and 2/ raised before, and send |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 291 | patches.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 292 | </li> |
| 293 | <li> |
| 294 | <em>Where can I get more examples and informations than in the web |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 295 | page</em> |
| 296 | <p>Ideally a libxml book would be nice. I have no such plan ... But you |
| 297 | can:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 298 | <ul> |
| 299 | <li>check more deeply the <a href="html/libxml-lib.html">existing |
| 300 | generated doc</a> |
| 301 | </li> |
| 302 | <li>looks for examples of use for libxml function using the Gnome code |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 303 | for example the following will query the full Gnome CVs base for the |
| 304 | use of the <strong>xmlAddChild()</strong> function: |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 305 | <p><a href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p> |
| 306 | <p>This may be slow, a large hardware donation to the gnome project |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 307 | could cure this :-)</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 308 | </li> |
| 309 | <li> |
| 310 | <a href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gnome-xml">Browse |
Daniel Veillard | af43f63 | 2002-03-08 15:05:20 +0000 | [diff] [blame] | 311 | the libxml source</a> , I try to write code as clean and documented |
Daniel Veillard | 2d347fa | 2002-03-17 10:34:11 +0000 | [diff] [blame] | 312 | as possible, so looking at it may be helpful. Especially the code of |
| 313 | xmllint.c and of the various testXXX.c tests programs should provide |
| 314 | good example on how to do things with the library.</li> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 315 | </ul> |
| 316 | </li> |
| 317 | <li>What about C++ ? |
Daniel Veillard | 008186f | 2001-09-13 14:24:44 +0000 | [diff] [blame] | 318 | <p>libxml is written in pure C in order to allow easy reuse on a number |
| 319 | of platforms, including embedded systems. I don't intend to convert to |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 320 | C++.</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 321 | <p>There is however a C++ wrapper provided by Ari Johnson |
Daniel Veillard | e9202a0 | 2000-10-16 16:58:19 +0000 | [diff] [blame] | 322 | <ari@btigate.com> which may fullfill your needs:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 323 | <p>Website: <a href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a> |
| 324 | </p> |
| 325 | <p>Download: <a href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a> |
| 326 | </p> |
| 327 | </li> |
| 328 | <li>How to validate a document a posteriori ? |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 329 | <p>It is possible to validate documents which had not been validated at |
| 330 | initial parsing time or documents who have been built from scratch using |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 331 | the API. Use the <a href="http://xmlsoft.org/html/libxml-valid.html#XMLVALIDATEDTD">xmlValidateDtd()</a> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 332 | function. It is also possible to simply add a Dtd to an existing |
| 333 | document:</p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 334 | <pre>xmlDocPtr doc; /* your existing document */ |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 335 | xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */ |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 336 | dtd->name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */ |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 337 | |
Daniel Veillard | e9202a0 | 2000-10-16 16:58:19 +0000 | [diff] [blame] | 338 | doc->intSubset = dtd; |
| 339 | if (doc->children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd); |
| 340 | else xmlAddPrevSibling(doc->children, (xmlNodePtr)dtd); |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 341 | </pre> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 342 | </li> |
| 343 | <li>etc ...</li> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 344 | </ol> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 345 | <p> |
Daniel Veillard | 3f4c40f | 2002-02-13 09:19:28 +0000 | [diff] [blame] | 346 | <p><a href="bugs.html">Daniel Veillard</a></p> |
Daniel Veillard | b8cfbd1 | 2001-10-25 10:53:28 +0000 | [diff] [blame] | 347 | </td></tr></table></td></tr></table></td></tr></table></td> |
| 348 | </tr></table></td></tr></table> |
Daniel Veillard | af74379 | 2000-07-01 11:49:28 +0000 | [diff] [blame] | 349 | </body> |
| 350 | </html> |