[richfaces-svn-commits] JBoss Rich Faces SVN: r13799 - in trunk/docs/realworld_app_guide/en/src/main: docbook/modules and 1 other directories.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Apr 23 10:38:17 EDT 2009
Author: artdaw
Date: 2009-04-23 10:38:17 -0400 (Thu, 23 Apr 2009)
New Revision: 13799
Added:
trunk/docs/realworld_app_guide/en/src/main/resources/images/modulesList.png
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/hiw.xml
trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml
Log:
https://jira.jboss.org/jira/browse/RF-5768 - Photo Album review
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-23 14:26:05 UTC (rev 13798)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml 2009-04-23 14:38:17 UTC (rev 13799)
@@ -11,13 +11,18 @@
<book>
<bookinfo>
- <title>RichFaces Real World Application Tutorial</title>
-
+ <title>RichFaces Photo Album Application Guide</title>
+ <subtitle>This documentation is work in progress, thus some mistakes or incompleteness is possible</subtitle>
<author>
<firstname>Alex</firstname>
<surname>Tsebro</surname>
<email>atsebro at exadel.com</email>
- </author>
+ </author>
+ <author>
+ <firstname>Gleb</firstname>
+ <surname>Galkin</surname>
+ <email>ggalkin at exadel.com</email>
+ </author>
<copyright>
<year>2009</year>
<holder>Red Hat</holder>
@@ -33,8 +38,8 @@
</bookinfo>
<toc/>
&intro;
+ &getting_started;
&application_overview;
- &getting_started;
&hiw;
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-23 14:26:05 UTC (rev 13798)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/application_overview.xml 2009-04-23 14:38:17 UTC (rev 13799)
@@ -10,7 +10,7 @@
<title>Application Overview</title>
- <section><title>Used technologies</title>
+ <!-- section><title>Used technologies</title>
<para>
The Photo Album Demo application is not only a JSF application. It encompasses various technologies and frameworks:
</para>
@@ -23,7 +23,7 @@
<listitem><para><emphasis>RichFaces</emphasis>, a framework and library of Ajax-capable UI components for JSF framework that had been evolved from Ajax4JSF framework (merge of Ajax and JavaServer Faces technologies).</para></listitem>
</itemizedlist>
- </section>
+ </section-->
<section>
<title>General overview</title>
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-23 14:26:05 UTC (rev 13798)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml 2009-04-23 14:38:17 UTC (rev 13799)
@@ -8,45 +8,111 @@
</keywordset>
</chapterinfo>
<title>Getting started</title>
-
<section>
<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>.
+ In order to download, build, modify, and deploy the Photo Album application
+ you need the following installed and configured:
</para>
- <para>
- Application sources are available at <ulink url="http://anonsvn.jboss.org/repos/richfaces/trunk/test-applications/realworld/">http://anonsvn.jboss.org/repos/richfaces/trunk/test-applications/realworld/</ulink>.
- </para>
- <para>
- In order to download the application sources and deploy them locally the following should be installed and configured on your computer:
- </para>
<itemizedlist>
- <listitem><para>JDK 1.5 and higher</para></listitem>
- <listitem><para>Maven 2.0.9</para></listitem>
- <listitem><para>JBDS (or another appropriate IDE)</para></listitem>
- <listitem><para>JBoss Server 4.2.3</para></listitem>
- <listitem><para>SVN client </para></listitem>
- <listitem><para>Browser</para></listitem>
+ <listitem>
+ <para>
+ <ulink url="http://java.sun.com/javase/downloads/index.jsp">JDK 1.5 and higher</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://maven.apache.org/download.html">Maven 2.0.10</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/tools">JBoss Tools</ulink>
+ (or <ulink url="http://www.eclipse.org/">Eclipse</ulink>)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/jbossas/downloads/">JBoss Server</ulink> (4.2.3.GA, 5.0.x.GA)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://subversion.tigris.org/">SVN client</ulink>
+ </para>
+ </listitem>
</itemizedlist>
</section>
<section>
<title>Installation</title>
- <para>Follow the next steps for downloading and installing the Real World demo.</para>
-
+ <para>
+ Once you have configured the environment you can install the Photo Album application:
+ </para>
<itemizedlist>
- <listitem><para><emphasis>Checkout the project using installed SVN client</emphasis>.
- URL of repository: <code>https://svn.jboss.org/repos/richfaces/trunk/test-applications/realworld/</code>;</para></listitem>
- <listitem><para><emphasis>Build the project</emphasis>.
- Open command line console, point to the folder with checkouted project and tell Maven: <code>mvn clean install eclipse:eclipse</code>;</para></listitem>
- <listitem><para><emphasis>Import the project into your IDE</emphasis>.
- Steps to follow for JBDS users: click <code>File</code> -> <code>Import</code> and select <code>Existing project into Workspace</code> as import source;
+ <listitem>
+ <para>
+ <emphasis>Checkout the project</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[svn co http://anonsvn.jboss.org/repos/richfaces/trunk/examples/photoalbum/]]></programlisting>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Build the project</emphasis>.
+ Open command line console,
+ point to the folder with checkouted project,
+ and tell Maven:
+ </para>
+ <programlisting role="XML"><![CDATA[mvn clean install eclipse:eclipse -Dwtpversion=1.5]]></programlisting>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Import the project into your IDE</emphasis>.
+ You can just deploy Photo Album application on 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
+ ensure rapid development process with Seam and RichFaces.
+ You can find a step-by-step tutorial "Importing existing projects"
+ at the
+<ulink url="http://help.eclipse.org/ganymede/topic/org.eclipse.platform.doc.user/tasks/tasks-importproject.htm">Eclipse documentation</ulink> page
+or simply in the <emphasis>Help</emphasis> > <emphasis>Help Contents</emphasis> of the Eclipse.
+ <!--
+ Steps to follow for JBDS users:
+ click <code>File</code> -> <code>Import</code> and select <code>Existing project into Workspace</code> as import source;
in <code>Import Project</code> window click <code>Browse</code> button and point to the realworld project folder; сlick <code>OK</code>.
- Three SNAPSHOTS (<code>ear</code>, <code>ejb</code>, <code>web</code>) should appear in <code>Projects</code> area.
- Checkmark them all and click <code>Finish</code>. These projects appear in JBDS <code>Package Explorer</code> window.</para></listitem>
- <listitem><para><emphasis>Register the pass to project images</emphasis>. Open project <code>web.xml</code> file (<code>realworld-web-1.0-SNAPSHOT/src/main/webapp/WEB-INF/web.xml</code>) and change <code>uploadRoot</code> parameter value from <code>E:/Andrey/Upload/</code> to yours e.g. <code>D:/realworld/Upload/</code>.</para></listitem>
- <listitem><para><emphasis>Run realworld-ear-1.0-SNAPSHOT</emphasis> on the <code>JBoss 4.2. Server</code> under 3 Runtime (those who prefer manual job should deploy and start <code>realworld.ear</code> file).</para></listitem>
- <listitem><para>Browse to <code>http:/localhost:8080/realworld</code>.</para></listitem>
+ -->
+ As the result three modules of Photo Album project appear in the Workspace:
+ </para>
+ <figure>
+ <title>Modules of Photo Album in the Workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/modulesList.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Add JBoss AS</emphasis>.
+ Now you need to add JBoss Application Server runtime.
+
+ Detailed instructions on how you can do it are given in the
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html/runtimes_servers.html">Runtimes and Servers in the JBoss AS plugin</ulink>
+ chapter from the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html/index.html">JBoss Server Manager Reference Guide</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Run photoalbum-ear-1.0-SNAPSHOT</emphasis> on the JBoss Application Server
+ you have just installed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Browse to <code>http:/localhost:8080/photoalbum</code>.
+ </para>
+ </listitem>
</itemizedlist>
</section>
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-23 14:26:05 UTC (rev 13798)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/hiw.xml 2009-04-23 14:38:17 UTC (rev 13799)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="patterns" xreflabel="patterns">
- <?dbhtml filename="getting_started.html"?>
+ <?dbhtml filename="patterns.html"?>
<chapterinfo>
<keywordset>
<keyword>RichFaces</keyword>
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-23 14:26:05 UTC (rev 13798)
+++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml 2009-04-23 14:38:17 UTC (rev 13799)
@@ -4,38 +4,66 @@
<title>Introduction</title>
<para>
- 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.
+ The "Photo Album" web application is a desktop-like on-line photo manager.
+ It provides social services for uploading photos, storing and previewing them,
+ creating your own albums and sharing them with other users, searching albums,
+ photos or users, managing the environment.
+ Newcomers or not registered users can navigate through other users shelves and albums
+ in "Anonymous mode", but in this case no possibilities to create personal
+ shelves or albums or upload photos are available.
</para>
<para>
- The <property>RichFaces</property> is an opensource framework and library of Ajax-capable UI components for JavaServer Faces framework.
- The <property>RichFaces</property> is evolved from Ajax4JSF framework (integration of Ajax and JavaServer Faces technologies).
+ The "Photo Album" 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>
- The <property>RichFaces</property> provides a set of benefits which distinguish it from a wide range of similar libraries and frameworks.
- All the <property>RichFaces</property> benefits and advantages 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>" chapter of the
- "<ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/html/index.html">RichFaces Developer Guide</ulink>".
- 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
- "<ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/html/ArchitectureOverview.html#Skinnability">Skinnability</ulink>").</para></listitem>
+ <para>
+ The Photo Album web application is designed and developed with RichFaces. This application 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
+ <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>
- The "Photo Album Demo" is a desktop-like on-line photo manager.
- It provides social services for uploading photos, storing and previewing them, creating your own albums and sharing them with other users, searching albums, photos or users, managing the environment.
- 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.
+ The Photo Album application also encompasses technologies and frameworks such as:
</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="https://facelets.dev.java.net/">Facelets</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://java.sun.com/products/ejb/">Enterprise Java Beans (EJB) 3.0</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://seamframework.org/">Seam framework</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
<para>
- 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.
+ The application is available online at <ulink url="http://livedemo.exadel.com/realworld/">Photo Album</ulink> page.
</para>
- <para>
- The <property>RichFaces</property> "Photo Album Demo" is a blue print application. One of it main goal is to show patterns of the <property>RichFaces</property> components usage.
- </para>
+
</chapter>
Added: trunk/docs/realworld_app_guide/en/src/main/resources/images/modulesList.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/realworld_app_guide/en/src/main/resources/images/modulesList.png
___________________________________________________________________
Name: svn:executable
+ *
Name: svn:mime-type
+ application/octet-stream
More information about the richfaces-svn-commits
mailing list