dleslie 00/05/09 11:43:20
Modified: c/xdocs/sources/xalan STATUS getstarted.xml readme.xml
Added: c/xdocs/sources/xalan xalan-cdist.gif
Log:
Doc updates. Still rough draft.
Revision Changes Path
1.2 +12 -5 xml-xalan/c/xdocs/sources/xalan/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/xml-xalan/c/xdocs/sources/xalan/STATUS,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- STATUS 2000/04/26 13:05:55 1.1
+++ STATUS 2000/05/09 18:43:16 1.2
@@ -1,9 +1,16 @@
-<s3 title="Things still to be done">
+<s3 title="Version of Xerces to use">
+<p>Xalan-C version 1.0.0 has been tested with Xerces-C version 1.1.0. The
Xalan-C Windows32 download includes xerces-c_1_1.dll. The Xalan-C Linux
download includes libxerces-c_1_1.so.
+
+ For information about including The Xerces-C dynamic link or shared object
library on the system class path, see <link idref="getstarted"
anchor="classpath">Setting up the system class path</link>.</p>
+<p><em>Important</em> You may experience unpredictable anomalies if your
Xalan and Xerces builds are not in synch. If you download an update to Xalan,
check the release notes to determine which version of Xerces you should use.</p>
+
+</s3>
+<s3 title="To-do tasks for future Xalan releases">
<p>We still need to do the following:</p>
<ul>
- <li>Work on number formatting<br/><br/></li>
- <li>Fix up our implementation of XPath node-set objects<br/><br/></li>
- <li>Verify conformance to <resource-ref idref="XSLT"/><br/><br/></li>
- <li>Work on stability and performance<br/><br/></li>
+ <li>Implement a more efficient mechanism for storing and navigating
DOM trees, along the lines of the Xalan-J
+ Document Table Model (DTM)<br/><br/></li>
+ <li>Add support for extension elements<br/><br/></li>
</ul>
+ <p>Watch the <human-resource-ref idref="xalandev"/> for more information
and for ideas about how you can get involved.</p>
</s3>
1.2 +39 -19 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- getstarted.xml 2000/05/08 19:23:04 1.1
+++ getstarted.xml 2000/05/09 18:43:17 1.2
@@ -10,34 +10,54 @@
<li><link anchor="apps">Setting up your own XSLT applications</link></li>
</ul>
<anchor name="download"/>
-<p>For Xalan-C 1.0.0, we are distributing a Windows32 build and a Linux
build. In the future, we intend to add more
-builds.</p>
<s2 title="Downloading what you need">
-<p>To run the Xalan command-line utility for performing transformations, you
need the following:</p>
-
-<ul>Windows
-<li> The utility: TestXSLT.exe (Windows32), TestXSLT (Linux)</li>
-<li>The 8 Xalan-C dynamic link libraries Windows32): DOMSupport.dll,
PlatformSupport.dll, XalanDOM.dll, XercesParserLiaison.dll;
+<p>For Xalan-C 1.0.0, we are distributing a Windows32 Visual C++ build and a
Linux build. In the future, we intend to add more builds.</p>
+<s3 title="Xalan-C Distributions">
+<p><img src="xalan-cdist.gif" alt="xalan-cdist.gif"/></p>
+</s3>
+<p>For the Windows32 build, download <jump
href="http://xml.apache.org/dist/xalan-c/xalan-c_1_0_0.zip";>xalan-c_1_0_1.zip</jump>.</p>
+<p>For the Linux build, download <jump
href="http://xml.apache.org/dist/xalan-j/xalan-c_1_0_0.tar.gz";>xalan-c_1_0_0.tar.gz</jump>.</p>
+<p>Each distribution contains all you need to run the Xalan command-line
utility for performing transformations.</p>
+<s3 title="What you need to run the Xalan command-line utility">
+<p>To run the Xalan executable for performing transformations, you need the
following:</p>
+<p><em>Windows32</em></p>
+<ul>
+<li>The executable: TestXSLT.exe</li>
+<li>The 8 Xalan-C dynamic link libraries: DOMSupport.dll,
PlatformSupport.dll, XalanDOM.dll, XercesParserLiaison.dll,
XercesPlatformSupport.dll, XMLSupport.dll, XPath.dll, XSLT.dll</li>
-<li>The Xerces-C dynamic link library to which the Xalan-C dlls are linked:
xerces-c_1_1.dll</li>
-Linux
+<li>The Xerces-C dynamic link library: xerces-c_1_1.dll</li>
</ul>
-
-<p>For the Windows32 build, download <jump
href="http://xml.apache.org/dist/xalan-c/xalan-c_1_0_0.zip";>xalan-c_1_0_1.zip</jump>.
For the Linux build, download <jump
href="http://xml.apache.org/dist/xalan-j/xalan-c_1_0_0.tar.gz";>xalan-c_1_0_0.tar.gz</jump>.
Both of these files contain the Xalan dlls and command-line utility
(TextXSLT.exe), along with the Xerces-C 1.1.0 dynamic link library
(xerces-c_1_1.dll). You can use a zip or tar utility to expand these files into
a full build.</p>
-<p>To build your own &xslt4c; applications, you also need need the Xalan-C
and Xerces-C header files and libraries. The Xalan-C header files are in the
source tree in both distributions: xml-xalan/c/src. In the Windows32
distribution (built with Microsoft Visual C++ 6.0), the dlls and libraries are
in xml-xalan/Build/Win32/VC6/Release. In the Linux distribution (built with
make), the shared object libraries are in xml-xalan/c/lib.</p>
-<p>To get the Xerces-C source tree, download the Xerces-C 1.1.? Source
distribution from the <resource-ref idref="Xerces-c-dist"/>. </p>
+<p><em>Linux</em></p>
+<ul>
+ <li>The utility: Test.XSLT</li>
+ <li>The Xalan-C shared library: libxalan-c_0_1_1.so</li>
+ <li>The Xerces-C shared library: libxerces-c1_1.so</li>
+</ul>
+<p>For information about using the command-line utility, see <link
idref="commandline">Command-Line Utility</link>.</p>
+</s3>
+<s3 title="What you need to build applications">
+<p>To build your own applications with Xalan and Xerces, you also need need
the
+Xalan-C and Xerces-C header (.hpp) files and (for Windows) the Xerces-C
libraries (.lib files).</p>
+<p>The Xalan-C header files are in the source tree in both distributions. In
the Windows32 distribution (built with Microsoft® Visual C++® 6.0), the
dlls and libraries are in the Build - Win32 -V6 - Release subdirectory. In the
Linux distribution (built with a make file), the shared object library is in
the lib subdirectory.</p>
+<p>To get the Xerces-C header and (for Windows) .lib files, download and
expand the Xerces-C 1.1.0 Binary distribution for your platform from the
<resource-ref idref="Xerces-c-dist"/>.</p>
+<note>If you want to rebuild Xalan, you will also need the Xerces-C source
distribution (Xalan uses a header file that is not included in the Xerces-C
binary distributions). For more information, see <link idref="readme"
anchor="build"></link>Build Notes.</note>
+</s3>
</s2><anchor name="path"/>
<s2 title="Setting up the system path">
-<p>The Xalan-C distribution includes a build directory with the Xalan and
Xerces dlls listed above, and the executables for the sample applications.
Include this directory on your system plath. If you do your own Xalan and
Xerces builds, be sure to include the directories that contain these dlls and
executables on your system path.</p>
+<p>For the Xalan-C Windows32 distribution, place
xml-xalan\c\Build\Win32\VC6\Release on the system path.</p>
+<p>For the Xalan-C Linux distribution, place xml-xalan/c/lib on the system
path. </p>
+<p>If you do your own Xalan and Xerces builds, be sure to include the
directories that contain these dlls and executables on your system path.</p>
</s2><anchor name="samples"/>
<s2 title="Trying out the samples">
-<p>The &xslt4c; distribution includes a number of basic sample applications.
These samples are easy to run, and you
-can review the source files -- all of which are brief -- to see just how
they work.</p>
+<p>The &xslt4c; Windows32 distribution includes a number of basic sample
applications. These samples are easy to run,
+ and you can review the source files -- all of which are brief -- to see
just how they work.</p>
+ <note>The Linux distribution includes the sample application source files
in the samples subdirectories. You can use these source files to build the
executables. </note>
<p>To run the samples, do the following:</p>
<ol>
-<li>Set up your path(see above), including the directory with the sample
executables.</li>
-<li>Go to the samples subdirectory containing the sample (use the DOS shell
if you are running Windows).</li>
+<li>Set up your path (see above). In the Windows32 distribution, the sample
executables are in
+xml-xalan\c\Build\Win32\VC6\Release.(</li>
+<li>Go to the samples subdirectory containing the sample (use the DOS shell
in Windows).</li>
<li>Run the sample from the command line.</li>
<li>Examine the application source files.</li>
</ol>
@@ -47,7 +67,7 @@
<p>For more information about all the samples, see <link
idref="samples">&xslt4c; Samples</link>.</p>
</s2><anchor name="commandline"/>
<s2 title="Performing your own transformations from the command line">
-<p>TestXSLT.exe provides a basic utility for performing transformations from
the command line. The command line for
+<p>TestXSLT(.exe) provides a basic utility for performing transformations
from the command line. The command line for
most standard transformations is as follows:</p>
<p><code>TestXSLT -in <ref>xmlSource</ref> -xsl <ref>stylesheet</ref> -out
<ref>outputfile</ref></code></p>
<p>where <ref>xmlSource</ref> is the XML source file name,
<ref>stylesheet</ref> is the XSL stylesheet file name, and
<ref>outputfile</ref> is the output file name.</p>
1.2 +7 -32 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- readme.xml 2000/05/08 19:23:04 1.1
+++ readme.xml 2000/05/09 18:43:17 1.2
@@ -68,12 +68,9 @@
</ul>
<s2 title="Status">
<ul>
- <li><link anchor="done">Bug fixes</link></li>
- <li><link anchor="bugs">Outstanding bugs</link></li>
+ <li><link anchor="bugs">Bug reporting</link></li>
<li><link anchor="status">Version of Xerces-C to use</link></li>
</ul>
- <anchor name="done"/>
- &done-c;
<anchor name="bugs"/>
&bugs-c;
<anchor name="status"/>
@@ -88,36 +85,14 @@
</ul>
<anchor name="jar"/>
<s3 title="Rebuilding &xslt4c;">
- <p>the Xalan-C dynamic link libraries and command-line executable.</p>
- <p>The &xslt4c; build is in xalan.jar. The &xslt4c; source code tree is
in the src directory.
- If you want to rebuild xalan.jar, you can do the following:</p>
- <ol>
- <li>Set up GNU or the equivalent build environment on your
workstation.<br/><br/>
- If you are running Windows 95/98/2000/NT, you can use the Cygwin port
of GNU. Be sure to put the
- appropriate Cygwin bin directory at the beginning of your system
path. For information about
- Cygwin, see <jump
href="http://www.sourceware.cygnus.com/cygwin/";>Cygwin</jump>.<br/><br/></li>
- <li>Place <resource-ref idref="xerces-used"/> xerces.jar in the Java
class path.<br/><br/></li>
- <li>If you are working in Windows, set MAKE_MODE as follows:<br/><br/>
- <code>set MAKE_MODE=UNIX</code><br/><br/></li>
- <li>Run the make file in the &xslt4c; root directory:<br/><br/>
- <code>make build</code><br/><br/></li>
- </ol>
- <p>If you want to do the build without the GNU build environment, keep
the following in mind:</p>
- <ul>
- <li>Set the class path to include the src directory, xerces.jar,
bsf.jar, and bsfengines.jar.</li>
- <li>Use a Java compiler (such as the IBM Just-In-Time compiler or the
Sun javac) to compile all the .java files in the src
- tree. </li>
- <li>Use the Sun jar utility to store the resulting .class files in
xalan.jar</li>
- </ul>
+ <p>To rebuild the Windows32 release, use the Microsoft Visual C++ 6.0
project files. To rebuild the Linux release, use the make file in the root of
the source directory.</p>
+ <p><em>Important</em> We have set up the Visual C++ projects and the
Linux make file to look for Xerces in a the directory structure that results
from downloading xml-xerces/c from the Apache XML repository and building with
the Visual C++ project files or the Linux make file. This structure parallels
the Xalan-C source tree and build structure.<br/><br/>
+If you are using a Xerces-C binary distribution, you must either modify the
Xalan-C project files or Makefile, or rearrange the build directory structure,
and you must also get the header files from the Xerces-C source distribution,
since Xalan-C uses a header file that is not included in the Xerces-C binary
distribution.</p>
</s3><anchor name="samples"/>
<s3 title="Rebuilding a sample application">
- <p>If you modify a sample and want to recompile it, you can run the Java
compiler in the directory containing the
- example. Be sure xalan.jar and xerces.jar are on the class path. To
recompile (and run!) the class files in the
- Servlet subdirectory, the javax.servlet and javax.servlet.http packages
must also be on the class path. Sun
- distributes these packages in the JSWDK 1.0.1 servlet.jar file.</p>
- <p>After recompiling a sample, you can use the Sun jar utility to place
your new .class files in
- xalansamples.jar.</p>
- </s3><anchor name="doc"/>
+ <p>The Windows32 distribution includes Visual C++ project files for each
of the sample applications. The project files are in the samples subdirectories
along with the source files. If you modify a sample and want to recompile it,
you can recompile the .cpp file(s) and rebuild the executable.</p>
+<p>The Linux distribution does not yet include make files for the sample
applications, so you must construct your own Linux make files and build the
sample executables.</p>
+ </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>
1.1 xml-xalan/c/xdocs/sources/xalan/xalan-cdist.gif
<<Binary file>>
