doc/xslt.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2     "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>The XSLT C library for GNOME</title>
   6   <meta name="GENERATOR" content="amaya 8.5, see http://www.w3.org/Amaya/">
   7   <meta http-equiv="Content-Type" content="text/html">
   8 </head>
   9
  10 <body bgcolor="#ffffff">
  11 <h1 align="center">The XSLT C library for GNOME</h1>
  12
  13 <h1 style="text-align: center">libxslt</h1>
  14
  15 <p>Libxslt is the <a href="http://www.w3.org/TR/xslt">XSLT</a> C library
  16 developed for the GNOME project. XSLT itself is a an XML language to define
  17 transformation for XML. Libxslt is based on <a
  18 href="http://xmlsoft.org/">libxml2</a> the XML C library developed for the
  19 GNOME project. It also implements most of the <a
  20 href="http://www.exslt.org/">EXSLT</a> set of processor-portable extensions
  21 functions and some of Saxon's evaluate and expressions extensions.</p>
  22
  23 <p>People can either embed the library in their application or use xsltproc
  24 the command line processing tool. This library is free software and can be
  25 reused in commercial applications (see the <a href="intro.html">intro</a>)</p>
  26
  27 <p>External documents:</p>
  28 <ul>
  29   <li>John Fleck wrote <a href="tutorial/libxslttutorial.html">a tutorial for
  30     libxslt</a></li>
  31   <li><a href="xsltproc.html">xsltproc user manual</a></li>
  32   <li><a href="http://xmlsoft.org/">the libxml documentation</a></li>
  33 </ul>
  34
  35 <p></p>
  36
  37 <p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
  38
  39 <h2><a name="Introducti">Introduction</a></h2>
  40
  41 <p>This document describes <a href="http://xmlsoft.org/XSLT/">libxslt</a>,
  42 the <a href="http://www.w3.org/TR/xslt">XSLT</a> C library developed for the
  43 <a href="http://www.gnome.org/">GNOME</a> project.</p>
  44
  45 <p>Here are some key points about libxslt:</p>
  46 <ul>
  47   <li>Libxslt is a C implementation</li>
  48   <li>Libxslt is based on libxml for XML parsing, tree manipulation and XPath
  49     support</li>
  50   <li>It is written in plain C, making as few assumptions as possible, and
  51     sticking closely to ANSI C/POSIX for easy embedding. Should works on
  52     Linux/Unix/Windows.</li>
  53   <li>This library is released under the <a
  54     href="http://www.opensource.org/licenses/mit-license.html">MIT
  55   Licence</a></li>
  56   <li>Though not designed primarily with performances in mind, libxslt seems
  57     to be a relatively fast processor.</li>
  58 </ul>
  59
  60 <h2><a name="Documentat">Documentation</a></h2>
  61
  62 <p>There are some on-line resources about using libxslt:</p>
  63 <ol>
  64   <li>Check the <a href="html/libxslt-lib.html#LIBXSLT-LIB">API
  65     documentation</a> automatically extracted from code comments (using the
  66     program apibuild.py, developed for libxml, together with the xsl script
  67     'newapi.xsl' and the libxslt xsltproc program).</li>
  68   <li>Look at the <a href="http://mail.gnome.org/archives/xslt/">mailing-list
  69     archive</a>.</li>
  70   <li>Of course since libxslt is based on libxml, it's a good idea to at
  71     least read <a href="http://xmlsoft.org/">libxml description</a></li>
  72 </ol>
  73
  74 <h2><a name="Reporting">Reporting bugs and getting help</a></h2>
  75
  76 <p>If you need help with the XSLT language itself, here are a number of
  77 useful resources:</p>
  78 <ul>
  79   <li>I strongly suggest to subscribe to <a
  80     href="http://www.mulberrytech.com/xsl/xsl-list">XSL-list</a>, check <a
  81     href="http://www.biglist.com/lists/xsl-list/archives/">the XSL-list
  82     archives</a></li>
  83   <li>The <a href="http://www.dpawson.co.uk/xsl/xslfaq.html">XSL FAQ</a>.</li>
  84   <li>The <a
  85     href="http://www.nwalsh.com/docs/tutorials/xsl/xsl/slides.html">tutorial</a>
  86     written by Paul Grosso and Norman Walsh is a very good on-line
  87     introdution to the language.</li>
  88   <li>The <a
  89     href="http://www.zvon.org/xxl/XSLTutorial/Books/Book1/index.html">only
  90     Zvon XSLT tutorial</a> details a lot of constructs with examples.</li>
  91   <li><a href="http://www.jenitennison.com/xslt/index.html">Jeni Tennison's
  92     XSLT</a> pages provide links to a lot of answers</li>
  93   <li>the <a href="http://incrementaldevelopment.com/xsltrick/">Gallery of
  94     XSLT Tricks</a> provides non-standard use case of XSLT</li>
  95   <li>And I suggest to buy Michael Kay "XSLT Programmer's Reference" book
  96     published by <a href="http://www.wrox.com/">Wrox</a> if you plan to work
  97     seriously with XSLT in the future.</li>
  98 </ul>
  99
 100 <p>Well, bugs or missing features are always possible, and I will make a
 101 point of fixing them in a timely fashion. The best way to report a bug is to
 102 use the <a
 103 href="http://bugzilla.gnome.org/enter_bug.cgi?product=libxslt">GNOME bug
 104 tracking database</a> (make sure to use the "libxslt" module name). Before
 105 filing a bug, check the <a
 106 href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">list of existing
 107 libxslt bugs</a> to make sure it hasn't already been filed. I look at reports
 108 there regularly and it's good to have a reminder when a bug is still open. Be
 109 sure to specify that the bug is for the package libxslt.</p>
 110
 111 <p>For small problems you can try to get help on IRC, the #xml channel on
 112 irc.gnome.org (port 6667) usually have a few person subscribed which may help
 113 (but there is no guarantee and if a real issue is raised it should go on the
 114 mailing-list for archival).</p>
 115
 116 <p>There is also a mailing-list <a
 117 href="mailto:xslt@gnome.org">xslt@gnome.org</a> for libxslt, with an <a
 118 href="http://mail.gnome.org/archives/xslt/">on-line archive</a>. To subscribe
 119 to this list, please visit the <a
 120 href="http://mail.gnome.org/mailman/listinfo/xslt">associated Web</a> page
 121 and follow the instructions.</p>
 122
 123 <p>Alternatively, you can just send the bug to the <a
 124 href="mailto:xslt@gnome.org">xslt@gnome.org</a> list, if it's really libxslt
 125 related I will approve it.. Please do not send me mail directly especially
 126 for portability problem, it makes things really harder to track and in some
 127 cases I'm not the best person to answer a given question, ask the list
 128 instead. <strong>Do not send code, I won't debug it</strong> (but patches are
 129 really appreciated!).</p>
 130
 131 <p>Please note that with the current amount of virus and SPAM, sending mail
 132 to the list without being subscribed won't work. There is *far too many
 133 bounces* (in the order of a thousand a day !) I cannot approve them manually
 134 anymore. If your mail to the list bounced waiting for administrator approval,
 135 it is LOST ! Repost it and fix the problem triggering the error. Also please
 136 note that <span style="color: #FF0000; background-color: #FFFFFF">emails with
 137 a legal warning asking to not copy or redistribute freely the information
 138 they contain</span> are <strong>NOT</strong> acceptable for the mailing-list,
 139 such mail will as much as possible be discarded automatically, and are less
 140 likely to be answered if they made it to the list, <strong>DO NOT</strong>
 141 post to the list from an email address where such legal requirements are
 142 automatically added, get private paying support if you can't share
 143 information.</p>
 144
 145 <p>Check the following too <span style="color: #E50000">before
 146 posting</span>:</p>
 147 <ul>
 148   <li><a href="search.php">use the search engine</a> to get information
 149     related to your problem.</li>
 150   <li>make sure you are <a href="ftp://xmlsoft.org/libxslt/">using a recent
 151     version</a>, and that the problem still shows up in those</li>
 152   <li>check the <a href="http://mail.gnome.org/archives/xslt/">list
 153     archives</a> to see if the problem was reported already, in this case
 154     there is probably a fix available, similarly check the <a
 155     href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">registered
 156     open bugs</a></li>
 157   <li>make sure you can reproduce the bug with xsltproc, a very useful thing
 158     to do is run the transformation with -v argument and redirect the
 159     standard error to a file, then search in this file for the transformation
 160     logs just preceding the possible problem</li>
 161   <li>Please send the command showing the error as well as the input and
 162     stylesheet (as an attachment)</li>
 163 </ul>
 164
 165 <p>Then send the bug with associated information to reproduce it to the <a
 166 href="mailto:xslt@gnome.org">xslt@gnome.org</a> list; if it's really libxslt
 167 related I will approve it. Please do not send mail to me directly, it makes
 168 things really hard to track and in some cases I am not the best person to
 169 answer a given question, ask on the list.</p>
 170
 171 <p>To <span style="color: #E50000">be really clear about support</span>:</p>
 172 <ul>
 173   <li>Support or help <span style="color: #E50000">request MUST be sent to
 174     the list or on bugzilla</span> in case of problems, so that the Question
 175     and Answers can be shared publicly. Failing to do so carries the implicit
 176     message "I want free support but I don't want to share the benefits with
 177     others" and is not welcome. I will automatically Carbon-Copy the
 178     xslt@gnome.org mailing list for any technical reply made about libxml2 or
 179     libxslt.</li>
 180   <li>There is <span style="color: #E50000">no guarantee for support</span>,
 181     if your question remains unanswered after a week, repost it, making sure
 182     you gave all the detail needed and the information requested.</li>
 183   <li>Failing to provide information as requested or double checking first
 184     for prior feedback also carries the implicit message "the time of the
 185     library maintainers is less valuable than my time" and might not be
 186     welcome.</li>
 187 </ul>
 188
 189 <p>Of course, bugs reports with a suggested patch for fixing them will
 190 probably be processed faster.</p>
 191
 192 <p>If you're looking for help, a quick look at <a
 193 href="http://mail.gnome.org/archives/xslt/">the list archive</a> may actually
 194 provide the answer, I usually send source samples when answering libxslt
 195 usage questions. The <a
 196 href="html/libxslt-lib.html#LIBXSLT-LIB">auto-generated documentation</a> is
 197 not as polished as I would like (I need to learn more about Docbook), but
 198 it's a good starting point.</p>
 199
 200 <h2><a name="help">How to help</a></h2>
 201
 202 <p>You can help the project in various ways, the best thing to do first is to
 203 subscribe to the mailing-list as explained before, check the <a
 204 href="http://mail.gnome.org/archives/xslt/">archives </a>and the <a
 205 href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">GNOME bug
 206 database:</a>:</p>
 207 <ol>
 208   <li>provide patches when you find problems</li>
 209   <li>provide the diffs when you port libxslt to a new platform. They may not
 210     be integrated in all cases but help pinpointing portability problems
 211   and</li>
 212   <li>provide documentation fixes (either as patches to the code comments or
 213     as HTML diffs).</li>
 214   <li>provide new documentations pieces (translations, examples, etc ...)</li>
 215   <li>Check the TODO file and try to close one of the items</li>
 216   <li>take one of the points raised in the archive or the bug database and
 217     provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
 218     </a>before to avoid synchronization problems and check that the suggested
 219     fix will fit in nicely :-)</li>
 220 </ol>
 221
 222 <h2><a name="Downloads">Downloads</a></h2>
 223
 224 <p>The latest versions of libxslt can be found on the <a
 225 href="ftp://xmlsoft.org/libxslt/">xmlsoft.org</a> server and on mirrors (<a
 226 href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a
 227 href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">GNOME FTP server</a> as a
 228 <a href="ftp://ftp.gnome.org/pub/GNOME/sources/libxslt/1.1/">source
 229 archive</a>, Antonin Sprinzl also provides <a
 230 href="ftp://gd.tuwien.ac.at/pub/libxml/">a mirror in Austria</a>. (NOTE that
 231 you need the <a href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a>,
 232 <a href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>,
 233 <a href="http://rpmfind.net/linux/RPM/libxslt.html">libxslt</a> and <a
 234 href="http://rpmfind.net/linux/RPM/libxslt-devel.html">libxslt-devel</a>
 235 packages installed to compile applications using libxslt.) <a
 236 href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the maintainer of
 237 the Windows port, <a
 238 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
 239 binaries</a>. <a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a>
 240 provides <a href="http://garypennington.net/libxml2/">Solaris binaries</a>.
 241 <a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> provides <a
 242 href="http://www.explain.com.au/oss/libxml2xslt.html">Mac Os X
 243 binaries</a>.</p>
 244
 245 <p><a name="Contribs">Contribs:</a></p>
 246
 247 <p>I do accept external contributions, especially if compiling on another
 248 platform, get in touch with me to upload the package. I will keep them in the
 249 <a href="ftp://xmlsoft.org/libxml2/contribs/">contrib directory</a></p>
 250
 251 <p>Libxslt is also available from SVN:</p>
 252 <ul>
 253   <li><p>The <a href="http://svn.gnome.org/viewcvs/libxslt/trunk/">GNOME SVN
 254     base</a>. Check the <a
 255     href="http://developer.gnome.org/tools/svn.html">GNOME SVN Tools</a>
 256     page; the SVN module is <b>libxslt</b>.</p>
 257   </li>
 258   <li><a href="ftp://xmlsoft.org/libxml2/libxslt-cvs-snapshot.tar.gz">snapshots from
 259     SVN</a> updated every hour are also provided</li>
 260 </ul>
 261
 262 <h2><a name="FAQ">FAQ</a></h2>
 263 <ol>
 264   <li><em>Troubles compiling or linking programs using libxslt</em>
 265     <p>Usually the problem comes from the fact that the compiler doesn't get
 266     the right compilation or linking flags. There is a small shell script
 267     <code>xslt-config</code> which is installed as part of libxslt usual
 268     install process which provides those flags. Use</p>
 269     <p><code>xslt-config --cflags</code></p>
 270     <p>to get the compilation flags and</p>
 271     <p><code>xslt-config --libs</code></p>
 272     <p>to get the linker flags. Usually this is done directly from the
 273     Makefile as:</p>
 274     <p><code>CFLAGS=`xslt-config --cflags`</code></p>
 275     <p><code>LIBS=`xslt-config --libs`</code></p>
 276     <p>Note also that if you use the EXSLT extensions from the program then
 277     you should prepend <code>-lexslt</code> to the LIBS options</p>
 278   </li>
 279   <li><em>passing parameters on the xsltproc command line doesn't work</em>
 280     <p><em>xsltproc --param test alpha foo.xsl foo.xml</em></p>
 281     <p><em>the param does not get passed and ends up as ""</em></p>
 282     <p>In a nutshell do a double escaping at the shell prompt:</p>
 283     <p>xsltproc --param test "'alpha'" foo.xsl foo.xml</p>
 284     <p>i.e. the string value is surrounded by " and ' then terminated by '
 285     and ". Libxslt interpret the parameter values as XPath expressions, so
 286     the string -&gt;<code>alpha</code>&lt;- is intepreted as the node set
 287     matching this string. You really want -&gt;<code>'alpha'</code>&lt;- to
 288     be passed to the processor. And to allow this you need to escape the
 289     quotes at the shell level using -&gt;<code>"'alpha'"</code>&lt;- .</p>
 290     <p>or use</p>
 291     <p>xsltproc --stringparam test alpha foo.xsl foo.xml</p>
 292   </li>
 293   <li><em>Is there C++ bindings ?</em>
 294     <p>Yes for example <a
 295     href="http://pmade.org/pjones/software/xmlwrapp/">xmlwrapp</a> , see <a
 296     href="python.html">the related pages about bindings</a></p>
 297   </li>
 298 </ol>
 299
 300 <h2><a name="News">News</a></h2>
 301
 302 <p>The <a href="ChangeLog.html">change log</a> describes the recents commits
 303 to the <a href="http://svn.gnome.org/viewcvs/libxslt/trunk/">SVN</a> code base.</p>
 304
 305 <p>Those are the public releases made:</p>
 306
 307 <h3>1.1.24: May 13 20088</h3>
 308 <ul>
 309   <li>Documentation: man page fix (Vincent Lefevre).</li>
 310   <li>Bug fixes: pattern bug fix, key initialization problems, exclusion of
 311       unknown namespaced element on top of stylesheets, python generator
 312       syntactic cleanup (Martin)</li>
 313 </ul>
 314 <h3>1.1.23: Apr  8 2008</h3>
 315 <ul>
 316   <li>Documentation: fix links for Cygwin DocBook setup (Philippe Bourcier),
 317       xsltParseStylesheetDoc doc fix (Jason Viers), fix manpage default
 318       maxdepth value </li>
 319   <li>Bug fixes: python segfault (Daniel Gryniewicz), week-in-year bug fix
 320       (Maurice van der Pot), fix python iterator problem (William Brack),
 321       avoid garbage collection problems on str:tokenize and str:split
 322       and function results (William Brack and Peter Pawlowski)
 323       superfluous re-generation of keys (William Brack), remove superfluous
 324       code in xsltExtInitTest (Tony Graham), func:result segfault fix
 325       (William Brack), timezone offset problem (Peter Pawlowski),</li>
 326   <li>Portability fixes: old gcrypt support fix (Brent Cowgill), Python
 327       portability patch (Stephane Bidoul), VS 2008 fix (Rob Richard) </li>
 328 </ul>
 329 <h3>1.1.22: Aug 23 2007</h3>
 330 <ul>
 331   <li>Bug fixes: RVT cleanup problems (William Brack), exclude-result-prefix
 332       bug (William Brack), stylesheet compilation error handling (Rob Richards).
 333       </li>
 334   <li>Portability fixes: improve build with VS2005 (Rob Richards),
 335       fixing build on AIX (Bjorn Wiberg), fix the security file checks on
 336       Windows (Roland Schwarz and Rob Richards). </li>
 337   <li>Improvement: add an --encoding option to xsltproc (Drazen Kacar). </li>
 338 </ul>
 339 <h3>1.1.21: Jun 12 2007</h3>
 340 <ul>
 341   <li>Bug fixes: out of memory allocation errors (William Brack),
 342       namespace problem on compound predicates (William Brack),
 343       python space/tab inconsistencies (Andreas Hanke), hook xsl:message
 344       to per transformation error callbacks (Shaun McCance),
 345       cached RVT problem (William Brack), XPath context maintainance
 346       on choose (William Brack), memory leaks in the math module (William
 347       Brack), exclude-result-prefix induced namespace problem (William
 348       Brack)</li>
 349   <li>Build: configure setup for TRIO_REPLACE_STDIO (William Brack)
 350   <li>Documentation: updated after change from CVs to SVN (William Brack)</li>
 351 </ul>
 352 <h3>1.1.20: Jan 17 2007</h3>
 353 <ul>
 354   <li>Portability fixes: strict aliasing fix (Marcus Meissner), BSD portability
 355       patches (Roland Illig)</li>
 356   <li>Bug fixes: Result Value Tree handling fix (William Brack), function
 357       parameters fix (William), uninitialized variable (Kjartan Maraas),
 358       empty text node handling (William), plugin support and test fixes (William),
 359       fragment support fixes (William)</li>
 360   <li>Improvements: python stylesheet compare and transform context
 361       access (Nic Ferrier), EXSLT string replace support (Joel Reed),
 362       xsltproc better low level error handling (Mike Hommey and William)</li>
 363 </ul>
 364 <h3>1.1.19: Nov 29 2006</h3>
 365 <ul>
 366   <li>Bug fixes: entities within attributes (William Brack), Python detection
 367       problem (Joseph Sacco), in-scope namespace bug (Mike Hommey), Result
 368       value tree caching bug (William Brack)</li>
 369 </ul>
 370 <h3>1.1.18: Oct 26 2006</h3>
 371 <ul>
 372   <li>portability and build fixes: DESTDIR problem, build paths in python
 373       shared lib, compile when libxml2 doesn't support XInclude (Gary Coady).</li>
 374   <li>bug fixes: a number of namespace related bugs (Kasimier Buchcik),
 375       parameters bugs (Kasimier Buchcik), proximity position in predicates
 376       of match patterns (Kasimier), exslt-node-set troubles with strings
 377       (Kasimier), CDATA serialization, Python floats and booleans XPath
 378       conversions, XInclude support fixes, RVT cleanup problem (William Brack
 379       and Kasimier), attribute checking in stylesheets (Kasimier), xsltForEach
 380       context problem (Kasimier), security check should pass full URLs (Shane
 381       Corgatelli), security cleanup patch (Mikhail Zabaluev), some python
 382       accessor for stylesheet were broken, memory errors when compiling
 383       stylesheets (Mike Hommey), EXSLT current date end-of-month problem
 384       (William Brack).</li>
 385   <li>improvements: refactoring of namespace handling, value-of impleemntation
 386       and template internal processing (Kasimier Buchcik), new xsltproc
 387       flag to apply Xinclude to stylesheets.</li>
 388   <li>documentation: xsltproc man pages (Daniel Leidert), tests updates
 389       (William Brack), various typo fixes (Daniel Leidert), comments on
 390       versions macros (Peter Breitenlohner).</li>
 391 </ul>
 392 <h3>1.1.17: Jun 6 2006</h3>
 393 <ul>
 394   <li>portability fixes: python detection</li>
 395   <li>bug fixes: some regression tests, attribute/namespaces output (Kasimier
 396     Buchcik), problem in mixed xsl:value-of and xsl:text uses (Kasimier)</li>
 397   <li>improvements: internal refactoring (Kasimier Buchcik), use of the XPath
 398     object cache in libxml2-2.6.25 (Kasimier)</li>
 399 </ul>
 400
 401 <h3>1.1.16: May 01 2006</h3>
 402 <ul>
 403   <li>portability fixes: EXSLT date/time on Solaris and IRIX (Albert Chin),
 404       HP-UX  build (Albert Chin),
 405   <li>build fixes: Python detection(Joseph Sacco), plugin configurei
 406       (Joel Reed)</li>
 407   <li>bug fixes: pattern compilation fix(William Brack), EXSLT date/time
 408       fix (Thomas Broyer), EXSLT function bug, potential loop on variable
 409       eval, startup race (Christopher Palmer), debug statement left in python
 410       (Nic Ferrier), various cleanup based on Coverity reports), error on
 411       Out of memory condition (Charles Hardin), various namespace prefixes
 412       fixes (Kasimier Buchcik), </li>
 413   <li>improvement: speed up sortingi, start of internals refactoring (Kasimier
 414       Buchcik)</li>
 415   <li>documentation: man page fixes and updates (Daniel Leidert)
 416 </ul>
 417
 418 <h3>1.1.15: Sep 04 2005</h3>
 419 <ul>
 420   <li>build fixes: Windows build cleanups and updates (Igor Zlatkovic),
 421     remove jhbuild warnings</li>
 422   <li>bug fixes: negative number formatting (William Brack), number
 423     formatting per mille definition (William Brack), XInclude default values
 424     (William), text copy bugs (William), bug related to xmlXPathContext size,
 425     reuse libxml2 memory management for text nodes, dictionary text bug,
 426     forbid variables in match (needs libxml2-2.6.21)</li>
 427   <li>improvements: EXSLT dyn:map (Mark Vakoc),</li>
 428   <li>documentation: EXSLT date and time functions namespace in man (Jonathan
 429     Wakely)</li>
 430 </ul>
 431
 432 <h3>1.1.14: Apr 02 2005</h3>
 433 <ul>
 434   <li>bug fixes: text node on stylesheet document without a dictionary
 435     (William Brack), more checking of XSLT syntax, calling xsltInit()
 436     multiple times, mode values interning raised by Mark Vakoc, bug in
 437     pattern matching with ancestors, bug in patterna matching with cascading
 438     select, xinclude and document() problem, build outside of source tree
 439     (Mike Castle)</li>
 440   <li>improvement: added a --nodict mode to xsltproc to check problems for
 441     docuemtns without dictionaries</li>
 442 </ul>
 443
 444 <h3>1.1.13: Mar 13 2005</h3>
 445 <ul>
 446   <li>build fixes: 64bits cleanup (William Brack), python 2.4 test (William),
 447     LIBXSLT_VERSION_EXTRA on Windows (William), Windows makefiles fixes (Joel
 448     Reed), libgcrypt-devel requires for RPM spec.</li>
 449   <li>bug fixes: exslt day-of-week-in-month (Sal Paradise), xsl:call-template
 450     should not change the current template rule (William Brack), evaluation
 451     of global variables (William Brack), RVT's in XPath predicates (William),
 452     namespace URI on template names (Mark Vakoc), stat() for Windows patch
 453     (Aleksey Gurtovoy), pattern expression fixes (William Brack), out of
 454     memory detection misses (William), parserOptions propagation (William),
 455     exclude-result-prefixes fix (William), // patten fix (William).</li>
 456   <li>extensions: module support (Joel Reed), dictionary based speedups
 457     trying to get rid of xmlStrEqual as much as possible.</li>
 458   <li>documentation: added Wiki (Joel Reed)</li>
 459 </ul>
 460
 461 <h3>1.1.12: Oct 29 2004</h3>
 462 <ul>
 463   <li>build fixes: warnings removal (William).</li>
 464   <li>bug fixes: attribute document pointer fix (Mark Vakoc), exslt date
 465     negative periods (William Brack), generated tree structure fixes,
 466     namespace lookup fix, use reentrant gmtime_r (William Brack),
 467     exslt:funtion namespace fix (William), potential NULL pointer reference
 468     (Dennis Dams, William), force string interning on generated
 469   documents.</li>
 470   <li>documentation: update of the second tutorial (Panagiotis Louridas), add
 471     exslt doc in rpm packages, fix the xsltproc man page.</li>
 472 </ul>
 473
 474 <h3>1.1.11: Sep 29 2004</h3>
 475 <ul>
 476   <li>bug fixes: xsl:include problems (William Brack), UTF8 number pattern
 477     (William), date-time validation (William), namespace fix (William),
 478     various Exslt date fixes (William), error callback fixes, leak with
 479     namespaced global variable, attempt to fix a weird problem #153137</li>
 480   <li>improvements: exslt:date-sum tests (Derek Poon)</li>
 481   <li>documentation: second tutorial by Panagiotis Lourida</li>
 482 </ul>
 483
 484 <h3>1.1.10: Aug 31 2004</h3>
 485 <ul>
 486   <li>build fix: NUL in c file blocking compilation on Solaris, Windows build
 487     (Igor Zlatkovic)</li>
 488   <li>fix: key initialization problem (William Brack)</li>
 489   <li>documentation: fixed missing man page description for --path</li>
 490 </ul>
 491
 492 <h3>1.1.9: Aug 22 2004</h3>
 493 <ul>
 494   <li>build fixes: missing tests (William Brack), Python dependancies, Python
 495     on 64bits boxes, --with-crypto flag (Rob Richards),</li>
 496   <li>fixes: RVT key handling (William), Python binding (William and Sitsofe
 497     Wheeler), key and XPath troubles (William), template priority on imports
 498     (William), str:tokenize with empty strings (William), #default namespace
 499     alias behaviour (William), doc ordering missing for main document
 500     (William), 64bit bug (Andreas Schwab)</li>
 501   <li>improvements: EXSLT date:sum added (Joel Reed), hook for document
 502     loading for David Hyatt, xsltproc --nodtdattr to avoid defaulting DTD
 503     attributes, extend xsltproc --version with CVS stamp (William).</li>
 504   <li>Documentation: web page problem reported by Oliver Stoeneberg</li>
 505 </ul>
 506
 507 <h3>1.1.8: July 5 2004</h3>
 508 <ul>
 509   <li>build fixes: Windows runtime options (Oliver Stoeneberg), Windows
 510     binary package layout (Igor Zlatkovic), libgcrypt version test and link
 511     (William)</li>
 512   <li>documentation: fix libxslt namespace name in doc (William)</li>
 513   <li>bug fixes: undefined namespace message (William Brack), search engine
 514     (William), multiple namespace fixups (William), namespace fix for key
 515     evaluation (William), Python memory debug bindings,</li>
 516   <li>improvements: crypto extensions for exslt (Joel Reed, William)</li>
 517 </ul>
 518
 519 <h3>1.1.7: May 17 2004</h3>
 520 <ul>
 521   <li>build fix: warning about localtime_r on Solaris</li>
 522   <li>bug fix: UTF8 string tokenize (William Brack), subtle memory
 523     corruption, linefeed after comment at document level (William),
 524     disable-output-escaping problem (William), pattern compilation in deep
 525     imported stylesheets (William), namespace extension prefix bug,
 526     libxslt.m4 bug (Edward Rudd), namespace lookup for attribute, namespaced
 527     DOCTYPE name</li>
 528 </ul>
 529
 530 <h3>1.1.6: Apr 18 2004</h3>
 531 <ul>
 532   <li>2 bug fixes about keys fixed one by Mark Vakoc</li>
 533 </ul>
 534
 535 <h3>1.1.5: Mar 23 2004</h3>
 536 <ul>
 537   <li>performance: use dictionary lookup for variables</li>
 538   <li>remove use of _private from source documents</li>
 539   <li>cleanup of "make tests" output</li>
 540   <li>bugfixes: AVT in local variables, use localtime_r to avoid thread
 541     troubles (William), dictionary handling bug (William), limited number of
 542     stubstitutions in AVT (William), tokenize fix for UTF-8 (William),
 543     superfluous namespace (William), xsltproc error code on
 544     &lt;xsl:message&gt; halt, OpenVMS fix, dictionary reference counting
 545     change.</li>
 546 </ul>
 547
 548 <h3>1.1.4: Feb 23 2004</h3>
 549 <ul>
 550   <li>bugfixes: attributes without doc (Mariano Suárez-Alvarez), problem with
 551     Yelp, extension problem</li>
 552   <li>display extension modules (Steve Little)</li>
 553   <li>Windows compilation patch (Mark Vadoc), Mingw (Mikhail Grushinskiy)</li>
 554 </ul>
 555
 556 <h3>1.1.3: Feb 16 2004</h3>
 557 <ul>
 558   <li>Rewrote the Attribute Value Template code, new XPath compilation
 559     interfaces, dictionary reuses for XSLT with potential for serious
 560     performance improvements.</li>
 561   <li>bug fixes: portability (William Brack), key() in node-set() results
 562     (William), comment before doctype (William), math and node-set() problems
 563     (William), cdata element and default namespace (William), behaviour on
 564     unknown XSLT elements (Stefan Kost), priority of "//foo" patterns
 565     (William), xsl:element and xsl:attribute QName check (William), comments
 566     with -- (William), attribute namespace (William), check for ?&gt; in PI
 567     (William)</li>
 568   <li>Documentations: cleanup (John Fleck and William)</li>
 569   <li>Python: patch for OS-X (Gianni Ceccarelli), enums export (Stephane
 570     bidoul)</li>
 571 </ul>
 572
 573 <h3>1.1.2: Dec 24 2003</h3>
 574 <ul>
 575   <li>Documentation fixes (John Fleck, William Brack), EXSLT documentation
 576     (William Brack)</li>
 577   <li>Windows compilation fixes for MSVC and Mingw (Igor Zlatkovic)</li>
 578   <li>Bug fixes: exslt:date returning NULL strings (William Brack),
 579     namespaces output (William Brack),  key and namespace definition problem,
 580     passing options down to the document() parser, xsl:number fixes (William
 581     Brack)</li>
 582 </ul>
 583
 584 <h3>1.1.1: Dec 10 2003</h3>
 585 <ul>
 586   <li>code cleanup (William Brack)</li>
 587   <li>Windows: Makefile improvements (Igor Zlatkovic)</li>
 588   <li>documentation improvements: William Brack, libexslt man page (Jonathan
 589     Wakely)</li>
 590   <li>param in EXSLT functions (Shaun McCance)</li>
 591   <li>XSLT debugging improvements (Mark Vakoc)</li>
 592   <li>bug fixes: number formatting (Bjorn Reese), exslt:tokenize (William
 593     Brack), key selector parsing with | reported by Oleg Paraschenko,
 594     xsl:element with computed namespaces (William Brack), xslt:import/include
 595     recursion detection (William Brack), exslt:function used in keys (William
 596     Brack), bug when CDATA_SECTION are foun in the tree (William Brack),
 597     entities handling when using XInclude.</li>
 598 </ul>
 599
 600 <h3>1.1.0: Nov 4 2003</h3>
 601 <ul>
 602   <li>Removed DocBook SGML broken support</li>
 603   <li>fix xsl:key to work with PIs</li>
 604   <li>Makefile and build improvement (Graham Wilson), build cleanup (William
 605     Brack), macro fix (Justin Fletcher), build outside of source tree (Roumen
 606     Petrov)</li>
 607   <li>xsltproc option display fix (Alexey Efimov), --load-trace (Crutcher
 608     Dunnavant)</li>
 609   <li>Python: never use stdout for error</li>
 610   <li>extension memory error fix (Karl Eichwalder)</li>
 611   <li>header path fixes (Steve Ball)</li>
 612   <li>added saxon:line-number() to libexslt (Brett Kail)</li>
 613   <li>Fix some tortuous template problems when using predicates (William
 614     Brack)</li>
 615   <li>Debugger status patch (Kasimier Buchcik)</li>
 616   <li>Use new libxml2-2.6.x APIs for faster processing</li>
 617   <li>Make sure xsl:sort is empty</li>
 618   <li>Fixed a bug in default processing of attributes</li>
 619   <li>Removes the deprecated breakpoint library</li>
 620   <li>detect invalid names on templates (William Brack)</li>
 621   <li>fix exslt:document (and similar) base handling problem</li>
 622 </ul>
 623
 624 <h3>1.0.33: Sep 12 2003</h3>
 625
 626 <p>This is a bugfix only release</p>
 627 <ul>
 628   <li>error message missing argument (William Brack)</li>
 629   <li>mode not cascaded in template fallbacks (William Brack)</li>
 630   <li>catch redefinition of parameter/variables  (William Brack)</li>
 631   <li>multiple keys with same namespace name (William Brack)</li>
 632   <li>patch for compilation using MingW on Windows (Mikhail Grushinskiy)</li>
 633   <li>header export macros for Windows (Igor Zlatkovic)</li>
 634   <li>cdata-section-elements handling of namespaced names</li>
 635   <li>compilation without libxml2 XPointer support (Mark Vadoc)</li>
 636   <li>apply-templates crash (William Brack)</li>
 637   <li>bug with imported templates (William Brack)</li>
 638   <li>imported attribute-sets merging bug (DocBook) (William Brack)</li>
 639 </ul>
 640
 641 <h3>1.0.32: Aug 9 2003</h3>
 642 <ul>
 643   <li>bugfixes: xsltSaveResultToFile() python binding (Chris Jaeger), EXSLT
 644     function (William Brack), RVT for globals (William Brack), EXSLT date
 645     (William Brack),
 646     <p>speed of large text output, xsl:copy with attributes, strip-space and
 647     namespaces prefix, fix for --path xsltproc option, EXST:tokenize (Shaun
 648     McCance), EXSLT:seconds (William Brack), sort with multiple keys (William
 649     Brack), checking of { and } for attribute value templates (William
 650     Brack)</p>
 651   </li>
 652   <li>Python bindings for extension elements (Sean Treadway)</li>
 653   <li>EXSLT:split added (Shaun McCance)</li>
 654   <li>portability fixes for HP-UX/Solaris/IRIX (William Brack)</li>
 655   <li>doc cleanup</li>
 656 </ul>
 657
 658 <h3>1.0.31: Jul 6 2003</h3>
 659 <ul>
 660   <li>bugfixes: xsl:copy on namespace nodes, AVT for xsl:sort order, fix for
 661     the debugger (Keith Isdale), output filename limitation, trio.h and
 662     triodef.h added (Albert Chin), EXSLT node-set (Peter Breitenlohner),
 663     xsltChoose and whitespace (Igor Zlatkovic),
 664     <p>stylesheet compilation (Igor Zlatkovic), NaN and sort (William Brack),
 665     RVT bug introduced in 1.0.30</p>
 666   </li>
 667   <li>avoid generating &amp;quot; (fix in libxml2-2.5.8)</li>
 668   <li>fix 64bit cleaness problem and compilation troubles introduced in
 669   1.0.30</li>
 670   <li>Windows makefile generation (Igor Zlatkovic)</li>
 671   <li>HP-UX portability fix</li>
 672 </ul>
 673
 674 <h3>1.0.30: May 4 2003</h3>
 675 <ul>
 676   <li>Fixes and new APIs to handle Result Value Trees and avoid leaks</li>
 677   <li>Fixes for: EXSLT math pow() function (Charles Bozeman), global
 678     parameter and global variables mismatch, a segfault on pattern
 679     compilation errors, namespace copy in xsl:copy-of, python generator
 680     problem, OpenVMS trio update, premature call to xsltFreeStackElem (Igor),
 681     current node when templates applies to attributes</li>
 682 </ul>
 683
 684 <h3>1.0.29: Apr 1 2003</h3>
 685 <ul>
 686   <li>performance improvements especially for large flat documents</li>
 687   <li>bug fixes: Result Value Tree handling, XML IDs, keys(), extra namespace
 688     declarations with xsl:elements.</li>
 689   <li>portability: python and trio fixes (Albert Chin), python on Solaris
 690     (Ben Phillips)</li>
 691 </ul>
 692
 693 <h3>1.0.28: Mar 24 2003</h3>
 694 <ul>
 695   <li>fixed node() in patterns semantic.</li>
 696   <li>fixed a memory access problem in format-number()</li>
 697   <li>fixed stack overflow in recursive global variable or params</li>
 698   <li>cleaned up Result Value Tree handling, and fixed a couple of old bugs
 699     in the process</li>
 700 </ul>
 701
 702 <h3>1.0.27: Feb 24 2003</h3>
 703 <ul>
 704   <li>bug fixes: spurious xmlns:nsX="" generation, serialization bug (in
 705     libxml2), a namespace copy problem, errors in the RPM spec prereqs</li>
 706   <li>Windows path canonicalization and document cache fix (Igor)</li>
 707 </ul>
 708
 709 <h3>1.0.26: Feb 10 2003</h3>
 710 <ul>
 711   <li>Fixed 3 serious bugs in document() and stylesheet compilation which
 712     could lead to a crash</li>
 713 </ul>
 714
 715 <h3>1.0.25: Feb 5 2003</h3>
 716 <ul>
 717   <li>Bug fix: double-free for standalone stylesheets introduced in 1.0.24, C
 718     syntax pbm, 3 bugs reported by Eric van der Vlist</li>
 719   <li>Some XPath and XInclude related problems were actually fixed in
 720     libxml2-2.5.2</li>
 721   <li>Documentation: emphasize taht --docbook is not for XML docs.</li>
 722 </ul>
 723
 724 <h3>1.0.24: Jan 14 2003</h3>
 725 <ul>
 726   <li>bug fixes: imported global varables, python bindings (Stéphane Bidoul),
 727     EXSLT memory leak (Charles Bozeman), namespace generation on
 728     xsl:attribute, space handling with imports (Daniel Stodden),
 729     extension-element-prefixes (Josh Parsons), comments within xsl:text (Matt
 730     Sergeant), superfluous xmlns generation, XInclude related bug for
 731     numbering, EXSLT strings (Alexey Efimov), attribute-sets computation on
 732     imports, extension module init and shutdown callbacks not called</li>
 733   <li>HP-UX portability (Alexey Efimov), Windows makefiles (Igor and Stephane
 734     Bidoul), VMS makefile updates (Craig A. Berry)</li>
 735   <li>adds xsltGetProfileInformation() (Michael Rothwell)</li>
 736   <li>fix the API generation scripts</li>
 737   <li>API to provide the sorting routines (Richard Jinks)</li>
 738   <li>added XML description of the EXSLT API</li>
 739   <li>added ESXLT URI (un)escaping (Jörg Walter)</li>
 740   <li>Some memory leaks have been found and fixed</li>
 741   <li>document() now support fragment identifiers in URIs</li>
 742 </ul>
 743
 744 <h3>1.0.23: Nov 17 2002</h3>
 745 <ul>
 746   <li>Windows build cleanup (Igor)</li>
 747   <li>Unix build and RPM packaging cleanup</li>
 748   <li>Improvement of the python bindings: extension functions and activating
 749     EXSLT</li>
 750   <li>various bug fixes: number formatting, portability for bounded string
 751     functions, CData nodes, key(), @*[...] patterns</li>
 752   <li>Documentation improvements (John Fleck)</li>
 753   <li>added libxslt.m4 (Thomas Schraitle)</li>
 754 </ul>
 755
 756 <h3>1.0.22: Oct 18 2002</h3>
 757 <ul>
 758   <li>Updates on the Windows Makefiles</li>
 759   <li>Added a security module, and a related set of new options to
 760   xsltproc</li>
 761   <li>Allowed per transformation error handler.</li>
 762   <li>Fixed a few bugs: node() semantic, URI escaping, media-type, attribute
 763     lists</li>
 764 </ul>
 765
 766 <h3>1.0.21: Sep 26 2002</h3>
 767 <ul>
 768   <li>Bug fixes: match="node()", date:difference() (Igor and Charlie
 769     Bozeman), disable-output-escaping</li>
 770   <li>Python bindings: style.saveResultToString() from Ralf Mattes</li>
 771   <li>Logos from Marc Liyanage</li>
 772   <li>Mem leak fix from Nathan Myers</li>
 773   <li>Makefile: DESTDIR fix from Christophe Merlet, AMD x86_64 (Mandrake),
 774     Windows (Igor), Python detection</li>
 775   <li>Documentation improvements: John Fleck</li>
 776 </ul>
 777
 778 <h3>1.0.20: Aug 23 2002</h3>
 779 <ul>
 780   <li>Windows makefile updates (Igor) and x86-64 (Frederic Crozat)</li>
 781   <li>fixed HTML meta tag saving for Mac/IE users</li>
 782   <li>possible leak patches from Nathan Myers</li>
 783   <li>try to handle document('') as best as possible depending in the
 784   cases</li>
 785   <li>Fixed the DocBook stylesheets handling problem</li>
 786   <li>Fixed a few XSLT reported errors</li>
 787 </ul>
 788
 789 <h3>1.0.19:  July 6 2002</h3>
 790 <ul>
 791   <li>EXSLT: dynamic functions and date support bug fixes (Mark Vakoc)</li>
 792   <li>xsl:number fix: Richard Jinks</li>
 793   <li>xsl:format-numbers fix: Ken Neighbors</li>
 794   <li>document('') fix: bug pointed by Eric van der Vlist</li>
 795   <li>xsl:message with terminate="yes" fixes: William Brack</li>
 796   <li>xsl:sort order support added: Ken Neighbors</li>
 797   <li>a few other bug fixes, some of them requiring the latest version of
 798     libxml2</li>
 799 </ul>
 800
 801 <h3>1.0.18: May 27 2002</h3>
 802 <ul>
 803   <li>a number of bug fixes: attributes, extra namespace declarations
 804     (DocBook), xsl:include crash (Igor), documentation (Christian Cornelssen,
 805     Charles Bozeman and Geert Kloosterman),  element-available (Richard
 806   Jinks)</li>
 807   <li>xsltproc can now list teh registered extensions thanks to Mark
 808   Vakoc</li>
 809   <li>there is a new API to save directly to a string
 810     xsltSaveResultToString() by Morus Walter</li>
 811   <li>specific error registration function for the python API</li>
 812 </ul>
 813
 814 <h3>1.0.17: April 29 2002</h3>
 815 <ul>
 816   <li>cleanup in code, XSLT debugger support and Makefiles for Windows by
 817   Igor</li>
 818   <li>a C++ portability fix by Mark Vakoc</li>
 819   <li>EXSLT date improvement and regression tests by Charles Bozeman</li>
 820   <li>attempt to fix a bug in xsltProcessUserParamInternal</li>
 821 </ul>
 822
 823 <h3>1.0.16: April 15 2002</h3>
 824 <ul>
 825   <li>Bug fixes: strip-space, URL in HTML output, error when xsltproc can't
 826     save</li>
 827   <li>portability fixes: OSF/1, IEEE on alphas, Windows, Python bindings</li>
 828 </ul>
 829
 830 <h3>1.0.15: Mar 25 2002</h3>
 831 <ul>
 832   <li>Bugfixes: XPath, python Makefile, recursive attribute sets, @foo[..]
 833     templates</li>
 834   <li>Debug of memory alocation with valgind</li>
 835   <li>serious profiling leading to significant improvement for DocBook
 836     processing</li>
 837   <li>revamp of the Windows build</li>
 838 </ul>
 839
 840 <h3>1.0.14: Mar 18 2002</h3>
 841 <ul>
 842   <li>Improvement in the XPath engine (libxml2-2.4.18)</li>
 843   <li>Nasty bug fix related to exslt:node-set</li>
 844   <li>Fixed the python Makefiles, cleanup of doc comments, Windows
 845     portability fixes</li>
 846 </ul>
 847
 848 <h3>1.0.13: Mar 8 2002</h3>
 849 <ul>
 850   <li>a number of bug fixes including "namespace node have no parents"</li>
 851   <li>Improvement of the Python bindings</li>
 852   <li>Charles Bozeman provided fixes and regression tests for exslt date
 853     functions.</li>
 854 </ul>
 855
 856 <h3>1.0.12: Feb 11 2002</h3>
 857 <ul>
 858   <li>Fixed the makefiles especially the python module ones</li>
 859   <li>half a dozen bugs fixes including 2 old ones</li>
 860 </ul>
 861
 862 <h3>1.0.11: Feb 8 2002</h3>
 863 <ul>
 864   <li>Change of Licence to the <a
 865     href="http://www.opensource.org/licenses/mit-license.html">MIT
 866   Licence</a></li>
 867   <li>Added a beta version of the Python bindings, including support to
 868     extend the engine with functions written in Python</li>
 869   <li>A number of bug fixes</li>
 870   <li>Charlie Bozeman provided more EXSLT functions</li>
 871   <li>Portability fixes</li>
 872 </ul>
 873
 874 <h3>1.0.10: Jan 14 2002</h3>
 875 <ul>
 876   <li>Windows fixes for Win32 from Igor</li>
 877   <li>Fixed the Solaris compilation trouble (Albert)</li>
 878   <li>Documentation changes and updates: John Fleck</li>
 879   <li>Added a stringparam option to avoid escaping hell at the shell
 880   level</li>
 881   <li>A few bug fixes</li>
 882 </ul>
 883
 884 <h3>1.0.9: Dec 7 2001</h3>
 885 <ul>
 886   <li>Makefile patches from Peter Williams</li>
 887   <li>attempt to fix the compilation problem associated to prelinking</li>
 888   <li>obsoleted libxsltbreakpoint now deprecated and frozen to 1.0.8 API</li>
 889   <li>xsltproc return codes are now significant, John Fleck updated the
 890     documentation</li>
 891   <li>patch to allow as much as 40 steps in patterns (Marc Tardif), should be
 892     made dynamic really</li>
 893   <li>fixed a bug raised by Nik Clayton when using doctypes with HTML
 894   output</li>
 895   <li>patches from Keith Isdale to interface with xsltdebugger</li>
 896 </ul>
 897
 898 <h3>1.0.8: Nov 26 2001</h3>
 899 <ul>
 900   <li>fixed an annoying header problem, removed a few bugs and some code
 901     cleanup</li>
 902   <li>patches for Windows and update of Windows Makefiles by Igor</li>
 903   <li>OpenVMS port instructions from John A Fotheringham</li>
 904   <li>fixed some Makefiles annoyance and libraries prelinking
 905   information</li>
 906 </ul>
 907
 908 <h3>1.0.7: Nov 10 2001</h3>
 909 <ul>
 910   <li>remove a compilation problem with LIBXSLT_PUBLIC</li>
 911   <li>Finishing the integration steps for Keith Isdale debugger</li>
 912   <li>fixes the handling of indent="no" on HTML output</li>
 913   <li>fixes on the configure script and RPM spec file</li>
 914 </ul>
 915
 916 <h3>1.0.6: Oct 30 2001</h3>
 917 <ul>
 918   <li>bug fixes on number formatting (Thomas), date/time functions (Bruce
 919     Miller)</li>
 920   <li>update of the Windows Makefiles (Igor)</li>
 921   <li>fixed DOCTYPE generation rules for HTML output (me)</li>
 922 </ul>
 923
 924 <h3>1.0.5: Oct 10 2001</h3>
 925 <ul>
 926   <li>some portability fixes, including Windows makefile updates from
 927   Igor</li>
 928   <li>fixed a dozen bugs on XSLT and EXSLT (me and Thomas Broyer)</li>
 929   <li>support for Saxon's evaluate and expressions extensions added (initial
 930     contribution from Darren Graves)</li>
 931   <li>better handling of XPath evaluation errors</li>
 932 </ul>
 933
 934 <h3>1.0.4: Sep 12 2001</h3>
 935 <ul>
 936   <li>Documentation updates from John fleck</li>
 937   <li>bug fixes (DocBook  FO generation should be fixed)  and portability
 938     improvements</li>
 939   <li>Thomas Broyer improved the existing EXSLT support and added String,
 940     Time and Date core functions support</li>
 941 </ul>
 942
 943 <h3>1.0.3:  Aug 23 2001</h3>
 944 <ul>
 945   <li>XML Catalog support see the doc</li>
 946   <li>New NaN/Infinity floating point code</li>
 947   <li>A few bug fixes</li>
 948 </ul>
 949
 950 <h3>1.0.2:  Aug 15 2001</h3>
 951 <ul>
 952   <li>lot of bug fixes, increased the testsuite</li>
 953   <li>a large chunk of EXSLT is implemented</li>
 954   <li>improvements on the extension framework</li>
 955   <li>documentation improvements</li>
 956   <li>Windows MSC projects files should be up-to-date</li>
 957   <li>handle attributes inherited from the DTD by default</li>
 958 </ul>
 959
 960 <h3>1.0.1:  July 24 2001</h3>
 961 <ul>
 962   <li>initial EXSLT framework</li>
 963   <li>better error reporting</li>
 964   <li>fixed the profiler on Windows</li>
 965   <li>bug fixes</li>
 966 </ul>
 967
 968 <h3>1.0.0: July 10 2001</h3>
 969 <ul>
 970   <li>a lot of cleanup, a lot of regression tests added or fixed</li>
 971   <li>added a documentation for <a href="extensions.html">writing
 972     extensions</a></li>
 973   <li>fixed some variable evaluation problems (with William)</li>
 974   <li>added profiling of stylesheet execution accessible as the xsltproc
 975     --profile option</li>
 976   <li>fixed element-available() and the implementation of the various
 977     chunking methods present, Norm Walsh provided a lot of feedback</li>
 978   <li>exclude-result-prefixes and namespaces output should now work as
 979     expected</li>
 980   <li>added support of embedded stylesheet as described in section 2.7 of the
 981     spec</li>
 982 </ul>
 983
 984 <h3>0.14.0: July 5 2001</h3>
 985 <ul>
 986   <li>lot of bug fixes, and code cleanup</li>
 987   <li>completion of the little XSLT-1.0 features left unimplemented</li>
 988   <li>Added and implemented the extension API suggested by Thomas Broyer</li>
 989   <li>the Windows MSC environment should be complete</li>
 990   <li>tested and optimized with a really large document (DocBook Definitive
 991     Guide) libxml/libxslt should really be faster on serious workloads</li>
 992 </ul>
 993
 994 <h3>0.13.0: June 26 2001</h3>
 995 <ul>
 996   <li>lots of cleanups</li>
 997   <li>fixed a C++ compilation problem</li>
 998   <li>couple of fixes to xsltSaveTo()</li>
 999   <li>try to fix Docbook-xslt-1.4 and chunking, updated the regression test
