From richfaces-svn-commits at lists.jboss.org Thu May 27 03:17:13 2010 Content-Type: multipart/mixed; boundary="===============7916481778654571994==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r17307 - root/docs/trunk/Developer_Guide/en-US. Date: Thu, 27 May 2010 03:17:13 -0400 Message-ID: <201005270717.o4R7HDxT026546@svn01.web.mwc.hst.phx2.redhat.com> --===============7916481778654571994== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2010-05-27 03:17:13 -0400 (Thu, 27 May 2010) New Revision: 17307 Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_start= ed_with_RichFaces.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_ove= rview.xml Log: Updating Getting Started chapter based on feedback. Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Gettin= g_started_with_RichFaces.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_star= ted_with_RichFaces.xml 2010-05-27 01:08:07 UTC (rev 17306) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_star= ted_with_RichFaces.xml 2010-05-27 07:17:13 UTC (rev 17307) @@ -4,234 +4,95 @@ Getting started with RichFaces - Follow the instructions in this chapter to install and configure RichFac= es for development. If you have existing projects that use an previous vers= ion of RichFaces, refer to the RichFaces Migration Guide. + Follow the instructions in this chapter configure the RichFaces framewor= k for development. RichFaces applications can be developed using JBoss Tools, as described in . = + + If you have existing projects that use a previous version of RichFaces, = refer to the RichFaces Migration Guide. +
Technical Requirements - RichFaces has been developed with an open architecture to be compatible= with a wide variety of environments. In addition to the RichFaces framewor= k, you need the following frameworks, environments, and applications instal= led on your computer to start developing with RichFaces: = - - - Java Development Kit (JDK) - - - RichFaces supports the following JDK versions: = - - - - JDK 1.5 and higher - - - - - - - - JavaServer Faces (JSF) - - - RichFaces supports the following JSF implementations and frameworks= : = - - - - - MyFaces 1.2.5 - - - - - Seam 1.2 and higher - - - - - - - - - A Java application server or servlet container - - - RichFaces supports the following servers: = - - - - Apache Tomcat 5.5 – 6.0 - - - - - BEA WebLogic 9.1 – 10.0 - - - - - JBoss 4.2 – 5.0 - - - - - Geronimo 2.0 and higher - - - - - Glassfish (J2EE 5) - - - - - Resin 3.1 - - - - - Sun Application Server 9 (J2EE 1.5) - - - - - Websphere 7.0 and higher - - - - - - - - A web browser - - - RichFaces supports the following web browsers: = - - Linux environments - - - Firefox 3.0 and higher - - - - - Google Chrome - - - - - Opera 9.5 and higher - - - - - Mac OS environments - - - Firefox 3.5 and higher - - - - - Google Chrome - - - - - Safari 3.0 and higher - - - - - Microsoft Windows environments - - - Firefox 3.0 and higher - - - - - Google Chrome - - - - - Internet Explorer 7.0 and higher - - - - - Opera 9.5 and higher - - - - - Safari 3.0 and higher - - - - - - - + The minimum technical requirements needed to get started with RichFaces= are outlined below. + + + + Java Development Kit (JDK) 1.5 or higher + + + + + JBoss Tools 3.1 + + + + + A JavaServer Faces 2 (JSF 2) implementation + + + + + An application server, such as JBoss Application Server = 6 or Apache Tomcat 6. + + + + + A web browser, such as Firefox 3.5 or Internet Explorer 7 + + + + + RichFaces supports additional products not listed here. Refer to for a full list of technical requirements and supported envrion= ments, browsers, and tools. + + =
= -
- Installing RichFaces +
+ Setting up RichFaces - Follow the instructions in this section to install the RichFaces framew= ork and begin building applications. + Follow the instructions in this section to set up the RichFaces framewo= rk and begin building applications. -
- Downloading RichFaces - - Download RichFaces from the JBoss RichFaces Downloads area at http://www.jboss.org/ri= chfaces/download.html. The binary files (available in .bin.zip or .bin.= tar.gz archives) contain a compiled, ready-to-use version of Ric= hFaces with a set of basic skins. - - - Create a new directory named RichFaces, then unzi= p the archive containing the binaries there. - -
- Compiling the source - + + + Download RichFaces archive - Instead of downloading the pre-compiled binaries, you can download th= e source files and compile them yourself. Download the source files (also a= vailable in .bin.zip or .bin.tar.gz archives) from the JBoss RichFac= es Downloads area at http://www.jboss.org/richfaces/download.html. + Download RichFaces from the JBoss RichFaces Downloads area at http://www.jboss.org/r= ichfaces/download.html. The binary files (available in .bin.zip or .bin= .tar.gz archives) contain a compiled, ready-to-use version of Ri= chFaces with a set of basic skins. - + + + Compiling from source + + Instead of downloading the pre-compiled binaries, you can download = the source files and compile them yourself. Refer to for f= urther instructions. + + + + + + Unzip archive - Alternatively, the source files can be downloaded from the anonymous = SVN repository at http://anonsvn.jboss.org/repos/richfaces/root/ using the follo= wing command: + Create a new directory named RichFaces, then unz= ip the archive containing the binaries there. -svn co http://anonsvn.jboss.org/repos/richfaces/root/ -
+ + = -
-
= -
- Creating a project +
+ Creating a project with <productname>JBoss Tools</productname></t= itle> <para> - Follow the procedure in this section to create a new RichFaces applicat= ion with <application>JBoss Tools</application>. + Follow the procedure in this section to create a new RichFaces applicat= ion with <productname>JBoss Tools</productname>. </para> <procedure> <step id=3D"step-Developer_Guide-Creating_a_project-Create_a_new_projec= t"> <title>Create a new project - Create a new project based on the JSF 2 environment. In = JBoss Tools, select FileNewJSF Project from th= e menu. Name the project, select JSF 2 from the JSF Environment drop-down box, and click the Fini= sh button to create the project. + Create a new project based on the JSF 2 environment. In = JBoss Tools, select FileNewJSF Project from th= e menu. Name the project, select JSF 2 from the JSF Environment drop-down box, and click the Fini= sh button to create the project. Add the RichFaces libraries to the project - Add core-ui.jar, richfaces-api.jar, and richfaces-impl.jar into your project by d= ragging them from the location where you unzipped the RichFaces archive to = the WebContent/WEB-INF/lib/ directory of your project = in JBoss Tools. + Add core-ui.jar, richfaces-api.jar, and richfaces-impl.jar into your project by c= opying them from the location where you unzipped the RichFaces archive to t= he WebContent/WEB-INF/lib/ directory of your project i= n JBoss Tools. + + + MyFaces 2 and higher + + + + + Seam 2 and higher + + + + + Sun JSF-RI 2 and higher + + + + + + + + Development environment + + + RichFaces can be developed using most Java development environments= . The following are recommended, and used for examples in this guide: + + + + JBoss Tools 3.1 and higher + + + + + Maven 2.1.0 and higher + + + + + + + +
+ = +
+ =
Architecture @@ -193,6 +394,158 @@
+ = +
+ Compiling from source code + + The source code for the RichFaces framework can be downloaded and compi= led manually rather than using the pre-compiled binaries. + + + + Download source code + + + JBoss RichFaces Downloads area + + + Download the source files (also available in .bin.zip or .bin.tar.gz archives) from the JBoss RichFaces Downloads area at http://www.jboss.org/richfac= es/download.html. + + + + Anonymous SVN repository + + + Alternatively, the source files can be downloaded from the anonymou= s SVN repository at http://anonsvn.jboss.org/repos/richfaces/root/ using the fol= lowing command: + + svn co http://anonsvn.jboss.org/repos/richfaces/root/ + + + + + Unzip archive + + Create a new directory named RichFaces, then unz= ip the archive containing the source code there. + + + + Compile using <productname>Maven</productname> + + In the root directory of the unzipped source code, enter the followin= g command to compile and build the RichFaces framework: + + mvn clean install + + Add any of the following options after the command to customize the b= uild: + + + + -P release,docs + + + Maven additionally builds the documentation and release artifacts. + + + + + -D skipTests=3Dtrue + + + Maven skips the unit and functional tests, which completes the bui= ld faster. + + + + + -D checkstyle.skip=3Dtrue + + + Maven skips the scans for checking style, which completes the buil= d faster. + + + + + -D skip-source + + + Maven does not produce any source jar files f= rom the build. + + + + + -D skip-enforce + + + Maven does not check for the correct JDK version, Maven version, a= nd SNAPSHOT plug-in, and forces the build. + + + + + -D jsf-profile=3Dimplementation + + + Maven tests builds and tests against the specified JSF implementat= ion. The implementation value can be any of the = following: + + + + + jsf_ri: The latest release of JS= F RI (Mojarra). This is the default implemenation. + + + + + jsf_ri_javax: The latest release of javax.faces. + + + + + jsf_ri_snapshot: The latest snapshot version = of JSF RI (Mojarra). + + + + + myfaces: The latest release of M= yFaces. + + + + + myfaces: The latest snapshot version of MyFaces. + + + + + + + + + Access compiled binaries + + The compiled libraries are located in the following sub-directories o= f the root RichFaces directory: + + + + + ui/assembly/target/dist/richfaces-ui-version= -SNAPSHOT.jar + + + + + framework/api/target/richfaces-api-version-SNAPSHOT.jar + + + + + framework/impl/target/richfaces-impl-version= -SNAPSHOT.jar + + + + + If Maven built the framework using the -P release = option, the distribution package containing all three compiled libraries an= d reference documentation is located at ui/assembly/target/dist/r= ichfaces-ui-version-SNAPSHOT-bin.zip. + + + + + You can now add the compiled libraries to your project as described in = . + + = +
= = --===============7916481778654571994==--