Author: SeanRogers Date: 2010-05-05 23:58:58 -0400 (Wed, 05 May 2010) New Revision: 16905 Added: root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories.xml_sample root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories_(legacy).xml_sample Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.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-RichFaces_overview.xml Log: Completed revision of Developer Guide based on tech review. Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-05-06 00:27:39 UTC (rev 16904) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-05-06 03:58:58 UTC (rev 16905) @@ -633,6 +633,33 @@ <section id="sect-Component_Reference-Tables_and_grids-richdataOrderedList"> <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataOrderedList</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataOrderedListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataOrderedListTag</classname> + </para> + </listitem> + </itemizedlist> <para> Incomplete </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-05-06 00:27:39 UTC (rev 16904) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Basic_concepts.xml 2010-05-06 03:58:58 UTC (rev 16905) @@ -14,7 +14,7 @@ <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. + 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>click</varname> JavaScript event. </para> </listitem> <listitem> @@ -24,7 +24,7 @@ </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. + 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>keyup</varname> or <varname>mouseover</varname>, for example. </para> </listitem> <listitem> @@ -51,7 +51,7 @@ <section id="sect-Developer_Guide-Receiving_events_and_updates-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. + 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. Controls and components from third-party libraries contained in these regions are also updated. </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. 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-05-06 00:27:39 UTC (rev 16904) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2010-05-06 03:58:58 UTC (rev 16905) @@ -215,7 +215,7 @@ <step id="step-Developer_Guide-Creating_a_project-Create_a_new_project"> <title>Create a new project</title> <para> - Create a new project based on the JSF 2 environment by using the JSF Project wizard in <application>JBoss Tools</application>. + Create a new project based on the JSF 2 environment. 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. </para> </step> <step id="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project"> @@ -226,7 +226,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>. <remark>These dependencies need to be confirmed.</remark> + 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>. </para> <itemizedlist> <listitem> @@ -287,44 +287,10 @@ <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> <remark>(may be renamed in a later release)</remark> 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: + A structure for the Maven project with minimal content can be created with the Maven archetype named <filename>maven-archetype-jsfwebapp</filename> <remark>(may be renamed in a later release)</remark> included as part of the RichFaces Component Development Kit (<acronym>CDK</acronym>). The archetype and the project itself require the JBoss repository to be provided (<filename>https://repository.jboss.org/nexus/content/groups/public/<...>). To make the repositories accessible to Maven, add a profile in the <filename><replaceable>maven_installation_folder</replaceable>/conf/settings.xml</filename> file under the <sgmltag>&lt;profiles&gt;</sgmltag> element: </para> -<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> +<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The profile then needs to be activated in the <sgmltag>&lt;activeProfiles&gt;</sgmltag> element: </para> @@ -396,107 +362,26 @@ 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: </para> -<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;4.0.0&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;4.0.0&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;4.0.0&lt;/version&gt; - &lt;/dependency&gt; -&lt;/dependencies&gt; -</programlisting> +<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_dependencies.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </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 <application>Eclipse</application> and <application>JBoss Tools</application></title> - <para> - To build the project for <application>Eclipse</application> and <application>JBoss Tools</application>, 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 <application>Eclipse</application>. - </para> - </step> - </stepalternatives> + <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). + </para> </step> + <step id="step-Developer_Guide-Build_the_project-Building_for_Eclipse_and_JBoss_Tools"> + <title>Import the project into an IDE</title> + <para> + Import the Maven project into your IDE. + </para> + <para> + For <application>Eclipse</application> and <application>JBoss Tools</application>, you need to have the <productname>M2Eclipse</productname> plug-in installed. You can then import the <application>Maven</application> project through a wizard by choosing <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice> from the menu. Select <guilabel>Maven Projects</guilabel> as the input source and choose the <filename>pom.xml</filename> file for your project. + </para> + </step> <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_tag_library_references"> <title>Add tag library references</title> <para> 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-05-06 00:27:39 UTC (rev 16904) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml 2010-05-06 03:58:58 UTC (rev 16905) @@ -26,7 +26,7 @@ </mediaobject> </figure> <para> - Using JSF tags, RichFaces allows different parts of a JSF page to be updated with an Ajax request. JSF pages using RichFaces do not change from "regular" JSF pages, and additional JavaScript or XMLHTTPRequest objects do not need to be written. + Using JSF tags, RichFaces allows different parts of a JSF page to be updated with an Ajax request. JSF pages using RichFaces do not change from "regular" JSF pages, and additional JavaScript code is not required. </para> <section id="sect-Developer_Guide-RichFaces_overview-Architecture"> <title>Architecture</title> Added: root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories.xml_sample =================================================================== --- root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories.xml_sample (rev 0) +++ root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories.xml_sample 2010-05-06 03:58:58 UTC (rev 16905) @@ -0,0 +1,47 @@ +<settings> + ... + <profiles> + ... + <profile> + <id>jboss-public-repository</id> + <repositories> + <repository> + <id>jboss-public-repository-group</id> + <name>JBoss Public Maven Repository Group</name> + <url>https://repository.jboss.org/nexus/content/groups/public/</url> + <layout>default</layout> + <releases> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + </repository> + </repositories> + <pluginRepositories> + <pluginRepository> + <id>jboss-public-repository-group</id> + <name>JBoss Public Maven Repository Group</name> + <url>https://repository.jboss.org/nexus/content/groups/public/</url> + <layout>default</layout> + <releases> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + </pluginRepository> + </pluginRepositories> + </profile> + + </profiles> + + <activeProfiles> + <activeProfile>jboss-public-repository</activeProfile> + </activeProfiles> + ... +</settings> Added: root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories_(legacy).xml_sample =================================================================== --- root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories_(legacy).xml_sample (rev 0) +++ root/docs/trunk/Developer_Guide/en-US/extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories_(legacy).xml_sample 2010-05-06 03:58:58 UTC (rev 16905) @@ -0,0 +1,34 @@ +<profiles> + <profile> + <id>jsf-app-profile</id> + <repositories> + <repository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + </snapshots> + <id>snapshots.jboss.org</id> + <name>Snapshot Jboss Repository for Maven</name> + <url>http://snapshots.jboss.org/maven2/</url> + <layout>default</layout> + </repository> + <repository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + </snapshots> + <id>repository.jboss.com</id> + <name>Jboss Repository for Maven</name> + <url>http://repository.jboss.com/maven2/</url> + <layout>default</layout> + </repository> + </repositories> + </profile> + ... +</profiles>