[seam-commits] Seam SVN: r11673 - tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US.

[seam-commits at lists.jboss.org]

Author: laubai
Date: 2009-11-24 03:09:15 -0500 (Tue, 24 Nov 2009)
New Revision: 11673

Modified:
   tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Tutorial.xml
Log:
Edited part of Tutorial chapter.

Modified: tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Tutorial.xml
===================================================================
--- tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Tutorial.xml	2009-11-24 08:00:17 UTC (rev 11672)
+++ tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Tutorial.xml	2009-11-24 08:09:15 UTC (rev 11673)
@@ -6,29 +6,27 @@
     <section id="try-examples">
         <title>Try the examples</title>
 
-        <para> In this tutorial, we'll assume that you are using JBoss EAP 4.3.</para>
+        <para> Seam provides a number of example applications which demonstrate how to use a variety of Seam's features. This tutorial will guide you through a few of those examples to help you get started learning Seam. The Seam examples are located in the <filename>examples</filename> subdirectory of the Seam distribution. The first example, on registration, is in the <filename>examples/registration</filename> directory, and so on.</para>
+        
+        <para>
+          Each example has the same directory structure:
+        </para>
 
-        <para> The directory structure of each example in Seam follows this pattern: </para>
-
         <itemizedlist>
             <listitem>
-                <para> Web pages, images and stylesheets may be found in
-                        <filename>examples/<replaceable>registration</replaceable>/view</filename>
+                <para> The <filename>view</filename> directory contains view-related files such as web page templates, images and stylesheets. 
                 </para>
             </listitem>
             <listitem>
-                <para> Resources such as deployment descriptors and data import scripts may be found in
-                            <filename>examples/<replaceable>registration</replaceable>/resources</filename>
+                <para> The <filename>resources</filename> directory contains deployment descriptors and other configuration files. 
                 </para>
             </listitem>
             <listitem>
-                <para> Java source code may be found in
-                    <filename>examples/<replaceable>registration</replaceable>/src</filename>
+                <para> The <filename>src</filename> directory contains the application source code. 
                 </para>
             </listitem>
             <listitem>
-                <para> The Ant build script is
-                    <filename>examples/<replaceable>registration</replaceable>/build.xml</filename>
+                <para> <filename>build.xml</filename> is the Ant script that builds and runs the example.
                 </para>
             </listitem>
         </itemizedlist>
@@ -37,10 +35,10 @@
             <title>Running the examples on JBoss AS</title>
 
             <para> First, make sure you have Ant correctly installed, with <literal>$ANT_HOME</literal> and
-                    <literal>$JAVA_HOME</literal> set correctly. Next, make sure you set the location of your EAP embedded JBoss AS
+                    <literal>$JAVA_HOME</literal> set correctly. Next, make sure you set the location of your Enterprise Application Platform embedded JBoss AS
                 installation in the <literal>build.properties</literal> file in the root folder of your Seam
                 installation, predefined location is /var/lib/jbossas. If you haven't already done so, 
-                start JBoss EAP AS now by typing <literal>bin/run.sh</literal>
+                start JBoss Enterprise Application Platform AS now by typing <literal>bin/run.sh</literal>
                 or <literal>bin/run.bat</literal> in the root directory of your JBoss installation. </para>
 
             <para> Now, build and deploy the example by typing <literal>ant deploy</literal> in the
@@ -99,6 +97,7 @@
                         <emphasis>validation</emphasis> declaratively, via annotations. It also needs some extra
                     annotations that define the class as a Seam component. </para>
                   <!-- Can't use code hightlighting with callouts -->
+                  <example>
                   <formalpara><title>User.java Example</title>
                  <para>                                  
 <programlisting role="JAVA"><![CDATA[@Entity
@@ -199,7 +198,7 @@
                     </orderedlist>
                 </para>
 </formalpara>
-
+</example>
                     <para> The most important things to notice in this example are the <literal>@Name</literal> and
                             <literal>@Scope</literal> annotations. These annotations establish that this class is a Seam component. </para>
                     <para> We'll see below that the properties of our <literal>User</literal> class are bound