Author: wsmoak
Date: Sun Feb 5 15:40:45 2006
New Revision: 375135
URL: http://svn.apache.org/viewcvs?rev=375135&view=rev
Log:
Updated documentation
* Added links to the tiger extensions and the new example apps.
* Updated the description of the nightly build packages.
* Reorganized the menu to group the example apps.
* Added 'team-list.xml' to override the generated page.
* Added PDF generation to the multi-project site.
Added:
struts/shale/trunk/xdocs/team-list.xml (with props)
Modified:
struts/shale/trunk/build/maven.xml
struts/shale/trunk/build/project.xml
struts/shale/trunk/xdocs/features-tiger-extensions.xml
struts/shale/trunk/xdocs/index.xml
struts/shale/trunk/xdocs/navigation.xml
struts/shale/trunk/xdocs/pdf-navigation.xml
Modified: struts/shale/trunk/build/maven.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/build/maven.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/build/maven.xml (original)
+++ struts/shale/trunk/build/maven.xml Sun Feb 5 15:40:45 2006
@@ -29,6 +29,10 @@
<attainGoal name="clean"/>
</postGoal>
+ <postGoal name="multiproject:site">
+ <attainGoal name="pdf"/>
+ </postGoal>
+
<!-- Workaround for maven-dist-plugin's inability to find the
source code when running from 'build'. -->
<postGoal name="dist:prepare-src-filesystem">
Modified: struts/shale/trunk/build/project.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/build/project.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/build/project.xml (original)
+++ struts/shale/trunk/build/project.xml Sun Feb 5 15:40:45 2006
@@ -247,6 +247,15 @@
<url>http://maven.apache.org/maven-1.x/reference/plugins/javadoc/</url>
</dependency>
+ <dependency>
+ <groupId>maven</groupId>
+ <artifactId>maven-pdf-plugin</artifactId>
+ <version>2.5-SNAPSHOT</version>
+ <type>plugin</type>
+
<!--url>http://maven.apache.org/maven-1.x/reference/plugins/pdf/</url-->
+ <url>http://cvs.apache.org/repository/maven/plugins/</url>
+ </dependency>
+
</dependencies>
</project>
Modified: struts/shale/trunk/xdocs/features-tiger-extensions.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/xdocs/features-tiger-extensions.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/xdocs/features-tiger-extensions.xml (original)
+++ struts/shale/trunk/xdocs/features-tiger-extensions.xml Sun Feb 5 15:40:45
2006
@@ -110,7 +110,7 @@
to use a particular method name for these callbacks. In addition,
if your backing bean logic is not interested in one or more of the
view controller callbacks, you are <code>NOT</code> required to
- provide a method that is marked with the corresponding annotaiton.</p>
+ provide a method that is marked with the corresponding annotation.</p>
<h4>Annotated Component Registration</h4>
Modified: struts/shale/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/xdocs/index.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/xdocs/index.xml (original)
+++ struts/shale/trunk/xdocs/index.xml Sun Feb 5 15:40:45 2006
@@ -178,6 +178,10 @@
and <a href="junit.org">JUnit</a> test case base classes suitable
for
testing both the framework classes themselves, as well as
application
components built on top of the framework.</li>
+ <li><a href="features-tiger-extensions.html">Tiger Extensions</a> -
+ Optional add-on library that adds additional ease-of-use features
+ for Shale applications that run on Java Standard Edition 5
+ (popularly known by its code name during development,
"tiger").</li>
</ul>
</section>
@@ -188,22 +192,33 @@
<p>Nightly builds of Shale are available from
<a href="http://cvs.apache.org/builds/struts/nightly/struts-shale/";>
http://cvs.apache.org/builds/struts/nightly/struts-shale/</a>.
- For convenience, there are four available packages:</p>
+ For convenience, the nightly builds include the following packages:</p>
<ul>
- <li><strong>Core Library</strong> -
- The fundamental core of Shale, required for
- all applications using the framework.</li>
- <li><strong>Clay Plug-In</strong> -
- Library supporting reusable view fragments.</li>
- <li><strong>Test Framework</strong> -
- Library of mock objects and convenience base
- classes for JUnit test cases, suitable for testing both the framework
- itself and the components of applications built on top of Shale.</li>
- <li><strong>Use Cases Sample App</strong> -
- Composite set of use case based examples
- of Shale features.</li>
+
+ <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
+ examples are: shale-blank, shale-mailreader, shale-usecases, and
+ shale-sql-browser.</li>
+
</ul>
+
+ <p>Snapshots of Shale are also available in Maven repositories.</p>
</section>
@@ -225,20 +240,29 @@
Test Framework</a>.</li>
<li><a href="shale-tiles/apidocs/index.html" target="_blank">
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">
Use Cases Sample App</a>.</li>
<li><a href="shale-mailreader/apidocs/index.html" target="_blank">
Mailreader Example App</a>.</li>
- <li><a href="shale-tiger/apidocs/index.html" target="_blank">
- Tiger Extensions</a>.</li>
+ <li><a href="shale-blank/apidocs/index.html" target="_blank">
+ Shale Blank Example App</a>.</li>
+ <li><a href="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">
<a name="mail"/>
- <p>As a Struts sub-project, Shale shares the <i>user at
+ <p>As an Apache Struts sub-project, Shale shares the <i>user at
struts.apache.org</i> and <i>dev at struts.apache.org</i> mailing lists.
Subscription information can be found <a
href="../mail.html">here</a>.</p>
Modified: struts/shale/trunk/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/xdocs/navigation.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/xdocs/navigation.xml (original)
+++ struts/shale/trunk/xdocs/navigation.xml Sun Feb 5 15:40:45 2006
@@ -6,11 +6,6 @@
<title>Shale Framework</title>
<body>
- <links>
- <item name="Struts" href="http://struts.apache.org/"; />
- <item name="Shale" href="http://struts.apache.org/struts-shale"/>
- </links>
-
<menu name="Shale">
<item name="Background" href="/index.html#Background"/>
<item name="Features" href="/index.html#Shale_Features"/>
@@ -43,17 +38,21 @@
<item name="Struts-Faces Integration Library"
href="../struts-faces/index.html"/>
</menu>
- <menu name="Sub-Project Documentation">
+ <menu name="Additional Documentation">
<item name="Overview" href="/projects-overview.html"
collapse="true">
<item name="Core Library" href="/shale-core/index.html"/>
<item name="Test Framework" href="/shale-test/index.html"/>
<item name="Clay Plugin" href="/shale-clay/index.html"/>
- <item name="Use Cases" href="/shale-usecases/index.html"/>
- <item name="Mailreader" href="/shale-mailreader/index.html"/>
<item name="Tiles Integration" href="/shale-tiles/index.html"/>
<item name="Spring Integration" href="/shale-spring/index.html"/>
<item name="Tiger Extensions" href="/shale-tiger/index.html"/>
<item name="Core Library Tests" href="/shale-core-test/index.html"/>
+ <item name="Example Applications">
+ <item name="Use Cases" href="/shale-usecases/index.html"/>
+ <item name="Mailreader"
href="/shale-mailreader/index.html"/>
+ <item name="Blank" href="/shale-blank/index.html"/>
+ <item name="SQL Browser"
href="/shale-sql-browser/index.html"/>
+ </item>
</item>
</menu>
Modified: struts/shale/trunk/xdocs/pdf-navigation.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/xdocs/pdf-navigation.xml?rev=375135&r1=375134&r2=375135&view=diff
==============================================================================
--- struts/shale/trunk/xdocs/pdf-navigation.xml (original)
+++ struts/shale/trunk/xdocs/pdf-navigation.xml Sun Feb 5 15:40:45 2006
@@ -24,11 +24,7 @@
<item name="Tiles Integration"
href="/features-tiles-integration.html"/>
<item name="Reusable Views" href="/features-reusable-views.html"/>
<item name="Test Framework" href="/features-test-framework.html"/>
- </menu>
-
- <menu name="Tag Reference">
- <item name="Core Tags"
href="/shale-core/tagreference-taglib.html"/>
- <item name="Clay Tags"
href="/clay-plugin/tagreference-shale-clay.html"/>
+ <item name="Tiger Extensions"
href="/features-tiger-extensions.html"/>
</menu>
</body>
Added: struts/shale/trunk/xdocs/team-list.xml
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/xdocs/team-list.xml?rev=375135&view=auto
==============================================================================
--- struts/shale/trunk/xdocs/team-list.xml (added)
+++ struts/shale/trunk/xdocs/team-list.xml Sun Feb 5 15:40:45 2006
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <title>Project Team</title>
+ </properties>
+
+ <body>
+
+ <p>For a list of project team members, see the Apache Struts
+ <a href="http://struts.apache.org/volunteers.html";>Volunteers</a> and
+ <a href="http://struts.apache.org/team-list.html";>Project Team</a> pages.
+ </p>
+
+ </body>
+
+</document>
Propchange: struts/shale/trunk/xdocs/team-list.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: struts/shale/trunk/xdocs/team-list.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
