From richfaces-svn-commits at lists.jboss.org Fri Aug  7 13:49:24 2009
Content-Type: multipart/mixed; boundary="===============4441197347207891382=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r15138 -
 branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/modules.
Date: Fri, 07 Aug 2009 13:49:24 -0400
Message-ID: <200908071749.n77HnObl019125@svn01.web.mwc.hst.phx2.redhat.com>

--===============4441197347207891382==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: msorokin
Date: 2009-08-07 13:49:24 -0400 (Fri, 07 Aug 2009)
New Revision: 15138

Modified:
   branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/=
modules/getting_started.xml
   branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/=
modules/intro.xml
   branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/=
modules/overview.xml
Log:
https://jira.jboss.org/jira/browse/RF-5768

Modified: branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/d=
ocbook/modules/getting_started.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/getting_started.xml	2009-08-07 17:47:45 UTC (rev 15137)
+++ branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/getting_started.xml	2009-08-07 17:49:24 UTC (rev 15138)
@@ -12,7 +12,7 @@
             <title>Environment Configuration</title>
             <para>
                   In order to download, build, modify, and deploy the Phot=
o Album application =

-                  you need the following installed and configured: =

+                  you need to have the following installed and configured: =

             </para>
             <itemizedlist>
                   <listitem>
@@ -67,7 +67,7 @@
                   </listitem>
                   <listitem>
                   	<para>
-                  		<emphasis>Import the project into your IDE</emphasis>. =

+                  		<emphasis>Import the project into Eclipse IDE</emphasi=
s>. =

                   		You can just deploy Photo Album application onto the s=
erver, but
                   		the convenient way is to import the project into your =
IDE. =

                         We recommend Eclipse with JBoss Tools since this b=
undle is more preferable to =

@@ -128,11 +128,11 @@
                   </tip>
       </section>
       <section>
-            <title>Running Functional(Selenium) Tests</title>
+            <title>Running Functional(Selenium) Tests TBR</title>
             <para>
-                  Before starting Selenium test please make sure that you =
have Firefox browser installed on your local machine and =

-                 since the Photo Album application is designed to be deplo=
yed and run on JBoss Application server,
-                 so please make sure that the &lt;jboss.installer.url&gt; =
property of the project pom.xml (<code>examples/photoalbum/</code>) points =
to a existing JBoss Application server copy.
+                  Before starting Selenium test please make sure that you =
have Firefox browser installed on your local machine, as
+                  the Photo Album application is designed to be deployed a=
nd run on JBoss Application server,
+                 so please make sure that the &lt;jboss.installer.url&gt; =
property of the project pom.xml (<code>examples/photoalbum/</code>) points =
to an existing JBoss Application server copy.
             </para>
             =

             <para>
@@ -156,7 +156,7 @@
       <section>
             <title>Context Help</title>
             <para>
-               The Photo Album appellation was developed in the first plac=
e to demonstrate the mighty power of RichFaces thus most of UI elements in =
the application has a context help article that tells how a particular elem=
ent works, providing technical details about it.
+               The Photo Album application was developed in the first plac=
e to demonstrate the mighty power of RichFaces thus most of UI elements in =
the application has a context help article that tells how a particular elem=
ent works, providing technical details about it.
                A context help article is displayed when you click on the q=
