dmitryh 2004/04/12 08:24:17
Modified: c/xdocs/sources/xalan extensions.xml extensionslib.xml
faq.xml getstarted.xml history.xml readme.xml
usagepatterns.xml
Log:
Initial patch for documentation
Revision Changes Path
1.23 +1 -1 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.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- extensions.xml 26 Feb 2004 22:24:07 -0000 1.22
+++ extensions.xml 12 Apr 2004 15:24:17 -0000 1.23
@@ -119,7 +119,7 @@
}</source>
</s2><anchor name="install"/>
<s2 title="Installing an extension function">
-<p><jump href="apidocs/class_xalantransformer.html">XalanTransformer</jump>
provides methods for installing and unistalling external functions:</p>
+<p><jump href="apiDocs/class_xalantransformer.html">XalanTransformer</jump>
provides methods for installing and unistalling external functions:</p>
<ul>
<li>installExternalFunction() makes the function available in the current
instance of XalanTransformer. Use uninstallExternalFunction() to remove the
function.<br/><br/></li>
<li>installExternalFunctionGlobal() makes the function available globally.
Use uninstallExternalFunctionGlobal() to remove the function. The global
install and unistall operations are not thread-safe. However, all global
functions should be thread-safe, because multiple threads could call a
particular function instance at the same time.</li>
1.10 +12 -12 xml-xalan/c/xdocs/sources/xalan/extensionslib.xml
Index: extensionslib.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/extensionslib.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- extensionslib.xml 26 Feb 2004 22:24:07 -0000 1.9
+++ extensionslib.xml 12 Apr 2004 15:24:17 -0000 1.10
@@ -41,12 +41,12 @@
<p>The source files for the implementations are in the XalanEXSLT
subdirectory of the source tree.
See</p>
<ul>
-<li><jump
href="apidocs/XalanEXSLTCommonImpl.hpp.html">XalanEXSLTCommonImpl</jump></li>
-<li><jump
href="apidocs/XalanEXSLTMathImpl.hpp.html">XalanEXSLTMathImpl</jump></li>
-<li><jump
href="apidocs/XalanEXSLTSetImpl.hpp.html">XalanEXSLTSetImpl</jump></li>
-<li><jump
href="apidocs/XalanEXSLTStringImpl.hpp.html">XalanEXSLTStringImpl</jump></li>
-<li><jump
href="apidocs/XalanEXSLTDynamicImpl.hpp.html">XalanEXSLTDynamicImpl</jump></li>
-<li><jump
href="apidocs/XalanEXSLTDateTimeImpl.hpp.html">XalanEXSLTDateTimeImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTCommonImpl_8hpp.html">XalanEXSLTCommonImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTMathImpl_8hpp.html">XalanEXSLTMathImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTSetImpl_8hpp.html">XalanEXSLTSetImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTStringImpl_8hpp.html">XalanEXSLTStringImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTDynamicImpl_8hpp.html">XalanEXSLTDynamicImpl</jump></li>
+<li><jump
href="apiDocs/XalanEXSLTDateTimeImpl_8hpp.html">XalanEXSLTDateTimeImpl</jump></li>
</ul>
<p>For the function specifications, see:</p>
<ul>
@@ -69,7 +69,7 @@
</s2>
<anchor name="nodeset"/>
<s2 title= "nodeset">
-<p>Implemented in <jump
href="apidocs/class_functionnodeset.html">FunctionNodeSet</jump>, <code>nodeset
(result-tree-fragment)</code> casts a result tree fragment into a node-set.</p>
+<p>Implemented in <jump
href="apiDocs/class_functionnodeset.html">FunctionNodeSet</jump>, <code>nodeset
(result-tree-fragment)</code> casts a result tree fragment into a node-set.</p>
<note>When you bind a variable to a template, rather than to the value
generated by a select expression, the data type of the variable is result tree
fragment. For more information, see <jump
href="http://www.w3.org/TR/xslt#section-Result-Tree-Fragments";>Result Tree
Fragments</jump>.</note>
<anchor name="ex-nodeset"/>
<s3 title="Example with the nodeset extension function">
@@ -105,22 +105,22 @@
</s3>
</s2><anchor name="intersection"/>
<s2 title="intersection">
-<p>Implemented in <jump
href="apidocs/class_functionintersection.html">FunctionIntersection</jump>,
<code>intersection (node-set1, node-set2)</code> returns a node-set with all
nodes that are in ns1 and in ns2.</p>
+<p>Implemented in <jump
href="apiDocs/class_functionintersection.html">FunctionIntersection</jump>,
<code>intersection (node-set1, node-set2)</code> returns a node-set with all
nodes that are in ns1 and in ns2.</p>
</s2><anchor name="difference"/>
<s2 title= "difference">
-<p>Implemented in <jump
href="apidocs/class_functiondifference.html">FunctionDifference</jump>,
<code>difference(node-set1, node-set2)</code> returns a node-set with the nodes
in node-set1 and not in node-set2.</p>
+<p>Implemented in <jump
href="apiDocs/class_functiondifference.html">FunctionDifference</jump>,
<code>difference(node-set1, node-set2)</code> returns a node-set with the nodes
in node-set1 and not in node-set2.</p>
</s2><anchor name="distinct"/>
<s2 title= "distinct">
- <p>Implemented in <jump
href="apidocs/class_functiondistinct.html">FunctionDistinct</jump>, distinct
(node-set) returns a node-set containing nodes with distinct string values. If
more than one node in the node-set
+ <p>Implemented in <jump
href="apiDocs/class_functiondistinct.html">FunctionDistinct</jump>, distinct
(node-set) returns a node-set containing nodes with distinct string values. If
more than one node in the node-set
contains the same text node value, distinct only returns the first of these
nodes that it finds.</p>
</s2><anchor name="evaluate"/>
<s2 title= "evaluate">
- <p>Implemented in <jump
href="apidocs/class_functionevaluate.html">FunctionEvaluate</jump>,
<code>evaluate (xpath-expression)</code> returns the result of evaluating the
xpath-expression in the current
+ <p>Implemented in <jump
href="apiDocs/class_functionevaluate.html">FunctionEvaluate</jump>,
<code>evaluate (xpath-expression)</code> returns the result of evaluating the
xpath-expression in the current
XPath expression context (automatically passed in by the extension
mechanism).</p>
<p>Use the evaluation extension function when the value of the expression is
not known until run time.</p>
</s2>
<anchor name="hassamenodes"/>
<s2 title= "hasSameNodes">
-<p>Implemented in <jump
href="apidocs/class_functionhassamenodes.html">FunctionHasSameNodes</jump>,
<code>hasSameNodes(node-set1, node-set2)</code> returns true if both node-set1
and node-set2 contain exactly the same set of nodes.</p>
+<p>Implemented in <jump
href="apiDocs/class_functionhassamenodes.html">FunctionHasSameNodes</jump>,
<code>hasSameNodes(node-set1, node-set2)</code> returns true if both node-set1
and node-set2 contain exactly the same set of nodes.</p>
</s2>
</s1>
1.46 +4 -4 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.45
retrieving revision 1.46
diff -u -r1.45 -r1.46
--- faq.xml 26 Feb 2004 22:24:07 -0000 1.45
+++ faq.xml 12 Apr 2004 15:24:17 -0000 1.46
@@ -65,12 +65,12 @@
Xalan, using the internal DOM implementation is the best approach.</p>
<p>In cases where you want to modify the DOM document on the fly,
-wyou should use the Xerces DOM as the base document. You can wrap the
-Xerces DOM in a wrapper (see <link anchor="xercesdomwrapperparsedsource">
+you should use the Xerces DOM as the base document. You can wrap the
+Xerces DOM in a wrapper (see <link idref="usagepatterns"
anchor="xercesdomwrapperparsedsource">
passing in a Xerces DOM</link>) to then use as an input to a Xalan
transformation. Alternatively you can output the result of
a transformation to a Xerces DOM document (see
-<link anchor="dom">working with DOM input and output</link>).
+<link idref="usagepatterns" anchor="dom">working with DOM input and
output</link>).
In either case, the Xerces
document can be freely modified. However, after you modify the document,
you need to re-build the wrapper so that any changes are replicated in the
@@ -133,7 +133,7 @@
<jump href="http://www.gnu.org/software/tar/tar.html";>
http://www.gnu.org/software/tar/tar.html</jump>. For additional
background information on this problem, see the online manual
- <jump
href="http://www.gnu.org/manual/tar/html_node/tar_117.html#SEC112";>
+ <jump
href="http://www.gnu.org/manual/tar/html_chapter/tar_8.html#SEC112";>
GNU tar and POSIX tar </jump> for the utility.
</p>
</a>
1.49 +2 -1 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.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- getstarted.xml 26 Feb 2004 22:24:07 -0000 1.48
+++ getstarted.xml 12 Apr 2004 15:24:17 -0000 1.49
@@ -147,6 +147,7 @@
<anchor name="xalandists"/>
<p>If you want to take advantage of the support for number formatting,
sorting, and encoding the ICU provides, you should also download and install
the <resource-ref idref="icu"/>; see <link idref="usagepatterns"
anchor="icu">Using the ICU</link>,</p>
+<note>To access previous releases of &xslt4c;, visit the <jump
href="http://archive.apache.org/dist/xml/xalan-c/";>Xalan-C archive
directory</jump>.</note>
</s2><anchor name="path"/>
<s2 title="Setting up the path/library path">
<ul>
@@ -200,7 +201,7 @@
<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
-&xslt4c-win_root;\Build\Win32\VC6\Release. In the UNIX distributions, the
executables are in &xslt4c-win_root;/bin.</li>
+&xslt4c-win_root;\Build\Win32\VC6\Release. In the UNIX distributions, the
executables are in &xslt4c-unix_root;/bin.</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>
1.11 +3 -3 xml-xalan/c/xdocs/sources/xalan/history.xml
Index: history.xml
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/history.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- history.xml 26 Feb 2004 22:24:07 -0000 1.10
+++ history.xml 12 Apr 2004 15:24:17 -0000 1.11
@@ -67,10 +67,10 @@
<ul>
<li><link idref="extensionslib">Introduction of a library of extension
functions</link></li>
<li>Support for pre-parsed source documents and pre-compiled
stylesheets in
- <jump
href="apidocs/class_xalantransformer.html">XalanTransformer</jump> and the C
API.</li>
- <li>Support for stylesheet params in <jump
href="apidocs/class_xalantransformer.html">XalanTransformer</jump>
+ <jump
href="apiDocs/class_xalantransformer.html">XalanTransformer</jump> and the C
API.</li>
+ <li>Support for stylesheet params in <jump
href="apiDocs/class_xalantransformer.html">XalanTransformer</jump>
and the C API</li>
- <li>Support for extension functions in <jump
href="apidocs/class_xalantransformer.html">XalanTransformer</jump></li>
+ <li>Support for extension functions in <jump
href="apiDocs/class_xalantransformer.html">XalanTransformer</jump></li>
<li>Performance enhancements</li>
</ul>
</s3>
1.54 +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.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- readme.xml 4 Apr 2004 18:30:03 -0000 1.53
+++ readme.xml 12 Apr 2004 15:24:17 -0000 1.54
@@ -218,7 +218,7 @@
</ul>
<p>Regardless of which method you choose, a message file containing
translated messages in the
language of your choice must be provided. The standard message file
provided in the &xslt4c;
- version 1.7 beta source package is in XML Localization Interchange File
Format (XLIFF) format
+ version 1.7 source package is in XML Localization Interchange File Format
(XLIFF) format
and conforms to the XLIFF 1.1 standard (please see
<jump
href="http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm";>
http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm</jump>
for more
@@ -231,7 +231,7 @@
<ol>
<li>Open the Xalan.dsw workspace using Microsoft Visual C++. The "inmem"
localization method should be configured by default.</li>
<li>Select the Localization project, and go to Settings and click on the
"General" tab.Verify
- the build command line to use "nmake /f Localization.mak TYPE=inmem
LOCAL=en_US"</li>
+ the build command line to use "nmake /f BuildMessages.mak TYPE=inmem
LOCAL=en_US"</li>
<li>Add the Xerces-C bin directory to the PATH </li>
<li>Add the Xerces-C lib directory to the library directory list </li>
<li>Add the Xerces-C include directory to the include directory list.
</li>
@@ -243,7 +243,7 @@
<li>Select the AllInOneWithICU project, and ensure that the project
depends on the LocalizationWithICU
project. </li>
<li>Select the LocalizationWithICU project, and go to Settings and click
on the "General" tab. Modify
- the build command line to use "nmake /f Localization.mak TYPE=icu
LOCAL=en_US"</li>
+ the build command line to use "nmake /f BuildMessages.mak TYPE=icu
LOCAL=en_US"</li>
<li>Add the Xerces-C bin directory and ICU bin directory to the PATH </li>
<li>Add the Xerces-C lib directory and ICU lib directory to the library
directory list </li>
<li>Add the Xerces-C include directory and ICU include directory to the
include directory list </li>
1.44 +23 -24 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.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- usagepatterns.xml 26 Feb 2004 22:24:07 -0000 1.43
+++ usagepatterns.xml 12 Apr 2004 15:24:17 -0000 1.44
@@ -36,11 +36,11 @@
<s2 title="Introduction">
<p>
To perform a transformation, use one of the
- <jump href="apidocs/class_xalantransformer.html">XalanTransformer
+ <jump href="apiDocs/class_xalantransformer.html">XalanTransformer
</jump> transform() methods. The transformation requires an XML
source
document and an XSL stylesheet. Both of these objects may be
represented by instances of
- <jump href="apidocs/class_xsltinputsource.html">XSLTInputSource
+ <jump href="apiDocs/class_xsltinputsource.html">XSLTInputSource
</jump>. You can construct an XSLTInputSource with a string (the
system ID for a file or URI), an input stream, or a DOM.
</p>
@@ -48,10 +48,10 @@
If you are using an XSL stylesheet to perform a series of
transformations, you can improve performance by calling transform()
with a compiled stylesheet, an instance of
- <jump href="apidocs/class_xalancompiledstylesheet.html">
+ <jump href="apiDocs/class_xalancompiledstylesheet.html">
XalanCompiledStylesheet</jump>. If you are transforming an XML
source more than once, you should call transform() with a parsed XML
- source, an instance of <jump href="apidocs/class_xalanparsedsource">
+ source, an instance of <jump href="apiDocs/class_xalanparsedsource">
XalanParsedSource</jump>. See <link
anchor="compiled">Performing
a series of transformations</link>.
</p>
@@ -62,14 +62,14 @@
</p>
<p>
The transformation output is represented by an
- <jump href="apidocs/class_xsltresulttarget.html">XSLTResultTarget
+ <jump href="apiDocs/class_xsltresulttarget.html">XSLTResultTarget
</jump>, which you can set up to refer to an output stream, the
system ID for a file or URI, or a Formatter for one of the various
styles of DOM output.
</p>
<p>
For detailed API documentation, see
- <jump href="apidocs/index.html">&xslt4c; API</jump>. For an overview
+ <jump href="apiDocs/index.html">&xslt4c; API</jump>. For an overview
of the command-line utility, see <link idref="commandline">
Command-Line Utility</link>.
</p>
@@ -77,7 +77,7 @@
<anchor name="xalantransformer"/>
<s2 title="Basic usage patten with the XalanTransformer C++ API">
<p>
- Using <jump
href="apidocs/class_xalantransformer.html">XalanTransformer</jump> and the C++
API, you can perform one or more transformations as described in the following
steps.
+ Using <jump
href="apiDocs/class_xalantransformer.html">XalanTransformer</jump> and the C++
API, you can perform one or more transformations as described in the following
steps.
</p>
<note>
For a working sample that illustrates these steps, see the <link
idref="samples" anchor="xalantransform">XalanTransform</link> sample.
@@ -142,11 +142,11 @@
<s3 title="5. Perform each transformation.">
<p>
You can explicitly instantiate
- <jump href="apidocs/class_xsltinputsource.html">XSLTInputSource
+ <jump href="apiDocs/class_xsltinputsource.html">XSLTInputSource
</jump> objects for the XML source document and XSL stylesheet,
- and an <jump href="apidocs/class_xsltresulttarget.html">
+ and an <jump href="apiDocs/class_xsltresulttarget.html">
XSLTResultTarget</jump> object for the output, and then call
- <jump
href="apidocs/class_xalantransformer.html">XalanTransformer
+ <jump
href="apiDocs/class_xalantransformer.html">XalanTransformer
</jump> transform() with those objects as parameters. For
example:
</p>
<source>
@@ -160,8 +160,8 @@
Alternatively, you can call transform() with the strings
(system
identifiers), streams, and/or DOMs that the compiler needs to
implicitly construct the
- <jump href="apidocs/class_xsltinputsource.html">XSLTInputSource
- </jump> and <jump href="apidocs/class_xsltresulttarget.html">
+ <jump href="apiDocs/class_xsltinputsource.html">XSLTInputSource
+ </jump> and <jump href="apiDocs/class_xsltresulttarget.html">
XSLTResultTarget</jump> objects. For example:
</p>
<source>
@@ -172,9 +172,9 @@
theXalanTransformer.transform(xmlIn,xslIn,xmlOut)
</source>
<p>
- Keep in mind that <jump
href="apidocs/class_xsltinputsource.html">
+ Keep in mind that <jump
href="apiDocs/class_xsltinputsource.html">
XSLTInputSource</jump> and
- <jump
href="apidocs/class_xsltresulttarget.html">XSLTResultTarget
+ <jump
href="apiDocs/class_xsltresulttarget.html">XSLTResultTarget
</jump> provide a variety of single-argument constructors that
you
can use in this manner:
</p>
@@ -255,7 +255,7 @@
</p>
<p>
To set a stylesheet parameter, use the
- <jump href="apidocs/class_xalantransformer.html">XalanTransformer
+ <jump href="apiDocs/class_xalantransformer.html">XalanTransformer
</jump> setStylesheetParam() method. The setStytlesheetParam() method
takes two arguments: the parameter name and the expression. For
example:
</p>
@@ -302,7 +302,7 @@
<anchor name="incremental"/>
<s2 title="Processing output incrementally">
<p>
- <jump href="apidocs/class_xalantransformer.html">XalanTransformer
+ <jump href="apiDocs/class_xalantransformer.html">XalanTransformer
</jump> provides a transform() method that sends the output in
blocks to a callback function, which enables you to begin processing
the output while the transformation is still in process:
@@ -332,12 +332,12 @@
the binary representation when you call transform().
</p>
<p>
- <jump href="apidocs/class_xalantransformer.html">XalanTransformer
+ <jump href="apiDocs/class_xalantransformer.html">XalanTransformer
</jump> includes methods for creating compiled stylesheets and
parsed XML documents: the compileStylesheet() method returns a
- pointer to a <jump href="apidocs/class_xalancompiledstylesheet.html">
+ pointer to a <jump href="apiDocs/class_xalancompiledstylesheet.html">
XalanCompiledStylesheet</jump>; the parseSource() method
returns a
- pointer to a <jump href="apidocs/class_xalanparsedsource.html">
+ pointer to a <jump href="apiDocs/class_xalanparsedsource.html">
XalanParsedSource</jump>.
</p>
<note>
@@ -379,7 +379,7 @@
<anchor name="dom"/>
<s2 title="Working with DOM input and output">
<p>
- You can set up an <jump href="apidocs/class_xsltresulttarget.html">
+ You can set up an <jump href="apiDocs/class_xsltresulttarget.html">
XSLTResultTarget</jump> to produce a DOM when you perform a
transformation. You can also use a DOM as input for a transformation.
</p>
@@ -452,7 +452,7 @@
<anchor name="xercesdomwrapperparsedsource"/>
<s3 title="Passing in a Xerces DOM to a transformation">
<p>
- You may want to use a Xerces DOM that was created without using
the XalanTransformer class. As the following code snippet illustrates, you can
use <jump
href="apidocs/class_xercesdomwrapperparsedsource.html">XercesDOMWrapperParsedSource</jump>
to pass in a Xerces DOM as the source for an XSL transformation.
+ You may want to use a Xerces DOM that was created without using
the XalanTransformer class. As the following code snippet illustrates, you can
use <jump
href="apiDocs/class_xercesdomwrapperparsedsource.html">XercesDOMWrapperParsedSource</jump>
to pass in a Xerces DOM as the source for an XSL transformation.
</p>
<source>
#include <xercesc/parsers/DOMParser.hpp>
@@ -555,7 +555,6 @@
accompanies the download.
<br/><em>Important</em> For Windows, be sure to install the ICU
on the same drive and at
the same level as &xslt4c; and &xml4c;.<br/><br/></li>
- <li>Set the ICU_DATA environment variable as indicated in the
readme.html.</li>
</ol>
<anchor name="icusupport"/>
<s3 title="Enabling ICU support for encoding">
@@ -627,7 +626,7 @@
<anchor name="capi"/>
<s2 title="Basic XalanTransformer usage pattern with the C API">
<p>
- We also include a simple C interface for using the XalanTransformer
class. See <jump
href="apidocs/XalanCAPI.h.html">XalanTransformer/XalanCAPI.h</jump>.
+ We also include a simple C interface for using the XalanTransformer
class. See <jump
href="apiDocs/XalanCAPI_8h.html">XalanTransformer/XalanCAPI.h</jump>.
The <link idref="samples" anchor="apachemodulexslt">ApacheModuleXSLT</link>
sample illustrates the use of this C API.
</p>
<p>Basic strategy:</p>
@@ -667,7 +666,7 @@
<anchor name="cvar"/>
<s2 title="Variations with the XalanTransformer C API">
<p>
- The <jump href="apidocs/XalanCAPI.h.html">Xalan C API</jump> supports
approximately the same set of options as the C++ API. In particular, you can
+ The <jump href="apiDocs/XalanCAPI_8h.html">Xalan C API</jump>
supports approximately the same set of options as the C++ API. In particular,
you can
</p>
<ul>
<li>Use stylesheet processing instructions (PI) to indicate the URI
of the stylesheet. Supply NULL for the stylesheet argument.<br/><br/></li>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
