From richfaces-svn-commits at lists.jboss.org Fri Jul 10 14:32:21 2009
Content-Type: multipart/mixed; boundary="===============3095800237385242851=="
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: r14899 -
 branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/modules.
Date: Fri, 10 Jul 2009 14:15:12 -0400
Message-ID: <200907101815.n6AIFCBO022483@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: msorokin
Date: 2009-07-10 14:15:12 -0400 (Fri, 10 Jul 2009)
New Revision: 14899

Modified:
   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
page flow section is updated


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-07-10 18:14:34 UTC (rev 14898)
+++ branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook=
/modules/overview.xml	2009-07-10 18:15:12 UTC (rev 14899)
@@ -11,8 +11,17 @@
       <section id=3D"pageFlows">
       	<title>Page flows</title>
         <para>
-             Work in progress...
+            =

+            The page flow of the application is illustrated on the diagram.
         </para>
+        <figure>
+          <title>Page Flow diagram</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref=3D"images/diagram.png"/>
+            </imageobject>
+          </mediaobject>
+        </figure>
         <section>
           <title>Page flows: implementation details</title>
          =

@@ -40,7 +49,52 @@
             <para>When all fields are filled out with correct values the <=
code>register(user)</code> is triggered and a new user is set. </para>
           </section>
           =

-        </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.
+            </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> =

+            <para>
+              =

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

+            </para>
+            =

+            <programlisting role=3D"XML"><![CDATA[...
+ public enum NavigationEnum {
+	ANONYM("includes/publicShelves.xhtml"),
+	FILE_UPLOAD("includes/fileUpload.xhtml"),
+	USER_PREFS("includes/userPrefs.xhtml"),
+	REGISTER("includes/register.xhtml"),
+	SEARCH("includes/search.xhtml"),
+	ALBUM_PREVIEW("includes/album.xhtml"),
+	ALBUM_IMAGE_PREVIEW("/includes/image.xhtml"),
+	SHELF_PREVIEW("/includes/shelf.xhtml"),
+	ALL_SHELFS("/includes/userShelves.xhtml"),
+	TAGS("includes/tag.xhtml"),
+	ALL_ALBUMS("/includes/userAlbums.xhtml"),
+	ALL_IMAGES("/includes/userImages.xhtml"),
+	ALBUM_IMAGE_EDIT("/includes/imageEdit.xhtml"),
+	ALBUM_EDIT("/includes/albumEdit.xhtml"),
+	SHELF_EDIT("/includes/shelfEdit.xhtml"),
+	SHELF_UNVISITED("/includes/shelfUnvisited.xhtml"),
+	USER_SHARED_ALBUMS("/includes/userSharedAlbums.xhtml"),
+	USER_SHARED_IMAGES("/includes/userSharedImages.xhtml"),
+	ALBUM_UNVISITED("/includes/albumUnvisited.xhtml");
+...
+}
+]]></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>
         =

       </section>
       <section id=3D"dataModel">
@@ -58,11 +112,12 @@
           </mediaobject>
         </figure>
       </section>
-      <section id=3D"setUp">
+        </section>
+      <!--section id=3D"setUp">
       	<title>Project Set Up</title>
         <para>
              Work in progress...
         </para>
-      </section>
+      </section-->
 </chapter>
 =



--===============3095800237385242851==--