dleslie 00/10/12 08:34:20
Modified: java/xdocs/sources/xalan commandline.xml extensions.xml
getstarted.xml index.xml overview.xml readme.xml
samples.xml STATUS usagepatterns.xml whatsnew.xml
Log:
doc updates for xalan-j 2.
Revision Changes Path
1.3 +4 -2 xml-xalan/java/xdocs/sources/xalan/commandline.xml
Index: commandline.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/commandline.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- commandline.xml 2000/09/12 21:41:09 1.2
+++ commandline.xml 2000/10/12 15:34:17 1.3
@@ -70,7 +70,8 @@
<ol>
<li>Download &xslt4j;.<br/><br/></li>
<li><link idref="getstarted" anchor="classpath">Set the java class
path</link> to include xalan.jar and
- xerces.jar<br/><br/></li>
+ xerces.jar (or another conformat XMLReader -- see <link
idref="usagepatterns" anchor="xmlreader">Setting the
+ XMLReader</link>).<br/><br/></li>
<li>Call java and the Process class with the appropriate flags and
arguments (described below). The following command line, for example,
includes the -IN, -XSL,
and -OUT flags with their accompanying arguments -- the XML source
document, the XSL
@@ -98,7 +99,8 @@
-XML (Use XML formatter and add XML header)
-TEXT (Use simple Text formatter)
-HTML (Use HTML formatter)
--PARAM name expression (Set a stylesheet parameter)</source>
+-PARAM name expression (Set a stylesheet parameter)
+-DIAG put out timing diagnostics</source>
<p>Use -IN to specify the XML source document.</p>
<p>Use -XSL to specify the XSL stylesheet file.</p>
<p>Use -LXCIN to specify a compiled XSL stylesheet file.</p>
1.4 +3 -71 xml-xalan/java/xdocs/sources/xalan/extensions.xml
Index: extensions.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/extensions.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- extensions.xml 2000/09/25 21:16:29 1.3
+++ extensions.xml 2000/10/12 15:34:17 1.4
@@ -16,10 +16,10 @@
<li><link anchor="ext-elements">Using an extension element</link></li>
<li><link anchor="ext-functions">Using extension functions</link></li>
<li><link anchor="java-namespace">Alternative: using the predefined java
extension namespace</link></li>
-<li>Examples: <link anchor="ex-basic">basic JavaScript example</link>, <link
anchor="ex-redirect">the Redirect extension</link>, <link
anchor="ex-java-namespace">using the java namespace</link>, <link
anchor="ex-java">using a Java Hashtable</link>, <link
anchor="ex-javascript">using a JavaScript array</link></li>
+<li>Examples: <link anchor="ex-basic">basic JavaScript example</link>, <link
anchor="ex-java-namespace">using the java namespace</link>, <link
anchor="ex-java">using a Java Hashtable</link>, <link
anchor="ex-javascript">using a JavaScript array</link></li>
</ul><anchor name="intro"/>
<s2 title="Introduction">
- <p>For those situations where you would like to augment the functionality
of XSLT with calls to a procedural language, &xslt4j; supports the creation and
use of extension elements and extension functions. An extension (a collection
of elements and functions) inhabits a namespace, either a namespace you declare
and designate as an extensions namespace, or the predefined java namespace that
&xslt4j; provides. For information about XML namespaces, see <jump
href="http://www.w3.org/TR/REC-xml-names/";>Namespaces in XML</jump>.</p>
+ <p>For those situations where you would like to augment the functionality
of XSLT with calls to a procedural language, &xslt4j; supports the creation and
use of extension elements and extension functions. &xslt4j; also provides a
growing <link idref="extensionslib">extensions library</link> available for
your use. An extension (a collection of elements and functions) inhabits a
namespace, either a namespace you declare and designate as an extensions
namespace, or the predefined java namespace that &xslt4j; provides. For
information about XML namespaces, see <jump
href="http://www.w3.org/TR/REC-xml-names/";>Namespaces in XML</jump>.</p>
<p><em>Extension elements</em> Unlike a literal result element, which the
stylesheet simply transfers to the result tree, an extension element performs
an action. For example, you can use the Redirect extension elements shipped
with &xslt4j; to redirect portions of your transformation output to one or more
files. Extension elements may contain attributes, text nodes, other elements,
basically any valid XML. Extension elements may perform quite sophisticated
actions, given that the extension routine (the implementation) has direct
access to the XSL processor context object and to the element. In many cases
the implementation returns void or null; if it does return a value, that value
is placed in the transformation result tree.</p>
@@ -227,77 +227,9 @@
<code> (org.apache.xalan.xslt.XSLProcessorContext,
</code><br/>
<code> org.w3c.dom.Element
extensionElement)</code></p>
<p>JavaScript example: <code>function myElement(xslProcContext,
element)</code></p>
+<p>The <link idref="extensionslib" anchor="redirect">Redirect
extension</link>in the extensions library contains three extension elements.</p>
</s3>
-<s3 title="The Redirect extension">
-<p>The Redirect extension (<jump href =
"apidocs/org/apache/xalan/xslt/extensions/Redirect.html">org.apache.xalan.xslt.extensions.Redirect</jump>)
is shipped with &xslt4j; (more extensions are on the way!).</p>
-<p>A standard XSL transformation involves three parameters: the XML source
tree, an XSL stylesheet, and the transformation result tree. Whether the result
tree is output to a file, a character stream, a byte stream, a DOM, or a SAX
document handler, the initial transformation sends the entire result to a
single target, represented by the <resource-ref
idref="XSLTResultTargetDoc"/>.</p>
-<p>The Redirect extension supplies three extension elements that you can use
to redirect portions of your transformation output to multiple files:
<open>, <write>, and <close>. If you use the <write>
element alone, the extension opens a file, writes to it, and closes the file
immediately. If you want explicit control over the opening and closing of
files, use <write> in conjunction with the <open> and <close>
elements.</p>
-<p>Each of these elements includes a file attribute and/or a select
attribute to designate the output file. The file attribute takes a string, so
you can use it to directly specify the output file name; The select attribute
takes an XPath expression, so you can use it to dynamically generate the output
file name. If you include both attributes, the Redirect extension first
evaluates the select attribute, and falls back to the file attribute if the
select attribute expression does not return a valid file name.</p>
-</s3><anchor name="ex-redirect"/>
-<s3 title="Example with the Redirect extension">
-<p>Suppose you are outputting the bulk of your result tree to one file, but
you want to output the transformation of all <foo> elements and their
children to another file. The following example illustrates the basic structure
of the XML source:</p>
-<source><?xml version="1.0"?>
-<doc>
- <foo file="foo.out">
- Testing Redirect extension:
- <bar>A foo subelement text node</bar>
- </foo>
- <main>
- Everything else
- </main>
-</doc></source>
-<p>This stylesheet redirects part of the output to a secondary file:</p>
-<source>
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
- version="1.0"
- xmlns:lxslt="http://xml.apache.org/xslt";
- xmlns:redirect="org.apache.xalan.xslt.extensions.Redirect"
- extension-element-prefixes="redirect">
- <xsl:template match="/">
- <standard-out>
- Standard output:
- <xsl:apply-templates/>
- </standard-out>
- </xsl:template>
-
- <xsl:template match="main">
- <main>
- <xsl:apply-templates/>
- </main>
- </xsl:template>
-
- <xsl:template match="/doc/foo">
- <redirect:write select="@file">
- <foo-out>
- <xsl:apply-templates/>
- </foo-out>
- </redirect:write>
- </xsl:template>
-
- <xsl:template match="bar">
- <foobar-out>
- <xsl:apply-templates/>
- </foobar-out>
- </xsl:template>
-
-</xsl:stylesheet></source>
-<p>The standard output is:</p>
-<source><?xml version="1.0" encoding="UTF-8"?>
-<standard-out>
- Standard output:
- <main>
- Everything else.
- </main>
-<standard-out></source>
-<p>The output redirected to foo.out is:</p>
-<source><?xml version="1.0" encoding="UTF-8"?>
-<foo-out>
- Testing Redirect extension:
- <foobar-out>foo subelement text node</foobar-out>
- </foo-out></source>
-<p>For more information on using the Redirect extension to send output to
multiple files, examine the <link idref="samples"
anchor="ext1">SimpleRedirect</link> sample and see the <jump
href="apidocs/org/apache/xalan/lib/Redirect.html">Redirect</jump>class
Javadoc.</p>
-</s3>
</s2><anchor name="ext-functions"/>
<s2 title="Using extension functions">
<p>Extension functions may include arguments of any type and return a value
of any type.</p>
1.3 +2 -2 xml-xalan/java/xdocs/sources/xalan/getstarted.xml
Index: getstarted.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/getstarted.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- getstarted.xml 2000/09/25 21:16:29 1.2
+++ getstarted.xml 2000/10/12 15:34:17 1.3
@@ -23,7 +23,7 @@
<p>If you plan to run <link idref="extensions">XSLT extensions</link>, you
need bsf.jar, which is included in the &xslt4j; distribution. If you plan to
run XSLT extensions implemented in JavaScript or another scripting language,
you will need one or more additional files as indicated in <link
idref="extensions" anchor="supported-lang">extensions language
requirements</link>.</p>
</s2><anchor name="classpath"/>
<s2 title="Setting up the system class path">
-<p>At the very minimum, you must include xalan.jar and xerces.jar on the
system class path. To run the sample applications, include xalansamples.jar
(all samples other than the servlet) and xalanservlet.jar. To run extensions,
include bsf.jar. All these JAR files are distributed with &xslt4j;. For
extensions implemented in JavaScript or another scripting language, see <link
idref="extensions" anchor="supported-lang">extensions language
requirements</link> to identify any additional JAR files you must place on the
class path and where you can get them.</p>
+<p>At the very minimum, you must include xalan.jar and xerces.jar (or
another conformant XMLReader -- see <link idref="usagepatterns"
anchor="xmlreader">Setting the XMLReader</link>) on the system class path. To
run the sample applications, include xalansamples.jar (all samples other than
the servlet) and xalanservlet.jar. To run extensions, include bsf.jar. All
these JAR files are distributed with &xslt4j;. For extensions implemented in
JavaScript or another scripting language, see <link idref="extensions"
anchor="supported-lang">extensions language requirements</link> to identify any
additional JAR files you must place on the class path and where you can get
them.</p>
<p>If you are using JDK or JRE 1.1.8, also include classes.zip on the class
path.</p>
</s2><anchor name="samples"/>
<s2 title="Trying out the samples">
@@ -42,7 +42,7 @@
<p>The extensions examples require additional JAR files on the class path,
and the procedure for running the sample applet and sample servlet is
different. For more information about all the samples, see <link
idref="samples">&xslt4j; Samples</link>.</p>
</s2><anchor name="commandline"/>
<s2 title="Performing your own transformations from the command line">
-<p>java.org.apache.xalan.xslt.Process provides a basic utility for
performing transformations from the command line. You use this utility, for
example, to run the extensions samples. The command line for most standard
transformations is as follows:</p>
+<p>java.org.apache.xalan.xslt.Process provides a basic utility for
performing transformations from the command line. You use this utility, for
example, to run several of the extensions samples. The command line for most
standard transformations is as follows:</p>
<p><code>java org.apache.xalan.xslt.Process -in
<ref>xmlSource</ref></code><br/>
<code> -xsl <ref>stylesheet</ref> -out
<ref>outputfile</ref></code></p>
<p>where <ref>xmlSource</ref> is the XML source file name,
<ref>stylesheet</ref> is the XSL stylesheet file name, and
<ref>outputfile</ref> is the output file name.</p>
1.2 +5 -3 xml-xalan/java/xdocs/sources/xalan/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2000/09/15 19:03:20 1.1
+++ index.xml 2000/10/12 15:34:17 1.2
@@ -67,13 +67,13 @@
modular framework and a standard API for performing an open-ended range
of XML transformations.</p>
<p>In conjunction with TRaX, &xslt4j2; relies on system properties to
configure its operational settings, such as
which stylesheet processor, which SAX parser, and which serializers to
use. The default settings point to the Xalan
- StylesheetProcessor, the Xerces SAXParser, and the serializers shipped
with Xerces.</p>
+ StylesheetProcessor, the serializers shipped with Xalan, and the Xerces
SAXParser.</p>
<p>&xslt4j; version 2 also builds on <resource-ref idref="sax2"/>,
<resource-ref idref="dom2"/>, and the
<resource-ref idref="jaxp"/>.</p>
<p>For more information, see <link idref="whatsnew">What's new in
&xslt4j2;</link>.</p>
</s2>
<s2 title="How about this release?">
- <p>&xslt4j-current; is the first release of &xslt4j2;. It is an alpha
Develper's release. For information about known
+ <p>&xslt4j-current; is the first release of &xslt4j2;. It is an alpha
Developer's release. For information about known
limitations and problems, see the <link idref="readme">Release
notes</link>. Please send your comments, bug reports, and
feeback to the <human-resource-ref idref="xalandev"/></p>
</s2>
@@ -86,8 +86,10 @@
</s2>
<s2 title="Where do I get Xerces?">
- <p>The Xalan download includes xerces.jar from &xml4j-used;. This is all
you need to run Xalan.
+ <p>The Xalan download includes xerces.jar from &xml4j-used;. This is all
you need to run Xalan with the Xerces XML parser.
You can, however, download the complete Xerces distribution from the
<resource-ref idref="xml4j-distdir"/>.</p>
+ <note>If you plan to use a different XML parser, see <link
idref="usagepatterns" anchor="xmlreader">Setting the
+ XMLReader</link>.</note>
</s2>
<s2 title="What else do I need?">
<p>You need the Java Development Kit or Java Runtime 1.1.8 or 1.2.2,
which you can obtain from <jump
1.3 +17 -17 xml-xalan/java/xdocs/sources/xalan/overview.xml
Index: overview.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/overview.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- overview.xml 2000/09/29 15:46:21 1.2
+++ overview.xml 2000/10/12 15:34:17 1.3
@@ -99,20 +99,23 @@
</s2><anchor name="features"/>
<s2 title="&xslt4j; Features">
<ul>
- <li>Implements the <resource-ref idref="xslt"/> and the
<resource-ref idref="xpath"/><br/><br/></li>
+ <li>Implements the <resource-ref idref="xslt"/> and the
<resource-ref idref="xpath"/>.<br/><br/></li>
<li>Builds on <resource-ref idref="trax"/>, <resource-ref
idref="sax2"/>, <resource-ref idref="dom2"/>,
- and the <resource-ref idref="jaxp"/><br/><br/></li>
- <li>Works by default with the <jump
href="http://xml.apache.org/xerces-j/index.html";>&xml4j; SAXParser</jump>, and
may
- be configured to work with any conformant SAX or DOM
parser<br/><br/></li>
- <li>Can process SAX or DOM input, and output to SAX or
DOM<br/><br/></li>
- <li>Transformations may be chained (the output of one transformation
may be the input for another)<br/><br/></li>
+ and the <resource-ref idref="jaxp"/>.<br/><br/></li>
+ <li>May be configured to work with any XMLReader, such as the
+ <jump href="http://xml.apache.org/xerces-j/index.html";>&xml4j;
SAXParser</jump>, that implements the
+ Java API for XML Parsing (see <link idref="usagepatterns"
anchor="xmlreader">Setting the
+ XMLReader</link>).<br/><br/></li>
+ <li>Can process SAX or DOM input, and output to SAX or
DOM.<br/><br/></li>
+ <li>Transformations may be chained (the output of one transformation
may be the input for
+ another).<br/><br/></li>
<li>May be run from the <link idref="commandline">command
line</link> for convenient file-to-file
- transformations<br/><br/></li>
- <li>Includes an <link idref="getstarted" anchor="applet">applet
wrapper</link><br/><br/></li>
- <li>May be used in a <link idref="samples"
anchor="servlet">servlet</link> to transform XML documents into HTML
- and serve the results to clients<br/><br/></li>
- <li>Supports the creation of <link idref="extensions">Java and
scripting language extensions</link> and provides
- a growing library of extension elements and functions</li>
+ transformations.<br/><br/></li>
+ <li>Includes an <link idref="getstarted" anchor="applet">applet
wrapper</link>.<br/><br/></li>
+ <li>May be used in a <link idref="samples"
anchor="servlet">servlet</link> to transform XML documents into
+ HTML and serve the results to clients.<br/><br/></li>
+ <li>Supports the creation of <link idref="extensions">Java and
scripting language extensions</link> and
+ provides a growing library of extension elements and functions.</li>
</ul>
</s2><anchor name="towork"/>
<s2 title="Getting to work with &xslt4j;">
@@ -151,7 +154,7 @@
Anders Møller and Michael I. Schwartzbach</li>
</ul>
<p>When you come across other useful introductory or background
materials, please email <human-resource-ref
- idref="dleslie"/>, so he can add them to this list.</p>
+ idref="xalandev"/>, so we can add them to this list.</p>
</s2><anchor name="glossary"/>
<s2 title="Glossary">
@@ -179,10 +182,7 @@
<label>Result Tree</label>
<item>The tree that is output by the XSL process.<br/><br/></item>
-
- <label>Stylesheet Tree</label>
- <item>The stylesheet tree produced from the XSL
file.<br/><br/></item>
-
+
<label>Match Pattern</label>
<item>The part of a template that defines the kind(s) of nodes to
which the template applies.<br/><br/></item>
1.3 +28 -39 xml-xalan/java/xdocs/sources/xalan/readme.xml
Index: readme.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/readme.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- readme.xml 2000/09/19 12:52:37 1.2
+++ readme.xml 2000/10/12 15:34:17 1.3
@@ -127,31 +127,12 @@
in the source tree for doc and Javadoc builds</td></tr>
</table>
<p>If you build a target that depends on other targets, Ant creates those
other targets in the correct order.</p>
- <p><em>Other build tools</em></p>
- <p>The distribution also includes makefiles that you can use with the GNU
development tools. And of course you can also use
- the underlying utilities to compile source files, create JAR files,
generate Javadoc, and generate the HTML User's Guide. One
- utility that you may not be familiar with is
org.apache.stylebook.StyleBook (in stylebook-1.0-b2.jar), a tool from the
- xml-stylebook module that we use along with Xalan and Xerces to help
generate the documentation. For the details, you can
- inspect the makefiles.</p>
-
</s3><anchor name="jar"/>
<s3 title="Rebuilding &xslt4j;">
<p>The &xslt4j; build is in xalan.jar. The &xslt4j; source code tree is
in the src directory.</p>
<p>If you are using Ant, the target is jar (the default). For more
information, see <link anchor="ant">Using
Ant</link>.</p>
- <p>To use GNU development tools, do the following:</p>
- <ol>
- <li>Set up GNU or the equivalent build environment on your
workstation.<br/><br/>
- If you are running Windows 95/98/2000/NT, you can use the Cygwin port
of GNU. Be sure to put the
- appropriate Cygwin bin directory at the beginning of your system
path. For information about
- Cygwin, see <jump
href="http://www.sourceware.cygnus.com/cygwin/";>Cygwin</jump>.<br/><br/></li>
- <li>Place <resource-ref idref="xml4j-used"/> xerces.jar in the Java
class path.<br/><br/></li>
- <li>If you are working in Windows, set MAKE_MODE as follows:<br/><br/>
- <code>set MAKE_MODE=UNIX</code><br/><br/></li>
- <li>Run the make file in the &xslt4j; root directory:<br/><br/>
- <code>make build</code><br/><br/></li>
- </ol>
- <p>If you want to do the build without Ant or the GNU build
environment, keep the following in mind:</p>
+ <p>If you want to do the build without Ant, keep the following in
mind:</p>
<ul>
<li>Set the class path to include the src directory, xerces.jar,
bsf.jar, and bsfengines.jar.</li>
<li>Use a Java compiler (such as the IBM Just-In-Time compiler or the
Sun javac) to compile all the .java files in the src
@@ -177,26 +158,11 @@
HTML User's Guide, and the overview and package-level documents used
during the generation of Javadoc.</p>
<p>To rebuild the documentation, you must use the StyleBook tool and
the JDK 1.2.2 java and javadoc
tools. StyleBook (which uses Xalan and Xerces) is in
stylebook-1.0-b2.jar. Some of the document definition files,
- stylesheets, and resources are stored in xml-site-style.tar.gz, and
are unzipped when you run the make files as described
- below. If the JDK 1.2.2 bin and lib directories are not on your class
path, you can edit the make.include file in the
- Xalan root directory so the make file can find the JDK 1.2.2 java and
javadoc tools. You can also include java and javadoc
- arguments on the make file command line. See the make.include file
for the details.</p>
+ stylesheets, and resources are stored in xml-site-style.tar.gz, and
are unzipped when you run Ant as described
+ below.</p>
<p>You can use Ant with the docs target to regenerate the User's Guide
and with the javadocs target to regenerate the
Javadoc API documentation. For more information, see <link
anchor="ant">Using Ant</link>.</p>
- <p>To generate the Xalan HTML User's Guide with the GNU development
tools, run the Xalan make file in the Xalan xdocs
- directory:<br/><br/>
- <code>make makesbook</code></p>
- <p>To generate the Xalan API documentation with GNU, set up the make
file to use the Javadoc tool in the Java JDK 1.2.2 bin
- directory.</p>
- <p>Do the following:</p>
- <ol>
- <li>Put the Java JDK 1.2.2 bin directory on your path (in front of
any JDK 1.1.x bin
- directory that appears on the path).<br/><br/></li>
- <li>In the Xalan docs directory, run the Xalan make file as
follows:<br/><br/>
- <code>make makejavadoc</code><br/><br/></li>
- </ol>
- <p>If you want to rebuild the documentation without using Ant or the
GNU build environment, keep the following in
- mind:</p>
+ <p>If you want to rebuild the documentation without using Ant, keep
the following in mind:</p>
<ul>
<li>Unzip xml-site-style.tar.gz into the xdocs directory (the
operation places files in a number of subdirectories).
<br/><br/></li>
@@ -211,7 +177,30 @@
<li>Before you run javadoc, make sure the following directory
structure exists under the Xalan root
directory: build/docs/apidocs.<br/><br/></li>
<li>To build the API documentation, run the JDK 1.2.2 javadoc tool
from the xdocs directory:<br/><br/>
-<code>javadoc -doclet xalanjdoc.Standard -docletpath ../bin/xalanjdoc.jar
-private -overview ../src/javadocOverview.html -sourcepath ../src -group TrAX
"trax" -group Xalan_Core
"org.apache.xalan.processor:org.apache.xalan.templates:org.apache.xalan.transformer"
-group XPath "org.apache.xpath*:org.w3c.xslt" -group Xalan_Other
"org.apache.xalan.client:org.apache.xalan.dtm:org.apache.xalan.extensions:org.apache.xalan.res:org.apache.xalan.stree:org.apache.xalan.trace:org.apache.xalan.utils"
-group Xalan_Extensions "org.apache.xalan.lib*" -group Serializers
"serialize*" -group Xalan-Java_1_Interface
"org.apache.xalan.xslt:org.apache.xalan.xpath" org.apache.xalan.client
org.apache.xalan.dtm org.apache.xalan.extensions org.apache.xalan.lib
org.apache.xalan.lib.sql org.apache.xalan.processor org.apache.xalan.res
org.apache.xalan.stree org.apache.xalan.templates org.apache.xalan.trace
org.apache.xalan.transformer org.apache.xalan.utils org.apache.xalan.xpath
org.apache.xalan.xpath.xml org.apache.xalan.xslt org.apa
che.xpath org.apache.xpath.axes org.apache.xpath.compiler
org.apache.xpath.functions org.apache.xpath.objects org.apache.xpath.operations
org.apache.xpath.patterns org.apache.xpath.res org.w3c.xslt serialize
serialize.helpers trax -d ../build/docs/apidocs -windowtitle "Xalan-Java 2"
-doctitle "Xalan-Java 2" -bottom "Copyright © 2000 Apache XML Project. All
Rights Reserved."
+<code>
+javadoc -doclet xalanjdoc.Standard -docletpath ../bin/xalanjdoc.jar -private
+-overview ../src/javadocOverview.html -sourcepath ../src
+-group TrAX "trax"
+-group Xalan_Core "org.apache.xalan.processor:org.apache.xalan.templates:
+org.apache.xalan.transformer"
+-group XPath "org.apache.xpath*:org.w3c.xslt"
+-group Xalan_Other "org.apache.xalan.client:org.apache.xalan.dtm:
+org.apache.xalan.extensions:org.apache.xalan.res:org.apache.xalan.stree:
+org.apache.xalan.trace:org.apache.xalan.utils"
+-group Xalan_Extensions "org.apache.xalan.lib*"
+-group Serializers "serialize*"
+-group Xalan-Java_1_Interface "org.apache.xalan.xslt:org.apache.xalan.xpath"
+org.apache.xalan.client org.apache.xalan.dtm org.apache.xalan.extensions
+org.apache.xalan.lib org.apache.xalan.lib.sql org.apache.xalan.processor
+org.apache.xalan.res org.apache.xalan.stree org.apache.xalan.templates
+org.apache.xalan.trace org.apache.xalan.transformer org.apache.xalan.utils
+org.apache.xalan.xpath org.apache.xalan.xpath.xml org.apache.xalan.xslt
+org.apache.xpath org.apache.xpath.axes org.apache.xpath.compiler
+org.apache.xpath.functions org.apache.xpath.objects
org.apache.xpath.operations
+org.apache.xpath.patterns org.apache.xpath.res org.w3c.xslt
+serialize serialize.helpers trax
+-d ../build/docs/apidocs -windowtitle "Xalan-Java 2" -doctitle "Xalan-Java 2"
+-bottom "Copyright © 2000 Apache XML Project. All Rights Reserved."
</code></li>
</ul>
</s3>
1.8 +19 -13 xml-xalan/java/xdocs/sources/xalan/samples.xml
Index: samples.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/samples.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- samples.xml 2000/09/29 15:46:21 1.7
+++ samples.xml 2000/10/12 15:34:17 1.8
@@ -86,7 +86,7 @@
</ol>
<p>The basic command line for running most of the samples is </p>
<p><code>java <ref>classname args</ref></code></p>
- <p>where <ref>classname</ref> is the classname and <ref>args</ref> are
the arguments, if any. As described in
+ <p>where <ref>classname</ref> is the sample class and <ref>args</ref>
are the arguments, if any. As described in
the following sections, some samples take no arguments. The
UseStylesheetParam sample takes an
additional argument. Several samples in extensions use the &xslt4j;
<link idref="commandline">command-line utility</link>, so they take
arguments for the XML source
@@ -129,7 +129,7 @@
<p>Run this sample from the Pipe subdirectory with</p>
<p><code>java Pipe</code></p>
</s2><anchor name="usexmlfilters"/>
- <s2 title="UseXMLFilters"/>
+ <s2 title="UseXMLFilters">
<p>What it does: Chains together the same transformations as the
preceding Pipe sample. Using each Transformer
object as an extension of the SAX XMLFilter interface, sets the
XMLReader as the parent of Transformer1,
Transformer1 as the parent of Transformer2, and Transformer2 as the
parent of of Transformer3.</p>
@@ -156,7 +156,8 @@
<s2 title="AppletXMLtoHTML">
<p>The applet uses a stylesheet to transform an XML document into HTML.
It displays the XML document, the
stylesheet, and the HTML output.</p>
- <p>How to run it: See <jump
href="../samples/appletXMLtoHTML/readme.html">sample applet readme</jump>.</p>
+ <p>How to run it: Copy xalan.jar and xerces.jar to the AppletXMLtoHTML
subdirectory, and open AppletXMLotHTML.hmtl in a
+ browser (it has been tested with Netscape 4.7 and Internet Explorer
5).</p>
</s2><anchor name="servlet"/>
<s2 title="Servlet">
<p>What it does: The client (which you must set up) specifies an XML
document and a stylesheet. The servlet
@@ -198,7 +199,7 @@
for information about the extensions library distributed with &xslt4j;,
see
<link idref="extensions">Extensions</link>.</p>
<ul>
- <li><link anchor="ext1">SimpleRedirect</link></li>
+ <li><link anchor="ext1">1-redir</link></li>
<li><link anchor="ext2">2-basicJscript</link></li>
<li><link anchor="ext3">3-java-namespace</link></li>
<li><link anchor="ext4">4-numlistJava</link></li>
@@ -218,14 +219,19 @@
line):</p>
<anchor name="ext1"/>
- <s3 title="SimpleRedirect">
+ <s3 title="1-redir">
<p>What it does: Uses the Redirect extension elements shipped with
&xslt4j; to direct output to two output
files.</p>
<p>Run this sample from the extensions subdirectory with</p>
- <p><code>java SimpleRedirect</code></p>
+ <p><code>java org.apache.xalan.xslt.Process -in 1-redir.xml</code></p>
+ <p> <code>-xsl 1-redir.xsl</code></p>
+ <p>The standard (non-redirected) output is writen to the screen. The
redirected output is written to 1-redir-out, or
+ whatever filename you assign to the doc/foo @file attribute in
1-redir.xml. The stylesheet gets the file name for
+ redirected output from the XML input file.</p>
</s3><anchor name="ext2"/>
<s3 title="2-basicJscript">
- <p>What it does: Uses an extension element and extension function
implemented in Javascript.</p>
+ <p>What it does: Uses an extension element and extension function
implemented in Javascript to compute a
+ deadline for responding to a customer inquiry.</p>
<p>Run this sample from the extensions subdirectory with</p>
<p><code>java org.apache.xalan.xslt.Process -in
2-basicJscript.xml</code>
<br/> <code>-xsl 2-jbasicJscript.xsl</code></p>
@@ -235,20 +241,20 @@
extension namespace to provide ready access to extensions
implemented in Java.</p>
<p>Run this sample from the extensions subdirectory with</p>
<p><code>java org.apache.xalan.xslt.Process -in
3-java-namespace.xml</code>
- <br/> <code>3-java-namespace.xsl</code></p>
+ <br/> <code>-xsl 3-java-namespace.xsl</code></p>
</s3><anchor name="ext4"/>
<s3 title="4-numlistJava">
- <p>What it does: Uses a Java extension to transform a set of name
elements into an alphabetical and numbered
+ <p>What it does: Uses a Java extension to transform a set of name
elements into a numbered and alphabetized
list.</p>
<p>Run this sample from the extensions subdirectory with</p>
- <p><code>java org.apache.xalan.xslt.Process -in
4-numlistJava.xml</code>
+ <p><code>java org.apache.xalan.xslt.Process -in numlist.xml</code>
<br/> <code>-xsl 4-numlistJava.xsl</code></p>
</s3><anchor name="ext5"/>
<s3 title="5-numlistJscript">
- <p>What it does: Uses a Javascript extension to transform a set of
name elements into an alphabetical and
- numbered list. This sample performs the same operations as the
preceding Java extension.</p>
+ <p>What it does: Uses a Javascript extension to transform a set of
name elements into a numbered and
+ alphabetized list. This sample performs the same operations as the
preceding Java extension.</p>
<p>Run this sample from the extensions subdirectory with</p>
- <p><code> java org.apache.xalan.xslt.Process -in 5-numlistJscript.xml
</code>
+ <p><code> java org.apache.xalan.xslt.Process -in numlist.xml</code>
<br/> <code>-xsl 5-numlistJscript.xsl</code></p>
</s3>
</s2>
1.3 +2 -1 xml-xalan/java/xdocs/sources/xalan/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/STATUS,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- STATUS 2000/09/19 12:52:36 1.2
+++ STATUS 2000/10/12 15:34:17 1.3
@@ -1,7 +1,8 @@
<s3 title="Version of Xerces to use">
<p>The &xslt4j-current; has been tested with &xml4j-used;. &download; For
information about including xerces.jar on the system class path, see <link
idref="getstarted" anchor="classpath">Setting up the system class
path</link>.</p>
<p><em>Important</em> You may experience unpredictable anomalies if your
Xalan and Xerces builds are not in synch. If you download an update to Xalan,
check the release notes to determine which version of Xerces you should use.</p>
-<note>You can use Xalan with other conformnant SAX and DOM parsers. </note>
+<note>You can use Xalan with other XMLReaders that implement the
<resource-ref idref="jaxp"/>. See
+<link idref="usagepatterns" anchor="xmlreader">Setting the
XMLReader</link>).</note>
</s3><anchor name="to-do"/>
<s3 title="To-do tasks">
<ul>
1.5 +49 -9 xml-xalan/java/xdocs/sources/xalan/usagepatterns.xml
Index: usagepatterns.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/usagepatterns.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- usagepatterns.xml 2000/09/29 15:46:21 1.4
+++ usagepatterns.xml 2000/10/12 15:34:17 1.5
@@ -59,6 +59,8 @@
<s1 title="Basic usage patterns">
<ul>
<li><link anchor="basic">Basic steps</link></li>
+<li><link anchor="xmlreader">Setting the XMLReader</link></li>
+<li><link anchor="embed">Working with embedded stylesheets</link></li>
<li><link anchor="params">Setting stylesheet parameters</link></li>
<li><link anchor="sax">Explicitly working with SAX</link></li>
<li><link anchor="outasin">Using transformation output as input for another
transformation</link></li>
@@ -67,6 +69,7 @@
<li><link anchor="applet">Using the &xslt4j; applet wrapper</link></li>
<li><link anchor="servlet">Using &xslt4j; in a servlet</link></li>
<li><link anchor="extensions">Creating and using extensions</link></li>
+<li><link anchor="multithreading">Multithreading</link></li>
<li><link anchor="debugging">Debugger interface</link></li>
</ul>
<anchor name="basic"/>
@@ -124,15 +127,50 @@
<p>For each node in the XML source, the Transformer uses the Templates
object to determine which template to apply: one of the templates in the
Templates object, a default template rule as specified in the XSLT spec, or
none.</p>
<p>The Transformer forwards the SAX events produced by this process to the
appropriate output ContentHandler, a serializer if the Result object has been
set up to write to a stream or file, a DOMBuilder utility if the output is to
be a DOM tree.</p>
<note>A serializer is a utility that translates a series of SAX events or a
DOM tree into a stream, performing any character escaping required by the
output method (the XML ourput method, for example normally requires < and
& to be escaped).</note>
-<p>To the degree possible, the parsing of the XML source and application of
the Templates object to that source are performed concurrently in separate
threads. For more information, see xxxx.</p>
+<p>To the degree possible, the parsing of the XML source and application of
the Templates object to that source are performed concurrently. This enables
the Transformer to begin supplying the client with transformation output before
the parsing has been completed. When necessary, the Transformer waits for the
XMLReader to provide the input it needs to continue.</p>
+</s2><anchor name="xmlreader"/>
+<s2 title="Setting the XMLReader">
+<p>Unless you are submitting your stylesheet and your XML input in the form
of DOM trees, &xslt4j; uses an XMLReader to parse the stylesheet and the XML
input. This XMLReader must implement the <resource-ref idref="jaxp"/>. To
designate an XMLReader, do one of the following:</p>
+<ul>
+ <li>Set the org.xml.sax.driver system property.<br/><br/>
+ You can set system properties from the command line or within your
application. You can also edit the setting in
org/apache/xalan/res/XSLTInfo.properties (in xalan.jar). If the
org.xml.sax.driver system property is not set, &xslt4j; uses this file to set
it.<br/><br/></li>
+ <li>Call the trax.Processor.setXMLReader() method.<br/><br/>
+ If you call this method before you call trax.Processor.process() to
generate a Templates object, &xslt4j; uses the XMLReader you designate to
process the stylesheet and the XML input, and ignores the org.xml.sax.driver
property setting (for the current transformation).<br/><br/></li>
+</ul>
+<p>Be sure the XMLReader is on the classpath. The &xml4j; XMLReader --
org.apache.xerces.parsers.SAXParser -- is in xerces.jar.(</p>
+<note>Other system properties: The default serializer system property
settings are in serialize/serializer.properties. The default XSLT stylesheet
system property setting is in org/apache/xalan/res/XSLTInfo.properties (not in
trax/trax.properties??). These properties files are in xalan.jar.</note>
</s2><anchor name="params"/>
<s2 title="Setting stylesheet parameters">
<p>An XSLT stylesheet may include parameters that are set at run time each
time a transformation takes place. To set a stylesheet parameter, use the
trax.Transformer <jump
href="apidocs/trax/Transformer.html#setParameter(java.lang.String,java.lang.String,java.lang.Object)">setParameter(String
name, String namespace, Object value)</jump> method. If the parameter QName
only includes a local name (as is often the case), the namespace argument is
null. For a working example, see UseStylesheetParam.java in the
java/samples/UseStylesheetParam subdirectory.</p>
<p>You can also set a parameter with the command-line utility by including
the -param flag. For example:</p>
<p><code>java org.apache.xalan.xslt.Process -in foo.xml -xsl foo.xsl -param
param1 boo</code></p>
-<p>or</p>
-<p><code>java org.apache.xalan.xslt.Process -in foo.xml -xsl foo.xsl -param
param1 org/myorg/xyz boo</code></p>
-<p>where <code>param</code> is the parameter name,
<code>org/myorg/xyz</code> is the parameter namespace. [not yet working], and
<code>boo</code> is the parameter value. Unless you have defined a namespace
for the parameter, the parameter namespace is null.</p>
+<p>where <code>param</code> is the parameter name and <code>boo</code> is
the parameter value. The parameter namespace is null.</p>
+</s2><anchor name="embed"/>
+<s2 title="Working with embedded stylesheets">
+<p>An XML source document may include an <jump
href="http://www.w3.org/TR/xml-stylesheet/";>xml-stylesheet processing
instruction</jump> which identifies the stylesheet to be used to process the
document. As indicated by the processing instruction href attribute, the
stylesheet itself may be embedded in the XML document or located elsewhere.</p>
+<p>Suppose you have an XML document (foo.xml) with the following
xml-stylesheet processing instruction:</p>
+<p><code><?xml-stylesheet type="text/xml" href="foo.xsl"?></code></p>
+<p>The following fragment, uses this instruction to locate the stylesheet
(foo.xsl in the same directory) and create a Templates object. Note the use of
the Processor getAssociatedStylesheets() and processMultipleStylesheets()
methods in steps 2a and 2b.</p>
+<note>An XML document may include more than one xml-stylesheet processing
instruction, hence the support for working with multiple stylesheets. If more
than one stylesheet is returned, the other stylesheets are imported into the
first stylesheet [awaiting clarification from the W3C].</note>
+<source>// 1. Instantiate the stylesheet processor.
+trax.Processor processor = trax.Processor.newInstance("xslt");
+
+// 2a. Get the stylesheet(s) from the XML source (the source may contain
+// more than one xml-stylesheet processing instruction).
+String media = null , title = null, charset = null;
+org.xml.sax.InputSource[] stylesheet = processor.getAssociatedStylesheets
+ (new InputSource("foo.xml"), media, title, charset);
+// 2b. Process the stylesheet(s), producing a Templates object.
+trax.Templates templates = processor.processMultiple(stylesheet);
+
+// 3. Use the Templates object to instantiate a Transformer.
+trax.Transformer transformer = templates.newTransformer();
+
+// 4. Use the Transformer to apply the Templates object to an XML
+// source and send the output to a Result object.
+transformer.transform
+ (new
org.xml.sax.InputSource("foo.xml"),
+ new
trax.Result(new java.io.FileWriter("foo.out")));</source>
</s2><anchor name="sax"/>
<s2 title="Explicitly working with SAX">
<p>&xslt4j; uses the SAX event model to process stylesheets, to parse XML
input documents, and to produce output. For each of these operations, an
XMLReader reads input, firing parse events, and a ContentHandler listens to the
XMLReader and performs parse event methods.</p>
@@ -187,8 +225,8 @@
<s2 title="Using transformation output as input for another transformation">
<p>You can chain together a series of two or more transformations such that
the output of one transformation provides input for the another transformation.
&xslt4j; supports two basic strategies for chaining a series of
transformations:</p>
<ul>
- <li><br/>A Transformer uses a SAX ContentHandler to process input, and
another ContentHandler to process output. Along these lines, you can use the
Transformer getInputContentHandler() method to make one Transformer the
ContentHandler for the XMLParse that reads the input, then use the same method
make a second Transformer the ContentHandler for the output of the first
Transformer, and so on. For more detail and an example, see the <link
idref="samples" anchor="pipe">Pipe<link> sample.<br/><br/></li>
- <li>A Transformer extends the SAX XMLFilter interface. Using the
setParent() method this interface supplies, you can set an XMLReader as the
parent of the Transformer for the first transformation, then set this
Transformer as the parent for the Transformer performing the second
transformation, and so on. You launch the series by instructing the last
Transformer to parse the input. For more detail and an example, see the <link
idref="samples" anchor="usexmlfilters">UseXMLFilters<link> sample.</li>
+ <li><br/>A Transformer uses a SAX ContentHandler to process input, and
another ContentHandler to process output. Along these lines, you can use the
Transformer getInputContentHandler() method to make one Transformer the
ContentHandler for the XMLReader that parses the input, then use the same
method make a second Transformer the ContentHandler for the output of the first
Transformer, and so on. For more detail and an example, see the <link
idref="samples" anchor="pipe">Pipe</link> sample.<br/><br/></li>
+ <li>A Transformer extends the SAX XMLFilter interface. Using the
setParent() method this interface supplies, you can set an XMLReader as the
parent of the Transformer for the first transformation, then set this
Transformer as the parent for the Transformer performing the second
transformation, and so on. You launch the series by instructing the last
Transformer to parse the input. For more detail and an example, see the <link
idref="samples" anchor="usexmlfilters">UseXMLFilters</link> sample.</li>
</ul>
</s2><anchor name="dom"/>
<s2 title="Processing and producing DOM trees">
@@ -226,12 +264,14 @@
</s2><anchor name="extensions"/>
<s2 title="Creating and using extensions">
<p>For those cases where you want to be able to call procedural code from
within a stylesheet, the &xslt4j; Extensions facility supports the creation of
extension elements and extension functions. See <link
idref="extensions">Extensions</link> and <link idref="samples"
anchor="extensions">Extensions samples</link>.</p>
-</s2>
-<anchor name="debugging"/>
+</s2><anchor name="multithreading"/>
+<s2 title="Multithreading">
+<p>A given Templates object may be used concurrently iand repeatedly in
multiple transformations. You must, however, use a separate Transformer object
to perform each transformation. The Transformer object tracks state information
and is lightweight. Each time you perform a transformation, use the Templates
object newTransformer() method to instantiate a Transformer.</p>
+</s2><anchor name="debugging"/>
<s2 title="Debugger Interface">
<p>&xslt4j; contains a debugger interface in the
org.apache.xalan.xslt.trace package:</p>
<ul>
- <li><jump
href="apidocs/org/apache/xalan/trace/TraceListener.html">TraceListener"</jump>
is an interface that debuggers
+ <li><jump
href="apidocs/org/apache/xalan/trace/TraceListener.html">TraceListener</jump>
is an interface that debuggers
can implement. Or, like the <link
idref="commandline">command-line utility</link>, you can use the <jump
href="apidocs/org/apache/xalan/trace/PrintTraceListener.html">PrintTraceListener</jump>
implementation of that interface.
<br/><br/></li>
1.9 +53 -33 xml-xalan/java/xdocs/sources/xalan/whatsnew.xml
Index: whatsnew.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/whatsnew.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- whatsnew.xml 2000/09/29 15:46:21 1.8
+++ whatsnew.xml 2000/10/12 15:34:17 1.9
@@ -62,54 +62,58 @@
<li><link anchor="packages">Package layout</link></li>
</ul><anchor name="design"/>
<s2 title="New Design">
- <p>&xslt4j2; represents a fundamental redesign of Xalan. The goal of this
redesign is an easier-to-use, more understandable, and more modular API that
that lends itself to "streaming," the production of transformation output while
the input is still being parsed, and that encourages wider participation in its
ongoing development by the open-source XML developer community.</p>
+ <p>&xslt4j2; represents a fundamental redesign of Xalan. The primary
objective of this redesign is an easier-to-use, more understandable, and more
modular API that that encourages wider participation in its ongoing development
by the open-source XML developer community, and that lends itself to
"streaming," the production of transformation output while the input is still
being parsed, and .</p>
<p>As a result of this redesign, the changes are global in nature. The API
and the basic usage patterns are different. For the details, see <link
idref="usagepatterns">Basic Usage Patterns</link>.</p>
-<p>To start with, &xslt4j2; implements the <resource-ref idref="trax"/>
interfaces. A number of open-source XML tool developers have collaborated on
TRaX, a conceptual framework and a standard API for performing a variety of XML
transformations. We strongly encourage you to use the TRaX framework and
interfaces when you perform XML transformations.</p>
+<p>To start with, &xslt4j2; implements the <resource-ref idref="trax"/>
interfaces. A number of open-source XML tool developers have collaborated on
TRaX, a conceptual framework and a standard API for performing XML
transformations. We strongly encourage you to use the TRaX framework and
interfaces when you use &xslt4j2; to perform XML transformations.</p>
<p>The basic organization of TRaX is quite simple: use a Processor to
process transformation instructions (the stylesheet), producing a Templates
object. Use the Templates object to instantiate a Transformer, with which you
can apply the Templates object to XML input, producing a result tree. For more
detail, see <link idref="usagepatterns" anchor="basic">Basic steps</link>.</p>
<p>&xslt4j2; builds on <resource-ref idref="sax2"/>, <resource-ref
idref="dom2"/>, and the <resource-ref idref="jaxp"/>. For example, &xslt4j2;
incorporates the SAX parsing event model in its support for the incremental
production of transformation output.</p>
- <p>In conjunction with TRaX, &xslt4j; gathers basic operational settings
from system properties. System properties, for example, identify the stylesheet
processor and SAX parser to use, and the serializers that are available for
various output methods. The default settings point to the Xalan
StylesheetProcessor, the Xerces SAXParser, and the serializers shipped with
Xerces.</p>
+ <p>In conjunction with TRaX, &xslt4j; gathers basic operational settings
from Java system property settings. System properties, for example, identify
the stylesheet processor and XMLReader to use, and the serializers that are
available for various output methods. You can set these system properties on
the command line, in your applications, or by editing the properties files that
&xslt4j; uses for system properties that you do not set. The default settings
in these files (as shipped) point to the Xalan StylesheetProcessor, the
serializers shipped with Xerces, and the Xerces SAXParser.</p>
</s2><anchor name="packages"/>
<s2 title="Package layout">
- <p>The class package structure maps closely to major conceptual modules.
For example, you use the processor
- package to process stylesheets and produce stylesheet templates (the
templates package). Then you use the
- transformer package to apply the templates to a source tree and produce an
output tree. Responsibility for
- evaluating XPath expressions and XSLT matching patterns is centralized in
the XPath packages, and a variety of
+ <p>The new class package structure is flatter and maps closely to the TRaX
framework. For example, you use the
+ processor package to process stylesheets and produce stylesheet templates
(the templates package). Then you use the
+ transformer package to apply the templates to a source tree and produce an
output tree.</p>
+ <p>Responsibility for evaluating XPath expressions and XSLT matching
patterns is centralized in the XPath packages,
+ serializers for outputting transformation result trees as a stream are in
the serializers package, and a variety of
utilities used by multiple packages are in the utils package.</p>
- <p>&xslt4j2; is made up of four major and several minor modules. The four
major modules are:</p>
-<gloss>
- <label><jump
href="apidocs/org/apache/xalan/processor/package-summary.html">org.apache.xalan.processor</jump></label>
- <item>Processes the stylesheet and produces the Templates
object. This module is responsible for
+ <p>&xslt4j2; is made up of four primary and several secondary packages.
The four primary packages are:</p>
+ <gloss>
+ <label><jump
+
href="apidocs/org/apache/xalan/processor/package-summary.html">org.apache.xalan.processor</jump></label>
+ <item>Processes the stylesheet and produces the Templates
object. This package is responsible for
implementing the <jump
href="apidocs/trax/Processor.html">trax.Processor</jump> abstract class, which
provides the primary entry point into &xslt4j;.</item>
</gloss>
<gloss>
- <label><jump
href="apidocs/org/apache/xalan/templates/package-summary.html">org.apache.xalan.templates</jump></label>
- <item>Defines the structure and content of a stylesheet tree
(which may include multiple imported and
- included stylesheets). This module is responsible for implementing the
<jump
+ <label><jump
+
href="apidocs/org/apache/xalan/templates/package-summary.html">org.apache.xalan.templates</jump></label>
+ <item>Defines the structure and content of a stylesheet tree
(which may include multiple imported and
+ included stylesheets). This package is responsible for implementing the
<jump
href="apidocs/trax/Templates.html">trax.Templates</jump>
interface.</item>
</gloss>
<gloss>
- <label><jump
href="apidocs/org/apache/xalan/transformer/package-summary.html">org.apache.xalan.transformer</jump></label>
- <item>Applies the Templates object to the XML source and
produces the result tree. This module is
+ <label><jump
+
href="apidocs/org/apache/xalan/transformer/package-summary.html">org.apache.xalan.transformer</jump></label>
+ <item>Applies the Templates object to the XML source and
produces the result tree. This package is
responsible for implementing the <jump
href="apidocs/trax/Transformer.html">trax.Transformer</jump>
interface.</item>
</gloss>
<gloss>
- <label><jump
href="apidocs/org/apache/xpath/package-summary.html">org.apache.xpath</jump></label>
+ <label><jump
href="apidocs/org/apache/xpath/package-summary.html">org.apache.xpath</jump>
packages</label>
<item>Evaluates XPath expressions and XSLT match
patterns.</item>
</gloss>
- <p>Other modules include:</p>
- <gloss>
- <label><jump
href="apidocs/org/apache/xalan/stree/package-summary.html">org.apache.xalan.stree</jump></label>
+ <p>Other packages include:</p>
+ <gloss>
+ <label><jump
href="apidocs/org/apache/xalan/stree/package-summary.html">org.apache.xalan.stree</jump></label>
<item>Implementation of DOM source tree optimized for node retrieval
and XSLT processing.</item>
- </gloss>
- <gloss>
- <label><jump
href="apidocs/org/apache/xalan/utils/package-summary.html">org.apache.xalan.utils</jump></label>
+ </gloss>
+ <gloss>
+ <label><jump
href="apidocs/org/apache/xalan/utils/package-summary.html">org.apache.xalan.utils</jump></label>
<item>Xalan utilities used by the other packages.</item>
</gloss>
<gloss>
<label><jump
href="apidocs/org/apache/xalan/res/package-summary.html">org.apache.xalan.res</jump></label>
- <item>&xslt4j; resource files (such as error message).</item>
+ <item>&xslt4j; resource files (such as error message).</item>
</gloss>
<gloss>
<label><jump
href="apidocs/org/apache/xalan/client/package-summary.html">org.apache.xalan.client</jump></label>
@@ -120,16 +124,32 @@
<item>Enables XSLT debuggers and similar tools to add trace listeners
to transformation operations.</item>
</gloss>
<gloss>
- <label><jump
href="apidocs/org/apache/xalan/extensions/package-summary.html">org.apache.xalan.extensions</jump></label>
- <item>Support for extension elements and extension functions, which
allow you to call Java code and scripts from within a stylesheet.</item>
- </gloss>
- <gloss>
- <label><jump
href="apidocs/org/apache/xalan/lib/package-summary.html">org.apache.xalan.lib</jump></label>
- <item>The &xslt4j; extensions library. To date this library includes a
Redirect extension, which allows a stylesheet to produce multiple output files,
and a preliminary version of an SQL extension with which you can connect to and
submit queries to a JDBC data source, and incrementally "stream" the result set
into an XML target.</item>
+ <label><jump
+
href="apidocs/org/apache/xalan/extensions/package-summary.html">org.apache.xalan.extensions</jump></label>
+ <item>Support for extension elements and extension functions, which
allow you to call Java code and scripts from
+ within a stylesheet.</item>
</gloss>
<gloss>
- <label><jump
href="apidocs/org/apache/xalan/xslt/package-summary.html">org.apache.xalan.xslt</jump>
and <jump
href="apidocs/org/apache/xalan/xpath/package-summary.html">org.apache.xalan.xpath</jump></label>
- <item>Provide &xslt4j; 1 applications an interface to &xslt4j2;</item>
- </gloss>
+ <label><jump
href="apidocs/org/apache/xalan/lib/package-summary.html">org.apache.xalan.lib</jump>
+ packages</label>
+ <item>The &xslt4j; library of extension elements and extension
functions.</item>
+ </gloss>
+ <p>Other packages that are included in the xml-xalan source tree and
xalan.jar:</p>
+ <gloss>
+ <label><jump href="">javax.xml.parsers</jump></label>
+ <item>The xml.apache.org implementation of <resource-ref
idref="jaxp"/>.</item>
+ </gloss>
+ <gloss>
+ <label><jump href="">serialize</jump> packages</label>
+ <item>Output transformation result trees as a stream.</item>
+ </gloss>
+ <gloss>
+ <label><jump
href="apidocs/org/xml/sax/package-summary.html">org.xml.sax</jump>
packages</label>
+ <item>SAX 2 interfaces.</item>
+ </gloss>
+ <gloss>
+ <label><jump
href="apidocs/org/w3c/dom/package-summary.html">org.w3.dom</jump>
packages</label>
+ <item>DOM level 2 interfaces.</item>
+ </gloss>
</s2>
</s1>
