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/02/01 18:11:09 UTC
cvs commit: xml-xalan/java/xdocs/sources/xalan features.xml getstarted.xml index.xml xsltc_usage.xml
dleslie 02/02/01 09:11:09
Modified: java/xdocs/sources/xalan features.xml getstarted.xml
index.xml xsltc_usage.xml
Log:
Editorial cleanup for 2.3.
Revision Changes Path
1.4 +43 -30 xml-xalan/java/xdocs/sources/xalan/features.xml
Index: features.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/features.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- features.xml 31 Jan 2002 15:55:22 -0000 1.3
+++ features.xml 1 Feb 2002 17:11:08 -0000 1.4
@@ -64,24 +64,26 @@
</ul>
<anchor name="factoryfeature"/>
<s2 title="Standard TransformerFactory features">
-<p>The JAXP 1.1 Transformation API for XML (<link idref="trax">TrAX</link>) defines objects and methods for processing input and producing output in a variety of formats, including character streams, SAX event streams, and DOM Documents.</p>
-<p>JAXP 1.1 defines the following feature URIs:</p>
+<p>The JAXP 1.1 Transformation API for XML (<link idref="trax">TrAX</link>) defines objects and methods for processing input and producing
+output in a variety of formats, including character streams, SAX event streams, and DOM Documents.</p>
+<p>JAXP 1.1 defines the following features:</p>
<ul>
-<li><link anchor="streamsource">"http://javax.xml.transform.stream.StreamSource/feature"</link></li>
-<li><link anchor="streamresult">"http://javax.xml.transform.stream.StreamResult/feature"</link></li>
-<li><link anchor="domsource">"http://javax.xml.transform.dom.DOMSource/feature"</link></li>
-<li><link anchor="domresult">"http://javax.xml.transform.dom.DOMResult/feature"</link></li>
-<li><link anchor="saxsource">"http://javax.xml.transform.dom.SAXSource/feature"</link></li>
-<li><link anchor="saxresult">"http://javax.xml.transform.dom.SAXResult/feature"</link></li>
-<li><link anchor="saxtransformerfactory">"http://javax.xml.transform.sax.SAXTransformerFactory/feature"</link></li>
-<li><link anchor="xmlfilter">"http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter"</link></li>
+<li><link anchor="streamsource">StreamSource feature</link></li>
+<li><link anchor="streamresult">StreamResult feature</link></li>
+<li><link anchor="domsource">DOMSource feature</link></li>
+<li><link anchor="domresult">DOMResult feature</link></li>
+<li><link anchor="saxsource">SAXSource feature</link></li>
+<li><link anchor="saxresult">SAXResult feature</link></li>
+<li><link anchor="saxtransformerfactory">SAXTransformerFactory feature</link></li>
+<li><link anchor="xmlfilter">XMLFilter feature</link></li>
</ul>
<p>You can use the
<jump href="apidocs/javax/xml/transform/TransformerFactory.html#getFeature(java.lang.String)">TransformerFactory.getFeature(String)</jump>
method to return a boolean indicating whether the implementation you are using supports the use of one of these objects or methods. For the String argument, provide the static String variable or literal URI String as detailed below.</p>
<p>&xslt4j; supports <em>all</em> TransformerFactory features.</p>
<anchor name="streamsource"/>
-<s3 title='"http://javax.xml.transform.stream.StreamSource/feature"'>
+<s3 title="StreamSource feature">
+<p><em>URI:</em> "http://javax.xml.transform.stream.StreamSource/feature"</p>
<p>The implementation supports the processing of <jump href="apidocs/javax/xml/transform/stream/StreamSource.html">StreamSource</jump> input objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static StreamSource.FEATURE variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -94,7 +96,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="simpletransform">SimpleTransform</link>.</p>
</s3><anchor name="streamresult"/>
-<s3 title='"http://javax.xml.transform.stream.StreamResult/feature"'>
+<s3 title="StreamResult feature">
+<p><em>URI:</em> "http://javax.xml.transform.stream.StreamResult/feature"</p>
<p>The implementation supports the production of transformation output in the form of <jump href="apidocs/javax/xml/transform/stream/StreamResult.html">StreamResult</jump> objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static StreamResult.FEATURE variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -107,7 +110,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="simpletransform">SimpleTransform</link>.</p>
</s3><anchor name="domsource"/>
-<s3 title='"http://javax.xml.transform.dom.DOMSource/feature"'>
+<s3 title="DOMSource feature">
+<p><em>URI:</em> "http://javax.xml.transform.dom.DOMSource/feature"</p>
<p>The implementation supports the processing of XML input in the form of <jump href="apidocs/javax/xml/transform/dom/DOMSource.html">DOMSource</jump> objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static DOMSource.FEATURE string variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -120,7 +124,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="dom2dom">DOM2DOM</link>.</p>
</s3><anchor name="domresult"/>
-<s3 title='"http://javax.xml.transform.dom.DOMResult/feature"'>
+<s3 title="DOMResult feature">
+<p><em>URI:</em> "http://javax.xml.transform.dom.DOMResult/feature"</p>
<p>The implementation supports the production of transformation output in the form of <jump href="apidocs/javax/xml/transform/dom/DOMResult.html">DOMResult</jump> objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static DOMResult.FEATURE variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -133,7 +138,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="dom2dom">DOM2DOM</link>.</p>
</s3><anchor name="saxsource"/>
-<s3 title='"http://javax.xml.transform.dom.SAXSource/feature"'>
+<s3 title="SAXSource feature">
+<p><em>URI:</em> "http://javax.xml.transform.dom.SAXSource/feature"</p>
<p>The implementation supports the processing of XML input in the form of <jump href="apidocs/javax/xml/transform/sax/SAXSource.html">SAXSource</jump> objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static SAXSource.FEATURE string variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -145,7 +151,8 @@
..
}</source>
</s3><anchor name="saxresult"/>
-<s3 title='"http://javax.xml.transform.dom.SAXResult/feature"'>
+<s3 title="SAXResult feature">
+<p><em>URI:</em> "http://javax.xml.transform.dom.SAXResult/feature"</p>
<p>The implementation supports the production of transformation output in the form of <jump href="apidocs/javax/xml/transform/sax/SAXResult.html">SAXResult</jump> objects.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static SAXResult.FEATURE variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -158,7 +165,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="sax2sax">SAX2SAX</link>.</p>
</s3><anchor name="saxtransformerfactory"/>
-<s3 title='"http://javax.xml.transform.sax.SAXTransformerFactory/feature"'>
+<s3 title="SAXTransformerFactory feature">
+<p><em>URI:</em> "http://javax.xml.transform.sax.SAXTransformerFactory/feature"</p>
<p>The implementation provides a <jump href="apidocs/javax/xml/transform/sax/SAXTransformerFactory.html">SAXTransformerFactory</jump>.
You may safely cast the TransformerFactory returned by TransformerFactory.newInstance() to a SAXTransformerFactory.</p>
<p>To determine whether your implementation supports this feature (&xslt4j; does), you can use the static SAXTransformerFactory.FEATURE
@@ -173,7 +181,8 @@
}</source>
<p>For a example that uses this feature, see <link idref="samples" anchor="sax2sax">SAX2SAX</link>.</p>
</s3><anchor name="xmlfilter"/>
-<s3 title='"http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter"'>
+<s3 title="XMLFilter feature">
+<p><em>URI: </em>"http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter"</p>
<p>The implementation supports the use of <jump href="apidocs/org/xml/sax/XMLFilter.html">XMLFilter</jump> to use the output of one
transformation as input for another transformation. The SAXTransformerFactory newXMLFilter(Source) and newXMLFilter(Templates) methods
are supported.</p>
@@ -187,24 +196,26 @@
// Can use SAXTransformerFactory to get XMLFilters.
..
}</source>
-<p>For an example, see <link idref="samples" anchor="usexmlfilters">UseXMLFilters</link>.</p>
+<p>For an example that uses this feature to chain together a series of transformations, see
+<link idref="samples" anchor="usexmlfilters">UseXMLFilters</link>.</p>
</s3>
</s2><anchor name="factoryattribute"/>
<s2 title="&xslt4j; TransformerFactory attributes">
-<p>A given implementation may provide TransformerFactory attributes that you can set and get. &xslt4j; uses the <link idref="dtm">
-DTM (Document Table Model)</link> to support three such attributes:</p>
+<p>A given implementation may provide TransformerFactory attributes for which you can set and get values. &xslt4j; uses the
+<link idref="dtm"> DTM (Document Table Model)</link> to support three attributes which can be set to true or false:</p>
<ul>
-<li><link anchor="optimize">"http://apache.org/xalan/features/optimize"</link></li>
-<li><link anchor="incremental">"http://apache.org/xalan/features/incremental"</link></li>
-<li><link anchor="source_location">"http://apache.org/xalan/features/source_location"</link></li>
+<li><link anchor="optimize">optimize attribute</link></li>
+<li><link anchor="incremental">incremental attribute</link></li>
+<li><link anchor="source_location">source_location attribute</link></li>
</ul>
<p>To get an attribute setting, use the TransformerFactory.getAttribute(String) method, which returns an Object. For these three &xslt4j;
attributes, you can cast the return value to a boolean. To set an attribute, use the TransformerFactory.setAttribute(String, Object) method.
For the String argument, provide the static String variable or literal URI String as detailed below. For the Object argument, use
-Boolean.TRUE or Boolean.FALSE.</p><anchor name="optimize"/>
-<s3 title='"http://apache.org/xalan/features/optimize"'>
+Boolean.TRUE or Boolean.FALSE (or the Strings "true" or "false").</p><anchor name="optimize"/>
+<s3 title="optimize attribute">
+<p><em>URI:</em> "http://apache.org/xalan/features/optimize"</p>
<p>Optimize stylesheet processing. By default, this attribute is set to true. You may need to set it to false for tooling applications.
-For more information, see <link idref="dtm" anchor="optimize">optimize</link>.</p>
+For more information, see <link idref="dtm" anchor="optimize">DTM optimize</link>.</p>
<p>To turn optimization off, you can use the TransformerFactoryImpl.FEATURE_OPTIMIZE static variable (equivalent to the URI String above)
as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
@@ -216,10 +227,11 @@
Boolean.FALSE);
}</source>
</s3><anchor name="incremental"/>
-<s3 title='"http://apache.org/xalan/features/incremental"'>
+<s3 title="incremental attribute">
+<p><em>URI:</em> "http://apache.org/xalan/features/incremental"</p>
<p>Produce output incrementally, rather than waiting to finish parsing the input before generating any output. By default this attribute is set
to false. You can turn this attribute on to transform large documents where the stylesheet structure is optimized to execute individual templates
-without having to parse the entire document. For more information, see <link idref="dtm" anchor="incremental">incremental</link>.</p>
+without having to parse the entire document. For more information, see <link idref="dtm" anchor="incremental">DTM incremental</link>.</p>
<p>To turn incremental transformations on, you can use the TransformerFactoryImpl.FEATURE_INCREMENTAL static variable (equivalent to the URI String above) as follows:</p>
<source>import javax.xml.transform.TransformerFactory;
import org.apache.xalan.processor.TransformerFactoryImpl;
@@ -230,7 +242,8 @@
Boolean.FALSE);
}</source>
</s3><anchor name="source_location"/>
-<s3 title='"http://apache.org/xalan/features/source_location"'>
+<s3 title="source_location attribute">
+<p><em>URI:</em> "http://apache.org/xalan/features/source_location"</p>
<p>Provide a <jump href="apidocs/javax/xml/transform/SourceLocator.html">SourceLocator</jump> that can be used during a transformation
to obtain the location of individual nodes in a source document (system ID, line number, and column number).</p>
<p>By default, this attribute is set to false. Setting this attribute to true involves a substantial increase in storage cost per source
1.19 +8 -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.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- getstarted.xml 22 Jan 2002 17:25:36 -0000 1.18
+++ getstarted.xml 1 Feb 2002 17:11:08 -0000 1.19
@@ -13,7 +13,7 @@
<s2 title="Downloading what you need">
<p>To use Xalan, you need the following:</p>
<ul>
-<li>The JDK or JRE 1.1.8, 1.2.2, or 1.3</li>
+<li>The JDK or JRE 1.2.2, or 1.3.x</li>
<li>xalan.jar</li>
<li>&xml4j-jar;, or another <link idref="usagepatterns" anchor="plug">XML Parser</link>)</li>
</ul>
@@ -24,9 +24,13 @@
<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 &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 &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>
+<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 <link idref="xsltc_usage">XSLTC</link>, see <link idref="xsltc_usage" anchor="classpath">Setting the system classpath for XSLTC</link>.</p>
+<p>If you are using JDK or JRE 1.2.2, include tools.jar on the classpath.</p>
</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.44 +10 -9 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.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- index.xml 22 Jan 2002 17:25:36 -0000 1.43
+++ index.xml 1 Feb 2002 17:11:08 -0000 1.44
@@ -72,12 +72,13 @@
<note>&xslt4j; version 1 is no longer supported and no longer available from xml.apache.org.</note>
</s2>
<s2 title="How about this release?">
- <p>&xslt4j-current; incorporates the <link idref="dtm">DTM (Document Table Model)</link> and has been tested with &xml4j; version 2. As of
- this release, support for the &xslt4j; release 1 API, which predates the design of the <resource-ref idref="jaxp11"/>JAXP 1.1/<link idref="trax">TrAX
+ <p>&xslt4j-current; works with &xml4j; version 2, and the distribution includes xercesImpl.jar from &xml4j-used;. For the time being, &xslt4j;
+ maintains backwards compatiblity with &xml4j; version 1.</p>
+ <p>Support for the &xslt4j; release 1 API, which predates the design of the <resource-ref idref="jaxp11"/>JAXP 1.1/<link idref="trax">TrAX
</link> interfaces, has been dropped.</p>
- <p>Starting with 2.2.D12, we have reduced xalan.jar to just include the &xslt4j; implementation, placing the SAX, DOM,
- and JAVAX interfaces in xml-apis.jar. These interfaces are shared by a number of tools (&xslt4j;, &xml4j;, etc.), so placing them in a
- separate JAR simplifies coordination and reduces risk of duplication. <em>Be sure to put both JAR files on your classpath!</em></p>
+ <p>The &xslt4j; implementation is in xalan.jar. The SAX, DOM, and JAVAX interfaces are in xml-apis.jar. These interfaces are shared by a
+ number of tools (&xslt4j;, &xml4j;, etc.), so placing them in a separate JAR simplifies coordination and reduces risk of duplication.
+ <em>Be sure to put both JAR files (and xercesImpl.jar or another JAXP 1.1-compliant XML parser) on your classpath!</em></p>
</s2>
<s2 title="How do I get it?">
<p>To get the binary distribution (all you need to use and develop applications with &xslt4j;), download and unzip either of the following:</p>
@@ -93,14 +94,14 @@
</s2>
<s2 title="Where do I get Xerces?">
- <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>
+ <p>The Xalan download includes &xml4j-jar; from &xml4j-used;. In conjunction with xml-apis.jar, this is all you need to run Xalan with
+ the Xerces XML parser. You can, however, download the complete Xerces binary or source distribution from the
+ <resource-ref idref="xml4j-distdir"/>.</p>
<note>If you plan to use a different XML parser, see <link idref="usagepatterns" anchor="plug">Plugging in a Transformer
and XML parser</link>.</note>
</s2>
<s2 title="What else do I need?">
- <p>You need the Java Development Kit or Java Runtime 1.1.8, 1.2.2, or 1.3, which you can obtain from <jump
+ <p>You need the Java Development Kit or Java Runtime 1.2.2, or 1.3.x, which you can obtain 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>
</s2>
<s2 title="For more information...">
1.21 +1 -1 xml-xalan/java/xdocs/sources/xalan/xsltc_usage.xml
Index: xsltc_usage.xml
===================================================================
RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/xsltc_usage.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- xsltc_usage.xml 17 Jan 2002 20:07:31 -0000 1.20
+++ xsltc_usage.xml 1 Feb 2002 17:11:08 -0000 1.21
@@ -70,7 +70,7 @@
<p>See also: <jump href="xsltc/index.html">XSLTC Design</jump></p>
<anchor name="intro"/>
<s2 title="Introduction">
-<p>XSLT provides a compiler and a runtime processor. Use the compiler to compile an XSL stylesheet into a translet, a set of Java classes. Use the runtime processor to apply the translet to an XML document and perform a transformation.</p>
+<p>XSLTC provides a compiler and a runtime processor. Use the compiler to compile an XSL stylesheet into a translet, a set of Java classes. Use the runtime processor to apply the translet to an XML document and perform a transformation.</p>
<note>To compile translets, you must be running the JDK or JRE 1.2 or higher. You can run translets with the JDK or JRE 1.1.8 or higher.</note>
</s2><anchor name="classpath"/>
<s2 title="Setting the system classpath for XSLTC">
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org