struts-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r385020 - /struts/shale/trunk/docs/release-notes-1.0.1.html
Date Sat, 11 Mar 2006 05:56:39 GMT
Author: craigmcc
Date: Fri Mar 10 21:56:37 2006
New Revision: 385020

Add initial crack at the release notes for 1.0.1 (phew ... we did quite a lot
of stuff!).  Still need to refine the list of outstanding issues in section 4.

    struts/shale/trunk/docs/release-notes-1.0.1.html   (with props)

Added: struts/shale/trunk/docs/release-notes-1.0.1.html
--- struts/shale/trunk/docs/release-notes-1.0.1.html (added)
+++ struts/shale/trunk/docs/release-notes-1.0.1.html Fri Mar 10 21:56:37 2006
@@ -0,0 +1,303 @@
+ Copyright 2006 The Apache Software Foundation.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ $Id$
+  <head>
+    <title>Apache Shale (Version 1.0.1) Release Notes</title>
+  </head>
+  <body>
+    <div align="center">
+      <h1>Apache Shale (Version 1.0.1) Release Notes</h1>
+    </div>
+    <ul>
+    <li><a href="#Introduction">Introduction</a></li>
+    <li><a href="#Included">What Is Included</a></li>
+    <li><a href="#Changes">Changes From Previous Releases</a></li>
+    <li><a href="#Known">Known Issues In This Release</a></li>
+    </ul>
+    <a name="Introduction"></a>
+    <h3>1.0 Introduction</h3>
+    <p>Welcome to the <a href="">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="">
+    JavaServer Faces</a>.</p>
+    <p>This is the second 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, see
+    <a href="">
+    Shale API Target Audiences and Stability Ratings</a>.
+    <a name="Included"></a>
+    <h3>2.0 What Is Included</h3>
+    <p>A release of Shale includes several primary categories of materials:</p>
+    <ul>
+    <li><a href="../dist">Shale distribution libraries</a>:
+        <ul>
+        <li><code>shale-core.jar</code> - Core framework functionality</li>
+        <li><code>shale-clay.jar</code> - Clay plug-in</li>
+        <li><code>shale-designtime.jar</code> - Optional design time integration
+            with <a href="">Sun Java
+            Studio Creator 2</a></li>
+        <li><code>shale-remoting.jar</code> - Standalone library for components
+            and applications that wish to support asynchronous callbacks,
+            such as AJAX requests.</li>
+        <li><code>shale-spring.jar</code> - Optional integration layer
+            adapters for the <a href="">Spring
+            Framework</a></li>
+        <li><code>shale-test.jar</code> - Unit test framework</code></li>
+        <li><code>shale-tiger.jar</code> - Optional core extensions that
+            available if you are using Java SE 5 ("Tiger")</li>
+        <li><code>shale-tiles.jar</code> - Optional integration layer with
+            the <em>standalone</em> version of Tiles, currently under
+            development as part of the <a href="">
+            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>
+        <li><code>shale-blank.war</code> - Very simple "starter" application
+            includes all of the configuration files and libraries that a typical
+            Shale application will require.</li>
+        <li><code>shale-mailreader.war</code> - Canonical Struts 1.x example
+            application, converted to use JavaServer Faces and Shale facilities.</li>
+        <li><code>shale-sql-browser.war</code> - Simple implementation
of an
+            SQL browsing application that illustrates dynamic changes to the
+            JSF component tree.</li>
+        <li><code>shale-usecases.war</code> Omnibus example application
+            that illustrates the use of most Shale features.</li>
+        </ul></li>
+    <li>Source code and JavaDocs for the following modules:
+        <ul>
+        <li><a href="../blank/docs/api/index.html">Blank Example App</a></li>
+        <li><a href="../clay-plugin/docs/api/index.html">Clay Plug-In</a></li>
+        <li><a href="../core-library/docs/api/index.html">Core Library</a></li>
+        <li><a href="../mailreader/docs/api/index.html">MailReader Example App</a></li>
+        <li><a href="../test-framework/docs/api/index.html">Unit Test Framework</a></li>
+        <li><a href="../tiger/docs/api/index.html">Tiger Extensions</a></li>
+        <li><a href="../use-cases/docs/api/index.html">Use Cases Example App</a></li>
+        </ul>
+    </ul>
+    <a name="Changes"></a>
+    <h3>3.0 Changes From Previous Releases</h3>
+    <h4>3.1 New Features</h4>
+    <p><b>Creator Design Time Support</b> - Shale now includes the beginnings
+    design time support for importing Shale into
+    <a href="">Sun Java Studio Creator</a>,
+    a graphical IDE for building web applications based on JavaServer Faces.
+    This support is not yet complete, or ready for use.</p>
+    <p><b>Shale Remoting</b> - The previous functionality for supporting
+    application (in package <code>org.apache.shale.remote</code>) has been
+    substantially revised and expanded in a new package (<code>org.apache.shale.remoting</code>).
+    In addition, this support has been packaged in a separate JAR file
+    (<code>shale-remoting.jar</code>) that has zero dependencies on the
+    rest of Shale.  See the
+    <a href="">
+    package description</a> for this package in the Javadocs for more information.</code>
+    <p><b>Shale Tiger Extensions</b> - If you are running your servlet
+    on a Java SE 5 ("Tiger") or later JDK, you may use this optional library
+    to reduce the need for configuring application metadata in <code>faces-config.xml</code>
+    files, or having to implement a particular interface to receive View
+    Controller services.  See the <a href="">
+    feature description</a> on the Shale website for more information.</p>
+    <p><b>New Sample Applications</b> - New sample applications to illustrate
+    the use of Shale features:</p>
+    <ul>
+        <li><code>shale-blank.war</code> - Starter application that incudes
+            configuration files and libraries needed by most applications.</i>
+        <li><code>shale-mailreader.war</code> - Conversion of the canonical
+            Struts 1.x example "mail reader" application.</i>
+        <li><code>shale-sql-browser.war</code> - Simple "SQL browser" application
+            that illustrates dynamic component tree manipulation.</li>
+    </ul>
+    <p><b>Test Framework Base Class for HTMLUNIT Tests</b> - The test framework
+    now includes a base class for building system integration tests of web based
+    applications.  It uses HTMLUNIT (from SourceForge) to simulate the client
+    of the webapp, and then exposes the DOM of the retrieved page to examination
+    by JUnit style test methods.</p>
+    <p><b>Test Framework New Mock Objects</b> - The test framework now
offers mock
+    objects for <code>ResponseWriter</code>, <code>ResponseStream</code>,
+    <code>Principal</code> objects.</p>
+    <h4>3.2 Bugfix Issues</h4>
+    <p>[<a href="">36884<a>]
+    View file example in Use Cases is useless.</p>
+    <p>[<a href="">37364<a>]
+    Static members accessed in a non-static way.</p>
+    <p>[<a href="">37796<a>]
+    NullPointerException when Clay Jsfid parameter of Clay component
+    has null value.</p>
+    <p>[<a href="">37821<a>]
+    Clay HTML parser has problem with the &lt;a&gt; tag.</p>
+    <p>[<a href="">37867<a>]
+    Fix issues with filter mapping in the Clay Plug-In.</p>
+    <p>[<a href="">38058<a>]
+    Clay initialization parameter names should be fully qualified.</p>
+    <p>[<a href="">38157<a>]
+    Clay <code>&lt;TH&gt;</code> bug.</p>
+    <p>[<a href="">38190<a>]
+    Remoting doesn't work with RI build.</p>
+    <p>[<a href="">38314<a>]
+    Clay symbol replacement in CreateComponentCommand.</p>
+    <p>[<a href="">38492<a>]
+    Symbol for action attribute on components does not get evaluated.</p>
+    <p>[<a href="">38493<a>]
+    Rendered attribute does not affect children.</p>
+    <p>[<a href="">38542<a>]
+    Clay not handling binding attribute correctly.</p>
+    <p>[<a href="">38593<a>]
+    ValidatorScript does not find validators in facets.</p>
+    <p>[-----] Fix two Clay configuration parsing bugs.</p>
+    <h4>3.3 Request For Enhancement Issues</h4>
+    <p>[<a href="">37504<a>]
+    Realphabetize imports and remove redundant ones.</p>
+    <p>[<a href="">38042<a>]
+    Default validator configuration should include rules.</p>
+    <p>[<a href="">38044<a>]
+    Name and location of validation rule file(s) should be
+    configurable.</p>
+    <p>[<a href="">38168<a>]
+    Add spring like syntax for loading clay configs from classpath.</p>
+    <p>[<a href="">38185<a>]
+    Refactor ShaleViewHandler and ShalePhaseListener.</p>
+    <p>[<a href="">38482<a>]
+    Clay enhancement - reusable clay components.</p>
+    <p>[<a href="">38510<a>]
+    Add additional convenience accessors in AbstractFacesBean.</p>
+    <p>[-----] Allow configuration of a comma delimited list of validation
+    rules files under the init param <code>org.apache.shale.validator.VALIDATOR_RULES</code>.</p>
+    <p>[-----] Include the default <code>validator-rules.xml</code> file
so that
+    users do not have to include a copy in <code>/WEB-INF</code>.</p>
+    <p>[-----] Add support for specifying validator parameters using nested
+    <code>s:validatorVar</code> tags.</code>
+    <p>[-----] Improve functionality of <code>LoadBundle</code> and
+    <code>Messages</code> such that the "map" property is not required in
+    value binding expressions.</p>
+    <p>[-----] Add JSF-friendly helper methods to access bean properties;
+    first step towards removing core dependency on Commons Beanutils.</p>
+    <p>[-----] Add JSF-friendly helper methods to perform type conversions;
+    second step towards removing core dependency on Commons Beanutils.</p>
+    <p>[-----] Flesh out operation of many test framework methods that formerly
+    threw <code>UnsupportedOperationException</code>.</p>
+    <a name="Known"></a>
+    <h3>4.0 Known Issues In This Release</h3>
+    <p><b>FIXME</b> - This list has not yet been updated from 1.0.0 the
+    <p>[<a href="">35066<a>]
+    The <em>Dialog</em> feature has known problems with attempting to have
+    multiple simultaneously active dialogs in a single session (most commonly
+    due to using frames or multiple windoes), and dealing with back buttons.
+    These issues will be addressed in a subsequent release.</p>
+    <p>[<a href="">35839</a>]
+    Additional improvements to the HTML parser will be addressed in a
+    subsequent release.</p>
+    <p>[<a href="">37024</a>]
+    The Shale contribution to addressing this issue is to ensure that
+    <code>META-INF/clay-config.xml</code> resources from JAR files loaded as
+    part of the application are automatically loaded.  This will be addressed
+    in a subsequent release.  The actual configuration resources for a given
+    component library such as Tomahawk, however, should be provided by the
+    component library itself rather than by Shale.</p>
+    <p>[<a href="">37120</a>]
+    IFrames are a specific use case related to multiple simultaneous dialogs,
+    so this issue will be addressed at the same time as 35066.</p>
+    <p>[<a href="">37361</a>]
+    There is a bug in the MyFaces implementation of validation that causes the
+    Use Cases example app to fail, where it works with the RI.  The corresponding
+    MyFaces issue is <a href="">
+    here</a>.  Leaving this bug open (with state <code>REMIND</code>) as
+    reminder to flag this issue in Shale release notes until it is resolved
+    in a subsequent MyFaces release.</p>
+    <p>[<a href="">37615</a>]
+    RFE for using XML namespaces in Clay attributes, to be considered in a
+    subsequent release.</p>
+    <p>[<a href="">37643</a>]
+    RFE to add documentation (on the web site) for the Tiles and Remoting
+    features, to be addressed in a subsequent release.</p>
+    <p>[<a href="">37707</a>]
+    Several classes that need to be serializable (because they could be stored
+    in session scope) are not currently.  In addition, two classes inherit an
+    <code>implements Serializable</code> declaration from their superclass, but
+    are not themselves able to be serialized.  This does not cause a problem
+    using the classes in Shale, because such instances are never stored into
+    session scope, but will be flagged by code audits that check for this
+    scenario.</p>
+  </body>

Propchange: struts/shale/trunk/docs/release-notes-1.0.1.html
    svn:eol-style = native

Propchange: struts/shale/trunk/docs/release-notes-1.0.1.html
    svn:keywords = Date Author Id Revision HeadURL

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message