Daniel Veillard | 20c8cf2 | 2001-06-26 22:47:36 +0000 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" |
| 2 | "http://www.w3.org/TR/html4/loose.dtd"> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 3 | <html> |
| 4 | <head> |
Daniel Veillard | ec78c0f | 2000-08-25 10:25:23 +0000 | [diff] [blame] | 5 | <title>The XML C library for Gnome</title> |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 6 | <meta name="GENERATOR" content="amaya V4.1"> |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 7 | <meta http-equiv="Content-Type" content="text/html"> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 8 | </head> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 9 | |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 10 | <body bgcolor="#ffffff"> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 11 | <p><a href="http://www.gnome.org/"><img src="smallfootonly.gif" |
| 12 | alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" |
Daniel Veillard | b370a74 | 2001-06-09 16:58:47 +0000 | [diff] [blame] | 13 | alt="W3C Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif" |
| 14 | alt="Red Hat Logo"></a></p> |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 15 | |
Daniel Veillard | ec78c0f | 2000-08-25 10:25:23 +0000 | [diff] [blame] | 16 | <h1 align="center">The XML C library for Gnome</h1> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 17 | |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 18 | <h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2> |
| 19 | |
| 20 | <p></p> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 21 | <ul> |
| 22 | <li><a href="#Introducti">Introduction</a></li> |
| 23 | <li><a href="#Documentat">Documentation</a></li> |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 24 | <li><a href="#Reporting">Reporting bugs and getting help</a></li> |
| 25 | <li><a href="#help">how to help</a></li> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 26 | <li><a href="#Downloads">Downloads</a></li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 27 | <li><a href="#News">News</a></li> |
| 28 | <li><a href="#XML">XML</a></li> |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 29 | <li><a href="#XSLT">XSLT</a></li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 30 | <li><a href="#tree">The tree output</a></li> |
| 31 | <li><a href="#interface">The SAX interface</a></li> |
| 32 | <li><a href="#library">The XML library interfaces</a> |
| 33 | <ul> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 34 | <li><a href="#Invoking">Invoking the parser: the pull way</a></li> |
| 35 | <li><a href="#Invoking">Invoking the parser: the push way</a></li> |
| 36 | <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 37 | <li><a href="#Building">Building a tree from scratch</a></li> |
| 38 | <li><a href="#Traversing">Traversing the tree</a></li> |
| 39 | <li><a href="#Modifying">Modifying the tree</a></li> |
| 40 | <li><a href="#Saving">Saving the tree</a></li> |
| 41 | <li><a href="#Compressio">Compression</a></li> |
| 42 | </ul> |
| 43 | </li> |
| 44 | <li><a href="#Entities">Entities or no entities</a></li> |
| 45 | <li><a href="#Namespaces">Namespaces</a></li> |
| 46 | <li><a href="#Validation">Validation</a></li> |
| 47 | <li><a href="#Principles">DOM principles</a></li> |
| 48 | <li><a href="#real">A real example</a></li> |
Daniel Veillard | 9698445 | 2000-08-31 13:50:12 +0000 | [diff] [blame] | 49 | <li><a href="#Contributi">Contributions</a></li> |
| 50 | </ul> |
| 51 | |
| 52 | <p>Separate documents:</p> |
| 53 | <ul> |
| 54 | <li><a href="upgrade.html">upgrade instructions for migrating to |
| 55 | libxml2</a></li> |
| 56 | <li><a href="encoding.html">libxml Internationalization support</a></li> |
| 57 | <li><a href="xmlio.html">libxml Input/Output interfaces</a></li> |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 58 | <li><a href="xmlmem.html">libxml Memory interfaces</a></li> |
Daniel Veillard | 300f7d6 | 2000-11-24 13:04:04 +0000 | [diff] [blame] | 59 | <li><a href="xmldtd.html">a short introduction about DTDs and |
| 60 | libxml</a></li> |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 61 | <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a></li> |
Daniel Veillard | 7b06bcb | 2001-06-22 16:03:51 +0000 | [diff] [blame] | 62 | <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page: a |
| 63 | standard DOM interface for libxml2</a></li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 64 | </ul> |
| 65 | |
| 66 | <h2><a name="Introducti">Introduction</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 67 | |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 68 | <p>This document describes libxml, the <a |
Daniel Veillard | ec78c0f | 2000-08-25 10:25:23 +0000 | [diff] [blame] | 69 | href="http://www.w3.org/XML/">XML</a> C library developped for the <a |
| 70 | href="http://www.gnome.org/">Gnome</a> project. <a |
| 71 | href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based |
| 72 | structured documents/data.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 73 | |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 74 | <p>Here are some key points about libxml:</p> |
| 75 | <ul> |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 76 | <li>Libxml exports Push and Pull type parser interfaces for both XML and |
| 77 | HTML.</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 78 | <li>Libxml can do DTD validation at parse time, using a parsed document |
| 79 | instance, or with an arbitrary DTD.</li> |
| 80 | <li>Libxml now includes nearly complete <a |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 81 | href="http://www.w3.org/TR/xpath">XPath</a> and <a |
Daniel Veillard | 0c06922 | 2000-10-21 09:25:52 +0000 | [diff] [blame] | 82 | href="http://www.w3.org/TR/xptr">XPointer</a> implementations.</li> |
Daniel Veillard | ec78c0f | 2000-08-25 10:25:23 +0000 | [diff] [blame] | 83 | <li>It is written in plain C, making as few assumptions as possible, and |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 84 | sticking closely to ANSI C/POSIX for easy embedding. Works on |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 85 | Linux/Unix/Windows, ported to a number of other platforms.</li> |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 86 | <li>Basic support for HTTP and FTP client allowing aplications to fetch |
| 87 | remote resources</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 88 | <li>The design is modular, most of the extensions can be compiled out.</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 89 | <li>The internal document repesentation is as close as possible to the <a |
| 90 | href="http://www.w3.org/DOM/">DOM</a> interfaces.</li> |
| 91 | <li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 92 | like interface</a>; the interface is designed to be compatible with <a |
| 93 | href="http://www.jclark.com/xml/expat.html">Expat</a>.</li> |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 94 | <li>This library is released both under the <a |
| 95 | href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 96 | IPR</a> and the <a href="http://www.gnu.org/copyleft/lesser.html">GNU |
| 97 | LGPL</a>. Use either at your convenience, basically this should make |
| 98 | everybody happy, if not, drop me a mail.</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 99 | </ul> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 100 | |
Daniel Veillard | e0c1d72 | 2001-03-21 10:28:36 +0000 | [diff] [blame] | 101 | <p>Warning: unless you are forced to because your application links with a |
| 102 | Gnome library requiring it, <strong><span |
| 103 | style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use |
| 104 | libxml2</p> |
| 105 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 106 | <h2><a name="Documentat">Documentation</a></h2> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 107 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 108 | <p>There are some on-line resources about using libxml:</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 109 | <ol> |
Daniel Veillard | 365e13b | 2000-07-02 07:56:37 +0000 | [diff] [blame] | 110 | <li>Check the <a href="FAQ.html">FAQ</a></li> |
Daniel Veillard | c19fccc | 2000-07-03 11:52:01 +0000 | [diff] [blame] | 111 | <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive |
Daniel Veillard | 8c6d6af | 2000-08-25 17:14:13 +0000 | [diff] [blame] | 112 | documentation</a> automatically extracted from code comments (using <a |
| 113 | href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gtk-doc">gtk |
| 114 | doc</a>).</li> |
Daniel Veillard | 8d86964 | 2000-07-14 12:12:59 +0000 | [diff] [blame] | 115 | <li>Look at the documentation about <a href="encoding.html">libxml |
| 116 | internationalization support</a></li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 117 | <li>This page provides a global overview and <a href="#real">some |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 118 | examples</a> on how to use libxml.</li> |
| 119 | <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a |
| 120 | href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice |
| 121 | documentation</a> explaining how to use the libxml SAX interface.</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 122 | <li>George Lebl wrote <a |
| 123 | href="http://www-4.ibm.com/software/developer/library/gnome3/">an article |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 124 | for IBM developerWorks</a> about using libxml.</li> |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 125 | <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO |
| 126 | file</a></li> |
| 127 | <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are |
| 128 | starting a new project using libxml you should really use the 2.x |
| 129 | version.</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 130 | <li>And don't forget to look at the <a href="/messages/">mailing-list |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 131 | archive</a>.</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 132 | </ol> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 133 | |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 134 | <h2><a name="Reporting">Reporting bugs and getting help</a></h2> |
Daniel Veillard | 4c3a203 | 1999-11-19 17:46:26 +0000 | [diff] [blame] | 135 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 136 | <p>Well, bugs or missing features are always possible, and I will make a point |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 137 | of fixing them in a timely fashion. The best way to report a bug is to use the |
Daniel Veillard | 8178110 | 2001-03-07 09:31:47 +0000 | [diff] [blame] | 138 | <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome bug |
| 139 | tracking database</a> (make sure to use the "libxml" module name). I look at |
| 140 | reports there regularly and it's good to have a reminder when a bug is still |
Daniel Veillard | a41123c | 2001-04-22 19:31:20 +0000 | [diff] [blame] | 141 | open. Check the <a |
| 142 | href="http://bugzilla.gnome.org/bugwritinghelp.html">instructions on reporting |
| 143 | bugs</a> and be sure to specify that the bug is for the package libxml.</p> |
Daniel Veillard | 4c3a203 | 1999-11-19 17:46:26 +0000 | [diff] [blame] | 144 | |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 145 | <p>There is also a mailing-list <a |
Daniel Veillard | 3197f16 | 2001-04-04 00:40:08 +0000 | [diff] [blame] | 146 | href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a |
| 147 | href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a |
| 148 | href="http://xmlsoft.org/messages">old</a>). To subscribe to this list, please |
| 149 | visit the <a href="http://mail.gnome.org/mailman/listinfo/xml">associated |
Daniel Veillard | f5498f3 | 2001-06-25 15:08:36 +0000 | [diff] [blame] | 150 | Web</a> page and follow the instructions. <strong>Do not send code, I won't |
Daniel Veillard | b97b430 | 2001-06-26 23:04:22 +0000 | [diff] [blame] | 151 | debug it</strong> (but patches are really appreciated!), make sure you can |
| 152 | reproduce the bug with xmllint or one of the test programs found in source in |
| 153 | the distribution and send the command showing the error as well as the input |
| 154 | (as an attachement), thanks.</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 155 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 156 | <p>Alternatively, you can just send the bug to the <a |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 157 | href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml |
Daniel Veillard | 6e93c4a | 2001-06-05 20:57:42 +0000 | [diff] [blame] | 158 | related I will approve it.. Please do not send me mail directly especially for |
| 159 | portability problem, it makes things really harder to track and in some cases |
| 160 | I'm not the best person to answer a given question, ask the list instead.</p> |
Daniel Veillard | 4c3a203 | 1999-11-19 17:46:26 +0000 | [diff] [blame] | 161 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 162 | <p>Of course, bugs reported with a suggested patch for fixing them will |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 163 | probably be processed faster.</p> |
| 164 | |
| 165 | <p>If you're looking for help, a quick look at <a |
| 166 | href="http://xmlsoft.org/messages/#407">the list archive</a> may actually |
| 167 | provide the answer, I usually send source samples when answering libxml usage |
Daniel Veillard | 6f0adb5 | 2000-07-03 11:41:26 +0000 | [diff] [blame] | 168 | questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 169 | documentantion</a> is not as polished as I would like (i need to learn more |
| 170 | about Docbook), but it's a good starting point.</p> |
| 171 | |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 172 | <h2><a name="help">How to help</a></h2> |
| 173 | |
| 174 | <p>You can help the project in various ways, the best thing to do first is to |
| 175 | subscribe to the mailing-list as explained before, check the <a |
| 176 | href="http://xmlsoft.org/messages/">archives </a>and the <a |
| 177 | href="http://bugs.gnome.org/db/pa/lgnome-xml.html">Gnome bug |
| 178 | database:</a>:</p> |
| 179 | <ol> |
| 180 | <li>provide patches when you find problems</li> |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 181 | <li>provide the diffs when you port libxml to a new platform. They may not |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 182 | be integrated in all cases but help pinpointing portability problems |
| 183 | and</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 184 | <li>provide documentation fixes (either as patches to the code comments or |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 185 | as HTML diffs).</li> |
| 186 | <li>provide new documentations pieces (translations, examples, etc ...)</li> |
| 187 | <li>Check the TODO file and try to close one of the items</li> |
| 188 | <li>take one of the points raised in the archive or the bug database and |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 189 | provide a fix. <a href="mailto:Daniel.Veillard@imag.fr">Get in touch with |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 190 | me </a>before to avoid synchronization problems and check that the |
| 191 | suggested fix will fit in nicely :-)</li> |
| 192 | </ol> |
| 193 | |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 194 | <h2><a name="Downloads">Downloads</a></h2> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 195 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 196 | <p>The latest versions of libxml can be found on <a |
Daniel Veillard | 20c8cf2 | 2001-06-26 22:47:36 +0000 | [diff] [blame] | 197 | href="ftp://xmlsoft.org/">xmlsoft.org</a> (<a |
| 198 | href="ftp://speakeasy.rpmfind.net/pub/libxml/">Seattle</a>, <a |
| 199 | href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 200 | href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 201 | as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 202 | archive</a> or <a |
Daniel Veillard | a41123c | 2001-04-22 19:31:20 +0000 | [diff] [blame] | 203 | href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM |
| 204 | packages</a>. (NOTE that you need both the <a |
Daniel Veillard | c19fccc | 2000-07-03 11:52:01 +0000 | [diff] [blame] | 205 | href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a |
| 206 | href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 207 | packages installed to compile applications using libxml.)</p> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 208 | |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 209 | <p><a name="Snapshot">Snapshot:</a></p> |
| 210 | <ul> |
| 211 | <li>Code from the W3C cvs base libxml <a |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 212 | href="ftp://xmlsoft.org/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 213 | <li>Docs, content of the web site, the list archive included <a |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 214 | href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 215 | </ul> |
| 216 | |
| 217 | <p><a name="Contribs">Contribs:</a></p> |
| 218 | |
| 219 | <p>I do accept external contributions, especially if compiling on another |
| 220 | platform, get in touch with me to upload the package. I will keep them in the |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 221 | <a href="ftp://xmlsoft.org/contribs/">contrib directory</a></p> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 222 | |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 223 | <p>Libxml is also available from CVS:</p> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 224 | <ul> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 225 | <li><p>The <a |
| 226 | href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&dir=gnome-xml">Gnome |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 227 | CVS base</a>. Check the <a |
| 228 | href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> page; |
| 229 | the CVS module is <b>gnome-xml</b>.</p> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 230 | </li> |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 231 | <li>The <strong>libxslt</strong> module is also present there</li> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 232 | </ul> |
| 233 | |
| 234 | <h2><a name="News">News</a></h2> |
| 235 | |
Daniel Veillard | 944b5ff | 1999-12-15 19:08:24 +0000 | [diff] [blame] | 236 | <h3>CVS only : check the <a |
| 237 | href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 238 | for a really accurate description</h3> |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 239 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 240 | <p>Items floating around but not actively worked on, get in touch with me if |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 241 | you want to test those</p> |
| 242 | <ul> |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 243 | <li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done as |
Daniel Veillard | 823a77f | 2001-06-26 23:07:32 +0000 | [diff] [blame^] | 244 | a separate C library on top of libxml called libxslt</li> |
Daniel Veillard | 28929b2 | 2000-11-13 18:22:49 +0000 | [diff] [blame] | 245 | <li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a |
| 246 | href="http://www.w3.org/TR/xinclude">XInclude</a></li> |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 247 | <li>(seeems working but delayed from release) parsing/import of Docbook SGML |
| 248 | docs</li> |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 249 | </ul> |
| 250 | |
Daniel Veillard | 1164810 | 2001-06-26 16:08:24 +0000 | [diff] [blame] | 251 | <h3>2.3.12: June 26 2001</h3> |
| 252 | <ul> |
| 253 | <li>lots of cleanup</li> |
| 254 | <li>a couple of validation fix</li> |
| 255 | <li>fixed line number counting</li> |
| 256 | <li>fixed serious problems in the XInclude processing</li> |
| 257 | <li>added support for UTF8 BOM at beginning of entities</li> |
| 258 | <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0 |
| 259 | miscompile uri.c (William), Thomas Leitner provided a fix for the |
| 260 | optimizer on Tru64</li> |
| 261 | <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for |
| 262 | compilation on Windows MSC</li> |
| 263 | <li>update of libxml-doc.el (Felix Natter)</li> |
| 264 | <li>fixed 2 bugs in URI normalization code</li> |
| 265 | </ul> |
| 266 | |
Daniel Veillard | e3c81b5 | 2001-06-17 14:50:34 +0000 | [diff] [blame] | 267 | <h3>2.3.11: June 17 2001</h3> |
| 268 | <ul> |
| 269 | <li>updates to trio, Makefiles and configure should fix some portability |
| 270 | problems (alpha)</li> |
| 271 | <li>fixed some HTML serialization problems (pre, script, and block/inline |
| 272 | handling), added encoding aware APIs, cleanup of this code</li> |
| 273 | <li>added xmlHasNsProp()</li> |
| 274 | <li>implemented a specific PI for encoding support in the DocBook SGML |
| 275 | parser</li> |
| 276 | <li>some XPath fixes (-Infinity, / as a function parameter and namespaces |
| 277 | node selection)</li> |
| 278 | <li>fixed a performance problem and an error in the validation code</li> |
| 279 | <li>fixed XInclude routine to implement the recursive behaviour</li> |
| 280 | <li>fixed xmlFreeNode problem when libxml is included statically twice</li> |
| 281 | <li>added --version to xmllint for bug reports</li> |
| 282 | </ul> |
| 283 | |
Daniel Veillard | 2e4f188 | 2001-06-01 10:11:57 +0000 | [diff] [blame] | 284 | <h3>2.3.10: June 1 2001</h3> |
| 285 | <ul> |
| 286 | <li>fixed the SGML catalog support</li> |
| 287 | <li>a number of reported bugs got fixed, in XPath, iconv detection, XInclude |
| 288 | processing</li> |
| 289 | <li>XPath string function should now handle unicode correctly</li> |
| 290 | </ul> |
| 291 | |
Daniel Veillard | 4623acd | 2001-05-19 15:13:15 +0000 | [diff] [blame] | 292 | <h3>2.3.9: May 19 2001</h3> |
| 293 | |
| 294 | <p>Lots of bugfixes, and added a basic SGML catalog support:</p> |
| 295 | <ul> |
| 296 | <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li> |
| 297 | <li>some serious speed optimisation again</li> |
| 298 | <li>some documentation cleanups</li> |
| 299 | <li>trying to get better linking on solaris (-R)</li> |
| 300 | <li>XPath API cleanup from Thomas Broyer</li> |
| 301 | <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed |
| 302 | xmlValidGetValidElements()</li> |
| 303 | <li>Added an INSTALL file</li> |
| 304 | <li>Attribute removal added to API: #54433</li> |
| 305 | <li>added a basic support for SGML catalogs</li> |
| 306 | <li>fixed xmlKeepBlanksDefault(0) API</li> |
| 307 | <li>bugfix in xmlNodeGetLang()</li> |
| 308 | <li>fixed a small configure portability problem</li> |
| 309 | <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li> |
| 310 | </ul> |
| 311 | |
Daniel Veillard | a265af7 | 2001-05-14 11:13:58 +0000 | [diff] [blame] | 312 | <h3>1.8.13: May 14 2001</h3> |
| 313 | <ul> |
| 314 | <li>bugfixes release of the old libxml1 branch used by Gnome</li> |
| 315 | </ul> |
| 316 | |
Daniel Veillard | 3bbbe6f | 2001-05-03 11:15:37 +0000 | [diff] [blame] | 317 | <h3>2.3.8: May 3 2001</h3> |
| 318 | <ul> |
| 319 | <li>Integrated an SGML DocBook parser for the Gnome project</li> |
| 320 | <li>Fixed a few things in the HTML parser</li> |
| 321 | <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating |
| 322 | point portability issue</li> |
| 323 | <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for DOM+validation |
| 324 | using the XML REC as input and a 700MHz celeron).</li> |
| 325 | <li>incorporated more Windows cleanup</li> |
| 326 | <li>added xmlSaveFormatFile()</li> |
| 327 | <li>fixed problems in copying nodes with entities references (gdome)</li> |
| 328 | <li>removed some troubles surrounding the new validation module</li> |
| 329 | </ul> |
| 330 | |
Daniel Veillard | a41123c | 2001-04-22 19:31:20 +0000 | [diff] [blame] | 331 | <h3>2.3.7: April 22 2001</h3> |
| 332 | <ul> |
| 333 | <li>lots of small bug fixes, corrected XPointer</li> |
| 334 | <li>Non determinist content model validation support</li> |
| 335 | <li>added xmlDocCopyNode for gdome2</li> |
| 336 | <li>revamped the way the HTML parser handles end of tags</li> |
| 337 | <li>XPath: corrctions of namespacessupport and number formatting</li> |
| 338 | <li>Windows: Igor Zlatkovic patches for MSC compilation</li> |
| 339 | <li>HTML ouput fixes from P C Chow and William M. Brack</li> |
| 340 | <li>Improved validation speed sensible for DocBook</li> |
| 341 | <li>fixed a big bug with ID declared in external parsed entities</li> |
| 342 | <li>portability fixes, update of Trio from Bjorn Reese</li> |
| 343 | </ul> |
| 344 | |
Daniel Veillard | afc7311 | 2001-04-11 11:51:41 +0000 | [diff] [blame] | 345 | <h3>2.3.6: April 8 2001</h3> |
| 346 | <ul> |
| 347 | <li>Code cleanup using extreme gcc compiler warning options, found and |
| 348 | cleared half a dozen potential problem</li> |
| 349 | <li>the Eazel team found an XML parser bug</li> |
| 350 | <li>cleaned up the user of some of the string formatting function. used the |
| 351 | trio library code to provide the one needed when the platform is missing |
| 352 | them</li> |
| 353 | <li>xpath: removed a memory leak and fixed the predicate evaluation problem, |
| 354 | extended the testsuite and cleaned up the result. XPointer seems broken |
| 355 | ...</li> |
| 356 | </ul> |
| 357 | |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 358 | <h3>2.3.5: Mar 23 2001</h3> |
| 359 | <ul> |
| 360 | <li>Biggest change is separate parsing and evaluation of XPath expressions, |
| 361 | there is some new APIs for this too</li> |
| 362 | <li>included a number of bug fixes(XML push parser, 51876, notations, |
| 363 | 52299)</li> |
| 364 | <li>Fixed some portability issues</li> |
| 365 | </ul> |
| 366 | |
Daniel Veillard | e356c28 | 2001-03-10 12:32:04 +0000 | [diff] [blame] | 367 | <h3>2.3.4: Mar 10 2001</h3> |
| 368 | <ul> |
| 369 | <li>Fixed bugs #51860 and #51861</li> |
| 370 | <li>Added a global variable xmlDefaultBufferSize to allow default buffer |
| 371 | size to be application tunable.</li> |
| 372 | <li>Some cleanup in the validation code, still a bug left and this part |
| 373 | should probably be rewritten to support ambiguous content model :-\</li> |
| 374 | <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3 |
| 375 | parser</li> |
| 376 | <li>Fixed another bug in xmlNodeGetContent()</li> |
| 377 | <li>Bjorn fixed XPath node collection and Number formatting</li> |
| 378 | <li>Fixed a loop reported in the HTML parsing</li> |
| 379 | <li>blank space are reported even if the Dtd content model proves that they |
| 380 | are formatting spaces, this is for XmL conformance</li> |
| 381 | </ul> |
| 382 | |
Daniel Veillard | b402c07 | 2001-03-01 17:28:58 +0000 | [diff] [blame] | 383 | <h3>2.3.3: Mar 1 2001</h3> |
| 384 | <ul> |
| 385 | <li>small change in XPath for XSLT</li> |
| 386 | <li>documentation cleanups</li> |
| 387 | <li>fix in validation by Gary Pennington</li> |
| 388 | <li>serious parsing performances improvements</li> |
| 389 | </ul> |
| 390 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 391 | <h3>2.3.2: Feb 24 2001</h3> |
Daniel Veillard | 7168110 | 2001-02-24 17:48:53 +0000 | [diff] [blame] | 392 | <ul> |
| 393 | <li>chasing XPath bugs, found a bunch, completed some TODO</li> |
| 394 | <li>fixed a Dtd parsing bug</li> |
| 395 | <li>fixed a bug in xmlNodeGetContent</li> |
| 396 | <li>ID/IDREF support partly rewritten by Gary Pennington</li> |
| 397 | </ul> |
| 398 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 399 | <h3>2.3.1: Feb 15 2001</h3> |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 400 | <ul> |
| 401 | <li>some XPath and HTML bug fixes for XSLT</li> |
| 402 | <li>small extension of the hash table interfaces for DOM gdome2 |
| 403 | implementation</li> |
| 404 | <li>A few bug fixes</li> |
| 405 | </ul> |
| 406 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 407 | <h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3> |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 408 | <ul> |
| 409 | <li>Lots of XPath bug fixes</li> |
| 410 | <li>Add a mode with Dtd lookup but without validation error reporting for |
| 411 | XSLT</li> |
| 412 | <li>Add support for text node without escaping (XSLT)</li> |
| 413 | <li>bug fixes for xmlCheckFilename</li> |
| 414 | <li>validation code bug fixes from Gary Pennington</li> |
| 415 | <li>Patch from Paul D. Smith correcting URI path normalization</li> |
| 416 | <li>Patch to allow simultaneous install of libxml-devel and |
| 417 | libxml2-devel</li> |
| 418 | <li>the example Makefile is now fixed</li> |
| 419 | <li>added HTML to the RPM packages</li> |
| 420 | <li>tree copying bugfixes</li> |
| 421 | <li>updates to Windows makefiles</li> |
| 422 | <li>optimisation patch from Bjorn Reese</li> |
| 423 | </ul> |
| 424 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 425 | <h3>2.2.11: Jan 4 2001</h3> |
Daniel Veillard | 503b893 | 2001-01-05 06:36:31 +0000 | [diff] [blame] | 426 | <ul> |
| 427 | <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li> |
| 428 | <li>added htmlHandleOmittedElem()</li> |
| 429 | <li>Applied Bjorn Reese's IPV6 first patch</li> |
| 430 | <li>Applied Paul D. Smith patches for validation of XInclude results</li> |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 431 | <li>added XPointer xmlns() new scheme support</li> |
Daniel Veillard | 503b893 | 2001-01-05 06:36:31 +0000 | [diff] [blame] | 432 | </ul> |
| 433 | |
Daniel Veillard | 2ddd23d | 2000-11-25 10:42:19 +0000 | [diff] [blame] | 434 | <h3>2.2.10: Nov 25 2000</h3> |
Daniel Veillard | 9d343c4 | 2000-11-25 10:12:43 +0000 | [diff] [blame] | 435 | <ul> |
| 436 | <li>Fix the Windows problems of 2.2.8</li> |
| 437 | <li>integrate OpenVMS patches</li> |
| 438 | <li>better handling of some nasty HTML input</li> |
| 439 | <li>Improved the XPointer implementation</li> |
| 440 | <li>integrate a number of provided patches</li> |
| 441 | </ul> |
| 442 | |
Daniel Veillard | 2ddd23d | 2000-11-25 10:42:19 +0000 | [diff] [blame] | 443 | <h3>2.2.9: Nov 25 2000</h3> |
| 444 | <ul> |
| 445 | <li>erroneous release :-(</li> |
| 446 | </ul> |
| 447 | |
Daniel Veillard | 28929b2 | 2000-11-13 18:22:49 +0000 | [diff] [blame] | 448 | <h3>2.2.8: Nov 13 2000</h3> |
| 449 | <ul> |
| 450 | <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a> |
| 451 | support</li> |
| 452 | <li>Patch in conditional section handling</li> |
| 453 | <li>updated MS compiler project</li> |
| 454 | <li>fixed some XPath problems</li> |
| 455 | <li>added an URI escaping function</li> |
| 456 | <li>some other bug fixes</li> |
| 457 | </ul> |
| 458 | |
| 459 | <h3>2.2.7: Oct 31 2000</h3> |
| 460 | <ul> |
| 461 | <li>added message redirection</li> |
| 462 | <li>XPath improvements (thanks TOM !)</li> |
| 463 | <li>xmlIOParseDTD() added</li> |
| 464 | <li>various small fixes in the HTML, URI, HTTP and XPointer support</li> |
| 465 | <li>some cleanup of the Makefile, autoconf and the distribution content</li> |
| 466 | </ul> |
| 467 | |
Daniel Veillard | 29a11cc | 2000-10-25 13:32:39 +0000 | [diff] [blame] | 468 | <h3>2.2.6: Oct 25 2000:</h3> |
| 469 | <ul> |
| 470 | <li>Added an hash table module, migrated a number of internal structure to |
| 471 | those</li> |
| 472 | <li>Fixed a posteriori validation problems</li> |
| 473 | <li>HTTP module cleanups</li> |
| 474 | <li>HTML parser improvements (tag errors, script/style handling, attribute |
| 475 | normalization)</li> |
| 476 | <li>coalescing of adjacent text nodes</li> |
| 477 | <li>couple of XPath bug fixes, exported the internal API</li> |
| 478 | </ul> |
| 479 | |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 480 | <h3>2.2.5: Oct 15 2000:</h3> |
Daniel Veillard | 4c3a203 | 1999-11-19 17:46:26 +0000 | [diff] [blame] | 481 | <ul> |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 482 | <li>XPointer implementation and testsuite</li> |
| 483 | <li>Lot of XPath fixes, added variable and functions registration, more |
| 484 | tests</li> |
| 485 | <li>Portability fixes, lots of enhancements toward an easy Windows build and |
| 486 | release</li> |
| 487 | <li>Late validation fixes</li> |
| 488 | <li>Integrated a lot of contributed patches</li> |
| 489 | <li>added memory management docs</li> |
Daniel Veillard | ab8500d | 2000-10-15 21:06:19 +0000 | [diff] [blame] | 490 | <li>a performance problem when using large buffer seems fixed</li> |
Daniel Veillard | 189446d | 2000-10-13 10:23:06 +0000 | [diff] [blame] | 491 | </ul> |
| 492 | |
| 493 | <h3>2.2.4: Oct 1 2000:</h3> |
| 494 | <ul> |
| 495 | <li>main XPath problem fixed</li> |
| 496 | <li>Integrated portability patches for Windows</li> |
| 497 | <li>Serious bug fixes on the URI and HTML code</li> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 498 | </ul> |
| 499 | |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 500 | <h3>2.2.3: Sep 17 2000</h3> |
| 501 | <ul> |
| 502 | <li>bug fixes</li> |
| 503 | <li>cleanup of entity handling code</li> |
| 504 | <li>overall review of all loops in the parsers, all sprintf usage has been |
| 505 | checked too</li> |
| 506 | <li>Far better handling of larges Dtd. Validating against Docbook XML Dtd |
| 507 | works smoothly now.</li> |
| 508 | </ul> |
| 509 | |
| 510 | <h3>1.8.10: Sep 6 2000</h3> |
| 511 | <ul> |
| 512 | <li>bug fix release for some Gnome projects</li> |
| 513 | </ul> |
| 514 | |
| 515 | <h3>2.2.2: August 12 2000</h3> |
Daniel Veillard | 786d7c8 | 2000-08-12 23:38:57 +0000 | [diff] [blame] | 516 | <ul> |
| 517 | <li>mostly bug fixes</li> |
Daniel Veillard | ec78c0f | 2000-08-25 10:25:23 +0000 | [diff] [blame] | 518 | <li>started adding routines to access xml parser context options</li> |
Daniel Veillard | 786d7c8 | 2000-08-12 23:38:57 +0000 | [diff] [blame] | 519 | </ul> |
| 520 | |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 521 | <h3>2.2.1: July 21 2000</h3> |
Daniel Veillard | a2679fa | 2000-07-22 02:38:15 +0000 | [diff] [blame] | 522 | <ul> |
| 523 | <li>a purely bug fixes release</li> |
| 524 | <li>fixed an encoding support problem when parsing from a memory block</li> |
| 525 | <li>fixed a DOCTYPE parsing problem</li> |
| 526 | <li>removed a bug in the function allowing to override the memory allocation |
| 527 | routines</li> |
| 528 | </ul> |
| 529 | |
Daniel Veillard | d5f97f8 | 2000-09-17 16:38:14 +0000 | [diff] [blame] | 530 | <h3>2.2.0: July 14 2000</h3> |
Daniel Veillard | 94e9060 | 2000-07-17 14:38:19 +0000 | [diff] [blame] | 531 | <ul> |
| 532 | <li>applied a lot of portability fixes</li> |
| 533 | <li>better encoding support/cleanup and saving (content is now always |
| 534 | encoded in UTF-8)</li> |
| 535 | <li>the HTML parser now correctly handles encodings</li> |
| 536 | <li>added xmlHasProp()</li> |
| 537 | <li>fixed a serious problem with &#38;</li> |
| 538 | <li>propagated the fix to FTP client</li> |
| 539 | <li>cleanup, bugfixes, etc ...</li> |
| 540 | <li>Added a page about <a href="encoding.html">libxml Internationalization |
| 541 | support</a></li> |
| 542 | </ul> |
| 543 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 544 | <h3>1.8.9: July 9 2000</h3> |
| 545 | <ul> |
| 546 | <li>fixed the spec the RPMs should be better</li> |
| 547 | <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve |
| 548 | rpmfind users problem</li> |
| 549 | </ul> |
| 550 | |
Daniel Veillard | 6388e17 | 2000-07-03 16:07:19 +0000 | [diff] [blame] | 551 | <h3>2.1.1: July 1 2000</h3> |
| 552 | <ul> |
| 553 | <li>fixes a couple of bugs in the 2.1.0 packaging</li> |
| 554 | <li>improvements on the HTML parser</li> |
| 555 | </ul> |
| 556 | |
Daniel Veillard | 3f6f7f6 | 2000-06-30 17:58:25 +0000 | [diff] [blame] | 557 | <h3>2.1.0 and 1.8.8: June 29 2000</h3> |
| 558 | <ul> |
| 559 | <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to |
| 560 | <a href="upgrade.html">new instructions</a>. It fixes a nasty problem |
| 561 | about &#38; charref parsing</li> |
| 562 | <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it |
| 563 | also contains numerous fixes and enhancements: |
| 564 | <ul> |
| 565 | <li>added xmlStopParser() to stop parsing</li> |
| 566 | <li>improved a lot parsing speed when there is large CDATA blocs</li> |
| 567 | <li>includes XPath patches provided by Picdar Technology</li> |
| 568 | <li>tried to fix as much as possible DtD validation and namespace |
| 569 | related problems</li> |
| 570 | <li>output to a given encoding has been added/tested</li> |
| 571 | <li>lot of various fixes</li> |
| 572 | </ul> |
| 573 | </li> |
| 574 | </ul> |
| 575 | |
Daniel Veillard | e0aed30 | 2000-04-16 08:52:20 +0000 | [diff] [blame] | 576 | <h3>2.0.0: Apr 12 2000</h3> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 577 | <ul> |
| 578 | <li>First public release of libxml2. If you are using libxml, it's a good |
Daniel Veillard | e0aed30 | 2000-04-16 08:52:20 +0000 | [diff] [blame] | 579 | idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally |
| 580 | scheduled for Apr 3 the relase occured only on Apr 12 due to massive |
| 581 | workload.</li> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 582 | <li>The include are now located under $prefix/include/libxml (instead of |
Daniel Veillard | e0aed30 | 2000-04-16 08:52:20 +0000 | [diff] [blame] | 583 | $prefix/include/gnome-xml), they also are referenced by |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 584 | <pre>#include <libxml/xxx.h></pre> |
Daniel Veillard | e0aed30 | 2000-04-16 08:52:20 +0000 | [diff] [blame] | 585 | <p>instead of</p> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 586 | <pre>#include "xxx.h"</pre> |
| 587 | </li> |
Daniel Veillard | 8f62198 | 2000-03-20 13:07:15 +0000 | [diff] [blame] | 588 | <li>a new URI module for parsing URIs and following strictly RFC 2396</li> |
| 589 | <li>the memory allocation routines used by libxml can now be overloaded |
| 590 | dynamically by using xmlMemSetup()</li> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 591 | <li>The previously CVS only tool tester has been renamed |
| 592 | <strong>xmllint</strong> and is now installed as part of the libxml2 |
| 593 | package</li> |
Daniel Veillard | e0aed30 | 2000-04-16 08:52:20 +0000 | [diff] [blame] | 594 | <li>The I/O interface has been revamped. There is now ways to plug in |
| 595 | specific I/O modules, either at the URI scheme detection level using |
| 596 | xmlRegisterInputCallbacks() or by passing I/O functions when creating a |
| 597 | parser context using xmlCreateIOParserCtxt()</li> |
| 598 | <li>there is a C preprocessor macro LIBXML_VERSION providing the version |
| 599 | number of the libxml module in use</li> |
| 600 | <li>a number of optional features of libxml can now be excluded at configure |
| 601 | time (FTP/HTTP/HTML/XPath/Debug)</li> |
Daniel Veillard | edfb29b | 2000-03-14 19:59:05 +0000 | [diff] [blame] | 602 | </ul> |
| 603 | |
| 604 | <h3>2.0.0beta: Mar 14 2000</h3> |
| 605 | <ul> |
| 606 | <li>This is a first Beta release of libxml version 2</li> |
Daniel Veillard | e356c28 | 2001-03-10 12:32:04 +0000 | [diff] [blame] | 607 | <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org |
| 608 | FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and |
| 609 | RPMs</li> |
Daniel Veillard | edfb29b | 2000-03-14 19:59:05 +0000 | [diff] [blame] | 610 | <li>This version is now the head in the Gnome CVS base, the old one is |
| 611 | available under the tag LIB_XML_1_X</li> |
| 612 | <li>This includes a very large set of changes. Froma programmatic point of |
| 613 | view applications should not have to be modified too much, check the <a |
| 614 | href="upgrade.html">upgrade page</a></li> |
| 615 | <li>Some interfaces may changes (especially a bit about encoding).</li> |
| 616 | <li>the updates includes: |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 617 | <ul> |
Daniel Veillard | edfb29b | 2000-03-14 19:59:05 +0000 | [diff] [blame] | 618 | <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly |
| 619 | handled now</li> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 620 | <li>Better handling of entities, especially well formedness checking and |
| 621 | proper PEref extensions in external subsets</li> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 622 | <li>DTD conditional sections</li> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 623 | <li>Validation now correcly handle entities content</li> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 624 | <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change |
| 625 | structures to accomodate DOM</a></li> |
Daniel Veillard | 6c8b117 | 2000-03-01 00:40:41 +0000 | [diff] [blame] | 626 | </ul> |
| 627 | </li> |
Daniel Veillard | edfb29b | 2000-03-14 19:59:05 +0000 | [diff] [blame] | 628 | <li>Serious progress were made toward compliance, <a |
| 629 | href="conf/result.html">here are the result of the test</a> against the |
| 630 | OASIS testsuite (except the japanese tests since I don't support that |
| 631 | encoding yet). This URL is rebuilt every couple of hours using the CVS |
| 632 | head version.</li> |
Daniel Veillard | e41f2b7 | 2000-01-30 20:00:07 +0000 | [diff] [blame] | 633 | </ul> |
| 634 | |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 635 | <h3>1.8.7: Mar 6 2000</h3> |
| 636 | <ul> |
| 637 | <li>This is a bug fix release:</li> |
| 638 | <li>It is possible to disable the ignorable blanks heuristic used by |
| 639 | libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note |
| 640 | that for adherence to XML spec, this behaviour will be disabled by default |
| 641 | in 2.x . The same function will allow to keep compatibility for old |
| 642 | code.</li> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 643 | <li>Blanks in <a> </a> constructs are not ignored anymore, |
| 644 | avoiding heuristic is really the Right Way :-\</li> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 645 | <li>The unchecked use of snprintf which was breaking libxml-1.8.6 |
| 646 | compilation on some platforms has been fixed</li> |
| 647 | <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing |
| 648 | URIs</li> |
| 649 | </ul> |
| 650 | |
Daniel Veillard | e41f2b7 | 2000-01-30 20:00:07 +0000 | [diff] [blame] | 651 | <h3>1.8.6: Jan 31 2000</h3> |
| 652 | <ul> |
| 653 | <li>added a nanoFTP transport module, debugged until the new version of <a |
| 654 | href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use |
| 655 | it without troubles</li> |
Daniel Veillard | da07c34 | 2000-01-25 18:31:22 +0000 | [diff] [blame] | 656 | </ul> |
| 657 | |
| 658 | <h3>1.8.5: Jan 21 2000</h3> |
| 659 | <ul> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 660 | <li>adding APIs to parse a well balanced chunk of XML (production <a |
| 661 | href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML |
| 662 | spec)</li> |
Daniel Veillard | 461a66c | 2000-01-18 18:01:01 +0000 | [diff] [blame] | 663 | <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 664 | <li>Jody Goldberg <jgoldberg@home.com> provided another patch trying |
| 665 | to solve the zlib checks problems</li> |
Daniel Veillard | 461a66c | 2000-01-18 18:01:01 +0000 | [diff] [blame] | 666 | <li>The current state in gnome CVS base is expected to ship as 1.8.5 with |
| 667 | gnumeric soon</li> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 668 | </ul> |
| 669 | |
| 670 | <h3>1.8.4: Jan 13 2000</h3> |
| 671 | <ul> |
| 672 | <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li> |
| 673 | <li>all exit() call should have been removed from libxml</li> |
| 674 | <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li> |
| 675 | <li>added newDocFragment()</li> |
Daniel Veillard | f84f71f | 2000-01-05 19:54:23 +0000 | [diff] [blame] | 676 | </ul> |
| 677 | |
| 678 | <h3>1.8.3: Jan 5 2000</h3> |
| 679 | <ul> |
| 680 | <li>a Push interface for the XML and HTML parsers</li> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 681 | <li>a shell-like interface to the document tree (try tester --shell :-)</li> |
Daniel Veillard | dbfd641 | 1999-12-28 16:35:14 +0000 | [diff] [blame] | 682 | <li>lots of bug fixes and improvement added over XMas hollidays</li> |
Daniel Veillard | 437b87b | 2000-01-03 17:30:46 +0000 | [diff] [blame] | 683 | <li>fixed the DTD parsing code to work with the xhtml DTD</li> |
Daniel Veillard | f84f71f | 2000-01-05 19:54:23 +0000 | [diff] [blame] | 684 | <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li> |
| 685 | <li>Fixed bugs in xmlNewNs()</li> |
Daniel Veillard | 437b87b | 2000-01-03 17:30:46 +0000 | [diff] [blame] | 686 | <li>External entity loading code has been revamped, now it uses |
Daniel Veillard | f84f71f | 2000-01-05 19:54:23 +0000 | [diff] [blame] | 687 | xmlLoadExternalEntity(), some fix on entities processing were added</li> |
Daniel Veillard | 437b87b | 2000-01-03 17:30:46 +0000 | [diff] [blame] | 688 | <li>cleaned up WIN32 includes of socket stuff</li> |
Daniel Veillard | 5cb5ab8 | 1999-12-21 15:35:29 +0000 | [diff] [blame] | 689 | </ul> |
| 690 | |
| 691 | <h3>1.8.2: Dec 21 1999</h3> |
| 692 | <ul> |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 693 | <li>I got another problem with includes and C++, I hope this issue is fixed |
| 694 | for good this time</li> |
Daniel Veillard | 5cb5ab8 | 1999-12-21 15:35:29 +0000 | [diff] [blame] | 695 | <li>Added a few tree modification functions: xmlReplaceNode, |
| 696 | xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and |
| 697 | xmlDocSetRootElement</li> |
| 698 | <li>Tried to improve the HTML output with help from <a |
| 699 | href="mailto:clahey@umich.edu">Chris Lahey</a></li> |
Daniel Veillard | e4e5131 | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 700 | </ul> |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 701 | |
Daniel Veillard | e4e5131 | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 702 | <h3>1.8.1: Dec 18 1999</h3> |
| 703 | <ul> |
| 704 | <li>various patches to avoid troubles when using libxml with C++ compilers |
| 705 | the "namespace" keyword and C escaping in include files</li> |
| 706 | <li>a problem in one of the core macros IS_CHAR was corrected</li> |
| 707 | <li>fixed a bug introduced in 1.8.0 breaking default namespace processing, |
| 708 | and more specifically the Dia application</li> |
Daniel Veillard | 944b5ff | 1999-12-15 19:08:24 +0000 | [diff] [blame] | 709 | <li>fixed a posteriori validation (validation after parsing, or by using a |
| 710 | Dtd not specified in the original document)</li> |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 711 | <li>fixed a bug in</li> |
Daniel Veillard | 10a2c65 | 1999-12-12 13:03:50 +0000 | [diff] [blame] | 712 | </ul> |
| 713 | |
| 714 | <h3>1.8.0: Dec 12 1999</h3> |
| 715 | <ul> |
| 716 | <li>cleanup, especially memory wise</li> |
| 717 | <li>the parser should be more reliable, especially the HTML one, it should |
| 718 | not crash, whatever the input !</li> |
| 719 | <li>Integrated various patches, especially a speedup improvement for large |
| 720 | dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>, |
| 721 | configure with --with-buffers to enable them.</li> |
| 722 | <li>attribute normalization, oops should have been added long ago !</li> |
| 723 | <li>attributes defaulted from Dtds should be available, xmlSetProp() now |
| 724 | does entities escapting by default.</li> |
Daniel Veillard | 4c3a203 | 1999-11-19 17:46:26 +0000 | [diff] [blame] | 725 | </ul> |
Daniel Veillard | 3500838 | 1999-10-25 13:15:52 +0000 | [diff] [blame] | 726 | |
| 727 | <h3>1.7.4: Oct 25 1999</h3> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 728 | <ul> |
Daniel Veillard | 3500838 | 1999-10-25 13:15:52 +0000 | [diff] [blame] | 729 | <li>Lots of HTML improvement</li> |
| 730 | <li>Fixed some errors when saving both XML and HTML</li> |
| 731 | <li>More examples, the regression tests should now look clean</li> |
| 732 | <li>Fixed a bug with contiguous charref</li> |
| 733 | </ul> |
| 734 | |
| 735 | <h3>1.7.3: Sep 29 1999</h3> |
| 736 | <ul> |
| 737 | <li>portability problems fixed</li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 738 | <li>snprintf was used unconditionnally, leading to link problems on system |
Daniel Veillard | 3500838 | 1999-10-25 13:15:52 +0000 | [diff] [blame] | 739 | were it's not available, fixed</li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 740 | </ul> |
| 741 | |
| 742 | <h3>1.7.1: Sep 24 1999</h3> |
| 743 | <ul> |
| 744 | <li>The basic type for strings manipulated by libxml has been renamed in |
| 745 | 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason |
| 746 | is that CHAR was conflicting with a predefined type on Windows. However on |
| 747 | non WIN32 environment, compatibility is provided by the way of a |
| 748 | <strong>#define </strong>.</li> |
| 749 | <li>Changed another error : the use of a structure field called errno, and |
| 750 | leading to troubles on platforms where it's a macro</li> |
| 751 | </ul> |
| 752 | |
| 753 | <h3>1.7.0: sep 23 1999</h3> |
| 754 | <ul> |
| 755 | <li>Added the ability to fetch remote DTD or parsed entities, see the <a |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 756 | href="html/libxml-nanohttp.html">nanohttp</a> module.</li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 757 | <li>Added an errno to report errors by another mean than a simple printf |
| 758 | like callback</li> |
| 759 | <li>Finished ID/IDREF support and checking when validation</li> |
| 760 | <li>Serious memory leaks fixed (there is now a <a |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 761 | href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li> |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 762 | <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a> |
| 763 | implementation</li> |
| 764 | <li>Added an HTML parser front-end</li> |
| 765 | </ul> |
| 766 | |
| 767 | <h2><a name="XML">XML</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 768 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 769 | <p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 770 | markup-based structured documents. Here is <a name="example">an example XML |
| 771 | document</a>:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 772 | <pre><?xml version="1.0"?> |
| 773 | <EXAMPLE prop1="gnome is great" prop2="&amp; linux too"> |
| 774 | <head> |
| 775 | <title>Welcome to Gnome</title> |
| 776 | </head> |
| 777 | <chapter> |
| 778 | <title>The Linux adventure</title> |
| 779 | <p>bla bla bla ...</p> |
| 780 | <image href="linus.gif"/> |
| 781 | <p>...</p> |
| 782 | </chapter> |
| 783 | </EXAMPLE></pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 784 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 785 | <p>The first line specifies that it's an XML document and gives useful |
| 786 | information about its encoding. Then the document is a text format whose |
| 787 | structure is specified by tags between brackets. <strong>Each tag opened has |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 788 | to be closed</strong>. XML is pedantic about this. However, if a tag is empty |
| 789 | (no content), a single tag can serve as both the opening and closing tag if it |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 790 | ends with <code>/></code> rather than with <code>></code>. Note that, |
| 791 | for example, the image tag has no content (just an attribute) and is closed by |
| 792 | ending the tag with <code>/></code>.</p> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 793 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 794 | <p>XML can be applied sucessfully to a wide range of uses, from long term |
| 795 | structured document maintenance (where it follows the steps of SGML) to simple |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 796 | data encoding mechanisms like configuration file formatting (glade), |
| 797 | spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where |
| 798 | it is used to encode remote calls between a client and a server.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 799 | |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 800 | <h2><a name="XSLT">XSLT</a></h2> |
| 801 | |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 802 | <p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p> |
| 803 | |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 804 | <p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a language |
| 805 | for transforming XML documents into other XML documents (or HTML/textual |
| 806 | output).</p> |
| 807 | |
| 808 | <p>A separate library called libxslt is being built on top of libxml2. This |
| 809 | module "libxslt" can be found in the Gnome CVS base too.</p> |
| 810 | |
Daniel Veillard | 383b147 | 2001-01-23 11:39:52 +0000 | [diff] [blame] | 811 | <p>You can check the <a |
Daniel Veillard | 6e6a6cc | 2001-02-15 15:55:44 +0000 | [diff] [blame] | 812 | href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a> supported |
| 813 | and the progresses on the <a |
Daniel Veillard | 8268716 | 2001-01-22 15:32:01 +0000 | [diff] [blame] | 814 | href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p> |
| 815 | |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 816 | <h2>An overview of libxml architecture</h2> |
| 817 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 818 | <p>Libxml is made of multiple components; some of them are optional, and most |
| 819 | of the block interfaces are public. The main components are:</p> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 820 | <ul> |
| 821 | <li>an Input/Output layer</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 822 | <li>FTP and HTTP client layers (optional)</li> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 823 | <li>an Internationalization layer managing the encodings support</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 824 | <li>a URI module</li> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 825 | <li>the XML parser and its basic SAX interface</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 826 | <li>an HTML parser using the same SAX interface (optional)</li> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 827 | <li>a SAX tree module to build an in-memory DOM representation</li> |
| 828 | <li>a tree module to manipulate the DOM representation</li> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 829 | <li>a validation module using the DOM representation (optional)</li> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 830 | <li>an XPath module for global lookup in a DOM representation |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 831 | (optional)</li> |
| 832 | <li>a debug module (optional)</li> |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 833 | </ul> |
| 834 | |
| 835 | <p>Graphically this gives the following:</p> |
| 836 | |
| 837 | <p><img src="libxml.gif" alt="a graphical view of the various"></p> |
| 838 | |
| 839 | <p></p> |
| 840 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 841 | <h2><a name="tree">The tree output</a></h2> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 842 | |
| 843 | <p>The parser returns a tree built during the document analysis. The value |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 844 | returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 845 | <strong>xmlDoc</strong> structure). This structure contains information such |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 846 | as the file name, the document type, and a <strong>children</strong> pointer |
| 847 | which is the root of the document (or more exactly the first child under the |
| 848 | root which is the document). The tree is made of <strong>xmlNode</strong>s, |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 849 | chained in double-linked lists of siblings and with a children<->parent |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 850 | relationship. An xmlNode can also carry properties (a chain of xmlAttr |
| 851 | structures). An attribute may have a value which is a list of TEXT or |
| 852 | ENTITY_REF nodes.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 853 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 854 | <p>Here is an example (erroneous with respect to the XML spec since there |
| 855 | should be only one ELEMENT under the root):</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 856 | |
| 857 | <p><img src="structure.gif" alt=" structure.gif "></p> |
| 858 | |
| 859 | <p>In the source package there is a small program (not installed by default) |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 860 | called <strong>xmllint</strong> which parses XML files given as argument and |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 861 | prints them back as parsed. This is useful for detecting errors both in XML |
| 862 | code and in the XML parser itself. It has an option <strong>--debug</strong> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 863 | which prints the actual in-memory structure of the document; here is the |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 864 | result with the <a href="#example">example</a> given before:</p> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 865 | <pre>DOCUMENT |
| 866 | version=1.0 |
| 867 | standalone=true |
| 868 | ELEMENT EXAMPLE |
| 869 | ATTRIBUTE prop1 |
| 870 | TEXT |
| 871 | content=gnome is great |
| 872 | ATTRIBUTE prop2 |
| 873 | ENTITY_REF |
| 874 | TEXT |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 875 | content= linux too |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 876 | ELEMENT head |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 877 | ELEMENT title |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 878 | TEXT |
| 879 | content=Welcome to Gnome |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 880 | ELEMENT chapter |
| 881 | ELEMENT title |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 882 | TEXT |
| 883 | content=The Linux adventure |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 884 | ELEMENT p |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 885 | TEXT |
| 886 | content=bla bla bla ... |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 887 | ELEMENT image |
| 888 | ATTRIBUTE href |
| 889 | TEXT |
| 890 | content=linus.gif |
| 891 | ELEMENT p |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 892 | TEXT |
| 893 | content=...</pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 894 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 895 | <p>This should be useful for learning the internal representation model.</p> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 896 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 897 | <h2><a name="interface">The SAX interface</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 898 | |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 899 | <p>Sometimes the DOM tree output is just too large to fit reasonably into |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 900 | memory. In that case (and if you don't expect to save back the XML document |
| 901 | loaded using libxml), it's better to use the SAX interface of libxml. SAX is a |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 902 | <strong>callback-based interface</strong> to the parser. Before parsing, the |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 903 | application layer registers a customized set of callbacks which are called by |
| 904 | the library as it progresses through the XML input.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 905 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 906 | <p>To get more detailed step-by-step guidance on using the SAX interface of |
Daniel Veillard | 4540be4 | 2000-08-19 16:40:28 +0000 | [diff] [blame] | 907 | libxml, see the <a |
| 908 | href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice |
| 909 | documentation</a>.written by <a href="mailto:james@daa.com.au">James |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 910 | Henstridge</a>.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 911 | |
| 912 | <p>You can debug the SAX behaviour by using the <strong>testSAX</strong> |
| 913 | program located in the gnome-xml module (it's usually not shipped in the |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 914 | binary packages of libxml, but you can find it in the tar source |
Daniel Veillard | 402e8c8 | 2000-02-29 22:57:47 +0000 | [diff] [blame] | 915 | distribution). Here is the sequence of callbacks that would be reported by |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 916 | testSAX when parsing the example XML document shown earlier:</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 917 | <pre>SAX.setDocumentLocator() |
| 918 | SAX.startDocument() |
| 919 | SAX.getEntity(amp) |
| 920 | SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp; linux too') |
| 921 | SAX.characters( , 3) |
| 922 | SAX.startElement(head) |
| 923 | SAX.characters( , 4) |
| 924 | SAX.startElement(title) |
| 925 | SAX.characters(Welcome to Gnome, 16) |
| 926 | SAX.endElement(title) |
| 927 | SAX.characters( , 3) |
| 928 | SAX.endElement(head) |
| 929 | SAX.characters( , 3) |
| 930 | SAX.startElement(chapter) |
| 931 | SAX.characters( , 4) |
| 932 | SAX.startElement(title) |
| 933 | SAX.characters(The Linux adventure, 19) |
| 934 | SAX.endElement(title) |
| 935 | SAX.characters( , 4) |
| 936 | SAX.startElement(p) |
| 937 | SAX.characters(bla bla bla ..., 15) |
| 938 | SAX.endElement(p) |
| 939 | SAX.characters( , 4) |
| 940 | SAX.startElement(image, href='linus.gif') |
| 941 | SAX.endElement(image) |
| 942 | SAX.characters( , 4) |
| 943 | SAX.startElement(p) |
| 944 | SAX.characters(..., 3) |
| 945 | SAX.endElement(p) |
| 946 | SAX.characters( , 3) |
| 947 | SAX.endElement(chapter) |
| 948 | SAX.characters( , 1) |
| 949 | SAX.endElement(EXAMPLE) |
| 950 | SAX.endDocument()</pre> |
| 951 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 952 | <p>Most of the other interfaces of libxml are based on the DOM tree-building |
| 953 | facility, so nearly everything up to the end of this document presupposes the |
| 954 | use of the standard DOM tree build. Note that the DOM tree itself is built by |
| 955 | a set of registered default callbacks, without internal specific |
| 956 | interface.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 957 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 958 | <h2><a name="library">The XML library interfaces</a></h2> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 959 | |
| 960 | <p>This section is directly intended to help programmers getting bootstrapped |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 961 | using the XML library from the C language. It is not intended to be extensive. |
| 962 | I hope the automatically generated documents will provide the completeness |
| 963 | required, but as a separate set of documents. The interfaces of the XML |
| 964 | library are by principle low level, there is nearly zero abstraction. Those |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 965 | interested in a higher level API should <a href="#DOM">look at DOM</a>.</p> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 966 | |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 967 | <p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are |
| 968 | separated from the <a href="html/libxml-htmlparser.html">HTML parser |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 969 | interfaces</a>. Let's have a look at how the XML parser can be called:</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 970 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 971 | <h3><a name="Invoking">Invoking the parser : the pull method</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 972 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 973 | <p>Usually, the first thing to do is to read an XML input. The parser accepts |
| 974 | documents either from in-memory strings or from files. The functions are |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 975 | defined in "parser.h":</p> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 976 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 977 | <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 978 | <dd><p>Parse a null-terminated string containing the document.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 979 | </dd> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 980 | </dl> |
| 981 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 982 | <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 983 | <dd><p>Parse an XML document contained in a (possibly compressed) |
| 984 | file.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 985 | </dd> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 986 | </dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 987 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 988 | <p>The parser returns a pointer to the document structure (or NULL in case of |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 989 | failure).</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 990 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 991 | <h3 id="Invoking1">Invoking the parser: the push method</h3> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 992 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 993 | <p>In order for the application to keep the control when the document is being |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 994 | fetched (which is common for GUI based programs) libxml provides a push |
| 995 | interface, too, as of version 1.8.3. Here are the interface functions:</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 996 | <pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax, |
| 997 | void *user_data, |
| 998 | const char *chunk, |
| 999 | int size, |
| 1000 | const char *filename); |
| 1001 | int xmlParseChunk (xmlParserCtxtPtr ctxt, |
| 1002 | const char *chunk, |
| 1003 | int size, |
| 1004 | int terminate);</pre> |
| 1005 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1006 | <p>and here is a simple example showing how to use the interface:</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1007 | <pre> FILE *f; |
| 1008 | |
| 1009 | f = fopen(filename, "r"); |
| 1010 | if (f != NULL) { |
| 1011 | int res, size = 1024; |
| 1012 | char chars[1024]; |
| 1013 | xmlParserCtxtPtr ctxt; |
| 1014 | |
| 1015 | res = fread(chars, 1, 4, f); |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1016 | if (res > 0) { |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1017 | ctxt = xmlCreatePushParserCtxt(NULL, NULL, |
| 1018 | chars, res, filename); |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1019 | while ((res = fread(chars, 1, size, f)) > 0) { |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1020 | xmlParseChunk(ctxt, chars, res, 0); |
| 1021 | } |
| 1022 | xmlParseChunk(ctxt, chars, 0, 1); |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1023 | doc = ctxt->myDoc; |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1024 | xmlFreeParserCtxt(ctxt); |
| 1025 | } |
| 1026 | }</pre> |
| 1027 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1028 | <p>The HTML parser embedded into libxml also has a push interface; the |
| 1029 | functions are just prefixed by "html" rather than "xml".</p> |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1030 | |
| 1031 | <h3 id="Invoking2">Invoking the parser: the SAX interface</h3> |
| 1032 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1033 | <p>The tree-building interface makes the parser memory-hungry, first loading |
| 1034 | the document in memory and then building the tree itself. Reading a document |
| 1035 | without building the tree is possible using the SAX interfaces (see SAX.h and |
| 1036 | <a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1037 | Henstridge's documentation</a>). Note also that the push interface can be |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1038 | limited to SAX: just use the two first arguments of |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1039 | <code>xmlCreatePushParserCtxt()</code>.</p> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 1040 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1041 | <h3><a name="Building">Building a tree from scratch</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1042 | |
| 1043 | <p>The other way to get an XML tree in memory is by building it. Basically |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1044 | there is a set of functions dedicated to building new elements. (These are |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1045 | also described in <libxml/tree.h>.) For example, here is a piece of code |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 1046 | that produces the XML document used in the previous examples:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1047 | <pre> #include <libxml/tree.h> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 1048 | xmlDocPtr doc; |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1049 | xmlNodePtr tree, subtree; |
| 1050 | |
| 1051 | doc = xmlNewDoc("1.0"); |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1052 | doc->children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL); |
| 1053 | xmlSetProp(doc->children, "prop1", "gnome is great"); |
| 1054 | xmlSetProp(doc->children, "prop2", "& linux too"); |
| 1055 | tree = xmlNewChild(doc->children, NULL, "head", NULL); |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1056 | subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome"); |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1057 | tree = xmlNewChild(doc->children, NULL, "chapter", NULL); |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1058 | subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure"); |
| 1059 | subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ..."); |
| 1060 | subtree = xmlNewChild(tree, NULL, "image", NULL); |
| 1061 | xmlSetProp(subtree, "href", "linus.gif");</pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1062 | |
| 1063 | <p>Not really rocket science ...</p> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1064 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1065 | <h3><a name="Traversing">Traversing the tree</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1066 | |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 1067 | <p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 1068 | code has access to the internal structure of all the elements of the tree. The |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1069 | names should be somewhat simple like <strong>parent</strong>, |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 1070 | <strong>children</strong>, <strong>next</strong>, <strong>prev</strong>, |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1071 | <strong>properties</strong>, etc... For example, still with the previous |
Daniel Veillard | 0142b84 | 2000-01-14 14:45:24 +0000 | [diff] [blame] | 1072 | example:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1073 | <pre><code>doc->children->children->children</code></pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1074 | |
| 1075 | <p>points to the title element,</p> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1076 | <pre>doc->children->children->next->children->children</pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1077 | |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1078 | <p>points to the text node containing the chapter title "The Linux |
| 1079 | adventure".</p> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 1080 | |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 1081 | <p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1082 | present before the document root, so <code>doc->children</code> may point |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1083 | to an element which is not the document Root Element; a function |
Daniel Veillard | 5cb5ab8 | 1999-12-21 15:35:29 +0000 | [diff] [blame] | 1084 | <code>xmlDocGetRootElement()</code> was added for this purpose.</p> |
Daniel Veillard | b24054a | 1999-12-18 15:32:46 +0000 | [diff] [blame] | 1085 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1086 | <h3><a name="Modifying">Modifying the tree</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1087 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1088 | <p>Functions are provided for reading and writing the document content. Here |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 1089 | is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1090 | <dl> |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 1091 | <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const |
| 1092 | xmlChar *value);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1093 | <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The |
| 1094 | value can be NULL.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1095 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1096 | </dl> |
| 1097 | <dl> |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 1098 | <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1099 | *name);</code></dt> |
Daniel Veillard | c92c304 | 2000-09-29 02:42:04 +0000 | [diff] [blame] | 1100 | <dd><p>This function returns a pointer to new copy of the property |
| 1101 | content. Note that the user must deallocate the result.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1102 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1103 | </dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1104 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1105 | <p>Two functions are provided for reading and writing the text associated with |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1106 | elements:</p> |
| 1107 | <dl> |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 1108 | <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1109 | *value);</code></dt> |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1110 | <dd><p>This function takes an "external" string and converts it to one |
| 1111 | text node or possibly to a list of entity and text nodes. All |
| 1112 | non-predefined entity references like &Gnome; will be stored |
| 1113 | internally as entity nodes, hence the result of the function may not be |
| 1114 | a single node.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1115 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1116 | </dl> |
| 1117 | <dl> |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 1118 | <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1119 | inLine);</code></dt> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1120 | <dd><p>This function is the inverse of |
| 1121 | <code>xmlStringGetNodeList()</code>. It generates a new string |
| 1122 | containing the content of the text and entity nodes. Note the extra |
| 1123 | argument inLine. If this argument is set to 1, the function will expand |
| 1124 | entity references. For example, instead of returning the &Gnome; |
| 1125 | XML encoding in the string, it will substitute it with its value (say, |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1126 | "GNU Network Object Model Environment").</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1127 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1128 | </dl> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 1129 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1130 | <h3><a name="Saving">Saving a tree</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1131 | |
| 1132 | <p>Basically 3 options are possible:</p> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1133 | <dl> |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 1134 | <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1135 | *size);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1136 | <dd><p>Returns a buffer into which the document has been saved.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1137 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1138 | </dl> |
| 1139 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1140 | <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1141 | <dd><p>Dumps a document to an open file descriptor.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1142 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1143 | </dl> |
| 1144 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1145 | <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt> |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1146 | <dd><p>Saves the document to a file. In this case, the compression |
| 1147 | interface is triggered if it has been turned on.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1148 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1149 | </dl> |
Daniel Veillard | 10c6a8f | 1998-10-28 01:00:12 +0000 | [diff] [blame] | 1150 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1151 | <h3><a name="Compressio">Compression</a></h3> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1152 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1153 | <p>The library transparently handles compression when doing file-based |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1154 | accesses. The level of compression on saves can be turned on either globally |
| 1155 | or individually for one file:</p> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1156 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1157 | <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1158 | <dd><p>Gets the document compression ratio (0-9).</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1159 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1160 | </dl> |
| 1161 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1162 | <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1163 | <dd><p>Sets the document compression ratio.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1164 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1165 | </dl> |
| 1166 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1167 | <dt><code>int xmlGetCompressMode(void);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1168 | <dd><p>Gets the default compression ratio.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1169 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1170 | </dl> |
| 1171 | <dl> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1172 | <dt><code>void xmlSetCompressMode(int mode);</code></dt> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1173 | <dd><p>Sets the default compression ratio.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1174 | </dd> |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 1175 | </dl> |
| 1176 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1177 | <h2><a name="Entities">Entities or no entities</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1178 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1179 | <p>Entities in principle are similar to simple C macros. An entity defines an |
| 1180 | abbreviation for a given string that you can reuse many times throughout the |
| 1181 | content of your document. Entities are especially useful when a given string |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1182 | may occur frequently within a document, or to confine the change needed to a |
| 1183 | document to a restricted area in the internal subset of the document (at the |
| 1184 | beginning). Example:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1185 | <pre>1 <?xml version="1.0"?> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1186 | 2 <!DOCTYPE EXAMPLE SYSTEM "example.dtd" [ |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1187 | 3 <!ENTITY xml "Extensible Markup Language"> |
| 1188 | 4 ]> |
| 1189 | 5 <EXAMPLE> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1190 | 6 &xml; |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1191 | 7 </EXAMPLE></pre> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1192 | |
| 1193 | <p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1194 | its name with '&' and following it by ';' without any spaces added. There |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1195 | are 5 predefined entities in libxml allowing you to escape charaters with |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1196 | predefined meaning in some parts of the xml document content: |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1197 | <strong>&lt;</strong> for the character '<', <strong>&gt;</strong> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1198 | for the character '>', <strong>&apos;</strong> for the character ''', |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1199 | <strong>&quot;</strong> for the character '"', and |
| 1200 | <strong>&amp;</strong> for the character '&'.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1201 | |
| 1202 | <p>One of the problems related to entities is that you may want the parser to |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1203 | substitute an entity's content so that you can see the replacement text in |
| 1204 | your application. Or you may prefer to keep entity references as such in the |
| 1205 | content to be able to save the document back without losing this usually |
| 1206 | precious information (if the user went through the pain of explicitly defining |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1207 | entities, he may have a a rather negative attitude if you blindly susbtitute |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1208 | them as saving time). The <a |
Daniel Veillard | 9cb5ff4 | 2001-01-29 08:22:21 +0000 | [diff] [blame] | 1209 | href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a> |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1210 | function allows you to check and change the behaviour, which is to not |
| 1211 | substitute entities by default.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1212 | |
| 1213 | <p>Here is the DOM tree built by libxml for the previous document in the |
| 1214 | default case:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1215 | <pre>/gnome/src/gnome-xml -> ./xmllint --debug test/ent1 |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1216 | DOCUMENT |
| 1217 | version=1.0 |
| 1218 | ELEMENT EXAMPLE |
| 1219 | TEXT |
| 1220 | content= |
| 1221 | ENTITY_REF |
| 1222 | INTERNAL_GENERAL_ENTITY xml |
| 1223 | content=Extensible Markup Language |
| 1224 | TEXT |
| 1225 | content=</pre> |
| 1226 | |
| 1227 | <p>And here is the result when substituting entities:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1228 | <pre>/gnome/src/gnome-xml -> ./tester --debug --noent test/ent1 |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1229 | DOCUMENT |
| 1230 | version=1.0 |
| 1231 | ELEMENT EXAMPLE |
| 1232 | TEXT |
| 1233 | content= Extensible Markup Language</pre> |
| 1234 | |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1235 | <p>So, entities or no entities? Basically, it depends on your use case. I |
| 1236 | suggest that you keep the non-substituting default behaviour and avoid using |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1237 | entities in your XML document or data if you are not willing to handle the |
| 1238 | entity references elements in the DOM tree.</p> |
| 1239 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1240 | <p>Note that at save time libxml enforces the conversion of the predefined |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1241 | entities where necessary to prevent well-formedness problems, and will also |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1242 | transparently replace those with chars (i.e. it will not generate entity |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1243 | reference elements in the DOM tree or call the reference() SAX callback when |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1244 | finding them in the input).</p> |
| 1245 | |
Daniel Veillard | 7b9c4b7 | 2000-08-25 16:26:50 +0000 | [diff] [blame] | 1246 | <p><span style="background-color: #FF0000">WARNING</span>: handling entities |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1247 | on top of the libxml SAX interface is difficult!!! If you plan to use |
Daniel Veillard | 7b9c4b7 | 2000-08-25 16:26:50 +0000 | [diff] [blame] | 1248 | non-predefined entities in your documents, then the learning cuvre to handle |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1249 | then using the SAX API may be long. If you plan to use complex documents, I |
Daniel Veillard | 7b9c4b7 | 2000-08-25 16:26:50 +0000 | [diff] [blame] | 1250 | strongly suggest you consider using the DOM interface instead and let libxml |
Daniel Veillard | 8c6d6af | 2000-08-25 17:14:13 +0000 | [diff] [blame] | 1251 | deal with the complexity rather than trying to do it yourself.</p> |
Daniel Veillard | 7b9c4b7 | 2000-08-25 16:26:50 +0000 | [diff] [blame] | 1252 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1253 | <h2><a name="Namespaces">Namespaces</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1254 | |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 1255 | <p>The libxml library implements <a |
| 1256 | href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by |
| 1257 | recognizing namespace contructs in the input, and does namespace lookup |
| 1258 | automatically when building the DOM tree. A namespace declaration is |
| 1259 | associated with an in-memory structure and all elements or attributes within |
| 1260 | that namespace point to it. Hence testing the namespace is a simple and fast |
| 1261 | equality operation at the user level.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1262 | |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1263 | <p>I suggest that people using libxml use a namespace, and declare it in the |
| 1264 | root element of their document as the default namespace. Then they don't need |
| 1265 | to use the prefix in the content but we will have a basis for future semantic |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1266 | refinement and merging of data from different sources. This doesn't increase |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1267 | the size of the XML output significantly, but significantly increases its |
| 1268 | value in the long-term. Example:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1269 | <pre><mydoc xmlns="http://mydoc.example.org/schemas/"> |
| 1270 | <elem1>...</elem1> |
| 1271 | <elem2>...</elem2> |
| 1272 | </mydoc></pre> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1273 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1274 | <p>The namespace value has to be an absolute URL, but the URL doesn't have to |
| 1275 | point to any existing resource on the Web. It will bind all the element and |
| 1276 | atributes with that URL. I suggest to use an URL within a domain you control, |
| 1277 | and that the URL should contain some kind of version information if possible. |
| 1278 | For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good |
| 1279 | namespace scheme.</p> |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 1280 | |
| 1281 | <p>Then when you load a file, make sure that a namespace carrying the |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1282 | version-independent prefix is installed on the root element of your document, |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1283 | and if the version information don't match something you know, warn the user |
| 1284 | and be liberal in what you accept as the input. Also do *not* try to base |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1285 | namespace checking on the prefix value. <foo:text> may be exactly the |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1286 | same as <bar:text> in another document. What really matters is the URI |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1287 | associated with the element or the attribute, not the prefix string (which is |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1288 | just a shortcut for the full URI). In libxml, element and attributes have an |
Daniel Veillard | ec30341 | 2000-03-24 13:41:54 +0000 | [diff] [blame] | 1289 | <code>ns</code> field pointing to an xmlNs structure detailing the namespace |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1290 | prefix and its URI.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1291 | |
| 1292 | <p>@@Interfaces@@</p> |
| 1293 | |
| 1294 | <p>@@Examples@@</p> |
| 1295 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1296 | <p>Usually people object to using namespaces together with validity checking. |
| 1297 | I will try to make sure that using namespaces won't break validity checking, |
| 1298 | so even if you plan to use or currently are using validation I strongly |
Daniel Veillard | f13e1ed | 2000-03-06 07:41:49 +0000 | [diff] [blame] | 1299 | suggest adding namespaces to your document. A default namespace scheme |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1300 | <code>xmlns="http://...."</code> should not break validity even on less |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1301 | flexible parsers. Using namespaces to mix and differentiate content coming |
Daniel Veillard | 88f00ae | 2000-03-02 00:15:55 +0000 | [diff] [blame] | 1302 | from multiple DTDs will certainly break current validation schemes. I will try |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1303 | to provide ways to do this, but this may not be portable or standardized.</p> |
| 1304 | |
Daniel Veillard | 2f4dfc4 | 1999-09-24 14:03:48 +0000 | [diff] [blame] | 1305 | <h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1306 | |
| 1307 | <p>Well what is validation and what is a DTD ?</p> |
| 1308 | |
| 1309 | <p>Validation is the process of checking a document against a set of |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1310 | construction rules; a <strong>DTD</strong> (Document Type Definition) is such |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1311 | a set of rules.</p> |
| 1312 | |
| 1313 | <p>The validation process and building DTDs are the two most difficult parts |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1314 | of the XML life cycle. Briefly a DTD defines all the possibles element to be |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1315 | found within your document, what is the formal shape of your document tree (by |
| 1316 | defining the allowed content of an element, either text, a regular expression |
Daniel Veillard | 306be99 | 2000-07-03 12:38:45 +0000 | [diff] [blame] | 1317 | for the allowed list of children, or mixed content i.e. both text and |
| 1318 | children). The DTD also defines the allowed attributes for all elements and |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1319 | the types of the attributes. For more detailed information, I suggest that you |
Daniel Veillard | 8178110 | 2001-03-07 09:31:47 +0000 | [diff] [blame] | 1320 | read the related parts of the XML specification, the examples found under |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1321 | gnome-xml/test/valid/dtd and any of the large number of books available on |
| 1322 | XML. The dia example in gnome-xml/test/valid should be both simple and |
| 1323 | complete enough to allow you to build your own.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1324 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1325 | <p>A word of warning, building a good DTD which will fit the needs of your |
| 1326 | application in the long-term is far from trivial; however, the extra level of |
| 1327 | quality it can ensure is well worth the price for some sets of applications or |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1328 | if you already have already a DTD defined for your application field.</p> |
| 1329 | |
| 1330 | <p>The validation is not completely finished but in a (very IMHO) usable |
| 1331 | state. Until a real validation interface is defined the way to do it is to |
| 1332 | define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external |
| 1333 | variable to 1, this will of course be changed at some point:</p> |
| 1334 | |
| 1335 | <p>extern int xmlDoValidityCheckingDefaultValue;</p> |
| 1336 | |
| 1337 | <p>...</p> |
| 1338 | |
| 1339 | <p>xmlDoValidityCheckingDefaultValue = 1;</p> |
| 1340 | |
| 1341 | <p></p> |
| 1342 | |
| 1343 | <p>To handle external entities, use the function |
| 1344 | <strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to |
| 1345 | link in you HTTP/FTP/Entities database library to the standard libxml |
| 1346 | core.</p> |
| 1347 | |
| 1348 | <p>@@interfaces@@</p> |
| 1349 | |
Daniel Veillard | 3500838 | 1999-10-25 13:15:52 +0000 | [diff] [blame] | 1350 | <h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1351 | |
| 1352 | <p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1353 | Model</em>; this is an API for accessing XML or HTML structured documents. |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1354 | Native support for DOM in Gnome is on the way (module gnome-dom), and will be |
| 1355 | based on gnome-xml. This will be a far cleaner interface to manipulate XML |
Daniel Veillard | 3197f16 | 2001-04-04 00:40:08 +0000 | [diff] [blame] | 1356 | files within Gnome since it won't expose the internal structure.</p> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1357 | |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1358 | <p>The current DOM implementation on top of libxml is the <a |
Daniel Veillard | a47fb3d | 2001-03-25 17:23:49 +0000 | [diff] [blame] | 1359 | href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this |
| 1360 | is a full DOM interface, thanks to Paolo Casarini, check the <a |
| 1361 | href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more |
| 1362 | informations.</p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1363 | |
Daniel Veillard | 3500838 | 1999-10-25 13:15:52 +0000 | [diff] [blame] | 1364 | <h2><a name="Example"></a><a name="real">A real example</a></h2> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1365 | |
| 1366 | <p>Here is a real size example, where the actual content of the application |
| 1367 | data is not kept in the DOM tree but uses internal structures. It is based on |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1368 | a proposal to keep a database of jobs related to Gnome, with an XML based |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1369 | storage structure. Here is an <a href="gjobs.xml">XML encoded jobs |
| 1370 | base</a>:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1371 | <pre><?xml version="1.0"?> |
| 1372 | <gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"> |
| 1373 | <gjob:Jobs> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1374 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1375 | <gjob:Job> |
| 1376 | <gjob:Project ID="3"/> |
| 1377 | <gjob:Application>GBackup</gjob:Application> |
| 1378 | <gjob:Category>Development</gjob:Category> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1379 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1380 | <gjob:Update> |
| 1381 | <gjob:Status>Open</gjob:Status> |
| 1382 | <gjob:Modified>Mon, 07 Jun 1999 20:27:45 -0400 MET DST</gjob:Modified> |
| 1383 | <gjob:Salary>USD 0.00</gjob:Salary> |
| 1384 | </gjob:Update> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1385 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1386 | <gjob:Developers> |
| 1387 | <gjob:Developer> |
| 1388 | </gjob:Developer> |
| 1389 | </gjob:Developers> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1390 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1391 | <gjob:Contact> |
| 1392 | <gjob:Person>Nathan Clemons</gjob:Person> |
| 1393 | <gjob:Email>nathan@windsofstorm.net</gjob:Email> |
| 1394 | <gjob:Company> |
| 1395 | </gjob:Company> |
| 1396 | <gjob:Organisation> |
| 1397 | </gjob:Organisation> |
| 1398 | <gjob:Webpage> |
| 1399 | </gjob:Webpage> |
| 1400 | <gjob:Snailmail> |
| 1401 | </gjob:Snailmail> |
| 1402 | <gjob:Phone> |
| 1403 | </gjob:Phone> |
| 1404 | </gjob:Contact> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1405 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1406 | <gjob:Requirements> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1407 | The program should be released as free software, under the GPL. |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1408 | </gjob:Requirements> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1409 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1410 | <gjob:Skills> |
| 1411 | </gjob:Skills> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1412 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1413 | <gjob:Details> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1414 | A GNOME based system that will allow a superuser to configure |
| 1415 | compressed and uncompressed files and/or file systems to be backed |
| 1416 | up with a supported media in the system. This should be able to |
| 1417 | perform via find commands generating a list of files that are passed |
| 1418 | to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine |
| 1419 | or via operations performed on the filesystem itself. Email |
| 1420 | notification and GUI status display very important. |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1421 | </gjob:Details> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1422 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1423 | </gjob:Job> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1424 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1425 | </gjob:Jobs> |
| 1426 | </gjob:Helping></pre> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1427 | |
| 1428 | <p>While loading the XML file into an internal DOM tree is a matter of calling |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1429 | only a couple of functions, browsing the tree to gather the ata and generate |
| 1430 | the internal structures is harder, and more error prone.</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1431 | |
| 1432 | <p>The suggested principle is to be tolerant with respect to the input |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1433 | structure. For example, the ordering of the attributes is not significant, the |
| 1434 | XML specification is clear about it. It's also usually a good idea not to |
| 1435 | depend on the order of the children of a given node, unless it really makes |
| 1436 | things harder. Here is some code to parse the information for a person:</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1437 | <pre>/* |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1438 | * A person record |
| 1439 | */ |
| 1440 | typedef struct person { |
| 1441 | char *name; |
| 1442 | char *email; |
| 1443 | char *company; |
| 1444 | char *organisation; |
| 1445 | char *smail; |
| 1446 | char *webPage; |
| 1447 | char *phone; |
| 1448 | } person, *personPtr; |
| 1449 | |
| 1450 | /* |
| 1451 | * And the code needed to parse it |
| 1452 | */ |
| 1453 | personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) { |
| 1454 | personPtr ret = NULL; |
| 1455 | |
| 1456 | DEBUG("parsePerson\n"); |
| 1457 | /* |
| 1458 | * allocate the struct |
| 1459 | */ |
| 1460 | ret = (personPtr) malloc(sizeof(person)); |
| 1461 | if (ret == NULL) { |
| 1462 | fprintf(stderr,"out of memory\n"); |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1463 | return(NULL); |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1464 | } |
| 1465 | memset(ret, 0, sizeof(person)); |
| 1466 | |
| 1467 | /* We don't care what the top level element name is */ |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1468 | cur = cur->xmlChildrenNode; |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1469 | while (cur != NULL) { |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1470 | if ((!strcmp(cur->name, "Person")) && (cur->ns == ns)) |
| 1471 | ret->name = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1); |
| 1472 | if ((!strcmp(cur->name, "Email")) && (cur->ns == ns)) |
| 1473 | ret->email = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1); |
| 1474 | cur = cur->next; |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1475 | } |
| 1476 | |
| 1477 | return(ret); |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1478 | }</pre> |
| 1479 | |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1480 | <p>Here are a couple of things to notice:</p> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1481 | <ul> |
Daniel Veillard | 91e9d58 | 2001-02-26 07:31:12 +0000 | [diff] [blame] | 1482 | <li>Usually a recursive parsing style is the more convenient one: XML data |
| 1483 | is by nature subject to repetitive constructs and usually exibits highly |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1484 | stuctured patterns.</li> |
| 1485 | <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e. |
| 1486 | the pointer to the global XML document and the namespace reserved to the |
| 1487 | application. Document wide information are needed for example to decode |
| 1488 | entities and it's a good coding practice to define a namespace for your |
| 1489 | application set of data and test that the element and attributes you're |
| 1490 | analyzing actually pertains to your application space. This is done by a |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1491 | simple equality test (cur->ns == ns).</li> |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1492 | <li>To retrieve text and attributes value, you can use the function |
| 1493 | <em>xmlNodeListGetString</em> to gather all the text and entity reference |
| 1494 | nodes generated by the DOM output and produce an single text string.</li> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1495 | </ul> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1496 | |
| 1497 | <p>Here is another piece of code used to parse another level of the |
| 1498 | structure:</p> |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1499 | <pre>#include <libxml/tree.h> |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 1500 | /* |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1501 | * a Description for a Job |
| 1502 | */ |
| 1503 | typedef struct job { |
| 1504 | char *projectID; |
| 1505 | char *application; |
| 1506 | char *category; |
| 1507 | personPtr contact; |
| 1508 | int nbDevelopers; |
| 1509 | personPtr developers[100]; /* using dynamic alloc is left as an exercise */ |
| 1510 | } job, *jobPtr; |
| 1511 | |
| 1512 | /* |
| 1513 | * And the code needed to parse it |
| 1514 | */ |
| 1515 | jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) { |
| 1516 | jobPtr ret = NULL; |
| 1517 | |
| 1518 | DEBUG("parseJob\n"); |
| 1519 | /* |
| 1520 | * allocate the struct |
| 1521 | */ |
| 1522 | ret = (jobPtr) malloc(sizeof(job)); |
| 1523 | if (ret == NULL) { |
| 1524 | fprintf(stderr,"out of memory\n"); |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1525 | return(NULL); |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1526 | } |
| 1527 | memset(ret, 0, sizeof(job)); |
| 1528 | |
| 1529 | /* We don't care what the top level element name is */ |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1530 | cur = cur->xmlChildrenNode; |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1531 | while (cur != NULL) { |
| 1532 | |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1533 | if ((!strcmp(cur->name, "Project")) && (cur->ns == ns)) { |
| 1534 | ret->projectID = xmlGetProp(cur, "ID"); |
| 1535 | if (ret->projectID == NULL) { |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1536 | fprintf(stderr, "Project has no ID\n"); |
| 1537 | } |
| 1538 | } |
Daniel Veillard | 60979bd | 2000-07-10 12:17:33 +0000 | [diff] [blame] | 1539 | if ((!strcmp(cur->name, "Application")) && (cur->ns == ns)) |
| 1540 | ret->application = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1); |
| 1541 | if ((!strcmp(cur->name, "Category")) && (cur->ns == ns)) |
| 1542 | ret->category = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1); |
| 1543 | if ((!strcmp(cur->name, "Contact")) && (cur->ns == ns)) |
| 1544 | ret->contact = parsePerson(doc, ns, cur); |
| 1545 | cur = cur->next; |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1546 | } |
| 1547 | |
| 1548 | return(ret); |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1549 | }</pre> |
Daniel Veillard | 14fff06 | 1999-06-22 21:49:07 +0000 | [diff] [blame] | 1550 | |
Daniel Veillard | ec70e91 | 2001-02-26 20:10:45 +0000 | [diff] [blame] | 1551 | <p>Once you are used to it, writing this kind of code is quite simple, but |
| 1552 | boring. Ultimately, it could be possble to write stubbers taking either C data |
| 1553 | structure definitions, a set of XML examples or an XML DTD and produce the |
| 1554 | code needed to import and export the content between C data and XML storage. |
| 1555 | This is left as an exercise to the reader :-)</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1556 | |
Daniel Veillard | 6f0adb5 | 2000-07-03 11:41:26 +0000 | [diff] [blame] | 1557 | <p>Feel free to use <a href="example/gjobread.c">the code for the full C |
| 1558 | parsing example</a> as a template, it is also available with Makefile in the |
| 1559 | Gnome CVS base under gnome-xml/example</p> |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 1560 | |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 1561 | <h2><a name="Contributi">Contributions</a></h2> |
| 1562 | <ul> |
Daniel Veillard | 851c59c | 2000-11-24 16:06:22 +0000 | [diff] [blame] | 1563 | <li><a href="mailto:ari@lusis.org">Ari Johnson</a> provides a C++ wrapper |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 1564 | for libxml: |
| 1565 | <p>Website: <a |
| 1566 | href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p> |
| 1567 | <p>Download: <a |
| 1568 | href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p> |
| 1569 | </li> |
| 1570 | <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a |
| 1571 | precompiled Windows version |
| 1572 | <p><a |
Daniel Veillard | c5d6434 | 2001-06-24 12:13:24 +0000 | [diff] [blame] | 1573 | href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a> |
| 1574 | (older). The distribution now includes projects and makefiles for Windows |
| 1575 | compiler contributed by various people.</p> |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 1576 | </li> |
Daniel Veillard | e356c28 | 2001-03-10 12:32:04 +0000 | [diff] [blame] | 1577 | <li><a |
| 1578 | href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt |
| 1579 | Sergeant</a> developped <a |
| 1580 | href="http://axkit.org/download/">XML::LibXSLT</a>, a perl wrapper for |
| 1581 | libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML |
| 1582 | application server</a></li> |
Daniel Veillard | c5d6434 | 2001-06-24 12:13:24 +0000 | [diff] [blame] | 1583 | <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a |
| 1584 | href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a |
Daniel Veillard | ca98976 | 2001-06-23 17:39:29 +0000 | [diff] [blame] | 1585 | href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions |
Daniel Veillard | 3f6f7f6 | 2000-06-30 17:58:25 +0000 | [diff] [blame] | 1586 | documentation</li> |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 1587 | <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a |
Daniel Veillard | c5d6434 | 2001-06-24 12:13:24 +0000 | [diff] [blame] | 1588 | href="http://xmlsoft.org/messages/0488.html">man pages</a></li> |
| 1589 | <li>Seems <a href="http://www.arsdigita.com/">ArsDigita</a> wrote a Tcl |
| 1590 | wrapper for libxml called <a |
| 1591 | href="http://www.linuxgazette.com/issue63/washington.html">ns_xml</a></li> |
Daniel Veillard | c310d56 | 2000-06-23 18:32:15 +0000 | [diff] [blame] | 1592 | </ul> |
| 1593 | |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1594 | <p></p> |
| 1595 | |
Daniel Veillard | 33a6780 | 2001-03-07 09:44:02 +0000 | [diff] [blame] | 1596 | <p><a href="mailto:Daniel.Veillard@imag.fr">Daniel Veillard</a></p> |
Daniel Veillard | c8eab3a | 1999-09-04 18:27:23 +0000 | [diff] [blame] | 1597 | |
Daniel Veillard | 823a77f | 2001-06-26 23:07:32 +0000 | [diff] [blame^] | 1598 | <p>$Id: xml.html,v 1.95 2001/06/26 23:04:22 veillard Exp $</p> |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 1599 | </body> |
| 1600 | </html> |