Author: craigmcc Date: Thu Dec 28 21:39:55 2006 New Revision: 490922 URL: http://svn.apache.org/viewvc?view=rev&rev=490922 Log: First pass at updating the API stability page for SHALE-379. Major changes: * Divide into two tables, one for app developers and one for framework extenders, with a column for which module jar contains the corresponding classes. * FIXME - need to review whether shale-clay classes are intended for direct application use. * FIXME - need to review the proposed stability rankings and add any relevant additional comments.
Modified: shale/framework/trunk/src/site/xdoc/api-stability.xml Modified: shale/framework/trunk/src/site/xdoc/api-stability.xml URL: http://svn.apache.org/viewvc/shale/framework/trunk/src/site/xdoc/api-stability.xml?view=diff&rev=490922&r1=490921&r2=490922 ============================================================================== --- shale/framework/trunk/src/site/xdoc/api-stability.xml (original) +++ shale/framework/trunk/src/site/xdoc/api-stability.xml Thu Dec 28 21:39:55 2006 @@ -81,343 +81,303 @@ </subsection> - <a name="stability-core"/> - <subsection name="Packages Delivered in shale-core.jar"> + <a name="stability-application"/> + <subsection name="Packages Intended For Application Developer Use"> - <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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/org/apache/shale/remote/package-summary.html"> - org.apache.shale.remote</a></td> - <td>Application</td> - <td>Deprecated</td> - <td>Use corresponding functionality from package - <a href="shale-remoting/apidocs/org/apache/shale/remoting/package-summary.html"> - org.apache.shale.remoting</a>.</td> - </tr> - <tr> - <td><a href="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/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="shale-core/apidocs/org/apache/shale/view/faces/package-summary.html"> - org.apache.shale.view.faces</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-core/apidocs/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> + <table> + <thead> + <tr> + <th width="15%">Library JAR</th> + <th width="25%">Package Name</th> + <th width="10%">Stability</th> + <th width="40%">Additional Comments</th> + </tr> + </thead> + <tbody> + <tr> + <td><a href="shale-application/index.html">shale-application</a></td> + <td><a href="shale-application/apidocs/org/apache/shale/application/package-summary.html">org.apache.shale.application</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-core/index.html">shale-core</a></td> + <td><a href="shale-core/apidocs/org/apache/shale/component/package-summary.html">org.apache.shale.component</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-core/index.html">shale-core</a></td> + <td><a href="shale-core/apidocs/org/apache/shale/util/package-summary.html">org.apache.shale.util</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/package-summary.html">org.apache.shale.dialog</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/base/package-summary.html">org.apache.shale.dialog.base</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/base/package-summary.html">org.apache.shale.test.base</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/htmlunit/package-summary.html">org.apache.shale.test.htmlunit</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/jmock/package-summary.html">org.apache.shale.test.jmock</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/mock/package-summary.html">org.apache.shale.test.mock</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/package-summary.html">org.apache.shale.tiger.managed</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/register/package-summary.html">org.apache.shale.tiger.register</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/package-summary.html">org.apache.shale.tiger.view</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/package-summary.html">org.apache.shale.validator</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/converter/package-summary.html">org.apache.shale.validator.converter</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/util/package-summary.html">org.apache.shale.validator.util</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/validator/package-summary.html">org.apache.shale.validator.validator</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-view/index.html">shale-view</a></td> + <td><a href="shale-view/apidocs/org/apache/shale/view/package-summary.html">org.apache.shale.validator</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + </tbody> + </table> </subsection> - <a name="stability-remoting"/> - <subsection name="Packages Delivered in shale-remoting.jar"> + <a name="stability-framework"/> + <subsection name="Packages Intended For Framework Extender Use"> - <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="shale-remoting/apidocs/org/apache/shale/remoting/package-summary.html"> - org.apache.shale.remoting</a></td> - <td>Application</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-remoting/apidocs/org/apache/shale/remoting/faces/package-summary.html"> - org.apache.shale.remoting.faces</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-remoting/apidocs/org/apache/shale/remoting/impl/package-summary.html"> - org.apache.shale.remoting.impl</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - </tbody> - </table> - - </subsection> - - <a name="stability-spring"/> - <subsection name="Packages Delivered in shale-spring.jar"> - - <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="shale-spring/apidocs/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> - - </subsection> - - <a name="stability-test"/> - <subsection name="Packages Delivered in shale-test.jar"> - - <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="shale-test/apidocs/org/apache/shale/test/base/package-summary.html"> - org.apache.shale.test.base</a></td> - <td>Application</td> - <td>Evolving</td> - <td>Use these classes as base classes for your own - JUnit test cases</td> - </tr> - <tr> - <td><a href="shale-test/apidocs/org/apache/shale/test/htmlunit/package-summary.html"> - org.apache.shale.test.htmlunit</a></td> - <td>Application</td> - <td>Evolving</td> - <td>Use these classes as base classes for your own - system integration tests using JUnit and HtmlUnit</td> - </tr> - <tr> - <td><a href="shale-test/apidocs/org/apache/shale/test/mock/package-summary.html"> - org.apache.shale.test.mock</a></td> - <td>Application</td> - <td>Evolving</td> - <td>Use these classes in your JUnit test cases - to simulate container behavior</td> - </tr> - </tbody> - </table> - - </subsection> - - <a name="stability-tiger"/> - <subsection name="Packages Delivered in shale-tiger.jar"> - - <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="shale-tiger/apidocs/org/apache/shale/tiger/config/package-summary.html"> - org.apache.shale.tiger.config</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/faces/package-summary.html"> - org.apache.shale.tiger.faces</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/package-summary.html"> - org.apache.shale.tiger.managed</a></td> - <td>Application</td> - <td>Developing</td> - <td>Annotations for the <em>Annotated Managed Beans</em> feature</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/config/package-summary.html"> - org.apache.shale.tiger.managed.config</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/rules/package-summary.html"> - org.apache.shale.tiger.managed.rules</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/register/package-summary.html"> - org.apache.shale.tiger.register</a></td> - <td>Application</td> - <td>Developing</td> - <td>Annotations for the <em>Annotated Component Registration</em> feature</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/resources/package-summary.html"> - org.apache.shale.tiger.resources</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/package-summary.html"> - org.apache.shale.tiger.view</a></td> - <td>Application</td> - <td>Developing</td> - <td>Annotations for the <em>Annotated View Controller</em> feature</td> - </tr> - <tr> - <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/faces/package-summary.html"> - org.apache.shale.tiger.view.faces</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - </tbody> - </table> - - </subsection> - - <a name="stability-tiles"/> - <subsection name="Packages Delivered in shale-tiles.jar"> - - <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="shale-tiles/apidocs/org/apache/shale/tiles/package-summary.html"> - org.apache.shale.tiles</a></td> - <td>Framework</td> - <td>Developing</td> - <td>---</td> - </tr> - </tbody> - </table> + <table> + <thead> + <tr> + <th width="15%">Library JAR</th> + <th width="25%">Package Name</th> + <th width="10%">Stability</th> + <th width="40%">Additional Comments</th> + </tr> + </thead> + <tbody> + <tr> + <td><a href="shale-application/index.html">shale-application</a></td> + <td><a href="shale-application/apidocs/org/apache/shale/application/faces/package-summary.html">org.apache.shale.application.faces</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-clay/index.html">shale-clay</a></td> + <td><a href="shale-clay/apidocs/org/apache/shale/clay/package-summary.html">org.apache.shale.clay.*</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-core/index.html">shale-core</a></td> + <td><a href="shale-core/apidocs/org/apache/shale/faces/package-summary.html">org.apache.shale.faces</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-core/index.html">shale-core</a></td> + <td><a href="shale-core/apidocs/org/apache/shale/renderer/package-summary.html">org.apache.shale.renderer</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-core/index.html">shale-core</a></td> + <td><a href="shale-core/apidocs/org/apache/shale/taglib/package-summary.html">org.apache.shale.taglib</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/faces/package-summary.html">org.apache.shale.dialog.faces</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-basic</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/basic/package-summary.html">org.apache.shale.dialog.basic</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-basic</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/basic/config/package-summary.html">org.apache.shale.dialog.basic.config</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-basic</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/basic/model/package-summary.html">org.apache.shale.dialog.basic.model</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-scxml</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/scxml/package-summary.html">org.apache.shale.dialog.scxml</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-scxml</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/scxml/action/package-summary.html">org.apache.shale.dialog.scxml.action</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-scxml</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/scxml/config/package-summary.html">org.apache.shale.dialog.scxml.config</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-dialog/index.html">shale-dialog-scxml</a></td> + <td><a href="shale-dialog/apidocs/org/apache/shale/dialog/scxml/impl/package-summary.html">org.apache.shale.dialog.scxml.implk</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-spring/index.html">shale-spring</a></td> + <td><a href="shale-spring/apidocs/org/apache/shale/spring/package-summary.html">org.apache.shale.spring</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/cargo/package-summary.html">org.apache.shale.test.cargo</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-test/index.html">shale-test</a></td> + <td><a href="shale-test/apidocs/org/apache/shale/test/el/package-summary.html">org.apache.shale.test.el</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/config/package-summary.html">org.apache.shale.tiger.config</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/faces/package-summary.html">org.apache.shale.tiger.faces</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/config/package-summary.html">org.apache.shale.tiger.managed.config</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/managed/rules/package-summary.html">org.apache.shale.tiger.managed.rules</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/register/faces/package-summary.html">org.apache.shale.tiger.register.faces</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiger/index.html">shale-tiger</a></td> + <td><a href="shale-tiger/apidocs/org/apache/shale/tiger/view/faces/package-summary.html">org.apache.shale.tiger.view.faces</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-tiles/index.html">shale-tiger</a></td> + <td><a href="shale-tiles/apidocs/org/apache/shale/tiles/package-summary.html">org.apache.shale.tiles</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/faces/package-summary.html">org.apache.shale.validator.faces</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-validator/index.html">shale-validator</a></td> + <td><a href="shale-validator/apidocs/org/apache/shale/validator/tag/package-summary.html">org.apache.shale.validator.tag</a></td> + <td>Developing</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-view/index.html">shale-view</a></td> + <td><a href="shale-view/apidocs/org/apache/shale/view/faces/package-summary.html">org.apache.shale.view.faces</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + <tr> + <td><a href="shale-view/index.html">shale-view</a></td> + <td><a href="shale-view/apidocs/org/apache/shale/view/impl/package-summary.html">org.apache.shale.view.impl</a></td> + <td>Evolving</td> + <td>---</td> + </tr> + </tbody> + </table> </subsection>