dleslie 00/05/10 09:41:23
Modified: c/xdocs/sources/xalan commandline.xml faq.xml getstarted.xml
index.xml overview.xml readme.xml samples.xml
STATUS usagepatterns.xml
Log:
First draft of xalan-c doc source files.
Revision Changes Path
1.2 +1 -5 xml-xalan/c/xdocs/sources/xalan/commandline.xml
Index: commandline.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/commandline.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- commandline.xml 2000/05/08 19:23:03 1.1
+++ commandline.xml 2000/05/10 16:41:16 1.2
@@ -59,7 +59,7 @@
-->
-<s1 title="Command-Line Utility">
+<s1 title="Xalan-C Command-Line Utility">
<s2 title="Using the Command-Line Utility">
<p>To perform a transformation, you can call &xslt4c; from the command
line (or script),
@@ -90,10 +90,6 @@
-LF (Use linefeeds only on output -- default is CR/LF)
-CR (Use carriage returns only on output -- default is CR/LF)
-INDENT (Number of spaces to indent each level in output tree --default is 0)
--TT (Trace the templates as they are being called)
--TG (Trace each result tree generation event)
--TS (Trace each selection event)
--TTC (Trace the template children as they are being processed)
-VALIDATE (Validate the XML and XSL input -- validation is off by default)
-EDUMP [optional]FileName (Do stackdump on error)
-XML (Use XML formatter and add XML header)
1.2 +1 -1 xml-xalan/c/xdocs/sources/xalan/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/faq.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.xml 2000/05/08 19:23:04 1.1
+++ faq.xml 2000/05/10 16:41:16 1.2
@@ -32,7 +32,7 @@
<p>StylesheetRoot objects, on the other hand, are thread-safe. A single
StylesheetRoot object may be called concurrently
from multiple threads. Keep in mind, however, that the StylesheetRoot
uses an XSLTEgineImpl to store running state information
for each transformation, so you must call the XSLTEngineImpl reset()
method between each transformation.</p>
- <p>For more detail, see <link idref="samples"
anchor="compilestylesheet"></link>.</p></a>
+ <p>For more detail, see <link idref="samples"
anchor="compilestylesheet">CompileStylesheet</link>.</p></a>
</faq>
<faq title="What can I do to speed up transformations?">
1.3 +14 -12 xml-xalan/c/xdocs/sources/xalan/getstarted.xml
Index: getstarted.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/getstarted.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- getstarted.xml 2000/05/09 18:43:17 1.2
+++ getstarted.xml 2000/05/10 16:41:17 1.3
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE s1 SYSTEM "sbk:/style/dtd/document.dtd">
-<s1 title="Getting Started">
+<s1 title="Getting Started with Xalan-C">
<ul>
<li><link anchor="download">Downloading what you need</link></li>
<li><link anchor="path">Setting up the system path</link></li>
@@ -11,13 +11,13 @@
</ul>
<anchor name="download"/>
<s2 title="Downloading what you need">
-<p>For Xalan-C 1.0.0, we are distributing a Windows32 Visual C++ build and a
Linux build. In the future, we intend to add more builds.</p>
+<p>For Xalan-C 1.0.0, we are distributing a Windows32 Visual C++ build and a
Linux build. In the future, we intend to add builds for other platforms.</p>
<s3 title="Xalan-C Distributions">
<p><img src="xalan-cdist.gif" alt="xalan-cdist.gif"/></p>
</s3>
<p>For the Windows32 build, download <jump
href="http://xml.apache.org/dist/xalan-c/xalan-c_1_0_0.zip";>xalan-c_1_0_1.zip</jump>.</p>
<p>For the Linux build, download <jump
href="http://xml.apache.org/dist/xalan-j/xalan-c_1_0_0.tar.gz";>xalan-c_1_0_0.tar.gz</jump>.</p>
-<p>Each distribution contains all you need to run the Xalan command-line
utility for performing transformations.</p>
+<p>Each distribution contains all you need to run the Xalan command-line
utility for performing transformations. To build your own applications, you
also need a compatible Xerces-C distribution.</p>
<s3 title="What you need to run the Xalan command-line utility">
<p>To run the Xalan executable for performing transformations, you need the
following:</p>
<p><em>Windows32</em></p>
@@ -39,15 +39,17 @@
<s3 title="What you need to build applications">
<p>To build your own applications with Xalan and Xerces, you also need need
the
Xalan-C and Xerces-C header (.hpp) files and (for Windows) the Xerces-C
libraries (.lib files).</p>
-<p>The Xalan-C header files are in the source tree in both distributions. In
the Windows32 distribution (built with Microsoft® Visual C++® 6.0), the
dlls and libraries are in the Build - Win32 -V6 - Release subdirectory. In the
Linux distribution (built with a make file), the shared object library is in
the lib subdirectory.</p>
-<p>To get the Xerces-C header and (for Windows) .lib files, download and
expand the Xerces-C 1.1.0 Binary distribution for your platform from the
<resource-ref idref="Xerces-c-dist"/>.</p>
+<p>The Xalan-C header files are in the source tree in both
distributions.</p>
+<p>In the Windows32 distribution (built with Microsoft® Visual C++®
6.0), the dlls and libraries are in the Build - Win32 -V6 - Release
subdirectory.</p>
+<p>In the Linux distribution (built with a make file), the shared object
library is in the lib subdirectory.</p>
+<p>To get the Xerces-C header and (for Windows) .lib files, download and
expand the Xerces-C 1.1.0 Binary distribution for your platform from the
<resource-ref idref="Xerces-c-dist"/>. For information about which Xerces-C
distribution has been tested with this Xalan-C release, see <link
idref="readme" anchor="status">Version of Xerces to use</link>.</p>
<note>If you want to rebuild Xalan, you will also need the Xerces-C source
distribution (Xalan uses a header file that is not included in the Xerces-C
binary distributions). For more information, see <link idref="readme"
anchor="build"></link>Build Notes.</note>
</s3>
</s2><anchor name="path"/>
<s2 title="Setting up the system path">
<p>For the Xalan-C Windows32 distribution, place
xml-xalan\c\Build\Win32\VC6\Release on the system path.</p>
-<p>For the Xalan-C Linux distribution, place xml-xalan/c/lib on the system
path. </p>
-<p>If you do your own Xalan and Xerces builds, be sure to include the
directories that contain these dlls and executables on your system path.</p>
+<p>For the Xalan-C Linux distribution, place xml-xalan/c/bin and
xml-xalan/c/lib on the system path. </p>
+<p>If you do your own Xalan and Xerces builds, be sure to include the
directories that contain the libraries and the TextXSLT executable on your
system path.</p>
</s2><anchor name="samples"/>
<s2 title="Trying out the samples">
<p>The &xslt4c; Windows32 distribution includes a number of basic sample
applications. These samples are easy to run,
@@ -56,18 +58,18 @@
<p>To run the samples, do the following:</p>
<ol>
<li>Set up your path (see above). In the Windows32 distribution, the sample
executables are in
-xml-xalan\c\Build\Win32\VC6\Release.(</li>
+xml-xalan\c\Build\Win32\VC6\Release.</li>
<li>Go to the samples subdirectory containing the sample (use the DOS shell
in Windows).</li>
<li>Run the sample from the command line.</li>
<li>Examine the application source files.</li>
</ol>
<p>For example, go to the SimpleTransform subdirectory and issue the
following command:</p>
<p><code>SimpleTransform</code></p>
-<p>The sample writes the transformation result to foo.out. To see how the
example works, examine the source files: foo.xml, foo.xsl, foo.out, and
SimpleTransform.cpp.</p>
-<p>For more information about all the samples, see <link
idref="samples">&xslt4c; Samples</link>.</p>
+<p>The sample uses the foo.xsl stylesheet to transform foo.xml, and writes
the transformation result to foo.out. To see how the example works, examine the
source files: foo.xml, foo.xsl, foo.out, and SimpleTransform.cpp.</p>
+<p>For more information about the samples, see <link
idref="samples">&xslt4c; Samples</link>.</p>
</s2><anchor name="commandline"/>
<s2 title="Performing your own transformations from the command line">
-<p>TestXSLT(.exe) provides a basic utility for performing transformations
from the command line. The command line for
+<p>TestXSLT provides a basic utility for performing transformations from the
command line. The command line for
most standard transformations is as follows:</p>
<p><code>TestXSLT -in <ref>xmlSource</ref> -xsl <ref>stylesheet</ref> -out
<ref>outputfile</ref></code></p>
<p>where <ref>xmlSource</ref> is the XML source file name,
<ref>stylesheet</ref> is the XSL stylesheet file name, and
<ref>outputfile</ref> is the output file name.</p>
@@ -76,7 +78,7 @@
</s2><anchor name="apps"/>
<s2 title="Setting up your own C++ applications">
<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
idref="usagepatterns">basic usage patterns</link>.</p>
-<p>If you modify a C++ source file, be sure to rebuild the application
executable and place it on the system path. Here are some basic points to keep
in mind as you are setting up transformations:</p>
+<p>If you modify a C++ source file, be sure to rebuild the application
executable and place it on the system path.</p>
<p>For more information on setting up applications, see <link
idref="usagepatterns">Basic Usage Patterns</link>.</p>
</s2>
</s1>
1.2 +30 -14 xml-xalan/c/xdocs/sources/xalan/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2000/05/08 19:23:04 1.1
+++ index.xml 2000/05/10 16:41:17 1.2
@@ -61,28 +61,44 @@
<s1 title="Xalan-C Version 1.0.0">
<s2 title="What is it?">
- <p>Xalan is an XSL processor for transforming XML documents into HTML,
text, or other XML document types. Xalan-C version
- 1.0.0 represents a complete and a robust C++ reference implementation of
the W3C Recommendations for XSL Transformations
- (XSLT) and the XML Path Language (XPath).</p>
+ <p>Xalan is an XSL processor for transforming XML documents into HTML,
text, or other XML document types. Xalan-C
+ version 1.0.0 represents a complete and a robust C++ reference
implementation of the W3C Recommendations for XSL
+ Transformations (XSLT) and the XML Path Language (XPath).</p>
<p>Xalan-C uses the Xerces-C XML parser.</p>
</s2>
<s2 title="How do I get it?">
- <p>Download and unzip either of the following:</p>
- <ul>
- <li><jump
href="http://xml.apache.org/dist/xalan-j/xalan-j_1_0_1.zip";>xalan-j_1_0_0.zip</jump></li>
- <li><jump
href="http://xml.apache.org/dist/xalan-j/xalan-j_1_0_1.tar.gz";>xalan-j_1_0_0.tar.gz</jump></li>
- </ul>
+ <p>Download and unzip the distribution file for your platform. In
addition to the platform-specific binaries,
+ documentation, and sample applications, both distributions also include
the complete Xalan-C source tree.</p>
+ <table>
+ <tr>
+ <td><em>Platform</em></td>
+ <td><em>Download</em></td>
+ </tr>
+ <tr>
+ <td>Windows32</td>
+ <td><jump
href="http://xml.apache.org/dist/xalan-j/xalan-j_1_0_1.zip";>xalan-c_1_0_0.zip</jump></td>
+ </tr>
+ <tr>
+ <td>Linux</td>
+ <td><jump
href="http://xml.apache.org/dist/xalan-j/xalan-j_1_0_1.tar.gz";>xalan-c_1_0_0.tar.gz</jump></td>
+ </tr>
+ </table>
+ <p>We plan to add builds for other platforms as soon as possible.
Volunteers are more than welcome!</p>
</s2>
<s2 title="Where do I get Xerces?">
- <p>The Xalan-C dowload includes xerces-c_1_1.dll from Xerces-C 1.0.3.
This provides the Xerces runtime environment for
- Xalan.To build applications with Xalan and the Xerces XML parser, you
also need the Xerces-C source tree, which you can
- obtain by downloading the Xerces-C Source distribution from the
<resource-ref idref="Xeces-c-dist"/>.</p>
+ <p>Both distributions include the Xerces runtime environment for Xalan
-- xerces-c_1_1.dll for Windows,
+ and libxerces-c_1_1.so for Linux. To build applications with Xalan and
Xerces, you also need the Xerces-C binary
+ binary distribution for your platform, which you can download from the
+ <resource-ref idref="Xerces-c-dist"/>.</p>
+ <note>Be sure you are using a compatible Xerces-C build. For
information about the build with which this release
+ of Xalan-C was tested, see <link idref="readme" anchor="status">Version
of Xerces to use</link>.</note>
</s2>
<s2 title="For more information...">
- <p>For more information, go to <link idref="overview">Xalan
Overview</link> and <link idref="getstarted">Getting
- Started</link>. All of the Xalan documentation on this website is
included in the Xalan download, as are a number of samples
- to help you start using Xalan to transform XML documents.</p>
+ <p>For more information, go to the <link idref="overview">Xalan-C
Overview</link> and
+ <link idref="getstarted">Getting Started with Xalan-C</link>. All of the
Xalan documentation on this website is
+ included in the Xalan downloads, as are a number of samples to help you
start using Xalan to transform XML
+ documents.</p>
</s2>
</s1>
1.2 +1 -1 xml-xalan/c/xdocs/sources/xalan/overview.xml
Index: overview.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/overview.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- overview.xml 2000/05/08 19:23:04 1.1
+++ overview.xml 2000/05/10 16:41:17 1.2
@@ -76,7 +76,7 @@
For more information, see <jump href="http://www.w3.org/TR/xsl/";>W3C XSL
Working Draft</jump> and the <jump
href="http://xml.apache.org/fop";>Apache XML FOP (Formatting Objects
Project)</jump>.</note>
<p>You use the XSLT language to compose XSL stylesheets. An XSL
stylesheet contains instructions for
- transforming XML documents from one document type into another document
type (XML, HTML, or other). In structural
+ transforming XML documents from one document type to another document
type (XML, HTML, or other). In structural
terms, an XSL stylesheet specifies the transformation of one tree of
nodes (the XML input) into another tree of nodes
(the output or transformation result).</p>
<note>The XSL stylesheet may include cascading style sheets (CSS) in the
result.</note>
1.3 +3 -2 xml-xalan/c/xdocs/sources/xalan/readme.xml
Index: readme.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/readme.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- readme.xml 2000/05/09 18:43:17 1.2
+++ readme.xml 2000/05/10 16:41:17 1.3
@@ -60,7 +60,7 @@
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
-->
-<s1 title="Release Notes">
+<s1 title="Xalan-C Release Notes">
<ul>
<li><link anchor="status">Status</link></li>
<li><link anchor="build">Build Notes</link></li>
@@ -87,7 +87,8 @@
<s3 title="Rebuilding &xslt4c;">
<p>To rebuild the Windows32 release, use the Microsoft Visual C++ 6.0
project files. To rebuild the Linux release, use the make file in the root of
the source directory.</p>
<p><em>Important</em> We have set up the Visual C++ projects and the
Linux make file to look for Xerces in a the directory structure that results
from downloading xml-xerces/c from the Apache XML repository and building with
the Visual C++ project files or the Linux make file. This structure parallels
the Xalan-C source tree and build structure.<br/><br/>
-If you are using a Xerces-C binary distribution, you must either modify the
Xalan-C project files or Makefile, or rearrange the build directory structure,
and you must also get the header files from the Xerces-C source distribution,
since Xalan-C uses a header file that is not included in the Xerces-C binary
distribution.</p>
+If you are using a Xerces-C binary distribution, you must either modify the
Xalan-C project files or makefile, or rearrange the build directory structure,
and you must also get the header files from the Xerces-C source distribution,
since Xalan-C uses a header file that is not included in the Xerces-C binary
distribution.</p>
+<note>Keep in mind that at any given point in time the Xalan-C and Xerces-C
source trees in the Apache XML repository may not be consistent. When we
release a version of Xerces-C we certify that it is compabible with a given
release of Xalan-C. To be safe, stick with distributions that we certify to be
compatible. Reminder: Xalan-C 1.0.0 is compatible with Xerces-C 1.1.0.</note>
</s3><anchor name="samples"/>
<s3 title="Rebuilding a sample application">
<p>The Windows32 distribution includes Visual C++ project files for each
of the sample applications. The project files are in the samples subdirectories
along with the source files. If you modify a sample and want to recompile it,
you can recompile the .cpp file(s) and rebuild the executable.</p>
1.2 +12 -10 xml-xalan/c/xdocs/sources/xalan/samples.xml
Index: samples.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/samples.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- samples.xml 2000/05/08 19:23:04 1.1
+++ samples.xml 2000/05/10 16:41:18 1.2
@@ -57,7 +57,7 @@
-->
<!DOCTYPE s1 SYSTEM "sbk:/style/dtd/document.dtd">
-<s1 title="Samples">
+<s1 title="Xalan-C Samples">
<ul>
<li><link anchor="getstarted">Samples to help you get started</link></li>
<li><link anchor="simpletransform">SimpleTransform</link></li>
@@ -69,9 +69,11 @@
<anchor name="getstarted"/>
<s2 title="Samples to help you get started">
- <p>Each of the subdirectories in the &xslt4j; samples directory contains
the source files for a
- sample application. The executables for all the samples are in the xxx
directory, so to run the samples,
- you should place this directory on the system path.</p>
+ <p>Each of the subdirectories in the &xslt4c; samples directory contains
the source files for a
+ sample application. In the Windows32 distribution, the executables for
all the samples are in the build
+ subdirectory, which should be on the system path. If you are using the
Linux distribution, you must build the
+ sample application executables yourself. Of course you can also consult
the sample application source files for
+ useful information about how to perform basic operations.</p>
<p>With most of the samples, you can use the following procedure:</p>
<ol>
<li>Go to the samples subdirectory containing the sample (use the DOS
shell if you are running Windows)
@@ -88,11 +90,11 @@
<p>where <ref>executable</ref> is the name of the executable and
<ref>args</ref> are the arguments.</p>
</s2><anchor name="simpletransform"/>
<s2 title="SimpleTransform">
- <p>What it does: The SimpleTransform class uses the foo.xsl stylesheet
to transform foo.xml, and prints the
+ <p>What it does: The SimpleTransform class uses the foo.xsl stylesheet
to transform foo.xml, and writes the
output to foo.out.</p>
<p>You can run it from the SimpleTransform subdirectory with</p>
<p><code>SimpleTransform</code></p>
- <p>See also: <link idref="usagepatterns" anchor="basic">Basic
proecedures for performing XSL
+ <p>See also: <link idref="usagepatterns" anchor="basic">Basic procedures
for performing XSL
transformations</link>.</p>
</s2><anchor name="usestylesheetparam"/>
<s2 title="UseStylesheetParam">
@@ -105,8 +107,8 @@
expression. Enclose the string expression in single quotes (so it is
interpreted as an expression); if it
includes more than a single word, enclose the resulting string in
double quotes so the executable interprets it
as a single argument. For example:</p>
- <p><code>UseStylesheetParam param1 "'this is a mulit-word string
expression'"</code></p>
- <p>See also: <link idref="usagepatterns" anchor="params">Setting
stylesheet params</link>.</p>
+ <p><code>UseStylesheetParam param1 "'hello out there'"</code></p>
+ <p>See also: <link idref="usagepatterns" anchor="params">Setting
stylesheet parameters</link>.</p>
</s2><anchor name="compilestylesheet"/>
<s2 title="CompileStylesheet">
<p>What it does: Use a compiled stylesheet to perform a series of
transformations.</p>
@@ -117,7 +119,7 @@
<s2 title="XPathWrapper">
<p>This sample uses TestDriver, an executable, and two classes:
XPathWrapper and XPathWrapperImp. </p>
<p>What it does: TestDriver passes XPathWrapper an XML file name, a
context node location path, and an XPath
- expression. XPathWrapper in turn passes these arguments to the
XPahtWrapperImpl evaluate() method, which executes
+ expression. XPathWrapper in turn passes these arguments to the
XPathWrapperImpl evaluate() method, which executes
the XPath expression from specified context node in the XML document and
returns the nodes (if any) it finds.</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 context node in an XML file.</note>
@@ -140,7 +142,7 @@
<p>See also: <link idref="usagepatterns" anchor="xpath">Working with
XPath expressions</link>.</p>
</s2><anchor name="externalfunctions"/>
<s2 title="ExternalFunctions">
- <p>What it does: implement, install, and illustratethe usage of three
extension functions. The functions return a
+ <p>What it does: implement, install, and illustrate the usage of three
extension functions. The functions return a
square root, a cube, and a string with the current date and time. The
sample stylesheet (foo.xsl) gets the area
of a cube and units of measurement from an XML document (foo.xml),
computes the length of each side
of a cube and the volume of the cube, and enters the date and time of
the transformation. The output appears in
1.3 +3 -2 xml-xalan/c/xdocs/sources/xalan/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/STATUS,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- STATUS 2000/05/09 18:43:16 1.2
+++ STATUS 2000/05/10 16:41:18 1.3
@@ -1,5 +1,5 @@
<s3 title="Version of Xerces to use">
-<p>Xalan-C version 1.0.0 has been tested with Xerces-C version 1.1.0. The
Xalan-C Windows32 download includes xerces-c_1_1.dll. The Xalan-C Linux
download includes libxerces-c_1_1.so.
+<p>Xalan-C version 1.0.0 has been tested with Xerces-C version 1.1.0. The
Xalan-C 1.1.0 Windows32 download includes xerces-c_1_1.dll. The Xalan-C 1.1.0
Linux download includes libxerces-c_1_1.so.
For information about including The Xerces-C dynamic link or shared object
library on the system class path, see <link idref="getstarted"
anchor="classpath">Setting up the system class path</link>.</p>
<p><em>Important</em> You may experience unpredictable anomalies if your
Xalan and Xerces builds are not in synch. If you download an update to Xalan,
check the release notes to determine which version of Xerces you should use.</p>
@@ -9,7 +9,8 @@
<p>We still need to do the following:</p>
<ul>
<li>Implement a more efficient mechanism for storing and navigating
DOM trees, along the lines of the Xalan-J
- Document Table Model (DTM)<br/><br/></li>
+ Document Table Model )<br/><br/>(DTM)<br/><br/></li>
+ <li>Provide a debugging interface to enable the tracing of
transformation events<br/><br/></li>
<li>Add support for extension elements<br/><br/></li>
</ul>
<p>Watch the <human-resource-ref idref="xalandev"/> for more information
and for ideas about how you can get involved.</p>
1.2 +8 -15 xml-xalan/c/xdocs/sources/xalan/usagepatterns.xml
Index: usagepatterns.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/usagepatterns.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- usagepatterns.xml 2000/05/08 19:23:04 1.1
+++ usagepatterns.xml 2000/05/10 16:41:18 1.2
@@ -56,7 +56,7 @@
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
-->
-<s1 title="Basic usage patterns">
+<s1 title="Xalan-C Basic usage patterns">
<ul>
<li><link anchor="intro">Introduction</link></li>
<li><link anchor="basic">Basic procedure for performing XSL
transformations</link></li>
@@ -65,13 +65,13 @@
<li><link anchor="compiled">Compiling stylesheets</link></li>
<li><link anchor="xpath">Working with XPath expressions</link></li>
<li><link anchor="extensions">Creating and using extension
functions</link></li>
-<li><link anchor="debugging">Debugger interface</link></li>
</ul><anchor name="intro"/>
<s2 title="Introduction">
-<p>&xslt4c; takes as primary input an XML source document and an XSL
stylesheet, both represented by instances of <jump
href="apidocs/class_XSLTInputSource.html">XSLTInputSource</jump>. The
stylesheet may also take the form of a compiled stylesheet (an instance of
<jump href="apidocs/class_stylesheetroot.html">StylesheetRoot</jump>. If the
XML document contains a stylesheet Processing Instruction (PI), a separate
stylesheet is not required.</p>
-<p>&xslt4c; uses an implementation of the <jump
href="apidocs/class_xmlparserliaison.html"/> to interact with the Xerces XML
parser and sends the output to <jump
href="apidocs/class_xsltresulttarget.html">XSLTResultTarget</jump>.
+<p>&xslt4c; takes as primary input an XML source document and an XSL
stylesheet, both represented by instances of <jump
href="apidocs/class_XSLTInputSource.html">XSLTInputSource</jump>.</p>
+<note>The stylesheet may also take the form of a compiled stylesheet (an
instance of <jump
href="apidocs/class_stylesheetroot.html">StylesheetRoot</jump>. If the XML
document contains a stylesheet Processing Instruction (PI), a separate
stylesheet is not required.</note>
+<p>&xslt4c; uses the Xerces DOM parser to parse the input and the Xerces SAX
parser to parse the stylesheet, and sends the output to <jump
href="apidocs/class_xsltresulttarget.html">XSLTResultTarget</jump>.
Your input and output objects can each take the form of a URL or file, a
stream, or a DOM tree.</p>
<p>For detailed API documentation, see <jump href="apidocs/index.html">Xalan
C++ API</jump>. For an overview of the
command-line utility, see <link idref="commandline">Command-Line
Utility</link>.</p>
@@ -111,7 +111,7 @@
theProcessor.setFormatter(&theParserLiaison);</source>
</s3>
<s3 title="4. Create context objects for the stylesheet">
-<p>Use the processor and support objects to set up a stylesheet construction
context object and execution context object.</p>
+<p>Use the processor and support objects to set up stylesheet construction
context and execution context objects.</p>
<source>
StylesheetConstructionContextDefault theConstructionContext(
theProcessor,
@@ -155,7 +155,7 @@
theExecutionContext);</source>
<p>The XSLTResultTarget object now contains the transformation output.</p>
<p>XSLTEngineImpl stores running state information, so it is not
thread-safe. To perform multiple transformations, create a new instance for
each transformation, synchronize the transformations, or call the XSLTProcessor
reset() method between each transformation.</p>
-<p>If you are using the same stylesheet to perform multiple transformations,
compile the stylesheet and use the StylesheetRoot process() method.
StylesheetRoot objects are thread-safe. A single StylesheetRoot object may be
called concurrently from multiple threads. For more information, see xxxx.</p>
+<p>If you are using the same stylesheet to perform multiple transformations,
compile the stylesheet and use the StylesheetRoot process() method.
StylesheetRoot objects are thread-safe. A single StylesheetRoot object may be
called concurrently from multiple threads. For more information, see <link
anchor="compiled">Compiling stylesheets</link>.</p>
<p>For a sample application that performs a transformation, see <link
idref="samples" anchor="simpletransform">SimpleTransform</link>.</p>
</s3>
</s2><anchor name="dom"/>
@@ -249,7 +249,7 @@
theXSLTProcessorEnvSupport,
theXPathSupport,
theXObjectFactory);</source>
-<p>To compile a stylesheet, use the <jump
href="apidocs/class_xsltengineimpl.html">XSLTEngineImpl</jump>
processStylesheet() method. This operation also sets the XXLTEngineImpl
Stylesheet property. In the interest of clarity, you may want to use the
setStylesheet() method to explicitly set that property. Then when you call the
process method, include a 0 for the "uncompiled" stylesheet parameter so
XSLTEngineImpl uses the compiled stylesheet. For example:</p>
+<p>To compile a stylesheet, use the <jump
href="apidocs/class_xsltengineimpl.html">XSLTEngineImpl</jump>
processStylesheet() method. This operation also sets the XSLTEngineImpl
Stylesheet property. In the interest of clarity, you may want to use the
setStylesheet() method to explicitly set that property. Then when you call the
process method, include a 0 for the "uncompiled" stylesheet parameter so
XSLTEngineImpl uses the compiled stylesheet. For example:</p>
<source>
// Compile the stylesheet.
StylesheetRoot* const theStylesheetRoot =
@@ -262,7 +262,7 @@
// Set up an XSLTInputSource object (theInputSource)
// and an XSLTResultTarget object (theResultTarget).
...
-// Do the tranformation...
+// Do the transformation...
theProcessor.process(
theInputSource,
0, //Use the StylesheetRoot
@@ -283,13 +283,6 @@
</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
programmatically 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 executes XPath expressions against XML source files,
see <link idref="samples" anchor="xpath">XPathWrapper</link>.</p>
-</s2>
-<anchor name="debugging"/>
-<s2 title="Debugger Interface">
-<p><em>Placeholder</em>. What do we have to say about TraceListener, the
XSLTEngineImplProcessor addTraceListener() method, and TracerEvents? Must also
figure out what to include and what to cut out of the command line document.</p>
</s2>
</s1>
