dleslie 00/10/02 05:17:12
Modified: c/xdocs/sources/xalan DONE commandline.xml extensions.xml
faq.xml getstarted.xml index.xml readme.xml
samples.xml usagepatterns.xml
Log:
Editorial updates per my own reivew.
Revision Changes Path
1.4 +1 -1 xml-xalan/c/xdocs/sources/xalan/DONE
Index: DONE
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/DONE,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DONE 2000/09/05 13:03:05 1.3
+++ DONE 2000/10/02 12:17:01 1.4
@@ -5,7 +5,7 @@
<li>Full implementation of the format-number() function and support for the
decimal-format element<br/><br/></li>
<li>Integration with the <resource-ref idref="icu"/>for number formatting,
sorting, and output encoding<br/><br/></li>
<li>Support for the exclude-result-prefixes attribute<br/><br/></li>
-<li>Add support for the output encoding attribute</li>
+<li>Support for the output encoding attribute</li>
</ul>
</s3>
1.10 +1 -1 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.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- commandline.xml 2000/09/29 15:44:28 1.9
+++ commandline.xml 2000/10/02 12:17:02 1.10
@@ -123,7 +123,7 @@
support for output encoding. See <resource-ref
idref="xerces-build-icu"/>.</p>
<p>TestXSLT also conditionally includes ICU support for number
formatting and sorting. Look in process.cpp for the
<code>#if defined(XALAN_USE_ICU)</code> blocks. In these blocks,
process.cpp #includes the ICUBridge headers, and
- substitues ICU support for xsl:number, format-number(), and xsl:sort.
To activate this support:</p>
+ substitutes ICU support for xsl:number, format-number(), and xsl:sort.
To activate this support:</p>
<ol>
<li>Download and build the ICU (see <link idref="usagepatterns"
anchor="icu">Using the ICU</link>).<br/><br/></li>
<li>Rebuild TestXSLT with the ICU enabled (see below).</li>
1.8 +3 -3 xml-xalan/c/xdocs/sources/xalan/extensions.xml
Index: extensions.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/extensions.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- extensions.xml 2000/09/29 15:44:28 1.7
+++ extensions.xml 2000/10/02 12:17:02 1.8
@@ -72,7 +72,7 @@
<p>You can send arguments to an extension function in the form of XPath
expressions, literals (for string, boolean, and number), the values returned by
other functions, and XSL variables or parameters set to any of the
preceding.</p>
<p>For an example that implements, installs, and uses three extension
functions, see the
<link idref="samples" anchor="externalfunc">External Functions</link>
sample.</p>
-<note>&xslt4c; does not yet support extension elements. Support for
extension elements will be added in the near future.</note>
+<note>&xslt4c; does not yet support extension elements. Support for
extension elements will be added soon.</note>
</s2><anchor name="implement"/>
<s2 title="Implementing an extension function">
<p>Like the standard XPath functions, the functions you create derive from
the Function base class. Set up your
@@ -82,7 +82,7 @@
in the example below -- to create an XObject corresponding to the XSLT
data type the function returns.<br/><br/></li>
<li>Implement a clone() method to enable Xalan to create and maintain a
copy of the extension
function.<br/><br/></li>
- <li>(Optional) As is the practice for the XPath functions, you may want to
prevent the compiler from generating
+ <li>(Optional) As Xalan does for the XPath functions, you may want to
prevent the compiler from generating
an assignment or equality operator for this function.</li>
</ol>
<p>These features all appear in the following example.</p>
@@ -214,7 +214,7 @@
in the stylesheet element or<br/><br/>
<code>xsl:exclude-result-prefixes="<ref>prefix-1 prefix-2
...</ref>"</code><br/><br/>
in a literal result element or extension element.<br/><br/></li>
-<li>Call the extension function in the same manner you would call an XPath
function. The function name you use in the stylesheet is a Qualified Name
(QName) made up of the prefix you delcared in step 1 and the function name you
specified when you installed the function.<br/><br/>
+<li>Call the extension function in the same manner you would call an XPath
function. The function name you use in the stylesheet is a Qualified Name
(QName) made up of the prefix you declared in step 1 and the function name you
specified when you installed the function.<br/><br/>
You can use XPath expressions, literals (for string, boolean, and number),
and values returned by other functions to
specify function arguments.</li></ol>
<p>Suppose, for example, you are working with XML documents containing area
elements like
1.7 +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.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- faq.xml 2000/09/01 19:23:22 1.6
+++ faq.xml 2000/10/02 12:17:03 1.7
@@ -29,7 +29,7 @@
<p>The XSLTEngineImpl stores running state information, so it is not
thread-safe. If you want to use the XSLTEngineImpl
to perform multiple simultaneous transformations, create a separate
instance for each transformation.
If you want to perform multiple serial transformations with a single
XSLTEngineImpl object, call the XSLTEngineImpl reset()
- method after each transformation. You may want to serialize access to
this object, so it can't accidently start another
+ method after each transformation. You may want to serialize access to
this object, so it can't accidentally start another
transformation while a transformation is in progress.</p>
<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
1.13 +5 -5 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.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- getstarted.xml 2000/09/29 15:44:28 1.12
+++ getstarted.xml 2000/10/02 12:17:04 1.13
@@ -40,7 +40,7 @@
<li>The Xalan-C++ load library: &xslt4c-aixlib;</li>
<li>The Xerces-C++ load library: &xml4c-aixlib;</li>
</ul>
-<p>If you want to enable ICU support for the command-line utility, you must
build the ICU and rebuild the Xal-C++ shared/load library and TestXSLT with the
ICUBridge. See <link idref="usagepatterns" anchor="icu">Using the ICU</link>
and <link idref="commandline" anchor="icu">Enabling ICU support for
TestXSLT</link>.</p>
+<p>If you want to enable ICU support for the command-line utility, you must
build the ICU and rebuild the Xalan-C++ shared/load library (Linux/AIX) and
TestXSLT (all platforms) with the ICUBridge. See <link idref="usagepatterns"
anchor="icu">Using the ICU</link> and <link idref="commandline"
anchor="icu">Enabling ICU support for TestXSLT</link>.</p>
<p>For information about using the command-line utility, see <link
idref="commandline">Command-Line Utility</link>.</p>
</s3>
<s3 title="What you need to build applications">
@@ -48,7 +48,7 @@
Xalan-C++ and Xerces-C++ header (.hpp) files and (for Windows) the &xslt4c;
and &xml4c; libraries (.lib files).</p>
<p>The Xalan-C++ header files are in the src directory 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 on Red Hat Linux 6.1 with a make file
and the GNU C++ compiler), the shared object library is in the lib
subdirectory.</p>
+<p>In the Linux distribution (built with a make file and the GNU C++
compiler on Red Hat Linux 6.1), the shared object library is in the lib
subdirectory.</p>
<p>In the AIX distribution (built with the make file and xlC_r), the load
library is in the lib subdirectory.</p>
<p>To get the Xerces-C++ header and (for Windows) .lib files, download and
expand the &xml4c; binary distribution for your platform from the <resource-ref
idref="xml4c-distdir"/>. For information about which &xml4c; distribution has
been tested with this &xslt4c; release, see <link idref="readme"
anchor="status">Version of &xml4c; to use</link>.</p>
<p>If you want to enable ICU support in your applications, you must rebuild
the Xalan-C++ shared/load library (Linux/AIX) and include the ICUBridge headers
(all platforms).</p>
@@ -63,13 +63,13 @@
<p>If you do your own Xalan, ICU, and Xerces builds, be sure to include the
directories that contain the libraries and the TextXSLT executable on your
path.</p>
</s2><anchor name="samples"/>
<s2 title="Trying out the samples">
-<p>The &xslt4c; distribution includes a number of basic sample applications.
We have precompiled these samples for you so they are ready to run, and you can
review the source files -- all of which are brief -- to see just how they work.
</p>
+<p>The &xslt4c; distribution includes a number of basic sample applications.
We have precompiled these samples for you so they are ready to run, and you can
review the source files to see just how they work. </p>
<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. In the Linux and AIX distributions, the
executables are in xml-xalan/c/bin.</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>Go to the samples subdirectory containing the sample.</li>
+<li>Run the sample from the command line (in Windows, use the DOS
shell).</li>
<li>Examine the application source files.</li>
</ol>
<p>For example, go to the SimpleTransform subdirectory and issue the
following command:</p>
1.11 +0 -3 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.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- index.xml 2000/09/12 21:37:47 1.10
+++ index.xml 2000/10/02 12:17:04 1.11
@@ -98,9 +98,6 @@
Windows, &xml4c-linuxlib; for Linux, and &xml4c-aixlib; for AIX.</p>
<p>To build applications with Xalan and Xerces, you also need the
&xml4c; binary distribution
for your platform, which you can download from the <resource-ref
idref="xml4c-distdir"/>.</p>
- <note>Be sure you are using a compatible &xml4c; build. For information
about the build with
- which this release of &xml4c; was tested, see <link idref="readme"
anchor="status">Version of
- Xerces to use</link>.</note>
</s2>
<s2 title="How about support for internationalization?">
<p>To extend Unicode support for encoding, number formatting, and
sorting, you can download,
1.13 +3 -3 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.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- readme.xml 2000/09/29 15:44:28 1.12
+++ readme.xml 2000/10/02 12:17:04 1.13
@@ -105,7 +105,7 @@
<p>The required &xml4c; files are in the &xml4c; binary distributions.</p>
<p>For information on using the <resource-ref idref="icu"/>, see
<link idref="usagepatterns" anchor="icu">Using the ICU</link>.</p>
- <note>If you are not rebuilding ICUBridge, you do not need the ICU header
or .lib files.</note>
+ <note>If you are not rebuilding with the ICU, you do not need the ICU
header or .lib files.</note>
<p>To rebuild the Windows32 release, use the Microsoft Visual C++ 6.0
project files. To rebuild
the Linux or AIX release, use the make file in the root of the source
directory. The builds look
for &xml4c; and ICU in directories parallel to the
@@ -118,7 +118,7 @@
<s4 title="&xml4c; and ICU layout for &xslt4c; build">
<p><img src="xerces-icu.gif" alt="xerces-icu.gif"/></p>
</s4>
-<note>Keep in mind that at any given point in time the &xslt4c; and &xml4c;
source trees in the Apache XML repository may not be consistent. When we
release a version of &xslt4c; we certify that it is compabible with a given
release of &xml4c;. To be safe, stick with distributions that we certify to be
compatible. Reminder: &xslt4c-current; is compatible with
&xml4c-used;.<br/><br/>
+<note>Keep in mind that at any given point in time the &xslt4c; and &xml4c;
source trees in the Apache XML repository may not be consistent. When we
release a version of &xslt4c; we certify that it is compatible with a given
release of &xml4c;. To be safe, stick with distributions that we certify to be
compatible. Reminder: &xslt4c-current; is compatible with
&xml4c-used;.<br/><br/>
&xslt4c-current; has been tested with &icu-used;. You may be able to use
newer ICU releases as they appear.</note>
</s3><anchor name="win32"/>
<s3 title="Steps for doing a Windows build">
@@ -158,7 +158,7 @@
<code>chmod +x
conf*</code><br/><br/></li>
<li>Run the runConfigure utility with at least the platform flag
(Linux) or the platform, C compilier, and C++ compiler flags (AIX) as indicated
below.<br/><br/>
<ref>Linux:</ref> <code>runConfigure -p linux</code><br/>
- <ref>AIX:</ref> <code>runConfigure -p aix -c xlc_r -x
xlC-R</code><br/><br/>
+ <ref>AIX:</ref> <code>runConfigure -p aix -c
xlc_r -x xlC-R</code><br/><br/>
To see the other runConfigure flags you may include, use the help
flag:<br/><br/>
<code>runConfigure
-h</code><br/><br/></li>
<li>Run the make file:<br/><br/>
1.10 +4 -4 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.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- samples.xml 2000/09/29 15:44:28 1.9
+++ samples.xml 2000/10/02 12:17:05 1.10
@@ -83,10 +83,10 @@
modify a .cpp file, you must rebuild the executable and place it on
the path before you can run the
modified application.</li>
</ol>
- <p><em>Caution:</em> Each sample application looks for input files in
the current directory, the directory from
+ <Note> Each sample application looks for input files in the current
directory, the directory from
which you run the application. The input files are in the samples
subdirectory along with the sample source
files. The application executable, on the other hand, is in the build
subdirectory. To run a sample, be sure the
- executable is on the path, and run it from the samples subdirectory
that contains the input files.</p>
+ executable is on the path, and run it from the samples subdirectory
that contains the input files.</note>
</s2><anchor name="simpletransform"/>
<s2 title="SimpleTransform">
<p>What it does: The SimpleTransform class uses the foo.xsl stylesheet
to transform foo.xml, and writes the
@@ -172,8 +172,6 @@
<p>where <ref>XMLFile</ref> is an XML source file,
<ref>ContextNode</ref> is the location path to the context
node, and <ref>XPathExpression</ref> is an XPath expression to apply to
that context node. The XPathWrapper
subdirectory contains an XML file named xml.foo (part of it appears
below).</p>
- <note>If an XPathWrapper argument includes characters (such as *) that
the shell intercepts, enclose the argument
- in double quotes.</note>
<source><?xml version="1.0"?>
<doc>
<name first="David" last="Marston"/>
@@ -185,6 +183,8 @@
<p><code>TestDriver foo.xml /doc name/@last</code></p>
<p>and</p>
<p><code>TestDriver foo.xml //name[position()="4"]./@first</code></p>
+ <note>If an XPathWrapper argument includes characters (such as *) that
the shell intercepts, enclose the argument
+ in double quotes.</note>
<p>See also: <link idref="usagepatterns" anchor="xpath">Working with
XPath expressions</link>.</p>
</s2><anchor name="externalfunctions"/>
<s2 title="ExternalFunctions">
1.9 +6 -5 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.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- usagepatterns.xml 2000/09/29 15:44:28 1.8
+++ usagepatterns.xml 2000/10/02 12:17:06 1.9
@@ -155,7 +155,7 @@
<p>If you are using the same stylesheet to perform multiple transformations,
for efficiency you should compile the stylesheet and use the appropriate
XSLTEngineImpl process() method. Compiled stylesheet (StylesheetRoot) objects
are also thread-safe. A single StylesheetRoot object may be called concurrently
from multiple threads. For more information, see <link
anchor="compiled">Compiling stylesheets</link>.</p>
</s3>
<s3 title="7. Shut down Xerces.">
-<p>When you are done performing transformationsw, shut down Xerces.</p>
+<p>When you are done performing transformations, shut down Xerces.</p>
<source>// Call the static terminator for Xerces.
XMLPlatformUtils::Terminate();
</source>
@@ -247,7 +247,7 @@
theXSLTProcessorEnvSupport,
theXPathSupport,
theXObjectFactory);</source>
-<p>Compile the stylesheet, add the StylesheetRoot object to the execution
context, and start performing transformations. Use the XSLTEngineImpl process()
method (see below) that takes advantage of the compiled stylesheet. Be sure to
reset the processer and execution context between each transformation. For
example:</p>
+<p>Compile the stylesheet, add the StylesheetRoot object to the execution
context, and start performing transformations. Use the XSLTEngineImpl process()
method (see below) that takes advantage of the compiled stylesheet. Be sure to
reset the processor and execution context between each transformation. For
example:</p>
<source>
// Compile the stylesheet.
StylesheetRoot* const theStylesheetRoot =
@@ -288,7 +288,7 @@
<p>For an example that executes XPath expressions against XML source files,
see <link idref="samples" anchor="xpath">XPathWrapper</link>.</p>
</s2><anchor name="tracelistener"/>
<s2 title="Using TraceListener">
-<p>TraceListener is a debugging abstract base class implemented by
TraceListenerDefault. You can use TraceListener to trace any combination of the
folllowing:</p>
+<p>TraceListener is a debugging abstract base class implemented by
TraceListenerDefault. You can use TraceListener to trace any combination of the
following:</p>
<ul>
<li>Calls to templates</li>
<li>Calls to template children</li>
@@ -315,7 +315,7 @@
pattern and optional decimal-format name. If you install ICU support
for format-number(),
this function is fully supported with all its arguments.<br/><br/></li>
<li><em>xsl:sort</em>
- <br/>If you install ICU spport for xml:sort, &xslt4c; applies the
Unicode sorting
+ <br/>If you install ICU support for xml:sort, &xslt4c; applies the
Unicode sorting
algorithm.</li>
</ul>
@@ -342,7 +342,7 @@
want to enable ICU support:</p>
<ol>
<li>Include the ICUBridge headers.<br/><br/></li>
- <li>Substitue ICU support for format-number(), xsl:number, and/or
xsl:sort.<br/><br/></li>
+ <li>Substitute ICU support for format-number(), xsl:number, and/or
xsl:sort.<br/><br/></li>
<li>Windows: Provide your application access to the ICUBridge
library.<br/>
Linux or AIX: Rebuild the Xalan library to include the ICUBridge.</li>
</ol>
@@ -358,6 +358,7 @@
(LD_LIBRARY_PATH for Red Hat Linux 6.1) or copy it to /usr/lib.</p>
<p>For AIX, rebuild &xslt4c-linuxlib;/&xslt4c-aixlib; with XALAN_USE_ICU
defined, and place it on the load library
path (LIB_PATH) or copy it to /usr/lib.</p>
+ <p><em>Number formatting</em></p>
<p>To enable ICU support for the xsl:number element and the XSLT
format-number() function, do
the following:</p>
<source>// Install ICU support for the format-number() function.
