[richfaces-svn-commits] JBoss Rich Faces SVN: r4936 - branches/3.1.x/docs/userguide/en/src/main/docbook/modules.

Author: vkorluzhenko Date: 2007-12-20 06:47:25 -0500 (Thu, 20 Dec 2007) New Revision: 4936 Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml branches/3.1.x/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml Log: http://jira.jboss.com/jira/browse/RF-1712- added new section. Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml =================================================================== --- branches/3.1.x/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-12-20 11:00:02 UTC (rev 4935) +++ branches/3.1.x/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-12-20 11:47:25 UTC (rev 4936) @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="UTF-8"?> <section id="WebApplicationDescriptorParameters"> -<?dbhtml filename="WebApplicationParameters.html"?> + <?dbhtml filename="WebApplicationParameters.html"?> <title>Web Application Descriptor Parameters</title> - <para>RichFaces doesn&apos;t require any parameters to be defined in your - web.xml. But the <property>RichFaces</property> parameters listed below may - help with development and may increase the flexibility of RichFaces - usage.</para> + <para>RichFaces doesn&apos;t require any parameters to be defined in your web.xml. But the + <property>RichFaces</property> parameters listed below may help with development and may + increase the flexibility of RichFaces usage.</para> - <para><table> + <para> + <table> <title>Initialization Parameters</title> <tgroup cols="3"> @@ -24,33 +24,54 @@ </thead> <tbody> - + <row> <entry>org.richfaces.SKIN</entry> - + <entry>DEFAULT</entry> - - <entry>Is a name of a skin used in an application. It can be a - literal string with a skin name, or the <emphasis - ><property>EL</property></emphasis> expression - (#{...}) pointed to a <emphasis - ><property>String</property></emphasis> property - (skin name) or a property of a org.richfaces.framework.skin type. + + <entry>Is a name of a skin used in an application. It can be a literal string with a + skin name, or the <emphasis> + <property>EL</property> + </emphasis> expression (#{...}) pointed to a <emphasis> + <property>String</property> + </emphasis> property (skin name) or a property of a org.richfaces.framework.skin type. Skin in last case, this instance is used as a current skin</entry> </row> - + <row> + <entry>org.richfaces.LoadScriptStrategy</entry> + + <entry>DEFAULT</entry> + + <entry>Defines how the RichFaces script files are loaded to application. Possible values + are: ALL, DEFAULT, NONE. For more information see <link + linkend="ScriptsandStylesLoadStrategy">&quot;Scripts and Styles Load + Strategy&quot;</link>.</entry> + </row> + + <row> + <entry>org.richfaces.LoadStyleStrategy</entry> + + <entry>DEFAULT</entry> + + <entry>Defines how the RichFaces style files are loaded to application. Possible values + are: ALL, DEFAULT, NONE. For more information see <link + linkend="ScriptsandStylesLoadStrategy">&quot;Scripts and Styles Load + Strategy&quot;</link>.</entry> + </row> + + <row> <entry>org.ajax4jsf.LOGFILE</entry> <entry>none</entry> - <entry>Is an URL to an application or a container log file (if - possible). If this parameter is set, content from the given URL is - shown on a <emphasis - ><property>Debug</property></emphasis> error page - in the <emphasis - ><property>iframe</property></emphasis> - window</entry> + <entry>Is an URL to an application or a container log file (if possible). If this + parameter is set, content from the given URL is shown on a <emphasis> + <property>Debug</property> + </emphasis> error page in the <emphasis> + <property>iframe</property> + </emphasis> window</entry> </row> <row> @@ -58,13 +79,12 @@ <entry>none</entry> - <entry>Is a comma-separated list of custom <emphasis - ><property>ViewHandler</property></emphasis> - instances for inserting in chain. Handlers are inserted BEFORE - RichFaces viewhandlers in the given order. For example, in facelets - application this parameter must contain - com.sun.facelets.FaceletViewHandler, instead of declaration in - faces-config.xml</entry> + <entry>Is a comma-separated list of custom <emphasis> + <property>ViewHandler</property> + </emphasis> instances for inserting in chain. Handlers are inserted BEFORE RichFaces + viewhandlers in the given order. For example, in facelets application this parameter + must contain com.sun.facelets.FaceletViewHandler, instead of declaration in + faces-config.xml</entry> </row> <row> @@ -72,13 +92,12 @@ <entry>none</entry> - <entry>Is a comma-separated list of names for a component as a - special control case, such as messages bundle loader, alias bean - components, etc. Is a type of component got by a reflection from - the static field <emphasis - ><property>COMPONENT_TYPE</property></emphasis>. - For components with such types encode methods always are called in - rendering Ajax responses, even if a component isn&apos;t in an updated + <entry>Is a comma-separated list of names for a component as a special control case, + such as messages bundle loader, alias bean components, etc. Is a type of component got + by a reflection from the static field <emphasis> + <property>COMPONENT_TYPE</property> + </emphasis>. For components with such types encode methods always are called in + rendering Ajax responses, even if a component isn&apos;t in an updated part</entry> </row> @@ -87,15 +106,13 @@ <entry>false</entry> - <entry>For generated resources, such as encrypt generation data, - it&apos;s encoded in the resource URL. For example, URL for an image - generated from the <emphasis - ><property>mediaOutput</property></emphasis> - component contains a name of a generation method, since for a - hacker attack, it is possible to create a request for any JSF - baked beans or other attributes. To prevent such attacks, set this - parameter to &quot;true&quot; in critical applications (works with JRE &gt; - 1.4 )</entry> + <entry>For generated resources, such as encrypt generation data, it&apos;s encoded + in the resource URL. For example, URL for an image generated from the <emphasis> + <property>mediaOutput</property> + </emphasis> component contains a name of a generation method, since for a hacker + attack, it is possible to create a request for any JSF baked beans or other + attributes. To prevent such attacks, set this parameter to &quot;true&quot; in + critical applications (works with JRE &gt; 1.4 )</entry> </row> <row> @@ -103,27 +120,29 @@ <entry>random</entry> - <entry>Is a password for encryption of resources data. If isn&apos;t - set, a random password is used</entry> + <entry>Is a password for encryption of resources data. If isn&apos;t set, a random + password is used</entry> </row> <row> - <entry>org.ajax4jsf.COMPRESS_SCRIPT</entry> - <entry>true</entry> - <entry>It doesn&apos;t allow framework to reformat JavaScript files (makes it impossible to debug) - </entry> + <entry>org.ajax4jsf.COMPRESS_SCRIPT</entry> + <entry>true</entry> + <entry>It doesn&apos;t allow framework to reformat JavaScript files (makes it + impossible to debug) </entry> </row> </tbody> </tgroup> - </table></para> - + </table> + </para> + <note> <title>Note:</title> <para>org.richfaces.SKIN is used in the same way as org.ajax4jsf.SKIN</para> - </note> + </note> - <para><table> + <para> + <table> <title>org.ajax4jsf.Filter Initialization Parameters</title> <tgroup cols="3"> @@ -143,9 +162,10 @@ <entry>-</entry> - <entry>Is a path (relative to web application context) to the - <emphasis ><property>log4j.xml</property></emphasis> configuration file, it can be used to setup - per-application custom logging</entry> + <entry>Is a path (relative to web application context) to the <emphasis> + <property>log4j.xml</property> + </emphasis> configuration file, it can be used to setup per-application custom + logging</entry> </row> <row> @@ -153,9 +173,9 @@ <entry>true</entry> - <entry>Enable caching of framework-generated resources (JavaScript, CSS, images, etc.). - For debug purposes development custom JavaScript or Style prevents to use old cached data in a - browser</entry> + <entry>Enable caching of framework-generated resources (JavaScript, CSS, images, etc.). + For debug purposes development custom JavaScript or Style prevents to use old cached + data in a browser</entry> </row> <row> @@ -163,14 +183,15 @@ <entry>true</entry> - <entry>Force parsing by a filter <emphasis - ><property>HTML</property></emphasis> syntax - checker on any JSF page. If &quot;false&quot;, only Ajax responses are - parsed to syntax check and conversion to well-formed XML. Setting - to &quot;false&quot; improves performance, but can provide visual effects on - Ajax updates</entry> + <entry>Force parsing by a filter <emphasis> + <property>HTML</property> + </emphasis> syntax checker on any JSF page. If &quot;false&quot;, only Ajax + responses are parsed to syntax check and conversion to well-formed XML. Setting to + &quot;false&quot; improves performance, but can provide visual effects on Ajax + updates</entry> </row> </tbody> </tgroup> - </table></para> -</section> \ No newline at end of file + </table> + </para> +</section> Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml =================================================================== --- branches/3.1.x/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-12-20 11:00:02 UTC (rev 4935) +++ branches/3.1.x/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-12-20 11:47:25 UTC (rev 4936) @@ -885,8 +885,60 @@ (&quot;TIDY&quot; filter type is used for code correction). </para> </section> + <section id="ScriptsandStylesLoadStrategy"> + <?dbhtml filename="ScriptsandStylesLoadStrategy" ?> + <title>Scripts and Styles Load Strategy</title> + <para>Before the version 3.1.3, RichFaces loaded styles and script on demand. I.e. files are + loaded only if they are required on a particular page. Since RichFaces 3.1.3, it&apos;s + possible to manage how the RichFaces script and style files are loaded to application. </para> + <para> + <emphasis role="bold">org.richfaces.LoadScriptStrategy </emphasis> + </para> + <para>The following declaration in your web.xml allows loading the integrated script files.</para> + <programlisting role="XML"><![CDATA[... + <context-param> + <param-name>org.richfaces.LoadScriptStrategy</param-name> + <param-value>ALL</param-value> + </context-param> +... +]]></programlisting> + <para>If you do not declare the <property>org.richfaces.LoadScriptStrategy</property> in the + web.xml, it equals to:</para> + <programlisting role="XML"><![CDATA[... + <context-param> + <param-name>org.richfaces.LoadScriptStrategy</param-name> + <param-value>DEFAULT</param-value> + </context-param> +... +]]></programlisting> + <para>The third possible value is &quot;NONE&quot;. You have no a special reason to + use it unless you obtain the newest (or modified) version of the script and want to include + it manually in a page header. </para> + + <para> + <emphasis role="bold">org.richfaces.LoadStyleStrategy</emphasis> + </para> + + <para> The following declaration allows to load only one integrated style sheet file.</para> + <programlisting role="XML"><![CDATA[... + <context-param> + <param-name>org.richfaces.LoadStyleStrategy</param-name> + <param-value>ALL</param-value> + </context-param> +... +]]></programlisting> + <para>The integrated style sheet contains style for all shipped components. The skinnability + feature still works. </para> + <para>The &quot;DEFAULT&quot; value is a classical on-demand variant. </para> + <para>The &quot;NONE&quot; stops loading the styles at all. The earlier introduced + plain skin resets all color and font parameters to null. The &quot;NONE&quot; value + for <property>org.richfaces.LoadStyleStrategy</property> means that predefined styles for + RichFaces are not used.</para> + <para>For more information see <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&... + >RichFaces User Forum</ulink>.</para> + </section> - <section id="RequestErrorsAndSessionExpirationHandling"> <?dbhtml filename="RequestErrorsAndSessionExpirationHandling.html"?> <title>Request Errors and Session Expiration Handling</title>