From richfaces-svn-commits at lists.jboss.org Fri May 14 00:47:31 2010
Content-Type: multipart/mixed; boundary="===============4760583243290129595=="
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: r17045 -
 root/docs/trunk/Developer_Guide/en-US.
Date: Fri, 14 May 2010 00:47:30 -0400
Message-ID: <201005140447.o4E4lURg010732@svn01.web.mwc.hst.phx2.redhat.com>

--===============4760583243290129595==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: SeanRogers
Date: 2010-05-14 00:47:30 -0400 (Fri, 14 May 2010)
New Revision: 17045

Modified:
   root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml
   root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_start=
ed_with_RichFaces.xml
Log:
Revised Maven usage based on feedback

Modified: root/docs/trunk/Developer_Guide/en-US/Developer_Guide.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/Developer_Guide.xml	2010-05-14 00=
:59:39 UTC (rev 17044)
+++ root/docs/trunk/Developer_Guide/en-US/Developer_Guide.xml	2010-05-14 04=
:47:30 UTC (rev 17045)
@@ -3,7 +3,8 @@
 ]>
 <book status=3D"draft">
 	<xi:include href=3D"Book_Info.xml" xmlns:xi=3D"http://www.w3.org/2001/XIn=
clude" />
-	<!--  <xi:include href=3D"Preface.xml" xmlns:xi=3D"http://www.w3.org/2001=
/XInclude"></xi:include>  --><xi:include href=3D"chap-Developer_Guide-Intro=
duction.xml" xmlns:xi=3D"http://www.w3.org/2001/XInclude" />
+	<!--  <xi:include href=3D"Preface.xml" xmlns:xi=3D"http://www.w3.org/2001=
/XInclude"></xi:include>  -->
+	<xi:include href=3D"chap-Developer_Guide-Introduction.xml" xmlns:xi=3D"ht=
tp://www.w3.org/2001/XInclude" />
 	<xi:include href=3D"chap-Developer_Guide-Getting_started_with_RichFaces.x=
ml" xmlns:xi=3D"http://www.w3.org/2001/XInclude" />
 	<xi:include href=3D"chap-Developer_Guide-RichFaces_overview.xml" xmlns:xi=
=3D"http://www.w3.org/2001/XInclude" />
 	<xi:include href=3D"chap-Developer_Guide-Basic_concepts.xml" xmlns:xi=3D"=
http://www.w3.org/2001/XInclude" />

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-14 00:59:39 UTC (rev 17044)
+++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_star=
ted_with_RichFaces.xml	2010-05-14 04:47:30 UTC (rev 17045)
@@ -32,11 +32,13 @@
 						<para>
 							RichFaces supports the following JSF implementations and frameworks=
: =

 							<itemizedlist>
+								<!--
 								<listitem>
 									<para>
 										Facelets 1.1.1 &#8211; 1.2
 									</para>
 								</listitem>
+								-->
 								<listitem>
 									<para>
 										MyFaces 1.2.5
@@ -47,11 +49,13 @@
 										Seam 1.2 and higher
 									</para>
 								</listitem>
+								<!--
 								<listitem>
 									<para>
 										Sun JSF-RI 1.2_12
 									</para>
 								</listitem>
+								-->
 							</itemizedlist>
 						</para>
 					</listitem>
@@ -197,9 +201,15 @@
 			</para>
 			<section id=3D"sect-Developer_Guide-Downloading_RichFaces-Compiling_the=
_source">
 				<title>Compiling the source</title>
+				<!-- Update download location in Enterprise docs, or remove this secti=
on altogether -->
 				<para>
 					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 <filename class=3D"extension">.bin.zip</filename> or <filename =
class=3D"extension">.bin.tar.gz</filename> archives) from the JBoss RichFac=
es Downloads area at <ulink url=3D"http://www.jboss.org/richfaces/download.=
html">http://www.jboss.org/richfaces/download.html</ulink>.
 				</para>
+				<!-- Remove SVN details in Enterprise docs -->
+				<para>
+					Alternatively, the source files can be downloaded from the anonymous =
SVN repository at <ulink url=3D"http://anonsvn.jboss.org/repos/richfaces/ro=
ot/">http://anonsvn.jboss.org/repos/richfaces/root/</ulink> using the follo=
wing command:
+				</para>
+<screen>svn co http://anonsvn.jboss.org/repos/richfaces/root/</screen>
 			</section>
 =

 		</section>
@@ -223,6 +233,7 @@
 				<para>
 					Add <filename>core-ui.jar</filename>, <filename>richfaces-api.jar</fi=
lename>, and <filename>richfaces-impl.jar</filename> into your project by d=
ragging 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>.
 				</para>
+				<!--
 				<note>
 					<title>Other required libraries</title>
 					<para>
@@ -256,6 +267,7 @@
 						</listitem>
 					</itemizedlist>
 				</note>
+				-->
 			</step>
 			<step id=3D"step-Developer_Guide-Creating_a_project-Reference_the_tag_l=
ibraries">
 				<title>Reference the tag libraries</title>
@@ -370,6 +382,11 @@
 				</para>
 				=

 <programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"text" h=
ref=3D"extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Add_dependenc=
ies.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlis=
ting>
+				=

