Author: atsebro Date: 2009-01-12 06:41:40 -0500 (Mon, 12 Jan 2009) New Revision: 12207 Added: trunk/docs/realworld_app_guide/ trunk/docs/realworld_app_guide/en/ trunk/docs/realworld_app_guide/en/pom.xml trunk/docs/realworld_app_guide/en/src/ trunk/docs/realworld_app_guide/en/src/main/ trunk/docs/realworld_app_guide/en/src/main/docbook/ trunk/docs/realworld_app_guide/en/src/main/docbook/included/ trunk/docs/realworld_app_guide/en/src/main/docbook/included/actionparam.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/ajaxSingleFacets.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/binding.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/calendarDate.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/dataTableAjax.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerFor.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerPaired.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/explicitId.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/fileUploadListener.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/i18n.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/menuJSF.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/myfaces.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/resource.xml trunk/docs/realworld_app_guide/en/src/main/docbook/included/seamMultipartFilter.xml trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/req.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/rw_itself.xml trunk/docs/realworld_app_guide/en/src/main/docbook/modules/scope.xml trunk/docs/realworld_app_guide/en/src/main/resources/ trunk/docs/realworld_app_guide/en/src/main/resources/images/ trunk/docs/realworld_app_guide/en/src/main/resources/images/rw_its_start.png trunk/docs/realworld_app_guide/pom.xml Log: https://jira.jboss.org/jira/browse/RF-4494 - Tutorial about developing this Sample application Added: trunk/docs/realworld_app_guide/en/pom.xml =================================================================== --- trunk/docs/realworld_app_guide/en/pom.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/pom.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,42 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.richfaces.docs</groupId> + <artifactId>realworld</artifactId> + <version>3.3.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + <groupId>org.richfaces.docs.migration</groupId> + <artifactId>${translation}</artifactId> + <version>3.3.0-SNAPSHOT</version> + <packaging>jar</packaging> + <name>RichFaces Realworld application Guide (${translation})</name> + + <properties> + <translation>en</translation> + </properties> + <build> + <finalName> + ${project.parent.artifactId}_${translation}-${version} + </finalName> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>xml-maven-plugin</artifactId> + <version>1.0-beta-2</version> + </plugin> + + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <extensions>true</extensions> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/actionparam.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/actionparam.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/actionparam.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="actionparam" role="NotInToc"> + <?dbhtml filename="actionparam.html"?> + <sectioninfo> + <keywordset> + <keyword>a4j:actionparam</keyword> + <keyword>actionListener</keyword> + <keyword>JSP</keyword> + </keywordset> + </sectioninfo> + <title>Action listeners calling problem with &lt;a4j:actionparam&gt; on JSP page</title> + <section> + <title>Description</title> + <para> + As it has been mentioned above we&apos;ve migrated to <property>JSF 1.2</property> standard in <property>RichFaces 3.2.0</property>. + The order of calling action listeners has been changed in <property>JSF 1.2</property>: first the listener of the component itself is called then the other listeners are called. + </para> + <para> + This is why the <emphasis role="bold"><property>&lt;a4j:actionparam&gt;</property></emphasis> component setter is called after + <emphasis><property>&quot;actionListener&quot;</property></emphasis> of the component itself. + In the following example <code>#{bean.action}</code> is called before <code>#{bean.value}</code>: + </para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... +<a4:support actionListener="#{bean.action}" event="onclick"> + <a4j:actionparam assignTo="#{bean.value}" value="John"/> +</a4j:support> +...]]></programlisting> + <para> + This issue occurs in JSP pages only. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-3110">Jira</uli... + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <programlisting role="XML"><![CDATA[... +<f:view> + <h:form> + <h:panelGrid width="120" border="5"> + <a4j:support event="onclick" reRender="rep" actionListener="#{actionPlanBean.actionListener}"> + <a4j:actionparam name="username" value="John" assignTo="#{actionPlanBean.name}" /> + </a4j:support> + <h:outputLabel value="Panel 1 - John"/> + </h:panelGrid> + <rich:panel> + <h:outputText id="rep" value="I say: #{actionPlanBean.helloLabel}"/> + </rich:panel> + </h:form> +</f:view> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + Please, see <ulink url="http://jira.jboss.com/jira/browse/RF-3080">Jira</uli...;. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + The solution is to use <emphasis role="bold"><property>&lt;a4j:actionParam&gt;</property></emphasis> before: + </para> + <programlisting role="XML"><![CDATA[... +<f:actionListener binding="#{skin.binding}"/> +...]]></programlisting> + + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/ajaxSingleFacets.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/ajaxSingleFacets.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/ajaxSingleFacets.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="ajaxSingleFacets" role="NotInToc"> + <?dbhtml filename="ajaxSingleFacets.html"?> + <sectioninfo> + <keywordset> + <keyword>ajaxSingle</keyword> + <keyword>facet</keyword> + <keyword>static</keyword> + </keywordset> + </sectioninfo> + <title>The ajaxSingle/region components in facets of &lt;h:dataTable&gt;</title> + <section> + <title>Description</title> + <para> + The <property>RichFaces</property> components that have + <emphasis><property>&quot;ajaxSingle&quot;</property></emphasis> set to &quot;true&quot; does not work in + <emphasis><property>&quot;header&quot;</property></emphasis> or <emphasis><property>&quot;footer&quot;</property></emphasis> facets + of <emphasis role="bold"><property>&lt;h:dataTable&gt;</property></emphasis>, e.g. + <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> - scrolling doesn't work. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2696">Jira</uli... + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs if the following code is used. As a result the <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> component stops working. + </para> + <programlisting role="XML"><![CDATA[... +<h:dataTable> + <f:facet name="header"> + <rich:datascroller ajaxSingle="true"/> + </f:facet> + ... +</h:dataTable> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + The ajaxSingle/region requires <code>invokeOnComponent()</code> to work properly. For more details, please, + see <ulink url="https://javaserverfaces.dev.java.net/issues/show_bug.cgi?id=718... Faces issues reporting</ulink> page. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + The solution is to use <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> component. + </para> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/binding.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/binding.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/binding.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="binding" role="NotInToc"> + <?dbhtml filename="binding.html"?> + <sectioninfo> + <keywordset> + <keyword>binding</keyword> + <keyword>JSP</keyword> + </keywordset> + </sectioninfo> + <title>Binding problem in JSP</title> + <section> + <title>Description</title> + <para> + Binding does not work for all components in JSP: it is impossible to use the<emphasis><property>&quot;binding&quot;</property></emphasis> attribute for + RichFaces components, since wrong class-name is used in TLD generated from XML configuration files. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2918 ">Jira</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs if binding attribute is used with RichFaces components. + </para> + </section> + <section> + <title>Causes</title> + <para> + There was a wrong <code>&lt;classname&gt;java.lang.String&lt;/classname&gt;</code> specified instead of <code>&lt;classname&gt;javax.faces.component.UIComponent&lt;/classname&gt;</code> in configuration files. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + The solution is to use <property>Facelets</property> upgrade to <ulink url=" http://www.jboss.org/jbossrichfaces/downloads/">RichFaces 3.2.0 SP1</ulink> + </para> + </section> + +</section> Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/calendarDate.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/calendarDate.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/calendarDate.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="calendarDate" role="NotInToc"> + <?dbhtml filename="calendarDate.html"?> + <sectioninfo> + <keywordset> + <keyword>calendar</keyword> + <keyword>date</keyword> + <keyword>ondateselected</keyword> + </keywordset> + </sectioninfo> + <title>&lt;rich:calendar&gt; and &quot;ondateselected&quot; event problem</title> + <section> + <title>Description</title> + <para> + The <emphasis role="bold"><property>&lt;rich:calendar&gt;</property></emphasis> date selected event is fired before input update. + </para> + <para> + If <property>time</property> and <property>apply</property> elements are added to the calendar, + <emphasis><property>&quot;ondateselected&quot;</property></emphasis> gets fired when a date is selected but before it&apos;s updated in input. + Now we have three events instead of one. But it causes compatibility problem because this event was used by customers to save selected value via Ajax. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs when <emphasis role="bold"><property>&lt;a4j:support&gt;</property></emphasis>is put inside <emphasis role="bold"><property>&lt;rich:calendar&gt;</property></emphasis>. + If the <emphasis><property>&quot;event&quot;</property></emphasis> property is set to &quot;ondateselected&quot; + previous value of the <emphasis role="bold"><property>&lt;rich:calendar&gt;</property></emphasis> is stored after selection. + </para> + </section> + <section> + <title>Causes</title> + <para> + Events firing sequence was changed. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + You need <emphasis><property>&quot;onchanged&quot;</property></emphasis> event to be fired after any change which causes input to be updated, both date and time. + </para> + <para> + Note, that + </para> + <itemizedlist> + <listitem> + <para> + <emphasis><property>&quot;ondateselected&quot;</property></emphasis> event is fired after a date is selected in popup + </para> + </listitem> + <listitem> + <para> + <emphasis><property>&quot;ontimechanged&quot;</property></emphasis> event is fired after new time is selected. + </para> + </listitem> + </itemizedlist> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/dataTableAjax.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/dataTableAjax.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/dataTableAjax.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="dataTableAjax" role="new"> + <?dbhtml filename="dataTableAjax.html"?> + <sectioninfo> + <keywordset> + <keyword>dataTable</keyword> + <keyword>ajax</keyword> + </keywordset> + </sectioninfo> + <title>Ajax request calls encode() methods of &lt;rich:dataTable&gt; even if it is not necessary</title> + <section> + <title>Description</title> + <para> + Any Ajax request reloads the list that is related to the <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> component even if the Ajax request is related to another bean. +It happens because the Ajax request checks whether the <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> has nested <emphasis role="bold"><property>&lt;rich:outputPanel&gt;</property></emphasis> or <emphasis role="bold"><property>&lt;rich:messages&gt;</property></emphasis> components that should be updated. +If there are no <emphasis role="bold"><property>&lt;rich:outputPanel&gt;</property></emphasis>, <emphasis role="bold"><property>&lt;rich:messages&gt;</property></emphasis> components inside the <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> will not be updated, but anyway the <code>encode()</code> methods is called by the Ajax request. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="https://jira.jboss.org/jira/browse/RF-3341">Jira</ul... + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + Place the following code on a page and click the button. The list in <code>myBean1.myList</code> will be reloaded. + </para> + <programlisting role="XML"><![CDATA[... +<h:form id="form1"> + <rich:dataTable id="myTable" value="#{myBean1.myList}" var="comp"> + ... + </rich:dataTable> +</h:form> +<h:form id="form2"> + <h:outputText value="#{myBean2.test}"/> + <a4j:commandButton event="onclick" reRender="form2" /> +</h:form> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + Bug is caused by <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> implementation peculiarity. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + Wrap the zone of a page that should be processed and updated in the <emphasis role="bold"><property>&lt;a4j:region&gt;</property></emphasis> component with <code>renderRegionOnly=&quot;true&quot;</code>. The <emphasis role="bold"><property>&lt;rich:dataTable&gt;</property></emphasis> should be outside of the <emphasis role="bold"><property>&lt;a4j:region&gt;</property></emphasis>. + </para> + </section> +</section> Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerFor.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerFor.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerFor.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="datascrollerFor" role="NotInToc"> + <?dbhtml filename="datascrollerFor.html"?> + <sectioninfo> + <keywordset> + <keyword>datascroller</keyword> + <keyword>for</keyword> + <keyword>static</keyword> + </keywordset> + </sectioninfo> + <title>Static &quot;for&quot; attribute in &lt;rich:datascroller&gt;</title> + <section> + <title>Description</title> + <para> + The <emphasis><property>&quot;for&quot;</property></emphasis>attribute of <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> component + doesn&apos;t allow EL expressions in 3.2.0.GA. + </para> + <para> + Custom tags exploiting the ability of the <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> to have dynamic + <emphasis><property>&quot;for&quot;</property></emphasis> attribute doesn&apos;t work. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2923">Jira</uli... + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs if the following code is used: + </para> + <programlisting role="XML"><![CDATA[... +<rich:datascroller for="#{bean.property}"/> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + Please, see <ulink url="http://jira.jboss.com/jira/browse/RF-1133">Jira</uli... + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + None, so far. + </para> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerPaired.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerPaired.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/datascrollerPaired.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="datascrollerPaired" role="NotInToc"> + <?dbhtml filename="datascrollerPaired.html"?> + <sectioninfo> + <keywordset> + <keyword>datascroller</keyword> + <keyword>paired</keyword> + <keyword>page</keyword> + </keywordset> + </sectioninfo> + <title>Paired &lt;rich:datascroller&gt; components do not work</title> + <section> + <title>Description</title> + <para> + Two <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> components bound to the same table aren&apos;t synchronized. + Having two <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis>components on a page, session-scoped beans saves the data for only one <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> component. + It is a common pattern to have 2 <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> components: + the first in the header, the second in the footer. In this case the first one will not work. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2970">Jira</uli... + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs if two <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> components are added to any table. + </para> + </section> + <section> + <title>Causes</title> + <para> + The <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> component does not manage the scroll state of a data table. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + The solution is to use <emphasis><property>&quot;page&quot;</property></emphasis> attribute and bind it to the same property for all + <emphasis role="bold"><property>&lt;rich:datascroller&gt;</property></emphasis> components. + </para> + </section> + +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/explicitId.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/explicitId.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/explicitId.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="explicitId" role="NotInToc"> + <?dbhtml filename="explicitId.html"?> + <sectioninfo> + <keywordset> + <keyword>explicit</keyword> + <keyword>id</keyword> + </keywordset> + </sectioninfo> + <title>Ajax requests in JSF 1.2</title> + <section> + <title>Description</title> + <para> + Ajax requests stop to work without any errors messages displayed, when intensive Ajax traffic is expected. No errors or other messages to detect cause of the defect are shown. + </para> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problem occurs if an <property>id</property> for Ajax command component is not defined. + </para> + <programlisting role="XML"><![CDATA[... + <h:form> + <h:panelGrid columns="2"> + <h:inputText id="myinput" value="#{userBean.name}"> + <a4j:support event="onkeyup" reRender="outtext" /> + </h:inputText> + <h:outputText id="outtext" value="#{userBean.name}" /> + </h:panelGrid> + </h:form> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + The problem occurred due to specific usage of the dynamic id generation implementing JSF 1.2. + In case of simultaneous request processing, the id of the command component becomes <property>out-of-sync</property> + with id of the same component on the page. After that any Ajax requests of the component with old id is not processed. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + You should define the <property>id</property> for the command component and parent namespace components + (<emphasis role="bold"><property>&lt;h:form&gt;</property></emphasis>, + <emphasis role="bold"><property>&lt;f:subview&gt;</property></emphasis>, + <emphasis role="bold"><property>&lt;h:dataTable&gt;</property></emphasis> and so on) explicitly. + As soon as this is a core JSF 1.2 functionality, the problem cannot be solved on the <property>RichFaces</property> level. + </para> + </section> + +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/fileUploadListener.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/fileUploadListener.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/fileUploadListener.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="fileUploadListener" role="NotInToc"> + <?dbhtml filename="fileUploadListener.html"?> + <sectioninfo> + <keywordset> + <keyword>fileUpload</keyword> + <keyword>listener</keyword> + </keywordset> + </sectioninfo> + <title>The &quot;fileUploadListener&quot; with MyFaces or JSF-RI 1.2_04</title> + <section> + <title>Description</title> + <para> + The <emphasis><property>&quot;fileUploadListener&quot;</property></emphasis>(<emphasis><property>&quot;UploadEvent&quot;</property></emphasis> event) is not invoked + when <property>MyFaces</property> or <property>JSF-RI 1.2_04</property> is used. But file is uploaded successfully. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2935">Jira(for MyFaces)</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + <property>MyFaces</property> or <property>JSF-RI 1.2_04</property> with default configuration + </para> + </section> + <section> + <title>Causes</title> + <para> + In case <property>MyFaces</property> <code>org.apache.myfaces.CHECK_EXTENSIONS_FILTER</code> parameter is set to &quot;true&quot;, the parameter checks if the extensions-filter has been properly configured. + </para> + <para> + The reason why usage of <property>JSF-RI 1.2_04</property> causes the problem is not yet identified. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + To avoid generation of errors from <property>MyFaces</property> in case of invalid filter configuration + you can set up the following parameters in <property>web.xml</property>: + </para> + <programlisting role="XML"><![CDATA[... +<context-param> + <param-name>org.apache.myfaces.CHECK_EXTENSIONS_FILTER</param-name> + <param-value>false</param-value> +</context-param> +...]]></programlisting> + <para> + In case of JSF 1.2_04, upgrading to <ulink url="https://javaserverfaces.dev.java.net/servlets/ProjectDocumentLi... 1.2_07</ulink> + (last stable version) works. + </para> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/i18n.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/i18n.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/i18n.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="i18n" role="NotInToc"> + <?dbhtml filename="i18n.html"?> + <sectioninfo> + <keywordset> + <keyword>i18n</keyword> + <keyword>internationalization</keyword> + </keywordset> + </sectioninfo> + <title>non-ASCII characters in application with i18n</title> + <section> + <title>Description</title> + <para> + An application with i18n does not work correctly due to the validation error that occurs when non-ASCII characters are used. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2962">Jira</uli... + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <programlisting role="XML"><![CDATA[... +<select id="j_id27:cbxUser" name="j_id27:cbxUser" size="1" style="width:120px"> + <option value="Al Korbeli& #269;o">Al Korbeli& #269;o</option> + <option value="Al Nagyov& aacute;">Al Nagyov& aacute;</option> + <option value="Al Tothov& aacute;">Al Tothov& aacute;</option> + <option value="An Gajdov& aacute;">An Gajdov& aacute;</option> + ... +</select> +...]]></programlisting> + </section> + <section> + <title>Causes</title> + <para> + Bug is caused by the<emphasis role="bold"><property>&lt;rich:fileUpload&gt;</property></emphasis> component + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + You need to update to <ulink url="http://www.jboss.org/jbossrichfaces/downloads/">RichFaces 3.2.0 SP1</ulink> + </para> + </section> + +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/menuJSF.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/menuJSF.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/menuJSF.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="menuJSF" role="NotInToc"> + <?dbhtml filename="menuJSF.html"?> + <sectioninfo> + <keywordset> + <keyword>JSF-RI-1.2_08</keyword> + <keyword>menu</keyword> + </keywordset> + </sectioninfo> + <title>Menu components and JSF-RI-1.2_08</title> + <section> + <title>Description</title> + <para> + Menu components do not work with JSF-RI-1.2_08: + </para> + <itemizedlist> + <listitem> + <para> + The <emphasis role="bold"><property>&lt;rich:contextMenu&gt;</property></emphasis> component is not invoked by the right mouse click + </para> + </listitem> + <listitem> + <para> + The <emphasis role="bold"><property>&lt;rich:dropDownMenu&gt;</property></emphasis> component causes the exception, displaying a XHTML invalid output message + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="https://javaserverfaces.dev.java.net/issues/show_bug.cgi?id=717 ">JavaServer Faces issues</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2637 ">Jira</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The described above problems occur if JSF-RI 1.2_08 and menu components are used on a page + </para> + </section> + <section> + <title>Causes</title> + <para> + It is a critical bug in JSF-RI 1.2_08 which has been already fixed in the further releases. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + Upgrade to <ulink url="https://javaserverfaces.dev.java.net/servlets/ProjectDocumentLi... 1.2_09</ulink> or above + </para> + </section> + +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/myfaces.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/myfaces.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/myfaces.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="myfaces" role="NotInToc"> + <?dbhtml filename="myfaces.html"?> + <sectioninfo> + <keywordset> + <keyword>MyFaces</keyword> + <keyword>RichFaces</keyword> + <keyword>WebLogic</keyword> + </keywordset> + </sectioninfo> + <title>RichFaces 3.2.0 with MyFaces 1.2.2 on WebLogic 10 MP1</title> + <section> + <title>Description</title> + <para> + If you try to use <property>RichFaces 3.2.0</property> with <property>MyFaces 1.2.2</property> on a + <property>WebLogic 10 MP1</property> server the following error appears: + </para> + <programlisting role="JAVA"><![CDATA[java.lang.IllegalStateException: Servlet response already use stream, Writer not possible +...]]></programlisting> + + + <para> + The same project works on <property>Tomcat 6.016</property>, <property>Tomcat 5.5.25</property> + <property>WebLogic 10MP1</property> with <property>RichFaces 3.1.4</property>. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The problem occurs if the environment mentioned above is set. + </para> + </section> + <section> + <title>Causes</title> + <para> + Unknown. Possible problem with <property>MyFaces</property> on <property>WebLogic 10MP1</property>. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + Switching to <ulink url="https://javaserverfaces.dev.java.net/servlets/ProjectDocumentLi... 1.2_07</ulink> + fixes the problem (see forum post) + </para> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/resource.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/resource.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/resource.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="resource" role="NotInToc"> + <?dbhtml filename="resource.html"?> + <sectioninfo> + <keywordset> + <keyword>resource</keyword> + <keyword>skinning</keyword> + </keywordset> + </sectioninfo> + <title>Resources for standard skinning classes</title> + <section> + <title>Description</title> + <para> + When standard skinning classes or background images are inaccessible + <code>&quot;Resource not registered : org.richfaces.renderkit.html.images.InputBackgroundImage&quot;</code> (another name is possible) exception appears in server log. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/RF-2944 ">Jira</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para>The described above problem usually occurs after server restart when user refreshes the page</para> + </section> + <section> + <title>Causes</title> + <para> + The problem is caused when resources for standard skinning classes are not available to be registered during <property>RichFaces</property> library build + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + Switch off standard skinning classes by setting initial parameter in <property>web.xml</property>: + </para> + <programlisting role="XML"><![CDATA[... +<context-param> + <param-name>org.richfaces.CONTROL_SKINNING_CLASSES</param-name> + <param-value>disable</param-value> +</context-param> +...]]></programlisting> +<para> + Add <ulink url="http://docs.google.com/View?docid=dqk93fg_3ggsznfz5">ME... to the application classpath. +</para> + </section> + +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/included/seamMultipartFilter.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/included/seamMultipartFilter.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/included/seamMultipartFilter.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="seamMultipartFilter" role="NotInToc"> + <?dbhtml filename="seamMultipartFilter.html"?> + <sectioninfo> + <keywordset> + <keyword>rich:fileUpload</keyword> + <keyword>Seam</keyword> + <keyword>multi-part</keyword> + <keyword>filter</keyword> + </keywordset> + </sectioninfo> + <title>&lt;rich:fileUpload&gt; with Seam multi-part filter</title> + <section> + <title>Description</title> + <para> + The <emphasis role="bold"><property>&lt;rich:fileUpload&gt;</property></emphasis> component does not work with <property>Seam</property> multi-part filter. + </para> + </section> + <section> + <title>Links</title> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... Forum</ulink> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>How to reproduce</title> + <para> + The problem occurs if you use the <emphasis role="bold"><property>&lt;rich:fileUpload&gt;</property></emphasis> component and <property>Seam</property> multi-part filter at the same time. + </para> + </section> + <section> + <title>Causes</title> + <para> + Lack of specification on the <property>Servlet</property> level does not allow to use stuff doing the same thing. One of them should be turned off. + </para> + </section> + + <section> + <title>Workarounds</title> + <para> + The solution is turn the <property>Seam</property> multi-part filter off. + </para> + </section> +</section> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/master.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd" [ + <!ENTITY intro SYSTEM "modules/intro.xml"> + <!ENTITY getting_started SYSTEM "modules/getting_started.xml"> + <!ENTITY rw_itself SYSTEM "modules/rw_itself.xml"> + + +]> + +<book> + <bookinfo> + <title>RichFaces Real World Application Guide</title> + + <author> + <firstname>Alex</firstname> + <surname>Tsebro</surname> + <email&gt;atsebro(a)exadel.com&lt;/email&gt; + </author> + <copyright> + <year>2009</year> + <holder>Red Hat</holder> + </copyright> + + <abstract> + <title/> + <para> + <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... version</ulink> + </para> + </abstract> + + </bookinfo> + <toc/> + &intro; + &getting_started; + &rw_itself; + + +</book> Added: 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 (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/getting_started.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Getting_started_with_RW" xreflabel="Getting_started_with_RW"> + <?dbhtml filename="RichFacesMigrationIssues31to32.html"?> + <chapterinfo> + <keywordset> + <keyword>RichFaces</keyword> + + </keywordset> + </chapterinfo> + <title>Getting started</title> + + <section> + <title>Environment configuration</title> + <para> + The working version of the application is available online(?). + Those who wish to rimmage and touch the source code form inside can dowload the project from repository and deploy it locally. + Following should be installed and configured to start working with project source: + </para> + + <itemizedlist> + <listitem><para>JDK 1.5 and higher</para></listitem> + <listitem><para>Maven 2.0.9</para></listitem> + <listitem><para>JBDS (or Eclipse)</para></listitem> + <listitem><para>JBoss Server 4.2.3</para></listitem> + <listitem><para>SVN client </para></listitem> + <listitem><para>Browser</para></listitem> + </itemizedlist> + </section> + + <section> + <title>Installation</title> + <para>Do the following steps for downloading and installing the Real World demo.</para> + + <itemizedlist> + <listitem><para><literallayout><emphasis>Checkout the project using installed SVN client</emphasis>. + URL of repository: <code>https://svn.jboss.org/repos/richfaces/trunk/test-applications/rea...;. + <listitem><para><emphasis>Build the project</emphasis>. Open command line, point to the folder with checkouted project and tell Maven: <code>mvn clean install eclipse:eclipseMaven 2.0.9</code>.</para></listitem> + <listitem><para><emphasis>Import the project into your IDE</emphasis>. Steps to do 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 (ear, ejb, web) should appear in <code>Projects</code> area. Checkmark them all and click <code>Finish</code>. These projects should 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 realqorld.ear file).</para></listitem> + <listitem><para>Browse to <code>http:/localhost:8080/realworld</code>.</para></listitem> + </itemizedlist> + + + + </section> + + + + + +</chapter> \ No newline at end of file Added: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/intro.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction" xreflabel="introduction"> + <?dbhtml filename="intro.html"?> + + <title>Introduction</title> + <para> + The <emphasis>RichFaces Real World Application</emphasis> — the working name is &quot;<emphasis role="bold">Photo Album</emphasis>&quot; — is created to imaginate the way, + the web applications designed and developed with <property>RichFaces</property> could look and behave. + </para> + <para> + The RichFaces are evolved from <emphasis>Ajax4JSF</emphasis> framework (merge of Ajax and JavaServer Faces technologies) and + represent a framework and library of <emphasis>Ajax-capable UI components for JSF framework</emphasis>. + Amongst the wide range of similar libraries the RichFaces has set of benefits that is fully described in + the <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... to the RichFaces</ulink>. + The &quot;Photo Album&quot; covers some of the most important of them and demonstrates: + </para> + + <itemizedlist> + <listitem><para><emphasis>wide variety of UI components</emphasis>, which provides Lego-like way of building user interfaces for web applications;</para></listitem> + <listitem><para><emphasis>built-in Ajax capability</emphasis>, which offers both component-wide and a lot more flexible page-wide Ajax support;</para></listitem> + <listitem><para><emphasis>highly customizable look-and-feel</emphasis> (the RichFaces have special feature called + &quot;<ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... + </itemizedlist> +</chapter> + + Added: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/req.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/req.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/req.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="rw_itself" xreflabel="rw_itself"> + <?dbhtml filename="requirements.html"?> + <chapterinfo> + <keywordset> + <keyword>RichFaces</keyword> + + </keywordset> + </chapterinfo> + + <title>The Real World as it is</title> + <para> + + </para> + +</chapter> + Added: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/rw_itself.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/rw_itself.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/rw_itself.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="rw_itself" xreflabel="rw_itself"> + <?dbhtml filename="requirements.html"?> + <chapterinfo> + <keywordset> + <keyword>RichFaces</keyword> + + </keywordset> + </chapterinfo> + + <title>The Real World as it is</title> + <para>The &quot;Photo Album&quot; is a desktop-like online photo manager that provides social service with pictures uploading, preview, storage, management and sharing features. +It allows to create own albums, upload photos there, share the albums with other users, search albums. +For newcomers the system allows &quot;Anonymous regime&quot; that may be used to search and view others albums, but no personal albums, no possibility to mark favorite photos and friends albums are available. + </para> + + <section> + <title>Used components</title> + + <para>Below there is a list of components used in &quot;Photo album&quot;.</para> + <table> + <title>Components used in &quot;Photo album&quot;</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>a4j:commandLink</entry> + <entry>The component is very similar to the &lt;h:commandLink&gt; component, the only difference is that an Ajax form submit is generated on a click and it allows dynamic rerendering after a response comes back. It's not necessary to plug any support into the component, as Ajax support is already built in.</entry> + </row> + <row> + <entry>a4j:commandButton</entry> + <entry>The component is very similar to the &lt;h:commandButton&gt; component, the only difference is that an Ajax form submit is generated on a click and it allows dynamic rerendering after a response comes back. It's not necessary to plug any support into the component, as Ajax support is already built in.</entry> + </row> + <row> + <entry>a4j:push</entry> + <entry>The component periodically perform Ajax request to 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> + </row> + <row> + <entry>rich:calendar</entry> + <entry>The component is used for creating monthly calendar elements on a page.</entry> + </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> + </row> + <row> + <entry>rich:dataGrid</entry> + <entry>The component to render data as a grid that allows choosing data from a model and obtains built-in support of Ajax updates.</entry> + </row> + <row> + <entry>rich:datascroller</entry> + <entry>The component 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> + </row> + <row> + <entry>rich:inplaceInput</entry> + <entry>The component is an input component used for displaying and editing data inputted. </entry> + </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> + </row> + <row> + <entry>rich:mediaOutput</entry> + <entry>The component implements one of the basic features specified in the framework. The component is a facility for generating images, video, sounds and other binary resources defined by you on-the-fly.</entry> + </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> + </row> + <row> + <entry>rich:progressBar</entry> + <entry>The component is designed for displaying a progress bar which shows the current status of the process. </entry> + </row> + <row> + <entry>rich:tree</entry> + <entry>The component is designed for hierarchical data presentation and is applied for building a tree structure with a drag-and-drop capability. The component also uses built-in drag and drop.</entry> + </row> + + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Main views</title> + <para>The following section contains some most importants screenshots provided with additional comments. + </para> + <para>Starting page of the &quot;Photo album&quot; contains some basic information about RichFaces an log-in fields: + </para> + <figure> + <title>&quot;Photo album&quot; start page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rw_its_start.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Three users where created for test purposes. Their names, passes and albums are listed in the table below:</para> + <table> + <title>Components used in &quot;Photo album&quot;</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Pass</entry> + <entry>Albums</entry> + </row> + </thead> + <tbody> + <row> + <entry>amarkhel</entry> + <entry>12345</entry> + <entry>Cars, Tetki</entry> + </row> + <row> + <entry>root</entry> + <entry>12345</entry> + <entry>Football</entry> + </row> + <row> + <entry>qqqq</entry> + <entry>12345</entry> + <entry>Japan, Music</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>After loging in the user gets to his personal page. The interface of the "cabinet" consists of menu bar, albums panels and working area. + </para> + + + + </section> + + + + + + +</chapter> + Added: trunk/docs/realworld_app_guide/en/src/main/docbook/modules/scope.xml =================================================================== --- trunk/docs/realworld_app_guide/en/src/main/docbook/modules/scope.xml (rev 0) +++ trunk/docs/realworld_app_guide/en/src/main/docbook/modules/scope.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="scope" xreflabel="scope"> + <?dbhtml filename="scope.html"?> + <chapterinfo> + <keywordset> + <keyword>RichFaces</keyword> + <keyword>Migration Guide</keyword> + <keyword>scope</keyword> + </keywordset> + </chapterinfo> + + <title>Scope of the document</title> + + <itemizedlist> + <listitem> + <para> + This document should not be used as a tutorial for <property>RichFaces</property> framework + since it is created to describe the issues caused by migration process + </para> + </listitem> + <listitem> + <para> + It is assumed that you are familiar with basic tenets of <property>RichFaces</property> framework. + If you are newbie in <property>RichFaces</property> you can find + <property>RichFaces</property> documentation <ulink url="http://www.jboss.org/jbossrichfaces/docs/index.html">he...;. + </para> + </listitem> + <listitem> + <para> + Concepts related to Web or application servers configuration, JSF, JSF implementations are beyond the scope of this document + </para> + </listitem> + </itemizedlist> + +</chapter> Added: trunk/docs/realworld_app_guide/en/src/main/resources/images/rw_its_start.png =================================================================== (Binary files differ) Property changes on: trunk/docs/realworld_app_guide/en/src/main/resources/images/rw_its_start.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/realworld_app_guide/pom.xml =================================================================== --- trunk/docs/realworld_app_guide/pom.xml (rev 0) +++ trunk/docs/realworld_app_guide/pom.xml 2009-01-12 11:41:40 UTC (rev 12207) @@ -0,0 +1,184 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <artifactId>docs</artifactId> + <groupId>org.richfaces</groupId> + <version>3.3.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>org.richfaces.docs</groupId> + <artifactId>realworld</artifactId> + <packaging>pom</packaging> + <version>3.3.0-SNAPSHOT</version> + <name>RichFaces Realworld application Guide</name> + <description>RichFaces Migration Guide from 3.1.* to 3.2.0 version</description> + <pluginRepositories> + <pluginRepository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>false</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + <id>repository.jboss.com</id> + <name>Jboss Repository for Maven</name> + <url>http://repository.jboss.com/maven2/</url> + <layout>default</layout> + </pluginRepository> + </pluginRepositories> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <executions> + <execution> + <id>unpack</id> + <phase>generate-resources</phase> + <goals> + <goal>unpack</goal> + </goals> + <configuration> + <artifactItems> + <artifactItem> + <groupId> + org.richfaces.docs.common-resources + </groupId> + <artifactId> + ${project.translation} + </artifactId> + <version> + ${project.version} + </version> + <type>jar</type> + <overWrite>true</overWrite> + <outputDirectory> + ${project.build.directory} + </outputDirectory> + </artifactItem> + </artifactItems> + <overWriteReleases> + false + </overWriteReleases> + <overWriteSnapshots> + true + </overWriteSnapshots> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + <executions> + <execution> + <id>jdocbook:generate</id> + <phase>compile</phase> + <goals> + <goal>generate</goal> + </goals> + </execution> + <execution> + <id>jdocbook:resources</id> + <phase>process-resources</phase> + <goals> + <goal>resources</goal> + </goals> + </execution> + <execution> + <id>jdocbook:bundle</id> + <phase>package</phase> + <goals> + <goal>bundle</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0-SNAPSHOT</version> + <type>jdocbook-style</type> + </dependency> + <dependency> + <groupId>org.richfaces.docs.common-resources</groupId> + <artifactId>${translation}</artifactId> + <version>${project.version}</version> + <type>jar</type> + </dependency> + </dependencies> + <configuration> + <sourceDirectory> + ${basedir}/src/main/docbook + </sourceDirectory> + <imageResource> + <directory> + ${basedir}/src/main/resources + </directory> + </imageResource> + <cssResource> + <directory> + ${project.build.directory}/common-resources + </directory> + </cssResource> + <sourceDocumentName>master.xml</sourceDocumentName> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>richfaces_migration_guide.pdf</finalName> + <imagePathSettingRequired>true</imagePathSettingRequired> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource> + ${xsl_html} + </stylesheetResource> + <finalName>index.html</finalName> + <imageCopyingRequired> + true + </imageCopyingRequired> + <imagePathSettingRequired> + false + </imagePathSettingRequired> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource> + ${xsl_html_single} + </stylesheetResource> + <imageCopyingRequired>true</imageCopyingRequired> + <imagePathSettingRequired>false</imagePathSettingRequired> + <finalName>index.html </finalName> + </format> + </formats> + <xincludeSupported>true</xincludeSupported> + <options> + <xincludeSupported>true</xincludeSupported> + <useRelativeImageUris> true </useRelativeImageUris> + <xmlTransformerType> saxon </xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> + <properties> + <masterTranslation>en</masterTranslation> + </properties> + + <modules> + <module>en</module> + </modules> + +</project> \ No newline at end of file