From richfaces-svn-commits at lists.jboss.org Fri May 28 03:03:55 2010 Content-Type: multipart/mixed; boundary="===============7232075658917313478==" 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: r17338 - root/docs/trunk/Developer_Guide/en-US. Date: Fri, 28 May 2010 03:03:55 -0400 Message-ID: <201005280703.o4S73tMR016455@svn01.web.mwc.hst.phx2.redhat.com> --===============7232075658917313478== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2010-05-28 03:03:55 -0400 (Fri, 28 May 2010) New Revision: 17338 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: Revising Maven archetype sections: RF-8648 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-28 01:40:33 UTC (rev 17337) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_star= ted_with_RichFaces.xml 2010-05-28 07:03:55 UTC (rev 17338) @@ -167,11 +167,17 @@
Using the <productname>RichFaces</productname> project archetype= + + A Maven archetype is a template for creating projects. Ma= ven uses an archetype to generate a directory structure and f= iles for a particular project, as well as creating pom.xml files that contain build instructions. + + + The RichFaces Component Development Kit includes a Maven archetype for= generating the basic structure and requirements for a RichFaces applicatio= n project. The archetype is named richfaces-archetype-simpleapp and is included as part of the RichFaces Component Development Ki= t (CDK), but Maven can obtain it from the JBoss reposito= ry at https://repository.jboss.org/nexus/content/groups/public/. Follow the procedure in this section to generate a new Maven-bas= ed RichFaces project using the archetype. + - Add required repositories + Add required repository - A structure for the project with minimal content can be created with= the Maven archetype named maven-archetype-jsfwebapp <= remark>(may be renamed in a later release) included as part of the= RichFaces Component Development Kit (CDK). The archetyp= e and the project itself require the JBoss repository to be provided (https://repository.jboss.org/nexus/content/groups/public/).= To make the repositories accessible to Maven, add a profile in the maven_installation_folder/conf/settings.xml file under the <profiles> element: + The details for the JBoss repository need to be added to Maven so it can access the archetype. Add a profile in the= maven_installation_folder/conf/settin= gs.xml file under the <profiles> elemen= t: = @@ -185,19 +191,17 @@ Generate the project from the archetype - = - + mvn archetype:generate -DarchetypeGroupId=3Dorg.richfaces.archety= pes -DarchetypeArtifactId=3Drichfaces-archetype-simpleapp -DarchetypeVersio= n=3D4.0.0-SNAPSHOT -DgroupId=3Dorg.docs.richfaces -DartifactId=3Dnew_project = + The following parameters can be used to customize your project: @@ -220,49 +224,51 @@ - The command generates a JSF project with the following structure: + The command generates a new RichFaces project with the following str= ucture: - jsf-app + new_project =E2=94=9C=E2=94=80=E2=94=80 pom.xml =E2=94=94=E2=94=80=E2=94=80 src - =E2=94=9C=E2=94=80=E2=94=80 main - =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 java - =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 org - =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 docs - =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 ri= chfaces - =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 Bean.java - =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 resources - =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 webapp - =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 WEB-INF - =E2=94=82 =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 faces-= config.xml - =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 web.xm= l - =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 index.xhtml - =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 pages - =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 index.xhtml + =E2=94=94=E2=94=80=E2=94=80 main + =E2=94=9C=E2=94=80=E2=94=80 java + =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 org + =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 docs + =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 richfaces<= /filename> + =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 RichBe= an.java + =E2=94=94=E2=94=80=E2=94=80 webapp + =E2=94=9C=E2=94=80=E2=94=80 index.xhtml + =E2=94=9C=E2=94=80=E2=94=80 templates + =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 template.xhtml= + =E2=94=94=E2=94=80=E2=94=80 WEB-INF + =E2=94=9C=E2=94=80=E2=94=80 faces-config.xml + =E2=94=94=E2=94=80=E2=94=80 web.xml + = - Add dependencies + + Add test dependencies (optional) - Your root directory of your project contains a project descriptor fi= le, pom.xml. To add RichFaces libraries to your projec= t, edit the project descriptor to add dependencies to the <depe= ndencies> element as follows: + Your root directory of your project contains a project descriptor fi= le, pom.xml. + + = +--> If you wish to include modules for test-driven JSF development, add = any dependencies for the tests to the pom.xml file. Fo= r full details on how to use the jsf-test projec= t, refer to http:/= /community.jboss.org/wiki/TestDrivenJSFDevelopment. = - + +--> = Build the project @@ -290,15 +295,19 @@ Build the project from the command line by entering the mvn= install command. - The BUILD SUCCESSFUL message indica= tes the project has been assembled and is ready to import into an IDE (inte= grated development environment). + The BUILD SUCCESSFUL message indica= tes the project has been assembled and is ready to import into an IDE (inte= grated development environment), such as JBoss Tools. = Import the project into an IDE - Import the Maven project into your IDE. For Eclipse and JBoss Tools, you can either use <= application>Maven to prepare the project, or import the proje= ct using the M2Eclipse plug-in. + Import the Maven project into your IDE. For Eclipse and JBoss Tools, you can import the p= roject using the M2Eclipse plug-in. + + To install the plug-in, choose HelpInstall New Software from the menu. T= ype Maven to locate the Maven Integration for = Eclipse Update Site entry, then type Maven in= the filter to show the available plug-ins. Follow the prompts to install t= he Maven Integration for Eclipse plug-in. + + + + With the plug-in installed, open the importing wizard by choosing = FileImport from the menu. Select MavenExisting Maven Projects as the import source = and choose the pom.xml file for your project. + - +--> = Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFa= ces_overview.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-RichFaces_ov= erview.xml 2010-05-28 01:40:33 UTC (rev 17337) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_ov= erview.xml 2010-05-28 07:03:55 UTC (rev 17338) @@ -542,7 +542,7 @@ - You can now add the compiled libraries to your project as described in = . + You can now add the compiled libraries to your project as described in = of . =
--===============7232075658917313478==--