Author: wsmoak
Date: Sun Jun 18 18:30:11 2006
New Revision: 415227
URL: http://svn.apache.org/viewvc?rev=415227&view=rev
Log:
[SHALE-179] Maven 2 reorg - Update the information on acquiring and building.
Modified:
struts/shale/trunk/src/site/xdoc/building.xml
struts/shale/trunk/src/site/xdoc/index.xml
Modified: struts/shale/trunk/src/site/xdoc/building.xml
URL:
http://svn.apache.org/viewvc/struts/shale/trunk/src/site/xdoc/building.xml?rev=415227&r1=415226&r2=415227&view=diff
==============================================================================
--- struts/shale/trunk/src/site/xdoc/building.xml (original)
+++ struts/shale/trunk/src/site/xdoc/building.xml Sun Jun 18 18:30:11 2006
@@ -25,24 +25,58 @@
<p>The easiest way to acquire the source code for Shale is to download
one of the
<a href="http://cvs.apache.org/builds/struts/nightly/struts-shale/";>
- Nightly Build</a> or release distributions, which contain both the
+ Nightly Build</a> or <a href="http://struts.apache.org/downloads.html";>
+ Release Distributions</a>, which contain both the
source code and the binary libraries. Alternatively, you can check out
the source code from the Struts Subversion repository using the
URLs specified
- <a
href="http://struts.apache.org/downloads.html#Source_Code";>here</a>.</p>
+ <a
href="http://struts.apache.org/downloads.html#Source%20Code";>here</a>.</p>
</subsection>
+ <a name="building-building"/>
+ <subsection name="Building Shale From Source">
+
+ <p>Once you have <a href="#building-acquiring">acquired</a> the
+ source code for Shale from the Subversion repository or a nightly
+ build, as described above, you can proceed to set up a development
+ environment with which to build it. Follow these steps to
continue:</p>
+
+ <ul>
+ <li>Acquire a copy of a <a href="http://java.sun.com/javase/";>Java
+ Development Kit</a> (Version 1.4 or later), and install it
according
+ to the provided documentation.</li>
+ <li>Acquire a copy of <a href="http://maven.apache.org/";>Apache
Maven</a>
+ (version 2.0.4 or later), and install it according to the
+ provided documentation.</li>
+ <li>By default, the Shale build uses <a
href="http://myfaces.apache.org";>
+ Apache MyFaces</a>, but you can also build against the JavaServer
+ Faces Reference Implementation by adding <code>-Djsf=ri</code>
+ to the command line.</li>
+ <li>In the top-level directory of the unpacked Shale distribution,
+ execute the command <code>mvn clean install</code> to completely
+ rebuild the framework distribution from source.</li>
+ <li>In the shale-apps directory of the unpacked Shale distribution,
+ execute the command <code>mvn clean install</code> to
completely
+ rebuild the example applications from source.</li>
+ <li>In addition, each of the major source subdirectories has a
properly
+ configured <code>pom.xml</code> file, so you can rebuild just
that
+ subdirectory if desired.</li>
+ </ul>
+
+ </subsection>
+
+
<a name="building-building"/>
- <subsection name="Building Shale From Source">
+ <subsection name="Building Shale 1.0.2 (Alpha) From Source">
<p>Once you have <a href="#building-acquiring">acquired</a> the
- source code for Shale, as described above, you can proceed to set
+ Shale 1.0.2 (Alpha) distribution, you can proceed to set
up a development environment with which to build it. Follow these
steps to continue:</p>
<ul>
- <li>Acquire a copy of a <a href="http://java.sun.com/j2se/";>Java
+ <li>Acquire a copy of a <a href="http://java.sun.com/javase/";>Java
Development Kit</a> (Version 1.4 or later), and install it
according
to the provided documentation.</li>
<li>Acquire a copy of <a href="http://ant.apache.org/";>Apache Ant</a>
Modified: struts/shale/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/struts/shale/trunk/src/site/xdoc/index.xml?rev=415227&r1=415226&r2=415227&view=diff
==============================================================================
--- struts/shale/trunk/src/site/xdoc/index.xml (original)
+++ struts/shale/trunk/src/site/xdoc/index.xml Sun Jun 18 18:30:11 2006
@@ -199,23 +199,17 @@
<ul>
- <li><b>shale-framework-YYYYMMDD.{tar.gz,zip}</b> - The binary
- and source download of the framework itself.</li>
-
- <li><b>shale-dependencies-YYYYMMDD.{tar.gz,zip}</b> - For convenience,
- this is a snapshot of all the dependencies (other than the JavaServer
- Faces RI, which cannot be included for license reasons) that would
- normally be downloaded by executing the download-dependencies target in
- the top level build script.</li>
-
- <li><b>shale-starter-YYYYMMDD.{tar.gz,zip}</b> - A starting point source
- directory structure for a Shale based application that will use Ant as
the
- build tool. This is based on the source code of the Shale Blank Starter
- Application example, but separated out for the convenience of those who
- need only this feature.</li>
-
- <li><b>shale-XXXXXXXX-YYYYMMDD.war</b> - A web application archive for
- each example application that is avaiable. Currently, the available
+ <li><b>shale-framework-1.0.x-SNAPSHOT.{tar.gz,zip}</b> - The binary
+ and source download of the framework itself, including its
+ dependencies.</li>
+
+ <!-- TODO: Rework the Shale Blank archetype into a multi-module
+ build with a core jar, and separate webapp and integration
+ test modules. -->
+
+ <li><b>shale-XXXXXXXX-dist.{tar.gz,zip}</b> - A distribution containing
+ source code and a web application archive for
+ each example application that is available. Currently, the available
examples are: shale-blank, shale-mailreader, shale-usecases, and
shale-sql-browser.</li>
@@ -245,21 +239,16 @@
Tiles Integration</a>.</li>
<li><a href="shale-tiger/apidocs/index.html" target="_blank">
Tiger Extensions</a>.</li>
- <li><a href="shale-usecases/apidocs/index.html" target="_blank">
+ <li><a href="shale-apps/shale-usecases/apidocs/index.html"
target="_blank">
Use Cases Sample App</a>.</li>
- <li><a href="shale-mailreader/apidocs/index.html" target="_blank">
+ <li><a href="shale-apps/shale-mailreader/apidocs/index.html"
target="_blank">
Mailreader Example App</a>.</li>
- <li><a href="shale-blank/apidocs/index.html" target="_blank">
+ <li><a href="shale-apps/shale-blank/apidocs/index.html" target="_blank">
Shale Blank Example App</a>.</li>
- <li><a href="shale-sql-browser/apidocs/index.html" target="_blank">
+ <li><a href="shale-apps/shale-sql-browser/apidocs/index.html"
target="_blank">
SQL Browser Example App</a>.</li>
</ul>
- <p>PDF Documentation:</p>
- <ul>
- <li><a href="struts-shale.pdf">Shale Framework</a></li>
- </ul>
-
</section>
<section name="Shale Mailing Lists">
