mhoyt 2004/01/12 14:48:52
Modified: c/xdocs/sources entities.ent
c/xdocs/sources/xalan getstarted.xml readme.xml
Log:
Various documentation fixes
PR: 25716
Submitted by: [EMAIL PROTECTED]
Revision Changes Path
1.34 +2 -0 xml-xalan/c/xdocs/sources/entities.ent
Index: entities.ent
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/entities.ent,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- entities.ent 10 Jan 2004 22:12:26 -0000 1.33
+++ entities.ent 12 Jan 2004 22:48:52 -0000 1.34
@@ -58,6 +58,8 @@
<!ENTITY xslt4c "Xalan-C++">
<!ENTITY xslt4c-dist "Xalan-C_1_7_0">
+<!ENTITY xslt4c-win_root "xml-xalan\c">
+<!ENTITY xslt4c-unix_root "xml-xalan/c">
<!ENTITY xslt4c-current "Xalan-C++ version 1.7">
<!ENTITY xslt4c-windll "Xalan-C_1_7_0.dll">
<!ENTITY xslt4c-linuxlib "libxalan-c1_7.so">
1.46 +10 -10 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.45
retrieving revision 1.46
diff -u -r1.45 -r1.46
--- getstarted.xml 10 Jan 2004 22:12:26 -0000 1.45
+++ getstarted.xml 12 Jan 2004 22:48:52 -0000 1.46
@@ -197,7 +197,7 @@
<s3 title="For Windows">
<p>To use the Windows distribution, you must place the Xalan executables and
the Xalan and Xerces libraries on the path:</p>
<ul>
-<li>Put
&xslt4c-dist;-<my_Windows_distribution>\Build\Win32\VC6\Release and
&xml4c-dist;-<my_Windows_distribution>\bin on the path.</li>
+<li>Put &xslt4c-win_root;\Build\Win32\VC6\Release and
&xml4c-dist;-<my_Windows_distribution>\bin on the path.</li>
</ul>
<p>The Visual C++ Xalan project included with the Windows release knows the
relative paths to the Xalan headers and libraries, but it does not know where
you have unzipped the Xerces distribution. If you plan to use Visual C++ to
build Xalan applications or <link idref="readme" anchor="jar">rebuild
Xalan</link>, you must also provide Visual C++ with access to the Xerces
headers and libraries.</p>
<p>Use the Visual C++ Tools menu to open the Options dialog box, go to the
Directories tab, and do the following:</p>
@@ -212,26 +212,26 @@
the &xslt4c; and &xml4c; libraries on the library path.</p>
<p>For the &xslt4c; AIX distributions:</p>
<ul>
-<li>Put &xslt4c-dist;-<my_AIX_distribution>/bin on the path
(PATH).</li>
-<li>Put &xslt4c-dist;-<my_AIX_distribution>/lib and
&xml4c-dist;-<my_AIX_distribution>/lib
+<li>Put &xslt4c-unix_root;/bin on the path (PATH).</li>
+<li>Put &xslt4c-unix_root;/lib and
&xml4c-dist;-<my_AIX_distribution>/lib
on the library path (LIBPATH), or copy the shared libraries to /usr/lib.</li>
</ul>
<p>For the &xslt4c; HP-UX 11 distributions:</p>
<ul>
-<li>Put &xslt4c-dist;-<my_HPUX_distribution>/bin on the path
(PATH).<br/><br/></li>
-<li>Put &xslt4c-dist;-<my_HPUX_distribution>/lib and
&xml4c-dist;-<my_HPUX_distribution>/lib on the library path (SHLIB_PATH),
or copy
+<li>Put &xslt4c-unix_root;/bin on the path (PATH).<br/><br/></li>
+<li>Put &xslt4c-unix_root;/lib and
&xml4c-dist;-<my_HPUX_distribution>/lib on the library path (SHLIB_PATH),
or copy
the shared libraries to /usr/lib.</li>
</ul>
<p>For the &xslt4c; Solaris distributions:</p>
<ul>
-<li>Put &xslt4c-dist;-<my_solaris_distribution>/bin on the path
(PATH).<br/><br/></li>
-<li>Put &xslt4c-dist;-<my_solaris_distribution>/lib and
&xml4c-dist;-<my_solaris_distribution>/lib on the library path
+<li>Put &xslt4c-unix_root;/bin on the path (PATH).<br/><br/></li>
+<li>Put &xslt4c-unix_root;/lib and
&xml4c-dist;-<my_solaris_distribution>/lib on the library path
(LD_LIBRARY_PATH), or copy the shared libraries to /usr/lib.</li>
</ul>
<p>For the &xslt4c; RedHat and SuSE Linux distributions:</p>
<ul>
-<li>Put &xslt4c-dist;-<my_linux_distribution>/bin on the path
(PATH).</li>
-<li>Put &xslt4c-dist;-<my_linux_distribution>/lib and
&xml4c-dist;-<my_linux_distribution>/lib on the library path
(LD_LIBRARY_PATH),
+<li>Put &xslt4c-unix_root;/bin on the path (PATH).</li>
+<li>Put &xslt4c-unix_root;/lib and
&xml4c-dist;-<my_linux_distribution>/lib on the library path
(LD_LIBRARY_PATH),
or copy the shared libraries to /usr/lib.</li>
</ul>
</s3>
@@ -241,7 +241,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-dist;-<my_Windows_distribution>\Build\Win32\VC6\Release. In
the UNIX distributions, the executables are in
&xslt4c-dist;-<my_UNIX_distribution>/bin.</li>
+&xslt4c-win_root;\Build\Win32\VC6\Release. In the UNIX distributions, the
executables are in &xslt4c-win_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.51 +32 -33 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.50
retrieving revision 1.51
diff -u -r1.50 -r1.51
--- readme.xml 7 Jan 2004 19:02:30 -0000 1.50
+++ readme.xml 12 Jan 2004 22:48:52 -0000 1.51
@@ -101,10 +101,10 @@
should be changed to:<br/><br/>
<code>#include
"xalanc/XercesParserLiaison/Deprecated/XercesDocumentBridge.hpp"</code><br/><br/></li>
<li>Upgrade from Xerces-C 2.3 to Xerces-C 2.4. </li>
+ <li>Porting of ThreadSafe example to UNIX platform.</li>
<li>Implementation of EXSLT string extension functions encode-uri()
and decode-uri(). </li>
<li>Implementation of EXSLT dynamic extension function evaluate().
</li>
<li>Implementation of EXSLT date-time extension function
date-time().</li>
- <li>Porting of ThreadSafe example to UNIX platform.</li>
</ul>
</s3>
@@ -153,7 +153,7 @@
<ol>
<li>If you want to enable ICU support, install the ICU so the ICU root
directory is at the same level as the xml-xerces directory (see <link
idref="usagepatterns" anchor="icu">Using the ICU</link>). If you
choose to build Xalan with ICU, you will need to rebuild the Xerces binary with
ICU as well.<br/><br/></li>
- <li>Use Visual C++ to open the Xalan workspace from the
&xslt4c-dist;-src\Projects\Win32\VC6. If you are building with ICU, then use
XalanICU.dsw. Otherwise, open the Xalan.dsw workspace.
+ <li>Use Visual C++ to open the Xalan workspace 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/></li>
<li>From Visual C++, go to "Tools" and select "Options". From the
"Options" window, click on the "Directories" tab and do the following:
<ol>
@@ -171,9 +171,9 @@
<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/xalan", you would set the XALANCROOT to "/home/xalan/&xslt4c-dist;-src".
<br/><br/></li>
+ 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 &xslt4c-dist;-src in the &xslt4c;
distribution. You can also
+ <li>Change directory to &xslt4c-unix_root; in the &xslt4c;
distribution. 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
@@ -190,8 +190,8 @@
<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 icu.</td></tr>
- <tr><td>M</td><td>Locale for Message Localization Support. Default
is "en_US'</td></tr>
+ 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>
@@ -215,8 +215,8 @@
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 -x xlC -P
$HOME/my_xalan</code><br/><br/>
- Following the build process, standard binary directories bin, lib,
and include would be created
- under my_xalan.<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/>
@@ -239,39 +239,39 @@
</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-dist;-src,</note><p>
- <br/> <code>CC ...
-I/home/&xslt4c-dist;-src/src -I/home/&xslt4c-dist;-src/src/xalanc
mysrc.cpp</code><anchor name="64"/></p>
+ <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
+ <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". </li>
+ 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). By default, XSLT4C is built
using ICU localization
- support. </li>
+ 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
+ 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
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-dist;-src/c/src/xalanc/NLS directory (for example, the default
XLIFF message file
- provided is xslt4cMessages_en_US.xlf). To build, you will need to follow
the same steps
+ &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>Open the Xalan workspace using Microsoft Visual C++. </li>
- <li>Select the Localization project, and go to Settings and click on the
"General" tab. Modify
+ <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>
<li>Add the Xerces-C bin directory to the PATH </li>
<li>Add the Xerces-C lib directory to the library directory list </li>
@@ -280,16 +280,16 @@
</ol>
<p>For building on the Windows platform with ICU method:</p>
<ol>
- <li>Open the Xalan workspace using Microsoft Visual C++. </li>
- <li>Select the AllInOneWithICU project, and ensure that the project
depends on the Localization
+ <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 Localization project, and go to Settings and click on the
"General" tab. Modify
+ <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>
<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>
<li>Open the tools.ini file under Projects\Win32\VC6\Utils\Localization
and add the ICU root
- directory to the ICUROOT variable setting. </li>
+ directory to the ICUROOT variable setting. Another option is to define
ICUROOT as an environmental variable. </li>
<li>Run "Build all" with the configuration of your choice. </li>
</ol>
<p>For building on the Unix platform:</p>
@@ -306,23 +306,22 @@
</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-dist;-src/c/src/xalanc/NLS/<locale_name> (for example
- &xslt4c-dist;-src/c/src/xalanc/NLS/en_US/) under the file name:<br/><br/>
+ <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>libxslt4cMessages_1_7.so (for UNIX)<br/>
- xslt4cMessages_1_7.dll and xslt4cMessages_1_7.lib (for Windows)
+ <tr><td><ref>ICU or "in memory" method:</ref></td><td>libxalanMsg17.so
(for UNIX)<br/>
+ XalanMessages_1_7_0.dll and XalanMessages_1_7_0.lib (for Windows)
</td></tr>
- <tr><td><ref>NLS method:</ref></td><td>xslt4cMessages_1_7.cat</td></tr>
+ <tr><td><ref>NLS method:</ref></td><td>xalanMsg1_7.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
+ 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
+ <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>
@@ -334,8 +333,8 @@
</s3>
<anchor name="samples"/>
<s3 title="Rebuilding a Sample application">
- <p>In the Windows32 distribution, all of the sample applications can be
built from the Xalan.dsw Visual C++ workspace. If you modify a sample and want
to recompile it, you can recompile the .cpp file(s) and rebuild the
executable.</p>
-<p>The Makefile that come with the UNIX distributions include targets for
rebuilding one or all of the sample applications (with the exception of the
ThreadSafe sample, which in its current form only runs under Windows). 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/>
+ <p>In the Windows32 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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
