cziegeler 2002/07/04 03:50:05
Modified: src/documentation/xdocs/installing index.xml
Log:
Minor update to the installation doc
Revision Changes Path
1.26 +32 -5 xml-cocoon2/src/documentation/xdocs/installing/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/installing/index.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- index.xml 26 Jun 2002 02:14:56 -0000 1.25
+++ index.xml 4 Jul 2002 10:50:05 -0000 1.26
@@ -229,7 +229,7 @@
</s1>
<s1 title="Building Cocoon">
- <p>If you downloaded binary distriution of the Cocoon, you can
+ <p>If you downloaded binary distribution of the Cocoon, you can
skip this chapter and proceed to the "Installing Cocoon".
</p>
@@ -274,7 +274,7 @@
</p>
<p>
A library/package is available to the build process when it is located
- in the <code>./lib/optional</code> directory.
+ in the <code>./lib/optional</code> or the <code>./lib/local</code> directory.
</p>
<p>
The following table contains a list of the optional components,
@@ -313,11 +313,20 @@
<td>No</td>
</tr>
</table>
- <p><strong>Note:</strong> If you added a library/package, you
+ <p>If you want to add additional libraries, put them in the
<code>./lib/local</code>
+ directory as this directory is not touched by CVS.
+ <strong>Note:</strong> If you added a library/package, you
need to rebuild Cocoon as described in 'Create the Cocoon WAR package'.
</p>
</s2>
-
+ <s2 title="Building a minimal Cocoon">
+ <p>If you want to build a minimal Cocoon, simply remove all optional libraries
+ from the <code>./lib/local</code> and the <code>./lib/optional</code>
directory.
+ Make a <code>build clean</code> and then a build with the target you want.
+ However, if you want to build a web application make sure you leave the
+ <code>servlet.jar</code> in the <code>./lib/optional</code> directory.
+ </p>
+ </s2>
<s2 title="Running the build">
<p>Cocoon uses <link href="http://jakarta.apache.org/ant/";>Jakarta Ant</link>
for the build and installation, and comes with a build script
@@ -367,6 +376,8 @@
<p>Cocoon targets place work files and results in a build directory
under the cocoon root. The only exception are the distribution targets
that build in a directory called dist.</p>
+ <p>The target you will most use is propably the <strong>webapp</strong>
+ target which builds a Cocoon web application. For more information see
below.</p>
<s4 title="build all">
<p>Builds all main Cocoon targets to create the
<strong>cocoon.jar</strong>
@@ -502,7 +513,9 @@
</s4>
<s4 title="build dist">
- <p>Creates source and binary distributions of Cocoon.
+ <p>Creates source and binary distributions of Cocoon. This target
+ is not intented for the usual Cocoon user; it's primary used
+ by the Cocoon developers to create a new distribution.
</p>
<ul>
@@ -534,6 +547,20 @@
<p>this will create the <code>cocoon.war</code> file in the
<code>./build/cocoon</code> directory. Follow instructions in the next
chapter to deploy this webapp in your container.</p>
+ <p>If you want a "clean" web application, you can specify these optional
+ properties:</p>
+ <ul>
+ <li>exclude.webapp.samples : to exclude the samples</li>
+ <li>exclude.webapp.documentation : to exclude the documentation</li>
+ </ul>
+ <p>So, if you first remove all libraries from the <code>./lib/local</code>
+ and the <code>./lib/optional</code> directory except the
<code>servlet.jar</code>
+ and then type:</p>
+<source>
+[unix] ./build.sh -Dinclude.webapp.libs=yes -Dexclude.webapp.samples=yes
-Dexclude.webapp.documenation=yes webapp
+[win32] .\build.bat -Dinclude.webapp.libs=yes -Dexclude.webapp.samples=yes
-Dexclude.webapp.documenation=yes webapp</source>
+ <p>you get a minimal Cocoon web application without any samples or
documentation.
+ But remember to make a <code>build clean</code> beforehand.</p>
</s4>
<s4 title="[BETA] build scratchpad">
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
