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...@apache.org on 2001/01/24 16:36:58 UTC
cvs commit: xml-xalan/java/xdocs/sources/xalan commandline.xml extensions.xml faq.xml getstarted.xml readme.xml samples.xml usagepatterns.xml
dleslie 01/01/24 07:36:56
Modified: java/xdocs/sources/xalan commandline.xml extensions.xml
faq.xml getstarted.xml readme.xml samples.xml
usagepatterns.xml
Log:
Spell checking updates.
Revision Changes Path
1.9 +3 -3 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.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- commandline.xml 2001/01/11 18:31:25 1.8
+++ commandline.xml 2001/01/24 15:36:34 1.9
@@ -69,9 +69,9 @@
do the following:</p>
<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 (or another conformat XMLReader -- see <link idref="usagepatterns" anchor="xmlreader">Setting the
- XMLReader</link>).<br/><br/></li>
+ <li><link idref="getstarted" anchor="classpath">Set the Java classpath</link> to include xalan.jar and
+ xerces.jar (or another conformant XML Parser -- see <link idref="usagepatterns" anchor="plug">Plugging in
+ the Transformer and XML parser</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
1.12 +2 -2 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.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- extensions.xml 2001/01/11 18:31:26 1.11
+++ extensions.xml 2001/01/24 15:36:36 1.12
@@ -29,7 +29,7 @@
</s2><anchor name="supported-lang"/>
<s2 title="Supported languages">
<p>Extensions written in Java are directly supported by &xslt4j;. For extensions written in languages other than Java, &xslt4j; uses the <jump href="http://www.alphaworks.ibm.com/tech/bsf">Bean Scripting Framework (BSF)</jump>, an architecture for incorporating scripting into Java applications and applets. BSF allows an application to take advantage of scripting while being independent of any specific scripting language. To date, we have tested extensions implemented in JavaScript. Other languages with BSF support appear in the table below.</p>
-<p>BSF requires bsf.jar on the class path. This JAR file is shipped with &xslt4j; and is required only if you have extensions written in languages other than Java. The additional JAR files or DLLs required to support extensions written in other languages are listed in the table below. These files are available from the sources indicated and are not shipped with &xslt4j;.</p>
+<p>BSF requires bsf.jar on the classpath. This JAR file is shipped with &xslt4j; and is required only if you have extensions written in languages other than Java. The additional JAR files or DLLs required to support extensions written in other languages are listed in the table below. These files are available from the sources indicated and are not shipped with &xslt4j;.</p>
<table>
<tr>
<td><em>Language</em></td>
@@ -138,7 +138,7 @@
</source>
</s2><anchor name="setup-runtime"/>
<s2 title="Setting up the runtime environment">
-<p>To run the preceding example, bsf.jar and js.jar must be on the class path. Remember that bsf.jar must be on the class path to run any extension written in a language other than Java. For extensions implemented in a scripting language, see the additional requirements in <link anchor="supported-lang">Supported languages</link>.</p>
+<p>To run the preceding example, bsf.jar and js.jar must be on the classpath. Remember that bsf.jar must be on the classpath to run any extension written in a language other than Java. For extensions implemented in a scripting language, see the additional requirements in <link anchor="supported-lang">Supported languages</link>.</p>
</s2><anchor name="basic-syntax"/>
<s2 title="Syntax">
<p>You can always use the pattern illustrated above to set up and use extension elements and extension functions. For extension elements and functions implemented in Java, you can also use an abbreviated syntax, described in <link anchor="java-namespace">Alternative: using the abbreviated syntax for extensions implemented in Java</link>. Unless you are using the abbreviated syntax, do the following:</p>
1.2 +6 -6 xml-xalan/java/xdocs/sources/xalan/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/faq.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.xml 2001/01/23 22:07:20 1.1
+++ faq.xml 2001/01/24 15:36:38 1.2
@@ -13,7 +13,7 @@
<faq title="Which version of Xerces should I be using?">
<q>Which version of Xerces should I be using?</q>
- <a><p>&xslt4j-current; has been tested with &xml4j-used;. See <link idref="readme" anchor="status">Status</link></p></a>
+ <a><p>&xslt4j-current; has been tested with &xml4j-used;. See <link idref="readme" anchor="status">Status</link>.</p></a>
</faq>
<faq title="Compatibility with &xslt4j; version 1">
@@ -76,22 +76,22 @@
<faq title="NoClassDefFound errors">
- <q>I'm getting a NoClassDefFound error. What has to be on the class path?</q>
+ <q>I'm getting a NoClassDefFound error. What has to be on the classpath?</q>
<a><ol>
- <li>xalan.jar and xerces.jar (or the XML parser you are using) must always be on the class path.<br/><br/></li>
- <li>To run the samples in the samples subdirectories, xalansamples.jar must be on the class path. To run the servlet (in
+ <li>xalan.jar and xerces.jar (or the XML parser you are using) must always be on the classpath.<br/><br/></li>
+ <li>To run the samples in the samples subdirectories, xalansamples.jar must be on the classpath. To run the servlet (in
samples/servlet), xalanservlet.jar must be on the classpath along with the javax.servlet and javax.servlet.http packages. Sun distributes
the javax.servlet packages in the JSWDK servlet.jar file.<br/><br/></li>
<li>To run extensions (including the samples in samples/extensions), bsf.jar, and bsfengines.jar must be on the
- class path. To run extensions implemented in JavaScript, js.jar must also be on the class path. For information on what
+ classpath. To run extensions implemented in JavaScript, js.jar must also be on the classpath. For information on what
you need to run extensions implemented in other scripting languages, see <link idref="extensions"
anchor="supported-lang">Supported languages</link>.<br/><br/></li>
<li>To run applications that use the &xslt4j; version 1 API, you must put xalanj1compat.jar on the classpath, recompile the application,
and be sure xalanj1compat.jar is on the classpath at run time (see <link idref="usagepatterns" anchor="compat">Using the &xslt4j; version 1
API)</link>.</li>
</ol>
- <p>For more information, see <link idref="getstarted" anchor="classpath">Setting up the system class path</link>.</p></a>
+ <p>For more information, see <link idref="getstarted" anchor="classpath">Setting up the system classpath</link>.</p></a>
</faq>
1.11 +6 -6 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.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- getstarted.xml 2001/01/11 18:31:27 1.10
+++ getstarted.xml 2001/01/24 15:36:39 1.11
@@ -4,7 +4,7 @@
<s1 title="Getting Started">
<ul>
<li><link anchor="download">Downloading what you need</link></li>
-<li><link anchor="classpath">Setting up the system class path</link></li>
+<li><link anchor="classpath">Setting up the system classpath</link></li>
<li><link anchor="samples">Trying out the samples</link></li>
<li><link anchor="commandline">Performing your own transformations from the command line</link></li>
<li><link anchor="java-apps">Setting up your own XSLT applications</link></li>
@@ -22,16 +22,16 @@
<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 (or another conformant XML parser -- see <link idref="usagepatterns" anchor="plug">Plugging in a Transformer and XML parser</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 title="Setting up the system classpath">
+<p>At the very minimum, you must include xalan.jar and xerces.jar (or another conformant XML parser -- see <link idref="usagepatterns" anchor="plug">Plugging in a Transformer and XML parser</link>) on the system classpath. 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 classpath and where you can get them.</p>
+<p>If you are using JDK or JRE 1.1.8, also include classes.zip on the classpath.</p>
<note>If you are using xerces.jar from a Xerces release that is more recent than &xml4j-used;, you may need to put xerces.jar before xalan.jar on the classpath. Both JAR files include the org.w3c.dom packages. The Xerces team is tracking updates to DOM level 2, and the Xerces parser may require access to updates in these packages.</note>
</s2><anchor name="samples"/>
<s2 title="Trying out the samples">
<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 and (for the servlet) xalanservlet.jar.</li>
+<li>Set up your classpath (see above), including xalansamples.jar and (for the servlet) xalanservlet.jar.</li>
<li>Be sure the java executable is on your path.</li>
<li>Go to the samples subdirectory containing the sample (use the DOS shell if you are running Windows).</li>
<li>Use the java executable to run the sample from the command line.</li>
@@ -40,7 +40,7 @@
<p>For example, go to the SimpleTransform subdirectory and issue the following command:</p>
<p><code>java SimpleTransform</code></p>
<p>The sample writes the transformation result to a file (birds.out). To see how the example works, examine the source files: birds.xml, birds.xsl, and SimpleTransform.java.</p>
-<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>
+<p>The extensions examples require additional JAR files on the classpath, 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 several of the extensions samples. The command line for most standard transformations is as follows:</p>
1.21 +5 -5 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.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- readme.xml 2001/01/19 14:35:59 1.20
+++ readme.xml 2001/01/24 15:36:41 1.21
@@ -84,7 +84,7 @@
<ul>
<li>Handling xsl:namespace-alias declarations: In release 2.0.D01, we reported the need to do some research concerning exactly how Xalan
should handle xsl:namespace-alias declarations. As a result of discussions among members of the W3C Working Group on XSL, we have reached a
- more precise concensus on how namespaces should be represented when an xsl:namespace-alias declaration is in effect.<br/><br/>
+ more precise consensus on how namespaces should be represented when an xsl:namespace-alias declaration is in effect.<br/><br/>
If a literal result element has a namespace prefix, the prefix will be preserved and the namespace URI of the element will be as
specified in the xsl:namespace-alias element, but the result-prefix is not required to appear in the result. This also applies to the
two other cases of "Literal namespace URI" mentioned in the XSLT Recommendation on
@@ -124,7 +124,7 @@
<p>For a list of goals, tasks, and target dates for completion, see <jump href="todo.html">Xalan-Java Version 2: Things To Do</jump>.
As tasks are completed, they are moved from the to-do list to
<jump href="todo.html#release-date-completed">Completed</jump>.</p>
- <p>The source document for the todo list is an active document in the Apache CVS repository:
+ <p>The source document for the to-do list is an active document in the Apache CVS repository:
<jump href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xalan/java/todo.xml">xml-xalan/java/todo.xml</jump>.</p>
</s3>
</s2>
@@ -178,7 +178,7 @@
Ant</link>.</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>Set the classpath 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
tree. </li>
<li>Use the Sun jar utility to store the resulting .class files in xalan.jar</li>
@@ -186,8 +186,8 @@
</s3><anchor name="samples"/>
<s3 title="Rebuilding a sample application">
<p>If you modify a sample and want to recompile it, you can run the Java compiler in the directory containing the
- 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
+ example. Be sure xalan.jar and xerces.jar are on the classpath. To recompile (and run!) the class files in the
+ Servlet subdirectory, the javax.servlet and javax.servlet.http packages must also be on the classpath. 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
xalansamples.jar.</p>
1.23 +7 -7 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.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- samples.xml 2001/01/12 17:30:35 1.22
+++ samples.xml 2001/01/24 15:36:43 1.23
@@ -85,7 +85,7 @@
<li>Go to the samples subdirectory containing the sample (use the DOS shell if you are running Windows).</li>
<li>Run the sample from the command line (as indicated below)</li>
<li>Examine the application source files. You may also want to modify the source files. Remember that if you
- modify a java file, you must recompile the class and place it on the class path before you can run the
+ modify a java file, you must recompile the class and place it on the classpath before you can run the
modified application.</li>
</ol>
<p>The basic command line for running most of the samples is </p>
@@ -103,7 +103,7 @@
<p><code>java SimpleTransform</code></p>
</s2><anchor name="usestylesheetpi"/>
<s2 title="UseStylesheetPI">
- <p>What it does: The UseStylesheetPI class uses the styesheet processing instruction in the XML source document to determine
+ <p>What it does: The UseStylesheetPI class uses the stylesheet processing instruction in the XML source document to determine
which stylesheet to use to perform the transformation.</p>
<p>You can run it from the UseStylesheetPI subdirectory with</p>
<p><code>java UseStylesheetPI</code></p>
@@ -124,7 +124,7 @@
<s2 title="DOM2DOM">
<p>What it does: the DOM2DOM class uses the birds.xsl stylesheet to transform a DOM Document generated from birds.xml,
produces an output DOM, and traverses the DOM, printing the traversal to System.out. In contrast to SimpleTransform,
- DomToDom illustrates the procedure for processing an input DOM and creating an output DOM that is available for
+ DOM2DOM illustrates the procedure for processing an input DOM and creating an output DOM that is available for
further processing.</p>
<p>You can run it from the DOM2DOM subdirectory with</p>
<p><code>java DOM2DOM</code></p>
@@ -231,8 +231,8 @@
extensions implemented in JavaScript, and four of the samples use extensions implemented in Java.</p>
<p>To run these examples, you must place bsf.jar (distributed with &xslt4j;), and js.jar
(version 1.5, available from
- <jump href="http://www.mozilla.org/rhino">http://www.mozilla.org/rhino</jump>) on the class path.
- You do not need js.jar on the class path for the samples that use Java extensions. </p>
+ <jump href="http://www.mozilla.org/rhino">http://www.mozilla.org/rhino</jump>) on the classpath.
+ You do not need js.jar on the classpath for the samples that use Java extensions. </p>
<p>Use java.org.apache.xalan.xslt.Process, the &xslt4j; command-line utility, to run most of these samples from
the <link idref="commandline">command line</link>. The command line must include an -in flag with the
XML source and an -xsl flag with the XSL stylesheet. If you want the output to be written to a file, rather
@@ -290,9 +290,9 @@
<jump href="http://instantdb.enhydra.org/software/documentation/index.html">InstantDB</jump>
and the <jump href="http://instantdb.enhydra.org/software/license/index.html">Enydra Public
License</jump>.</note>
- <p>Run this sample from the extensions subdirectory with (adjust the Windows CLASSPATH setting
+ <p>Run this sample from the extensions subdirectory with (adjust the Windows classpath setting
below for your operating environment):</p>
- <p><code>java -cp instantdb/idb.jar;%CLASSPATH%</code>
+ <p><code>java -cp instantdb/idb.jar;%classpath%</code>
<br/> org.apache.xalan.xslt.Process<code></code>
<br/> <code>-xsl 6-sqllib-instantdb.xsl -out import1.html</code></p>
</s3>
1.24 +4 -4 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.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- usagepatterns.xml 2001/01/23 22:06:46 1.23
+++ usagepatterns.xml 2001/01/24 15:36:44 1.24
@@ -60,7 +60,7 @@
<ul>
<li><link anchor="basic">Basic steps</link></li>
<li><link anchor="plug">Plugging in the Transformer and XML parser</link></li>
-<li><link anchor="outputprops">Setting output properties in your styleshets</link></li>
+<li><link anchor="outputprops">Setting output properties in your stylesheets</link></li>
<li><link anchor="embed">Working with embedded stylesheets</link></li>
<li><link anchor="params">Setting stylesheet parameters</link></li>
<li><link anchor="serialize">Serializing output</link></li>
@@ -133,7 +133,7 @@
<li>Set the system property in jaxp.properties in the JAVA_HOME/lib directory, where JAVA_HOME is the root of the JDK.<br/><br/></li>
<li>Revise the entry in src/META-INF/services and rebuild xalan.jar.<br/><br/></li>
</ol>
-<p>For more information about the mechanism used to determine system property values and how you can plug other implementations into your applications, see "Section 3: Pluggability Layer" in the <ref>Java API for XML Processing</ref> at
+<p>For more information about the mechanism used to determine system property values and how you can plug other implementations into your applications, see "Section 3: Plugability Layer" in the <ref>Java API for XML Processing</ref> at
<jump href="http://java.sun.com/aboutJava/communityprocess/review/jsr063/index.html">JSR-000063 1.1</jump>.</p>
</s2><anchor name="outputprops"/>
<s2 title="Setting output properties in your stylesheets">
@@ -368,7 +368,7 @@
<s2 title="Multithreading">
<p>A given Templates object may be used repeatedly and even in multiple threads running concurrently for the transformation of XML input, but you should use the Templates object to instantiate a separate Transformer for each transformation you perform. The Templates object is an immutable runtime representation of the structure and content of a stylesheet (which may include and import multiple stylesheet sources). A Transformer, on the other hand, is a lightweight object that tracks state information during the transformation, and should only be used to perform a single transformation.</p>
-<p>If you want to perform multiple transformations (sequentialy or concurrently) with the same stylesheet instructions, do the following:</p>
+<p>If you want to perform multiple transformations (sequentially or concurrently) with the same stylesheet instructions, do the following:</p>
<ol>
<li>Use the TransformerFactory <jump href="apidocs/javax/xml/transform/TransformerFactory.html#newTemplates(javax.xml.transform.Source)">newTemplates(Source xslSource)</jump> method to create a Templates object.<br/><br/></li>
<li>For each transformation, use the Templates object <jump href="apidocs/javax/xml/transform/Templates.html#newTransformer()">newTransformer()</jump> method to create a Transformer, and use that Transformer's <jump href="apidocs/javax/xml/transform/Transformer.html#transform(javax.xml.transform.Source, javax.xml.transform.Result)">transform(Source xmlSource, Result transformResult)</jump> method to perform the transformation.</li>
@@ -449,6 +449,6 @@
<li>Recompile your application. It it does not compile, you may be using Xalan-Java 1.x API that the compatibility layer does not support. <br/><br/></li>
<li>Run the recompiled application with xalanj1compat.jar on the system classpath in front of the Xalan-Java 2 xalan.jar.</li>
</ol>
-<p>We want our Xalan-Java 1.x users to start using Xalan-Java 2. That is where we are concentrating our efforts to improve performance and fix any outstanding bugs. To see what portion of the Xalan-Java 1.x API we have included in xalanj1compat.jar, see <jump href="compat_apidocs/index.html">Xalan-Java 1 compatibility Javadoc</jump>. For example, the compatibility layer does not support the use of Xalan-Java 1.x extensions. If you feel that we should extend our compatibility JAR to support additional Xalan-Java 1.x API calls, please let us know exactly what you would like to see.</p>
+<p>We urge our Xalan-Java 1.x users to start using Xalan-Java 2. That is where we are concentrating our efforts to improve performance and fix any outstanding bugs. To see what portion of the Xalan-Java 1.x API we have included in xalanj1compat.jar, see <jump href="compat_apidocs/index.html">Xalan-Java 1 compatibility Javadoc</jump>. For example, the compatibility layer does not support the use of Xalan-Java 1.x extensions. If you feel that we should extend our compatibility JAR to support additional Xalan-Java 1.x API calls, please let us know exactly what you would like to see.</p>
</s2>
</s1>