+				<!-- Remove the following for Enterprise documentation -->
+				<para>
+					If you wish to include modules for test-driven JSF development, add a=
ny dependencies for the tests to the <filename>pom.xml</filename> file. For=
 full details on how to use the <productname>jsf-test</productname> project=
, refer to <ulink url=3D"http://community.jboss.org/docs/DOC-13155">http://=
community.jboss.org/wiki/TestDrivenJSFDevelopment</ulink>.
+				</para>
 			</step>
 			=

 <!--
@@ -380,14 +397,12 @@
 				<para>
 					After the project has been generated from the old archetype, it must =
be updated to use RichFaces &VERSION; and JSF 2.
 				</para>
+				<para>
+					RichFaces &VERSION; uses Facelets and does not support JSP. Any <file=
name>index.jsp</filename> pages that were generated need to forward <filena=
me>home.jsf</filename> page equivalents.
+				</para>
+				<!--
 				<substeps>
 					<step>
-						<title>Replace <filename>index.jsp</filename> pages</title>
-						<para>
-							RichFaces &VERSION; does not support JSP. Any <filename>index.jsp</=
filename> pages that were generated must be replaced with <filename>index.x=
html</filename> page equivalents.
-						</para>
-					</step>
-					<step>
 						<title>Deactivate the VDL view handler</title>
 						<para>
 							The <acronym>VDL</acronym> (View Definition Language) view handler =
must be deactivated for your project to work with JSF 2. To deactivate the =
viewhandler, edit the project's <filename>web.xml</filename> settings file =
with the following context parameter:
@@ -395,9 +410,9 @@
 <programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"text" h=
ref=3D"extras/prog-Developer_Guide-Using_RichFaces_with_Maven-Update_the_ge=
nerated_project.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" />=
</programlisting>
 					</step>
 				</substeps>
+				-->
 			</step>
 			=

-			=

 			<step id=3D"step-Developer_Guide-Using_RichFaces_with_Maven-Build_the_p=
roject">
 				<title>Build the project</title>
 				<para>
@@ -407,21 +422,39 @@
 					The <computeroutput>BUILD SUCCESSFUL</computeroutput> message indicat=
es the project has been assembled and is ready to import into an IDE (integ=
rated development environment).
 				</para>
 			</step>
+			=

 			<step id=3D"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.
+					Import the Maven project into your IDE. For <application>Eclipse</app=
lication> and <application>JBoss Tools</application>, you can either use <a=
pplication>Maven</application> to prepare the project, or import the projec=
t using the <productname>M2Eclipse</productname> plug-in.
 				</para>
-				<para>
-					For <application>Eclipse</application> and <application>JBoss Tools</=
application>, you need to have the <productname>M2Eclipse</productname> plu=
g-in installed. You can then import the <application>Maven</application> pr=
oject through a wizard by choosing <menuchoice><guimenu>File</guimenu><guim=
enuitem>Import</guimenuitem></menuchoice> from the menu. Select <guilabel>M=
aven Projects</guilabel> as the input source and choose the <filename>pom.x=
ml</filename> file for your project.
-				</para>
+				<stepalternatives>
+					<step>
+						<title>Using <application>Maven</application> to prepare the project=
 for <application>Eclipse</application></title>
+						<para>
+							Enter the following command in the root directory of the project:
+						</para>
+<screen>mvn eclipse:eclipse -DdownloadSources=3Dtrue -Dwtpversion=3D2.0</s=
creen>
+						<para>
+							The command generates the required <application>Eclipse</applicatio=
n> project files. You can then import the project into <application>Eclipse=
</application> and <application>JBoss Tools</application> through the impor=
ting wizard by choosing <menuchoice><guimenu>File</guimenu><guimenuitem>Imp=
ort</guimenuitem></menuchoice> from the menu. Select <menuchoice><guimenu>G=
eneral</guimenu><guimenuitem>Existing Projects into Workspace</guimenuitem>=
</menuchoice> as the import source and choose the root directory for your p=
roject.
+						</para>
+					</step>
+					<step>
+						<title>Using the <productname>M2Eclipse</productname> plug-in</title>
+						<para>
+							Alternatively, you can import a <application>Maven</application> pr=
oject into <application>Eclipse</application> and <application>JBoss Tools<=
/application> using the <productname>M2Eclipse</productname> plug-in. With =
the plug-in installed, open the importing wizard by choosing <menuchoice><g=
uimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice> from th=
e menu. Select <menuchoice><guimenu>Maven</guimenu><guimenuitem>Existing Ma=
ven Projects</guimenuitem></menuchoice> as the import source and choose the=
 <filename>pom.xml</filename> file for your project.
+						</para>
+					</step>
+				</stepalternatives>
 			</step>
+			<!--
 			<step id=3D"step-Developer_Guide-Using_RichFaces_with_Maven-Add_tag_lib=
rary_references">
 				<title>Add tag library references</title>
 				<para>
 					After importing, edit the <filename><replaceable>jsf-app</replaceable=
>/src/main/webapp/pages/index.xhtml</filename> file to include the tag libr=
ary declaration as described in <xref linkend=3D"step-Developer_Guide-Creat=
ing_a_project-Reference_the_tag_libraries" /> of <xref linkend=3D"sect-Deve=
loper_Guide-Getting_started_with_RichFaces-Creating_a_project" />.
 				</para>
 			</step>
+			-->
 		</procedure>
 		=

 		<para>


--===============4760583243290129595==--