cziegeler 01/07/19 00:59:57
Modified: xdocs installing.xml
Log:
Added installation instructions for sql examples and optional components
Revision Changes Path
1.13 +92 -4 xml-cocoon2/xdocs/installing.xml
Index: installing.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/installing.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- installing.xml 2001/07/18 11:11:38 1.12
+++ installing.xml 2001/07/19 07:59:57 1.13
@@ -9,6 +9,7 @@
<person name="Giacomo Pati" email="[EMAIL PROTECTED]"/>
<person name="Tom Klaasen" email="[EMAIL PROTECTED]"/>
<person name="Chris Stevenson" email="[EMAIL PROTECTED]"/>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
</authors>
</header>
@@ -16,7 +17,7 @@
<s1 title="System Requirements">
<p>
- Cocoon requires the following systems to be already installed in your system:
+ Cocoon2 requires the following systems to be already installed in your system:
</p>
<p><strong>Java Virtual Machine</strong>
@@ -41,7 +42,19 @@
<s1 title="Getting Apache Cocoon 2">
- <s2 title="Step-by-step installation instructions for Windows">
+ <p>
+ You have two choices for getting Cocoon2: you can either download
+ a stable relese or you can get the latest in development version
+ directly from the cvs repository.
+ </p>
+ <s2 title="Download a distribution">
+ <p>
+ You can simply download the latest official release from the
+ <link href="http://xml.apache.org/dist/cocoon2";>cocoon2 distribution</link>
+ directory.
+ </p>
+ </s2>
+ <s2 title="Step-by-step cvs instructions for Windows">
<ol>
<li>Download
<link
href="ftp://cvsgui.sourceforge.net/pub/cvsgui/WinCvs120.zip";>WinCVS
@@ -59,6 +72,8 @@
<li> Click "create->checkout module";</li>
<li>Module name and path on the server is "xml-cocoon2" (no quotes);</li>
<li>Choose a dir to put the source code in;</li>
+ <li>Go to the "Checkout-options" tab and select "By revision/tag/branch"
+ and enter "cocoon_20_branch";</li>
<li>Click "Ok";</li>
<li>If everything goes well, messages will start to appear in the log
window;</li>
@@ -67,12 +82,12 @@
<li>The Cocoon2 source is now on your harddrive.</li>
</ol>
</s2>
- <s2 title="Step-by-step instructions for Unix">
+ <s2 title="Step-by-step cvs instructions for Unix">
<ol>
<li>Start the shell of your choice.</li>
<li>Enter "cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic
login".</li>
<li>When asked for the password: answer "anoncvs".</li>
- <li>Enter "cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic -z3
checkout xml-cocoon2". This will create a directory called "xml-cocoon2" where the
Cocoon2 source will be stored.</li>
+ <li>Enter "cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic -z3
checkout -r cocoon_20_branch xml-cocoon2". This will create a directory called
"xml-cocoon2" where the Cocoon2 source will be stored.</li>
<li>Wait until cvs has finished.</li>
<li>The Cocoon2 source is now on your harddrive.</li>
</ol>
@@ -112,6 +127,79 @@
</s2>
+ <s2 title="Making the sql examples work out of the box">
+ <p>
+ The sample web application delivered with Cocoon2 contains some
+ examples which require a sql database. To make them work out of
+ the box, the hsqldb is included. However, this database needs
+ the installation path to work correctly. Using tomcat (see notes
+ below) you could use the following instruction to directly
+ build a web application which is alreary configured for the sql
+ examples. The build script will copy it directly to your webapps
+ directory.
+ </p>
+ <source>
+[unix] ./build.sh -Dinclude.webapp.libs=yes -Dinstall.war={path-to-webapps-dir}
install
+[win32] .\build.bat -Dinclude.webapp.libs=yes -Dinstall.war={path-to-webapps-dir}
install
+ </source>
+ <p>
+ Please note that this might not work with all servlet engines
+ and that you must follow the steps below, too.
+ </p>
+ </s2>
+ <s2 title="Adding additional components">
+ <p>
+ Some of the components delivered with Cocoon2 required additional libraries,
+ e.g. the Php generator or the FOP serializer (for more information about
+ these components, refer to their documentation).
+ </p>
+ <p>
+ Most of these libraries are already included in the distribution, but some
+ have to be downloaded manually. The build task checks whether you have
+ the required libraries or not and includes the optional components only
+ if you have the libraries available when you build Cocoon2.
+ </p>
+ <p>
+ A library/package is available to the build process when it is located
+ in the './lib' directory.
+ </p>
+ <p>
+ The following table contains a list of the optional components,
+ their needed libraries and if they are already included or not.
+ </p>
+ <table>
+ <tr>
+ <th>Component</th>
+ <th>Required Library</th>
+ <th>Library Included</th>
+ </tr>
+ <tr>
+ <td>HTML Generator</td>
+ <td><link href="http://sourceforge.net/projects/jtidy";>JTidy</link></td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>Php Generator</td>
+ <td><link href="http://www.php.net";>Php Servlet</link></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>XT Transformer</td>
+ <td><link href="http://www.jclark.com/xml/xt.html";>XT Processor</link></td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>LDAP Transformer</td>
+ <td><link href="http://java.sun.com/products/jndi";>JNDI</link></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>PDF Serializer</td>
+ <td><link href="http://xml.apache.org/fop/index.html";>FOP</link></td>
+ <td>Yes</td>
+ </tr>
+</table>
+ </s2>
</s1>
<s1 title="Installing Cocoon2">
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
