JBoss Rich Faces SVN: r17307 - root/docs/trunk/Developer_Guide/en-US.
by richfaces-svn-commits@lists.jboss.org
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_started_with_RichFaces.xml
root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml
Log:
Updating Getting Started chapter based on feedback.
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-27 01:08:07 UTC (rev 17306)
+++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2010-05-27 07:17:13 UTC (rev 17307)
@@ -4,234 +4,95 @@
<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 Migration Guide</citetitle>.
+ Follow the instructions in this chapter configure the RichFaces framework for development. RichFaces applications can be developed using <productname>JBoss Tools</productname>, as described in <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_JBoss_Tools" />; or using <productname>Maven</productname>, as described in <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_Maven" />.
</para>
+ <para>
+ If you have existing projects that use a 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:
- <variablelist>
- <varlistentry>
- <term>Java Development Kit (<acronym>JDK</acronym>)</term>
- <listitem>
- <para>
- RichFaces supports the following JDK versions:
- <itemizedlist>
- <listitem>
- <para>
- JDK 1.5 and higher
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>JavaServer Faces (<acronym>JSF</acronym>)</term>
- <listitem>
- <para>
- RichFaces supports the following JSF implementations and frameworks:
- <itemizedlist>
- <!--
- <listitem>
- <para>
- Facelets 1.1.1 – 1.2
- </para>
- </listitem>
- -->
- <listitem>
- <para>
- MyFaces 1.2.5
- </para>
- </listitem>
- <listitem>
- <para>
- Seam 1.2 and higher
- </para>
- </listitem>
- <!--
- <listitem>
- <para>
- Sun JSF-RI 1.2_12
- </para>
- </listitem>
- -->
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>A Java application server or servlet container</term>
- <listitem>
- <para>
- RichFaces supports the following servers:
- <itemizedlist>
- <listitem>
- <para>
- Apache Tomcat 5.5 – 6.0
- </para>
- </listitem>
- <listitem>
- <para>
- BEA WebLogic 9.1 – 10.0
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss 4.2 – 5.0
- </para>
- </listitem>
- <listitem>
- <para>
- Geronimo 2.0 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Glassfish (J2EE 5)
- </para>
- </listitem>
- <listitem>
- <para>
- Resin 3.1
- </para>
- </listitem>
- <listitem>
- <para>
- Sun Application Server 9 (J2EE 1.5)
- </para>
- </listitem>
- <listitem>
- <para>
- Websphere 7.0 and higher
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>A web browser</term>
- <listitem>
- <para>
- RichFaces supports the following web browsers:
- <itemizedlist id="item-Developer_Guide-Technical_Requirements-Linux_environments">
- <title>Linux environments</title>
- <listitem>
- <para>
- Firefox 3.0 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Google Chrome
- </para>
- </listitem>
- <listitem>
- <para>
- Opera 9.5 and higher
- </para>
- </listitem>
- </itemizedlist>
- <itemizedlist id="item-Developer_Guide-Technical_Requirements-Mac_OS_environments">
- <title>Mac OS environments</title>
- <listitem>
- <para>
- Firefox 3.5 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Google Chrome
- </para>
- </listitem>
- <listitem>
- <para>
- Safari 3.0 and higher
- </para>
- </listitem>
- </itemizedlist>
- <itemizedlist id="item-Developer_Guide-Technical_Requirements-Microsoft_Windows_environments">
- <title>Microsoft Windows environments</title>
- <listitem>
- <para>
- Firefox 3.0 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Google Chrome
- </para>
- </listitem>
- <listitem>
- <para>
- Internet Explorer 7.0 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Opera 9.5 and higher
- </para>
- </listitem>
- <listitem>
- <para>
- Safari 3.0 and higher
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ The minimum technical requirements needed to get started with RichFaces are outlined below.
</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Java Development Kit (<acronym>JDK</acronym>) 1.5 or higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <productname>JBoss Tools 3.1</productname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A <productname>JavaServer Faces 2</productname> (<acronym>JSF 2</acronym>) implementation
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ An application server, such as <productname>JBoss Application Server 6</productname> or <productname>Apache Tomcat 6</productname>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A web browser, such as <productname>Firefox 3.5</productname> or <productname>Internet Explorer 7</productname>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ RichFaces supports additional products not listed here. Refer to <xref linkend="sect-Component_Reference-RichFaces_overview-Full_technical_requirements" /> for a full list of technical requirements and supported envrionments, browsers, and tools.
+ </para>
+
</section>
- <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Installing_RichFaces">
- <title>Installing RichFaces</title>
+ <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Setting_up_RichFaces">
+ <title>Setting up RichFaces</title>
<para>
- Follow the instructions in this section to install the RichFaces framework and begin building applications.
+ Follow the instructions in this section to set up the RichFaces framework and begin building applications.
</para>
- <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://www.jboss.org/richfaces/download.html</ulink>. 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.
- </para>
- <para>
- Create a new directory named <filename>RichFaces</filename>, then unzip the archive containing the binaries there.
- </para>
- <section id="sect-Developer_Guide-Downloading_RichFaces-Compiling_the_source">
- <title>Compiling the source</title>
- <!-- Update download location in Enterprise docs, or remove this section altogether -->
+ <procedure>
+ <step>
+ <title>Download RichFaces archive</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://www.jboss.org/richfaces/download.html</ulink>.
+ Download RichFaces from the JBoss RichFaces Downloads area at <ulink url="http://www.jboss.org/richfaces/download.html">http://www.jboss.org/richfaces/download.html</ulink>. 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.
</para>
- <!-- Remove SVN details in Enterprise docs -->
+ <stepalternatives>
+ <step>
+ <title>Compiling from source</title>
+ <para>
+ Instead of downloading the pre-compiled binaries, you can download the source files and compile them yourself. Refer to <xref linkend="sect-Component_Reference-RichFaces_overview-Compiling_from_source_code" /> for further instructions.
+ </para>
+ </step>
+ </stepalternatives>
+ </step>
+ <step>
+ <title>Unzip archive</title>
<para>
- Alternatively, the source files can be downloaded from the anonymous SVN repository at <ulink url="http://anonsvn.jboss.org/repos/richfaces/root/">http://anonsvn.jboss.org/repos/richfaces/root/</ulink> using the following command:
+ Create a new directory named <filename>RichFaces</filename>, then unzip the archive containing the binaries there.
</para>
-<screen>svn co http://anonsvn.jboss.org/repos/richfaces/root/</screen>
- </section>
+ </step>
+ </procedure>
- </section>
-
</section>
- <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project">
- <title>Creating a project</title>
+ <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_JBoss_Tools">
+ <title>Creating a project with <productname>JBoss Tools</productname></title>
<para>
- Follow the procedure in this section to create a new RichFaces application with <application>JBoss Tools</application>.
+ Follow the procedure in this section to create a new RichFaces application with <productname>JBoss Tools</productname>.
</para>
<procedure>
<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. 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.
+ Create a new project based on the JSF 2 environment. In <productname>JBoss Tools</productname>, 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">
<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>.
+ Add <filename>core-ui.jar</filename>, <filename>richfaces-api.jar</filename>, and <filename>richfaces-impl.jar</filename> into your project by copying 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>
@@ -290,10 +151,10 @@
</para>
</section>
- <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Using_RichFaces_with_Maven">
- <title>Using RichFaces with Maven</title>
+ <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_Maven">
+ <title>Creating a project with <productname>Maven</productname></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.
+ <productname>Maven</productname> is a build automation and project management tool for Java projects. Follow the instructions in this section to create a Maven project for RichFaces.
</para>
<procedure>
<step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories">
@@ -465,7 +326,7 @@
<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" /> in <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project" /> for details.
+ RichFaces can be added to existing JSF2 projects by adding references to the new 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" /> in <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_JBoss_Tools" /> for details.
</para>
</section>
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-27 01:08:07 UTC (rev 17306)
+++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-RichFaces_overview.xml 2010-05-27 07:17:13 UTC (rev 17307)
@@ -28,6 +28,207 @@
<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 code is not required.
</para>
+ <section id="sect-Component_Reference-RichFaces_overview-Full_technical_requirements">
+ <title>Full technical requirements</title>
+ <para>
+ RichFaces has been developed with an open architecture to be compatible with a wide variety of environments.
+ </para>
+ <section id="sect-Component_Reference-RichFaces_overview-Server_requirements">
+ <title>Server requirements</title>
+ <para>
+ A Java application server or servlet container is required for running RichFaces applications. RichFaces supports the following servers:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Apache Tomcat 6.0 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ BEA WebLogic 9.1 – 10.0
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss 4.2 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Geronimo 2.0 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Glassfish (J2EE 5 and JEE 6)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Resin 3.1
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Sun Application Server 9 (J2EE 1.5)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Websphere 7.0 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Component_Reference-RichFaces_overview-Client_requirements">
+ <title>Client requirements</title>
+ <para>
+ Clients accessing RichFaces applications require a web browser. Richfaces supports the following web browsers:
+ </para>
+ <itemizedlist id="item-Developer_Guide-Technical_Requirements-Linux_environments">
+ <title>Linux environments</title>
+ <listitem>
+ <para>
+ Firefox 3.0 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Google Chrome
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Opera 9.5 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ <itemizedlist id="item-Developer_Guide-Technical_Requirements-Mac_OS_environments">
+ <title>Mac OS environments</title>
+ <listitem>
+ <para>
+ Firefox 3.5 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Google Chrome
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Safari 3.0 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ <itemizedlist id="item-Developer_Guide-Technical_Requirements-Microsoft_Windows_environments">
+ <title>Microsoft Windows environments</title>
+ <listitem>
+ <para>
+ Firefox 3.0 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Google Chrome
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Internet Explorer 7.0 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Opera 9.5 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Safari 3.0 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Component_Reference-RichFaces_overview-Development_requirements">
+ <title>Development requirements</title>
+ <para>
+ Developing applications with the RichFaces framework requires the Java Development Kit (<acronym>JDK</acronym>), an implementation of JavaServer Faces (<acronym>JSF</acronym>), and a development environment.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Java Development Kit (<acronym>JDK</acronym>)</term>
+ <listitem>
+ <para>
+ RichFaces supports the following JDK versions:
+ <itemizedlist>
+ <listitem>
+ <para>
+ JDK 1.5 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>JavaServer Faces (<acronym>JSF</acronym>)</term>
+ <listitem>
+ <para>
+ RichFaces supports the following JSF implementations and frameworks:
+ <itemizedlist>
+ <!--
+ <listitem>
+ <para>
+ Facelets 1.1.1 – 1.2
+ </para>
+ </listitem>
+ -->
+ <listitem>
+ <para>
+ MyFaces 2 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Seam 2 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Sun JSF-RI 2 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Development environment</term>
+ <listitem>
+ <para>
+ RichFaces can be developed using most Java development environments. The following are recommended, and used for examples in this guide:
+ <itemizedlist>
+ <listitem>
+ <para>
+ JBoss Tools 3.1 and higher
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Maven 2.1.0 and higher
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ </section>
+
<section id="sect-Developer_Guide-RichFaces_overview-Architecture">
<title>Architecture</title>
<para>
@@ -193,6 +394,158 @@
</itemizedlist>
</para>
</section>
+
+ <section id="sect-Component_Reference-RichFaces_overview-Compiling_from_source_code">
+ <title>Compiling from source code</title>
+ <para>
+ The source code for the RichFaces framework can be downloaded and compiled manually rather than using the pre-compiled binaries.
+ </para>
+ <procedure>
+ <step>
+ <title>Download source code</title>
+ <stepalternatives>
+ <step>
+ <title>JBoss RichFaces Downloads area</title>
+ <!-- Update download location in Enterprise docs, or remove this section altogether -->
+ <para>
+ 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://www.jboss.org/richfaces/download.html</ulink>.
+ </para>
+ </step>
+ <step>
+ <title>Anonymous SVN repository</title>
+ <!-- Remove SVN details in Enterprise docs -->
+ <para>
+ Alternatively, the source files can be downloaded from the anonymous SVN repository at <ulink url="http://anonsvn.jboss.org/repos/richfaces/root/">http://anonsvn.jboss.org/repos/richfaces/root/</ulink> using the following command:
+ </para>
+ <screen>svn co http://anonsvn.jboss.org/repos/richfaces/root/</screen>
+ </step>
+ </stepalternatives>
+ </step>
+ <step>
+ <title>Unzip archive</title>
+ <para>
+ Create a new directory named <filename>RichFaces</filename>, then unzip the archive containing the source code there.
+ </para>
+ </step>
+ <step>
+ <title>Compile using <productname>Maven</productname></title>
+ <para>
+ In the root directory of the unzipped source code, enter the following command to compile and build the RichFaces framework:
+ </para>
+ <screen>mvn clean install</screen>
+ <para>
+ Add any of the following options after the command to customize the build:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><command>-P release,docs</command></term>
+ <listitem>
+ <para>
+ Maven additionally builds the documentation and release artifacts.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-D skipTests=true</command></term>
+ <listitem>
+ <para>
+ Maven skips the unit and functional tests, which completes the build faster.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-D checkstyle.skip=true</command></term>
+ <listitem>
+ <para>
+ Maven skips the scans for checking style, which completes the build faster.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-D skip-source</command></term>
+ <listitem>
+ <para>
+ Maven does not produce any source <filename>jar</filename> files from the build.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-D skip-enforce</command></term>
+ <listitem>
+ <para>
+ Maven does not check for the correct JDK version, Maven version, and <literal>SNAPSHOT</literal> plug-in, and forces the build.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-D jsf-profile=<replaceable>implementation</replaceable></command></term>
+ <listitem>
+ <para>
+ Maven tests builds and tests against the specified JSF implementation. The <replaceable>implementation</replaceable> value can be any of the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>jsf_ri</literal>: The latest release of <productname>JSF RI (Mojarra)</productname>. This is the default implemenation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>jsf_ri_javax</literal>: The latest release of <productname>javax.faces</productname>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>jsf_ri_snapshot</literal>: The latest snapshot version of <productname>JSF RI (Mojarra)</productname>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>myfaces</literal>: The latest release of <productname>MyFaces</productname>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>myfaces</literal>: The latest snapshot version of <productname>MyFaces</productname>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </step>
+ <step>
+ <title>Access compiled binaries</title>
+ <para>
+ The compiled libraries are located in the following sub-directories of the root RichFaces directory:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>ui/assembly/target/dist/richfaces-ui-<replaceable>version</replaceable>-SNAPSHOT.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>framework/api/target/richfaces-api-<replaceable>version</replaceable>-SNAPSHOT.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>framework/impl/target/richfaces-impl-<replaceable>version</replaceable>-SNAPSHOT.jar</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ If Maven built the framework using the <command>-P release</command> option, the distribution package containing all three compiled libraries and reference documentation is located at <filename>ui/assembly/target/dist/richfaces-ui-<replaceable>version</replaceable>-SNAPSHOT-bin.zip</filename>.
+ </para>
+ </step>
+ </procedure>
+ <para>
+ You can now add the compiled libraries to your project as described in <xref linkend="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project" />.
+ </para>
+
+ </section>
</chapter>
14 years, 1 month
JBoss Rich Faces SVN: r17306 - root/build/parent/tags.
by richfaces-svn-commits@lists.jboss.org
Author: jbalunas(a)redhat.com
Date: 2010-05-26 21:08:07 -0400 (Wed, 26 May 2010)
New Revision: 17306
Removed:
root/build/parent/tags/richfaces-parent-6/
Log:
Rollback of release:prepare in error, meant to be a dryrun
14 years, 1 month
JBoss Rich Faces SVN: r17305 - root/build/parent/trunk.
by richfaces-svn-commits@lists.jboss.org
Author: jbalunas(a)redhat.com
Date: 2010-05-26 21:05:43 -0400 (Wed, 26 May 2010)
New Revision: 17305
Modified:
root/build/parent/trunk/pom.xml
Log:
Rollback of release:prepare in error - meant for dryrun
Modified: root/build/parent/trunk/pom.xml
===================================================================
--- root/build/parent/trunk/pom.xml 2010-05-27 00:55:03 UTC (rev 17304)
+++ root/build/parent/trunk/pom.xml 2010-05-27 01:05:43 UTC (rev 17305)
@@ -21,7 +21,7 @@
<groupId>org.richfaces</groupId>
<artifactId>richfaces-parent</artifactId>
<packaging>pom</packaging>
- <version>7-SNAPSHOT</version>
+ <version>6-SNAPSHOT</version>
<name>RichFaces Parent</name>
<parent>
14 years, 1 month
JBoss Rich Faces SVN: r17303 - root/build/parent/tags.
by richfaces-svn-commits@lists.jboss.org
Author: jbalunas(a)redhat.com
Date: 2010-05-26 20:54:56 -0400 (Wed, 26 May 2010)
New Revision: 17303
Added:
root/build/parent/tags/richfaces-parent-6/
Log:
[maven-release-plugin] copy for tag richfaces-parent-6
Copied: root/build/parent/tags/richfaces-parent-6 (from rev 17302, root/build/parent/trunk)
14 years, 1 month
JBoss Rich Faces SVN: r17301 - root/build/parent/trunk.
by richfaces-svn-commits@lists.jboss.org
Author: jbalunas(a)redhat.com
Date: 2010-05-26 20:52:18 -0400 (Wed, 26 May 2010)
New Revision: 17301
Modified:
root/build/parent/trunk/pom.xml
Log:
Updates release plugin verion to 2.0 release
Modified: root/build/parent/trunk/pom.xml
===================================================================
--- root/build/parent/trunk/pom.xml 2010-05-26 23:43:23 UTC (rev 17300)
+++ root/build/parent/trunk/pom.xml 2010-05-27 00:52:18 UTC (rev 17301)
@@ -152,6 +152,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
+ <version>2.0</version>
<configuration>
<!-- All sub-modules will have same version -->
<autoVersionSubmodules>true</autoVersionSubmodules>
14 years, 1 month
JBoss Rich Faces SVN: r17300 - root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker.
by richfaces-svn-commits@lists.jboss.org
Author: alexsmirnov
Date: 2010-05-26 19:43:23 -0400 (Wed, 26 May 2010)
New Revision: 17300
Added:
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/ClassNameModel.java
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/FreeMakerUtils.java
Modified:
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/CdkConfiguration.java
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/LibraryModelWrapper.java
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/PropertyModel.java
Log:
CODING IN PROGRESS - issue RF-8568: Improve FreeMarker generator.
https://jira.jboss.org/browse/RF-8568
Modified: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/CdkConfiguration.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/CdkConfiguration.java 2010-05-26 22:16:20 UTC (rev 17299)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/CdkConfiguration.java 2010-05-26 23:43:23 UTC (rev 17300)
@@ -42,14 +42,14 @@
private Logger log;
@Inject
- public CdkConfiguration(ObjectWrapper wrapper, Logger log) {
+ public CdkConfiguration(ObjectWrapper wrapper, Logger log, FreeMakerUtils utils) {
super();
this.log = log;
- // load templates from this project.
+ // load templates from plugin classloader.
setClassForTemplateLoading(this.getClass(), TEMPLATES);
setTemplateUpdateDelay(10000);// Forever...
-
+ setSharedVariable("utils", utils);
setObjectWrapper(wrapper);
// Add context variables
Added: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/ClassNameModel.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/ClassNameModel.java (rev 0)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/ClassNameModel.java 2010-05-26 23:43:23 UTC (rev 17300)
@@ -0,0 +1,72 @@
+/*
+ * $Id$
+ *
+ * License Agreement.
+ *
+ * Rich Faces - Natural Ajax for Java Server Faces (JSF)
+ *
+ * Copyright (C) 2007 Exadel, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+package org.richfaces.cdk.generate.freemarker;
+
+import org.richfaces.cdk.model.ClassName;
+
+import freemarker.ext.beans.BeansWrapper;
+import freemarker.ext.beans.StringModel;
+import freemarker.ext.util.ModelFactory;
+import freemarker.template.ObjectWrapper;
+import freemarker.template.TemplateModel;
+import freemarker.template.TemplateModelException;
+
+/**
+ * <p class="changed_added_4_0">
+ * </p>
+ *
+ * @author asmirnov(a)exadel.com
+ *
+ */
+public class ClassNameModel extends StringModel {
+
+ static final ModelFactory FACTORY = new ModelFactory() {
+ public TemplateModel create(Object object, ObjectWrapper wrapper) {
+ return new ClassNameModel((ClassName) object, (BeansWrapper) wrapper);
+ }
+ };
+
+ private final ClassName className;
+
+ public ClassNameModel(ClassName object, BeansWrapper wrapper) {
+ super(object, wrapper);
+ this.className = object;
+ }
+
+ @Override
+ public TemplateModel get(String key) throws TemplateModelException {
+ Object value;
+ if ("short".equals(key)) {
+ value = this.className.isPrimitive() || isFromJavaLang();
+ } else {
+ return super.get(key);
+ }
+ return wrapper.wrap(value);
+ }
+
+ public boolean isFromJavaLang() {
+ return "java.lang".equals(className.getPackage());
+ }
+
+}
Property changes on: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/ClassNameModel.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Added: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/FreeMakerUtils.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/FreeMakerUtils.java (rev 0)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/FreeMakerUtils.java 2010-05-26 23:43:23 UTC (rev 17300)
@@ -0,0 +1,68 @@
+/*
+ * $Id$
+ *
+ * License Agreement.
+ *
+ * Rich Faces - Natural Ajax for Java Server Faces (JSF)
+ *
+ * Copyright (C) 2007 Exadel, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+package org.richfaces.cdk.generate.freemarker;
+
+import java.util.List;
+
+import com.google.common.collect.ImmutableMap;
+
+import freemarker.template.TemplateHashModel;
+import freemarker.template.TemplateMethodModel;
+import freemarker.template.TemplateMethodModelEx;
+import freemarker.template.TemplateModel;
+import freemarker.template.TemplateModelException;
+
+/**
+ * <p class="changed_added_4_0">This class implements different utility functions used by generator.</p>
+ * @author asmirnov(a)exadel.com
+ *
+ */
+public class FreeMakerUtils implements TemplateHashModel {
+
+ ImmutableMap<String, ? extends TemplateMethodModel> functions = ImmutableMap.<String, TemplateMethodModel>builder().
+ put("version", new TemplateMethodModelEx() {
+
+ @Override
+ public Object exec(List arguments) throws TemplateModelException {
+ return "4.0.0";
+ }
+ }).
+ build();
+ /* (non-Javadoc)
+ * @see freemarker.template.TemplateHashModel#get(java.lang.String)
+ */
+ @Override
+ public TemplateModel get(String key) throws TemplateModelException {
+ return functions.get(key);
+ }
+
+ /* (non-Javadoc)
+ * @see freemarker.template.TemplateHashModel#isEmpty()
+ */
+ @Override
+ public boolean isEmpty() throws TemplateModelException {
+ return false;
+ }
+
+}
Property changes on: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/FreeMakerUtils.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Modified: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/LibraryModelWrapper.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/LibraryModelWrapper.java 2010-05-26 22:16:20 UTC (rev 17299)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/LibraryModelWrapper.java 2010-05-26 23:43:23 UTC (rev 17300)
@@ -25,7 +25,9 @@
package org.richfaces.cdk.generate.freemarker;
+import org.richfaces.cdk.model.ClassName;
import org.richfaces.cdk.model.ModelElementBase;
+import org.richfaces.cdk.model.PropertyBase;
import freemarker.ext.beans.BeansWrapper;
import freemarker.template.ObjectWrapper;
@@ -43,18 +45,20 @@
super();
setStrict(true);
setSimpleMapWrapper(true);
-
// setNullModel(TemplateScalarModel.EMPTY_STRING);
setUseCache(true);
}
@Override
public TemplateModel wrap(Object obj) throws TemplateModelException {
- // TODO wrap specified model classes.
- if (obj instanceof ModelElementBase) {
+ if (obj instanceof PropertyBase) {
+ return new PropertyModel((PropertyBase) obj, this);
+ } else if (obj instanceof ClassName) {
+ return create(obj, ClassNameModel.FACTORY);
+ } else if (obj instanceof ModelElementBase) {
return new ModelElementBaseTemplateModel((ModelElementBase) obj, this);
+ } else {
+ return super.wrap(obj);
}
-
- return super.wrap(obj);
}
}
Modified: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/PropertyModel.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/PropertyModel.java 2010-05-26 22:16:20 UTC (rev 17299)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/freemarker/PropertyModel.java 2010-05-26 23:43:23 UTC (rev 17300)
@@ -72,24 +72,12 @@
value = getName();
} else if ("capitalizeName".equals(key)) {
value = capitalizeName();
- } else if ("simpleTypeName".equals(key)) {
- value = this.property.getType().getSimpleName();
- } else if ("boxingClass".equals(key)) {
- value = this.property.getType().getBoxingName();
- } else if ("isPrimitive".equals(key)) {
- value = this.property.isPrimitive();
- } else if ("isPredefined".equals(key)) {
- value = this.property.isPrimitive() || isFromJavaLang(this.property.getType());
} else if ("typeForCasting".equals(key)) {
value = typeForCasting();
- } else if ("required".equals(key)) {
- value = String.valueOf(this.property.isRequired());
} else if ("isBingingAttribute".equals(key)) {
value = isBingingAttribute();
} else if ("isBinging".equals(key)) {
value = isBinging();
- } else if ("type".equals(key)) {
- value = this.property.getType().getName();
} else {
return super.get(key);
}
14 years, 1 month
JBoss Rich Faces SVN: r17299 - root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib.
by richfaces-svn-commits@lists.jboss.org
Author: alexsmirnov
Date: 2010-05-26 18:16:20 -0400 (Wed, 26 May 2010)
New Revision: 17299
Modified:
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibGeneratorVisitor.java
root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibWriter.java
Log:
Skip writing of taglib if it is empty.
Modified: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibGeneratorVisitor.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibGeneratorVisitor.java 2010-05-26 19:19:25 UTC (rev 17298)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibGeneratorVisitor.java 2010-05-26 22:16:20 UTC (rev 17299)
@@ -61,11 +61,19 @@
*/
private Element faceletTaglib;
+ private boolean empty=true;
-
public TaglibGeneratorVisitor() {
}
+ /**
+ * <p class="changed_added_4_0"></p>
+ * @return the empty
+ */
+ public boolean isEmpty() {
+ return this.empty;
+ }
+
public Document getDocument() {
return document;
}
@@ -208,12 +216,9 @@
}
private Element createTag(String tagName) {
- if (tagName == null) {
- System.out.println("tagName == null");
- }
Element tag = faceletTaglib.addElement("tag");
tag.addElement("tag-name").addText(tagName);
-
+ empty=false;
return tag;
}
@@ -240,6 +245,7 @@
functionElement.addElement("function-name").addText(model.getName());
functionElement.addElement("function-class").addText(model.getFunctionClass().toString());
functionElement.addElement("function-signature").addText(model.getSignature());
+ empty=false;
}
return null;
}
Modified: root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibWriter.java
===================================================================
--- root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibWriter.java 2010-05-26 19:19:25 UTC (rev 17298)
+++ root/cdk/trunk/plugins/generator/src/main/java/org/richfaces/cdk/generate/taglib/TaglibWriter.java 2010-05-26 22:16:20 UTC (rev 17299)
@@ -52,22 +52,20 @@
@Override
public void render(ComponentLibrary library) throws CdkException {
TaglibGeneratorVisitor visitor = new TaglibGeneratorVisitor();
- library.accept(visitor,library);
+ library.accept(visitor, library);
+ if (!visitor.isEmpty()) {
+ Document document = visitor.getDocument();
+ try {
+ OutputFormat format1 = OutputFormat.createPrettyPrint();
+ format1.setIndentSize(4);
- Document document = visitor.getDocument();
- if (document.getRootElement().elements("tag").isEmpty()) {
- return;
- }
+ XMLWriter writer = new XMLWriter(getOutput(library), format1);
+ writer.write(document);
+ writer.close();
+ } catch (IOException e) {
+ e.printStackTrace(); // TODO
+ }
- try {
- OutputFormat format1 = OutputFormat.createPrettyPrint();
- format1.setIndentSize(4);
-
- XMLWriter writer = new XMLWriter(getOutput(library), format1);
- writer.write(document);
- writer.close();
- } catch (IOException e) {
- e.printStackTrace(); // TODO
}
}
14 years, 1 month
JBoss Rich Faces SVN: r17298 - in root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces: commandLink and 1 other directory.
by richfaces-svn-commits@lists.jboss.org
Author: nbelaevski
Date: 2010-05-26 15:19:25 -0400 (Wed, 26 May 2010)
New Revision: 17298
Modified:
root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandButton/commandButton.xhtml
root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandLink/commandLink.xhtml
Log:
https://jira.jboss.org/browse/RF-8696
Modified: root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandButton/commandButton.xhtml
===================================================================
--- root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandButton/commandButton.xhtml 2010-05-26 19:18:57 UTC (rev 17297)
+++ root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandButton/commandButton.xhtml 2010-05-26 19:19:25 UTC (rev 17298)
@@ -21,7 +21,7 @@
<h:panelGrid columns="3">
<h:outputText value="Name:" />
<h:inputText value="#{userBean.name}" />
- <a4j:commandButton value="Say Hello" render="out" />
+ <a4j:commandButton value="Say Hello" render="out" execute="@form" />
</h:panelGrid>
</h:form>
<br />
Modified: root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandLink/commandLink.xhtml
===================================================================
--- root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandLink/commandLink.xhtml 2010-05-26 19:18:57 UTC (rev 17297)
+++ root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/commandLink/commandLink.xhtml 2010-05-26 19:19:25 UTC (rev 17298)
@@ -21,7 +21,7 @@
<h:panelGrid columns="3">
<h:outputText value="Name:" />
<h:inputText value="#{userBean.name}" />
- <a4j:commandLink value="Say Hello" render="out" />
+ <a4j:commandLink value="Say Hello" render="out" execute="@form" />
</h:panelGrid>
</h:form>
<br />
14 years, 1 month