You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by cr...@apache.org on 2005/11/24 20:46:48 UTC
svn commit: r348790 - in /struts/shale/trunk: build.xml
core-library/src/java/overview.html docs/release-notes-1.0.0.html
Author: craigmcc
Date: Thu Nov 24 11:46:44 2005
New Revision: 348790
URL: http://svn.apache.org/viewcvs?rev=348790&view=rev
Log:
Tweak global build script such that "ant clean release" works correctly
in a distribution (there were problems with the location of the release
notes file, which is now expected to be in the "docs" directory).
Fix hyperlinks in release notes and a couple of typos.
Remove API target audience and stability ratings info from the overview
Javadocs for the core library, since this information is now published
directly on the Shale website.
Modified:
struts/shale/trunk/build.xml
struts/shale/trunk/core-library/src/java/overview.html
struts/shale/trunk/docs/release-notes-1.0.0.html
Modified: struts/shale/trunk/build.xml
URL: http://svn.apache.org/viewcvs/struts/shale/trunk/build.xml?rev=348790&r1=348789&r2=348790&view=diff
==============================================================================
--- struts/shale/trunk/build.xml (original)
+++ struts/shale/trunk/build.xml Thu Nov 24 11:46:44 2005
@@ -616,8 +616,6 @@
<!-- Copy release-wide documentation -->
<copy todir="${target.dir}"
- file="docs/release-notes-1.0.0.html"/>
- <copy todir="${target.dir}"
file="build.xml"/>
<copy todir="${target.dir}"
file="build.properties.sample"/>
@@ -627,6 +625,11 @@
<fileset dir="core-library"
includes="*.txt"/>
</copy>
+ <mkdir dir="${target.dir}/docs"/>
+ <copy todir="${target.dir}/docs">
+ <fileset dir="docs"
+ includes="*.html"/>
+ </copy>
<!-- Copy clay-plugin artifacts -->
<mkdir dir="${target.dir}/clay-plugin"/>
@@ -670,6 +673,12 @@
<copy todir="${target.dir}/webapps">
<fileset dir="use-cases/dist"
includes="**/*.war"/>
+ </copy>
+
+ <!-- Copy standalone Tiles JAR to dist for convenience -->
+ <copy todir="${target.dir}/dist">
+ <fileset dir="${lib.dir}/tiles"
+ includes="*.jar"/>
</copy>
<!-- Construct archive files -->
Modified: struts/shale/trunk/core-library/src/java/overview.html
URL: http://svn.apache.org/viewcvs/struts/shale/trunk/core-library/src/java/overview.html?rev=348790&r1=348789&r2=348790&view=diff
==============================================================================
--- struts/shale/trunk/core-library/src/java/overview.html (original)
+++ struts/shale/trunk/core-library/src/java/overview.html Thu Nov 24 11:46:44 2005
@@ -21,6 +21,7 @@
<title>Shale Framework Overview</title>
</head>
<body>
+
<p>The <strong>Shale Framework</strong> is a loosely coupled set of value
added services focused on providing improved functionality and ease of
development for applications based on the
@@ -31,223 +32,6 @@
frameworks. Shale leverages the extensibility points that are also
built into JSF, and avoids the redundant implementation of features
that JSF already provides.</p>
-
-<h3>API Package Target Audiences and Stability Ratings</h3>
-
-<p>The core services provided by Shale are packaged in a series of
-JAR files, so that applications not utiizing some of the optional services
-need not include them. For each service, the APIs in particular Java
-packages are intended for public use by application developers, while
-other packages represent the internal implementation of Shale features,
-and would only be accessed directly if you intend to modify Shale's
-standard functionality. In the tables below, the intended target
-audience of each package is described by one of the following terms:</p>
-<ul>
-<li><em>Application</em> - Applications based on Shale may
- depend on APIs provided by this package. In general,
- such APIs will focus on avoiding backwards incompatble
- changes as they evolve.</li>
-<li><em>Framework</em> - Developers who wish to extend or
- modify the default implementation of Shale features
- may depend on APIs provided by this package. Stability
- of APIs across releases will still be a goal, but
- ongoing evolution will likely lead to some incompatible
- changes.</li>
-<li><em>Private</em> - This package is not intended for public
- use by developers, and its APIs are subject to change
- in later releases at any time.</li>
-</ul>
-
-<p>In addition to the intent described above, each package is also annotated
-with a stability rating, which is an indication of the expected rate of
-future change, described by one of the following terms:</p>
-<ul>
-<li><em>Private</em> - This package is not intended for public
- use by developers, and its APIs are subject to change
- in later releases at any time.</li>
-<li><em>Developing</em> - This package is under active development,
- and changes (including backwards incompatible changes) are likely
- in future versions.</li>
-<li><em>Evolving</em> - This package is continuing to be developed,
- but changes will generally add new features only, while maintaing
- backwards compatibility.</li>
-<li><em>Stable</em> - This package may continue to be developed,
- but offers the highest possible assurance of backwards compatibility
- in both public API and in functionality.</li>
-<li><em>Deprecated</em> - This package contains API that was available
- in previous versions, and is maintained (for a short while) for
- backwards compatibility purposes. However, dependencies on these
- APIs should be migrated appropriately, as at some point in time
- the package will be subject to removal.</li>
-</ul>
-
-
-<h3>Packages Delivered in <em>shale-core.jar</em></h3>
-
-<table border="1">
- <thead>
- <tr>
- <th width="30%">Package Name</th>
- <th width="10%">Target</th>
- <th width="10%">Stability</th>
- <th width="50%">Comments</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a href="org/apache/shale/application/package-summary.html">
- org.apache.shale.application</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/component/package-summary.html">
- org.apache.shale.component</a></td>
- <td>Application</td>
- <td>Evolving</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/dialog/package-summary.html">
- org.apache.shale.dialog</a></td>
- <td>Application</td>
- <td>Developing</td>
- <td>Expect further development to support multiple active
- dialogs in the same page.</td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/dialog/config/package-summary.html">
- org.apache.shale.dialog.config</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/dialog/faces/package-summary.html">
- org.apache.shale.dialog.faces</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/dialog/impl/package-summary.html">
- org.apache.shale.dialog.impl</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/faces/package-summary.html">
- org.apache.shale.faces</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/remote/package-summary.html">
- org.apache.shale.remote</a></td>
- <td>Application</td>
- <td>Developing</td>
- <td>Consider the current APIs to be experimental.</td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/renderer/package-summary.html">
- org.apache.shale.renderer</a></td>
- <td>Framework</td>
- <td>Evolving</td>
- <td>Functionality should be accessed indirectly via
- components in <code>org.apache.shale.component</code>.</td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/resources/package-summary.html">
- org.apache.shale.resources</a></td>
- <td>Framework</td>
- <td>Evolving</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/taglib/package-summary.html">
- org.apache.shale.taglib</a></td>
- <td>Application</td>
- <td>Evolving</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/util/package-summary.html">
- org.apache.shale.util</a></td>
- <td>Application</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/validator/package-summary.html">
- org.apache.shale.validator</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/view/package-summary.html">
- org.apache.shale.view</a></td>
- <td>Application</td>
- <td>Evolving</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="org/apache/shale/view/impl/package-summary.html">
- org.apache.shale.view.impl</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- </tbody>
-</table>
-
-<h3>Packages Delivered in <em>shale-spring.jar</em></h3>
-
-<table border="1">
- <thead>
- <tr>
- <th width="30%">Package Name</th>
- <th width="10%">Target</th>
- <th width="10%">Stability</th>
- <th width="50%">Comments</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a href="org/apache/shale/spring/package-summary.html">
- org.apache.shale.spring</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td>Functionality should be accessed indirectly via
- evaluating value binding and method binding expressions.</td>
- </tr>
- </tbody>
-</table>
-
-<h3>Packages Delivered in <em>shale-tiles.jar</em></h3>
-
-<table border="1">
- <thead>
- <tr>
- <th width="30%">Package Name</th>
- <th width="10%">Target</th>
- <th width="10%">Stability</th>
- <th width="50%">Comments</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a href="org/apache/shale/tiles/package-summary.html">
- org.apache.shale.tiles</a></td>
- <td>Framework</td>
- <td>Developing</td>
- <td> </td>
- </tr>
- </tbody>
-</table>
</body>
</html>
Modified: struts/shale/trunk/docs/release-notes-1.0.0.html
URL: http://svn.apache.org/viewcvs/struts/shale/trunk/docs/release-notes-1.0.0.html?rev=348790&r1=348789&r2=348790&view=diff
==============================================================================
--- struts/shale/trunk/docs/release-notes-1.0.0.html (original)
+++ struts/shale/trunk/docs/release-notes-1.0.0.html Thu Nov 24 11:46:44 2005
@@ -41,8 +41,8 @@
<a name="Introduction"></a>
<h3>1.0 Introduction</h3>
- <p>Welcome to the <a href="http://struts.apache.org/shale/">Apache Shale
- Framework</a>. Shale is a next generation framework for building web
+ <p>Welcome to the <a href="http://struts.apache.org/struts-shale/">Apache
+ Shale Framework</a>. Shale is a next generation framework for building web
applications using Java technology, and builds upon the framework and
component APIs provided by <a href="http://java.sun.com/j2ee/javaserverfaces/">
JavaServer Faces</a>.</p>
@@ -50,10 +50,9 @@
<p>This is the initial milestone release of Shale, released to encourage
experimentation and gather feedback on usage issues and requested features.
This should be treated as an "alpha" quality release. However, many of
- the APIs in Shale are reasonably stable -- for details, scroll down to the
- <em>API Package Target Audiences and Stability Ratings</em> section of the
- <a href="core-library/docs/api/overview-summary.html">Core Library Overview
- </a> JavaDocs.</p>
+ the APIs in Shale are reasonably stable -- for details, see
+ <a href="http://struts.apache.org/struts-shale/api-stability.html">
+ Shale API Target Audiences and Stability Ratings</a>.
<a name="Included"></a>
<h3>2.0 What Is Included</h3>
@@ -72,6 +71,9 @@
the <em>standalone</em> version of Tiles, currently under
development as part of the <a href="http://struts.apache.org">
Apache Struts</a> project.</li>
+ <li><code>tiles-core.jar</code> - For convenience, a copy of the
+ Standalone Tiles distribution is included here, to avoid the
+ requirement to extract it from the sample applications.</li>
</ul>
<li><a href="webapps">Example web applications</a>
<ul>
@@ -82,10 +84,10 @@
</ul></li>
<li>Source code and JavaDocs for the following modules:
<ul>
- <li><a href="core-library/docs/api/index.html">Core Library</a></li>
- <li><a href="clay-plugin/docs/api/index.html">Clay Plug-In</a></li>
- <li><a href="test-framework/docs/api/index.html">Unit Test Framework</a></li>
- <li><a href="use-cases/docs/api/index.html">Use Cases Example App</a></li>
+ <li><a href="../core-library/docs/api/index.html">Core Library</a></li>
+ <li><a href="../clay-plugin/docs/api/index.html">Clay Plug-In</a></li>
+ <li><a href="../test-framework/docs/api/index.html">Unit Test Framework</a></li>
+ <li><a href="../use-cases/docs/api/index.html">Use Cases Example App</a></li>
</ul>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org