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 2002/01/22 18:25:37 UTC
cvs commit: xml-xalan/java/xdocs/sources/xalan commandline.xml faq.xml getstarted.xml history.xml index.xml readme.xml samples.xml usagepatterns.xml
dleslie 02/01/22 09:25:36
Modified: java/xdocs/sources entities.ent
java/xdocs/sources/xalan commandline.xml faq.xml
getstarted.xml history.xml index.xml readme.xml
samples.xml usagepatterns.xml
Log:
Doc updates for 2.3
Revision Changes Path
1.44 +5 -3 xml-xalan/java/xdocs/sources/entities.ent
Index: entities.ent
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/entities.ent,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- entities.ent 17 Jan 2002 20:07:30 -0000 1.43
+++ entities.ent 22 Jan 2002 17:25:36 -0000 1.44
@@ -2,14 +2,16 @@
<!ENTITY xslt4j "Xalan-Java">
<!ENTITY xslt4j2 "Xalan-Java 2">
-<!ENTITY xslt4j-dist "xalan-j_2_2">
+<!ENTITY xslt4j-dist "xalan-j_2_3">
<!ENTITY xslt4j-dist-bin "&xslt4j-dist;-bin">
<!ENTITY xslt4j-dist-src "&xslt4j-dist;-src">
-<!ENTITY xslt4j-current "&xslt4j; version 2.2">
+<!ENTITY xslt4j-current "&xslt4j; version 2.3">
<!ENTITY xslt4j-distdir "http://xml.apache.org/dist/xalan-j/">
<!ENTITY xml4j "Xerces-Java">
+<!ENTITY xml4j1 "Xerces-Java 1">
<!ENTITY xml4j2 "Xerces-Java 2">
-<!ENTITY xml4j-used "&xml4j; version 1.4.4">
+<!ENTITY xml4j-used "&xml4j; version 2.0.beta4">
+<!ENTITY xml4j-jar "xercesImpl.jar (xerces.jar for &xml4j1;)">
<!ENTITY xslt4c "Xalan-C++">
<!ENTITY xml4c "Xerces-C++">
<!ENTITY download "The &xslt4j-current; download from xml.apache.org includes xerces.jar from &xml4j-used;.">
1.15 +1 -1 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.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- commandline.xml 9 Nov 2001 14:44:25 -0000 1.14
+++ commandline.xml 22 Jan 2002 17:25:36 -0000 1.15
@@ -70,7 +70,7 @@
<ol>
<li>Download &xslt4j;.<br/><br/></li>
<li><link idref="getstarted" anchor="classpath">Set the Java classpath</link> to include xalan.jar, xml-apis.jar, and
- xerces.jar (or another conformant XML Parser -- see <link idref="usagepatterns" anchor="plug">Plugging in
+ &xml4j-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,
1.16 +3 -3 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.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- faq.xml 17 Jan 2002 20:07:30 -0000 1.15
+++ faq.xml 22 Jan 2002 17:25:36 -0000 1.16
@@ -28,7 +28,7 @@
Processing. JAXP (including TrAX) provides users a standard, vendor-neutral API for working with (and transforming) XML documents.
You can use this API to build applications that are not bound to the particular implementation details of a given XML parser or XSL
transformer.</p>
- <p>&xslt4j; includes the JAXP packages, implements the TrAX portion of that API (javax.xml.transform....), and includes xerces.jar from
+ <p>&xslt4j; includes the JAXP packages, implements the TrAX portion of that API (javax.xml.transform....), and includes &xml4j-jar; from
&xml4j;, which implements the parser portion of the API (javax.xml.parser....).</p>
<p>For more information, see <link idref="trax">TRaX (Transformation API for XML)</link> and <resource-ref idref="jaxp11"/>.</p></a>
</faq>
@@ -49,7 +49,7 @@
<faq title="Issues running Xalan on JDK 1.3">
<q>I'm having a problem building or running &xslt4j; on the JDK 1.3.</q>
<a><p>The JDK 1.3 automatically places everything in the lib/ext directory in front of everything you place on the classpath. If this directory contains a version of DOM, JAXP, or Xerces that predates the &xslt4j; distribution you are using, you may have problems!</p>
-<p>The IBM JDK 1.3 includes an earlier version of xerces.jar in the lib/ext directory, a version that does not implement the JAXP 1.1 interfaces and therefore does not work with the current Xalan release. Accordingly, you must either purge the xerces.jar that is in that directory or overwrite it with the xerces.jar that is included with the Xalan distribution.</p>
+<p>The IBM JDK 1.3 includes an earlier version of xerces.jar in the lib/ext directory, a version that does not implement the JAXP 1.1 interfaces and therefore does not work with the current Xalan release. Accordingly, you must either purge the xerces.jar that is in that directory or replace it with the &xml4j-jar; that is included with the Xalan distribution.</p>
<p>The SUN JDK 1.3 includes a pre-1.1 version of the JAXP in crimson.jar. Either purge the crimson.jar in that directory or overwrite it with a newer crimson.jar that includes and implements the JAXP 1.1 interfaces.</p></a>
</faq>
<faq title="a "DOM006 Hierarchy request error"">
@@ -97,7 +97,7 @@
<q>I'm getting a NoClassDefFound error. What has to be on the classpath?</q>
<a><ol>
- <li>xalan.jar, xml-apis.jar, and xerces.jar (or the XML parser you are using) must always be on the classpath.<br/><br/></li>
+ <li>xalan.jar, xml-apis.jar, and &xml4j-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>
1.18 +4 -4 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.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- getstarted.xml 8 Nov 2001 19:24:18 -0000 1.17
+++ getstarted.xml 22 Jan 2002 17:25:36 -0000 1.18
@@ -15,18 +15,18 @@
<ul>
<li>The JDK or JRE 1.1.8, 1.2.2, or 1.3</li>
<li>xalan.jar</li>
-<li>xerces.jar (or another <link idref="usagepatterns" anchor="plug">XML Parser</link>)</li>
+<li>&xml4j-jar;, or another <link idref="usagepatterns" anchor="plug">XML Parser</link>)</li>
</ul>
<p>You can get the JDK or JRE from <jump href="http://www.ibm.com/java/jdk">ibm.com/java/jdk/</jump> or <jump href="http://www.java.sun.com">java.sun.com</jump>.</p>
-<p>For the binary distribution, which includes everything required to use and build applications with &xslt4j;, download <resource-ref idref="xslt4j-dist-bin-zip"/> or <resource-ref idref="xslt4j-dist-bin-targz"/>. Both of these files contain <resource-ref idref="xslt4j-current"/> (with xalan.jar) and xerces.jar from <resource-ref idref="xml4j-used"/>. You can use a zip or tar utility to expand these files into a full build.</p>
+<p>For the binary distribution, which includes everything required to use and build applications with &xslt4j;, download <resource-ref idref="xslt4j-dist-bin-zip"/> or <resource-ref idref="xslt4j-dist-bin-targz"/>. Both of these files contain <resource-ref idref="xslt4j-current"/> (with xalan.jar) and &xml4j-jar; from <resource-ref idref="xml4j-used"/>. You can use a zip or tar utility to expand these files into a full build.</p>
<p>If you want the &xslt4j; source files, download <resource-ref idref="xslt4j-dist-src-zip"/> or <resource-ref idref="xslt4j-dist-src-targz"/>. After you expand these files into the complete source tree, you can use <resource-ref idref="ant"/> to do your own builds. For more information, see <link idref="readme" anchor="build">Build notes</link>.</p>
<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 classpath">
-<p>At the very minimum, you must include xalan.jar, xml-apis.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>At the very minimum, you must include xalan.jar, xml-apis.jar, and &xml4j-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. If you are using JDK or JRE 1.2, include tools.jar on the classpath.</p>
-<note>If you are running Xalan on a 1.1.8 platform or recompiling Xalan on any platform, be sure to put xalan.jar and xml-apis.jar in front of xerces.jar on the classpath. Both JAR files include the org.w3c.dom packages. Xerces has added a number of DOM level-3 methods. These are not yet part of the W3C DOM recommendation, and Xalan does not support these methods.</note>
+<note>If you are running Xalan on a 1.1.8 platform or recompiling Xalan on any platform, be sure to put xalan.jar and xml-apis.jar in front of &xml4j-jar; on the classpath. Both JAR files include the org.w3c.dom packages. Xerces has added a number of DOM level-3 methods. These are not yet part of the W3C DOM recommendation, and Xalan does not support these methods.</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>
1.22 +1 -1 xml-xalan/java/xdocs/sources/xalan/history.xml
Index: history.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/history.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- history.xml 17 Jan 2002 20:07:30 -0000 1.21
+++ history.xml 22 Jan 2002 17:25:36 -0000 1.22
@@ -1170,7 +1170,7 @@
is currently a working draft (it is not yet a W3C recommendation), and Xalan does not support these new methods.
To run Xalan in the JDK 1.1.8 platform, you must put xalan.jar (with its DOM level-2 interfaces) in front of
xerces.jar on the system class path. If you want to rebuild Xalan (on JDK 1.1.8 or higher), you must put Xalan
-in front of xerces.jar on the system class path.</em></p>
+in front of xerces.jar the system class path.</em></p>
<p>This beta release includes the following non-XSLTC code changes:</p>
<ul>
1.43 +1 -1 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.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- index.xml 17 Jan 2002 20:07:30 -0000 1.42
+++ index.xml 22 Jan 2002 17:25:36 -0000 1.43
@@ -93,7 +93,7 @@
</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 with the Xerces XML parser.
+ <p>The Xalan download includes &xml4j-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"/>. If you are interested in testing
or prototyping &xml4j2;, you can run &xslt4j-current; with &xml4j; 2.0.0.beta4.</p>
<note>If you plan to use a different XML parser, see <link idref="usagepatterns" anchor="plug">Plugging in a Transformer
1.70 +4 -4 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.69
retrieving revision 1.70
diff -u -r1.69 -r1.70
--- readme.xml 18 Jan 2002 19:37:39 -0000 1.69
+++ readme.xml 22 Jan 2002 17:25:36 -0000 1.70
@@ -129,7 +129,7 @@
</s3>
<anchor name="status"/>
<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>The &xslt4j-current; has been tested with &xml4j-used;. &download; For information about including &xml4j-jar; on the system class path, see <link idref="getstarted" anchor="classpath">Setting up the system class path</link>.</p>
<note>You may also use &xslt4j-current; for prototyping or beta testing with &xml4j; 2.0.0.beta3. <em>You may not use the
<link idref="usagepatterns" anchor="compat">&xslt4j; version 1 API (deprecated)</link> with &xml4j; 2.0.0.beta3.</em></note>
<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>
@@ -199,7 +199,7 @@
Ant</link>.</p>
<p>If you want to do the build without Ant, keep the following in mind:</p>
<ul>
- <li>Set the classpath to include the src directory, xerces.jar, bsf.jar, and bsfengines.jar.</li>
+ <li>Set the classpath to include the src directory, &xml4j-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>
@@ -207,7 +207,7 @@
</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 classpath. To recompile (and run!) the class files in the
+ example. Be sure xalan.jar and &xml4j-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
@@ -231,7 +231,7 @@
<ul>
<li>Unzip xml-site-style.tar.gz into the xdocs directory (the operation places files in a number of subdirectories).
<br/><br/></li>
- <li>Be sure stylebook-1.0-b2.jar, xalanjdoc.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 &xml4j-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>
1.43 +2 -2 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.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- samples.xml 18 Jan 2002 18:16:03 -0000 1.42
+++ samples.xml 22 Jan 2002 17:25:36 -0000 1.43
@@ -79,7 +79,7 @@
sample applications. The class files for the samples are in xalansamples.jar (everything except the servlet) and xalanservlet.jar, so to run the samples, you should place these JAR files on the system classpath.</p>
<p>With most of the samples, you can use the following procedure:</p>
<ol>
- <li>Be sure xalan.jar, xalansamples.jar, and xerces.jar are on the system class
+ <li>Be sure xalan.jar, xalansamples.jar, and &xml4j-jar; are on the system class
path. For the extension examples, bsf.jar and (for the JavaScript extensions) js.jar must also be on the class
path.</li>
<li>Be sure the java executable is on your path.</li>
@@ -187,7 +187,7 @@
<p>The servlet subdirectory contains four sample servlets that use &xslt4j; to perform transformations. These servlets
are in a package named servlet and are compiled in xalanservlet.jar. To run these samples, you must place
xalanservlet.jar, and any XML and XSL files you want to use on a web server with a servlet engine, place
- xalanservlet.jar, xalan.jar, and xerces.jar on the servlet engine class path, and configure the servlet engine to
+ xalanservlet.jar, xalan.jar, and &xml4j-jar; on the servlet engine class path, and configure the servlet engine to
locate the XML and XSL files, and the properties file used by ApplyXSL.</p>
<p><link anchor="simplexsltservlet">servlet.SimpleXSLTServlet</link> applies a particular stylesheet to a particular
XML document.</p>
1.46 +2 -2 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.45
retrieving revision 1.46
diff -u -r1.45 -r1.46
--- usagepatterns.xml 17 Jan 2002 20:07:30 -0000 1.45
+++ usagepatterns.xml 22 Jan 2002 17:25:36 -0000 1.46
@@ -136,7 +136,7 @@
<ol>
<li>Set the system property from the command line when you launch Java or from within your application.<br/><br/></li>
<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 or xerces.jar (depending on which entry you have changed).<br/><br/></li>
+ <li>Revise the entry in src/META-INF/services and rebuild xalan.jar or &xml4j-jar;, depending on which entry you have changed.<br/><br/></li>
</ol>
<p>For example, to use the Crimson XML parser in place of the Xerces XML parser, place Crimson on the class path and set the
<code>javax.xml.parsers.SAXParserFactory</code> system property to <code>org.apache.crimson.jaxp.SAXParserFactoryImpl</code>.</p>
@@ -384,7 +384,7 @@
<source><applet
name="xslControl"
code="org.apache.xalan.client.XSLTProcessorApplet.class"
- archive="../../bin/xalan.jar,../../bin/xerces.jar"
+ archive="../../bin/xalan.jar,../../bin/xml-apis.jar,../../bin/xercesImpl.jar"
height="0"
width"0">
<param name="documentURL" value="xalanApplets.xml"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org