myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r573207 - in /myfaces/orchestra/trunk/src/site: site.xml xdoc/index.xml
Date Thu, 06 Sep 2007 09:54:38 GMT
Author: skitching
Date: Thu Sep  6 02:54:38 2007
New Revision: 573207

improve docs


Modified: myfaces/orchestra/trunk/src/site/site.xml
--- myfaces/orchestra/trunk/src/site/site.xml (original)
+++ myfaces/orchestra/trunk/src/site/site.xml Thu Sep  6 02:54:38 2007
@@ -61,6 +61,7 @@
 		<menu name="MyFaces Orchestra - Modules">
 			<item name="Core" href="myfaces-orchestra-core/index.html"/>
 			<item name="Core15" href="myfaces-orchestra-core15/index.html"/>
+			<item name="Sandbox" href="myfaces-orchestra-sandbox/index.html"/>
 			<item name="Examples" href="myfaces-orchestra-examples-project/index.html"/>

Modified: myfaces/orchestra/trunk/src/site/xdoc/index.xml
--- myfaces/orchestra/trunk/src/site/xdoc/index.xml (original)
+++ myfaces/orchestra/trunk/src/site/xdoc/index.xml Thu Sep  6 02:54:38 2007
@@ -16,7 +16,6 @@
 		<section name="Apache MyFaces Orchestra">
 			<subsection name="Introduction">
 				<p>Orchestra is a small library that can be used in web applications to provide
the following features:
 				<li><p>A conversation (aka dialog) scope for beans.</p></li>
@@ -28,36 +27,50 @@
 				<p>Together these features ease development of applications that perform a lot
of persistence
 				(ie are strongly coupled with a database).</p>
-				<p>Orchestra is divided into two modules:
-				<ul>
-				<li><p>"core" is JDK14-compatible and provides the majority of the functionality.</p></li>
-				<li><p>"core15" requires JDK15 and provides a number of extensions, including
convenient annotations
-				for working with Orchestra features.</p></li>
-				</ul>
-				</p>
-				<p>See the separate modules for further documentation of Orchestra.</p>
 				<p>Orchestra currently supports JSF1.1 and JSF1.2, but support should be possible
for other
-				web presentation frameworks in future. Orchestra does require Spring.</p>
+				web presentation frameworks in future.</p>
 				<p>Apache MyFaces Orchestra is a relatively new member of the Apache MyFaces project
family, but
 				has already been used in several real world projects. Check-out our demo-application
if you
 				want to see more on how it works in practice.</p>
 			<subsection name="Dependencies">
-				<p>Orchestra requires that Spring2.x be used to declare beans that will be stored
+				<p>Orchestra requires that Spring 2.x be used to declare managed beans that will
be stored in
 				conversation context.</p>
-				<p>There are no other significant dependencies, or structural requirements on code
+				<p>There are no other significant dependencies or structural requirements for code
 				uses Orchestra (in particular, no requirement to use EJBs).</p>
+			<subsection name="Structure">
+				<p>The Apache MyFaces Orchestra project contains several modules:
+				<ul>
+				<li><p><a href="myfaces-orchestra.core/index.html">core</a>:
The core module is compatible with
+					Java 1.4 - which means that you are able to use all this convenient stuff without the
+					need to migrate to Java 5.0</p></li>
+				<li><p><a href="myfaces-orchestra-core15/index.html">core15</a>:
Ok, we admit, we couldn't resist,
+					so this package contains Java 5.0 enhancements to the core so that you get cool new
+					annotation based stuff as well.</p></li>
+				<li><p><a href="myfaces-orchestra-sandbox/index.html">sandbox</a>:
An area for components that are
+					not yet API-stable, or which depend on unreleased components of other projects.</p></li>
+				<li><p><a href="myfaces-orchestra-examples/index.html">examples</a>:
Demo apps (currently only one)
+					showing off many of Orchestra's features.</p></li>
+				</ul>
+				</p>
+				<p>Follow the links to these modules for further documentation.</p>
+			</subsection>
 			<subsection name="Highlights">
 					<li><p>It works with a Java 1.4-compliant syntax, but you can optionally
use annotations</p></li>
 					<li><p>It utilizes the powerful Spring bean configuration mechanism instead
of JSF's
-						managed-bean facility.
-						Departing from Spring 2.0, it is possible to configure session and request-scoped
-						managed-beans in Spring - and you can easily use them from your JSF application.
-						We recommend doing so if you use Spring in your applications - you gain from having
-						one common syntax for defining the beans of your application, from the AOP-support
-						provides, and from other advanced features Spring has included.</p>
+						managed-bean facility. The release of Spring 2.0 made it possible to define custom
+						bean scopes in Spring. If a JSF Managed bean is declared in Spring using the
+						Orchestra "conversation" scope, then when that bean is referenced from a JSF EL
+						expression it is automatically created within that conversation scope. It is not
+						necessary for non-conversation-scoped managed beans to be declared via Spring,
+						although we do recommend it: request and session scopes are also supported and you
+						benefit from having one common syntax for defining the beans of your application,
+						from the AOP features Spring provides, and from Spring's other advanced features.</p>
 					<li><p>A plus for integrating Orchestra into existing applications:
 						If you configure your application to use Orchestra, whenever the
@@ -73,6 +86,7 @@
 					<li><p>Orchestra sports a very easy to use API - maximum 3 method calls,
and you're ready to go.</p></li>
 			<subsection name="A small JSF example">
 				<p>For the impatient, here's a quick demonstration of Orchestra's main features.</p>
@@ -136,16 +150,6 @@
-                       <subsection name="Whats next?">
-                                Move on to one of the Apache MyFaces Orchestra module
-                                <ul>
-                                        <li><a href="myfaces-orchestra-core/index.html">core</a></li>
-                                        <li><a href="myfaces-orchestra-core15/index.html">core15</a></li>
-                                </ul>
-                                for further documentation.
-                        </subsection>

View raw message