You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by jo...@apache.org on 2003/08/21 03:15:27 UTC
cvs commit: cocoon-2.0/src/documentation/xdocs/installing index.xml
joerg 2003/08/20 18:15:27
Modified: src/documentation/xdocs/installing index.xml
Log:
Changed the default build handling: "build webapp" builds a locally usable servlet context and is now the default target. "build war" packages the webapp into the well-known cocoon.war. "build all" is removed as it is the same as "build package".
Revision Changes Path
1.8 +157 -158 cocoon-2.0/src/documentation/xdocs/installing/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/cocoon-2.0/src/documentation/xdocs/installing/index.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- index.xml 3 Jul 2003 14:42:00 -0000 1.7
+++ index.xml 21 Aug 2003 01:15:27 -0000 1.8
@@ -6,15 +6,7 @@
<header>
<title>Installing Apache Cocoon</title>
<authors>
- <person name="Stefano Mazzocchi" email="stefano@apache.org"/>
- <person name="Giacomo Pati" email="Giacomo.Pati@pwr.ch"/>
- <person name="Tom Klaasen" email="tom.klaasen@the-ecorp.com"/>
- <person name="Chris Stevenson" email="zhcchz@mail.on.net"/>
- <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
- <person name="Vadim Gritsenko" email="vgritsenko@apache.org"/>
- <person name="Bernhard Huber" email="berni_huber@a1.net"/>
- <person name="Nicola Ken Barozzi" email="nicolaken@apache.org"/>
- <person name="Sylvain Wallez" email="sylvain@apache.org"/>
+ <person name="Cocoon Developers" email="dev@cocoon.apache.org"/>
</authors>
</header>
@@ -143,7 +135,7 @@
<note>Tomcat overrides the standard java endorsed directory. For tomcat, you'll need to use <code>%TOMCAT_HOME%\common\endorsed</code> for all these changes.</note>
<note>If you use the binary distribution, the above jars are bundled in the war file. You can get them by extracting the war with a zip utility and looking in <code>WEB-INF\lib</code>
</note>
- <p>Due to changes in JDBC between JDK 1.3 and JDK 1.4, it is not possible
+ <p>Due to changes in JDBC between JDK 1.3 and JDK 1.4, it is not possible
to use Cocoon built on JDK 1.2/1.3 with JDK 1.4 when it comes to databases. If you use the binary distribution, be sure to download the one appropriate for your JDK.</p>
</s2>
@@ -157,8 +149,8 @@
in the <code>WEB-INF/lib</code> directory. You can find the compiler
in <code>%JAVA_HOME%/lib/javac.jar</code>.
</p>
- <p>If you use the source distribution of Cocoon, the build system takes
- care of this and copies the jar file to the appropriate directory.
+ <p>If you use the source distribution of Cocoon, the build system takes
+ care of this and copies the jar file to the appropriate directory.
If you use the binary distribution or want to switch between different
JDKs you have to copy <code>%JAVA_HOME%/lib/javac.jar</code> to
<code>WEB-INF/lib/javac.jar</code> replacing the existing version.
@@ -325,7 +317,7 @@
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>
- <p><strong>Note:</strong>This feature is only available in the latest developer
+ <p><strong>Note:</strong>This feature is only available in the latest developer
version of Cocoon which you can find in the CVS. </p>
</s2>
<s2 title="Running the build">
@@ -368,256 +360,263 @@
<s3 title="Cocoon build targets">
<p>The <strong>build.xml</strong> file comes with some basic
- important targets. If no target is specified, the default one
+ important targets. If no target is specified, the default one
is used (defined in build.xml).</p>
<note>Some targets are preliminary and their call method will change
in the future. Preliminary targets are marked as [BETA].</note>
-
+
<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>
+ 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">
+
+ <s4 title="build webapp">
+ <p>Creates the Cocoon webapp in <code>./build/cocoon/webapp</code>
+ directory usable as servlet context for quicker turn around.</p>
+ <ul>
+ <li><strong>target:</strong> webapp</li>
+ <li><strong>required properties:</strong> include.webapp.libs</li>
+ <li><strong>buildfile:</strong> build.xml</li>
+ </ul>
+
+ <p>To do this you simply have to type:</p>
+
+<source>
+ [unix] ./build.sh -Dinclude.webapp.libs=yes webapp
+ [win32] .\build.bat -Dinclude.webapp.libs=yes webapp
+</source>
+ <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>
+ <li>exclude.webapp.javadocs : to exclude the java docs</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
+ -Dexclude.webapp.javadocs=yes webapp
+ [win32] .\build.bat -Dinclude.webapp.libs=yes
+ -Dexclude.webapp.samples=yes
+ -Dexclude.webapp.documenation=yes
+ -Dexclude.webapp.javadocs=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>
+
+ <note>This is currently the default target.</note>
+ </s4>
+
+ <s4 title="build war">
+
+ <p>Creates the Cocoon WAR package out of the <code>./build/cocoon/webapp</code>
+ directory. It's a non-interactive version of installwar.</p>
+
+ <ul>
+ <li><strong>target:</strong> war</li>
+ <li><strong>required properties:</strong> include.webapp.libs</li>
+ <li><strong>buildfile:</strong> build.xml</li>
+ </ul>
+
+ <p>It packages the complete webapp from the <code>./build/cocoon/webapp</code>
+ directory into one file called <code>cocoon.war</code>. The configuration
+ and the options are so the same as for <code>build webapp</code>.
+ </p>
+ </s4>
+
+ <s4 title="[BETA] build installwar">
+ <p>Builds and installs Cocoon war package in a specified directory.</p>
+
+ <ul>
+ <li><strong>target:</strong> installwar</li>
+ <li><strong>required properties:</strong> asks the user for installation path</li>
+ <li><strong>buildfile:</strong> build.xml</li>
+ </ul>
+
+ <note>This is the recommended target for an easy install in Tomcat.</note>
+
+ <note>Available in interactive build.</note>
+ </s4>
+
+ <s4 title="build clean">
+ <p>Cleans the build directory. It is recommended to clean Cocoon
+ build directory every time you upgrade Cocoon, or add/remove
+ libraries from the <code>./lib/optional/</code>
+ directory, or change JDK version.
+ </p>
+
+ <ul>
+ <li><strong>target:</strong> clean</li>
+ <li><strong>required properties:</strong> none</li>
+ <li><strong>buildfile:</strong> build.xml</li>
+ </ul>
+ <note>Available in interactive build.</note>
+ </s4>
+
+ <s4 title="build package">
<p>Builds all main Cocoon targets to create the <strong>cocoon.jar</strong>
package.
</p>
<ul>
- <li><strong>target:</strong> all</li>
+ <li><strong>target:</strong> package</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
- <note>This is currently the default target.</note>
+ <note>Available in interactive build.</note>
+ </s4>
- <note>Available in interactive build.</note>
+ <s4 title="build compile">
+ <p>Compiles Cocoon source files.</p>
+
+ <ul>
+ <li><strong>target:</strong> compile</li>
+ <li><strong>required properties:</strong> none</li>
+ <li><strong>buildfile:</strong> build.xml</li>
+ </ul>
+
+ <note>Available in interactive build.</note>
</s4>
<s4 title="[BETA] build interactive">
<p>Shows common build targets and asks the user for eventual
properties that may be needed.
</p>
-
+
<ul>
<li><strong>target:</strong> interactive</li>
<li><strong>required properties:</strong> none - asks if needed</li>
- <li><strong>buildfile:</strong> tools/build-i.xml</li>
+ <li><strong>buildfile:</strong> tools/build-i.xml</li>
</ul>
-
+
<p>To do this you simply have to type:</p>
-
+
<source>
[unix] ./build.sh -buildfile tools/build-i.xml
[win32] .\build.bat -buildfile tools/build-i.xml
</source>
-
- <note>This is the recommended target for first-time users.</note>
+
+ <note>This is the recommended target for first-time users.</note>
</s4>
-
- <s4 title="[BETA] build installwar">
- <p>Builds and installs Cocoon war package in a specified directory.
- </p>
-
- <ul>
- <li><strong>target:</strong> installwar</li>
- <li><strong>required properties:</strong>
- asks the user for installation path</li>
- <li><strong>buildfile:</strong> build.xml</li>
- </ul>
- <note>This is the recommended target for an easy install in Tomcat.</note>
-
- <note>Available in interactive build.</note>
- </s4>
-
<s4 title="build docs">
<p>Builds the Cocoon documentation in html format.
</p>
-
+
<ul>
<li><strong>target:</strong> docs</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
-
- <note>Available in interactive build.</note>
- </s4>
+
+ <note>Available in interactive build.</note>
+ </s4>
<s4 title="build javadocs">
<p>Builds the Cocoon javadocs in html format.
</p>
-
+
<ul>
<li><strong>target:</strong> javadocs</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
-
- <note>Available in interactive build.</note>
- </s4>
+
+ <note>Available in interactive build.</note>
+ </s4>
<s4 title="build printer-docs">
<p>Builds the Cocoon documentation in html printer-friendly format.
</p>
-
+
<ul>
<li><strong>target:</strong> printer-docs</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
-
- <note>Available in interactive build.</note>
- </s4>
+
+ <note>Available in interactive build.</note>
+ </s4>
<s4 title="build test">
<p>Runs Cocoon unit tests.
</p>
-
+
<ul>
<li><strong>target:</strong> test</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
-
- <note>Available in interactive build.</note>
- </s4>
- <s4 title="build compile">
- <p>Compiles Cocoon source files.
- </p>
-
- <ul>
- <li><strong>target:</strong> compile</li>
- <li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
- </ul>
-
- <note>Available in interactive build.</note>
- </s4>
+ <note>Available in interactive build.</note>
+ </s4>
- <s4 title="build clean">
- <p>Cleans the build directory. It is recommended to clean Cocoon
- build directory every time you upgrade Cocoon, or add/remove
- libraries from the <code>./lib/optional/</code>
- directory, or change JDK version.
- </p>
-
- <ul>
- <li><strong>target:</strong> clean</li>
- <li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
- </ul>
-
- <note>Available in interactive build.</note>
- </s4>
-
<s4 title="build dist">
<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>
<li><strong>target:</strong> dist</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> build.xml</li>
+ <li><strong>buildfile:</strong> build.xml</li>
</ul>
-
- <note>The results are in the dist directory.</note>
- </s4>
-
- <s4 title="build webapp">
-
- <p>Creates the Cocoon WAR package. It's a non-interactive version
- of installwar.</p>
- <ul>
- <li><strong>target:</strong> webapp</li>
- <li><strong>required properties:</strong> include.webapp.libs</li>
- <li><strong>buildfile:</strong> build.xml</li>
- </ul>
-
- <p>To do this you simply have to type:</p>
-
-<source>
-[unix] ./build.sh -Dinclude.webapp.libs=yes webapp
-[win32] .\build.bat -Dinclude.webapp.libs=yes webapp</source>
-
- <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>
- <li>exclude.webapp.javadocs : to exclude the java docs</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
- -Dexclude.webapp.javadocs=yes webapp
-[win32] .\build.bat -Dinclude.webapp.libs=yes
- -Dexclude.webapp.samples=yes
- -Dexclude.webapp.documenation=yes
- -Dexclude.webapp.javadocs=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>
- <p><strong>Note:</strong>This feature is only available in the latest developer
- version of Cocoon which you can find in the CVS. </p>
+ <note>The results are in the dist directory.</note>
</s4>
-
+
<s4 title="[BETA] build scratchpad">
<p>An interactive build to help alpha-testers in installing
cutting-edge code.
</p>
-
+
<ul>
<li><strong>target:</strong> scratchpad</li>
<li><strong>required properties:</strong> none</li>
- <li><strong>buildfile:</strong> tools/build-s.xml</li>
+ <li><strong>buildfile:</strong> tools/build-s.xml</li>
</ul>
-
+
<p>To do this you simply have to type:</p>
-
+
<source>
[unix] ./build.sh -buildfile tools/build-s.xml
[win32] .\build.bat -buildfile tools/build-s.xml</source>
-
+
<note><strong>WARNING:</strong> Scratchpad builds are <strong>not guaranteed to work</strong>.
You have been warned.
- </note>
- </s4>
-
+ </note>
+ </s4>
+
<s4 title="[BETA] build try">
<p>Makes it possible to try new build targets that have not yet made
it into the core build. These targets are in tools/builds/try.xml.
</p>
-
+
<ul>
<li><strong>target:</strong> try</li>
<li><strong>required properties:</strong> try.target</li>
- <li><strong>buildfiles:</strong> build.xml, tools/build-t.xml</li>
+ <li><strong>buildfiles:</strong> build.xml, tools/build-t.xml</li>
</ul>
-
+
<p>To test target test-target for example, you simply have to type:</p>
-
+
<source>
-[unix] ./build.sh try -Dtry.target=test-target
+[unix] ./build.sh try -Dtry.target=test-target
[win32] .\build.bat try -Dtry.target=test-target</source>
-
+
<note>Targets are in tools/build-i.xml.</note>
</s4>
</s3>
</s2>
</s1>
-
+
<s1 title="Installing Cocoon">
<p>In most servlet engines, this is just a matter of copying
the war file in a specific directory and the engine will take
@@ -1191,7 +1190,7 @@
<p>To get Cocoon running do the following:</p>
<ul>
<li>Stop the server if it is running.</li>
-
+
<li>
<strong>For 2.0.3 version and older:</strong>
If yours Resin is older then 2.0.4, you have to install Xerces as default XML parser for Resin
@@ -1390,7 +1389,7 @@
</li>
<li>Deploy cocoon.war webapp using console.</li>
<li>Save server configuration file.</li>
- <li>Restart the server using <code>stopServer</code> and
+ <li>Restart the server using <code>stopServer</code> and
<code>startServer</code> scripts.</li>
<li>Open the Cocoon welcome page:
<code>http://localhost:9080/cocoon/</code>