1000     with them</li>
1001   <li>fixed pattern compilation and priorities problems</li>
1002   <li>Patches for Windows and MSC project mostly contributed by Yon Derek</li>
1003   <li>update to the Tutorial by John Fleck</li>
1004   <li>William fixed bugs in templates and for-each functions</li>
1005   <li>added a new interface xsltRunStylesheet() for a more flexible output
1006     (incomplete), added -o option to xsltproc</li>
1007 </ul>
1008
1009 <h3>0.12.0: June 18 2001</h3>
1010 <ul>
1011   <li>fixed a dozen of bugs reported</li>
1012   <li>HTML generation should be quite better (requires libxml-2.3.11 upgrade
1013     too)</li>
1014   <li>William fixed some problems with document()</li>
1015   <li>Fix namespace nodes selection and copy (requires libxml-2.3.11 upgrade
1016     too)</li>
1017   <li>John Fleck added a<a href="tutorial/libxslttutorial.html">
1018   tutorial</a></li>
1019   <li>Fixes for namespace handling when evaluating variables</li>
1020   <li>XInclude global flag added to process XInclude on document() if
1021     requested</li>
1022   <li>made xsltproc --version more detailed</li>
1023 </ul>
1024
1025 <h3>0.11.0: June 1 2001</h3>
1026
1027 <p>Mostly a bug fix release.</p>
1028 <ul>
1029   <li>integration of catalogs from xsltproc</li>
1030   <li>added --version to xsltproc for bug reporting</li>
1031   <li>fixed errors when handling ID in external parsed entities</li>
1032   <li>document() should hopefully work correctly but ...</li>
1033   <li>fixed bug with PI and comments processing</li>
1034   <li>William fixed the XPath string functions when using unicode</li>
1035 </ul>
1036
1037 <h3>0.10.0: May 19 2001</h3>
1038 <ul>
1039   <li>cleanups to make stylesheet read-only (not 100% complete)</li>
1040   <li>fixed URI resolution in document()</li>
1041   <li>force all XPath expression to be compiled at stylesheet parsing time,
1042     even if unused ...</li>
1043   <li>Fixed HTML default output detection</li>
1044   <li>Fixed double attribute generation #54446</li>
1045   <li>Fixed {{ handling in attributes #54451</li>
1046   <li>More tests and speedups for DocBook document transformations</li>
1047   <li>Fixed a really bad race like bug in xsltCopyTreeList()</li>
1048   <li>added a documentation on the libxslt internals</li>
1049   <li>William Brack and Bjorn Reese improved format-number()</li>
1050   <li>Fixed multiple sort, it should really work now</li>
1051   <li>added a --docbook option for SGML DocBook input (hackish)</li>
1052   <li>a number of other bug fixes and regression test added as people were
1053     submitting them</li>
1054 </ul>
1055
1056 <h3>0.9.0: May 3 2001</h3>
1057 <ul>
1058   <li>lot of various bugfixes, extended the regression suite</li>
1059   <li>xsltproc should work with multiple params</li>
1060   <li>added an option to use xsltproc with HTML input</li>
1061   <li>improved the stylesheet compilation, processing of complex stylesheets
1062     should be faster</li>
1063   <li>using the same stylesheet for concurrent processing on multithreaded
1064     programs should work now</li>
1065   <li>fixed another batch of namespace handling problems</li>
1066   <li>Implemented multiple level of sorting</li>
1067 </ul>
1068
1069 <h3>0.8.0: Apr 22 2001</h3>
1070 <ul>
1071   <li>fixed ansidecl.h problem</li>
1072   <li>fixed unparsed-entity-uri() and generate-id()</li>
1073   <li>sort semantic fixes and priority prob from William M. Brack</li>
1074   <li>fixed namespace handling problems in XPath expression computations
1075     (requires libxml-2.3.7)</li>
1076   <li>fixes to current() and key()</li>
1077   <li>other, smaller fixes, lots of testing with N Walsh DocBook HTML
1078     stylesheets</li>
1079 </ul>
1080
1081 <h3>0.7.0: Apr 10 2001</h3>
1082 <ul>
1083   <li>cleanup using stricter compiler flags</li>
1084   <li>command line parameter passing</li>
1085   <li>fix to xsltApplyTemplates from William M. Brack</li>
1086   <li>added the XSLTMark in the regression tests as well as document()</li>
1087 </ul>
1088
1089 <h3>0.6.0: Mar 22 2001</h3>
1090 <ul>
1091   <li>another beta</li>
1092   <li>requires 2.3.5, which provide XPath expression compilation support</li>
1093   <li>document() extension should function properly</li>
1094   <li>fixed a number or reported bugs</li>
1095 </ul>
1096
1097 <h3>0.5.0: Mar 10 2001</h3>
1098 <ul>
1099   <li>fifth beta</li>
1100   <li>some optimization work, for the moment 2 XSLT transform cannot use the
1101     same stylesheet at the same time (to be fixed)</li>
1102   <li>fixed problems with handling of tree results</li>
1103   <li>fixed a reported strip-spaces problem</li>
1104   <li>added more reported/fixed bugs to the test suite</li>
1105   <li>incorporated William M. Brack fix for imports and global variables as
1106     well as patch for with-param support in apply-templates</li>
1107   <li>a bug fix on for-each</li>
1108 </ul>
1109
1110 <h3>0.4.0: Mar 1 2001</h3>
1111 <ul>
1112   <li>fourth beta test, released at the same time of libxml2-2.3.3</li>
1113   <li>bug fixes</li>
1114   <li>some optimization</li>
1115   <li>started implement extension support, not finished</li>
1116   <li>implemented but not tested multiple file output</li>
1117 </ul>
1118
1119 <h3>0.3.0: Feb 24 2001</h3>
1120 <ul>
1121   <li>third beta test, released at the same time of libxml2-2.3.2</li>
1122   <li>lot of bug fixes</li>
1123   <li>some optimization</li>
1124   <li>added DocBook XSL based testsuite</li>
1125 </ul>
1126
1127 <h3>0.2.0: Feb 15 2001</h3>
1128 <ul>
1129   <li>second beta version, released at the same time as libxml2-2.3.1</li>
1130   <li>getting close to feature completion, lot of bug fixes, some in the HTML
1131     and XPath support of libxml</li>
1132   <li>start becoming usable for real work. This version can now regenerate
1133     the XML 2e HTML from the original XML sources and the associated
1134     stylesheets (in <a
1135     href="http://www.w3.org/TR/REC-xml#b4d250b6c21">section I of the XML
1136     REC</a>)</li>
1137   <li>Still misses extension element/function/prefixes support. Support of
1138     key() and document() is not complete</li>
1139 </ul>
1140
1141 <h3>0.1.0: Feb 8 2001</h3>
1142 <ul>
1143   <li>first beta version, released at the same time as libxml2-2.3.0</li>
1144   <li>lots of bug fixes, first "testing" version, but incomplete</li>
1145 </ul>
1146
1147 <h3>0.0.1: Jan 25 2001</h3>
1148 <ul>
1149   <li>first alpha version released at the same time as libxml2-2.2.12</li>
1150   <li>Framework in place, should work on simple examples, but far from being
1151     feature complete</li>
1152 </ul>
1153
1154 <h2><a name="xsltproc">The xsltproc tool</a></h2>
1155
1156 <p>This program is the simplest way to use libxslt: from the command line. It
1157 is also used for doing the regression tests of the library.</p>
1158
1159 <p>It takes as first argument the path or URL to an XSLT stylesheet, the next
1160 arguments are filenames or URIs of the inputs to be processed. The output of
1161 the processing is redirected on the standard output. There is actually a few
1162 more options available:</p>
1163 <pre>orchis:~ -&gt; xsltproc
1164 Usage: xsltproc [options] stylesheet file [file ...]
1165    Options:
1166       --version or -V: show the version of libxml and libxslt used
1167       --verbose or -v: show logs of what's happening
1168       --output file or -o file: save to a given file
1169       --timing: display the time used
1170       --repeat: run the transformation 20 times
1171       --debug: dump the tree of the result instead
1172       --novalid: skip the Dtd loading phase
1173       --noout: do not dump the result
1174       --maxdepth val : increase the maximum depth
1175       --html: the input document is(are) an HTML file(s)
1176       --docbook: the input document is SGML docbook
1177       --param name value : pass a (parameter,value) pair
1178       --nonet refuse to fetch DTDs or entities over network
1179       --warnnet warn against fetching over the network
1180       --catalogs : use the catalogs from $SGML_CATALOG_FILES
1181       --xinclude : do XInclude processing on document input
1182       --profile or --norman : dump profiling information
1183 orchis:~ -&gt;</pre>
1184
1185 <h2><a name="DocBook">DocBook</a></h2>
1186
1187 <p><img src="duck.png" align="right" alt="The duck picture"></p>
1188
1189 <p><a href="http://www.oasis-open.org/committees/docbook/">DocBook</a> is an
1190 XML/SGML vocabulary particularly well suited to books and papers about
1191 computer hardware and software.</p>
1192
1193 <p>xsltproc and libxslt are not specifically dependant on DocBook, but since
1194 a lot of people use xsltproc and libxml2 for DocBook formatting, here are a
1195 few pointers and information which may be helpful:</p>
1196 <ul>
1197   <li>The <a href="http://www.oasis-open.org/committees/docbook/">DocBook
1198     homepage at Oasis</a> you should find pointers there on all the lastest
1199     versions of the DTDs and XSLT stylesheets</li>
1200   <li><a href="http://www.docbook.org/">DocBook: The Definitive Guide</a> is
1201     the official reference documentation for DocBook.</li>
1202   <li><a
1203     href="https://sourceforge.net/docman/index.php?group_id=21935">DocBook
1204     Open Repository</a> contains a lot of information about DocBook</li>
1205   <li>Bob Stayton provides a <a href="http://www.sagehill.net/">lot of
1206     resources</a> and consulting services around DocBook.</li>
1207   <li>Here is a <a href="/buildDocBookCatalog">shell script</a> to generate
1208     XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
1209     directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
1210     the resources found on the system. Otherwise it will just create
1211     ~/xmlcatalog and ~/dbkxmlcatalog and doing:
1212     <p><code>export XMLCATALOG=$HOME/xmlcatalog</code></p>
1213     <p>should allow to process DocBook documentations without requiring
1214     network accesses for the DTd or stylesheets</p>
1215   </li>
1216   <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
1217     small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
1218     to work fine for me too</li>
1219   <li>Informations on installing a <a
1220     href="http://wiki.docbook.org/topic/CygwinPackages">Windows
1221     DocBook processing setup</a> based on Cygwin (using the binaries from the
1222     official Windows port should be possible too)</li>
1223   <li>Alexander Kirillov's page on <a
1224     href="http://www.math.sunysb.edu/~kirillov/dbxml/">Using DocBook XML
1225     4.1.2</a> (RPM packages)</li>
1226   <li>Tim Waugh's <a href="http://cyberelk.net/tim/xmlto/">xmlto front-end
1227     conversion script</a></li>
1228   <li>Linux Documentation Project <a
1229     href="http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/">
1230     DocBook-Install-mini-HOWTO</a></li>
1231   <li>ScrollKeeper the open documentation cataloging project has a <a
1232     href="http://scrollkeeper.sourceforge.net/docbook.shtml">DocBook
1233     section</a></li>
1234   <li>Dan York presentation on <a
1235     href="http://www.lodestar2.com/people/dyork/talks/2001/xugo/docbook/index.html">Publishing
1236     using DocBook XML</a></li>
1237 </ul>
1238
1239 <p>Do not use the --docbook option of xsltproc to process XML DocBook
1240 documents, this option is only intended to provide some (limited) support of
1241 the SGML version of DocBook.</p>
1242
1243 <p>Points which are not DocBook specific but still worth mentionning
1244 again:</p>
1245 <ul>
1246   <li>if you think DocBook processing time is too slow, make sure you have
1247     XML Catalogs pointing to a local installation of the DTD of DocBook.
1248     Check the <a href="http://xmlsoft.org/catalog.html">XML Catalog page</a>
1249     to understand more on this subject.</li>
1250   <li>before processing a new document, use the command
1251     <p><code>xmllint --valid --noout path_to_document</code></p>
1252     <p>to make sure that your input is valid DocBook. And fixes the errors
1253     before processing further. Note that XSLT processing may work correctly
1254     with some forms of validity errors left, but in general it can give
1255     troubles on output.</p>
1256   </li>
1257 </ul>
1258
1259 <h2><a name="API">The programming API</a></h2>
1260
1261 <p>Okay this section is clearly incomplete. But integrating libxslt into your
1262 application should be relatively easy. First check the few steps described
1263 below, then for more detailed information, look at the<a
1264 href="html/libxslt-lib.html"> generated pages</a> for the API and the source
1265 of libxslt/xsltproc.c  and the  <a
1266 href="tutorial/libxslttutorial.html">tutorial</a>.</p>
1267
1268 <p>Basically doing an XSLT transformation can be done in a few steps:</p>
1269 <ol>
1270   <li>configure the parser for XSLT:
1271     <p>xmlSubstituteEntitiesDefault(1);</p>
1272     <p>xmlLoadExtDtdDefaultValue = 1;</p>
1273   </li>
1274   <li>parse the stylesheet with xsltParseStylesheetFile()</li>
1275   <li>parse the document with xmlParseFile()</li>
1276   <li>apply the stylesheet using xsltApplyStylesheet()</li>
1277   <li>save the result using xsltSaveResultToFile() if needed set
1278     xmlIndentTreeOutput to 1</li>
1279 </ol>
1280
1281 <p>Steps 2,3, and 5 will probably need to be changed depending on you
1282 processing needs and environment for example if reading/saving from/to
1283 memory, or if you want to apply XInclude processing to the stylesheet or
1284 input documents.</p>
1285
1286 <h2><a name="Python">Python and bindings</a></h2>
1287
1288 <p>There is a number of language bindings and wrappers available for libxml2,
1289 the list below is not exhaustive. Please contact the <a
1290 href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
1291 (<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
1292 order to get updates to this list or to discuss the specific topic of libxml2
1293 or libxslt wrappers or bindings:</p>
1294 <ul>
1295   <li><a
1296     href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
1297     Sergeant</a> developped <a href="http://axkit.org/download/">XML::LibXML
1298     and XML::LibXSLT</a>, Perl wrappers for libxml2/libxslt as part of the <a
1299     href="http://axkit.com/">AxKit XML application server</a></li>
1300   <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides and
1301     earlier version of the libxml/libxslt <a
1302     href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
1303   <li>Petr Kozelka provides <a
1304     href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
1305     libxml2</a> with Kylix, Delphi and other Pascal compilers</li>
1306   <li>Wai-Sun "Squidster" Chia provides <a
1307     href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a>  and
1308     libxml2 bindings are also available in Ruby through the <a
1309     href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
1310     maintained by Tobias Peters.</li>
1311   <li>Steve Ball and contributors maintains <a
1312     href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
1313     Tcl</a></li>
1314   <li><a href="mailto:xmlwrapp@pmade.org">Peter Jones</a> maintains C++
1315     bindings for libxslt within <a
1316     href="http://pmade.org/pjones/software/xmlwrapp/">xmlwrapp</a></li>
1317   <li><a href="phillim2@comcast.net">Mike Phillips</a> provides a module
1318     using <a href="http://siasl.dyndns.org/projects/projects.html">libxslt
1319     for PHP</a>.</li>
1320   <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
1321     an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
1322     libxslt as part of GNU ClasspathX project.</li>
1323   <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
1324     <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
1325   <li><a
1326     href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
1327     provides <a
1328     href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
1329     osax</a>. This is an osax for Mac OS X with a set of commands to
1330     implement in AppleScript the XML DOM, XPATH and XSLT.</li>
1331 </ul>
1332
1333 <p>The libxslt Python module depends on the <a
1334 href="http://xmlsoft.org/python.html">libxml2 Python</a> module.</p>
1335
1336 <p>The distribution includes a set of Python bindings, which are guaranteed to
1337 be maintained as part of the library in the future, though the Python
1338 interface have not yet reached the completeness of the C API.</p>
1339
1340 <p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
1341 maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
1342 of the Python bindings</a>.</p>
1343
1344 <p>Note to people interested in building bindings, the API is formalized as
1345 <a href="libxslt-api.xml">an XML API description file</a> which allows to
1346 automate a large part of the Python bindings, this includes function
1347 descriptions, enums, structures, typedefs, etc... The Python script used to
1348 build the bindings is python/generator.py in the source distribution.</p>
1349
1350 <p>To install the Python bindings there are 2 options:</p>
1351 <ul>
1352   <li>If you use an RPM based distribution, simply install the <a
1353     href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
1354     RPM</a> and the <a
1355     href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
1356     RPM</a>.</li>
1357   <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
1358     module distribution</a> corresponding to your installed version of
1359     libxml2 and libxslt. Note that to install it you will need both libxml2
1360     and libxslt installed and run "python setup.py build install" in the
1361     module tree.</li>
1362 </ul>
1363
1364 <p>The distribution includes a set of examples and regression tests for the
1365 python bindings in the <code>python/tests</code> directory. Here are some
1366 excepts from those tests:</p>
1367
1368 <h3>basic.py:</h3>
1369
1370 <p>This is a basic test of XSLT interfaces: loading a stylesheet and a
1371 document, transforming the document and saving the result.</p>
1372 <pre>import libxml2
1373 import libxslt
1374
1375 styledoc = libxml2.parseFile("test.xsl")
1376 style = libxslt.parseStylesheetDoc(styledoc)
1377 doc = libxml2.parseFile("test.xml")
1378 result = style.applyStylesheet(doc, None)
1379 style.saveResultToFilename("foo", result, 0)
1380 style.freeStylesheet()
1381 doc.freeDoc()
1382 result.freeDoc()</pre>
1383
1384 <p>The Python module is called libxslt, you will also need the libxml2 module
1385 for the operations on XML trees. Let's have a look at the objects manipulated
1386 in that example and how is the processing done:</p>
1387 <ul>
1388   <li><code>styledoc</code> : is a libxml2 document tree. It is obtained by
1389     parsing the XML file "test.xsl" containing the stylesheet.</li>
1390   <li><code>style</code> : this is a precompiled stylesheet ready to be used
1391     by the following transformations (note the plural form, multiple
1392     transformations can resuse the same stylesheet).</li>
1393   <li><code>doc</code> : this is the document to apply the transformation to.
1394     In this case it is simply generated by parsing it from a file but any
1395     other processing is possible as long as one get a libxml2 Doc. Note that
1396     HTML tree are suitable for XSLT processing in libxslt. This is actually
1397     how this page is generated !</li>
1398   <li><code>result</code> : this is a document generated by applying the
1399     stylesheet to the document. Note that some of the stylesheet information
1400     may be related to the serialization of that document and as in this
1401     example a specific saveResultToFilename() method of the stylesheet should
1402     be used to save it to a file (in that case to "foo").</li>
1403 </ul>
1404
1405 <p>Also note the need to explicitely deallocate documents with freeDoc()
1406 except for the stylesheet document which is freed when its compiled form is
1407 garbage collected.</p>
1408
1409 <h3>extfunc.py:</h3>
1410
1411 <p>This one is a far more complex test. It shows how to modify the behaviour
1412 of an XSLT transformation by passing parameters and how to extend the XSLT
1413 engine with functions defined in python:</p>
1414 <pre>import libxml2
1415 import libxslt
1416 import string
1417
1418 nodeName = None
1419 def f(ctx, str):
1420     global nodeName
1421
1422     #
1423     # Small check to verify the context is correcly accessed
1424     #
1425     try:
1426         pctxt = libxslt.xpathParserContext(_obj=ctx)
1427         ctxt = pctxt.context()
1428         tctxt = ctxt.transformContext()
1429         nodeName = tctxt.insertNode().name
1430     except:
1431         pass
1432
1433     return string.upper(str)
1434
1435 libxslt.registerExtModuleFunction("foo", "http://example.com/foo", f)</pre>
1436
1437 <p>This code defines and register an extension function. Note that the
1438 function can be bound to any name (foo) and how the binding is also
1439 associated to a namespace name "http://example.com/foo". From an XSLT point
1440 of view the function just returns an upper case version of the string passed
1441 as a parameter. But the first part of the function also read some contextual
1442 information from the current XSLT processing environement, in that case it
1443 looks for the current insertion node in the resulting output (either the
1444 resulting document or the Result Value Tree being generated), and saves it to
1445 a global variable for checking that the access actually worked.</p>
1446
1447 <p>For more information on the xpathParserContext and transformContext
1448 objects check the <a href="internals.html">libray internals description</a>.
1449 The pctxt is actually an object from a class derived from the
1450 libxml2.xpathParserContext() with just a couple more properties including the
1451 possibility to look up the XSLT transformation context from the XPath
1452 context.</p>
1453 <pre>styledoc = libxml2.parseDoc("""
1454 &lt;xsl:stylesheet version='1.0'
1455   xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
1456   xmlns:foo='http://example.com/foo'
1457   xsl:exclude-result-prefixes='foo'&gt;
1458
1459   &lt;xsl:param name='bar'&gt;failure&lt;/xsl:param&gt;
1460   &lt;xsl:template match='/'&gt;
1461     &lt;article&gt;&lt;xsl:value-of select='foo:foo($bar)'/&gt;&lt;/article&gt;
1462   &lt;/xsl:template&gt;
1463 &lt;/xsl:stylesheet&gt;
1464 """)</pre>
1465
1466 <p>Here is a simple example of how to read an XML document from a python
1467 string with libxml2. Note how this stylesheet:</p>
1468 <ul>
1469   <li>Uses a global parameter <code>bar</code></li>
1470   <li>Reference the extension function f</li>
1471   <li>how the Namespace name "http://example.com/foo" has to be bound to a
1472     prefix</li>
1473   <li>how that prefix is excluded from the output</li>
1474   <li>how the function is called from the select</li>
1475 </ul>
1476 <pre>style = libxslt.parseStylesheetDoc(styledoc)
1477 doc = libxml2.parseDoc("&lt;doc/&gt;")
1478 result = style.applyStylesheet(doc, { "bar": "'success'" })
1479 style.freeStylesheet()
1480 doc.freeDoc()</pre>
1481
1482 <p>that part is identical, to the basic example except that the
1483 transformation is passed a dictionary of parameters. Note that the string
1484 passed "success" had to be quoted, otherwise it is interpreted as an XPath
1485 query for the childs of root named "success".</p>
1486 <pre>root = result.children
1487 if root.name != "article":
1488     print "Unexpected root node name"
1489     sys.exit(1)
1490 if root.content != "SUCCESS":
1491     print "Unexpected root node content, extension function failed"
1492     sys.exit(1)
1493 if nodeName != 'article':
1494     print "The function callback failed to access its context"
1495     sys.exit(1)
1496
1497 result.freeDoc()</pre>
1498
1499 <p>That part just verifies that the transformation worked, that the parameter
1500 got properly passed to the engine, that the function f() got called and that
1501 it properly accessed the context to find the name of the insertion node.</p>
1502
1503 <h3>pyxsltproc.py:</h3>
1504
1505 <p>this module is a bit too long to be described there but it is basically a
1506 rewrite of the xsltproc command line interface of libxslt in Python. It
1507 provides nearly all the functionalities of xsltproc and can be used as a base
1508 module to write Python customized XSLT processors. One of the thing to notice
1509 are:</p>
1510 <pre>libxml2.lineNumbersDefault(1)
1511 libxml2.substituteEntitiesDefault(1)</pre>
1512
1513 <p>those two calls in the main() function are needed to force the libxml2
1514 processor to generate DOM trees compliant with the XPath data model.</p>
1515
1516 <h2><a name="Internals">Library internals</a></h2>
1517
1518 <h3>Table  of contents</h3>
1519 <ul>
1520   <li><a href="internals.html#Introducti">Introduction</a></li>
1521   <li><a href="internals.html#Basics">Basics</a></li>
1522   <li><a href="internals.html#Keep">Keep it simple stupid</a></li>
1523   <li><a href="internals.html#libxml">The libxml nodes</a></li>
1524   <li><a href="internals.html#XSLT">The XSLT processing steps</a></li>
1525   <li><a href="internals.html#XSLT1">The XSLT stylesheet compilation</a></li>
1526   <li><a href="internals.html#XSLT2">The XSLT template compilation</a></li>
1527   <li><a href="internals.html#processing">The processing itself</a></li>
1528   <li><a href="internals.html#XPath">XPath expressions compilation</a></li>
1529   <li><a href="internals.html#XPath1">XPath interpretation</a></li>
1530   <li><a href="internals.html#Descriptio">Description of XPath
1531   Objects</a></li>
1532   <li><a href="internals.html#XPath3">XPath functions</a></li>
1533   <li><a href="internals.html#stack">The variables stack frame</a></li>
1534   <li><a href="internals.html#Extension">Extension support</a></li>
1535   <li><a href="internals.html#Futher">Further reading</a></li>
1536   <li><a href="internals.html#TODOs">TODOs</a></li>
1537 </ul>
1538
1539 <h3><a name="Introducti2">Introduction</a></h3>
1540
1541 <p>This document describes the processing of <a
1542 href="http://xmlsoft.org/XSLT/">libxslt</a>, the <a
1543 href="http://www.w3.org/TR/xslt">XSLT</a> C library developed for the <a
1544 href="http://www.gnome.org/">GNOME</a> project.</p>
1545
1546 <p>Note: this documentation is by definition incomplete and I am not good at
1547 spelling, grammar, so patches and suggestions are <a
1548 href="mailto:veillard@redhat.com">really welcome</a>.</p>
1549
1550 <h3><a name="Basics1">Basics</a></h3>
1551
1552 <p>XSLT is a transformation language. It takes an input document and a
1553 stylesheet document and generates an output document:</p>
1554
1555 <p align="center"><img src="processing.gif"
1556 alt="the XSLT processing model"></p>
1557
1558 <p>Libxslt is written in C. It relies on <a
1559 href="http://www.xmlsoft.org/">libxml</a>, the XML C library for GNOME, for
1560 the following operations:</p>
1561 <ul>
1562   <li>parsing files</li>
1563   <li>building the in-memory DOM structure associated with the documents
1564     handled</li>
1565   <li>the XPath implementation</li>
1566   <li>serializing back the result document to XML and HTML. (Text is handled
1567     directly.)</li>
1568 </ul>
1569
1570 <h3><a name="Keep1">Keep it simple stupid</a></h3>
1571
1572 <p>Libxslt is not very specialized. It is built under the assumption that all
1573 nodes from the source and output document can fit in the virtual memory of
1574 the system. There is a big trade-off there. It is fine for reasonably sized
1575 documents but may not be suitable for large sets of data. The gain is that it
1576 can be used in a relatively versatile way. The input or output may never be
1577 serialized, but the size of documents it can handle are limited by the size
1578 of the memory available.</p>
1579
1580 <p>More specialized memory handling approaches are possible, like building
1581 the input tree from a serialization progressively as it is consumed,
1582 factoring repetitive patterns, or even on-the-fly generation of the output as
1583 the input is parsed but it is possible only for a limited subset of the
1584 stylesheets. In general the implementation of libxslt follows the following
1585 pattern:</p>
1586 <ul>
1587   <li>KISS (keep it simple stupid)</li>
1588   <li>when there is a clear bottleneck optimize on top of this simple
1589     framework and refine only as much as is needed to reach the expected
1590     result</li>
1591 </ul>
1592
1593 <p>The result is not that bad, clearly one can do a better job but more
1594 specialized too. Most optimization like building the tree on-demand would
1595 need serious changes to the libxml XPath framework. An easy step would be to
1596 serialize the output directly (or call a set of SAX-like output handler to
1597 keep this a flexible interface) and hence avoid the memory consumption of the
1598 result.</p>
1599
1600 <h3><a name="libxml">The libxml nodes</a></h3>
1601
1602 <p>DOM-like trees, as used and generated by libxml and libxslt, are
1603 relatively complex. Most node types follow the given structure except a few
1604 variations depending on the node type:</p>
1605
1606 <p align="center"><img src="node.gif" alt="description of a libxml node"></p>
1607
1608 <p>Nodes carry a <strong>name</strong> and the node <strong>type</strong>
1609 indicates the kind of node it represents, the most common ones are:</p>
1610 <ul>
1611   <li>document nodes</li>
1612   <li>element nodes</li>
1613   <li>text nodes</li>
1614 </ul>
1615
1616 <p>For the XSLT processing, entity nodes should not be generated (i.e. they
1617 should be replaced by their content). Most nodes also contains the following
1618 "navigation" information:</p>
1619 <ul>
1620   <li>the containing <strong>doc</strong>ument</li>
1621   <li>the <strong>parent</strong> node</li>
1622   <li>the first <strong>children</strong> node</li>
1623   <li>the <strong>last</strong> children node</li>
1624   <li>the <strong>prev</strong>ious sibling</li>
1625   <li>the following sibling (<strong>next</strong>)</li>
1626 </ul>
1627
1628 <p>Elements nodes carries the list of attributes in the properties, an
1629 attribute itself holds the navigation pointers and the children list (the
1630 attribute value is not represented as a simple string to allow usage of
1631 entities references).</p>
1632
1633 <p>The <strong>ns</strong> points to the namespace declaration for the
1634 namespace associated to the node, <strong>nsDef</strong> is the linked list
1635 of namespace declaration present on element nodes.</p>
1636
1637 <p>Most nodes also carry an <strong>_private</strong> pointer which can be
1638 used by the application to hold specific data on this node.</p>
1639
1640 <h3><a name="XSLT">The XSLT processing steps</a></h3>
1641
1642 <p>There are a few steps which are clearly decoupled at the interface
1643 level:</p>
1644 <ol>
1645   <li>parse the stylesheet and generate a DOM tree</li>
1646   <li>take the stylesheet tree and build a compiled version of it (the
1647     compilation phase)</li>
1648   <li>take the input and generate a DOM tree</li>
1649   <li>process the stylesheet against the input tree and generate an output
1650     tree</li>
1651   <li>serialize the output tree</li>
1652 </ol>
1653
1654 <p>A few things should be noted here:</p>
1655 <ul>
1656   <li>the steps 1/ 3/ and 5/ are optional</li>
1657   <li>the stylesheet obtained at 2/ can be reused by multiple processing 4/
1658     (and this should also work in threaded programs)</li>
1659   <li>the tree provided in 2/ should never be freed using xmlFreeDoc, but by
1660     freeing the stylesheet.</li>
1661   <li>the input tree 4/ is not modified except the _private field which may
1662     be used for labelling keys if used by the stylesheet</li>
1663 </ul>
1664
1665 <h3><a name="XSLT1">The XSLT stylesheet compilation</a></h3>
1666
1667 <p>This is the second step described. It takes a stylesheet tree, and
1668 "compiles" it. This associates to each node a structure stored in the
1669 _private field and containing information computed in the stylesheet:</p>
1670
1671 <p align="center"><img src="stylesheet.gif"
1672 alt="a compiled XSLT stylesheet"></p>
1673
1674 <p>One xsltStylesheet structure is generated per document parsed for the
1675 stylesheet. XSLT documents allow includes and imports of other documents,
1676 imports are stored in the <strong>imports</strong> list (hence keeping the
1677 tree hierarchy of includes which is very important for a proper XSLT
1678 processing model) and includes are stored in the <strong>doclist</strong>
1679 list. An imported stylesheet has a parent link to allow browsing of the
1680 tree.</p>
1681
1682 <p>The DOM tree associated to the document is stored in <strong>doc</strong>.
1683 It is preprocessed to remove ignorable empty nodes and all the nodes in the
1684 XSLT namespace are subject to precomputing. This usually consist of
1685 extracting all the context information from the context tree (attributes,
1686 namespaces, XPath expressions), and storing them in an xsltStylePreComp
1687 structure associated to the <strong>_private</strong> field of the node.</p>
1688
1689 <p>A couple of notable exceptions to this are XSLT template nodes (more on
1690 this later) and attribute value templates. If they are actually templates,
1691 the value cannot be computed at compilation time. (Some preprocessing could
1692 be done like isolation and preparsing of the XPath subexpressions but it's
1693 not done, yet.)</p>
1694
1695 <p>The xsltStylePreComp structure also allows storing of the precompiled form
1696 of an XPath expression that can be associated to an XSLT element (more on
1697 this later).</p>
1698
1699 <h3><a name="XSLT2">The XSLT template compilation</a></h3>
1700
1701 <p>A proper handling of templates lookup is one of the keys of fast XSLT
1702 processing. (Given a node in the source document this is the process of
1703 finding which templates should be applied to this node.) Libxslt follows the
1704 hint suggested in the <a href="http://www.w3.org/TR/xslt#patterns">5.2
1705 Patterns</a> section of the XSLT Recommendation, i.e. it doesn't evaluate it
1706 as an XPath expression but tokenizes it and compiles it as a set of rules to
1707 be evaluated on a candidate node. There usually is an indication of the node
1708 name in the last step of this evaluation and this is used as a key check for
1709 the match. As a result libxslt builds a relatively more complex set of
1710 structures for the templates:</p>
1711
1712 <p align="center"><img src="templates.gif"
1713 alt="The templates related structure"></p>
1714
1715 <p>Let's describe a bit more closely what is built. First the xsltStylesheet
1716 structure holds a pointer to the template hash table. All the XSLT patterns
1717 compiled in this stylesheet are indexed by the value of the the target
1718 element (or attribute, pi ...) name, so when a element or an attribute "foo"
1719 needs to be processed the lookup is done using the name as a key.</p>
1720
1721 <p>Each of the patterns is compiled into an xsltCompMatch structure. It holds
1722 the set of rules based on the tokenization of the pattern stored in reverse
1723 order (matching is easier this way). It also holds some information about the
1724 previous matches used to speed up the process when one iterates over a set of
1725 siblings. (This optimization may be defeated by trashing when running
1726 threaded computation, it's unclear that this is a big deal in practice.)
1727 Predicate expressions are not compiled at this stage, they may be at run-time
1728 if needed, but in this case they are compiled as full XPath expressions (the
1729 use of some fixed predicate can probably be optimized, they are not yet).</p>
1730
1731 <p>The xsltCompMatch are then stored in the hash table, the clash list is
1732 itself sorted by priority of the template to implement "naturally" the XSLT
1733 priority rules.</p>
1734
1735 <p>Associated to the compiled pattern is the xsltTemplate itself containing
1736 the information required for the processing of the pattern including, of
1737 course, a pointer to the list of elements used for building the pattern
1738 result.</p>
1739
1740 <p>Last but not least a number of patterns do not fit in the hash table
1741 because they are not associated to a name, this is the case for patterns
1742 applying to the root, any element, any attributes, text nodes, pi nodes, keys
1743 etc. Those are stored independently in the stylesheet structure as separate
1744 linked lists of xsltCompMatch.</p>
1745
1746 <h3><a name="processing">The processing itself</a></h3>
1747
1748 <p>The processing is defined by the XSLT specification (the basis of the
1749 algorithm is explained in <a
1750 href="http://www.w3.org/TR/xslt#section-Introduction">the Introduction</a>
1751 section). Basically it works by taking the root of the input document and
1752 applying the following algorithm:</p>
1753 <ol>
1754   <li>Finding the template applying to it. This is a lookup in the template
1755     hash table, walking the hash list until the node satisfies all the steps
1756     of the pattern, then checking the appropriate(s) global templates to see
1757     if there isn't a higher priority rule to apply</li>
1758   <li>If there is no template, apply the default rule (recurse on the
1759     children)</li>
1760   <li>else walk the content list of the selected templates, for each of them:
1761     <ul>
1762       <li>if the node is in the XSLT namespace then the node has a _private
1763         field pointing to the preprocessed values, jump to the specific
1764       code</li>
1765       <li>if the node is in an extension namespace, look up the associated
1766         behavior</li>
1767       <li>otherwise copy the node.</li>
1768     </ul>
1769     <p>The closure is usually done through the XSLT
1770     <strong>apply-templates</strong> construct recursing by applying the
1771     adequate template on the input node children or on the result of an
1772     associated XPath selection lookup.</p>
1773   </li>
1774 </ol>
1775
1776 <p>Note that large parts of the input tree may not be processed by a given
1777 stylesheet and that on the opposite some may be processed multiple times.
1778 (This often is the case when a Table of Contents is built).</p>
1779
1780 <p>The module <code>transform.c</code> is the one implementing most of this
1781 logic. <strong>xsltApplyStylesheet()</strong> is the entry point, it
1782 allocates an xsltTransformContext containing the following:</p>
1783 <ul>
1784   <li>a pointer to the stylesheet being processed</li>
1785   <li>a stack of templates</li>
1786   <li>a stack of variables and parameters</li>
1787   <li>an XPath context</li>
1788   <li>the template mode</li>
1789   <li>current document</li>
1790   <li>current input node</li>
1791   <li>current selected node list</li>
1792   <li>the current insertion points in the output document</li>
1793   <li>a couple of hash tables for extension elements and functions</li>
1794 </ul>
1795
1796 <p>Then a new document gets allocated (HTML or XML depending on the type of
1797 output), the user parameters and global variables and parameters are
1798 evaluated. Then <strong>xsltProcessOneNode()</strong> which implements the
1799 1-2-3 algorithm is called on the root element of the input. Step 1/ is
1800 implemented by calling <strong>xsltGetTemplate()</strong>, step 2/ is
1801 implemented by <strong>xsltDefaultProcessOneNode()</strong> and step 3/ is
1802 implemented by <strong>xsltApplyOneTemplate()</strong>.</p>
1803
1804 <h3><a name="XPath">XPath expression compilation</a></h3>
1805
1806 <p>The XPath support is actually implemented in the libxml module (where it
1807 is reused by the XPointer implementation). XPath is a relatively classic
1808 expression language. The only uncommon feature is that it is working on XML
1809 trees and hence has specific syntax and types to handle them.</p>
1810
1811 <p>XPath expressions are compiled using <strong>xmlXPathCompile()</strong>.
1812 It will take an expression string in input and generate a structure
1813 containing the parsed expression tree, for example the expression:</p>
1814 <pre>/doc/chapter[title='Introduction']</pre>
1815
1816 <p>will be compiled as</p>
1817 <pre>Compiled Expression : 10 elements
1818   SORT
1819     COLLECT  'child' 'name' 'node' chapter
1820       COLLECT  'child' 'name' 'node' doc
1821         ROOT
1822       PREDICATE
1823         SORT
1824           EQUAL =
1825             COLLECT  'child' 'name' 'node' title
1826               NODE
1827             ELEM Object is a string : Introduction
1828               COLLECT  'child' 'name' 'node' title
1829                 NODE</pre>
1830
1831 <p>This can be tested using the  <code>testXPath</code>  command (in the
1832 libxml codebase) using the <code>--tree</code> option.</p>
1833
1834 <p>Again, the KISS approach is used. No optimization is done. This could be
1835 an interesting thing to add. <a
1836 href="http://www-106.ibm.com/developerworks/library/x-xslt2/?dwzone=x?open&amp;l=132%2ct=gr%2c+p=saxon">Michael
1837 Kay describes</a> a lot of possible and interesting optimizations done in
1838 Saxon which would be possible at this level. I'm unsure they would provide
1839 much gain since the expressions tends to be relatively simple in general and
1840 stylesheets are still hand generated. Optimizations at the interpretation
1841 sounds likely to be more efficient.</p>
1842
1843 <h3><a name="XPath1">XPath interpretation</a></h3>
1844
1845 <p>The interpreter is implemented by <strong>xmlXPathCompiledEval()</strong>
1846 which is the front-end to <strong>xmlXPathCompOpEval()</strong> the function
1847 implementing the evaluation of the expression tree. This evaluation follows
1848 the KISS approach again. It's recursive and calls
1849 <strong>xmlXPathNodeCollectAndTest()</strong> to collect nodes set when
1850 evaluating a <code>COLLECT</code> node.</p>
1851
1852 <p>An evaluation is done within the framework of an XPath context stored in
1853 an <strong>xmlXPathContext</strong> structure, in the framework of a
1854 transformation the context is maintained within the XSLT context. Its content
1855 follows the requirements from the XPath specification:</p>
1856 <ul>
1857   <li>the current document</li>
1858   <li>the current node</li>
1859   <li>a hash table of defined variables (but not used by XSLT)</li>
1860   <li>a hash table of defined functions</li>
1861   <li>the proximity position (the place of the node in the current node
1862   list)</li>
1863   <li>the context size (the size of the current node list)</li>
1864   <li>the array of namespace declarations in scope (there also is a namespace
1865     hash table but it is not used in the XSLT transformation).</li>
1866 </ul>
1867
1868 <p>For the purpose of XSLT an <strong>extra</strong> pointer has been added
1869 allowing to retrieve the XSLT transformation context. When an XPath
1870 evaluation is about to be performed, an XPath parser context is allocated
1871 containing and XPath object stack (this is actually an XPath evaluation
1872 context, this is a remain of the time where there was no separate parsing and
1873 evaluation phase in the XPath implementation). Here is an overview of the set
1874 of contexts associated to an XPath evaluation within an XSLT
1875 transformation:</p>
1876
1877 <p align="center"><img src="contexts.gif"
1878 alt="The set of contexts associated "></p>
1879
1880 <p>Clearly this is a bit too complex and confusing and should be refactored
1881 at the next set of binary incompatible releases of libxml. For example the
1882 xmlXPathCtxt has a lot of unused parts and should probably be merged with
1883 xmlXPathParserCtxt.</p>
1884
1885 <h3><a name="Descriptio">Description of XPath Objects</a></h3>
1886
1887 <p>An XPath expression manipulates XPath objects. XPath defines the default
1888 types boolean, numbers, strings and node sets. XSLT adds the result tree
1889 fragment type which is basically an unmodifiable node set.</p>
1890
1891 <p>Implementation-wise, libxml follows again a KISS approach, the
1892 xmlXPathObject is a structure containing a type description and the various
1893 possibilities. (Using an enum could have gained some bytes.) In the case of
1894 node sets (or result tree fragments), it points to a separate xmlNodeSet
1895 object which contains the list of pointers to the document nodes:</p>
1896
1897 <p align="center"><img src="object.gif"
1898 alt="An Node set object pointing to "></p>
1899
1900 <p>The <a href="http://xmlsoft.org/html/libxml-xpath.html">XPath API</a> (and
1901 its <a href="http://xmlsoft.org/html/libxml-xpathinternals.html">'internal'
1902 part</a>) includes a number of functions to create, copy, compare, convert or
1903 free XPath objects.</p>
1904
1905 <h3><a name="XPath3">XPath functions</a></h3>
1906
1907 <p>All the XPath functions available to the interpreter are registered in the
1908 function hash table linked from the XPath context. They all share the same
1909 signature:</p>
1910 <pre>void xmlXPathFunc (xmlXPathParserContextPtr ctxt, int nargs);</pre>
1911
1912 <p>The first argument is the XPath interpretation context, holding the
1913 interpretation stack. The second argument defines the number of objects
1914 passed on the stack for the function to consume (last argument is on top of
1915 the stack).</p>
1916
1917 <p>Basically an XPath function does the following:</p>
1918 <ul>
1919   <li>check <code>nargs</code> for proper handling of errors or functions
1920     with variable numbers of parameters</li>
1921   <li>pop the parameters from the stack using <code>obj =
1922     valuePop(ctxt);</code></li>
1923   <li>do the function specific computation</li>
1924   <li>push the result parameter on the stack using <code>valuePush(ctxt,
1925     res);</code></li>
1926   <li>free up the input parameters with
1927   <code>xmlXPathFreeObject(obj);</code></li>
1928   <li>return</li>
1929 </ul>
1930
1931 <p>Sometime the work can be done directly by modifying in-situ the top object
1932 on the stack <code>ctxt-&gt;value</code>.</p>
1933
1934 <h3><a name="stack">The XSLT variables stack frame</a></h3>
1935
1936 <p>Not to be confused with XPath object stack, this stack holds the XSLT
1937 variables and parameters as they are defined through the recursive calls of
1938 call-template, apply-templates and default templates. This is used to define
1939 the scope of variables being called.</p>
1940
1941 <p>This part seems to be the most urgent attention right now, first it is
1942 done in a very inefficient way since the location of the variables and
1943 parameters within the stylesheet tree is still done at run time (it really
1944 should be done statically at compile time), and I am still unsure that my
1945 understanding of the template variables and parameter scope is actually
1946 right.</p>
1947
1948 <p>This part of the documentation is still to be written once this part of
1949 the code will be stable. <span
1950 style="background-color: #FF0000">TODO</span></p>
1951
1952 <h3><a name="Extension">Extension support</a></h3>
1953
1954 <p>There is a separate document explaining <a href="extensions.html">how the
1955 extension support works</a>.</p>
1956
1957 <h3><a name="Futher">Further reading</a></h3>
1958
1959 <p>Michael Kay wrote <a
1960 href="http://www-106.ibm.com/developerworks/library/x-xslt2/?dwzone=x?open&amp;l=132%2ct=gr%2c+p=saxon">a
1961 really interesting article on Saxon internals</a> and the work he did on
1962 performance issues. I wishes I had read it before starting libxslt design (I
1963 would probably have avoided a few mistakes and progressed faster). A lot of
1964 the ideas in his papers should be implemented or at least tried in
1965 libxslt.</p>
1966
1967 <p>The <a href="http://xmlsoft.org/">libxml documentation</a>, especially <a
1968 href="http://xmlsoft.org/xmlio.html">the I/O interfaces</a> and the <a
1969 href="http://xmlsoft.org/xmlmem.html">memory management</a>.</p>
1970
1971 <h3><a name="TODOs">TODOs</a></h3>
1972
1973 <p>redesign the XSLT stack frame handling. Far too much work is done at
1974 execution time. Similarly for the attribute value templates handling, at
1975 least the embedded subexpressions ought to be precompiled.</p>
1976
1977 <p>Allow output to be saved to a SAX like output (this notion of SAX like API
1978 for output should be added directly to libxml).</p>
1979
1980 <p>Implement and test some of the optimization explained by Michael Kay
1981 especially:</p>
1982 <ul>
1983   <li>static slot allocation on the stack frame</li>
1984   <li>specific boolean interpretation of an XPath expression</li>
1985   <li>some of the sorting optimization</li>
1986   <li>Lazy evaluation of location path. (this may require more changes but
1987     sounds really interesting. XT does this too.)</li>
1988   <li>Optimization of an expression tree (This could be done as a completely
1989     independent module.)</li>
1990 </ul>
1991
1992 <p></p>
1993
1994 <p>Error reporting, there is a lot of case where the XSLT specification
1995 specify that a given construct is an error are not checked adequately by
1996 libxslt. Basically one should do a complete pass on the XSLT spec again and
1997 add all tests to the stylesheet compilation. Using the DTD provided in the
1998 appendix and making direct checks using the libxml validation API sounds a
1999 good idea too (though one should take care of not raising errors for
2000 elements/attributes in different namespaces).</p>
2001
2002 <p>Double check all the places where the stylesheet compiled form might be
2003 modified at run time (extra removal of blanks nodes, hint on the
2004 xsltCompMatch).</p>
2005
2006 <p></p>
2007
2008 <h2><a name="Extensions">Writing extensions</a></h2>
2009
2010 <h3>Table  of content</h3>
2011 <ul>
2012   <li><a href="extensions.html#Introducti">Introduction</a></li>
2013   <li><a href="extensions.html#Basics">Basics</a></li>
2014   <li><a href="extensions.html#Keep">Extension modules</a></li>
2015   <li><a href="extensions.html#Registerin">Registering a module</a></li>
2016   <li><a href="extensions.html#module">Loading a module</a></li>
2017   <li><a href="extensions.html#Registerin1">Registering an extension
2018     function</a></li>
2019   <li><a href="extensions.html#Implementi">Implementing an extension
2020     function</a></li>
2021   <li><a href="extensions.html#Examples">Examples for extension
2022   functions</a></li>
2023   <li><a href="extensions.html#Registerin2">Registering an extension
2024     element</a></li>
2025   <li><a href="extensions.html#Implementi1">Implementing an extension
2026     element</a></li>
2027   <li><a href="extensions.html#Example">Example for extension
2028   elements</a></li>
2029   <li><a href="extensions.html#shutdown">The shutdown of a module</a></li>
2030   <li><a href="extensions.html#Future">Future work</a></li>
2031 </ul>
2032
2033 <h3><a name="Introducti1">Introduction</a></h3>
2034
2035 <p>This document describes the work needed to write extensions to the
2036 standard XSLT library for use with <a
2037 href="http://xmlsoft.org/XSLT/">libxslt</a>, the <a
2038 href="http://www.w3.org/TR/xslt">XSLT</a> C library developed for the <a
2039 href="http://www.gnome.org/">GNOME</a> project.</p>
2040
2041 <p>Before starting reading this document it is highly recommended to get
2042 familiar with <a href="internals.html">the libxslt internals</a>.</p>
2043
2044 <p>Note: this documentation is by definition incomplete and I am not good at
2045 spelling, grammar, so patches and suggestions are <a
2046 href="mailto:veillard@redhat.com">really welcome</a>.</p>
2047
2048 <h3><a name="Basics">Basics</a></h3>
2049
2050 <p>The <a href="http://www.w3.org/TR/xslt">XSLT specification</a> provides
2051 two <a href="http://www.w3.org/TR/xslt">ways to extend an XSLT engine</a>:</p>
2052 <ul>
2053   <li>providing <a href="http://www.w3.org/TR/xslt">new extension
2054     functions</a> which can be called from XPath expressions</li>
2055   <li>providing <a href="http://www.w3.org/TR/xslt">new extension
2056     elements</a> which can be inserted in stylesheets</li>
2057 </ul>
2058
2059 <p>In both cases the extensions need to be associated to a new namespace,
2060 i.e. an URI used as the name for the extension's namespace (there is no need
2061 to have a resource there for this to work).</p>
2062
2063 <p>libxslt provides a few extensions itself, either in the libxslt namespace
2064 "http://xmlsoft.org/XSLT/namespace" or in namespaces for other well known
2065 extensions provided by other XSLT processors like Saxon, Xalan or XT.</p>
2066
2067 <h3><a name="Keep">Extension modules</a></h3>
2068
2069 <p>Since extensions are bound to a namespace name, usually sets of extensions
2070 coming from a given source are using the same namespace name defining in
2071 practice a group of extensions providing elements, functions or both. From
2072 the libxslt point of view those are considered as an "extension module", and
2073 most of the APIs work at a module point of view.</p>
2074
2075 <p>Registration of new functions or elements are bound to the activation of
2076 the module. This is currently done by declaring the namespace as an extension
2077 by using the attribute  <code>extension-element-prefixes</code> on the
2078 <code><a href="http://www.w3.org/TR/xslt">xsl:stylesheet</a></code>
2079 element.</p>
2080
2081 <p>An extension module is defined by 3 objects:</p>
2082 <ul>
2083   <li>the namespace name associated</li>
2084   <li>an initialization function</li>
2085   <li>a shutdown function</li>
2086 </ul>
2087
2088 <h3><a name="Registerin">Registering a module</a></h3>
2089
2090 <p>Currently a libxslt module has to be compiled within the application using
2091 libxslt. There is no code to load dynamically shared libraries associated to
2092 a namespace (this may be added but is likely to become a portability
2093 nightmare).</p>
2094
2095 <p>The current way to register a module is to link the code implementing it
2096 with the application and to call a registration function:</p>
2097 <pre>int xsltRegisterExtModule(const xmlChar *URI,
2098                           xsltExtInitFunction initFunc,
2099                           xsltExtShutdownFunction shutdownFunc);</pre>
2100
2101 <p>The associated header is read by:</p>
2102 <pre>#include&lt;libxslt/extensions.h&gt;</pre>
2103
2104 <p>which also defines the type for the initialization and shutdown
2105 functions</p>
2106
2107 <h3><a name="module">Loading a module</a></h3>
2108
2109 <p>Once the module URI has been registered and if the XSLT processor detects
2110 that a given stylesheet needs the functionalities of an extended module, this
2111 one is initialized.</p>
2112
2113 <p>The xsltExtInitFunction type defines the interface for an initialization
2114 function:</p>
2115 <pre>/**
2116  * xsltExtInitFunction:
2117  * @ctxt:  an XSLT transformation context
2118  * @URI:  the namespace URI for the extension
2119  *
2120  * A function called at initialization time of an XSLT
2121  * extension module
2122  *
2123  * Returns a pointer to the module specific data for this
2124  * transformation
2125  */
2126 typedef void *(*xsltExtInitFunction)(xsltTransformContextPtr ctxt,
2127                                      const xmlChar *URI);</pre>
2128
2129 <p>There are 3 things to notice:</p>
2130 <ul>
2131   <li>The function gets passed the namespace name URI as an argument. This
2132     allows a single function to provide the initialization for multiple
2133     logical modules.</li>
2134   <li>It also gets passed a transformation context. The initialization is
2135     done at run time before any processing occurs on the stylesheet but it
2136     will be invoked separately each time for each transformation.</li>
2137   <li>It returns a pointer.  This can be used to store module specific
2138     information which can be retrieved later when a function or an element
2139     from the extension is used.  An obvious example is a connection to a
2140     database which should be kept and reused along with the transformation.
2141     NULL is a perfectly valid return; there is no way to indicate a failure
2142     at this level</li>
2143 </ul>
2144
2145 <p>What this function is expected to do is:</p>
2146 <ul>
2147   <li>prepare the context for this module (like opening the database
2148     connection)</li>
2149   <li>register the extensions specific to this module</li>
2150 </ul>
2151
2152 <h3><a name="Registerin1">Registering an extension function</a></h3>
2153
2154 <p>There is a single call to do this registration:</p>
2155 <pre>int xsltRegisterExtFunction(xsltTransformContextPtr ctxt,
2156                             const xmlChar *name,
2157                             const xmlChar *URI,
2158                             xmlXPathEvalFunc function);</pre>
2159
2160 <p>The registration is bound to a single transformation instance referred by
2161 ctxt, name is the UTF8 encoded name for the NCName of the function, and URI
2162 is the namespace name for the extension (no checking is done, a module could
2163 register functions or elements from a different namespace, but it is not
2164 recommended).</p>
2165
2166 <h3><a name="Implementi">Implementing an extension function</a></h3>
2167
2168 <p>The implementation of the function must have the signature of a libxml
2169 XPath function:</p>
2170 <pre>/**
2171  * xmlXPathEvalFunc:
2172  * @ctxt: an XPath parser context
2173  * @nargs: the number of arguments passed to the function
2174  *
2175  * an XPath evaluation function, the parameters are on the
2176  * XPath context stack
2177  */
2178
2179 typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt,
2180                                  int nargs);</pre>
2181
2182 <p>The context passed to an XPath function is not an XSLT context but an <a
2183 href="internals.html#XPath1">XPath context</a>. However it is possible to
2184 find one from the other:</p>
2185 <ul>
2186   <li>The function xsltXPathGetTransformContext provides this lookup facility:
2187     <pre>xsltTransformContextPtr
2188          xsltXPathGetTransformContext
2189                           (xmlXPathParserContextPtr ctxt);</pre>
2190   </li>
2191   <li>The <code>xmlXPathContextPtr</code> associated to an
2192     <code>xsltTransformContext</code> is stored in the <code>xpathCtxt</code>
2193     field.</li>
2194 </ul>
2195
2196 <p>The first thing an extension function may want to do is to check the
2197 arguments passed on the stack, the <code>nargs</code> parameter will tell how
2198 many of them were provided on the XPath expression. The macro valuePop will
2199 extract them from the XPath stack:</p>
2200 <pre>#include &lt;libxml/xpath.h&gt;
2201 #include &lt;libxml/xpathInternals.h&gt;
2202
2203 xmlXPathObjectPtr obj = valuePop(ctxt); </pre>
2204
2205 <p>Note that <code>ctxt</code> is the XPath context not the XSLT one. It is
2206 then possible to examine the content of the value. Check <a
2207 href="internals.html#Descriptio">the description of XPath objects</a> if
2208 necessary. The following is a common sequence checking whether the argument
2209 passed is a string and converting it using the built-in XPath
2210 <code>string()</code> function if this is not the case:</p>
2211 <pre>if (obj-&gt;type != XPATH_STRING) {
2212     valuePush(ctxt, obj);
2213     xmlXPathStringFunction(ctxt, 1);
2214     obj = valuePop(ctxt);
2215 }</pre>
2216
2217 <p>Most common XPath functions are available directly at the C level and are
2218 exported either in <code>&lt;libxml/xpath.h&gt;</code> or in
2219 <code>&lt;libxml/xpathInternals.h&gt;</code>.</p>
2220
2221 <p>The extension function may also need to retrieve the data associated to
2222 this module instance (the database connection in the previous example) this
2223 can be done using the xsltGetExtData:</p>
2224 <pre>void * xsltGetExtData(xsltTransformContextPtr ctxt,
2225                       const xmlChar *URI);</pre>
2226
2227 <p>Again the URI to be provided is the one which was used when registering
2228 the module.</p>
2229
2230 <p>Once the function finishes, don't forget to:</p>
2231 <ul>
2232   <li>push the return value on the stack using <code>valuePush(ctxt,
2233     obj)</code></li>
2234   <li>deallocate the parameters passed to the function using
2235     <code>xmlXPathFreeObject(obj)</code></li>
2236 </ul>
2237
2238 <h3><a name="Examples">Examples for extension functions</a></h3>
2239
2240 <p>The module libxslt/functions.c contains the sources of the XSLT built-in
2241 functions, including document(), key(), generate-id(), etc. as well as a full
2242 example module at the end. Here is the test function implementation for the
2243 libxslt:test function:</p>
2244 <pre>/**
2245  * xsltExtFunctionTest:
2246  * @ctxt:  the XPath Parser context
2247  * @nargs:  the number of arguments
2248  *
2249  * function libxslt:test() for testing the extensions support.
2250  */
2251 static void
2252 xsltExtFunctionTest(xmlXPathParserContextPtr ctxt, int nargs)
2253 {
2254     xsltTransformContextPtr tctxt;
2255     void *data;
2256
2257     tctxt = xsltXPathGetTransformContext(ctxt);
2258     if (tctxt == NULL) {
2259         xsltGenericError(xsltGenericErrorContext,
2260             "xsltExtFunctionTest: failed to get the transformation context\n");
2261         return;
2262     }
2263     data = xsltGetExtData(tctxt, (const xmlChar *) XSLT_DEFAULT_URL);
2264     if (data == NULL) {
2265         xsltGenericError(xsltGenericErrorContext,
2266             "xsltExtFunctionTest: failed to get module data\n");
2267         return;
2268     }
2269 #ifdef WITH_XSLT_DEBUG_FUNCTION
2270     xsltGenericDebug(xsltGenericDebugContext,
2271                      "libxslt:test() called with %d args\n", nargs);
2272 #endif
2273 }</pre>
2274
2275 <h3><a name="Registerin2">Registering an extension element</a></h3>
2276
2277 <p>There is a single call to do this registration:</p>
2278 <pre>int xsltRegisterExtElement(xsltTransformContextPtr ctxt,
2279                            const xmlChar *name,
2280                            const xmlChar *URI,
2281                            xsltTransformFunction function);</pre>
2282
2283 <p>It is similar to the mechanism used to register an extension function,
2284 except that the signature of an extension element implementation is
2285 different.</p>
2286
2287 <p>The registration is bound to a single transformation instance referred to
2288 by ctxt, name is the UTF8 encoded name for the NCName of the element, and URI
2289 is the namespace name for the extension (no checking is done, a module could
2290 register elements for a different namespace, but it is not recommended).</p>
2291
2292 <h3><a name="Implementi1">Implementing an extension element</a></h3>
2293
2294 <p>The implementation of the element must have the signature of an XSLT
2295 transformation function:</p>
2296 <pre>/**
2297  * xsltTransformFunction:
2298  * @ctxt: the XSLT transformation context
2299  * @node: the input node
2300  * @inst: the stylesheet node
2301  * @comp: the compiled information from the stylesheet
2302  *
2303  * signature of the function associated to elements part of the
2304  * stylesheet language like xsl:if or xsl:apply-templates.
2305  */
2306 typedef void (*xsltTransformFunction)
2307                           (xsltTransformContextPtr ctxt,
2308                            xmlNodePtr node,
2309                            xmlNodePtr inst,
2310                            xsltStylePreCompPtr comp);</pre>
2311
2312 <p>The first argument is the XSLT transformation context. The second and
2313 third arguments are xmlNodePtr i.e. internal memory <a
2314 href="internals.html#libxml">representation of  XML nodes</a>. They are
2315 respectively <code>node</code> from the the input document being transformed
2316 by the stylesheet and <code>inst</code> the extension element in the
2317 stylesheet. The last argument is <code>comp</code> a pointer to a precompiled
2318 representation of <code>inst</code> but usually for an extension function
2319 this value is <code>NULL</code> by default (it could be added and associated
2320 to the instruction in <code>inst-&gt;_private</code>).</p>
2321
2322 <p>The same functions are available from a function implementing an extension
2323 element as in an extension function, including
2324 <code>xsltGetExtData()</code>.</p>
2325
2326 <p>The goal of an extension element being usually to enrich the generated
2327 output, it is expected that they will grow the currently generated output
2328 tree. This can be done by grabbing ctxt-&gt;insert which is the current
2329 libxml node being generated (Note this can also be the intermediate value
2330 tree being built for example to initialize a variable, the processing should
2331 be similar). The functions for libxml tree manipulation from <a
2332 href="http://xmlsoft.org/html/libxml-tree.html">&lt;libxml/tree.h&gt;</a> can
2333 be employed to extend or modify the tree, but it is required to preserve the
2334 insertion node and its ancestors since there are existing pointers to those
2335 elements still in use in the XSLT template execution stack.</p>
2336
2337 <h3><a name="Example">Example for extension elements</a></h3>
2338
2339 <p>The module libxslt/transform.c contains the sources of the XSLT built-in
2340 elements, including xsl:element, xsl:attribute, xsl:if, etc. There is a small
2341 but full example in functions.c providing the implementation for the
2342 libxslt:test element, it will output a comment in the result tree:</p>
2343 <pre>/**
2344  * xsltExtElementTest:
2345  * @ctxt:  an XSLT processing context
2346  * @node:  The current node
2347  * @inst:  the instruction in the stylesheet
2348  * @comp:  precomputed information
2349  *
2350  * Process a libxslt:test node
2351  */
2352 static void
2353 xsltExtElementTest(xsltTransformContextPtr ctxt, xmlNodePtr node,
2354                    xmlNodePtr inst,
2355                    xsltStylePreCompPtr comp)
2356 {
2357     xmlNodePtr comment;
2358
2359     if (ctxt == NULL) {
2360         xsltGenericError(xsltGenericErrorContext,
2361                          "xsltExtElementTest: no transformation context\n");
2362         return;
2363     }
2364     if (node == NULL) {
2365         xsltGenericError(xsltGenericErrorContext,
2366                          "xsltExtElementTest: no current node\n");
2367         return;
2368     }
2369     if (inst == NULL) {
2370         xsltGenericError(xsltGenericErrorContext,
2371                          "xsltExtElementTest: no instruction\n");
2372         return;
2373     }
2374     if (ctxt-&gt;insert == NULL) {
2375         xsltGenericError(xsltGenericErrorContext,
2376                          "xsltExtElementTest: no insertion point\n");
2377         return;
2378     }
2379     comment =
2380         xmlNewComment((const xmlChar *)
2381                       "libxslt:test element test worked");
2382     xmlAddChild(ctxt-&gt;insert, comment);
2383 }</pre>
2384
2385 <h3><a name="shutdown">The shutdown of a module</a></h3>
2386
2387 <p>When the XSLT processor ends a transformation, the shutdown function (if
2388 it exists) for each of the modules initialized is called.  The
2389 xsltExtShutdownFunction type defines the interface for a shutdown
2390 function:</p>
2391 <pre>/**
2392  * xsltExtShutdownFunction:
2393  * @ctxt:  an XSLT transformation context
2394  * @URI:  the namespace URI for the extension
2395  * @data:  the data associated to this module
2396  *
2397  * A function called at shutdown time of an XSLT extension module
2398  */
2399 typedef void (*xsltExtShutdownFunction) (xsltTransformContextPtr ctxt,
2400                                          const xmlChar *URI,
2401                                          void *data);</pre>
2402
2403 <p>This is really similar to a module initialization function except a third
2404 argument is passed, it's the value that was returned by the initialization
2405 function. This allows the routine to deallocate resources from the module for
2406 example close the connection to the database to keep the same example.</p>
2407
2408 <h3><a name="Future">Future work</a></h3>
2409
2410 <p>Well, some of the pieces missing:</p>
2411 <ul>
2412   <li>a way to load shared libraries to instantiate new modules</li>
2413   <li>a better detection of extension functions usage and their registration
2414     without having to use the extension prefix which ought to be reserved to
2415     element extensions.</li>
2416   <li>more examples</li>
2417   <li>implementations of the <a href="http://www.exslt.org/">EXSLT</a> common
2418     extension libraries, Thomas Broyer nearly finished implementing them.</li>
2419 </ul>
2420
2421 <p></p>
2422
2423 <h2><a name="Contributi">Contributions</a></h2>
2424 <ul>
2425   <li>Bjorn Reese is the author of the number support and worked on the
2426     XSLTMark support</li>
2427   <li>William Brack was an early adopted, contributed a number of patches and
2428     spent quite some time debugging non-trivial problems in early versions of
2429     libxslt</li>
2430   <li><a href="mailto:igor@zlatkovic.com">Igor  Zlatkovic</a> is now the
2431     maintainer of the Windows port, <a
2432     href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
2433     binaries</a></li>
2434   <li>Thomas Broyer provided a lot of suggestions, and drafted most of the
2435     extension API</li>
2436   <li>John Fleck maintains <a href="tutorial/libxslttutorial.html">a tutorial
2437     for libxslt</a></li>
2438   <li><a
2439     href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
2440     Sergeant</a> developed <a
2441     href="http://axkit.org/download/">XML::LibXSLT</a>, a perl wrapper for
2442     libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
2443     application server</a></li>
2444   <li>there is a module for <a
2445     href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
2446     in OpenNSD/AOLServer</a></li>
2447   <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides
2448     libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for
2449     Python</a></li>
2450   <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a>, and
2451     contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
2452     bindings for libxml2 and libxslt</a>, as well as <a
2453     href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
2454     xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
2455     a GUI for xsltproc.</li>
2456   <li>If you want to use libxslt in a Mac OS X/Cocoa or Objective-C
2457     framework, Marc Liyanage provides <a
2458     href="http://www.entropy.ch/software/macosx/#testxslt">an application
2459     TestXSLT for XSLT and XML editing</a> including wrapper classes for the
2460     XML parser and XSLT processor.</li>
2461 </ul>
2462
2463 <p></p>
2464
2465 <p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
2466 </body>
2467 </html>