You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by dl...@locus.apache.org on 2000/03/06 14:31:51 UTC
cvs commit: xml-xalan/xdocs/sources/xalan dtm.xml getstarted.xml javadocOverview.xml org-apache-xalan-xpath-dtm.xml org-apache-xalan-xpath-xdom.xml org-apache-xalan-xpath-xml.xml org-apache-xalan-xpath.xml org-apache-xalan-xslt-client.xml org-apache-xalan-xslt-extensions.xml org-apache-xalan-xslt-trace.xml org-apache-xalan-xslt.xml org-apache-xml-serialize.xml overview.xml readme.xml resources.xml samples.xml usagepatterns.xml
dleslie 00/03/06 05:31:50
Modified: xdocs/sources/xalan dtm.xml getstarted.xml
javadocOverview.xml org-apache-xalan-xpath-dtm.xml
org-apache-xalan-xpath-xdom.xml
org-apache-xalan-xpath-xml.xml
org-apache-xalan-xpath.xml
org-apache-xalan-xslt-client.xml
org-apache-xalan-xslt-extensions.xml
org-apache-xalan-xslt-trace.xml
org-apache-xalan-xslt.xml
org-apache-xml-serialize.xml overview.xml
readme.xml resources.xml samples.xml
usagepatterns.xml
Log:
Editorial and technical revisions for gold build.
Revision Changes Path
1.5 +18 -16 xml-xalan/xdocs/sources/xalan/dtm.xml
Index: dtm.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/dtm.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- dtm.xml 2000/02/29 19:55:09 1.4
+++ dtm.xml 2000/03/06 13:31:48 1.5
@@ -60,24 +60,26 @@
<s1 title="&xslt4j; DTM">
- <s2 title="Using the &xslt4j; DTM (Document Table Model)">
- <p><resource-ref idref="DOM"/> (Document Object Model) provides a standard interface for interacting
- with XML documents. &xslt4j; supports this interface: when you set up an XSLTProcessor to use
- <resource-ref idref="XercesLiaisonDoc"/> and the Xerces XML parser, &xslt4j; uses an implementation of the
- DOM interface. For large XML documents, however, this may involve considerable overhead, since &xslt4j; must create
- one or more Java objects for each Node in the DOM tree.</p>
- <p>For those cases where your input and output are URLS, files, or streams, and you use the default liaison (<resource-ref
- idref="DTMLiaisonDoc"/>) and XML parser, &xslt4j; avoids this overhead by implementing a DTM, a "pseudo-DOM" that uses
- integer arrays to represent the required information about the DOM Nodes. For larger input and output trees, the
+ <s2 title="Using the &xslt4j; Document Table Model (DTM)">
+ <p>The Document Object Model (<resource-ref idref="DOM"/>) provides a standard interface for interacting
+ with XML documents. &xslt4j; supports this interface. For large XML documents, however, this may involve considerable
+ overhead, since &xslt4j; must create one or more Java objects for each Node in the document DOM tree.</p>
+ <p>For the majority of cases -- your input and output are URLS, files, or streams, and you use the default Liaison
+ (<resource-ref idref="DTMLiaisonDoc"/>) and XML parser, &xslt4j; avoids this overhead by implementing the Document Table
+ Model (DTM), a "pseudo-DOM" that uses integer arrays in place of the DOM. For larger input and output trees, the
performance improvements can be very significant.</p>
- <p>The <jump href="apidocs/org/apache/xalan/xslt/XSLTProcessorFactory.html#getProcessor()">XSLTProcessorFactory
- getProcessor()</jump> method (with no arguments) sets up an XSLT processor to use the default DTM
- liaison and parser. Keep in mind that if your input or output is a DOM, you must use a "standard" DOM liaison and XML
- parser, such as XercesLiaison and the Xerces XML parser. For more information, see
- <link idref="usagepatterns" anchor="dom-in">Processing DOM input and Producing DOM output</link>.</p>
+ <p>The <resource-ref idref="XSLTProcessorFactoryGetProcessorDoc"/> sets up an XSLT processor to use the default DTM liaison
+ and XML parser. If your input or output turns out to be a DOM Node, the XSLTProcessor automatically switches to the
+ <resource-ref idref="XercesLiaisonDoc"/> and the Xerces DOM parser. You can explicitly instantiate an XSLTProcessor to use
+ XercesLiaison and the Xerces DOM parser as follows:</p>
+ <p><code>org.apache.xalan.xsltXSLT.Processor xsltProc = org.apache.xalan.xslt.XSLTProcessorFactory.getProcessor(</code><br/>
+ <code> new org.apache.xalan.xpath.xdom.XercesLiaison());</code></p>
+ <p>For more information, see <link idref="usagepatterns" anchor="dom-in">Processing DOM input and Producing DOM
+ output</link>.</p>
<note>The DTM parser always attempts to expand entitity references in the source tree and stylesheet
tree. If you attempt to turn off entity reference expansion -- with DTMLiaison
setShouldExpandEntitityRefs(false) -- DTMLaison does not make the setting and issues a message to that
- effect. If you want to turn off entity refereence expansion, use XercesLiaison.</note>
+ effect. If you want to turn off entity refereence expansion, instantiate the XSLTProcessor to use XercesLiaison and the
+ Xerces DOM parser.</note>
</s2>
-</s1>
+</s1>
\ No newline at end of file
1.6 +9 -9 xml-xalan/xdocs/sources/xalan/getstarted.xml
Index: getstarted.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/getstarted.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- getstarted.xml 2000/02/29 19:55:09 1.5
+++ getstarted.xml 2000/03/06 13:31:48 1.6
@@ -17,16 +17,16 @@
<li>xalan.jar</li>
<li>xerces.jar</li>
</ul>
-<p>You can get the Sun JDK or JRE from <jump href="http://www.java.sun.com">java.sun.com</jump>. Download the latest release of Xalan and Xerces-java from <jump href="http://xml.apache.org/dist/">xml.apache.org</jump>. Check the <link idref="readme" anchor="status">version release notes</link> to verify that you are using the correct version of Xerces. <em>Important</em> You may experience unpredictable anomalies if your &xslt4j; and &xml4j; builds are not in synch. You can use &xslt4j; with other XML parsers, but it is up to you to implement liaisons to those parsers. Your liaison class should extend <resource-ref idref="XMLParserLiaisonDefaultDoc"/> and implement <resource-ref idref="XPathSupportDoc"/>.</p>
-<note>You may also download the latest releases of LotusXSL and the XML Parser for Java from <jump href="http://www.alphaworks.ibm.com/tech/LotusXSL">alphaWorks</jump>. LotusXSL and the XML Parser for Java are Xalan and Xerces-java respectively, along with additional features and with wrappers to support the core API in place on alphaWorks before the first releases of Xalan and Xerces-java on xml.apache.org in November 1999. The alphaWorks LotusXSL release also provides continued support for earlier alphaWorks releases of the XML4J DOM and TXDOM parsers.</note>
-<p>If you plan to run <link idref="extensions">XSLT extensions</link>. you need bsf.jar and bsfengines.jar, both of which are included in the Xalan 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>
+<p>You can get the Sun JDK or JRE from <jump href="http://www.java.sun.com">java.sun.com</jump>. Download the latest release of &xslt4j; and Xerces-java from <jump href="http://xml.apache.org/dist/">xml.apache.org</jump>. Check the <link idref="readme" anchor="status">version release notes</link> to verify that you are using the correct version of Xerces. <em>Important</em> You may experience unpredictable anomalies if your &xslt4j; and &xml4j; builds are not in synch. You can use &xslt4j; with other XML parsers, but it is up to you to implement liaisons to those parsers. Your liaison class should extend <resource-ref idref="XMLParserLiaisonDefaultDoc"/> and implement <resource-ref idref="XPathSupportDoc"/>.</p>
+
+<p>If you plan to run <link idref="extensions">XSLT extensions</link>. you need bsf.jar and bsfengines.jar, both of which are 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 To run extensions, include bsf.jar and bsfengines.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">
-<p>The Xalan distribution includes a number of basic sample applications. These samples are easy to run, and you can review the source files -- all of which are brief -- to see just how they work.</p>
+<p>The &xslt4j; distribution includes a number of basic sample applications. These samples are easy to run, and you can review the source files -- all of which are brief -- to see just how they work.</p>
<p>To run the samples, do the following:</p>
<ol>
<li>Set up your class path (see above), including xalansamples.jar.</li>
@@ -52,18 +52,18 @@
<p>You can start by using your own XML source files and XSL stylesheets with the sample applications, which illustrate a number of the <link anchor="usage-patterns">basic usage patterns</link>.</p>
<p>If you modify a java source file, be sure to compile the class and place it on the system class path. Here are some basic points to keep in mind as you are setting up transformations:</p>
<ul>
-<li>Use one of the <resource-ref idref="XSLTProcessorFactoryDoc"/> static getProcessor methods to set up an <resource-ref idref="XSLTProcessorDoc"/>. <br/><br/>By default, the XSLTProcessor uses the <resource-ref idref="DTMLiaisonDoc"/> and the high-performance <link idref="dtm"> Document Table Model (DTM)</link> "pseudo-DOM" parser to process the input. If your input or output is a DOM node (rather than a URL, file, or stream), you must use a "standard" DOM liaison and XML parser, such as the <resource-ref idref="XercesLiaisonDoc"/> and the Xerces XML parser. For an example, see <link anchor="dom-in">Processing DOM input</link>.<br/><br/></li>
+<li>Use the <resource-ref idref="XSLTProcessorFactoryGetProcessorDoc"/> to set up an <resource-ref idref="XSLTProcessorDoc"/> object.<br/><br/></li>
<li>Set up <resource-ref idref="XSLTInputSourceDoc"/> objects for the XML input and XSL stylesheet. You can use a file name or URL, character streams, byte streams, or SAX input stream to instantiate an XSLTInputSource object.<br/><br/>
If the XML document contains a stylesheet Processing Instruction (PI), you do not need to create a separate
XSLTInputSource object for an XSL stylesheet.<br/><br/></li>
-<li>For improved performance with a series of transformations, use the XSLTProcessor processStylesheet method to compile the XSL stylesheet (the result is a <resource-ref idref="StylesheetRootDoc"/>.<br/><br/>
-This is also useful when you need to get information from the stylesheet before the tranformation occurs, for
+<li>For improved performance with a series of transformations, use the <resource-ref idref="XSLTProcessorProcessStylesheetDoc"/> to compile the XSL stylesheet (the result is a <resource-ref idref="StylesheetRootDoc"/>), and then use the <resource-ref idref="StylesheetRootProcessDoc"/> to perform the transformations.<br/><br/>
+Compiling the stylesheet is also useful when you need to get information from the stylesheet before the tranformation occurs, for
instance, when you need to find out the output encoding in order to construct the right kind of Writer.
You must also compile the stylesheet if you are using the XSLTProcessor as a SAX document handler (see <link idref="usagepatterns" anchor="sax">Generating and responding to SAX events</link>).<br/><br/></li>
<li>Set up an <resource-ref idref="XSLTResultTargetDoc"/> for the transformation output. You can use a file name or URL, character stream, byte stream, or SAX document handler to instantiate an XSLTOutputTarget object.<br/><br/></li>
-<li>Use the XSLTProcessor (or, in some cases, the <resource-ref idref="StylesheetRootDoc"/>) process method to perform the transformation.<br/><br/>
+<li>Use the XSLTProcessor process() method to perform the transformation, or the StylesheetRoot process() method to perform a series of transformations with the same stylesheet.<br/><br/>
XSLTProcessor is thread-safe for one instance per thread. If you are using the same instance of XSLTProcessor to perform
-more than one transformation, call the reset method between transformations. StylesheetRoot is multithread-safe. amd a single instance may be used acress threads.</li>
+more than one transformation, call the reset method between transformations. StylesheetRoot is multithread-safe, and a single instance may be used across threads. Accordingly, you can call a StylesheetRoot object process() method repeatedly without resetting the StyleSheetRoot.</li>
</ul>
<p>For more information on setting up applications, see <link idref="usagepatterns">Usage Patterns</link>.</p>
</s2>
1.6 +1 -1 xml-xalan/xdocs/sources/xalan/javadocOverview.xml
Index: javadocOverview.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/javadocOverview.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- javadocOverview.xml 2000/03/03 14:50:42 1.5
+++ javadocOverview.xml 2000/03/06 13:31:48 1.6
@@ -74,7 +74,7 @@
By default, the XSLTProcessor uses the {@link org.apache.xalan.xpath.dtm.DTMLiaison} and the
high-performance <resource-ref idref="dtm_fr_jindex"/> "pseudo" DOM parser to process the input. If your input or output
is a DOM node (rather than a URL, file, or stream), &xslt4j; uses {@link org.apache.xalan.xpath.xdom.XercesLiaison
- XercesLiaison} and the Xerces DOM parser -- a "standard" DOM liaison and parser.<br/><br/>
+ XercesLiaison} and the Xerces DOM parser.<br/><br/>
The XSLT and XPath engines are independent from any given DOM or XML implementation. All parser-dependent
calls are funneled through the {@link org.apache.xalan.xpath.xml.XMLParserLiaison}.<br/><br/></li>
<li>Set up {@link org.apache.xalan.xslt.XSLTInputSource} objects for the XML input and XSL stylesheet.
1.4 +10 -9 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-dtm.xml
Index: org-apache-xalan-xpath-dtm.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-dtm.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- org-apache-xalan-xpath-dtm.xml 2000/02/29 19:55:09 1.3
+++ org-apache-xalan-xpath-dtm.xml 2000/03/06 13:31:48 1.4
@@ -59,24 +59,25 @@
-->
<s1 title="org.apache.xalan.xpath.dtm package">
<s2 title="Summary">
- <p>Implements a pseudo-DOM Liaison and XML parser that provides significant performance enhancements.</p>
+ <p>Default liaison and XML parser.</p>
</s2>
<s2 title="Description">
- <p>DOM (Document Object Model) is a standard interface for interacting with XML documents. Xalan fully
- supports this interface. For large XML documents, however, this may involve considerable overhead, since Xalan
+ <p>DOM (Document Object Model) is a standard interface for interacting with XML documents. &xslt4j; fully
+ supports this interface. For large XML documents, however, this may involve considerable overhead, since &xslt4j;
must create one or more Java objects for each Node in the document.</p>
- <p>For those cases where your input and output are URLS, files, or streams, and you use the default Liaison
- {@link org.apache.xalan.xpath.dtm.DTMLiaison} and XML parser {@link org.apache.xalan.xpath.dtm.DTM}, Xalan avoids
- this overhead by implementing a pseudo-DOM that uses integer arrays in place of the DOM. For larger input and output
- trees, the performance improvements can be very significant.</p>
+ <p>For the majority of cases -- your input and output are URLS, files, or streams, and you use the default Liaison
+ {@link org.apache.xalan.xpath.dtm.DTMLiaison} and XML parser {@link org.apache.xalan.xpath.dtm.DTM} -- &xslt4j; avoids
+ this overhead by implementing the Document Table Model (DTM), a pseudo-DOM that uses integer arrays in place of the DOM.
+ For larger input and output trees, the performance improvements can be very significant.</p>
</s2>
<s2 title="Usage">
<p>To use the high performance DTMLiaison and parser, instantiate the {@link org.apache.xalan.xslt.XSLTProcessor} as
follows:</p>
<p><code>org.apache.xalan.xslt.XSLTProcessor xsltProc = org.apache.xalan.xslt.XSLTProcessorFactory.getProcessor();
</code></p>
- <p>When your are providing input or writing output in the form of a DOM Node, instantiate the XSLTProcessor to use
- {@link org.apache.xalan.xpath.xdom.XercesLiaison} and the Xerces DOM parser:</p>
+ <p>When your provide input or write output in the form of a DOM Node, the XSLTProcessor switches to
+ {@link org.apache.xalan.xpath.xdom.XercesLiaison} and the Xerces DOM parser. You can explicitly instantiate an
+ XSLTProcesssor to use XercesLiaison and the Xerces DOM parser as follows:</p>
<p><code>org.apache.xalan.xsltXSLT.Processor xsltProc = org.apache.xalan.xslt.XSLTProcessorFactory.getProcessor(</code><br/>
<code> new org.apache.xalan.xpath.xdom.XercesLiaison());</code></p>
</s2>
1.3 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-xdom.xml
Index: org-apache-xalan-xpath-xdom.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-xdom.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- org-apache-xalan-xpath-xdom.xml 2000/02/17 12:51:18 1.2
+++ org-apache-xalan-xpath-xdom.xml 2000/03/06 13:31:48 1.3
@@ -59,7 +59,7 @@
-->
<s1 title="org.apache.xalan.xpath.xmldom package">
<s2 title="Summary">
- <p>Contains XercesLiaison, liaison to the Xerces XML parser.</p>
+ <p>Liaison for the Xerces XML parser.</p>
</s2>
<s2 title="Description">
<p>XercesLiaison extends {@link org.apache.xalan.xpath.xml.XMLParserLiaisonDefault}, an implementation
1.3 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-xml.xml
Index: org-apache-xalan-xpath-xml.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath-xml.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- org-apache-xalan-xpath-xml.xml 2000/02/17 12:51:18 1.2
+++ org-apache-xalan-xpath-xml.xml 2000/03/06 13:31:48 1.3
@@ -60,7 +60,7 @@
<s1 title="org.apache.xalan.xpath.xml package">
<s2 title="Summary">
- <p>The infrastructure for working with an XML parser.</p>
+ <p>Infrastructure for working with an XML parser.</p>
</s2>
<s2 title="Description">
<p>An implementation of the {@link org.apache.xalan.xpath.xml.XMLParserLiaison} interface provides a liaison
1.2 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath.xml
Index: org-apache-xalan-xpath.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xpath.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- org-apache-xalan-xpath.xml 2000/02/04 14:39:50 1.1
+++ org-apache-xalan-xpath.xml 2000/03/06 13:31:48 1.2
@@ -59,7 +59,7 @@
-->
<s1 title="org.apache.xalan.xpath package">
<s2 title="Summary">
- <p>Contains the infrastructure for processing XPATH expressions</p>
+ <p>Infrastructure for processing XPATH expressions</p>
</s2>
<s2 title="Description">
<p></p>
1.2 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-client.xml
Index: org-apache-xalan-xslt-client.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-client.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- org-apache-xalan-xslt-client.xml 2000/02/04 14:39:50 1.1
+++ org-apache-xalan-xslt-client.xml 2000/03/06 13:31:48 1.2
@@ -59,7 +59,7 @@
-->
<s1 title="org.apache.xalan.xslt.client package">
<s2 title="Summary">
- <p>Contains a simple applet for hosting the Xalan processor.</p>
+ <p>Non-visual applet for hosting the &xslt4j; processor.</p>
</s2>
<s2 title="Description">
<p>To perform transformations from an HTML client, do the following:</p>
1.3 +3 -2 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-extensions.xml
Index: org-apache-xalan-xslt-extensions.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-extensions.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- org-apache-xalan-xslt-extensions.xml 2000/02/17 12:51:18 1.2
+++ org-apache-xalan-xslt-extensions.xml 2000/03/06 13:31:48 1.3
@@ -59,10 +59,11 @@
-->
<s1 title="org.apache.xalan.xslt.extensions package">
<s2 title="Summary">
- <p>&xslt4j; supports the creation and use of extension elements and extension functions, which may be implemented in Java,
- JavaScript, or another scripting language.</p>
+ <p>Extension for redirecting transformation ouput to multiple files.</p>
</s2>
<s2 title="Description">
+ <p>&xslt4j; supports the creation and use of extension elements and extension functions, which may be implemented in Java,
+ JavaScript, or another scripting language.</p>
<p>This package includes our own proprietary extensions. For more information on extensions, see
<resource-ref idref="ext_fr_jindex_o_a_x_x_ext"/>.</p>
</s2>
1.4 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-trace.xml
Index: org-apache-xalan-xslt-trace.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt-trace.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- org-apache-xalan-xslt-trace.xml 2000/02/25 16:19:30 1.3
+++ org-apache-xalan-xslt-trace.xml 2000/03/06 13:31:48 1.4
@@ -59,7 +59,7 @@
-->
<s1 title="org.apache.xalan.xslt.trace package">
<s2 title="Summary">
- <p>Contains a debugging interface for &xslt4j;.</p>
+ <p>&xslt4j; debugging interface.</p>
</s2>
<s2 title="Description">
<ul>
1.4 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt.xml
Index: org-apache-xalan-xslt.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xalan-xslt.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- org-apache-xalan-xslt.xml 2000/02/29 19:55:09 1.3
+++ org-apache-xalan-xslt.xml 2000/03/06 13:31:48 1.4
@@ -59,7 +59,7 @@
-->
<s1 title="org.apache.xalan.xslt package">
<s2 title="Summary">
- <p><em>This is the main Xalan package.</em></p>
+ <p><em>The main &xslt4j; package</em> -- facilities for setting up and performing XSL transformations.</p>
</s2>
<s2 title="Description">
<p>Use one of the {@link org.apache.xalan.xslt.XSLTProcessorFactory} static getProcessor methods to
1.2 +1 -1 xml-xalan/xdocs/sources/xalan/org-apache-xml-serialize.xml
Index: org-apache-xml-serialize.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/org-apache-xml-serialize.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- org-apache-xml-serialize.xml 2000/02/04 14:39:50 1.1
+++ org-apache-xml-serialize.xml 2000/03/06 13:31:48 1.2
@@ -64,6 +64,6 @@
</s2>
<s2 title="Description">
<p>Eventually the tools in this package will replace the FormatterToDOM, FormatterToHTML,
- FormatterToText, and FormatterToXML classes in the org.apache.xalan.xpath.xml package.</p>
+ FormatterToText, and FormatterToXML classes in the {@link org.apache.xalan.xpath.xml} package.</p>
</s2>
</s1>
1.9 +3 -3 xml-xalan/xdocs/sources/xalan/overview.xml
Index: overview.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/overview.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- overview.xml 2000/03/01 18:24:33 1.8
+++ overview.xml 2000/03/06 13:31:48 1.9
@@ -67,9 +67,9 @@
<li><link anchor="glossary">Glossary</link></li>
</ul><anchor name="intro"/>
<s2 title="Introduction">
- <p>&xslt4j; (named after a rare musical instrument) fully implements the <resource-ref idref="XSLT"/>.
- XSLT is the first part of the XSL stylesheet language for XML. It includes the XSL Transformation vocabulary and the
- <resource-ref idref="XPath"/>, a language for addressing parts of XML documents. For links to background materials,
+ <p>&xslt4j; (named after a rare musical instrument) fully implements the <resource-ref idref="XSLT"/> and the
+ <resource-ref idref="XPath"/>. XSLT is the first part of the XSL stylesheet language for XML. It includes the XSL
+ Transformation vocabulary and XPath, a language for addressing parts of XML documents. For links to background materials,
discussion groups, frequently asked questions, and tutorials on XSLT, see <link anchor="uptospeed">Getting up
to speed with XSLT</link>.</p>
<note>XSL also includes a vocabulary for formatting documents, which is still under design and is not part of &xslt4j;.
1.4 +4 -3 xml-xalan/xdocs/sources/xalan/readme.xml
Index: readme.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/readme.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- readme.xml 2000/02/24 22:21:59 1.3
+++ readme.xml 2000/03/06 13:31:48 1.4
@@ -113,7 +113,7 @@
example. Be sure xalan.jar and xerces.jar are on the class path. To recompile (and run!) the class files in the
Servlet subdirectory, the javax.servlet and javax.servlet.http packages must also be on the class path. Sun
distributes these packages in the JSWDK 1.0.1 servlet.jar file.</p>
- <p>After recompiling a sample, you can use the Sun jar utility to place your new .class files in
+ <p>After recompiling a sample, you can use the Sun jar utility to place your new .class files in
xalansamples.jar.</p>
</s3><anchor name="doc"/>
<s3 title="Rebuilding the &xslt4j; documentation">
@@ -134,7 +134,7 @@
<p>If you want to rebuild the documentation without using the GNU build environment, keep the following in
mind:</p>
<ul>
- <li>Be sure stylebook-1.0-b1.jar, xalan.jar, bsf.jar, bsfengines.jar, and xerces.jar are on the class
+ <li>Be sure stylebook-1.0-b2.jar, xalanjdoc.jar, xalan.jar, bsf.jar, bsfengines.jar, and xerces.jar are on the class
path.<br/><br/></li>
<li>To build doc in a build/docs subdirectory, run StyleBook from the xdocs directory as follows:<br/><br/>
<code>java org.apache.stylebook.StyleBook "targetDirectory=../build/docs/" sources/xalanLocal.xml style</code>
@@ -145,7 +145,8 @@
<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 -overview ../src/javadocOverview.html -sourcepath ../src org.apache.xalan.xpath org.apache.xalan.xpath.xdom org.apache.xalan.xpath.dtm org.apache.xalan.xpath.xml org.apache.xalan.xslt org.apache.xalan.xslt.trace org.apache.xalan.xslt.client org.apache.xalan.xslt.extensions -windowtitle Xalan -d ../build/docs/apidocs</code></li>
+<code>-doclet xalanjdoc.Standard -public -overview ../src/javadocOverview.html -sourcepath ../src -group "XSLT Packages" "org.apache.xalan.xslt*" -group "XPath Packages" "org.apache.xalan.xpath*" org.apache.xalan.xpath org.apache.xalan.xpath.xdom org.apache.xalan.xpath.dtm org.apache.xalan.xpath.xml org.apache.xalan.xslt org.apache.xalan.xslt.trace org.apache.xalan.xslt.client org.apache.xalan.xslt.extensions -windowtitle Xalan -d ../build/docs/apidocs
+</code></li>
</ul>
</s3>
</s2><anchor name="contact"/>
1.7 +11 -16 xml-xalan/xdocs/sources/xalan/resources.xml
Index: resources.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/resources.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- resources.xml 2000/03/01 18:24:33 1.6
+++ resources.xml 2000/03/06 13:31:48 1.7
@@ -51,14 +51,6 @@
<resource id="SamplesDir" title="'samples' directory" location="Samples"/>
<resource id="ReadMeProductionDir" title="'readme_production' directory" location="../production"/>
<resource id="SourceCodeDir" title="'xml-xalan/src' directory" location="../src"/>
- <resource id="run_sh" title="run.sh" location="run.sh"/>
- <resource id="xml4j16_test_sh" title="testSuite/xml4j1tx/test.sh" location="testSuite/xml4j1tx/test.sh"/>
- <resource id="xml4j2tx_test_sh" title="testSuite/xml4j2tx/test.sh" location="testSuite/xml4j2tx/test.sh"/>
- <resource id="xml4j2dom_test_sh" title="testSuite/xml4j2dom/test.sh" location="testSuite/xml4j2dom/test.sh"/>
- <resource id="TestSuiteDir" title="'testSuite' directory" location="testSuite"/>
- <resource id="TestWithXML4J14SuiteDir" title="'testSuite\xml4j1tx' directory" location="testSuite\xml4j1tx"/>
- <resource id="TestWithXML4J2DOMSuiteDir" title="'testSuite\xml4j2dom' directory" location="testSuite\xml4j2dom"/>
- <resource id="TestWithXML4J2TXSuiteDir" title="'testSuite\xml4j2tx' directory" location="testSuite\xml4j2tx"/>
<resource id="APIOverview" title="API Overview" location="api.html"/>
<resource id="APIDocumentationDir" title="'apidocs' directory" location="apidocs"/>
@@ -66,6 +58,7 @@
<resource id="APIDocumentation" title="API Documentation" location="apidocs/index.html"/>
<resource id="ReadmeDocumentation" title="Release Notes" location="readme.html"/>
<resource id="readme.xml" title="XML version of the Readme file" location="../docs/readme.xml"/>
+
<human-resource id="xalandev" name="Xalan Development Mailing List" mailto="xalan-dev@xml.apache.org"/>
<human-resource id="sboag" name="Scott Boag" mailto="scott_boag@lotus.com"/>
<human-resource id="dnbertoni" name="David N. Bertoni" mailto="david_n_bertoni@lotus.com"/>
@@ -77,20 +70,22 @@
<human-resource id="sanjiva" name="Sanjiva Weerawarana" mailto="sanjiva@watson.ibm.com"/>
<human-resource id="dday" name="Don Day" mailto="dond@us.ibm.com"/>
-<resource id="TestLXSLDoc" title="TestLXSL Documentation" location="TestLXSL\index.html"/>
<resource id="SAX" title="SAX" location="http://www.megginson.com/SAX/sax.html"/>
<resource id="SAXDocumentHandler" title="org.xml.sax.DocumentHandler" location="http://www.megginson.com/SAX/javadoc/org.xml.sax.DocumentHandler.html#_top"/>
<!--Javadoc methods-->
+<resource id="XSLTProcessorFactoryGetProcessorDoc" title="XSLTProcessorFactory static getProcessor() method"
+location="apidocs/org/apache/xalan/xslt/XSLTProcessorFactory.html#getProcessor()"/>
<resource id="XSLTProcessorProcessDoc" title="XSLTProcessor process() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#process(org.apache.xalan.xslt.XSLTInputSource, org.apache.xalan.xslt.XSLTInputSource, org.apache.xalan.xslt.XSLTResultTarget)"/>
-<resource id="XSLTProcessorProcessStylesheetDoc" title="processStylesheet method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#processStylesheet(java.lang.String)"/>
-<resource id="XSLTProcessorSetStylesheetParamDoc" title="setStylesheetParam method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#setStylesheetParam(java.lang.String, java.lang.String)"/>
-<resource id="XSLTProcessorCreateXString" title="createXString method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXString(java.lang.String)"/>
-<resource id="XSLTProcessorCreateXObject" title="createXObject method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXObject(java.lang.Object)"/>
-<resource id="XSLTProcessorCreateXNumber" title="createXNumber method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNumber(double)"/>
-<resource id="XSLTProcessorCreateXBoolean" title="createXBoolean method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXBoolean(boolean)"/>
+<resource id="StylesheetRootProcessDoc" title="StylesheetRoot process() method" location="apidocs/org/apache/xalan/xslt/StylesheetRoot.html#process(org.apache.xalan.xslt.XSLTInputSource, org.apache.xalan.xslt.XSLTResultTarget)"/>
+<resource id="XSLTProcessorProcessStylesheetDoc" title="XSLTProcessor processStylesheet() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#processStylesheet(java.lang.String)"/>
+<resource id="XSLTProcessorSetStylesheetParamDoc" title="setStylesheetParam() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#setStylesheetParam(java.lang.String, java.lang.String)"/>
+<resource id="XSLTProcessorCreateXString" title="createXString() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXString(java.lang.String)"/>
+<resource id="XSLTProcessorCreateXObject" title="createXObject() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXObject(java.lang.Object)"/>
+<resource id="XSLTProcessorCreateXNumber" title="createXNumber() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNumber(double)"/>
+<resource id="XSLTProcessorCreateXBoolean" title="createXBoolean() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXBoolean(boolean)"/>
<resource id="XSLTProcessorCreateXNodeSet" title="createXNodeSet(NodeList nl) method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNodeSet(org.w3c.dom.NodeList)"/>
<resource id="XSLTProcessorCreateXNodeSet2" title="createXNodeSet(Node n) method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNodeSet(org.w3c.dom.Node)"/>
-<resource id="XSLTProcessorCreateXNull" title="createXNull method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNull()"/>
+<resource id="XSLTProcessorCreateXNull" title="createXNull() method" location="apidocs/org/apache/xalan/xslt/XSLTProcessor.html#createXNull()"/>
<resource id="XSLTProcessorApplettransformtoHTMLstringstringDoc" title="XSLTProcessorApplet transformToHTML() method" location="apidocs/org/apache/xalan/xslt/client/XSLTProcessorApplet.html#transformToHtml(java.lang.String, java.lang.String)"/>
<resource id="XSLTProcessorAppletsetDocumentURLDoc" title="XSLTProcessorApplet setDocumentURL() method" location="apidocs/org/apache/xalan/xslt/client/XSLTProcessorApplet.html#setDocumentURL(java.lang.String)"/>
<resource id="XSLTProcessorAppletsetStyleURLDoc" title="XSLTProcessorApplet setStyleURL() method" location="apidocs/org/apache/xalan/xslt/client/XSLTProcessorApplet.html#setStyleURL(java.lang.String)"/>
1.8 +20 -8 xml-xalan/xdocs/sources/xalan/samples.xml
Index: samples.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/samples.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- samples.xml 2000/03/01 18:24:33 1.7
+++ samples.xml 2000/03/06 13:31:48 1.8
@@ -12,7 +12,8 @@
<li><link anchor="transformtodom">TransformToDom</link></li>
<li><link anchor="usestylesheetparam">UseStylesheetParam</link></li>
<li><link anchor="xpath">ApplyXPath</link></li>
-<li><link anchor="pipe">Pipe (SAX)</link></li>
+<li><link anchor="pipe">Pipe</link></li>
+<li><link anchor="sax">PureSAX</link></li>
<li><link anchor="extensions">Extensions</link></li>
<li><link anchor="appletxmltohtml">AppletXMLtoHTML</link></li>
<li><link anchor="servlet">Servlet</link></li>
@@ -63,8 +64,10 @@
<p>where <ref>param</ref> is the stylesheet parameter (a string of your choice).</p>
</s2><anchor name="xpath"/>
<s2 title="ApplyXPath">
- <p>What it does: The ApplyXPath class executes an XPath expression against an XML document and returns
- information about the route it takes and the nodes (if any) it finds.</p>
+ <p>What it does: The ApplyXPath class uses the XPathAPi class to execute an XPath expression against an XML document
+ and returns the nodes (if any) it finds. XPathAPI contains some convenience methods for using XPath expressions to return
+ single Nodes, NodeLists, and XObjects. In the future, we plan to incorporate user feedback and move these methods into the
+ core API.</p>
<note>You can use this sample as an aid when you want to find out what a given XPath expression returns from a
given XML file. Keep in mind that the context node (base point of evaluation) for the XPath expression is the document
root.</note>
@@ -76,8 +79,10 @@
<p><code>java ApplyXPath foo.xml /</code></p>
<p>and</p>
<p><code>java ApplyXPath foo.xml /doc/name/@first</code></p>
+ <p>If you are interested in the API for executing XPath expressions, we suggest you take a look at the methods in XPathAPI,
+ and send us feedback on what best meets your needs.</p>
</s2><anchor name="pipe"/>
- <s2 title="Pipe (SAX)">
+ <s2 title="Pipe">
<p>What it does: The Pipe class uses the output of the first transformation as input to a second
transformation.</p>
<p>The first transformation produces a sequence of SAX events which the second transformation processes with
@@ -85,8 +90,14 @@
for the entire result tree to be constructed (as the DOM consumer must do).</p>
<p>Run this sample from the Pipe subdirectory with</p>
<p><code>java Pipe</code></p>
- <p>For other examples using the SAX document handler, see <link idref="getstarted" anchor="sax">Generating and
- responding to SAX events</link>.</p>
+ <p>For other examples using the SAX document handler, see the next section and <link idref="getstarted"
+ anchor="sax">Generating and responding to SAX events</link>.</p>
+ </s2><anchor name="sax"/>
+ <s2 title="PureSAX">
+ <p>What it does: The PureSAX class uses SAX DocumentHandlers and the Xerces SAX parser to produce a stylesheet tree,
+ an XML input tree, and the transformation result tree.</p>
+ <p>Run this sample from the PureSax subdirectory with</p>
+ <p><code>java PureSAX</code></p>
</s2><anchor name="extensions"/>
<s2 title="Extensions">
<p>The extensions subdirectory contains four samples with &xslt4j; extensions. Two of the samples use
@@ -130,8 +141,9 @@
</ol>
<p>Examples:</p>
<gloss>
-<label>http://localhost/servlet/DefaultApplyXSL?URL=/data.xml&xslURL=/style.xsl</label>
-<item>...applies the style.xsl stylesheet to the data.xml data. Both files are
+<label>http://localhost/servlet/DefaultApplyXSL?URL=/data.xml&xslURL=
+/style.xsl</label>
+<item>...applies the style.xsl stylesheet to the data.xml data. Both files are<br/>
served from the Web server's HTTP XSLTInputSource root.<br/><br/></item>
<label>http://localhost/servlet/DefaultApplyXSL?URL=/data.xml&xslURL=
/style.xsl&debug=true</label>
1.6 +6 -2 xml-xalan/xdocs/sources/xalan/usagepatterns.xml
Index: usagepatterns.xml
===================================================================
RCS file: /home/cvs/xml-xalan/xdocs/sources/xalan/usagepatterns.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- usagepatterns.xml 2000/03/01 18:24:34 1.5
+++ usagepatterns.xml 2000/03/06 13:31:48 1.6
@@ -261,10 +261,14 @@
intermedResult);
}
}</source>
-<p>For a more compact (and elegant) form of this example, see the <link idref="samples" anchor="pipe">Pipe</link>.</p>
+<p>For a more compact (and elegant) form of this example, see the <link idref="samples" anchor="pipe">Pipe</link>. For an example that uses SAX DocumentHandlers and the Xerces SAX parser to parse the XML input and XSL stylesheet and produce the transformation result, see the <link idref="samples" anchor="sax">PureSAX</link>.</p>
</s2><anchor name="xpath"/>
<s2 title="Working with XPath expressions">
-<p>XSL stylesheets use XPath expressions to select nodes, specify conditions, and generate text for the result tree. XPath provides an API that you can call directly. For example, you may want to select nodes programatically and do your own processing without a stylesheet. For an example that executes individual XPath expressions against XML source files, see <link idref="samples" anchor="xpath">ApplyXPath</link>.</p>
+<p>XSL stylesheets use XPath expressions to select nodes, specify conditions, and generate text for the result tree. XPath provides an API that you can call directly. For example, you may want to select nodes programatically and do your own processing without a stylesheet.</p>
+<p>The XPathAPI class, in the samples/ApplyXPath subdirectory, contains several convenience methods that you can use to return single DOM Nodes, NodeLists, and XObjects. In the future, we plan to incorporate user feedback and move these methods into the core API.</p>
+<p>If you are interested in the API for executing XPath expressions, we suggest you take a look at the methods in XPathAPI,
+and send us feedback on what best meets your needs.</p>
+<p>For an example that uses the XPathAPI convenience methods to execute XPath expressions against XML source files, see <link idref="samples" anchor="xpath">ApplyXPath</link>.</p>
</s2><anchor name="applet"/>
<s2 title="Using the &xslt4j; applet wrapper">
<ol>