Author: smukhina Date: 2009-04-22 11:17:25 -0400 (Wed, 22 Apr 2009) New Revision: 13769 Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/hiw.xml Log: https://jira.jboss.org/jira/browse/RF-398 English is checked and corrected in 2 chapters for Photo Album Tutorial Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml 2009-04-22 14:59:53 UTC (rev 13768) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml 2009-04-22 15:17:25 UTC (rev 13769) @@ -8,7 +8,7 @@ </keywordset> </chapterinfo> - <title>Application overview</title> + <title>Application Overview</title> <section><title>Used technologies</title> <para> @@ -44,7 +44,7 @@ </para> <figure> - <title>Thе Photo Album Demo Entity Relation Diagram</title> + <title>The Photo Album Demo Entity Relation Diagram</title> <mediaobject> <imageobject> <imagedata fileref="images/erd.png"/> @@ -185,7 +185,7 @@ </programlisting> <para>The snippet above shows that the <code>index.xhtml</code> page does not contain sources for application functional parts but includes them as templates that are rendered depending on conditions and events taking place during user interaction with the Photo Album Demo. - The illustration below shows <code>index.xhtml</code> page schematically with it &quot;includes&quot; and paths to them:</para> + The illustration below shows <code>index.xhtml</code> page schematically with all its &quot;includes&quot; and paths to them:</para> <mediaobject> <imageobject> <imagedata fileref="images/indexxhtml.png"/> Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/hiw.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/hiw.xml 2009-04-22 14:59:53 UTC (rev 13768) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/hiw.xml 2009-04-22 15:17:25 UTC (rev 13769) @@ -10,7 +10,7 @@ <title>How it works</title> <section> - <title>Used components</title> + <title>Used Components</title> <para>Below there is a list of components used in <property>Photo Album Demo</property>.</para> <table> @@ -33,11 +33,11 @@ </row> <row> <entry>a4j:push</entry> - <entry>The component periodically perform Ajax request to server, to simulate 'push' data.</entry> + <entry>The component periodically perform Ajax request to the server, to simulate 'push' data.</entry> </row> <row> <entry>a4J:poll</entry> - <entry>The component allows periodical sending of Ajax requests to a server and is used for a page updating according to a specified time interval.</entry> + <entry>The component allows periodical sending of Ajax requests to the server and is used for a page updating according to a specified time interval.</entry> </row> <row> <entry>rich:calendar</entry> @@ -45,7 +45,7 @@ </row> <row> <entry>rich:contextMenu</entry> - <entry>The component is used for creation multileveled context menus that are activated after a user defines an event ("onmouseover", "onclick", etc.) on any element on the page.</entry> + <entry>The component is used for creation of multileveled context menus that are activated after a user defines an event ("onmouseover", "onclick", etc.) on any element on the page.</entry> </row> <row> <entry>rich:dataGrid</entry> @@ -53,11 +53,11 @@ </row> <row> <entry>rich:datascroller</entry> - <entry>The component designed for providing the functionality of tables scrolling using Ajax requests.</entry> + <entry>The component is designed for providing the functionality of tables scrolling using Ajax requests.</entry> </row> <row> <entry>rich:fileUpload</entry> - <entry>The component designed to perform Ajax-ed files upload to server.</entry> + <entry>The component is designed to perform Ajax-ed files upload to the server.</entry> </row> <row> <entry>rich:inplaceInput</entry> @@ -65,7 +65,7 @@ </row> <row> <entry>rich:inplaceSelect</entry> - <entry>The component is used for creation select based inputs: it shows the value as text in one state and enables editing the value, providing a list of options in another state.</entry> + <entry>The component is used to create select based inputs: it shows the value as text in one state and enables editing the value, providing a list of options in another state.</entry> </row> <row> <entry>rich:mediaOutput</entry> @@ -73,7 +73,7 @@ </row> <row> <entry>rich:modalPanel</entry> - <entry>The component implements a modal dialog window. All operations in the main application window are locked out while this window is active. Opening and closing the window is done through client JavaScript code.</entry> + <entry>The component implements a modal dialog window. All operations in the main application window are locked out while this window is active. Opening and closing the window is done with client JavaScript code.</entry> </row> <row> <entry>rich:progressBar</entry> @@ -91,7 +91,7 @@ </section> <section> - <title>Albums representation</title> + <title>Albums Representation</title> <section> <title>Building the &lt;rich:tree&gt; on the page</title> @@ -102,18 +102,18 @@ <para> The <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> component in the <property>Photo Album Demo</property> application helps to represent and implement inherently the &quot;Shelves—Albums—Photos&quot; hierarchy. Shelf is the highest possible level in the tree hierarchy. - Shelfs are used to group thematic albums and may contain as many albums as needed. + shelves are used to group thematic albums and may contain as many albums as needed. Photos are not represented in the tree because it can be a great number of them and it can make a tree clumsy. Photos are rendered in the center of the screen (hereinafter referred to as a watching area). </para> <para> - Implicitly, the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> component takes one the main place in the <property>Photo Album Demo</property> and is tightly bounded with the application logic. + Implicitly, the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> component takes one of the main places in the <property>Photo Album Demo</property> and is tightly bounded with the application logic. There are several ways to implement the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis>. In the current application the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> is designed using a model tag <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis>. </para> <para> - The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> component accepts a collection of elements, which are allowed to include lists, arrays, maps, XML NodeList or NamedNodeMap, and iterates through it. + The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> component accepts a collection of elements, which are allowed to include lists, arrays, maps, XML NodeList or NamedNodeMap, and iterate over it. The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> component repeats a hierarchical tree structure on a <code>xhtml</code> or <code>jsp</code> page in a component tree and can be nested without any limitations. The code snippet below schematically shows the idea of how a tree can be built on a page with the help of adaptors: </para> @@ -141,10 +141,10 @@ </para> <para> - Implementation of the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> in the application is very close to the model shown above. + Implementation of the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> in the application is very similar to the model shown above. The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> component has &lt;nodes&gt; attribute. - The top <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> in the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> in the Phot Album Demo application is responsible for shelfs rendering. - Its <emphasis><property>&quot;nodes&quot;</property></emphasis> attribute refers to <emphasis><property>getShelfs()</property></emphasis> method of the <code>ShelfManager</code> class and gets the collection of shelfs associated with the current user including all shared shelfs in the system. + The top <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> in the <emphasis role="bold"><property>&lt;rich:tree&gt;</property></emphasis> in the Phot Album Demo application is responsible for shelves rendering. + Its <emphasis><property>&quot;nodes&quot;</property></emphasis> attribute refers to <emphasis><property>getShelfs()</property></emphasis> method of the <code>ShelfManager</code> class and gets the collection of shelves associated with the current user including all shared shelves in the system. Take a look at this method: </para>