[richfaces-svn-commits] JBoss Rich Faces SVN: r13497 - trunk/docs/userguide/en/src/main/docbook/modules.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Fri Apr 10 11:11:17 EDT 2009


Author: ochikvina
Date: 2009-04-10 11:11:17 -0400 (Fri, 10 Apr 2009)
New Revision: 13497

Modified:
   trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
   trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
https://jira.jboss.org/jira/browse/RF-5117 - correcting code samples;

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml	2009-04-10 14:31:21 UTC (rev 13496)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml	2009-04-10 15:11:17 UTC (rev 13497)
@@ -88,12 +88,11 @@
                               <emphasis role="bold">Example:</emphasis>
                     </para>
                     <programlisting role="XML"><![CDATA[...
-          <context-param>
-	          <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
-		<param-value>com.sun.facelets.FaceletViewHandler</param-value>
-	</context-param>
-...]]>
-		</programlisting>
+<context-param>
+     <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
+     <param-value>com.sun.facelets.FaceletViewHandler</param-value>
+</context-param>
+...]]></programlisting>
                     <para> says that <property>Facelets</property> will officially be the first,
                               however <code>AjaxViewHandler</code> will be a little ahead
                               temporarily to do some small, but very important job. </para>
@@ -114,78 +113,77 @@
                     <para> Your web.xml for <property>Seam 1.2</property> must be like this: </para>
                     <programlisting role="XML"><![CDATA[<?xml version="1.0" ?>
 <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
-        version="2.4">
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
+                   version="2.4">
 
-    <!-- richfaces -->
+     <!-- richfaces -->
 
-    <filter>
-        <display-name>RichFaces Filter</display-name>
-        <filter-name>richfaces</filter-name>
-        <filter-class>org.ajax4jsf.Filter</filter-class>
-    </filter>
+     <filter>
+          <display-name>RichFaces Filter</display-name>
+          <filter-name>richfaces</filter-name>
+          <filter-class>org.ajax4jsf.Filter</filter-class>
+     </filter>
 
-    <filter-mapping>
-        <filter-name>richfaces</filter-name>
-        <url-pattern>*.seam</url-pattern>
-    </filter-mapping>
+     <filter-mapping>
+          <filter-name>richfaces</filter-name>
+          <url-pattern>*.seam</url-pattern>
+     </filter-mapping>
 
-<!-- Seam -->
+     <!-- Seam -->
 
-    <listener>
-        <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
-    </listener>
+     <listener>
+          <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
+     </listener>
 
-    <servlet>
-        <servlet-name>Seam Resource Servlet</servlet-name>
-        <servlet-class>org.jboss.seam.servlet.ResourceServlet</servlet-class>
-    </servlet>
+     <servlet>
+          <servlet-name>Seam Resource Servlet</servlet-name>
+          <servlet-class>org.jboss.seam.servlet.ResourceServlet</servlet-class>
+     </servlet>
 
-    <servlet-mapping>
-        <servlet-name>Seam Resource Servlet</servlet-name>
-        <url-pattern>/seam/resource/*</url-pattern>
-    </servlet-mapping>
+     <servlet-mapping>
+          <servlet-name>Seam Resource Servlet</servlet-name>
+          <url-pattern>/seam/resource/*</url-pattern>
+     </servlet-mapping>
 
-    <filter>
-        <filter-name>Seam Filter</filter-name>
-        <filter-class>org.jboss.seam.web.SeamFilter</filter-class>
-    </filter>
+     <filter>
+          <filter-name>Seam Filter</filter-name>
+          <filter-class>org.jboss.seam.web.SeamFilter</filter-class>
+     </filter>
 
-    <filter-mapping>
-        <filter-name>Seam Filter</filter-name>
-        <url-pattern>/*</url-pattern>
-    </filter-mapping>
+     <filter-mapping>
+          <filter-name>Seam Filter</filter-name>
+          <url-pattern>/*</url-pattern>
+     </filter-mapping>
 
-   <!-- MyFaces -->
+     <!-- MyFaces -->
 
-    <listener>
-         <listener-class>org.apache.myfaces.webapp.StartupServletContextListener</listener-class>
-    </listener>
+     <listener>
+          <listener-class>org.apache.myfaces.webapp.StartupServletContextListener</listener-class>
+     </listener>
 
-    <!-- JSF -->
+     <!-- JSF -->
 
-    <context-param>
-        <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
-        <param-value>client</param-value>
-    </context-param>
+     <context-param>
+          <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
+          <param-value>client</param-value>
+     </context-param>
 
-    <context-param>
-        <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
-        <param-value>.xhtml</param-value>
-    </context-param>
+     <context-param>
+          <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
+         <param-value>.xhtml</param-value>
+     </context-param>
 
-    <servlet>
-        <servlet-name>Faces Servlet</servlet-name>
-        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
-        <load-on-startup>1</load-on-startup>
-    </servlet>
+     <servlet>
+          <servlet-name>Faces Servlet</servlet-name>
+          <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+          <load-on-startup>1</load-on-startup>
+     </servlet>
 
-    <servlet-mapping>
-        <servlet-name>Faces Servlet</servlet-name>
-        <url-pattern>*.seam</url-pattern>
-    </servlet-mapping>
-
+     <servlet-mapping>
+          <servlet-name>Faces Servlet</servlet-name>
+          <url-pattern>*.seam</url-pattern>
+     </servlet-mapping>
 </web-app>]]></programlisting>
                     <para>
                               <property>Seam 2</property> supports RichFaces Filter. Thus your
@@ -193,64 +191,63 @@
 
                     <programlisting role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
 <web-app version="2.5"
-    xmlns="http://java.sun.com/xml/ns/javaee"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
+                   xmlns="http://java.sun.com/xml/ns/javaee"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 
-    <context-param>
-        <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
-        <param-value>com.sun.facelets.FaceletViewHandler</param-value>
-    </context-param>
+     <context-param>
+          <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
+          <param-value>com.sun.facelets.FaceletViewHandler</param-value>
+     </context-param>
 
-    <!-- Seam -->
+     <!-- Seam -->
 
-    <listener>
-        <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
-    </listener>
+     <listener>
+          <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
+     </listener>
 
-    <servlet>
-        <servlet-name>Seam Resource Servlet</servlet-name>
-        <servlet-class>org.jboss.seam.servlet.SeamResourceServlet</servlet-class>
-    </servlet>
+     <servlet>
+          <servlet-name>Seam Resource Servlet</servlet-name>
+          <servlet-class>org.jboss.seam.servlet.SeamResourceServlet</servlet-class>
+     </servlet>
 
-    <servlet-mapping>
-        <servlet-name>Seam Resource Servlet</servlet-name>
-        <url-pattern>/seam/resource/*</url-pattern>
-    </servlet-mapping>
+     <servlet-mapping>
+          <servlet-name>Seam Resource Servlet</servlet-name>
+          <url-pattern>/seam/resource/*</url-pattern>
+     </servlet-mapping>
 
-    <filter>
-        <filter-name>Seam Filter</filter-name>
-        <filter-class>org.jboss.seam.servlet.SeamFilter</filter-class>
-    </filter>
+     <filter>
+          <filter-name>Seam Filter</filter-name>
+          <filter-class>org.jboss.seam.servlet.SeamFilter</filter-class>
+     </filter>
 
-    <filter-mapping>
-        <filter-name>Seam Filter</filter-name>
-        <url-pattern>/*</url-pattern>
-    </filter-mapping>
+     <filter-mapping>
+          <filter-name>Seam Filter</filter-name>
+          <url-pattern>/*</url-pattern>
+     </filter-mapping>
 
-    <!-- JSF -->
+     <!-- JSF -->
 
-    <context-param>
-        <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
-        <param-value>.xhtml</param-value>
-    </context-param>
+     <context-param>
+          <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
+          <param-value>.xhtml</param-value>
+     </context-param>
 
-    <context-param>
-        <param-name>facelets.DEVELOPMENT</param-name>
-        <param-value>true</param-value>
-    </context-param>
+     <context-param>
+          <param-name>facelets.DEVELOPMENT</param-name>
+          <param-value>true</param-value>
+     </context-param>
 
-    <servlet>
-        <servlet-name>Faces Servlet</servlet-name>
-        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
-        <load-on-startup>1</load-on-startup>
-    </servlet>
+     <servlet>
+          <servlet-name>Faces Servlet</servlet-name>
+          <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+          <load-on-startup>1</load-on-startup>
+     </servlet>
 
-    <servlet-mapping>
-        <servlet-name>Faces Servlet</servlet-name>
-        <url-pattern>*.seam</url-pattern>
-    </servlet-mapping>
-
+     <servlet-mapping>
+          <servlet-name>Faces Servlet</servlet-name>
+          <url-pattern>*.seam</url-pattern>
+     </servlet-mapping>
 </web-app>]]></programlisting>
 
                     <para> Only one issue still persists while using <property>Seam</property> with
@@ -276,13 +273,12 @@
                               <emphasis role="bold">Example:</emphasis>
                     </para>
                     <programlisting role="XML"><![CDATA[...
-    <servlet>
-          <servlet-name>Faces Servlet</servlet-name>
-          <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
-          <load-on-startup>0</load-on-startup>
-    </servlet>
-...
-]]></programlisting>
+<servlet>
+     <servlet-name>Faces Servlet</servlet-name>
+     <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+     <load-on-startup>0</load-on-startup>
+</servlet>
+...]]></programlisting>
                     <para> This is because, EAServer calls servlet <code>init()</code> before the
                                         <code>ServletContextInitializer</code>. Not an EAServer bug,
                               this is in Servlet 2.3 spec. </para>
@@ -294,12 +290,13 @@
                               application&apos;s class loader from importing the Oracle XML
                               parser. Use the following notation in
                               <property>orion-application.xml</property> : </para>
+                    
                     <programlisting role="XML"><![CDATA[...
 <imported-shared-libraries>
-        <remove-inherited name="oracle.xml"/>
-        <remove-inherited name="oracle.xml.security"/>
+     <remove-inherited name="oracle.xml"/>
+     <remove-inherited name="oracle.xml.security"/>
 </imported-shared-libraries>
-...
-]]></programlisting>
+...]]></programlisting>
+                    
           </section>
 </chapter>

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2009-04-10 14:31:21 UTC (rev 13496)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2009-04-10 15:11:17 UTC (rev 13497)
@@ -1629,9 +1629,9 @@
 			<para>
 				<emphasis role="bold">Example:</emphasis>
 			</para>
-			<programlisting role="XML">
-				<![CDATA[<div class="dr-pnl rich-panel"> ... </div>]]>
-			</programlisting>
+			<programlisting role="XML"><![CDATA[<div class="dr-pnl rich-panel">
+     ...
+</div>]]></programlisting>
 			<para> dr-pnl is a CSS class specified in the framework via skin parameters: </para>
 			<itemizedlist>
 				<listitem>
@@ -1658,10 +1658,8 @@
 			<para>
 				<emphasis role="bold">Example:</emphasis>
 			</para>
-			<programlisting role="XML">
-				<![CDATA[<rich:panel styleClass="customClass" />]]>
-			</programlisting>
-			<para> Could add some style properties from customClass to one particular panel, as a
+			<programlisting role="XML"><![CDATA[<rich:panel styleClass="customClass" />]]></programlisting>
+			<para>Could add some style properties from customClass to one particular panel, as a
 				result we get three styles: </para>
 			<para>
 				<emphasis role="bold">Example:</emphasis>
@@ -1903,8 +1901,8 @@
 					</para>
 					<programlisting role="XML"><![CDATA[...
 <context-param>
-	<param-name>org.richfaces.SKIN</param-name>
-    <param-value>name</param-value>
+     <param-name>org.richfaces.SKIN</param-name>
+     <param-value>name</param-value>
 </context-param>
 ...]]></programlisting>
 				</listitem>
@@ -1939,10 +1937,8 @@
 					<para> Create a custom render kit and register it in the faces-config.xml like
 						this: </para>
 					<programlisting role="XML"><![CDATA[<render-kit>
-	<render-kit-id>NEW_SKIN</render-kit-id>
-    	<render-kit-class>
-            org.ajax4jsf.framework.renderer.ChameleonRenderKitImpl
-        </render-kit-class>
+     <render-kit-id>NEW_SKIN</render-kit-id>
+     <render-kit-class>org.ajax4jsf.framework.renderer.ChameleonRenderKitImpl</render-kit-class>
 </render-kit>]]></programlisting>
 				</listitem>
 				<listitem>
@@ -2026,35 +2022,32 @@
                 To do this, edit the file properties of the skin. Here is an example of the code for page:
 			</para>
 			<programlisting role="XML"><![CDATA[<h:form>
-	<div style="display: block; float: left"><h:selectOneRadio
-			value="#{skinBean.skin}" border="0" layout="pageDirection"
-			title="Changing skin" style="font-size: 8; font-family: comic"
-			onchange="submit()">
-			<f:selectItem itemLabel="plain" itemValue="plain" />
-			<f:selectItem itemLabel="emeraldTown" itemValue="emeraldTown" />
-			<f:selectItem itemLabel="blueSky" itemValue="blueSky" />
-			<f:selectItem itemLabel="wine" itemValue="wine" />
-			<f:selectItem itemLabel="japanCherry" itemValue="japanCherry" />
-			<f:selectItem itemLabel="ruby" itemValue="ruby" />
-			<f:selectItem itemLabel="classic" itemValue="classic" />
-			<f:selectItem itemLabel="laguna" itemValue="laguna" />
-			<f:selectItem itemLabel="deepMarine" itemValue="deepMarine" />
-			<f:selectItem itemLabel="blueSky Modified" itemValue="blueSkyModify" />
-		</h:selectOneRadio>
-	</div>
-	<div style="display: block; float: left">
-		<rich:panelBar height="100" width="200">
-			<rich:panelBarItem label="Item 1" style="font-family: monospace; font-size: 12;">
-			Changing skin in runtime
-			</rich:panelBarItem>
-			<rich:panelBarItem label="Item 2"
-				style="font-family: monospace; font-size: 12;">
-			 This is a result of the modification "blueSky" skin
-			</rich:panelBarItem>
-		</rich:panelBar>
-	</div>
-</h:form>]]>
-			</programlisting>
+     <div style="display: block; float: left">
+          <h:selectOneRadio value="#{skinBean.skin}" border="0" layout="pageDirection" title="Changing skin" style="font-size: 8; font-family: comic" onchange="submit()">
+               	<f:selectItem itemLabel="plain" itemValue="plain" />
+		<f:selectItem itemLabel="emeraldTown" itemValue="emeraldTown" />
+		<f:selectItem itemLabel="blueSky" itemValue="blueSky" />
+		<f:selectItem itemLabel="wine" itemValue="wine" />
+		<f:selectItem itemLabel="japanCherry" itemValue="japanCherry" />
+		<f:selectItem itemLabel="ruby" itemValue="ruby" />
+		<f:selectItem itemLabel="classic" itemValue="classic" />
+		<f:selectItem itemLabel="laguna" itemValue="laguna" />
+		<f:selectItem itemLabel="deepMarine" itemValue="deepMarine" />
+		<f:selectItem itemLabel="blueSky Modified" itemValue="blueSkyModify" />
+          </h:selectOneRadio>
+     </div>
+     <div style="display: block; float: left">
+          <rich:panelBar height="100" width="200">
+               <rich:panelBarItem label="Item 1" style="font-family: monospace; font-size: 12;">
+	     Changing skin in runtime
+	</rich:panelBarItem>
+	
+	<rich:panelBarItem label="Item 2" style="font-family: monospace; font-size: 12;">
+	     This is a result of the modification "blueSky" skin
+	</rich:panelBarItem>
+          </rich:panelBar>
+     </div>
+</h:form>]]></programlisting>
 			<para>
 				This is result:
 			</para>
@@ -2080,10 +2073,7 @@
 				used. However, if you want to explicitly specify the level of skinning you want to be applied, you need to add a context parameter to your web.xml 
 				with <code>org.richfaces.CONTROL_SKINNING_LEVEL</code> as the parameter name 
 				
-				 and value  set to either <code>basic</code> or <code>extended</code>.  
-			
-			
-			
+				 and value  set to either <code>basic</code> or <code>extended</code>.  			
 			</para>
 			<itemizedlist>
 				<listitem>
@@ -2241,25 +2231,25 @@
 			<para> There is a snippet with some of them for example: </para>
 			<programlisting role="XML"><![CDATA[...
 <u:selector name=".rich-box-bgcolor-header">
-    <u:style name="background-color" skin="headerBackgroundColor" />
+     <u:style name="background-color" skin="headerBackgroundColor" />
 </u:selector>
 <u:selector name=".rich-box-bgcolor-general">
-   <u:style name="background-color" skin="generalBackgroundColor" />
+     <u:style name="background-color" skin="generalBackgroundColor" />
 </u:selector>
 ...
 //gradient elements
 ...
 <u:selector name=".rich-gradient-menu">
-    <u:style name="background-image">
-        <f:resource f:key="org.richfaces.renderkit.html.gradientimages.MenuGradientImage"/>
-    </u:style>
-    <u:style name="background-repeat" value="repeat-x" />
+     <u:style name="background-image">
+          <f:resource f:key="org.richfaces.renderkit.html.gradientimages.MenuGradientImage"/>
+     </u:style>
+     <u:style name="background-repeat" value="repeat-x" />
 </u:selector>
 <u:selector name=".rich-gradient-tab">
-    <u:style name="background-image">
-        <f:resource f:key="org.richfaces.renderkit.html.gradientimages.TabGradientImage"/>
-    </u:style>
-    <u:style name="background-repeat" value="repeat-x" />
+     <u:style name="background-image">
+          <f:resource f:key="org.richfaces.renderkit.html.gradientimages.TabGradientImage"/>
+     </u:style>
+     <u:style name="background-repeat" value="repeat-x" />
 </u:selector>
 ...]]></programlisting>
 			<para> To get a better idea of standard component skinning we recommend to explore CSS
@@ -3191,10 +3181,10 @@
 				CSS format. </para>
 			<programlisting role="CSS"><![CDATA[...
 .rich-component-name {
-	background-color: additionalBackgroundColor; /*the value of the constant defined by your skin*/
-	border-color: tableBorderColor; /*the value of the constant defined by your skin*/
-	border-width: tableBorderWidth /*the value of the constant defined by your skin*/
-	border-style: solid;
+     background-color: additionalBackgroundColor; /*the value of the constant defined by your skin*/
+     border-color: tableBorderColor; /*the value of the constant defined by your skin*/
+     border-width: tableBorderWidth; /*the value of the constant defined by your skin*/
+     border-style: solid;
 }
 ...]]></programlisting>
 			<para> The <emphasis>
