dleslie 99/12/30 09:51:40
Modified: docs document.dtd install.xml
Log:
Added general info on setting up Xalan as well as building it.
Revision Changes Path
1.4 +11 -14 xml-xalan/docs/document.dtd
Index: document.dtd
===================================================================
RCS file: /home/cvs/xml-xalan/docs/document.dtd,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- document.dtd 1999/12/16 16:51:52 1.3
+++ document.dtd 1999/12/30 17:51:40 1.4
@@ -1,31 +1,28 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<!ENTITY xslt4j "Xalan">
-<!ENTITY xml4j "Xerces">
-<!ENTITY resources SYSTEM "../docs/resources.xml">
-<!ENTITY done SYSTEM "../DONE">
-<!ENTITY status SYSTEM "../STATUS">
-<!ENTITY bugs SYSTEM "../BUGS">
+<!ENTITY xslt4j "Xalan-Java">
+<!ENTITY xml4j "Xerces-Java">
+<!ENTITY xslt4c "Xalan-C++">
+<!ENTITY xml4c "Xerces-C++">
+<!ENTITY resources SYSTEM "/xml-xalan1222/docs/resources.xml">
+<!ENTITY done SYSTEM "DONE">
+<!ENTITY status SYSTEM "STATUS">
+<!ENTITY bugs SYSTEM "BUGS">
<!ENTITY % blocksEntity SYSTEM "blocks.ent">
%blocksEntity;
-<!ELEMENT s1 (resources?,s2*)>
-<!ELEMENT s2 (s3|split|%blocks;)*>
+<!ELEMENT s1 (resources?,(s2|%blocks;)*)*>
+<!ELEMENT s2 (s3|%blocks;)*>
<!ELEMENT s3 (s4|%blocks;)*>
-<!ELEMENT s4 (s5|%blocks;)*>
-<!ELEMENT s5 (%blocks;)*>
+<!ELEMENT s4 (%blocks;)*>
-<!ELEMENT split (left,right)>
-<!ELEMENT left (s3|%blocks;)*>
-<!ELEMENT right (s3|%blocks;)*>
<!ATTLIST s1 title CDATA #REQUIRED>
<!ATTLIST s2 title CDATA #REQUIRED>
<!ATTLIST s3 title CDATA #REQUIRED>
<!ATTLIST s4 title CDATA #REQUIRED>
-<!ATTLIST s5 title CDATA #REQUIRED>
<!ELEMENT resources (resource|human-resource)+>
<!ELEMENT resource EMPTY>
1.4 +60 -12 xml-xalan/docs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/xml-xalan/docs/install.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- install.xml 1999/12/08 17:11:36 1.3
+++ install.xml 1999/12/30 17:51:40 1.4
@@ -60,20 +60,68 @@
<s1 title="Installation">
&resources;
- <s2 title="Installation Instructions">
-
+ <s2 title="Setting up &xslt4j;">
+ <p>To perform XSL transformations with &xslt4j;, you must provide a
Java run-time environment with access to an XML
+ parser. As explained in the next section, &xslt4j; runs by default with
a parser in &xml4j;. To set up &xslt4j;, do the
+ following:</p>
<ol>
<li><p>Install <resource-ref idref="JDK1.2"/> or
<resource-ref idref="JRE1.2"/>.
- (&xslt4j; should also work fine with 1.1.6 or later versions of the
JDK or Java
+ (&xslt4j; should also work fine with 1.1.6 or later versions of the
1.1 JDK or Java
runtime.)</p></li>
- <li><p>Download <resource-ref idref="xml4j-used"/>.</p></li>
- <li><p>Download &xslt4j;.</p></li>
- <li><p>Add &xml4j; and &xslt4j; to the system classpath, or
copy the &xml4j; jar
- into the &xslt4j; directory. To add &xml4j; and
&xslt4j; onto the system classpath,
- include something like:</p>
- <p><code>set
CLASSPATH=\xml-xalan\xalan.jar;\xml-xerces\java\xerces.jar;%CLASSPATH%</code></p>
- <p>in your autoexec.bat.</p></li>
-
+ <li><p>Download <resource-ref idref="Xalan-current"/>.</p></li>
+ <li><p>Download <resource-ref idref="xerces-used"/>.</p></li>
+ <li><p>Add the &xslt4j; and &xml4j; JAR files (xalan.jar and
xerces.jar) to the system classpath. To add
+ these jars to the system classpath, you can include a set statement
along the lines of</p>
+ <p><code>set
CLASSPATH=\xalan\xalan.jar;\xerces\xerces.jar;%CLASSPATH%</code></p>
+ <p>in your autoexec.bat.</p></li>
</ol>
+ <p>The basic infrastructure is now in place to perform XSL
transformations from the command line or from your own
+ java classes. For more information, see <resource-ref
idref="CommandLineUtility"/> and
+ <resource-ref idref="APIOverview"/>.</p>
</s2>
-</s1>
+
+ <s2 title="Using &xslt4j; with an &xml4j; Parser">
+ <p>By default, Xalan 0.19.1 uses the high-performance DTM parser in
Xalan 1.0.0 to parse XML documents
+ and XSL stylesheets. As indicated in the preceding section, you
provide &xslt4j; access to this parser by downloading
+ &xml4j; from http://xml.apache.org and placing xalan.jar in the
classpath. &xslt4j; also provides a liaison for the
+ &xml4j; 1.0.0 DOM parser.</p>
+ <note><p>If you want to use earlier alphaWorks releases of the XML4J
DOM or TXDOM parsers, you should download
+ LotusXSL 0.19.1 from
http://www.alphaworks.ibm.com/tech/LotusXSL.</p></note>
+ <p>If you want to use &xslt4j; with some other XML parser, it is up to
you to implement a liaison
+ to the parser. Your liaison class should extend
org.apache.xalan.xpath.xml.XMLParserLiaisonDefault
+ and implement org.apache.xalan.xpath.XPathSupport.</p>
+ </s2>
+
+ <s2 title="Rebuilding &xslt4j;">
+ <p>The &xslt4j; build is in xalan.jar. If you want to rebuild xalan.jar
+ yourself, do the following:</p>
+ <ol>
+ <li><p>Set up GNU or the equivalent build environment on your
workstation.</p>
+ <p> If you are running Windows 95/98/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
+ <link
idref="http://sourceware.cygnus.com/cygwin/";>Cygwin</link>.</p></li>
+ <li><p>Place <resource-ref idref="xerces-used"/> xerces.jar in the
Java classpath.</p></li>
+ <li><p>If you are working in Windows, set MAKE_MODE as follows:</p>
+ <p><code>set MAKE_MODE=UNIX</code></p></li>
+ <li><p>Run the lMakefile in the &xslt4j; root directory:</p>
+ <p><code>make -f lMakefile build</code></p></li>
+ </ol>
+ </s2>
+ <s2 title="Generating the documentation">
+ <p>&xslt4j; includes a number of XML source files, XSL stylesheets,
document type definition (DTD)
+ files, and entity relationship (ENT) files, that provide the input for
the Xalan User's Guide,
+ and the overview and package-level documents used during the
generation of Javadoc.</p>
+ <p>To generate the Xalan User's Guide, run the Xalan make file in the
Xalan <em>docs</em>
+ directory:</p>
+ <p><code>make -f lMakefile stylebook</code></p>
+ <p>To generate Xalan API documentation, set up the make file to use the
Javadoc tool in the Java JDK 1.2.2 bin
+ directory. </p>
+ <p>Do the following:</p>
+ <ol>
+ <li><p>Put the Java JDK 1.2.2 bin directory on your path (in front
of any JDK 1.1.x bin
+ directory that appears on the path).</p></li>
+ <li><p>In the Xalan docs directory, run the Xalan make file as
follows:</p>
+ <p><code>make -f lMakefile javadoc</code></p></li>
+ </ol>
+ </s2>
+</s1>
\ No newline at end of file
