[richfaces-svn-commits] JBoss Rich Faces SVN: r2439 - trunk/docs/userguide/en/src/main/docbook/modules.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Aug 23 11:18:32 EDT 2007
Author: vkorluzhenko
Date: 2007-08-23 11:18:32 -0400 (Thu, 23 Aug 2007)
New Revision: 2439
Modified:
trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
http://jira.jboss.com/jira/browse/RF-621
http://jira.jboss.com/jira/browse/RF-622
http://jira.jboss.com/jira/browse/RF-656
keywords and content was changed according to the merging of two projects
Modified: trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-08-23 15:16:53 UTC (rev 2438)
+++ trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-08-23 15:18:32 UTC (rev 2439)
@@ -116,7 +116,12 @@
</tbody>
</tgroup>
- </table></para>
+ </table></para>
+
+ <note>
+ <title>Note:</title>
+ <para>org.richfaces.SKIN is used in the same way as org.ajax4jsf.SKIN</para>
+ </note>
<para><table>
<title>org.ajax4jsf.Filter Initialization Parameters</title>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml 2007-08-23 15:16:53 UTC (rev 2438)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml 2007-08-23 15:18:32 UTC (rev 2439)
@@ -12,8 +12,8 @@
</keywordset>
</chapterinfo>
<title>Getting Started with RichFaces</title>
- <section id="DownloadingAjax4jsf">
- <?dbhtml filename="DownloadingAjax4jsf.html" ?>
+ <section id="DownloadingRichFaces">
+ <?dbhtml filename="DownloadingRichFaces.html" ?>
<title>Downloading RichFaces 3.1.0</title>
<para>The latest release of <property>RichFaces</property> is available for download at:<simplelist>
<member>
@@ -27,50 +27,60 @@
<title>Installation</title>
<itemizedlist>
<listitem> Unzip <emphasis>
- <property>"ajax4jsf.zip"</property>
+ <property>"richfaces-ui-3.1.0-bin.zip"</property>
</emphasis> file to the chosen folder. </listitem>
<listitem> Copy <emphasis>
- <property>"ajax4jsf.jar"</property>
- </emphasis> and <emphasis>
- <property>"oscache-2.3.2.jar"</property>
- </emphasis> files into the <emphasis>
+ <property>"richfaces-api-3.1.0.jar"</property>
+ </emphasis>, <emphasis>
+ <property>"richfaces-impl-3.1.0.jar"</property>
+ </emphasis>,<emphasis>
+ <property>"richfaces-ui-3.1.0.jar"</property>
+ </emphasis>files into the <emphasis>
<property>"WEB-INF/lib"</property>
</emphasis> folder of your application. </listitem>
- <note>
+ <!--note>
<title>Note:</title>
<para>Starting from Ajax4jsf 1.1.1, the oscache library is not required to be in the
classpath anymore. </para>
- </note>
+ </note-->
<listitem> Add the following content into the <emphasis>
<property>"WEB-INF/web.xml"</property>
- </emphasis> file of your application: <programlisting role="XML"><![CDATA[<filter>
- <display-name>Ajax4jsf Filter</display-name>
- <filter-name>ajax4jsf</filter-name>
- <filter-class>org.ajax4jsf.Filter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>ajax4jsf</filter-name>
- <servlet-name>Faces Servlet</servlet-name>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- </filter-mapping>]]></programlisting>
- <note>
+ </emphasis> file of your application: <programlisting role="XML"><![CDATA[
+ <filter>
+ <display-name>RichFaces Filter</display-name>
+ <filter-name>richfaces</filter-name>
+ <filter-class>org.ajax4jsf.Filter</filter-class>
+ </filter>
+ <filter-mapping>
+ <filter-name>richfaces</filter-name>
+ <servlet-name>Faces Servlet</servlet-name>
+ <dispatcher>REQUEST</dispatcher>
+ <dispatcher>FORWARD</dispatcher>
+ <dispatcher>INCLUDE</dispatcher>
+ </filter-mapping>]]></programlisting>
+ <!--note>
<title>Note:</title>
<para>You can copy and paste the above text from the <emphasis>
<property>"README.txt"</property>
</emphasis> file.</para>
- </note>
+ </note-->
</listitem>
+
<listitem>
- <para>Add the following line for each JSP page of your application where you are going to
- bring in Ajax functionality.</para>
- <programlisting role="XML"> <![CDATA[<%@ taglib uri="https://ajax4jsf.dev.java.net/ajax" prefix="a4j"%>]]></programlisting>
+ <para>Add the following lines for each JSP page of your application.</para>
+ <programlisting role="XML"><![CDATA[<%@ taglib uri="http://richfaces.org/a4j" prefix="a4j"%>
+<%@ taglib uri="http://richfaces.org/rich" prefix="rich"%> ]]></programlisting>
<para>For XHTML pages:</para>
- <programlisting role="XML"><xmlns:a4j="https://ajax4jsf.dev.java.net/ajax"></programlisting>
+ <programlisting role="XML"><![CDATA[<xmlns:a4j="http://richfaces.org/a4j">
+<xmlns:a4j="http://richfaces.org/rich">]]></programlisting>
</listitem>
</itemizedlist>
+ <note>
+ <title>Note:</title>
+ <para>The previous URIs (https://ajax4jsf.dev.java.net/ajax and
+ http://richfaces.ajax4jsf.org/rich) are also available for backward compatibility.</para>
+ </note>
</section>
<section id="SimpleAJAXEchoProject">
<?dbhtml filename="SimpleAJAXEchoProject.html" ?>
@@ -91,7 +101,7 @@
<?dbhtml filename="JSPPage.html"?>
<title>JSP Page</title>
<para>Here is the necessary page (echo.jsp):</para>
- <programlisting role="JSP"> <![CDATA[<%@ taglib uri="https://ajax4jsf.dev.java.net/ajax" prefix="a4j"%>
+ <programlisting role="JSP"> <![CDATA[<%@ taglib uri="http://richfaces.org/a4j" prefix="a4j"%>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<html>
@@ -170,7 +180,7 @@
<para>
<note>
<title>Note:</title>
- <para>Nothing that relates directly to Ajax4jsf is required in the configuration
+ <para>Nothing that relates directly to RichFaces is required in the configuration
file.</para>
</note>
</para>
@@ -178,54 +188,49 @@
<section id="Web.xml">
<?dbhtml filename="Web.xml.html"?>
<title>Web.xml</title>
- <para>It is also necessary to add jar files (see <ulink
- url="GettingStartedWithAjax4jsf.html#Installation">installation chapter</ulink>) and
- modify the "web.xml" file: </para>
+ <para>It is also necessary to add jar files (see <link linkend="Installation"
+ >installation chapter</link>) and modify the "web.xml" file: </para>
<programlisting role="XML"> <![CDATA[<?xml version="1.0"?>
<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
- <display-name>a4jEchoText</display-name>
- <context-param>
+ <display-name>a4jEchoText</display-name>
+ <context-param>
<param-name>javax.faces.STATE_SAVING_METHOD</param-name>
<param-value>server</param-value>
- </context-param>
- <filter>
- <display-name>Ajax4jsf Filter</display-name>
- <filter-name>ajax4jsf</filter-name>
- <filter-class>org.ajax4jsf.Filter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>ajax4jsf</filter-name>
- <servlet-name>Faces Servlet</servlet-name>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- </filter-map>
- <listener>
- <listener-class>
- com.sun.faces.config.ConfigureListener
- </listener-class>
- </listener>
+ </context-param>
+ <filter>
+ <display-name>RichFaces Filter</display-name>
+ <filter-name>richfaces</filter-name>
+ <filter-class>org.ajax4jsf.Filter</filter-class>
+ </filter>
+ <filter-mapping>
+ <filter-name>richfaces</filter-name>
+ <servlet-name>Faces Servlet</servlet-name>
+ <dispatcher>REQUEST</dispatcher>
+ <dispatcher>FORWARD</dispatcher>
+ <dispatcher>INCLUDE</dispatcher>
+ </filter-map>
+ <listener>
+ <listener-class>com.sun.faces.config.ConfigureListener</listener-class>
+ </listener>
- <!-- Faces Servlet -->
- <servlet>
+ <!-- Faces Servlet -->
+ <servlet>
<servlet-name>Faces Servlet</servlet-name>
- <servlet-class>
- javax.faces.webapp.FacesServlet
- </servlet-class>
+ <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
<load-on-startup>1</load-on-startup>
- </servlet>
+ </servlet>
- <!-- Faces Servlet Mapping -->
- <servlet-mapping>
+ <!-- Faces Servlet Mapping -->
+ <servlet-mapping>
<servlet-name>Faces Servlet</servlet-name>
<url-pattern>*.jsf</url-pattern>
- </servlet-mapping>
- <login-config>
+ </servlet-mapping>
+ <login-config>
<auth-method>BASIC</auth-method>
- </login-config>
+ </login-config>
</web-app>]]></programlisting>
<para>Now your application should work.</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-08-23 15:16:53 UTC (rev 2438)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-08-23 15:18:32 UTC (rev 2439)
@@ -6,20 +6,18 @@
<keywordset>
<keyword>RichFaces</keyword>
- <keyword>Ajax4jsf</keyword>
+ <keyword>CSS</keyword>
- <keyword>CSS</keyword>
-
<keyword>skin</keyword>
</keywordset>
</chapterinfo>
-<title>Basic concepts of the Ajax4jsf Framework</title>
+<title>Basic concepts of the RichFaces Framework</title>
<section id="introToBasics">
<?dbhtml filename="introToBasics.html"?>
<title>Introduction</title>
<para>The framework is implemented as a component library which adds Ajax capability into existing
pages, so you don't need to write any JavaScript code or to replace existing
- components with new Ajax widgets. <property>Ajax4jsf</property> enables page-wide Ajax support instead of the
+ components with new Ajax widgets. <property>RichFaces</property> enables page-wide Ajax support instead of the
traditional component-wide support. So, you can define the event on the page that
invokes an Ajax request and the areas of the page that should be synchronized with the JSF
Component Tree after the Ajax request changes the data on the server according to the
@@ -33,15 +31,15 @@
<imagedata fileref="images/newpic1.jpg"/>
</imageobject>
</mediaobject>
- <para><property>Ajax4jsf</property> allows to define (by means of JSF tags) different parts of a JSF page you
+ <para><property>RichFaces</property> allows to define (by means of JSF tags) different parts of a JSF page you
wish to update with an Ajax request and provide a few options to send Ajax requests to
the server. Also JSF page doesn't change from a "regular" JSF
page and you don't need to write any JavaScript or XMLHttpRequest objects by hands, everything is done automatically.</para>
</section>
- <section id="Ajax4jsfArchitectureOverview">
- <?dbhtml filename="Ajax4jsfArchitectureOverview.html"?>
- <title>Ajax4jsf Architecture Overview</title>
- <para>Next figure lists several important elements of the <property>Ajax4jsf</property> framework</para>
+ <section id="RichFacesArchitectureOverview">
+ <?dbhtml filename="RichFacesArchitectureOverview.html"?>
+ <title>RichFaces Architecture Overview</title>
+ <para>Next figure lists several important elements of the <property>RichFaces</property> framework</para>
<figure>
<title>Core Ajax component structure</title>
</figure>
@@ -52,7 +50,7 @@
</mediaobject>
<formalpara>
<title>Ajax Filter.</title>
- <para>To get all benefits of <property>Ajax4jsf</property>, you should register an Ajax Filter in web.xml
+ <para>To get all benefits of <property>RichFaces</property>, you should register an Ajax Filter in web.xml
file of your application.The Ajax Filter recognizes multiple request types. The sequence diagram on Figure 3
shows the difference in processing of a "regular" JSF request and an Ajax request.</para>
</formalpara>
@@ -101,7 +99,7 @@
</formalpara>
<formalpara>
<title>JavaScript Engine</title>
- <para><property> Ajax4jsf</property> JavaScript Engine runs on the client-side. It knows how to update different areas
+ <para><property>RichFaces</property> JavaScript Engine runs on the client-side. It knows how to update different areas
on your JSF page based on the information from the Ajax response. Do
not use this JavaScript code directly, as it is available automatically.
</para>
@@ -110,7 +108,7 @@
<section id="LimitationsAndRules">
<?dbhtml filename="LimitationAndRules.html"?>
<title>Limitations and Rules</title>
- <para>In order to create AJAX4JSF applications properly, keep the following points in mind:</para>
+ <para>In order to create RichFaces applications properly, keep the following points in mind:</para>
<itemizedlist>
<listitem>
The Ajax framework should not append or delete, but only replace elements on the page. For successful updates, an element with the same ID as in the response must exist on the page. If you'd like to append any code to a page, put in a placeholder for it (any empty element). For the same reason, it's recommended to place messages in the<emphasis >
@@ -247,7 +245,7 @@
value of the transientFlag of JSF components. If the value of this flag is true, the
component must not participate in state saving or restoring of process.
</para>
- <para>In order to provide a solution to this kind of problems, Ajax4jsf uses the concept of
+ <para>In order to provide a solution to this kind of problems, RichFaces uses the concept of
an output panel that is defined by the <emphasis role="bold">
<property><a4j:outputPanel></property>
</emphasis> tag. If you put a <emphasis role="bold"><property><f:verbatim></property></emphasis>
@@ -270,7 +268,7 @@
<section id="RequestErrorsAndSessionExpirationHandling">
<?dbhtml filename="RequestErrorsAndSessionExpirationHandling.html"?>
<title>Request Errors and Session Expiration Handling</title>
- <para>Ajax4jsf allows to redefine standard handlers responsible for processing of different exceptional situations. It helps to define own JavaScript, which is executed when this situations occur.</para>
+ <para>RichFaces allows to redefine standard handlers responsible for processing of different exceptional situations. It helps to define own JavaScript, which is executed when this situations occur.</para>
<section id="RequestErrorsHandling">
<?dbhtml filename="RequestErrorsHandling.html"?>
<title>Request Errors Handling</title>
@@ -289,7 +287,7 @@
<section id="SessionExpiredHandling">
<?dbhtml filename="SessionExpiredHandling.html"?>
<title>Session Expired Handling</title>
- <para>Beginning with Ajax4jsf version 1.0.5 it's possible to redefine also the <emphasis >
+ <para>It's possible to redefine also the <emphasis >
<property>"onExpired"</property>
</emphasis> framework method that is called on the <emphasis >
<property>"Session Expiration"</property>
@@ -310,17 +308,17 @@
<property>"Session Expiration"</property>
</emphasis>event.</listitem>
</itemizedlist>
-<note>
+<!--note>
<title>Note:</title>
Until the version 1.0.5 the method can't be redefined on <emphasis >
<property>"Session Expiration"</property>,
</emphasis> a confirmation dialog with a request for view reloading was always called.
-</note>
+</note-->
</section>
</section>
-&FAQ;
+
<section>
<title>Skinnability</title>
@@ -350,7 +348,7 @@
contains the same values repeated numerous times.</para>
<para>These problems can be solved with the
- <property>skinnability</property> system built into the Ajax4jsf project
+ <property>skinnability</property> system built into theRichFaces project
and realized fully in RichFaces. Every named skin has some
skin-parameters for the definition of a palette and the other parameters
of the user interface. By changing just a few parameters, you can alter
@@ -376,7 +374,7 @@
<itemizedlist>
<listitem>
- <para>Skin parameters defined in the Ajax4jsf framework</para>
+ <para>Skin parameters defined in the RichFaces framework</para>
</listitem>
<listitem>
@@ -497,10 +495,10 @@
</div></programlisting>
</section>
- <section id="SkinParametersTablesInAjax4jsf">
- <?dbhtml filename="SkinParametersTablesInAjax4jsf.html"?>
+ <section id="SkinParametersTablesInRichFaces">
+ <?dbhtml filename="SkinParametersTablesInRichFaces.html"?>
- <title>Skin Parameters Tables in Ajax4jsf</title>
+ <title>Skin Parameters Tables in RichFaces</title>
<para>RichFaces provides eight predefined skin parameters (skins) at the
simplest level of common customization:</para>
@@ -544,7 +542,7 @@
</itemizedlist>
<para>To plug one in, it's necessary to specify a skin name in the
- <emphasis ><property>"org.ajax4jsf.SKIN"</property></emphasis> context-param.</para>
+ <emphasis ><property>"org.richfaces.SKIN"</property></emphasis> context-param.</para>
<para>Here is an example of a table with values for one of the main
skins, <property>"blueSky"</property>.</para>
@@ -819,7 +817,7 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><context-param>
- <param-name>org.ajax4jsf.SKIN</param-name>
+ <param-name>org.richfaces.SKIN</param-name>
<param-value>name</param-value>
</context-param></programlisting>
</listitem>
@@ -831,8 +829,8 @@
</itemizedlist>
</section>
<section>
-<title>Built-in skinnability in Ajax4jsf</title>
- <para>Ajax4jsf gives an opportunity to incorporate <property>skinnability</property> into UI
+<title>Built-in skinnability in RichFaces</title>
+ <para>RichFaces gives an opportunity to incorporate <property>skinnability</property> into UI
design. With this framework you can easily use named skin parameters in
properties files to control the appearance of the skins that are applied
consistently to a whole set of components. You can look at examples of
@@ -844,8 +842,8 @@
</simplelist>
<para>
You may simply control the look-and-feel of your application by using the <property>skinnability</property> service
- of the Ajax4jsf framework. With the means of this service you can define the same style for rendering
- standard JSF components and custom JSF components built with the help of Ajax4jsf.
+ of the RichFaces framework. With the means of this service you can define the same style for rendering
+ standard JSF components and custom JSF components built with the help of RichFaces.
</para>
<para>To find out more on <property>skinnability</property> possibilities, follow these
steps:</para>
@@ -899,10 +897,10 @@
</section>
-<section id="OtherRelevantResources">
+<!--section id="OtherRelevantResources">
<title>Other Relevant Resources</title>
<para><ulink url="http://jsf.javabeat.net/articles/2007/06/introduction-to-ajax4jsf/">Introduction to Ajax4Jsf</ulink> by Shunmuga Raja</para>
-</section>
+</section-->
</chapter>
\ No newline at end of file
More information about the richfaces-svn-commits
mailing list