Author: SeanRogers Date: 2011-03-23 21:53:32 -0400 (Wed, 23 Mar 2011) New Revision: 22299 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml Log: Updates based on QE review RFPL-1384 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -138,7 +138,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 using the RichFaces 4 template. 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 + RichFaces 4</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 using the RichFaces 4 template. In <productname>JBoss Tools</productname>, select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem><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> <para> If necessary, update the JSF 2 JAR files to the latest versions. @@ -147,7 +147,7 @@ <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 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>. + Add <filename>richfaces-core-api.jar</filename>, <filename>richfaces-core-impl.jar</filename>, <filename>richfaces-components-api.jar</filename>, and <filename>richfaces-components-ui.jar</filename> into your project. Copy 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> </step> <step id="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries"> @@ -164,8 +164,10 @@ </procedure> <para> - You are now ready to begin constructing your RichFaces applications. RichFaces components can be dragged and dropped into your application's XHTML pages from the RichFaces palette in <productname>JBoss Tools</productname>, shown in <xref linkend="figu-Developer_Guide-Creating_a_project-RichFaces_palette_in_JBoss_Tools" /> + You are now ready to begin constructing your RichFaces applications. RichFaces components can be dragged and dropped into your application's XHTML pages from the RichFaces palette in <productname>JBoss Tools</productname>. + <!--, shown in <xref linkend="figu-Developer_Guide-Creating_a_project-RichFaces_palette_in_JBoss_Tools" />--> </para> + <!-- TODO need an updated screenshot <figure id="figu-Developer_Guide-Creating_a_project-RichFaces_palette_in_JBoss_Tools"> <title>RichFaces palette in JBoss Tools</title> <mediaobject> @@ -179,6 +181,7 @@ </textobject> </mediaobject> </figure> + --> </section> <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_Maven"> @@ -201,7 +204,7 @@ A Maven archetype is a template for creating projects. <productname>Maven</productname> uses an archetype to generate a directory structure and files for a particular project, as well as creating <filename>pom.xml</filename> files that contain build instructions. </para> <para> - The RichFaces Component Development Kit includes a Maven archetype named <filename>richfaces-archetype-simpleapp</filename> for generating the basic structure and requirements for a RichFaces application project. Maven can obtain the archetype from the JBoss repository at <filename>https://repository.jboss.org/nexus/content/groups/public/<...;. The archetype is also included with the RichFaces source code in the <filename>archetypes</filename> directory. Follow the procedure in this section to generate a new Maven-based RichFaces project using the archetype. + The RichFaces Component Development Kit includes a Maven archetype named <filename>richfaces-archetype-simpleapp</filename> for generating the basic structure and requirements for a RichFaces application project. Maven can obtain the archetype from the JBoss repository at <ulink url="https://repository.jboss.org/nexus/content/groups/public/"...;. The archetype is also included with the RichFaces source code in the <filename>archetypes</filename> directory. Follow the procedure in this section to generate a new Maven-based RichFaces project using the archetype. </para> <procedure> <step id="step-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories"> @@ -260,6 +263,7 @@ </para> <screen><replaceable>new_project</replaceable> ├── <filename>pom.xml</filename> + ├── <filename>readme.txt</filename> └── <filename>src</filename> └── <filename>main</filename> ├── <filename>java</filename> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Introduction.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -24,7 +24,7 @@ </listitem> <listitem> <para> - Generate binary resources on the fly. Extensions to JSF 2 resource handlind facilities can generate images, sounds, <application>Microsoft Excel</application> spreadsheets, and more during run-time. + Generate binary resources on the fly. Extensions to JSF 2 resource-handling facilities can generate images, sounds, <application>Microsoft Excel</application> spreadsheets, and more during run-time. </para> </listitem> <listitem> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -70,7 +70,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> @@ -88,7 +88,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> @@ -106,7 +106,7 @@ </listitem> <listitem> <para> - <productname>Google Chrome</productname> + <productname>Google Chrome 1.0</productname> and higher </para> </listitem> <listitem> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2011-03-24 00:54:09 UTC (rev 22298) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Skinning_and_theming.xml 2011-03-24 01:53:32 UTC (rev 22299) @@ -92,7 +92,7 @@ To add one of these skins to your application, add the <literal>org.richfaces.SKIN</literal> context parameter to the <filename>web.xml</filename> configuration file: </para> <programlisting>&lt;context-param&gt; - &lt;param-name&gt;org.richfaces.SKIN&lt;/param-name&gt; + &lt;param-name&gt;org.richfaces.skin&lt;/param-name&gt; &lt;param-value&gt;<replaceable>skin_name</replaceable>&lt;/param-value&gt; &lt;/context-param&gt;</programlisting> </section> @@ -132,294 +132,222 @@ <section id="sect-Developer_Guide-Skinning_overview-Skin_parameter_tables"> <title>Skin parameter tables</title> <para> - <xref linkend="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin" /> lists the default values for the parameter settings in the <literal>blueSky</literal> skin. These values are all listed in the <filename>buleSky.skin.properties</filename> file, which can be customized and extended as described in <xref linkend="sect-Developer_Guide-Skinning_and_theming-Customizing_skins" />. + <xref linkend="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin" /> lists the default values for the parameter settings in the <literal>blueSky</literal> skin. These values are all listed in the <filename>blueSky.skin.properties</filename> file, which can be customized and extended as described in <xref linkend="sect-Developer_Guide-Skinning_and_theming-Customizing_skins" />. </para> <table id="tabl-Developer_Guide-Skin_parameter_tables_in_RichFaces-Parameter_settings_for_the_blueSky_skin"> <title>Parameter settings for the <literal>blueSky</literal> skin</title> <tgroup cols="2"> <thead> <row> - <entry> - Parameter name - </entry> - <entry> - Default value - </entry> + <entry>Parameter name</entry> + <entry>Default value</entry> </row> </thead> <tbody> <row> - <entry><parameter> - headerBackgroundColor - </parameter></entry> - <entry><literal> - #BED6F8 - </literal></entry> + <entry><parameter>headerBackgroundColor</parameter></entry> + <entry><literal>#BED6F8</literal></entry> </row> <row> - <entry><parameter> - headerGradientColor - </parameter></entry> - <entry><literal> - #F2F7FF - </literal></entry> + <entry><parameter>headerGradientColor</parameter></entry> + <entry><literal>#F2F7FF</literal></entry> </row> <row> - <entry><parameter> - headTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>headTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - headerWeightFont - </parameter></entry> - <entry><literal> - bold - </literal></entry> + <entry><parameter>headerWeightFont</parameter></entry> + <entry><literal>bold</literal></entry> </row> <row> - <entry><parameter> - generalBackgroundColor - </parameter></entry> - <entry><literal> - #FFFFFF - </literal></entry> + <entry><parameter>generalBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - generalTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>generalTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - generalSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>generalSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> </row> <row> - <entry><parameter> - generalFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>generalFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> </row> <row> - <entry><parameter> - controlTextColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>controlTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - controlBackgroundColor - </parameter></entry> - <entry><literal> - #ffffff - </literal></entry> + <entry><parameter>controlBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - additionalBackgroundColor - </parameter></entry> - <entry><literal> - #ECF4FE - </literal></entry> + <entry><parameter>additionalBackgroundColor</parameter></entry> + <entry><literal>#ECF4FE</literal></entry> </row> <row> - <entry><parameter> - shadowBackgroundColor - </parameter></entry> - <entry><literal> - #000000 - </literal></entry> + <entry><parameter>shadowBackgroundColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - shadowOpacity - </parameter></entry> - <entry><literal> - 1 - </literal></entry> + <entry><parameter>shadowOpacity</parameter></entry> + <entry><literal>1</literal></entry> </row> <row> - <entry><parameter> - panelBorderColor - </parameter></entry> - <entry><literal> - #BED6F8 - </literal></entry> + <entry><parameter>panelBorderColor</parameter></entry> + <entry><literal>#BED6F8</literal></entry> </row> <row> - <entry><parameter> - subBorderColor - </parameter></entry> - <entry><literal> - #ffffff - </literal></entry> + <entry><parameter>subBorderColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> </row> <row> - <entry><parameter> - tabBackgroundColor - </parameter></entry> - <entry><literal> - #C6DEFF - </literal></entry> + <entry><parameter>calendarWeekBackgroundColor</parameter></entry> + <entry><literal>#F5F5F5</literal></entry> </row> <row> - <entry><parameter> - tabDisabledTextColor - </parameter></entry> - <entry><literal> - #8DB7F3 - </literal></entry> + <entry><parameter>calendarHolidaysBackgroundColor</parameter></entry> + <entry><literal>#FFEBDA</literal></entry> </row> <row> - <entry><parameter> - trimColor - </parameter></entry> - <entry><literal> - #D6E6FB - </literal></entry> + <entry><parameter>calendarHolidaysTextColor</parameter></entry> + <entry><literal>#FF7800</literal></entry> </row> <row> - <entry><parameter> - tipBackgroundColor - </parameter></entry> - <entry><literal> - #FAE6B0 - </literal></entry> + <entry><parameter>calendarCurrentBackgroundColor</parameter></entry> + <entry><literal>#FF7800</literal></entry> </row> <row> - <entry><parameter> - tipBorderColor - </parameter></entry> - <entry><literal> - #E5973E - </literal></entry> + <entry><parameter>calendarCurrentTextColor</parameter></entry> + <entry><literal>#FFEBDA</literal></entry> </row> <row> - <entry><parameter> - selectControlColor - </parameter></entry> - <entry><literal> - #E79A00 - </literal></entry> + <entry><parameter>calendarSpecBackgroundColor</parameter></entry> + <entry><literal>#E4F5E2</literal></entry> </row> <row> - <entry><parameter> - generalLinkColor - </parameter></entry> - <entry><literal> - #0078D0 - </literal></entry> + <entry><parameter>calendarSpecTextColor</parameter></entry> + <entry><literal>#000000</literal></entry> </row> <row> - <entry><parameter> - hoverLinkColor - </parameter></entry> - <entry><literal> - #0090FF - </literal></entry> + <entry><parameter>editorBackgroundColor</parameter></entry> + <entry><literal>#F1F1F1</literal></entry> </row> <row> - <entry><parameter> - visitedLinkColor - </parameter></entry> - <entry><literal> - #0090FF - </literal></entry> + <entry><parameter>editBackgroundColor</parameter></entry> + <entry><literal>#FEFFDA</literal></entry> </row> <row> - <entry><parameter> - headerSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>errorColor</parameter></entry> + <entry><literal>#FF0000</literal></entry> </row> <row> - <entry><parameter> - headerFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>gradientType</parameter></entry> + <entry><literal>plain</literal></entry> </row> <row> - <entry><parameter> - tabSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>tabBackgroundColor</parameter></entry> + <entry><literal>#C6DEFF</literal></entry> </row> <row> - <entry><parameter> - tabFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>tabDisabledTextColor</parameter></entry> + <entry><literal>#8DB7F3</literal></entry> </row> <row> - <entry><parameter> - buttonSizeFont - </parameter></entry> - <entry><literal> - 11px - </literal></entry> + <entry><parameter>tableHeaderBackgroundColor</parameter></entry> + <entry><literal>#D6E6FB</literal></entry> </row> <row> - <entry><parameter> - buttonFamilyFont - </parameter></entry> - <entry><literal> - Arial, Verdana, sans-serif - </literal></entry> + <entry><parameter>tableSubHeaderBackgroundColor</parameter></entry> + <entry><literal>#ECF4FE</literal></entry> </row> <row> - <entry><parameter> - tableBackgroundColor - </parameter></entry> - <entry><literal> - #FFFFFF - </literal></entry> + <entry><parameter>tableBorderWidth</parameter></entry> + <entry><literal>1px</literal></entry> </row> <row> - <entry><parameter> - tableFooterBackgroundColor - </parameter></entry> - <entry><literal> - #cccccc - </literal></entry> + <entry><parameter>tableHeaderTextColor</parameter></entry> + <entry><literal>#0B356C</literal></entry> </row> <row> - <entry><parameter> - tableSubfooterBackgroundColor - </parameter></entry> - <entry><literal> - #f1f1f1 - </literal></entry> + <entry><parameter>trimColor</parameter></entry> + <entry><literal>#D6E6FB</literal></entry> </row> <row> - <entry><parameter> - tableBorderColor - </parameter></entry> - <entry><literal> - #C0C0C0 - </literal></entry> + <entry><parameter>tipBackgroundColor</parameter></entry> + <entry><literal>#FAE6B0</literal></entry> </row> + <row> + <entry><parameter>tipBorderColor</parameter></entry> + <entry><literal>#E5973E</literal></entry> + </row> + <row> + <entry><parameter>selectControlColor</parameter></entry> + <entry><literal>#E79A00</literal></entry> + </row> + <row> + <entry><parameter>generalLinkColor</parameter></entry> + <entry><literal>#0078D0</literal></entry> + </row> + <row> + <entry><parameter>hoverLinkColor</parameter></entry> + <entry><literal>#0090FF</literal></entry> + </row> + <row> + <entry><parameter>visitedLinkColor</parameter></entry> + <entry><literal>#0090FF</literal></entry> + </row> + <row> + <entry><parameter>headerSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>headerFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>tabSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>tabFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>buttonSizeFont</parameter></entry> + <entry><literal>11px</literal></entry> + </row> + <row> + <entry><parameter>buttonFamilyFont</parameter></entry> + <entry><literal>Arial, Verdana, sans-serif</literal></entry> + </row> + <row> + <entry><parameter>tableBackgroundColor</parameter></entry> + <entry><literal>#FFFFFF</literal></entry> + </row> + <row> + <entry><parameter>tableFooterBackgroundColor</parameter></entry> + <entry><literal>#CCCCCC</literal></entry> + </row> + <row> + <entry><parameter>tableSubfooterBackgroundColor</parameter></entry> + <entry><literal>#F1F1F1</literal></entry> + </row> + <row> + <entry><parameter>tableBorderColor</parameter></entry> + <entry><literal>#C0C0C0</literal></entry> + </row> + <row> + <entry><parameter>warningColor</parameter></entry> + <entry><literal>#FFE6E6</literal></entry> + </row> + <row> + <entry><parameter>warningBackgroundColor</parameter></entry> + <entry><literal>#FF0000</literal></entry> + </row> </tbody> </tgroup> </table> @@ -587,7 +515,7 @@ <para> This example takes the <literal>blueSky</literal> skin as a base and only changes the <varname>generalSizeFont</varname> parameter. </para> - <programlisting>baseSkin=blueSky + <programlisting>baseSkin=blueSky generalSizeFont=12pt</programlisting> </example> </step> @@ -596,7 +524,7 @@ <step> <title>Reference the skin definition</title> <para>Add a skin definition <sgmltag>&lt;context-param&gt;</sgmltag> to the <filename>web.xml</filename> settings file of your application:</para> - <programlisting>&lt;context-param&gt; + <programlisting language="XML" role="XML">&lt;context-param&gt; &lt;param-name&gt;org.richfaces.skin&lt;/param-name&gt; &lt;param-value&gt;<replaceable>new_skin_name</replaceable>&lt;/param-value&gt; &lt;/context-param&gt;</programlisting> @@ -626,7 +554,7 @@ <para> Alternatively, use <acronym>EL</acronym> (Expression Language) to reference the skin bean from the <filename>web.xml</filename> settings file. </para> -<programlisting language="XML" role="XML">&lt;context-param&gt; + <programlisting language="XML" role="XML">&lt;context-param&gt; &lt;param-name&gt;org.richfaces.skin&lt;/param-name&gt; &lt;param-value&gt;#{skinBean.skin}&lt;/param-value&gt; &lt;/context-param&gt;</programlisting> @@ -639,7 +567,7 @@ The application needs an initial skin to display before the user chooses an alternative skin. Specify the skin in your class with <code>@ManagedProperty</code>. </para> <programlisting language="Java" role="JAVA">@ManagedProperty(value="blueSky") -Private String skin;</programlisting> +private String skin;</programlisting> <stepalternatives> <step> <para>