Author: SeanRogers Date: 2010-02-05 00:51:52 -0500 (Fri, 05 Feb 2010) New Revision: 16420 Modified: root/docs/trunk/Component_Development_Kit_Guide/en-US/Book_Info.xml root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.ent root/docs/trunk/Component_Reference/en-US/Book_Info.xml root/docs/trunk/Component_Reference/en-US/Component_Reference.ent root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Introduction.xml root/docs/trunk/Developer_Guide/en-US/Author_Group.xml root/docs/trunk/Developer_Guide/en-US/Book_Info.xml root/docs/trunk/Developer_Guide/en-US/Developer_Guide.ent root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml root/docs/trunk/Developer_Guide/en-US/Preface.xml root/docs/trunk/Developer_Guide/en-US/Revision_History.xml root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Advanced_features.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Basic_concepts.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Skinning_and_theming.xml root/docs/trunk/Developer_Guide/en-US/fallback_content/Conventions.xml root/docs/trunk/Developer_Guide/en-US/fallback_content/Feedback.xml root/docs/trunk/Developer_Guide/en-US/fallback_content/Legal_Notice.xml root/docs/trunk/Developer_Guide/publican.cfg root/docs/trunk/Migration_Guide/en-US/Book_Info.xml root/docs/trunk/Migration_Guide/en-US/Migration_Guide.ent Log: Worked on Developer Guide Modified: root/docs/trunk/Component_Development_Kit_Guide/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Component_Development_Kit_Guide/en-US/Book_Info.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Component_Development_Kit_Guide/en-US/Book_Info.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -6,7 +6,7 @@ <bookinfo id="book-Component_Development_Kit_Guide-Component_Development_Kit_Guide"> <title>Component Development Kit Guide</title> - <subtitle>Developing custom components for use in RichFaces &VERSION_LONG;<remark> (draft)</remark> + <subtitle>Developing custom components for use in RichFaces &VERSIONLONG;<remark> (draft)</remark> projects</subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> Modified: root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.ent =================================================================== --- root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.ent 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Component_Development_Kit_Guide/en-US/Component_Development_Kit_Guide.ent 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,6 +1,6 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Component_Development_Kit_Guide"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: root/docs/trunk/Component_Reference/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Component_Reference/en-US/Book_Info.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -3,7 +3,7 @@ ]> <bookinfo id="book-Component_Reference-Component_Reference"> <title>Component Reference</title> - <subtitle>A reference guide to the components of the RichFaces &VERSION_LONG;<remark> (draft)</remark> + <subtitle>A reference guide to the components of the RichFaces &VERSIONLONG;<remark> (draft)</remark> framework</subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> Modified: root/docs/trunk/Component_Reference/en-US/Component_Reference.ent =================================================================== --- root/docs/trunk/Component_Reference/en-US/Component_Reference.ent 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Component_Reference/en-US/Component_Reference.ent 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,6 +1,6 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Component_Reference"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Introduction.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Introduction.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Introduction.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -12,7 +12,7 @@ <section id="sect-Component_Reference-Introduction-Libraries"> <title>Libraries</title> <para> - The RichFaces framework as it now stands is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents Ajax4jsf, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don't require additional configuration in order to send requests or update. + The RichFaces framework is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents Ajax4jsf, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don't require additional configuration in order to send requests or update. </para> <note> <title>Ajax support</title> Modified: root/docs/trunk/Developer_Guide/en-US/Author_Group.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Author_Group.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Author_Group.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <authorgroup> <author> <firstname>Sean</firstname> Modified: root/docs/trunk/Developer_Guide/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Book_Info.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Book_Info.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,27 +1,26 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <bookinfo id="book-Developer_Guide-Developer_Guide"> <title>Developer Guide</title> - <subtitle>Developing projects using RichFaces &VERSION_LONG;<remark> (draft)</remark> + <subtitle>Developing projects using RichFaces &VERSIONLONG;<remark> (draft)</remark> </subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> <edition>0</edition> <pubsnumber>1</pubsnumber> <abstract> - <para>Read this book for a comprehensive guide to getting started and + <para> +Read this book for a comprehensive guide to getting started and working with RichFaces &VERSION;. It includes details of the -architecture, the framework&#39;s use in different applications, -and skinning implementations.</para> +architecture, the framework's use in different applications, +and skinning implementations. +</para> </abstract> <corpauthor> <inlinemediaobject> <imageobject> - <imagedata fileref="./images/rf_logo.png" format="PNG" /> + <imagedata fileref="./images/rf_logo.png" format="PNG" width="444" /> </imageobject> <textobject> <phrase>Logo</phrase> @@ -32,14 +31,9 @@ <year>&YEAR;</year> <holder>&HOLDER;</holder> </copyright> - - <!--FOR PUBLICAN --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Legal_Notice.xml"> - <!--FOR JDOCBOOK:--> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> + <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> </xi:include> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </bookinfo> - + Modified: root/docs/trunk/Developer_Guide/en-US/Developer_Guide.ent =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Developer_Guide.ent 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Developer_Guide.ent 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,6 +1,6 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Developer_Guide"> <!ENTITY HOLDER "Red Hat"> <!ENTITY YEAR "2009"> Modified: root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,19 +1,15 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <book status="draft"> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <!--<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... - <xi:include href="chap-Developer_Guide-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="chap-Developer_Guide-Getting_started_with_RichFaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="chap-Developer_Guide-RichFaces_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="chap-Developer_Guide-Basic_concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="chap-Developer_Guide-Advanced_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="chap-Developer_Guide-Skinning_and_theming.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="appe-Developer_Guide-Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> --><xi:include href="chap-Developer_Guide-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Developer_Guide-Getting_started_with_RichFaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Developer_Guide-RichFaces_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Developer_Guide-Basic_concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Developer_Guide-Advanced_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Developer_Guide-Skinning_and_theming.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="appe-Developer_Guide-Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> Modified: root/docs/trunk/Developer_Guide/en-US/Preface.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Preface.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Preface.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,28 +1,15 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <preface id="pref-Developer_Guide-Preface"> <title>Preface</title> - <!--FOR JDOCBOOK--> - <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <!--FOR PUBLICAN--> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> + <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> </xi:include> - - <!--PUBLICAN'S ORIGINAL XINCLUDES--> - <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> - <!--FOR JDOCBOOK--> - <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> - <xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include> - </xi:fallback> + <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> </xi:include> + </xi:fallback> + </xi:include> </preface> + Modified: root/docs/trunk/Developer_Guide/en-US/Revision_History.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Revision_History.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/Revision_History.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <appendix id="appe-Developer_Guide-Revision_History"> <title>Revision History</title> <simpara> Modified: root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <appendix id="appe-Developer_Guide-Resources"> <title>Resources</title> <para> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Advanced_features.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Advanced_features.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Advanced_features.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-Advanced_features"> <title>Advanced features</title> <para> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Basic_concepts.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Basic_concepts.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Basic_concepts.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-Basic_concepts"> <title>Basic concepts</title> <para> @@ -12,36 +9,78 @@ <section id="sect-Developer_Guide-Basic_concepts-Sending_an_Ajax_request"> <title>Sending an Ajax request</title> <para> - Incomplete + Many of the tags in the <classname>a4j</classname> and <classname>rich</classname> tag libraries are capable of sending Ajax requests from a JavaServer Faces (JSF) page. RichFaces tags hide the usual JavaScript activities that are required for an XMHTTPRequest object building and an Ajax request sending. Additionally the tags can determine which components of a JSF page are to be re-rendered as a result of the Ajax response; refer to <xref linkend="sect-Developer_Guide-Basic_concepts-Partial_page_updates" /> for details. </para> + <itemizedlist> + <listitem> + <para> + The <sgmltag>&lt;a4j:commandButton&gt;</sgmltag> and <sgmltag>&lt;a4j:commandLink&gt;</sgmltag> tags are used to send an Ajax request on the <varname>onclick</varname> JavaScript event. + </para> + </listitem> + <listitem> + <para> + The <sgmltag>&lt;a4j:poll&gt;</sgmltag> tag is used to send an Ajax request periodically using a timer. + </para> + </listitem> + <listitem> + <para> + The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> tag allows you to add Ajax functionality to standard JSF components and send Ajax request on a chosen JavaScript event, such as <varname>onkeyup</varname> or <varname>onmouseover</varname>, for example. + </para> + </listitem> + <listitem> + <para> + Most components in the <lassname>rich</lassname> tag library have built-in Ajax support. Refer to the <citetitle>RichFaces Component Reference</citetitle> for details on the use of each component. + </para> + </listitem> + </itemizedlist> + </section> <section id="sect-Developer_Guide-Basic_concepts-Receiving_events_and_updates"> <title>Receiving events and updates</title> <para> - Incomplete + If no specific regions are specified, the whole page is updated when an Ajax response is received. </para> + <note> + <title>Rendering outside the active region</title> + <para> + If the content of an Ajax response needs to be rendered outside the active region, then the value of the <varname>renderRegionOnly</varname> attribute should be set to <literal>false</literal>. Otherwise, your Ajax updates are limited to elements of the active region. If not defined, the default setting is <code>renderRegionOnly="false"</code>. + </para> + </note> + + <section id="sect-Developer_Guide-Basic_concepts-Partial_page_updates"> + <title>Partial page updates</title> + <para> + Specific regions of a page can be defined through the use of container components such as <sgmltag>&lt;a4j:region&gt;</sgmltag>. These regions can then be specified with their <varname>id</varname> identifiers in the <varname>render</varname> attribute of a component so that when the component sends an Ajax request, only the specified regions are updated. In this way you can control which part of the JSF View is decoded on the server side when the Ajax request is sent. Multiple regions can be defined and sent, and regions can be nested inside other regions. + </para> + <para> + Additionally, regions can be wrapped with the <sgmltag>&lt;a4j:outputPanel ajaxRendered="true"&gt;</sgmltag> tag. This causes all contents of the region to be updated on every Ajax response, even if not explicitly listed in the requesting component's <varname>render</varname> attribute. + </para> + <para> + Setting the <varname>limitRender</varname> attribute to <literal>true</literal> will cause <emphasis>only</emphasis> those regions listed in the requesting component's <varname>render</varname> attribute to be updated. This overrides any regions with the <sgmltag>&lt;a4j:outputPanel ajaxRendered="true"&gt;</sgmltag> tag. + </para> + <para> + Refer to the <citetitle>RichFaces Component Reference</citetitle> for further details on the common Ajax attributes used for partial page updates. + </para> + </section> + </section> - <section id="sect-Developer_Guide-Basic_concepts-Ajax_attributes"> - <title>Ajax attributes</title> + <section id="sect-Developer_Guide-Basic_concepts-Processing_data_on_the_server"> + <title>Processing data on the server</title> <para> - Incomplete + Use the <varname>process</varname> attribute to list the <varname>id</varname> identifiers of components that need to be processed together with a requesting component. This can be useful if more than one component needs to be processed, but not the entire view. Alternatively if only one component needs to be processed instead of the entire view, <code>process="@this"</code> can be specified. </para> </section> - <section id="sect-Developer_Guide-Basic_concepts-Ajax_containers"> - <title>Ajax containers</title> - <para> - Incomplete - </para> - </section> - <section id="sect-Developer_Guide-Basic_concepts-Component_overview"> <title>Component overview</title> <para> - Incomplete + The RichFaces framework is made up of two tag libraries: the <classname>a4j</classname> library and the <classname>rich</classname> library. The <classname>a4j</classname> tag library represents <emphasis>Ajax4jsf</emphasis>, which provides page-level Ajax support with core Ajax components. This allows developers to make use of custom Ajax behavior with existing components. The <classname>rich</classname> tag library provides Ajax support at the component level instead, and includes ready-made, self-contained components. These components don't require additional configuration in order to send requests or update. </para> + <para> + For details on the use of the various components, refer to <citetitle>RichFaces Component Reference</citetitle>. + </para> </section> </chapter> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,24 +1,21 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-Getting_started_with_RichFaces"> <title>Getting started with RichFaces</title> <para> - Follow the instructions in this chapter to install and configure RichFaces for development. If you have existing projects that use an previous version of RichFaces, refer to the <citetitle>RichFaces 4.0 Migration Guide</citetitle>. + Follow the instructions in this chapter to install and configure RichFaces for development. If you have existing projects that use an previous version of RichFaces, refer to the <citetitle>RichFaces Migration Guide</citetitle>. </para> <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Technical_Requirements"> <title>Technical Requirements</title> <para> - RichFaces has been developed with an open architecture to be compatible with a wide variety of environments. In addition to the RichFaces framework, you need the following frameworks, environments, and applications installed on your computer to start developing with RichFaces: + RichFaces has been developed with an open architecture to be compatible with a wide variety of environments. In addition to the RichFaces framework, you need the following frameworks, environments, and applications installed on your computer to start developing with RichFaces: <variablelist> <varlistentry> <term>Java Development Kit (<acronym>JDK</acronym>)</term> <listitem> <para> - RichFaces supports the following JDK versions: + RichFaces supports the following JDK versions: <itemizedlist> <listitem> <para> @@ -33,7 +30,7 @@ <term>JavaServer Faces (<acronym>JSF</acronym>)</term> <listitem> <para> - RichFaces supports the following JSF implementations and frameworks: + RichFaces supports the following JSF implementations and frameworks: <itemizedlist> <listitem> <para> @@ -63,7 +60,7 @@ <term>A Java application server or servlet container</term> <listitem> <para> - RichFaces supports the following servers: + RichFaces supports the following servers: <itemizedlist> <listitem> <para> @@ -118,8 +115,8 @@ <term>A web browser</term> <listitem> <para> - RichFaces supports the following web browsers: - <itemizedlist> + RichFaces supports the following web browsers: + <itemizedlist id="item-Developer_Guide-Technical_Requirements-Linux_environments"> <title>Linux environments</title> <listitem> <para> @@ -137,7 +134,7 @@ </para> </listitem> </itemizedlist> - <itemizedlist> + <itemizedlist id="item-Developer_Guide-Technical_Requirements-Mac_OS_environments"> <title>Mac OS environments</title> <listitem> <para> @@ -155,7 +152,7 @@ </para> </listitem> </itemizedlist> - <itemizedlist> + <itemizedlist id="item-Developer_Guide-Technical_Requirements-Microsoft_Windows_environments"> <title>Microsoft Windows environments</title> <listitem> <para> @@ -195,7 +192,7 @@ <para> Follow the instructions in this section to install the RichFaces framework on your computer. </para> - <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Downloading_RichFaces"> + <section id="sect-Developer_Guide-Installing_RichFaces-Downloading_RichFaces"> <title>Downloading RichFaces</title> <para> Download RichFaces from the JBoss RichFaces Downloads area at <ulink url="http://www.jboss.org/richfaces/download.html">http://ww...;. The binary files (available in <filename class="extension">.bin.zip</filename> or <filename class="extension">.bin.tar.gz</filename> archives) contain a compiled, ready-to-use version of RichFaces with a set of basic skins. @@ -203,14 +200,15 @@ <para> Create a new directory named <filename>RichFaces</filename>, then unzip the archive containing the binaries there. </para> - <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Compiling_the_source"> + <section id="sect-Developer_Guide-Downloading_RichFaces-Compiling_the_source"> <title>Compiling the source</title> <para> Instead of downloading the pre-compiled binaries, you can download the source files and compile them yourself. Download the source files (also available in <filename class="extension">.bin.zip</filename> or <filename class="extension">.bin.tar.gz</filename> archives) from the JBoss RichFaces Downloads area at <ulink url="http://www.jboss.org/richfaces/download.html">http://ww...;. </para> </section> + </section> - + </section> <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project"> @@ -219,13 +217,13 @@ Follow the procedure in this section to create a new RichFaces application with <application>JBoss Tools</application>. </para> <procedure> - <step> + <step id="step-Developer_Guide-Creating_a_project-Create_a_new_project"> <title>Create a new project</title> <para> - In <application>JBoss Tools</application>, select <menuchoice><guimenu>File</guimenu><guimenu>New</guimenu><guimenuitem>JSF Project</guimenuitem></menuchoice> from the menu. Name the project, select <guilabel>JSF 2</guilabel> from the <guilabel>JSF Environment</guilabel> drop-down box, and click the <guibutton>Finish</guibutton> button to create the project. + In <application>JBoss Tools</application>, select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem><guimenuitem>JSF Project</guimenuitem></menuchoice> from the menu. Name the project, select <guilabel>JSF 2</guilabel> from the <guilabel>JSF Environment</guilabel> drop-down box, and click the <guibutton>Finish</guibutton> button to create the project. </para> </step> - <step> + <step id="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project"> <title>Add the RichFaces libraries to the project</title> <para> Add <filename>core-ui.jar</filename>, <filename>richfaces-api.jar</filename>, and <filename>richfaces-impl.jar</filename> into your project by dragging them from the location where you unzipped the RichFaces archive to the <filename>WebContent/WEB-INF/lib/</filename> directory of your project in <application>JBoss Tools</application>. @@ -233,7 +231,7 @@ <note> <title>Other required libraries</title> <para> - RichFaces also requires the following libraries to be referenced in your project. Typically they are already included when creating a JSF project in <application>JBoss Tools</application>. + RichFaces also requires the following libraries to be referenced in your project. Typically they are already included when creating a JSF project in <application>JBoss Tools</application>. <itemizedlist> <listitem> <para> @@ -264,13 +262,16 @@ </para> </note> </step> - <step> + <step id="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries"> <title>Reference the tag libraries</title> - <para>The RichFaces tag libraries need to be referenced on each JSP and XHTML page in your project.</para> + <para> + The RichFaces tag libraries need to be referenced on each JSP and XHTML page in your project. + </para> <variablelist> <varlistentry> <term>Referencing in JSP pages</term> <listitem> + <programlisting language="XML" role="XML">&lt;%@ taglib uri="http://richfaces.org/a4j" prefix="a4j"%&gt; &lt;%@ taglib uri="http://richfaces.org/rich" prefix="rich"%&gt; </programlisting> @@ -279,6 +280,7 @@ <varlistentry> <term>Referencing in XHTML pages</term> <listitem> + <programlisting language="XML" role="XML">&lt;ui:composition xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:a4j="http://richfaces.org/a4j" @@ -291,10 +293,249 @@ </variablelist> </step> </procedure> + <para> - You are now ready to begin building your RichFaces applications. + You are now ready to begin constructing your RichFaces applications. </para> </section> + + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Using_RichFaces_with_Maven"> + <title>Using RichFaces with Maven</title> + <para> + Maven is a build automation and project management tool for Java projects. Follow the instructions in this section to integrate RichFaces into a Maven project. + </para> + <procedure> + <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories"> + <title>Add required repositories</title> + <para> + A structure for the Maven project with minimal content can be created with the Maven archetype named <filename>maven-archetype-jsfwebapp</filename> included as part of the RichFaces Component Development Kit (<acronym>CDK</acronym>). The archetype and the project itself require extra repositories to be provided, namely <filename>http://snapshots.jboss.org/maven2/</filename> and <filename>http://repository.jboss.com/maven2/</filename>;. To make the repositories accessible to Maven, add a profile in the <filename>maven_installation_folder/conf/settings.xml</filename> file under the <sgmltag>&lt;profiles&gt;</sgmltag> element: +<programlisting language="XML" role="XML">&lt;profiles&gt; + &lt;profile&gt; + &lt;id&gt;jsf-app-profile&lt;/id&gt; + &lt;repositories&gt; + &lt;repository&gt; + &lt;releases&gt; + &lt;enabled&gt;true&lt;/enabled&gt; + &lt;/releases&gt; + &lt;snapshots&gt; + &lt;enabled&gt;true&lt;/enabled&gt; + &lt;updatePolicy&gt;always&lt;/updatePolicy&gt; + &lt;/snapshots&gt; + &lt;id&gt;snapshots.jboss.org&lt;/id&gt; + &lt;name&gt;Snapshot Jboss Repository for Maven&lt;/name&gt; + &lt;url&gt;http://snapshots.jboss.org/maven2/&lt;/url&gt; + &lt;layout&gt;default&lt;/layout&gt; + &lt;/repository&gt; + &lt;repository&gt; + &lt;releases&gt; + &lt;enabled&gt;true&lt;/enabled&gt; + &lt;/releases&gt; + &lt;snapshots&gt; + &lt;enabled&gt;true&lt;/enabled&gt; + &lt;updatePolicy&gt;always&lt;/updatePolicy&gt; + &lt;/snapshots&gt; + &lt;id&gt;repository.jboss.com&lt;/id&gt; + &lt;name&gt;Jboss Repository for Maven&lt;/name&gt; + &lt;url&gt;http://repository.jboss.com/maven2/&lt;/url&gt; + &lt;layout&gt;default&lt;/layout&gt; + &lt;/repository&gt; + &lt;/repositories&gt; + &lt;/profile&gt; + ... +&lt;/profiles&gt; +</programlisting> + </para> + <para> + The profile then needs to be activated in the <sgmltag>&lt;activeProfiles&gt;</sgmltag> element: +<programlisting language="XML" role="XML">&lt;activeProfiles&gt; + &lt;activeProfile&gt;jsf-app-profile&lt;/activeProfile&gt; +&lt;/activeProfiles&gt; +</programlisting> + </para> + </step> + <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Generate_project_from_archetype"> + <title>Generate project from archetype</title> + <para> + The project can now be generated with the <filename>maven-archetype-jsfwebapp</filename> archetype. Create a new directory for your project, then run the following Maven command: +<screen> +mvn archetype:generate -DarchetypeGroupId=org.richfaces.cdk -DarchetypeArtifactId=maven-archetype-jsfwebapp -DarchetypeVersion=4.0.0-SNAPSHOT -DgroupId=<replaceable>org.docs.richfaces</replaceable> -DartifactId=<replaceable>jsf-app</replaceable> +</screen> + </para> + <para> + The following parameters can be used to customize your project: + <variablelist> + <varlistentry> + <term><command>-DgroupId</command></term> + <listitem> + <para> + Defines the package for the Managed Beans + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>-DartifactId</command></term> + <listitem> + <para> + Defines the name of the project + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + The command generates a JSF project with the following structure: +<screen><replaceable>jsf-app</replaceable> +├── pom.xml +└── src + ├── main + │ ├── java + │ │ └── org + │ │ └── docs + │ │ └── richfaces + │ │ └── Bean.java + │ ├── resources + │ └── webapp + │ ├── WEB-INF + │ │ ├── faces-config.xml + │ │ └── web.xml + │ ├── index.jsp + │ └── pages + │ ├── index.jsp + │ └── index.xhtml + └── test + └── java + └── org + └── docs + └── richfaces + └── BeanTest.java +</screen> + </para> + </step> + <step> + <title></title> + <para> + The <filename>jsf-app</filename> directory contains a project descriptor file, <filename>pom.xml</filename>. To add RichFaces libraries to your project, edit the project descriptor to add dependencies to the <sgmltag>&lt;dependencies&gt;</sgmltag> element as follows: +<programlisting language="XML" role="XML">&lt;dependencies&gt; + &lt;dependency&gt; + &lt;groupId&gt;junit&lt;/groupId&gt; + &lt;artifactId&gt;junit&lt;/artifactId&gt; + &lt;version&gt;3.8.1&lt;/version&gt; + &lt;scope&gt;test&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.servlet&lt;/groupId&gt; + &lt;artifactId&gt;servlet-api&lt;/artifactId&gt; + &lt;version&gt;2.4&lt;/version&gt; + &lt;scope&gt;provided&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.servlet&lt;/groupId&gt; + &lt;artifactId&gt;jsp-api&lt;/artifactId&gt; + &lt;version&gt;2.0&lt;/version&gt; + &lt;scope&gt;provided&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;jstl&lt;/groupId&gt; + &lt;artifactId&gt;jstl&lt;/artifactId&gt; + &lt;version&gt;1.1.2&lt;/version&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.servlet.jsp&lt;/groupId&gt; + &lt;artifactId&gt;jsp-api&lt;/artifactId&gt; + &lt;version&gt;2.1&lt;/version&gt; + &lt;scope&gt;provided&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.faces&lt;/groupId&gt; + &lt;artifactId&gt;jsf-api&lt;/artifactId&gt; + &lt;version&gt;1.2_12&lt;/version&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.faces&lt;/groupId&gt; + &lt;artifactId&gt;jsf-impl&lt;/artifactId&gt; + &lt;version&gt;1.2_12&lt;/version&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.el&lt;/groupId&gt; + &lt;artifactId&gt;el-api&lt;/artifactId&gt; + &lt;version&gt;1.0&lt;/version&gt; + &lt;scope&gt;provided&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;el-impl&lt;/groupId&gt; + &lt;artifactId&gt;el-impl&lt;/artifactId&gt; + &lt;version&gt;1.0&lt;/version&gt; + &lt;scope&gt;provided&lt;/scope&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;javax.annotation&lt;/groupId&gt; + &lt;artifactId&gt;jsr250-api&lt;/artifactId&gt; + &lt;version&gt;1.0&lt;/version&gt; + &lt;/dependency&gt; + &lt;!-- RichFaces libraries --&gt; + &lt;dependency&gt; + &lt;groupId&gt;org.richfaces.framework&lt;/groupId&gt; + &lt;artifactId&gt;richfaces-api&lt;/artifactId&gt; + &lt;version&gt;3.3.3-SNAPSHOT&lt;/version&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;org.richfaces.framework&lt;/groupId&gt; + &lt;artifactId&gt;richfaces-impl&lt;/artifactId&gt; + &lt;version&gt;3.3.3-SNAPSHOT&lt;/version&gt; + &lt;/dependency&gt; + &lt;dependency&gt; + &lt;groupId&gt;org.richfaces.ui&lt;/groupId&gt; + &lt;artifactId&gt;richfaces-ui&lt;/artifactId&gt; + &lt;version&gt;3.3.3-SNAPSHOT&lt;/version&gt; + &lt;/dependency&gt; +&lt;/dependencies&gt; +</programlisting> + </para> + </step> + <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Build_the_project"> + <title>Build the project</title> + <stepalternatives> + <step id="step-Developer_Guide-Build_the_project-Standard_building"> + <title>Standard building</title> + <para> + Build the project from the command line by entering the <command>mvn install</command> command. + </para> + <para> + The <computeroutput>BUILD SUCCESSFUL</computeroutput> message indicates the project has been assembled and is ready to import into an IDE (integrated development environment) and run on a server. + </para> + </step> + <step id="step-Developer_Guide-Build_the_project-Building_for_Eclipse_and_JBoss_Tools"> + <title>Building for <program>Eclipse</program> and <program>JBoss Tools</program></title> + <para> + To build the project for <program>Eclipse</program> and <program>JBoss Tools</program>, enter the following command at the command line: +<screen>mvn eclipse:eclipse -Dwtpversion=2.0 +</screen> + </para> + <para> + The <computeroutput>BUILD SUCCESSFUL</computeroutput> message indicates the project has been assembled and is ready to import into <program>Eclipse</program>. + </para> + </step> + </stepalternatives> + </step> + <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_tag_library_references"> + <title>Add tag library references</title> + <para> + After importing, edit the <filename><replaceable>jsf-app</replaceable>/src/main/webapp/pages/index.jsp</filename> file to include the tag library declaration as described in <xref linkend="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries" /> + </para> + </step> + </procedure> + + <para> + Your project is now ready to use. Once components and functionality have been added, you can run the application on a server and access it through a web browser at the address <filename>http://localhost:8080/<replaceable>jsf-app</replaceable>/</filename>. + </para> + </section> + + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Using_RichFaces_in_existing_JSF2_projects"> + <title>Using RichFaces in existing JSF2 projects</title> + <para> + RichFaces can be added to existing JSF2 projects by adding references to the RichFaces libraries. Refer to <xref linkend="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project" /> and <xref linkend="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries" /> for details. + </para> + </section> </chapter> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-Introduction"> <title>Introduction</title> <para> @@ -13,7 +10,7 @@ RichFaces leverages several parts of the JSF2 framework including lifecycle, validation, conversion facilities, and management of static and dynamic resources. The RichFaces framework includes components with built-in Ajax support and a customizable look-and-feel that can be incorporated into JSF applications. </para> <para> - RichFaces provides a number of advantages for enterprise web application development: + RichFaces provides a number of advantages for enterprise web application development: <itemizedlist> <listitem> <para> @@ -42,7 +39,7 @@ </listitem> <listitem> <para> - Generate binary resources on the fly. The resource framework can generate images, sounds, Microsoft <application>Excel</application> spreadsheets, and more during run-time. + Generate binary resources on the fly. The resource framework can generate images, sounds, <application>Microsoft Excel</application> spreadsheets, and more during run-time. </para> </listitem> <listitem> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-RichFaces_overview"> <title>RichFaces overview</title> <para> @@ -16,7 +13,7 @@ <title>Request processing flow</title> <mediaobject> <imageobject> - <imagedata fileref="images/figu-Developer_Guide-RichFaces_overview-Request_processing_flow.png" format="PNG" /> + <imagedata contentwidth="660" fileref="images/figu-Developer_Guide-RichFaces_overview-Request_processing_flow.png" format="PNG" width="444" /> </imageobject> <textobject> <para> @@ -31,7 +28,7 @@ <section id="sect-Developer_Guide-RichFaces_overview-Architecture"> <title>Architecture</title> <para> - The important elements of the RichFaces framework are as follows: + The important elements of the RichFaces framework are as follows: <itemizedlist> <listitem> <para> @@ -59,18 +56,18 @@ </para> </listitem> </itemizedlist> - Read this section for details on each element. + Read this section for details on each element. </para> - <section id="sect-Developer_Guide-RichFaces_overview-Ajax_Filter"> + <section id="sect-Developer_Guide-Architecture-Ajax_Filter"> <title>Ajax Filter</title> <para> - To get all benefits of RichFaces, a filter should be registered in the <filename>web.xml</filename> file of your application. The filter recognizes multiple request types. Filter configuration is covered in detail in <xref linkend="sect-Developer_Guide-Advanced_features-Filters" />. <xref linkend="figu-Developer_Guide-RichFaces_overview-Request_processing_sequences" /> shows the difference between processing a regular JSF request and an Ajax request with a filter. With the regular JSF request, the whole JSF tree is encoded. With the Ajax request, the filter parses the content of an Ajax response before sending it to the client side, and encoding depends on the size of the Ajax region. + To get all benefits of RichFaces, a filter should be registered in the <filename>web.xml</filename> file of your application. The filter recognizes multiple request types. Filter configuration is covered in detail in <xref linkend="sect-Developer_Guide-Advanced_features-Filters" />. <xref linkend="figu-Developer_Guide-Ajax_Filter-Request_processing_sequences" /> shows the difference between processing a regular JSF request and an Ajax request with a filter. With the regular JSF request, the whole JSF tree is encoded. With the Ajax request, the filter parses the content of an Ajax response before sending it to the client side, and encoding depends on the size of the Ajax region. </para> - <figure id="figu-Developer_Guide-RichFaces_overview-Request_processing_sequences"> + <figure id="figu-Developer_Guide-Ajax_Filter-Request_processing_sequences"> <title>Request processing sequences</title> <mediaobject> <imageobject> - <imagedata fileref="images/figu-Developer_Guide-RichFaces_overview-Request_processing_sequences.png" format="PNG" /> + <imagedata contentwidth="660" fileref="images/figu-Developer_Guide-RichFaces_overview-Request_processing_sequences.png" format="PNG" width="444" /> </imageobject> <textobject> <para> @@ -80,13 +77,13 @@ </mediaobject> </figure> <para> - Both with and without a filter, the required static or dynamic resources that your application requests are registered in the <classname>ResourseBuilder</classname> class. <xref linkend="figu-Developer_Guide-RichFaces_overview-Resource_request_sequence" /> shows the differences in resource requests for a regular JSF request and an Ajax request with a filter. When a request for a resource occurs, the RichFaces filter checks the <classname>ResourceCache</classname> for the resource. If the resource is in the cache, it is sent to the client. Otherwise, the filter searches for the resource among those that are registered by the <classname>ResourceBuilder</classname>. If the resource is registered, the RichFaces filter will send a request to the <classname>ResourceBuilder</classname> to deliver the resource. + Both with and without a filter, the required static or dynamic resources that your application requests are registered in the <classname>ResourseBuilder</classname> class. <xref linkend="figu-Developer_Guide-Ajax_Filter-Resource_request_sequence" /> shows the differences in resource requests for a regular JSF request and an Ajax request with a filter. When a request for a resource occurs, the RichFaces filter checks the <classname>ResourceCache</classname> for the resource. If the resource is in the cache, it is sent to the client. Otherwise, the filter searches for the resource among those that are registered by the <classname>ResourceBuilder</classname>. If the resource is registered, the RichFaces filter will send a request to the <classname>ResourceBuilder</classname> to deliver the resource. </para> - <figure id="figu-Developer_Guide-RichFaces_overview-Resource_request_sequence"> + <figure id="figu-Developer_Guide-Ajax_Filter-Resource_request_sequence"> <title>Resource request sequence</title> <mediaobject> <imageobject> - <imagedata fileref="images/figu-Developer_Guide-RichFaces_overview-Resource_request_sequence.png" format="PNG" /> + <imagedata contentwidth="660" fileref="images/figu-Developer_Guide-RichFaces_overview-Resource_request_sequence.png" format="PNG" width="444" /> </imageobject> <textobject> <para> @@ -96,30 +93,38 @@ </mediaobject> </figure> </section> - <section id="sect-Developer_Guide-RichFaces_overview-Ajax_Action_Components"> + + <section id="sect-Developer_Guide-Architecture-Ajax_Action_Components"> <title>Ajax Action Components</title> <para> The RichFaces framework includes several Ajax Action Components: <sgmltag>&lt;a4j:commandButton&gt;</sgmltag>, <sgmltag>&lt;a4j:commandLink&gt;</sgmltag>, <sgmltag>&lt;a4j:poll&gt;</sgmltag>, <sgmltag>&lt;a4j:ajax&gt;</sgmltag>, and more. Use Ajax Action Components to send Ajax requests from the client side. </para> </section> - <section id="sect-Developer_Guide-RichFaces_overview-Ajax_Containers"> + + <section id="sect-Developer_Guide-Architecture-Ajax_Containers"> <title>Ajax Containers</title> <para> <classname>AjaxContainer</classname> is an interface that describes an area on a JSF page that is decoded during an Ajax request. <classname>AjaxViewRoot</classname> and <classname>AjaxRegion</classname> are implementations of this interface. </para> </section> - <section id="sect-Developer_Guide-RichFaces_overview-Skins_and_Theming"> - <title>Skins and Theming</title> + + <section id="sect-Developer_Guide-Architecture-Skins_and_theming"> + <title>Skins and theming</title> <para> - + RichFaces includes extensive support for application skinning. Skinning is a high-level extension to traditional <acronym>CSS</acronym> (Cascading Style Sheets) which allows the color scheme and appearance of an application to be easily managed. The skins simplify look-and-feel design by allowing multiple elements of the interface to be handled as manageable features, which have associated color palettes and styling. Application skins can additionally be changed on the fly during run-time, allowing user experiences to be personalized and customized. </para> + <para> + For full details on skinning and how to create skins for the components in your application, refer to <xref linkend="chap-Developer_Guide-Skinning_and_theming" />. + </para> </section> - <section id="sect-Developer_Guide-RichFaces_overview-RichFaces_JavaScript_Engine"> + + <section id="sect-Developer_Guide-Architecture-RichFaces_JavaScript_Engine"> <title>RichFaces JavaScript Engine</title> <para> The RichFaces JavaScript Engine runs on the client side. It can update different areas on a JSF page based on an Ajax response. It is not necessary to use the JavaScript code directly, as it is available automatically. </para> </section> + </section> <section id="sect-Developer_Guide-RichFaces_overview-Technologies"> @@ -139,7 +144,7 @@ <section id="sect-Developer_Guide-RichFaces_overview-Restrictions"> <title>Restrictions</title> <para> - The following restrictions apply to applications implementing the RichFaces framework: + The following restrictions apply to applications implementing the RichFaces framework: <itemizedlist> <listitem> <para> @@ -169,20 +174,6 @@ </itemizedlist> </para> </section> - - <section id="sect-Developer_Guide-RichFaces_overview-Using_RichFaces_with_Maven"> - <title>Using RichFaces with Maven</title> - <para> - Incomplete - </para> - </section> - - <section id="sect-Developer_Guide-RichFaces_overview-Using_RichFaces_in_existing_JSF_projects"> - <title>Using RichFaces in existing JSF projects</title> - <para> - Incomplete - </para> - </section> </chapter> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Skinning_and_theming.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,9 +1,6 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <chapter id="chap-Developer_Guide-Skinning_and_theming"> <title>Skinning and theming</title> <para> Modified: root/docs/trunk/Developer_Guide/en-US/fallback_content/Conventions.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/fallback_content/Conventions.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/fallback_content/Conventions.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,12 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "../Developer_Guide.ent"> -%BOOK_ENTITIES; -<!ENTITY % BOOK_ENTITIES SYSTEM "Common_Content.ent"> -%BOOK_ENTITIES; ]> - -<section> +<section id="sect-Developer_Guide-Document_Conventions"> <title>Document Conventions</title> <para> This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. @@ -14,7 +9,7 @@ <para> In PDF and paper editions, this manual uses typefaces drawn from the <ulink url="https://fedorahosted.org/liberation-fonts/">Liberation Fonts</ulink> set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default. </para> - <section> + <section id="sect-Developer_Guide-Document_Conventions-Typographic_Conventions"> <title>Typographic Conventions</title> <para> Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows. @@ -73,7 +68,7 @@ The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context. </para> <para> - Note the <guimenu>&gt;</guimenu> shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow &#39;Select <guimenuitem>Mouse</guimenuitem> from the <guimenu>Preferences</guimenu> sub-menu in the <guimenu>System</guimenu> menu of the main menu bar&#39; approach. + Note the <guimenu>&gt;</guimenu> shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select <guimenuitem>Mouse</guimenuitem> from the <guimenu>Preferences</guimenu> sub-menu in the <guimenu>System</guimenu> menu of the main menu bar' approach. </para> <para> <command><replaceable>Mono-spaced Bold Italic</replaceable></command> or <application><replaceable>Proportional Bold Italic</replaceable></application> @@ -105,7 +100,7 @@ </blockquote> </section> - <section> + <section id="sect-Developer_Guide-Document_Conventions-Pull_quote_Conventions"> <title>Pull-quote Conventions</title> <para> Two, commonly multi-line, data types are set off visually from the surrounding text. @@ -139,14 +134,14 @@ System.out.println("Created Echo"); - System.out.println("Echo.echo(&#39;Hello&#39;) = " + echo.echo("Hello")); + System.out.println("Echo.echo('Hello') = " + echo.echo("Hello")); } } </programlisting> </section> - <section> + <section id="sect-Developer_Guide-Document_Conventions-Notes_and_Warnings"> <title>Notes and Warnings</title> <para> Finally, we use three visual styles to draw attention to information that might otherwise be overlooked. @@ -160,7 +155,7 @@ <important> <title>Important</title> <para> - Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won&#39;t cause data loss but may cause irritation and frustration. + Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won't cause data loss but may cause irritation and frustration. </para> </important> <warning> Modified: root/docs/trunk/Developer_Guide/en-US/fallback_content/Feedback.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/fallback_content/Feedback.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/fallback_content/Feedback.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,10 +1,7 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "../Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - -<section> +<section id="sect-Developer_Guide-We_Need_Feedback"> <title>We Need Feedback!</title> <indexterm> <primary>feedback</primary> @@ -14,7 +11,7 @@ If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: <ulink url="http://bugzilla.redhat.com/bugzilla/">http://bugzilla.r... against the product <application>&PRODUCT;.</application> </para> <para> - When submitting a bug report, be sure to mention the manual&#39;s identifier: <citetitle>&BOOKID;</citetitle> + When submitting a bug report, be sure to mention the manual's identifier: <citetitle>&BOOKID;</citetitle> </para> <para> If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. Modified: root/docs/trunk/Developer_Guide/en-US/fallback_content/Legal_Notice.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/fallback_content/Legal_Notice.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/en-US/fallback_content/Legal_Notice.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,18 +1,15 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "../Developer_Guide.ent"> -%BOOK_ENTITIES; ]> - <legalnotice> <para> Copyright <trademark class="copyright"></trademark> &YEAR; &HOLDER;. This material may only be distributed subject to the terms and conditions set forth in the Open Publication License, V1.0, (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencon...>). </para> <para> - Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries. + Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries. </para> <para> - <trademark class="registered">Linux</trademark> is the registered trademark of Linus Torvalds in the United States and other countries. + <trademark class="registered">Linux</trademark> is the registered trademark of Linus Torvalds in the United States and other countries. </para> <para> All other trademarks are the property of their respective owners. Modified: root/docs/trunk/Developer_Guide/publican.cfg =================================================================== --- root/docs/trunk/Developer_Guide/publican.cfg 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Developer_Guide/publican.cfg 2010-02-05 05:51:52 UTC (rev 16420) @@ -4,4 +4,3 @@ show_remarks: 1 debug: 1 xml_lang: en-US - Modified: root/docs/trunk/Migration_Guide/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Migration_Guide/en-US/Book_Info.xml 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Migration_Guide/en-US/Book_Info.xml 2010-02-05 05:51:52 UTC (rev 16420) @@ -5,7 +5,7 @@ ]> <bookinfo id="book-Migration_Guide-Migration_Guide"> <title>Migration Guide</title> - <subtitle>Migrating existing projects to RichFaces &VERSION_LONG;<remark> (draft)</remark> + <subtitle>Migrating existing projects to RichFaces &VERSIONLONG;<remark> (draft)</remark> </subtitle> <productname>RichFaces</productname> <productnumber>4.0</productnumber> Modified: root/docs/trunk/Migration_Guide/en-US/Migration_Guide.ent =================================================================== --- root/docs/trunk/Migration_Guide/en-US/Migration_Guide.ent 2010-02-05 00:09:13 UTC (rev 16419) +++ root/docs/trunk/Migration_Guide/en-US/Migration_Guide.ent 2010-02-05 05:51:52 UTC (rev 16420) @@ -1,6 +1,6 @@ <!ENTITY PRODUCT "RichFaces"> <!ENTITY VERSION "4.0"> -<!ENTITY VERSION_LONG "4.0.0.ALPHA2"> +<!ENTITY VERSIONLONG "4.0.0.ALPHA2"> <!ENTITY BOOKID "Migration_Guide"> <!ENTITY HOLDER "Red Hat Inc."> <!ENTITY YEAR "2009">