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/docbook/modules/getting_started.xml
===================================================================
---
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 Photo 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</emphasis>.
You can just deploy Photo Album application onto the server, but
the convenient way is to import the project into your IDE.
We recommend Eclipse with JBoss Tools since this bundle 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 deployed and run on
JBoss Application server,
- so please make sure that the <jboss.installer.url>
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 and run on JBoss
Application server,
+ so please make sure that the <jboss.installer.url>
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 place 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 element works, providing technical
details about it.
+ The Photo Album application was developed in the first place 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 element works, providing technical
details about it.
A context help article is displayed when you click on the question mark
icon (
<inlinemediaobject>
<imageobject>
Modified:
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/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 not be stored in
albums.
</para>
<para>
- The Photo Album web application is designed and developed with RichFaces. This
application demonstrates:
+ The Photo Album web application is designed and developed with RichFaces and by
RichFaces team. This application demonstrates:
</para>
<itemizedlist>
<listitem>
Modified:
branches/community/3.3.X/docs/photo_album_app_guide/en/src/main/docbook/modules/overview.xml
===================================================================
---
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="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 the 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 the application
if he/she wants to have access to all features of the application. Have a look at a piece
of code from <code>\includes\index\index.xhtml</code>:
+ </para>
<programlisting role="XML"><![CDATA[...
<h:panelGroup
rendered="#{!identity.loggedIn}" styleClass="top-right-bottom-menu-item-link"
layout="block">
<h:form style="margin: 0px">
@@ -41,27 +40,36 @@
</h:form>
</h:panelGroup>
...]]></programlisting>
- <para>When the button is hit the <code>goToRegister</code>
method is evoked 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>When the button is hit the <code>goToRegister</code>
method 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="bold"><property><a4j:commandLink></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: every content page
is included into the content area of <code>index.xhtml</code> file after a
certain action performed by user.
</para>
<programlisting role="XML"><![CDATA[...
<h:panelGroup styleClass="content_box" layout="block">
<ui:include src="#{model.mainArea.template}" />
</h:panelGroup>
...]]></programlisting>
+ <figure>
+ <title>Content Area</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/contentArea.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<para>
- The <code>NavigationEnum</code> class encapsulated all
possible states, that can be applied to content area ("mainArea") on
the page.
+ The <code>NavigationEnum</code> enumeration encapsulated all
possible states, that can be applied to content area ("mainArea") on
the page.
</para>
@@ -89,12 +97,14 @@
...
}
]]></programlisting>
+
<para>
This class specifies which file is included depending on some user action.
- The template to be loaded is identified according to some condition in a
Controller (<code>Controllor.java</code>) method and is saved to the Model
(<code>Model.java</code>). During <code>index.xhtml</code> page
rendering the value is taken from the Model to define what should be rendered to the
page.
- </para>
- </section>
+ The template to be loaded is identified according to some condition in the
Controller
+ (<code>Controllor.java</code>) class and is saved to the Model
(<code>Model.java</code>). During <code>index.xhtml</code> page
rendering the value is taken from the Model to define what should be rendered to the
page.
+ </para>
+ </section>
</section>
<section id="dataModel">