Updated the on-line documentation, Daniel
[platform/upstream/libxslt.git] / doc / API.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2 <html>
3 <head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
5 <style type="text/css"><!--
6 TD {font-size: 10pt; font-family: Verdana,Arial,Helvetica}
7 BODY {font-size: 10pt; font-family: Verdana,Arial,Helvetica; margin-top: 5pt; margin-left: 0pt; margin-right: 0pt}
8 H1 {font-size: 16pt; font-family: Verdana,Arial,Helvetica}
9 H2 {font-size: 14pt; font-family: Verdana,Arial,Helvetica}
10 H3 {font-size: 12pt; font-family: Verdana,Arial,Helvetica}
11 A:link, A:visited, A:active { text-decoration: underline }
12 --></style>
13 <title>The programming API</title>
14 </head>
15 <body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
16 <table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
17 <td width="100">
18 <a href="http://www.gnome.org/"><img src="smallfootonly.gif" alt="Gnome Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif" alt="Red Hat Logo"></a>
19 </td>
20 <td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
21 <h1>The XSLT C library for Gnome</h1>
22 <h2>The programming API</h2>
23 </td></tr></table></td></tr></table></td>
24 </tr></table>
25 <table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
26 <td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
27 <table width="100%" border="0" cellspacing="1" cellpadding="3">
28 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
29 <tr><td bgcolor="#fffacd"><ul style="margin-left: -2pt">
30 <li><a href="index.html">Home</a></li>
31 <li><a href="intro.html">Introduction</a></li>
32 <li><a href="docs.html">Documentation</a></li>
33 <li><a href="bugs.html">Reporting bugs and getting help</a></li>
34 <li><a href="help.html">How to help</a></li>
35 <li><a href="downloads.html">Downloads</a></li>
36 <li><a href="news.html">News</a></li>
37 <li><a href="xsltproc2.html">The xsltproc tool</a></li>
38 <li><a href="API.html">The programming API</a></li>
39 <li><a href="internals.html">Library internals</a></li>
40 <li><a href="extensions.html">Writing extensions</a></li>
41 <li><a href="contribs.html">Contributions</a></li>
42 <li>
43 <a href="xslt.html">flat page</a>, <a href="site.xsl">stylesheet</a>
44 </li>
45 </ul></td></tr>
46 </table>
47 <table width="100%" border="0" cellspacing="1" cellpadding="3">
48 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
49 <tr><td bgcolor="#fffacd"><ul style="margin-left: -2pt">
50 <li><a href="tutorial/libxslttutorial.html">Tutorial</a></li>
51 <li><a href="xsltproc.html">Man page for xsltproc</a></li>
52 <li><a href="http://mail.gnome.org/archives/xslt/">Mail archive</a></li>
53 <li><a href="http://xmlsoft.org/">XML libxml</a></li>
54 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">DOM gdome2</a></li>
55 <li><a href="ftp://xmlsoft.org/">FTP</a></li>
56 <li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
57 <li><a href="http://pages.eidosnet.co.uk/~garypen/libxml/">Solaris binaries</a></li>
58 <li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">Bug Tracker</a></li>
59 <li><a href="http://xsldbg.sourceforge.net/">Xsldbg Debugger</a></li>
60 </ul></td></tr>
61 </table>
62 </td></tr></table></td>
63 <td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
64 <p>Okay this section is clearly incomplete. But integrating libxslt into your
65 application should be relatively easy. First check the few steps described
66 below, then for more detailed informations, look at the<a href="html/libxslt-lib.html"> generated pages</a> for the API and the source
67 of libxslt/xsltproc.c  and the  <a href="tutorial/libxslttutorial.html">tutorial</a>.</p>
68 <p>Basically doing an XSLT transformation can be done in a few steps:</p>
69 <ol>
70 <li>configure the parser for XSLT:
71     <p>xmlSubstituteEntitiesDefault(1);</p>
72 <p>xmlLoadExtDtdDefaultValue = 1;</p>
73 </li>
74 <li>parse the stylesheet with xsltParseStylesheetFile()</li>
75 <li>parse the document with xmlParseFile()</li>
76 <li>apply the stylesheet using xsltApplyStylesheet()</li>
77 <li>save the result using xsltSaveResultToFile() if needed set
78     xmlIndentTreeOutput to 1</li>
79 </ol>
80 <p>Steps 2,3, and 5 will probably need to be changed depending on you
81 processing needs and environment for example if reading/saving from/to
82 memory, or if you want to apply XInclude processing to the stylesheet or
83 input documents.</p>
84 <p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
85 </td></tr></table></td></tr></table></td></tr></table></td>
86 </tr></table></td></tr></table>
87 </body>
88 </html>