You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by sh...@apache.org on 2012/06/16 06:28:16 UTC
svn commit: r1350859 [5/7] - in /xalan/c/trunk/xdocs: ./ html/ html/apiDocs/
sources/ sources/xalan-graphic/ sources/xalan/ sources/xslt-resources/
style/ style/dtd/
Added: xalan/c/trunk/xdocs/sources/xalan/readme.xml
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/sources/xalan/readme.xml?rev=1350859&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/sources/xalan/readme.xml (added)
+++ xalan/c/trunk/xdocs/sources/xalan/readme.xml Sat Jun 16 04:28:14 2012
@@ -0,0 +1,337 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE s1 SYSTEM "../../style/dtd/document.dtd"[
+<!ENTITY done-c SYSTEM "DONE">
+<!ENTITY status-c SYSTEM "STATUS">
+<!ENTITY history-c SYSTEM "history.xml">]>
+
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+<s1 title="&xslt4c; Release Notes">
+<p>Release notes for &xslt4c-current;</p>
+ <ul>
+ <li><link anchor="status">Status</link></li>
+ <li><link anchor="build">Rebuilding &xslt4c; and the sample applications</link></li>
+ <li><link anchor="contact">Getting in touch</link></li>
+ <li><link anchor="history">History of software changes</link></li>
+ </ul>
+ <anchor name="status"/>
+ <s2 title="Status">
+ <ul>
+ <li><link anchor="done">Changes for &xslt4c; version 1.8</link></li>
+ <li><link anchor="bugs">Bug reporting</link></li>
+ <li><link anchor="xml4c">Version of &xml4c; to use</link></li>
+ <li><link anchor="to-do">To-do tasks for future &xslt4c; releases</link></li>
+ </ul>
+ <anchor name="done"/>
+ <s3 title="Changes for &xslt4c; version 1.8">
+ <p>Major updates since version 1.7 include:</p>
+ <ul>
+ <li><resource-ref idref="bugsfixedforthisrelease"/>.</li>
+ <li>Upgrade from Xerces-C 2.4 to Xerces-C 2.5. </li>
+ <li>Provide build support for Cygwin and HP-UX 11.00 on Itanium. Although binary distributions are not provided for the Cygwin environment and
+ HP-UX 11.00 on Itanium platform, the build configuration files provided in the source distribution can be used to build on these platforms. </li>
+ <li>Project files for supporting Microsoft Visual Studio .NET. Although a binary distribution for the Microsoft Visual Studio .NET
+ is not provided in this release, Visual Studio solution files are provided in the Windows source distribution for those who choose to build
+ on this platform. Please see <link anchor="dotNet">"Step for doing a Windows Build with Visual Studio .NET"</link> for details.</li>
+ <li>Additional changes to Xerces Deprecated DOM support. This is another step towards phasing out the support for Xerces Deprecated DOM. Users are encouraged to modify their applications to interface with the new Xerces DOM support. For more information on the effects of these changes to your build environment, please see <link anchor="xercesdepdom">"Steps for doing a Build with Xerces Deprecated DOM Support"</link></li>
+ <!--
+ <li>Porting of conf utility to the UNIX platform. The conf utility is a test harness designed to run the conformance tests located under the xml-xalan/test/tests directory. After the tests have been run, a results report is generated in HTML format for easy viewing. For more information on how to use this tool, please see <link idref="commandline" anchor="confexe">"Using the command line utility"</link>.</li>
+ -->
+ <li>Implemented optimizations to significantly improve the throughput of the ICU-enabled "format-number" function.</li>
+ <li>Changes in the XML Serializer. The serializer will no longer put a newline after the xml header tag unless indent="yes". See bugzilla <jump href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=24304">24304</jump> and <jump href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=28386">28386</jump>.</li>
+ </ul>
+ </s3>
+
+ <anchor name="bugs"/>
+ <s3 title="Bug reporting">
+ <p>All known &xslt4c; bugs are listed in <resource-ref idref="jira"/>. For a list of open bugs with links to each bug
+ report, see <resource-ref idref="buglist"/>. If you find a new bug, please enter a XalanC bug report in this
+ database.</p>
+ <note>Before you can enter your first bug report, you must submit your email address to Jira and receive a password.</note>
+ <p>We strongly encourage you write patches for problems you find and submit them to
+ xalan-dev@xml.apache.org. We review the patches we receive to make sure they do not break something else, and (assuming they
+ do not) include them in our next release. In the interest of fixing bugs, adding enhancements, and addressing outstanding design
+ issues, we sincerely want (and need!) your active participation in the ongoing development of Xalan.</p>
+ </s3><anchor name="xml4c"/>
+ &status-c;
+ </s2><anchor name="build"/>
+ <s2 title="Rebuilding &xslt4c;">
+<ul>
+<li><link anchor="jar">Rebuilding &xslt4c;</link></li>
+<li><link anchor="samples">Rebuilding sample applications</link></li>
+</ul>
+<anchor name="jar"/>
+ <s3 title="Rebuilding &xslt4c;">
+ <ul>
+ <li><link anchor="needed">What you need from the distributions</link></li>
+ <li><link anchor="win32">Steps for doing a Windows Build</link></li>
+ <li><link anchor="dotNet">Steps for doing a Windows Build with Visual Studio .NET</link></li>
+ <li><link anchor="unix">Steps for doing a UNIX build</link></li>
+ <li><link anchor="locale">Steps for doing a Build with Message Localization Support</link></li>
+ <li><link anchor="xercesdepdom">Steps for doing a Build with Xerces Deprecated DOM Support</link></li>
+ </ul></s3><anchor name="needed"/>
+ <s3 title="What you need from the distributions">
+ <p>To rebuild &xslt4c;, you need the &xslt4c; source files, the &xml4c; header files, and
+ for Windows the &xml4c; .lib file. If you want to rebuild with the ICU, you will need to download the ICU source package to build the ICU libraries. </p>
+
+<note>You can also download &xslt4c; source distributions from <resource-ref idref="xslt4c-distdir"/>: &xslt4c-dist;-src.zip and &xslt4c-dist;-src.tar.gz. &xml4c; source distributions are available from <resource-ref idref="xml4c-distdir"/>:
+&xml4c-dist;-src.zip and &xml4c-dist;-src.tar.gz.</note>
+<p>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 version of &xml4c;. To be safe, use the Xerces distributions that we certify as compatible. Reminder: &xslt4c-current; is compatible with &xml4c-used;.</p>
+ <p>For information on using the <resource-ref idref="icu"/>, see
+ <link idref="usagepatterns" anchor="icu">Using the ICU</link>.
+ The recommended version of ICU for &xslt4c-current; is &icu-current;. You may be able to use newer ICU releases as they appear.</p>
+ </s3><anchor name="win32"/>
+ <s3 title="Steps for doing a Windows build">
+ <p>To build &xslt4c; on Windows, you need &xml4c; and MS Visual C++ 6.0 installed with Service Pack 5 for Visual C++ and Visual Studio .NET.</p>
+ <p>If you are using a different Service Pack, you must rebuild all of the Xerces and Xalan binaries.</p>
+<p>Before you do the following, be sure you have <link idref="getstarted" anchor="windowspath">provided Visual C++ the paths to the Xerces headers and libraries</link>.</p>
+ <ol>
+ <li>Create the ICUROOT environment variable and set it the the path of the ICU root.</li>
+ <li>Create the XERCESCROOT environment variable and set it to the path of the root of &xml4c;.</li>
+ <li>Use Visual C++ to open the Xalan workspace (.dsw) from the &xslt4c-win_root;\Projects\Win32\VC6. If you are building with ICU, then use XalanICU.dsw. Otherwise, open the Xalan.dsw workspace.<br/><br/>
+ <note>You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.</note>
+ <br/>
+ As an alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual C++. From the "Options" window, click on the "Directories" tab and do the following:
+ <ol>
+ <li>Show Directories for: Executable files. Add the Xerces bin directory to the list.</li>
+ <li>Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.</li>
+ <li>Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.</li>
+ </ol></li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)</note>
+ <p><img src="options-sane.gif" alt="Visual C++ 6.0 Include Directories change"/></p>
+</s3>
+<anchor name="dotNet"/>
+<s3 title="Steps for doing a Windows Build with Microsoft Visual Studio .NET">
+ <p>For users who want to build with Visual Studio .NET,</p>
+ <ol>
+ <li>Create the ICUROOT environment variable and set it the the path of the ICU root.</li>
+ <li>Create the XERCESCROOT environment variable and set it to the path of the root of &xml4c;.</li>
+ <li>Use Visual Studio .NET to open the Xalan solution (.sln) from the &xslt4c-win_root;\Projects\Win32\VC7. If you are building with ICU, then use XalanICU.sln. Otherwise, open the Xalan.sln solution file.<br/><br/>
+ <note>You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.</note>
+ <br/>
+ An alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual Studio .NET. From the "Options" window, click on the "Projects" folder to expand the list. Select "VC++ Directories" from the list and do the following:
+ <ol>
+ <li>Show Directories for: Executable files. Add the Xerces bin directory to the list.</li>
+ <li>Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.</li>
+ <li>Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.</li>
+ </ol></li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)</note>
+ <p><img src="NET_options.jpg" alt="Visual Studio .NET Include Directories change"/></p>
+ </s3><anchor name="unix"/>
+<s3 title="Steps for doing a UNIX build">
+ <p>For users who want to build in the UNIX environment,</p>
+ <ol>
+ <li>The Xalan build files are written for GNU make, and will not work with other make utilities.<br/><br/></li>
+ <li>Set the XERCESCROOT environment variable to the path to the root of &xml4c;.<br/><br/></li>
+ <li>Set the XALANCROOT environment variable to the path to the c directory in the root of the &xslt4c;
+ distribution. For example, if the distribution is located in "/home/mydir", you would set the XALANCROOT to "/home/mydir/&xslt4c-unix_root;". <br/><br/></li>
+ <li>(Optional) If you are including the ICUBridge, install the ICU, use the shell to define XALAN_USE_ICU and to set the ICUROOT environment variable to the path to the ICU root. For more information, see (see <link idref="usagepatterns" anchor="icu">Using the ICU</link>). Note that building Xalan with ICU requires that Xerces must also be built with ICU.<br/><br/></li>
+ <li>Change directory to XALANCROOT. You can also
+ build Xalan-C outside of the source tree, but you will need to adjust the path to the
+ runConfigure script in the next step.<br/><br/></li>
+ <li>Run the runConfigure utility and provide the platform, C compiler, and C++ compiler flags as
+ indicated below. The runConfigure utility is used to generate the appropriate Makefile for
+ the desired build platform based on the options specified by the user. Valid options for the
+ runConfigure utility are:<br/><br/>
+ <code>./runConfigure -p <value> -c <value> -x <value> [-[flag] <value>]</code><br/><br/>
+ <table>
+ <tr><th>flag</th><th>Description</th></tr>
+ <tr><td>p</td><td>Build platform. Option must be provided by user. Valid values <br/>include:
+ aix, linux, freebsd, netbsd, solaris, hp-10, hp-11, hp-11-ia64, irix,<br/> tru64, macosx, cygwin. </td></tr>
+ <tr><td>c</td><td>C compiler name. Example: gcc, cc, c89, xlc_r, etc.</td></tr>
+ <tr><td>x</td><td>C++ compiler name. Example: g++, xlC_r, CC, etc.</td></tr>
+ <tr><td>d</td><td>Indicates build is a debug build. Takes no values. Default is no <br/>debug.</td></tr>
+ <tr><td>t</td><td>Transcoder to use. Valid value is 'icu'. Default is null.</td></tr>
+ <tr><td>m</td><td>Type of localization support method. Valid values include: inmem, <br/>icu, and nls.
+ Default is inmem.</td></tr>
+ <tr><td>M</td><td>Locale for Message Localization Support. Default is "en_US"</td></tr>
+ <tr><td>r</td><td>Threads option. Valid values include: pthread or dce. Default is <br/>dce</td></tr>
+ <tr><td>b</td><td>Specify whether it is a 32-bit or 64-bit build. Valid values are 32 <br/>and 64.
+ Default is 32-bit</td></tr>
+ <tr><td>P</td><td>Install root directory. Used if invoking build with gmake install or <br/>gmake
+ install-package. Default install root directory is /usr/local</td></tr>
+ <tr><td>l</td><td>Extra link options other than the default. Default is null</td></tr>
+ <tr><td>z</td><td>Extra compiler options other than the default. Default is null</td></tr>
+ <tr><td>C</td><td>Extra configuration options.</td></tr>
+ <tr><td>h</td><td>To get help on the above commands. Default is no help.</td></tr>
+ </table><br/>
+ <ref>Linux using GCC:</ref> <code>./runConfigure -p linux -c gcc -x c++</code><br/>
+ <ref>Linux using the Intel compiler:</ref> <code>./runConfigure -p linux -c icc -x icpc</code><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r</code><br/><br/>
+ <ref>AIX (64-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -b 64</code><br/><br/>
+ <ref>Cygwin (32-bit):</ref> <code>./runConfigure -p cygwin -c gcc -x g++</code><br/><br/>
+ <ref>HP-UX 11 (32-bit):</ref> <code>./runConfigure -p hp-11 -c cc -x aCC</code><br/><br/>
+ <ref>HP-UX 11 (64-bit):</ref> <code>./runConfigure -p hp-11 -c cc -x aCC -b 64</code><br/><br/>
+ <ref>HP-UX 11 for Itanium (32-bit):</ref> <code>./runConfigure -p hp-11-ia64 -c cc -x aCC</code><br/><br/>
+ <ref>HP-UX 11 for Itanium (64-bit):</ref> <code>./runConfigure -p hp-11-ia64 -c cc -x aCC -b 64</code><br/><br/>
+ <ref>Solaris (32-bit):</ref> <code>./runConfigure -p solaris -c cc -x CC</code><br/><br/>
+ <ref>Solaris (64-bit):</ref> <code>./runConfigure -p solaris -c cc -x CC -b 64</code><br/><br/>
+ If you choose to install the distribution after building the libraries and executables,
+ then you will need to indicate where you would like the distribution to be installed.
+ To specify the install directory for your distribution, specify the flag -P <install directory>.
+ For example, building and installing on the AIX platform:<br/><br/>
+ <code>./runConfigure -p aix -c xlc_r -x xlC_r -P $HOME/my_xalan</code><br/><br/>
+ <note>The standard binary directories bin, lib, and include are created in the specified directory only if the install or install-package option is
+ specified in the build process.<br/><br/></note>
+ To see the other runConfigure flags you may include, use the help flag:<br/><br/>
+ <code>./runConfigure -h</code><br/><br/></li>
+ <li>Purge the previous build:<br/><br/>
+ <code> make clean</code><br/><br/></li>
+ <li>Run the new build:<br/><br/>
+ <code>make</code><br/>
+ or<br/>
+ <code>make <ref>targ</ref></code><br/><br/>
+ where <ref>targ</ref> can be one of:
+ <table>
+ <tr><th>targ</th><th>Description</th></tr>
+ <tr><td>all</td><td>Build the libraries and Xalan executable. This is the default target <br/>if no targ
+ is specified.</td></tr>
+ <tr><td>clean</td><td>Deletes existing binaries, executables, libraries, tests, and <br/>samples.</td></tr>
+ <tr><td>install</td><td>Build the library, executables and copy them (along with <br/>the header files)
+ the specified install location.</td></tr>
+ <tr><td>install-package</td><td>Installs the library, executables, samples to the <br/>specified location.</td></tr>
+ <tr><td>Samples</td><td>Builds the samples.</td></tr>
+ <tr><td>Tests</td><td>Builds the tests.</td></tr>
+ </table>
+ </li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify the command line in your Makefile to pick up the Xalan headers from it's new location. e.g: if your xalan source location is in /home/&xslt4c-unix_root;,</note><p>
+ <br/> <code>CC ... -I/home/&xslt4c-unix_root;/src -I/home/&xslt4c-unix_root;/src/xalanc mysrc.cpp</code><anchor name="64"/></p>
+ </s3>
+ <anchor name="locale"/>
+ <s3 title="Steps for doing a Build with Message Localization Support">
+ <p>Message Localization Support is a new feature to allow users to build &xslt4c; such that
+ diagnostic messages are issued in the language of their choice. Message localization support
+ comes in three flavours:</p>
+ <ul>
+ <li>Building static messages in the form of a library (DLL or shared object) which can be bound
+ to the Xalan executable. This method is referred to as "in memory". By default, &xslt4c; is built using "in memory" method.
+ </li>
+ <li>Building messages in the form of a library using localization support provided by the
+ International Components for Unicode (ICU). </li>
+ <li>Building messages in the form of a message catalog. This method utilizes the localization
+ support provided by the Unix National Language Support (NLS) system. This method is supported
+ for UNIX platforms only. </li>
+ </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.8 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
+ information.) All message files must be written and conform with the XLIFF 1.1 standard.</p>
+ <p>Once an XLIFF message file has been created, the XLIFF file should be stored under
+ &xslt4c-unix_root;/src/xalanc/NLS/<locale_name> directory (for example, the default XLIFF message file
+ provided is XalanMsg_en_US.xlf). To build, you will need to follow the same steps
+ as shown above for building in Unix or Windows but with a small change.</p>
+ <p>For building on Windows platform with "In Memory" method:</p>
+ <ol>
+ <li>Create the environment variable XERCESCROOT and set it to the path to the root of &xml4c;.</li>
+ <li>Create the environment variable ICUROOT and set it to the path to the ICU root.</li>
+ <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 BuildMessages.mak TYPE=inmem LOCAL=en_US"</li>
+ <li>Run "Build all" with the configuration of your choice. </li>
+ </ol>
+ <p>For building on the Windows platform with ICU method:</p>
+ <ol>
+ <li>Create the environment variable XERCESCROOT and set it to the path to the root of &xml4c;.</li>
+ <li>Create the environment variable ICUROOT and set it to the path to the ICU root.</li>
+ <li>Open the XalanICU.dsw workspace using Microsoft Visual C++. </li>
+ <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 BuildMessages.mak TYPE=icu LOCAL=en_US"</li>
+ <li>Open the tools.ini file under Projects\Win32\VC6\Utils\Localization and add the ICU root
+ directory to the ICUROOT variable setting.</li>
+ <li>Run "Build all" with the configuration of your choice. </li>
+ </ol>
+ <p>For building on the Unix platform:</p>
+ <ol>
+ <li>Repeat steps 1 through 5 as outlined under "Steps for doing a UNIX Build" </li>
+ <li>Run the runConfigure and provide the platform, C compiler, C++ compiler, the message locale
+ system flavour you are intending to build, and the locale support.<br/><br/>
+ Example 1: to use the NLS method for localization support using the default locale en_US:<br/><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC -m nls</code><br/><br/>
+ <ref>AIX (64-bit):</ref> .<code>/runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m nls</code><br/><br/>
+ Example 2: to use the 'icu' method for localization support using the locale fr_FR:<br/><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -m icu -M fr_Fr</code><br/><br/>
+ <ref>AIX (64-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m icu -M fr_Fr</code><br/><br/>
+ </li>
+ <li>Perform steps 7 and 8 as outlined under "Steps for doing a UNIX Build" </li>
+ </ol>
+ <p>After &xslt4c; and associated libraries have been successfully built, the message catalog
+ will be stored in the directory &xslt4c-unix_root;/bin.<br/><br/>
+ <table>
+ <tr><th>Localization Build Type</th><th>File Name</th></tr>
+ <tr><td><ref>ICU or "in memory" method:</ref></td><td>libxalanMsg18.so (for UNIX)<br/>
+ XalanMessages_1_8.dll and XalanMessages_1_8.lib (for Windows)
+ </td></tr>
+ <tr><td><ref>NLS method:</ref></td><td>xalanMsg1_8.cat can be found in $XALANCROOT/nls/<locale_name>/ directory</td></tr>
+ </table>
+ </p>
+ <p>The location of the message library, &xslt4c; and &xml4c; binaries need to be added to the PATH and
+ library path variables. Depending on the Message Localization Support method you've chosen, the
+ following steps will need to be performed such that &xslt4c; will be able to utilize the message
+ library. </p>
+ <ul>
+ <li>For an "in memory" or "icu" build, the location of the &xslt4c; and &xml4c; executables need to
+ be added to the PATH variable. The location of the message library will need to be added to:
+ <ul>
+ <li>the LIBPATH variable for AIX users </li>
+ <li>the LD_LIBRARY_PATH variable for RedHat, SuSE, and Solaris users </li>
+ <li>the SHLIB_PATH variable for HP-UX users. </li>
+ </ul></li>
+ <li>For an NLS build, the message catalog will need to be added to the NLSPATH. </li>
+ </ul>
+ </s3>
+ <anchor name="xercesdepdom"/>
+ <s3 title="Steps for doing a Build with Xerces Deprecated DOM Support">
+ <p>If you application is dependent on the XercesBridge classes to interface with the deprecated Xerces DOM, then the following steps must be taken.</p>
+ <p>For a Windows build using Microsoft Visual C++ version 6.0:</p>
+ <ol>
+ <li>Open the Xalan.dsw workspace</li>
+ <li>Go to "Projects" and select "Settings". From the "Project Settings panel", highlight the AllInOne project.</li>
+ <li>Click on the "C/C++" tab on the right hand side. From the "Category" pull down menu, scroll down to find "Preprocessor" and click to highlight this category.</li>
+ <li>Under the "Preprocessor Definitions" box, add "XALAN_BUILD_DEPRECATED_DOM_BRIDGE" to the list of definitions.</li>
+ <li>Rebuild &xslt4c; as described under <link anchor="win32">"Steps for doing a Windows Build"</link></li>
+ </ol>
+ <p>For a UNIX build, the following parameter should be added to your runConfigure step: <code>-z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE</code>. for example,</p>
+ <code>./runConfigure -p aix -c xlc_r -x xlC_r -z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE</code><br/><br/>
+
+ </s3>
+ <anchor name="samples"/>
+ <s3 title="Rebuilding a Sample application">
+ <p>In the 32-bit Windows distribution, all of the sample applications can be built from the Xalan.dsw Visual C++ workspace.</p>
+<p>The Makefile that come with the UNIX distributions include targets for rebuilding one or all of the sample applications . To rebuild one or more sample applications, go to the root directory of your source package or the samples directory of your binary package, and run<br/><br/>
+ <code>gmake <ref>Target</ref></code><br/><br/>
+where <ref>Target</ref> is <code>Samples</code> (all the samples), <code>ApacheModuleXSLT</code>, <code>CompileStylesheet</code>, <code>DocumentBuilder</code>, <code>ExternalFunctions</code>, <code>ParsedSourceWrappers</code>, <code>SerializedNodeSet</code>, <code>SimpleTransform</code>, <code>SimpleXPathAPI</code>, <code>SimpleXPathCAPI</code>, <code>StreamTransform</code>, <code>ThreadSafe</code> (Windows only), <code>TraceListen</code>, <code>TransformToXercesDOM</code>, <code>UseStylesheetParam</code>, <code>XPathWrapper</code>, <code>XalanTransform</code>, or <code>XalanTransformerCallback</code>.</p>
+<note>For information on building Apache Module, see <link idref="samples" anchor="apachemodulexslt">ApacheModuleXSLT</link></note>
+ </s3>
+ </s2><anchor name="contact"/>
+ <s2 title="Getting in Touch">
+ <p>Your feedback is more than welcome. Offers of help are even more so! Perhaps you would like to contribute to the ongoing development, testing, or documentation of &xslt4c;.</p>
+<p>Please email your comments, questions, suggestions, bug reports, and offers to help to <human-resource-ref idref="xalandev"/>.</p>
+ </s2><anchor name="history"/>
+ <s2 title="Cumulative history of software changes">
+ <p>The following sections list the changes in each release since &xslt4c; version 0.40.0.</p>
+ &history-c;
+ </s2>
+</s1>
Added: xalan/c/trunk/xdocs/sources/xalan/releasenotes.xml
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/sources/xalan/releasenotes.xml?rev=1350859&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/sources/xalan/releasenotes.xml (added)
+++ xalan/c/trunk/xdocs/sources/xalan/releasenotes.xml Sat Jun 16 04:28:14 2012
@@ -0,0 +1,337 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE s1 SYSTEM "../../style/dtd/document.dtd"[
+<!ENTITY done-c SYSTEM "DONE">
+<!ENTITY status-c SYSTEM "STATUS">
+<!ENTITY history-c SYSTEM "history.xml">]>
+
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+<s1 title="&xslt4c; Release Notes">
+<p>Release notes for &xslt4c-current;</p>
+ <ul>
+ <li><link anchor="status">Status</link></li>
+ <li><link anchor="build">Rebuilding &xslt4c; and the sample applications</link></li>
+ <li><link anchor="contact">Getting in touch</link></li>
+ <li><link anchor="history">History of software changes</link></li>
+ </ul>
+ <anchor name="status"/>
+ <s2 title="Status">
+ <ul>
+ <li><link anchor="done">Changes for &xslt4c; version 1.8</link></li>
+ <li><link anchor="bugs">Bug reporting</link></li>
+ <li><link anchor="xml4c">Version of &xml4c; to use</link></li>
+ <li><link anchor="to-do">To-do tasks for future &xslt4c; releases</link></li>
+ </ul>
+ <anchor name="done"/>
+ <s3 title="Changes for &xslt4c; version 1.8">
+ <p>Major updates since version 1.7 include:</p>
+ <ul>
+ <li><resource-ref idref="bugsfixedforthisrelease"/>.</li>
+ <li>Upgrade from Xerces-C 2.4 to Xerces-C 2.5. </li>
+ <li>Provide build support for Cygwin and HP-UX 11.00 on Itanium. Although binary distributions are not provided for the Cygwin environment and
+ HP-UX 11.00 on Itanium platform, the build configuration files provided in the source distribution can be used to build on these platforms. </li>
+ <li>Project files for supporting Microsoft Visual Studio .NET. Although a binary distribution for the Microsoft Visual Studio .NET
+ is not provided in this release, Visual Studio solution files are provided in the Windows source distribution for those who choose to build
+ on this platform. Please see <link anchor="dotNet">"Step for doing a Windows Build with Visual Studio .NET"</link> for details.</li>
+ <li>Additional changes to Xerces Deprecated DOM support. This is another step towards phasing out the support for Xerces Deprecated DOM. Users are encouraged to modify their applications to interface with the new Xerces DOM support. For more information on the effects of these changes to your build environment, please see <link anchor="xercesdepdom">"Steps for doing a Build with Xerces Deprecated DOM Support"</link></li>
+ <!--
+ <li>Porting of conf utility to the UNIX platform. The conf utility is a test harness designed to run the conformance tests located under the xml-xalan/test/tests directory. After the tests have been run, a results report is generated in HTML format for easy viewing. For more information on how to use this tool, please see <link idref="commandline" anchor="confexe">"Using the command line utility"</link>.</li>
+ -->
+ <li>Implemented optimizations to significantly improve the throughput of the ICU-enabled "format-number" function.</li>
+ <li>Changes in the XML Serializer. The serializer will no longer put a newline after the xml header tag unless indent="yes". See bugzilla <jump href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=24304">24304</jump> and <jump href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=28386">28386</jump>.</li>
+ </ul>
+ </s3>
+
+ <anchor name="bugs"/>
+ <s3 title="Bug reporting">
+ <p>All known &xslt4c; bugs are listed in <resource-ref idref="jira"/>. For a list of open bugs with links to each bug
+ report, see <resource-ref idref="buglist"/>. If you find a new bug, please enter a XalanC bug report in this
+ database.</p>
+ <note>Before you can enter your first bug report, you must submit your email address to Jira and receive a password.</note>
+ <p>We strongly encourage you write patches for problems you find and submit them to
+ xalan-dev@xml.apache.org. We review the patches we receive to make sure they do not break something else, and (assuming they
+ do not) include them in our next release. In the interest of fixing bugs, adding enhancements, and addressing outstanding design
+ issues, we sincerely want (and need!) your active participation in the ongoing development of Xalan.</p>
+ </s3><anchor name="xml4c"/>
+ &status-c;
+ </s2><anchor name="build"/>
+ <s2 title="Rebuilding &xslt4c;">
+<ul>
+<li><link anchor="jar">Rebuilding &xslt4c;</link></li>
+<li><link anchor="samples">Rebuilding sample applications</link></li>
+</ul>
+<anchor name="jar"/>
+ <s3 title="Rebuilding &xslt4c;">
+ <ul>
+ <li><link anchor="needed">What you need from the distributions</link></li>
+ <li><link anchor="win32">Steps for doing a Windows Build</link></li>
+ <li><link anchor="dotNet">Steps for doing a Windows Build with Visual Studio .NET</link></li>
+ <li><link anchor="unix">Steps for doing a UNIX build</link></li>
+ <li><link anchor="locale">Steps for doing a Build with Message Localization Support</link></li>
+ <li><link anchor="xercesdepdom">Steps for doing a Build with Xerces Deprecated DOM Support</link></li>
+ </ul></s3><anchor name="needed"/>
+ <s3 title="What you need from the distributions">
+ <p>To rebuild &xslt4c;, you need the &xslt4c; source files, the &xml4c; header files, and
+ for Windows the &xml4c; .lib file. If you want to rebuild with the ICU, you will need to download the ICU source package to build the ICU libraries. </p>
+
+<note>You can also download &xslt4c; source distributions from <resource-ref idref="xslt4c-distdir"/>: &xslt4c-dist;-src.zip and &xslt4c-dist;-src.tar.gz. &xml4c; source distributions are available from <resource-ref idref="xml4c-distdir"/>:
+&xml4c-dist;-src.zip and &xml4c-dist;-src.tar.gz.</note>
+<p>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 version of &xml4c;. To be safe, use the Xerces distributions that we certify as compatible. Reminder: &xslt4c-current; is compatible with &xml4c-used;.</p>
+ <p>For information on using the <resource-ref idref="icu"/>, see
+ <link idref="usagepatterns" anchor="icu">Using the ICU</link>.
+ The recommended version of ICU for &xslt4c-current; is &icu-current;. You may be able to use newer ICU releases as they appear.</p>
+ </s3><anchor name="win32"/>
+ <s3 title="Steps for doing a Windows build">
+ <p>To build &xslt4c; on Windows, you need &xml4c; and MS Visual C++ 6.0 installed with Service Pack 5 for Visual C++ and Visual Studio .NET.</p>
+ <p>If you are using a different Service Pack, you must rebuild all of the Xerces and Xalan binaries.</p>
+<p>Before you do the following, be sure you have <link idref="getstarted" anchor="windowspath">provided Visual C++ the paths to the Xerces headers and libraries</link>.</p>
+ <ol>
+ <li>Create the ICUROOT environment variable and set it the the path of the ICU root.</li>
+ <li>Create the XERCESCROOT environment variable and set it to the path of the root of &xml4c;.</li>
+ <li>Use Visual C++ to open the Xalan workspace (.dsw) from the &xslt4c-win_root;\Projects\Win32\VC6. If you are building with ICU, then use XalanICU.dsw. Otherwise, open the Xalan.dsw workspace.<br/><br/>
+ <note>You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.</note>
+ <br/>
+ As an alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual C++. From the "Options" window, click on the "Directories" tab and do the following:
+ <ol>
+ <li>Show Directories for: Executable files. Add the Xerces bin directory to the list.</li>
+ <li>Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.</li>
+ <li>Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.</li>
+ </ol></li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)</note>
+ <p><img src="options-sane.gif" alt="Visual C++ 6.0 Include Directories change"/></p>
+</s3>
+<anchor name="dotNet"/>
+<s3 title="Steps for doing a Windows Build with Microsoft Visual Studio .NET">
+ <p>For users who want to build with Visual Studio .NET,</p>
+ <ol>
+ <li>Create the ICUROOT environment variable and set it the the path of the ICU root.</li>
+ <li>Create the XERCESCROOT environment variable and set it to the path of the root of &xml4c;.</li>
+ <li>Use Visual Studio .NET to open the Xalan solution (.sln) from the &xslt4c-win_root;\Projects\Win32\VC7. If you are building with ICU, then use XalanICU.sln. Otherwise, open the Xalan.sln solution file.<br/><br/>
+ <note>You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.</note>
+ <br/>
+ An alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual Studio .NET. From the "Options" window, click on the "Projects" folder to expand the list. Select "VC++ Directories" from the list and do the following:
+ <ol>
+ <li>Show Directories for: Executable files. Add the Xerces bin directory to the list.</li>
+ <li>Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.</li>
+ <li>Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.</li>
+ </ol></li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)</note>
+ <p><img src="NET_options.jpg" alt="Visual Studio .NET Include Directories change"/></p>
+ </s3><anchor name="unix"/>
+<s3 title="Steps for doing a UNIX build">
+ <p>For users who want to build in the UNIX environment,</p>
+ <ol>
+ <li>The Xalan build files are written for GNU make, and will not work with other make utilities.<br/><br/></li>
+ <li>Set the XERCESCROOT environment variable to the path to the root of &xml4c;.<br/><br/></li>
+ <li>Set the XALANCROOT environment variable to the path to the c directory in the root of the &xslt4c;
+ distribution. For example, if the distribution is located in "/home/mydir", you would set the XALANCROOT to "/home/mydir/&xslt4c-unix_root;". <br/><br/></li>
+ <li>(Optional) If you are including the ICUBridge, install the ICU, use the shell to define XALAN_USE_ICU and to set the ICUROOT environment variable to the path to the ICU root. For more information, see (see <link idref="usagepatterns" anchor="icu">Using the ICU</link>). Note that building Xalan with ICU requires that Xerces must also be built with ICU.<br/><br/></li>
+ <li>Change directory to XALANCROOT. You can also
+ build Xalan-C outside of the source tree, but you will need to adjust the path to the
+ runConfigure script in the next step.<br/><br/></li>
+ <li>Run the runConfigure utility and provide the platform, C compiler, and C++ compiler flags as
+ indicated below. The runConfigure utility is used to generate the appropriate Makefile for
+ the desired build platform based on the options specified by the user. Valid options for the
+ runConfigure utility are:<br/><br/>
+ <code>./runConfigure -p <value> -c <value> -x <value> [-[flag] <value>]</code><br/><br/>
+ <table>
+ <tr><th>flag</th><th>Description</th></tr>
+ <tr><td>p</td><td>Build platform. Option must be provided by user. Valid values <br/>include:
+ aix, linux, freebsd, netbsd, solaris, hp-10, hp-11, hp-11-ia64, irix,<br/> tru64, macosx, cygwin. </td></tr>
+ <tr><td>c</td><td>C compiler name. Example: gcc, cc, c89, xlc_r, etc.</td></tr>
+ <tr><td>x</td><td>C++ compiler name. Example: g++, xlC_r, CC, etc.</td></tr>
+ <tr><td>d</td><td>Indicates build is a debug build. Takes no values. Default is no <br/>debug.</td></tr>
+ <tr><td>t</td><td>Transcoder to use. Valid value is 'icu'. Default is null.</td></tr>
+ <tr><td>m</td><td>Type of localization support method. Valid values include: inmem, <br/>icu, and nls.
+ Default is inmem.</td></tr>
+ <tr><td>M</td><td>Locale for Message Localization Support. Default is "en_US"</td></tr>
+ <tr><td>r</td><td>Threads option. Valid values include: pthread or dce. Default is <br/>dce</td></tr>
+ <tr><td>b</td><td>Specify whether it is a 32-bit or 64-bit build. Valid values are 32 <br/>and 64.
+ Default is 32-bit</td></tr>
+ <tr><td>P</td><td>Install root directory. Used if invoking build with gmake install or <br/>gmake
+ install-package. Default install root directory is /usr/local</td></tr>
+ <tr><td>l</td><td>Extra link options other than the default. Default is null</td></tr>
+ <tr><td>z</td><td>Extra compiler options other than the default. Default is null</td></tr>
+ <tr><td>C</td><td>Extra configuration options.</td></tr>
+ <tr><td>h</td><td>To get help on the above commands. Default is no help.</td></tr>
+ </table><br/>
+ <ref>Linux using GCC:</ref> <code>./runConfigure -p linux -c gcc -x c++</code><br/>
+ <ref>Linux using the Intel compiler:</ref> <code>./runConfigure -p linux -c icc -x icpc</code><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r</code><br/><br/>
+ <ref>AIX (64-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -b 64</code><br/><br/>
+ <ref>Cygwin (32-bit):</ref> <code>./runConfigure -p cygwin -c gcc -x g++</code><br/><br/>
+ <ref>HP-UX 11 (32-bit):</ref> <code>./runConfigure -p hp-11 -c cc -x aCC</code><br/><br/>
+ <ref>HP-UX 11 (64-bit):</ref> <code>./runConfigure -p hp-11 -c cc -x aCC -b 64</code><br/><br/>
+ <ref>HP-UX 11 for Itanium (32-bit):</ref> <code>./runConfigure -p hp-11-ia64 -c cc -x aCC</code><br/><br/>
+ <ref>HP-UX 11 for Itanium (64-bit):</ref> <code>./runConfigure -p hp-11-ia64 -c cc -x aCC -b 64</code><br/><br/>
+ <ref>Solaris (32-bit):</ref> <code>./runConfigure -p solaris -c cc -x CC</code><br/><br/>
+ <ref>Solaris (64-bit):</ref> <code>./runConfigure -p solaris -c cc -x CC -b 64</code><br/><br/>
+ If you choose to install the distribution after building the libraries and executables,
+ then you will need to indicate where you would like the distribution to be installed.
+ To specify the install directory for your distribution, specify the flag -P <install directory>.
+ For example, building and installing on the AIX platform:<br/><br/>
+ <code>./runConfigure -p aix -c xlc_r -x xlC_r -P $HOME/my_xalan</code><br/><br/>
+ <note>The standard binary directories bin, lib, and include are created in the specified directory only if the install or install-package option is
+ specified in the build process.<br/><br/></note>
+ To see the other runConfigure flags you may include, use the help flag:<br/><br/>
+ <code>./runConfigure -h</code><br/><br/></li>
+ <li>Purge the previous build:<br/><br/>
+ <code> make clean</code><br/><br/></li>
+ <li>Run the new build:<br/><br/>
+ <code>make</code><br/>
+ or<br/>
+ <code>make <ref>targ</ref></code><br/><br/>
+ where <ref>targ</ref> can be one of:
+ <table>
+ <tr><th>targ</th><th>Description</th></tr>
+ <tr><td>all</td><td>Build the libraries and Xalan executable. This is the default target <br/>if no targ
+ is specified.</td></tr>
+ <tr><td>clean</td><td>Deletes existing binaries, executables, libraries, tests, and <br/>samples.</td></tr>
+ <tr><td>install</td><td>Build the library, executables and copy them (along with <br/>the header files)
+ the specified install location.</td></tr>
+ <tr><td>install-package</td><td>Installs the library, executables, samples to the <br/>specified location.</td></tr>
+ <tr><td>Samples</td><td>Builds the samples.</td></tr>
+ <tr><td>Tests</td><td>Builds the tests.</td></tr>
+ </table>
+ </li>
+ </ol>
+ <note>To recompile existing applications without changing your source code, be sure to modify the command line in your Makefile to pick up the Xalan headers from it's new location. e.g: if your xalan source location is in /home/&xslt4c-unix_root;,</note><p>
+ <br/> <code>CC ... -I/home/&xslt4c-unix_root;/src -I/home/&xslt4c-unix_root;/src/xalanc mysrc.cpp</code><anchor name="64"/></p>
+ </s3>
+ <anchor name="locale"/>
+ <s3 title="Steps for doing a Build with Message Localization Support">
+ <p>Message Localization Support is a new feature to allow users to build &xslt4c; such that
+ diagnostic messages are issued in the language of their choice. Message localization support
+ comes in three flavours:</p>
+ <ul>
+ <li>Building static messages in the form of a library (DLL or shared object) which can be bound
+ to the Xalan executable. This method is referred to as "in memory". By default, &xslt4c; is built using "in memory" method.
+ </li>
+ <li>Building messages in the form of a library using localization support provided by the
+ International Components for Unicode (ICU). </li>
+ <li>Building messages in the form of a message catalog. This method utilizes the localization
+ support provided by the Unix National Language Support (NLS) system. This method is supported
+ for UNIX platforms only. </li>
+ </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.8 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
+ information.) All message files must be written and conform with the XLIFF 1.1 standard.</p>
+ <p>Once an XLIFF message file has been created, the XLIFF file should be stored under
+ &xslt4c-unix_root;/src/xalanc/NLS/<locale_name> directory (for example, the default XLIFF message file
+ provided is XalanMsg_en_US.xlf). To build, you will need to follow the same steps
+ as shown above for building in Unix or Windows but with a small change.</p>
+ <p>For building on Windows platform with "In Memory" method:</p>
+ <ol>
+ <li>Create the environment variable XERCESCROOT and set it to the path to the root of &xml4c;.</li>
+ <li>Create the environment variable ICUROOT and set it to the path to the ICU root.</li>
+ <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 BuildMessages.mak TYPE=inmem LOCAL=en_US"</li>
+ <li>Run "Build all" with the configuration of your choice. </li>
+ </ol>
+ <p>For building on the Windows platform with ICU method:</p>
+ <ol>
+ <li>Create the environment variable XERCESCROOT and set it to the path to the root of &xml4c;.</li>
+ <li>Create the environment variable ICUROOT and set it to the path to the ICU root.</li>
+ <li>Open the XalanICU.dsw workspace using Microsoft Visual C++. </li>
+ <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 BuildMessages.mak TYPE=icu LOCAL=en_US"</li>
+ <li>Open the tools.ini file under Projects\Win32\VC6\Utils\Localization and add the ICU root
+ directory to the ICUROOT variable setting.</li>
+ <li>Run "Build all" with the configuration of your choice. </li>
+ </ol>
+ <p>For building on the Unix platform:</p>
+ <ol>
+ <li>Repeat steps 1 through 5 as outlined under "Steps for doing a UNIX Build" </li>
+ <li>Run the runConfigure and provide the platform, C compiler, C++ compiler, the message locale
+ system flavour you are intending to build, and the locale support.<br/><br/>
+ Example 1: to use the NLS method for localization support using the default locale en_US:<br/><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC -m nls</code><br/><br/>
+ <ref>AIX (64-bit):</ref> .<code>/runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m nls</code><br/><br/>
+ Example 2: to use the 'icu' method for localization support using the locale fr_FR:<br/><br/>
+ <ref>AIX (32-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -m icu -M fr_Fr</code><br/><br/>
+ <ref>AIX (64-bit):</ref> <code>./runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m icu -M fr_Fr</code><br/><br/>
+ </li>
+ <li>Perform steps 7 and 8 as outlined under "Steps for doing a UNIX Build" </li>
+ </ol>
+ <p>After &xslt4c; and associated libraries have been successfully built, the message catalog
+ will be stored in the directory &xslt4c-unix_root;/bin.<br/><br/>
+ <table>
+ <tr><th>Localization Build Type</th><th>File Name</th></tr>
+ <tr><td><ref>ICU or "in memory" method:</ref></td><td>libxalanMsg18.so (for UNIX)<br/>
+ XalanMessages_1_8.dll and XalanMessages_1_8.lib (for Windows)
+ </td></tr>
+ <tr><td><ref>NLS method:</ref></td><td>xalanMsg1_8.cat can be found in $XALANCROOT/nls/<locale_name>/ directory</td></tr>
+ </table>
+ </p>
+ <p>The location of the message library, &xslt4c; and &xml4c; binaries need to be added to the PATH and
+ library path variables. Depending on the Message Localization Support method you've chosen, the
+ following steps will need to be performed such that &xslt4c; will be able to utilize the message
+ library. </p>
+ <ul>
+ <li>For an "in memory" or "icu" build, the location of the &xslt4c; and &xml4c; executables need to
+ be added to the PATH variable. The location of the message library will need to be added to:
+ <ul>
+ <li>the LIBPATH variable for AIX users </li>
+ <li>the LD_LIBRARY_PATH variable for RedHat, SuSE, and Solaris users </li>
+ <li>the SHLIB_PATH variable for HP-UX users. </li>
+ </ul></li>
+ <li>For an NLS build, the message catalog will need to be added to the NLSPATH. </li>
+ </ul>
+ </s3>
+ <anchor name="xercesdepdom"/>
+ <s3 title="Steps for doing a Build with Xerces Deprecated DOM Support">
+ <p>If you application is dependent on the XercesBridge classes to interface with the deprecated Xerces DOM, then the following steps must be taken.</p>
+ <p>For a Windows build using Microsoft Visual C++ version 6.0:</p>
+ <ol>
+ <li>Open the Xalan.dsw workspace</li>
+ <li>Go to "Projects" and select "Settings". From the "Project Settings panel", highlight the AllInOne project.</li>
+ <li>Click on the "C/C++" tab on the right hand side. From the "Category" pull down menu, scroll down to find "Preprocessor" and click to highlight this category.</li>
+ <li>Under the "Preprocessor Definitions" box, add "XALAN_BUILD_DEPRECATED_DOM_BRIDGE" to the list of definitions.</li>
+ <li>Rebuild &xslt4c; as described under <link anchor="win32">"Steps for doing a Windows Build"</link></li>
+ </ol>
+ <p>For a UNIX build, the following parameter should be added to your runConfigure step: <code>-z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE</code>. for example,</p>
+ <code>./runConfigure -p aix -c xlc_r -x xlC_r -z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE</code><br/><br/>
+
+ </s3>
+ <anchor name="samples"/>
+ <s3 title="Rebuilding a Sample application">
+ <p>In the 32-bit Windows distribution, all of the sample applications can be built from the Xalan.dsw Visual C++ workspace.</p>
+<p>The Makefile that come with the UNIX distributions include targets for rebuilding one or all of the sample applications . To rebuild one or more sample applications, go to the root directory of your source package or the samples directory of your binary package, and run<br/><br/>
+ <code>gmake <ref>Target</ref></code><br/><br/>
+where <ref>Target</ref> is <code>Samples</code> (all the samples), <code>ApacheModuleXSLT</code>, <code>CompileStylesheet</code>, <code>DocumentBuilder</code>, <code>ExternalFunctions</code>, <code>ParsedSourceWrappers</code>, <code>SerializedNodeSet</code>, <code>SimpleTransform</code>, <code>SimpleXPathAPI</code>, <code>SimpleXPathCAPI</code>, <code>StreamTransform</code>, <code>ThreadSafe</code> (Windows only), <code>TraceListen</code>, <code>TransformToXercesDOM</code>, <code>UseStylesheetParam</code>, <code>XPathWrapper</code>, <code>XalanTransform</code>, or <code>XalanTransformerCallback</code>.</p>
+<note>For information on building Apache Module, see <link idref="samples" anchor="apachemodulexslt">ApacheModuleXSLT</link></note>
+ </s3>
+ </s2><anchor name="contact"/>
+ <s2 title="Getting in Touch">
+ <p>Your feedback is more than welcome. Offers of help are even more so! Perhaps you would like to contribute to the ongoing development, testing, or documentation of &xslt4c;.</p>
+<p>Please email your comments, questions, suggestions, bug reports, and offers to help to <human-resource-ref idref="xalandev"/>.</p>
+ </s2><anchor name="history"/>
+ <s2 title="Cumulative history of software changes">
+ <p>The following sections list the changes in each release since &xslt4c; version 0.40.0.</p>
+ &history-c;
+ </s2>
+</s1>
Added: xalan/c/trunk/xdocs/sources/xalan/resources.xml
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/sources/xalan/resources.xml?rev=1350859&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/sources/xalan/resources.xml (added)
+++ xalan/c/trunk/xdocs/sources/xalan/resources.xml Sat Jun 16 04:28:14 2012
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE resources [
+ <!ENTITY % externalEntity SYSTEM "../entities.ent">
+ %externalEntity;
+ <!ELEMENT resources (resource|human-resource)+>
+ <!ELEMENT resource EMPTY>
+ <!ATTLIST resource id CDATA #IMPLIED
+ title CDATA #IMPLIED
+ location CDATA #IMPLIED>
+ <!ELEMENT human-resource EMPTY>
+ <!ATTLIST human-resource id CDATA #IMPLIED
+ name CDATA #IMPLIED
+ mailto CDATA #IMPLIED>
+ ]>
+<resources>
+
+<resource id="xslt4c-current"
+ title="&xslt4c-current;"
+ location="http://xml.apache.org/xalan-c"/>
+<resource id="xml4c-used"
+ title="&xml4c-used;"
+ location="http://xml.apache.org/xerces-c/index.html"/>
+<resource id="xslt4c-distdir"
+ title="Xalan-C downloads"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c"/>
+<!--
+<resource id="xml4c-distdir"
+ title="Xerces-C downloads"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xerces-c"/>
+-->
+<resource id="xml4c-distdir"
+ title="Xerces-C downloads"
+ location="http://www.apache.org/dyn/closer.cgi/xerces/c"/>
+<resource id="xslt4c-win32-download"
+ title="&xslt4c-dist;-win32.zip"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c/binaries/&xslt4c-dist;-win32.zip"/>
+<resource id="xslt4c-linux-download"
+ title="&xslt4c-dist;-linux.tar.gz"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c/binaries/&xslt4c-dist;-linux.tar.gz"/>
+<resource id="xslt4c-aix-download"
+ title="&xslt4c-dist;-aix.tar.gz"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c/binaries/&xslt4c-dist;-aix.tar.gz"/>
+<resource id="xslt4c-hp-ux-download"
+ title="&xslt4c-dist;-hp-ux.tar.gz"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c/binaries/&xslt4c-dist;-hp-ux.tar.gz"/>
+<resource id="xslt4c-Solaris-download"
+ title="&xslt4c-dist;-solaris.tar.gz"
+ location="http://www.apache.org/dyn/closer.cgi/xml/xalan-c/binaries/&xslt4c-dist;-solaris.tar.gz"/>
+
+<resource id="icu"
+ title="International Components for Unicode (ICU)"
+ location="http://oss.software.ibm.com/icu/index.html"/>
+<resource id="icu-download"
+ title="&icu-used;"
+ location="http://oss.software.ibm.com/icu/download/index.html"/>
+<resource id="xerces-build-icu"
+ title="Building ICU for &xml4c;"
+ location="http://xml.apache.org/xerces-c/build.html#BuildICU"/>
+<resource id="stlport"
+ title="STLport"
+ location="http://www.stlport.org/"/>
+<resource id="ApacheLicense"
+ title="The Apache Software License, Version 2.0"
+ location="http://www.apache.org/licenses/LICENSE-2.0"/>
+<resource id="Readme"
+ title="Xalan Repository Release Notes"
+ location="http://www.apache.org/websrc/cvsweb.cgi/xml-xalan/README"/>
+<resource id="XSL"
+ title="Extensible Stylesheet Language (XSL) Version 1.0 W3C Recommendation"
+ location="http://www.w3.org/TR/xsl"/>
+<resource id="XSLT"
+ title="W3C Recommendation 16 November 1999 XSL Transformations (XSLT) Version 1.0"
+ location="http://www.w3.org/TR/xslt"/>
+<resource id="XPath"
+ title="XML Path Language (XPath) Version 1.0"
+ location="http://www.w3.org/TR/xpath"/>
+<resource id="DOM"
+ title="DOM"
+ location="http://www.w3.org/DOM"/>
+<resource id="dpawsonxslfaq"
+ title="XSL Frequently Asked Questions"
+ location="http://www.dpawson.co.uk/xsl/xslfaq.html"/>
+
+<resource id="xercesmm"
+ title="Pluggable Memory Manager"
+ location="http://xml.apache.org/xerces-c/program-others.html#PluggableMemoryManager"/>
+
+<human-resource id="xalandev"
+ name="Xalan Development Mailing List"
+ mailto="xalan-dev@xml.apache.org"/>
+
+<human-resource id="xalancusers"
+ name="Xalan-C/C++ Users Mailing List"
+ mailto="xalan-c-users@xml.apache.org"/>
+
+<resource id="bugzilla"
+ title="Bugzilla (the Apache bug database)"
+ location="http://nagoya.apache.org/bugzilla"/>
+
+<resource id="jira"
+ title="JIRA (the Apache bug database)"
+ location="https://issues.apache.org/jira/browse/XALANC"/>
+
+<resource id="buglist"
+ title="XalanC open bugs"
+ location="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=project+%3D+XALANC+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC"/>
+
+<resource id="bugsfixedforthisrelease"
+ title="XalanC bugs fixed for this release"
+ location="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10582&version=10833"/>
+
+
+</resources>
Added: xalan/c/trunk/xdocs/sources/xalan/samples.xml
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/sources/xalan/samples.xml?rev=1350859&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/sources/xalan/samples.xml (added)
+++ xalan/c/trunk/xdocs/sources/xalan/samples.xml Sat Jun 16 04:28:14 2012
@@ -0,0 +1,399 @@
+<?xml version="1.0" standalone="no"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE s1 SYSTEM "../../style/dtd/document.dtd">
+<s1 title="&xslt4c; Samples">
+<ul>
+ <li><link anchor="getstarted">Samples to help you get started</link></li>
+ <li><link anchor="rebuilding">Rebuilding a Sample application</link></li>
+ <li><link anchor="apachemodulexslt">ApacheModuleXSLT</link></li>
+ <li><link anchor="compilestylesheet">CompileStylesheet</link></li>
+ <li><link anchor="documentbuilder">DocumentBuilder</link></li>
+ <li><link anchor="externalfunctions">ExternalFunctions</link></li>
+ <li><link anchor="parsedsourcewrappers">ParsedSourceWrappers</link></li>
+ <li><link anchor="serializenodeset">SerializeNodeSet</link></li>
+ <li><link anchor="simpletransform">SimpleTransform</link></li>
+ <li><link anchor="simplexpathapi">SimpleXPathAPI</link></li>
+ <li><link anchor="simplexpathcapi">SimpleXPathCAPI</link></li>
+ <li><link anchor="streamtransform">StreamTransform</link></li>
+ <li><link anchor="threadsafe">ThreadSafe</link></li>
+ <li><link anchor="tracelisten">TraceListen</link></li>
+ <li><link anchor="transformtoxercesdom">TransformToXercesDOM</link></li>
+ <li><link anchor="usememorymanager">UseMemoryManager</link></li>
+ <li><link anchor="usestylesheetparam">UseStylesheetParam</link></li>
+ <li><link anchor="xalantransform">XalanTransform</link></li>
+ <li><link anchor="xalantransformercallback">XalanTransformerCallback</link></li>
+</ul>
+
+<anchor name="getstarted"/>
+<s2 title="Samples to help you get started">
+<p>Each of the subdirectories in the &xslt4c; samples directory contains the source files for a
+ sample application. The executables for the samples are in the build subdirectory, which should be on the system
+ path.</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)<br/><br/></li>
+ <li>Run the sample from the command line (as indicated below)<br/><br/></li>
+ <li>Examine the application source files. You may also want to modify the source files. Remember that if you
+ modify a .cpp file, you must rebuild the executable and place it on the path before you can run the
+ modified application.</li>
+</ol>
+<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. For the UNIX builds, application executables are in the bin subdirectory. For the Windows32 build, the
+ application executable is in the bin subdirectory (&xslt4c-dist;-<my_Windows_distribution>\bin). To run a
+ sample, be sure the executable is on the path, and run it from the samples subdirectory that contains the input
+ files.</note>
+<note>The most of the samples are implemented without providing a pluggable memory manager. The <link anchor="simpletransform">SimpleTransform</link> sample illustrates,
+ in addition to a simple transformation, the usage of the processor with memory manager</note>
+
+</s2>
+
+<anchor name="rebuilding"/>
+<s2 title="Rebuilding a Sample application">
+<p>Instructions for rebuilding the samples differ depending on whether you are using the binary package or the source
+package. </p>
+<p>For Windows users, the Xalan Visual C++ workspace contains project configurations for building
+ each of the samples. Users who have downloaded the source package, can find the XalanICU.dsw workspace
+ file under:<br/><br/> <code>&xslt4c-dist;-src\src\xalanc\Projects\Win32\VC6</code>
+ <br/><br/> and XalanICU.sln solution file under:<br/><br/>
+ <code>&xslt4c-dist;-src\src\xalanc\Projects\Win32\VC7.1</code>
+
+ <br/><br/> Users who have downloaded the binary package, should use the Samples.dsw workspace file
+ located under: <br/><br/>
+ <code>&xslt4c-dist;-<my_Win32_distribution>\Samples\Projects\Win32\VC6</code><br/><br/>
+ or the Samples.sln solution file for .NET V7.1 users, located under: <br/><br/>
+ <code>&xslt4c-dist;-<my_Win32_distribution>\Samples\Projects\Win32\VC7.1</code><br/><br/>
+</p>
+<p>The Makefile that comes with the UNIX distributions include targets for rebuilding one or all of
+ the sample applications. To rebuild one or more sample applications from the UNIX source package,
+ go to the &xslt4c-dist;-src directory and run<br/><br/>
+ <code>gmake <ref>Target</ref></code><br/><br/>
+ where <ref>Target</ref> is <code>Samples</code> (all the samples), <code>ApacheModuleXSLT</code>,
+ <code>CompileStylesheet</code>, <code>DocumentBuilder</code>, <code>ExternalFunctions</code>,
+ <code>ParsedSourceWrappers</code>, <code>SerializedNodeSet</code>, <code>SimpleTransform</code>,
+ <code>SimpleXPathAPI</code>, <code>SimpleXPathCAPI</code>, <code>StreamTransform</code>,
+ <code>ThreadSafe</code>, <code>TraceListen</code>, <code>TransformToXercesDOM</code>,
+ <code>UseStylesheetParam</code>, <code>XalanTransform</code>, or
+ <code>XalanTransformerCallback</code>.</p>
+<p>To rebuild the samples from the UNIX binary package, go to the ../samples directory of your installation,
+ run the runConfigure utility for your target platform, and then run gmake. For example, AIX users would
+ issue the following command:<br/><br/>
+ <code>./runConfigure -p aix -c xlc_r -x xlC_r</code><br/>
+ <code>cd samples</code><br/><br/>
+ <code>gmake <ref>Target</ref></code><br/><br/>
+ where <ref>Target</ref> can be Samples (for building all samples), or the individual sample name as
+ listed above.</p>
+<note>For information on building Apache Module, see <link idref="samples"
+ anchor="apachemodulexslt">ApacheModuleXSLT</link></note>
+</s2>
+
+<anchor name="apachemodulexslt"/>
+<s2 title="ApacheModuleXSLT">
+<note>This sample must be built with the Apache Web server, and the &xslt4c; distribution files do not include a binary
+ for ApacheModuleXSLT. Assuming you have installed the Apache server on your platform, you can use Visual C++ on Windows to
+ build ApacheModuleXSLT.dll, or the Makefile on UNIX to build xslt_module (with the appropriate library suffix).</note>
+
+<p>What it does: runs as an Apache module on an Apache Web server; performs transformations and returns the output to a Web
+ browser. You configure Apache to respond to a given URL request for an output file (html or txt file in the configuration below)
+ by applying an xsl stylesheet file to an xml document file (both with the specified name in a given location) and returning
+ the transformation output to the client.</p>
+<p>This sample also illustrates use of the XalanTransformer class and the C API defined in src/XalanTransformer/XalanCAPI.h. It returns
+ transformation output in blocks to a callback function, which enables the browser to start displaying the result before the transformation
+ has been completed.</p>
+<note>You may need to adjust the Visual C++ or Makefile settings to locate the required Apache header files. As shipped, the Visual C++
+ project file looks in \Apache Group\Apache\src\include, and the UNIX Makefile looks in usr/lib.</note>
+<p>To build the Apache module, follow the instructions in <link idref="buildlibs" anchor="winbldenv">Steps for doing a Windows
+ build</link> or <link idref="buildlibs" anchor="unixbldenv">Steps for doing a UNIX build</link>. For UNIX platforms, you do the build with<br/>
+ <code>gmake ApacheModuleXSLT</code>.</p>
+
+<s3 title="Setting up and using ApacheModuleXSLT">
+<p>To use ApacheModuleXSLT, do the following:</p>
+<ol>
+ <li>(UNIX only) Be sure the Xalan and Xerces libraries are on your library path (you can accomplish this by copying them to
+ /usr/lib; see <link idref="getstarted" anchor="path">Setting up the path/library path</link>), and copy the Apache module to
+ /usr/lib/apache.<br/><br/></li>
+ <li>Add LoadModule and (UNIX only) AddModule entries to the Apache configuration file: httpd.conf.<br/><br/>
+ Windows: <code>LoadModule xslt_module &xslt4c-dist;-<my_Windows_distribution>\bin\ApacheModuleXSLT.dll</code><br/><br/>
+ UNIX: <code>AddModule mod_xslt.c</code><br/>
+ and<br/>
+ <code>LoadModule xslt_module /usr/lib/apache/mod_xslt.<ref>xx</ref></code><br/><br/>
+ where <ref>xx</ref> is the appropriate library suffix for the UNIX platform ("so" or "a").<br/><br/></li>
+ <li>Add a <Location> entry to httpd.conf that indicates where xml/xsl file pairs are to be found, and what target file extensions
+ to recognize. We suggest the following:<br/><br/>
+ <code><Location /xslt></code><br/>
+ <code>AddHandler mod_xslt .html</code><br/>
+ <code>AddHandler mod_xslt .txt</code><br/>
+ <code></Location></code><br/><br/>
+ This <Location> element instructs the module to respond to requests for <ref>xxx</ref>.html and <ref>xxx</ref>.txt files in the
+ in the xslt subdirectory (under the document root; see next item) by applying the <ref>xxx</ref>.xsl stylesheet to <ref>xxx</ref>.xml
+ (both in that directory) and returning the transformation result to the browser.<br/><br/>
+ For example, a request for foo.html instructs the module to apply foo.xsl to foo.xml and return the result.<br/><br/>
+ Note: It is up to the stylesheet to apply the appropriate xsl:output method to the output. Whether the user specifies html or txt is, of
+ itself, immaterial.<br/><br/></li>
+ <li>Put xml/xsl file pairs in the <Location> subdirectory (xslt in the example)) under the document root directory specified in
+ httpd.conf by the DocumentRoot and <Directory> settings. Alternatively, you can modify these settings to point to
+ &xslt4c-dist;-<my_UNIX_distribution>/samples/ApacheModuleXSLT, which includes an xslt subdirectory with xml/xsl file pairs
+ (foo.xml/xsl, apachemod.xml/xsl).<br/><br/></li>
+ <li>Start the Apache server.<br/><br/></li>
+ <li>From a Web browser, call the module with a URL as follows:<br/>
+ <code>http://<ref>serverName</ref>/xslt/<ref>xxx</ref>.html</code><br/>
+ where <ref>serverName</ref> is the Apache server (such as www.myServer.com) and <ref>xxx</ref> is the name of an xml/xsl pair of files
+ (such as foo.xml and foo.xsl) in the xslt subdirectory under the DocumentRoot directory.<br/><br/>
+ For example,<br/>
+ <code>http://www.myServer.com/xslt/apachemod.html</code><br/>
+ instructs ApacheModuleXSLT to apply the apachemod.xsl stylesheet to the apachemod.xml XML document (both files in the xslt directory
+ under the Apache DocumentRoot directory) and return the transformation result to the browser.</li>
+</ol>
+</s3>
+</s2>
+
+<anchor name="compilestylesheet"/>
+<s2 title="CompileStylesheet">
+<p>What it does: Use a compiled stylesheet to perform a series of transformations.</p>
+<p>You can run it from the CompileStylesheet subdirectory with</p>
+<p><code>CompileStylesheet</code></p>
+<p>See also: <link idref="usagepatterns" anchor="compiled">Compiling stylesheets</link>.</p>
+</s2>
+
+<anchor name="documentbuilder"/>
+<s2 title="DocumentBuilder">
+<p>What it does: Use a DocumentBuilder to programmatically construct an XML document, apply the foo.xsl stylesheet to
+ this document, and write the ouput to foo.out.</p>
+<p>You can run it from the DocumentBuilder subdirectory with</p>
+<p><code>DocumentBuilder</code></p>
+</s2>
+
+<anchor name="externalfunctions"/>
+<s2 title="ExternalFunctions">
+<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
+ foo.out.</p>
+<p>Run this sample from the ExternalFunctions subdirectory with</p>
+<p><code>ExternalFunctions</code></p>
+<p>See also: <link idref="extensions">Extension Functions</link>.</p>
+</s2>
+
+<anchor name="parsedsourcewrappers"/>
+<s2 title="ParsedSourceWrappers">
+<p>What it does: performs a transformation with input in the form of a pre-built XercesDOM or XalanSourceTree.</p>
+<p>Run this sample from the ParsedSourceWrappers subdirectory with</p>
+<p><code>ParsedSourceWrappers</code></p>
+<p>See transformXercesDOM() and transformXalanSourceTree() as called by transform() in ParsedSourceWrappers.cpp.</p>
+</s2>
+
+<anchor name="serializenodeset"/>
+<s2 title="SerializeNodeSet">
+<p>What it does: Serialize the node set returned by the application of an XPath expression to an XML document.</p>
+<p>Run this sample from the SerializeNodeSet subdirectory with</p>
+<p><code>SerializeNodeSet <ref>XMLFile</ref> <ref>ContextNode</ref> <ref>XPathExpression</ref></code></p>
+<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 SerializeNodeSet
+ directory contains the same foo.xml sample source file as the preceding examples.</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 writes the
+ output to foo.out. The source for this sample has been modified to demonstrate the usage of the new pluggable
+ memory management feature.</p>
+<p>You can run it from the SimpleTransform subdirectory with</p>
+<p><code>SimpleTransform</code></p>
+<p>See also: <link idref="usagepatterns" anchor="xalantransformer">Basic procedures for performing XSL
+ transformations</link>.</p>
+</s2>
+
+<anchor name="simplexpathapi"/>
+<s2 title="SimpleXPathAPI">
+<p>What it does: Use the XPathEvaluator interface to evaluate an XPath expression from the specified context node of
+ an XML file and display the nodeset returned by the expression.</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>
+<p>Run this sample from the SimpleXPathAPI subdirectory with</p>
+<p><code>SimpleXPathAPI <ref>XMLFile</ref> <ref>ContextNode</ref> <ref>XPathExpression</ref></code></p>
+<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.</p>
+<note>Keep in mind that the string value returned by an XPath expression is the string value of the first node in the
+ nodeset returned by the expresssion.</note>
+<p>The XPathWrapper subdirectory contains an XML file named xml.foo (part of it appears below).</p>
+<source>
+<?xml version="1.0"?>
+<doc>
+ <name first="David" last="Marston">Mr. Marson</name>
+ <name first="David" last="Bertoni">Mr. Bertoni</name>
+ ...
+ <name first="Paul" last="Dick">Mr. Dick</name>
+</doc>
+</source>
+<p>You can try command lines like</p>
+<p><code>SimpleXPathAPI foo.xml /doc name/@last</code></p>
+<p>and</p>
+<p><code>SimpleXPathAPI foo.xml / '//name[position()="4"]/@first'</code></p>
+<note>If a SimpleXPathAPI argument includes characters (such as *) that the shell interprets incorrectly, enclose the argument
+ in double quotes.</note>
+<p>See also: <link idref="usagepatterns" anchor="xpath">Working with XPath expressions</link>.</p>
+</s2>
+
+<anchor name="simplexpathcapi"/>
+<s2 title="SimpleXPathCAPI">
+<p>What it does: Use the XPathEvaluator C interface to evaluate an XPath epxeression and display the string value returned
+ by the epxression.</p>
+<note>Keep in mind that the string value returned by an XPath expression is the string value of the first node in the nodeset
+ returned by the epxresssion.</note>
+<p>Run this sample from the SimpleXPathCAPI subdirectory with</p>
+<p><code>SimpleXPathCAPI <ref>XMLFile</ref> <ref>XPathExpression</ref></code></p>
+<p>where <ref>XMLFile</ref> is an XML source file, and <ref>XPathExpression</ref> is an XPath expression to apply to the XML
+ source file. The SimpleXPathCAPI subdirectory contains an XML file named xml.foo identical to foo.xml in the preceding
+ example.</p>
+<p>You can try command lines like</p>
+<p><code>SimpleXPathCAPI foo.xml /doc/name[3]</code></p>
+</s2>
+
+<anchor name="streamtransform"/>
+<s2 title="StreamTransform">
+<p>What it does: The StreamTransform class processes character input streams containing a stylesheet and an XML document, and
+ writes the transformation output to a character output stream. This sample illustrates the process for working with stylesheets
+ and documents that you assemble in memory.</p>
+<p>You can run it from the SimpleTransform subdirectory with</p>
+<p><code>StreamTransform</code></p>
+</s2>
+
+<anchor name="threadsafe"/>
+<s2 title="ThreadSafe">
+<p>What it does: Multiple threads use a single compiled stylesheet (StylesheetRoot) and DOM source tree (XalanNode) to perform
+ transformations concurrently. The application tracks the progress of the threads in messages to the console, and each thread
+ writes its own output file. Imagine a server application responding to multiple clients who happen to request the same
+ transformation.</p>
+<p>You can run it from the ThreadSafe subdirectory with</p>
+<p><code>ThreadSafe</code></p>
+<p>See also: <link idref="usagepatterns" anchor="compiled">Compiling stylesheets</link>.</p>
+</s2>
+
+<anchor name="tracelisten"/>
+<s2 title="TraceListen">
+<p>What it does: Trace events during a transformation; the transformation uses birds.xsl to transform birds.xml and writes the
+ output to birds.out.</p>
+<p>You can run it from the TraceListen subdirectory with</p>
+<p><code>TraceListen <ref>traceFlags</ref></code></p>
+<p>where <ref>traceFlags</ref> is one or more of the following:</p>
+<p> <code>-tt</code> (Trace the templates as they are being called)</p>
+<p> <code>-tg</code> (Trace each result tree generation event)</p>
+<p> <code>-ts</code> (Trace each selection event)</p>
+<p> <code>-ttc</code> (Trace the template children as they are being processed)</p>
+<p>These flags are also available in the <link idref="commandline">command-line utility (TestXSLT)</link>.</p>
+<p>The core of this example is the following fragment:</p>
+<source>
+// Set up a diagnostic writer to be used by the TraceListener...
+XalanStdOutputStream theStdErr(cerr);
+XalanOutputStreamPrintWriter diagnosticsWriter(theStdErr);
+// Make sure that error reporting, which includes any TraceListener
+// output does not throw exceptions when transcoding, since that could
+// result in an exception being thrown while another exception is active.
+// In particular, characters that the TraceListener writes might not be
+// representable in the local code page.
+theStdErr.setThrowTranscodeException(false);
+
+// Set up the TraceListener...
+// traceTemplates, traceTemplateChildren, traceGenerationEvent,
+// and TraceSelectionEvent are booleans set by the command line.
+TraceListenerDefault theTraceListener(
+ diagnosticsWriter,
+ traceTemplates,
+ traceTemplateChildren,
+ traceGenerationEvent,
+ traceSelectionEvent);
+
+// Add the TraceListener to the XSLT processor...
+theProcessor.setTraceSelects(traceSelectionEvent);
+theProcessor.addTraceListener(&theTraceListener);
+
+// Perform the transformation
+....
+</source>
+</s2>
+
+<anchor name="transformtoxercesdom"/>
+<s2 title="TransformToXercesDOM">
+<p>What it does: Performs a simple transformation but puts the result in a Xerces DOMDocument</p>
+<p>Run this sample from the TransformToXercesDOM subdirectory with</p>
+<p><code>TransformToXercesDOM <ref>XMLFile</ref> <ref>XSLFile</ref></code></p>
+<p>where <ref>XMLFile</ref> is a source XML file, and <ref>XSLFile</ref> is the XLST input file. The program will use
+ <ref>XSLFile</ref> to transform the input file <ref>XMLFile</ref> using Xerces DOM as the output destination.</p>
+<p>See the FormatterToXercesDOM usage in the sample code.</p>
+</s2>
+
+<anchor name="usestylesheetparam"/>
+<s2 title="UseStylesheetParam">
+
+<p>What it does: Performs a transformation using top-level stylesheet parameters. There are three supported types of parameters. One is a text string. A second is a number of type double. A nodeset or parsed document can also be used.</p>
+
+<p>You can run it from the UseStylesheetParam subdirectory with</p>
+
+<p><code>UseStylesheetParam <ref>xmlfile</ref> <ref>stylesheet</ref> <ref>outfile</ref> [options]</code></p>
+
+<p>where the options are:</p>
+
+<p><code> -s key "'String-Value'"</code><br/>
+<code> -n key Number</code><br/>
+<code> -d key "Document-URL"</code></p>
+
+<p>The files used by the sample program and the top-level parameter nodesets for this illustration are to be in working directory in which the sample program runs.</p>
+
+<p>Using the sample program:</p>
+
+<p><code>UseStylesheetParam foo.xml foo.xslt foo.out \<br/>
+ -s stringA "'This is a test string value'" \<br/>
+ -n numberA 123.012345 \<br/>
+ -d parmA "parmA.xml" \<br/>
+ -d parmB "parmB.xml"</code></p>
+
+<p>The <ref>parmA.xml</ref> and <ref>parmB.xml</ref> are parsed and converted to nodesets. The stylesheet <ref>foo.xslt</ref> merges the contents of <ref>foo.xml</ref> and the parameters into the <ref>foo.out</ref> file.</p>
+
+<p>The source sample is implemented in C++. Another example is implemented in 'C' using the XalanCAPI library <ref>TestCAPIparm.c</ref>. The usage interface for both is the same.</p>
+
+<p>See also: <link idref="usagepatterns" anchor="params">Setting stylesheet parameters</link>.</p>
+</s2>
+
+<anchor name="xalantransform"/>
+<s2 title="XalanTransform">
+<p>What it does: XalanTransform uses the XalanTransformer class and the associated C++ API to apply an XSL stylesheet
+ file to an XML document file and write the transformation output to either an output file or to a stream. XalanTransform
+ takes command-line arguments for the XML document to be transformed, the XSL stylesheet to apply, and an optional output
+ file argument. If you omit the third argument, XalanTransform writes the transformation output to a stream that is sent to
+ standard out (the console).</p>
+<p>You can run XalanTransform from the XalanTransform subdirectory with</p>
+<p><code>XalanTransform foo.xml foo.xsl foo.out</code></p>
+<p>Omit the third argument to write the transformation result to the console. See also: <link idref="usagepatterns"
+ anchor="xalantransformer">Using the XalanTransformer class.</link>.</p>
+</s2>
+
+<anchor name="xalantransformercallback"/>
+<s2 title="XalanTransformerCallback">
+<p>What it does: Return transformation output in blocks to a callback function, which writes the output to a file.
+ This sample illustrates the use of a callback function to incrementally process a transformation result, that is to begin
+ working with the transformation result before the transformation has been completed. See <link idref="usagepatterns"
+ anchor="incremental">Processing output incrementally</link>.</p>
+<p>You can run it from the XalanTransformerCallback subdirectory with</p>
+<p><code>XalanTransformerCallback foo.xml foo.xsl [foo.out]</code></p>
+<note>If you omit the third argument, the transformation result is written to the console.</note>
+</s2>
+
+</s1>
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org