[richfaces-svn-commits] JBoss Rich Faces SVN: r13669 - in trunk/docs/realworld_app_guide/en/src/main/docbook: modules and 1 other directory.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Fri Apr 17 19:04:12 EDT 2009
Author: smukhina
Date: 2009-04-17 19:04:12 -0400 (Fri, 17 Apr 2009)
New Revision: 13669
Modified:
trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml
trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml
trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml
trunk/docs/realworld_app_guide/en/src/main/docbook/modules/how_it_works.xml
trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml
Log:
https://jira.jboss.org/jira/browse/rf-5768 English is corrected
Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml
===================================================================
--- trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml 2009-04-17 22:58:53 UTC (rev 13668)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml 2009-04-17 23:04:12 UTC (rev 13669)
@@ -32,7 +32,7 @@
</bookinfo>
<toc/>
&intro;
- &application_overview;
+ &application_overview;
&getting_started;
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-17 22:58:53 UTC (rev 13668)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml 2009-04-17 23:04:12 UTC (rev 13669)
@@ -12,7 +12,7 @@
<section><title>Used technologies</title>
<para>
- The Photo Album Demo application is not only a JSF application. It encompasses various technologies and frameworks:
+ The Photo Album Demo application is not only a JSF application. It encompasses various technologies and frameworks:
</para>
<itemizedlist>
<listitem><para><emphasis>Java Server Faces (JSF)</emphasis>, technology that provides a single, standard, efficient way to use Java technologies to build Web-based applications;</para></listitem>
@@ -29,8 +29,8 @@
<title>General overview</title>
<para>
While designing the <property>Photo Album Demo</property>, one of the goal was to create a well-structured and transparent system, which will provide a photo-album-like functionality on one hand and demonstrate the main benefits of the <property>RichFaces</property> on the other.
- Thinking within the bounds of the <property>RichFaces</property> library only we could get an application flooded with modal panels, toggles and other controls where they are necessary and where not.
- Developing just a photo album could cause missing the goal of demonstraiting the components.
+ Thinking within the bounds of the <property>RichFaces</property> library only we could get is an application flooded with modal panels, toggles and other controls where they are necessary and where are not.
+ Developing just a photo album could cause missing the goal to demonstrate the components functionality.
That’s why the development of the application was started with brewing of Rich component use cases. Some smart cases of using the components were found.
</para>
<para>
@@ -38,13 +38,13 @@
<ulink url="https://anonsvn.jboss.org/repos/richfaces/management/design/realWorldDemo/prototypes/ver_8/">https://anonsvn.jboss.org/repos/richfaces/management/design/realWorldDemo/prototypes/ver_8/</ulink>
</para>
<para>
- In order to document key concepts and conceptual representation of data of the <property>Photo Album Demo</property> application the Entity Relation diagram (ERD) was created.
+ In order to document key concepts and conceptual representation of data of the <property>Photo Album Demo</property> application the Entity Relation Diagram (ERD) is created.
The diagram also identifies the relationships among all major entities within the system and their significant methods and attributes.
It provides a structural view of the system that can be complemented by other dynamic views in use case models.
</para>
<figure>
- <title>Thе Photo Album Demo entity relation diagram</title>
+ <title>Thе Photo Album Demo Entity Relation Diagram</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/erd.png"/>
@@ -53,9 +53,9 @@
</figure>
<para>
- An important benefit of a entity relation diagram is that it describes and constrains the system scope.
+ An important benefit of an entity relation diagram is that it describes and constrains the system scope.
It is also used to verify and validate the understanding of the problems among various stakeholders of a project group.
- It is especially helpful as a communication tool and a focusing point between technical and business teams.
+ It is especially useful as a communication tool and a focusing point between technical and business teams.
</para>
<para>
@@ -68,20 +68,20 @@
The following steps describe how to use this archetype:
</para>
<itemizedlist>
- <listitem><para>create a new project directory on your hard disk;</para></listitem>
- <listitem><para>browse to the directory with the archetype (<code>richfaces\cdk\maven-archetype-seam-app</code>), switch to command line and type the next command <code>mvn install</code> to install the archetype in your repository;</para></listitem>
- <listitem><para>then browse to your project directory and type in command line</para>
+ <listitem><para>Create a new project directory on your hard disk;</para></listitem>
+ <listitem><para>Browse to the directory with the archetype (<code>richfaces\cdk\maven-archetype-seam-app</code>), switch to command line and type the next command <code>mvn install</code> to install the archetype in your repository;</para></listitem>
+ <listitem><para>Then browse to your project directory and type in command line</para>
<para><code>mvn archetype:generate </code></para>
<para><code>-DarchetypeGroupId=org.richfaces.cdk </code></para>
<para><code>-DarchetypeArtifactId=maven-archetype-seam-app </code></para>
<para><code>-DarchetypeVersion=3.3.0-SNAPSHOT </code></para>
<para><code>-DgroupId=[Your_project_group_id] </code></para>
<para><code>-DartifactId=[Your_project_name] </code></para>
- <para>some project preferences such as <property>RichFaces</property> components version or Jboss server version and others could be customized in root <code>.pom</code> file </para>
+ <para>Some project preferences such as <property>RichFaces</property> components version or Jboss server version and others could be customized in the root <code>.pom</code> file </para>
</listitem>
- <listitem><para>type <code>mvn install</code>;</para></listitem>
- <listitem><para>type <code>mvn eclipse:eclipse</code> to generate eclipse project </para></listitem>
- <listitem><para>import projects into your IDE.</para></listitem>
+ <listitem><para>Type <code>mvn install</code>;</para></listitem>
+ <listitem><para>Type <code>mvn eclipse:eclipse</code> to generate eclipse project </para></listitem>
+ <listitem><para>Import projects into your IDE.</para></listitem>
</itemizedlist>
<para>
@@ -103,7 +103,7 @@
The loader repository is a specific feature of JBoss projects architecture.
It's used to prevent classes of one application being used by classes of another application when two or more applications running on the same server.
Jboss class loading uses the concept of a class loader repository.
- It needs a little getting used to, so some it features should be touched here:
+ It needs a little getting used to, so some its features should be described here:
</para>
<itemizedlist>
@@ -112,7 +112,7 @@
<listitem><para>These class loaders at first ask the repository and then load their own classes;</para></listitem>
<listitem><para>They may also decide to become the head of a new loader repository;</para></listitem>
<listitem><para>Classes loaded into child loader repositories are not visible to parent loader repositories;</para></listitem>
- <listitem><para>The order in which the class loaders are added to the repository matters.</para></listitem>
+ <listitem><para>The order in which the class loaders are added to the repository matters.</para></listitem>
</itemizedlist>
<para>
@@ -129,7 +129,7 @@
</figure>
<para>
- The WEB module structure contains <code>.xhtml</code> sources looks similar to a usual JSF application. The structure of WEB module is illustrated below:
+ The WEB module structure contains <code>.xhtml</code> sources that looks similar to a usual JSF application. The structure of WEB module is illustrated below:
</para>
<figure>
@@ -143,7 +143,7 @@
<para>Since the Photo Album Demo uses Facelets technology the main page <code>index.xhtml</code> represents an <include> (or facelet) wrapped with the <emphasis role="bold"><ui:composition></emphasis> tag.
This tag is used to trim unnecessary markup in the facelet.
- Any content outside of <emphasis role="bold"><ui:composition></emphasis> tag will be ignored by the Facelets view handler.
+ Any content outside of <emphasis role="bold"><ui:composition></emphasis> tag is ignored by the Facelets view handler.
A facelet can be incorporated into another page or facelet with the help of <emphasis role="bold"><ui:define></emphasis> and <emphasis role="bold"><ui:include></emphasis> tags pointed to by the <emphasis role="bold"><ui:include></emphasis> "src" attribute.
The facelet may simply contain a fragment of XHTML or XML to be included.</para>
Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml
===================================================================
--- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml 2009-04-17 22:58:53 UTC (rev 13668)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml 2009-04-17 23:04:12 UTC (rev 13669)
@@ -10,7 +10,7 @@
<title>Getting started</title>
<section>
- <title>Environment configuration</title>
+ <title>Environment Configuration</title>
<para>
The working version of the application is available on-line at <ulink url="http://livedemo.exadel.com/realworld/">http://livedemo.exadel.com/realworld/</ulink>.
</para>
Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/how_it_works.xml
===================================================================
--- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/how_it_works.xml 2009-04-17 22:58:53 UTC (rev 13668)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/how_it_works.xml 2009-04-17 23:04:12 UTC (rev 13669)
@@ -9,9 +9,9 @@
</chapterinfo>
<title>How it works</title>
- <section><title>General application overview</title>
- <section><title>Used technologies overview</title>
- <para>The PhotoAlbum is based on following technologies and frameworks:</para>
+ <section><title>Application Overview</title>
+ <section><title>Used Technologies</title>
+ <para>The Photo Album is based on the following technologies and frameworks:</para>
<itemizedlist>
<listitem><para>Java Server Faces (JSF), technology that provides a single, standard, productive way to use Java technologies to build Web-based applications;</para></listitem>
<listitem><para>Facelets, the technology that combines the power of UI components and the flexibility of XML to accelerate JavaServer Faces development. Facelets presents a compelling alternative to JSP as the markup technology of choice for next-generation JSF applications;</para></listitem>
@@ -23,8 +23,8 @@
</section>
<section>
- <title>The main benefits of the RichFaces</title>
- <para>The RichFaces has set of benefits positioning this library and framework with a difference to the wide range of similar libraries.
+ <title>Benefits of RichFaces</title>
+ <para>The RichFaces has a set of benefits distinguishing this library and framework from a wide range of similar libraries.
All the RichFaces benefits are fully described in the <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/html/Introduction.html">Introduction to the RichFaces</ulink>.
The <Photo Album> covers some of the most important of them and demonstrates: </para>
<itemizedlist>
@@ -40,7 +40,7 @@
<para>Since the application uses Facelets technology the main page <code>index.xhtml</code> represents an <include> (or facelet) wrapped with the <emphasis role="bold"><ui:composition></emphasis> tag.
This tag is used to trim unnecessary markup in the facelet. Any content outside of <emphasis role="bold"><ui:composition></emphasis> tag will be ignored by the Facelets view handler.
A facelet can be incorporated into another page or facelet with the help of <emphasis role="bold"><ui:define></emphasis> and <emphasis role="bold"><ui:include></emphasis> tags pointed to by the <emphasis role="bold"><ui:include></emphasis> "src" attribute.
- The facelet may simply contain a fragment of XHTML or XML to be included.</para>
+ The facelet may simply contains a fragment of XHTML or XML to be included.</para>
<para>Here is <code>index.xhtml</code> page source code:</para>
<programlisting role="XML"><![CDATA[<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
Modified: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml
===================================================================
--- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml 2009-04-17 22:58:53 UTC (rev 13668)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml 2009-04-17 23:04:12 UTC (rev 13669)
@@ -4,7 +4,7 @@
<title>Introduction</title>
<para>
- The <emphasis>RichFaces Real World Demo Application</emphasis> — "<emphasis role="bold">Photo Album Demo</emphasis>" —
+ The Photo Album Demo
is created to help you imagine the way web applications designed and developed with <property>RichFaces</property> can look like and behave.
</para>
<para>
@@ -19,9 +19,9 @@
The "<emphasis role="bold">Photo Album Demo</emphasis>" covers some of the main ones and demonstrates:
</para>
<itemizedlist>
- <listitem><para><emphasis>wide variety of UI components</emphasis> — the <property>RichFaces</property> provides a Lego-like way of building user interfaces for web applications;</para></listitem>
- <listitem><para><emphasis>built-in Ajax capability</emphasis> — the <property>RichFaces</property> offers both component-wide and very flexible page-wide Ajax support with no need to write any JavaScript code; </para></listitem>
- <listitem><para><emphasis>highly customizable look-and-feel</emphasis> — the <property>RichFaces</property> have special feature called
+ <listitem><para><emphasis>Wide variety of UI components</emphasis> — the <property>RichFaces</property> provides a Lego-like way of building user interfaces for web applications;</para></listitem>
+ <listitem><para><emphasis>Built-in Ajax capability</emphasis> — the <property>RichFaces</property> offers both component-wide and very flexible page-wide Ajax support with no need to write any JavaScript code; </para></listitem>
+ <listitem><para><emphasis>Highly customizable look-and-feel</emphasis> — the <property>RichFaces</property> have special feature called
"<ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/html/ArchitectureOverview.html#Skinnability">Skinnability</ulink>").</para></listitem>
</itemizedlist>
<para>
@@ -30,7 +30,7 @@
Newcomers or not registered users can navigate through other users shelves and albums in "Anonymous mode", but in this case <property>no</property> possibilities to create personal shelves or albums or upload photos are available.
</para>
<para>
- The "Photo Album Demo" represents and implements strict "Shelves—Albums—Photos" paradigm.
+ The "Photo Album Demo" represents and implements strict "Shelves—Albums—Photos" hierarchy.
It means that photos are kept in albums and albums are stored on shelves, but albums can not contain another albums or shelves and shelves can not keep another shelves and can not be stored in albums.
</para>
<para>
More information about the richfaces-svn-commits
mailing list