uestion mark icon ( =

                   <inlinemediaobject>  =

                              <imageobject>

Modified: branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/d=
ocbook/modules/intro.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/intro.xml	2009-08-07 17:47:45 UTC (rev 15137)
+++ branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/intro.xml	2009-08-07 17:49:24 UTC (rev 15138)
@@ -18,7 +18,7 @@
             or shelves and shelves can not keep another shelves and can no=
t be stored in albums.
     </para>
     <para>
-    	The Photo Album web application is designed and developed with RichFa=
ces. This application demonstrates:
+    	The Photo Album web application is designed and developed with RichFa=
ces and by RichFaces team. This application demonstrates:
     </para>
     <itemizedlist>
             <listitem>

Modified: branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/d=
ocbook/modules/overview.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/overview.xml	2009-08-07 17:47:45 UTC (rev 15137)
+++ branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/overview.xml	2009-08-07 17:49:24 UTC (rev 15138)
@@ -7,12 +7,12 @@
                   =

             </keywordset>
       </chapterinfo>
-      <title>Application Overview</title>
+      <title>Application Overview TBR</title>
       <section id=3D"pageFlows">
       	<title>Page flows</title>
         <para>
             =

-            The page flow of the application is illustrated on the diagram.
+            The page flow of the application is illustrated in the diagram.
         </para>
         <figure>
           <title>Page Flow diagram</title>
@@ -31,9 +31,8 @@
           <section>
             <title>Registering</title>
             <para>
-              Registering in is basically the first step a user takes in t=
he application. Have a look at a piece of code from <code>\includes\index\<=
/code>
-            </para>
-            =

+              Registering in is basically the first step a user takes in t=
he application if he/she wants to have access to all features of the applic=
ation. Have a look at a piece of code from <code>\includes\index\index.xhtm=
l</code>:
+            </para>         =

             <programlisting role=3D"XML"><![CDATA[...
 <h:panelGroup rendered=3D"#{!identity.loggedIn}"	styleClass=3D"top-right-b=
ottom-menu-item-link" layout=3D"block">
   <h:form style=3D"margin: 0px">
@@ -41,27 +40,36 @@
   </h:form>
 </h:panelGroup>
 ...]]></programlisting> =

-            <para>When the button is hit the <code>goToRegister</code> met=
hod is evoked and the <code>START_REGISTER_EVENT</code> is raised. These ac=
tion display the registration form that is included from <code>\includes\re=
gister.xhtml</code>. </para>
+            <para>When the button is hit the <code>goToRegister</code> met=
hod of the <code>Authenticator</code> class is invoked and the <code>START_=
REGISTER_EVENT</code> is raised. These action display the registration form=
 that is included from <code>\includes\register.xhtml</code>. </para>
             =

-            =

+                        =

             <para>The <emphasis role=3D"bold"><property>&lt;a4j:commandLin=
k&gt;</property></emphasis> displays the link to the registration form and =
invokes the  <code>goToRegister</code> method.
             </para>
-            <para>When all fields are filled out with correct values the <=
code>register(user)</code> is triggered and a new user is set. </para>
+            <para>When all fields are filled out with correct values the <=
code>authenticator.register(user)</code> is triggered and a new user object=
 is declared. </para>
           </section>
           =

           <section>
             <title>Navigation Between Pages</title>
             <para>
-  Technically, user do not browse between pages of the application: every =
content page is included into the content area of <code>index.xhtml</code> =
file.
+  Technically, user does not browse between pages of the application: ever=
y content page is included into the content area of <code>index.xhtml</code=
> file after a certain action performed by user.
             </para>
             <programlisting role=3D"XML"><![CDATA[...
 <h:panelGroup styleClass=3D"content_box" layout=3D"block">
   <ui:include src=3D"#{model.mainArea.template}" />
 </h:panelGroup>
 ...]]></programlisting> =

+           <figure>
+             <title>Content Area</title>
+             <mediaobject>
+               <imageobject>
+                 <imagedata fileref=3D"images/contentArea.png"/>
+               </imageobject>
+             </mediaobject>
+           </figure> =

+            =

             <para>
               =

-              The <code>NavigationEnum</code> class  encapsulated all poss=
ible states, that can be applied to content area (&quot;mainArea&quot;)  on=
 the page.
+              The <code>NavigationEnum</code> enumeration  encapsulated al=
l possible states, that can be applied to content area (&quot;mainArea&quot=
;)  on the page.
               =

             </para>
             =

@@ -89,12 +97,14 @@
 ...
 }
 ]]></programlisting> =

+            =

             <para>
               =

               This class specifies which file is included depending on som=
e user action.     =

-              The template to be loaded is identified according to some co=
ndition in a Controller (<code>Controllor.java</code>) method and is saved =
to the Model (<code>Model.java</code>). During <code>index.xhtml</code> pag=
e rendering the value is taken from the Model to define what should be rend=
ered to the page.
-               </para>
-          </section>
+              The template to be loaded is identified according to some co=
ndition  in the Controller
+              (<code>Controllor.java</code>) class and is saved to the Mod=
el (<code>Model.java</code>). During <code>index.xhtml</code> page renderin=
g the value is taken from the Model to define what should be rendered to th=
e page.
+            </para>
+            </section>
         =

       </section>
       <section id=3D"dataModel">


--===============4441197347207891382==--