@@ -3407,10 +3397,9 @@
 							<code>&lt;f:verbatim&gt; &lt;![CDATA[ ...]]&gt;
 							&lt;/f:verbatim&gt;</code> tags.</para>
 					<para>For example </para>
-					<programlisting role="XML">
-<![CDATA[...
+					<programlisting role="XML"><![CDATA[...
 .rich-calendar-cell {
-	background: #537df8;
+     background: #537df8;
 }
 ...]]></programlisting>
 				</listitem>
@@ -3419,14 +3408,13 @@
 						formed in RichFaces. The XCSS tags have to be placed outside
 							<code>&lt;f:verbatim&gt; &lt;![CDATA[ ...]]&gt;
 							&lt;/f:verbatim&gt;</code> tags. </para>
-					<programlisting role="XML">
-			<![CDATA[...
+					<programlisting role="XML"><![CDATA[...
 <u:selector name=".rich-calendar-cell">
-	<u:style name="border-bottom-color" skin="panelBorderColor"/>
-	<u:style name="border-right-color" skin="panelBorderColor"/>
-	<u:style name="background-color" skin="tableBackgroundColor"/>
-	<u:style name="font-size" skin="generalSizeFont"/>
-	<u:style name="font-family" skin="generalFamilyFont"/>
+     <u:style name="border-bottom-color" skin="panelBorderColor"/>
+     <u:style name="border-right-color" skin="panelBorderColor"/>
+     <u:style name="background-color" skin="tableBackgroundColor"/>
+     <u:style name="font-size" skin="generalSizeFont"/>
+     <u:style name="font-family" skin="generalFamilyFont"/>
 </u:selector>
 ...]]></programlisting>
 				</listitem>




More information about the richfaces-svn-commits mailing list