svn commit: r559261 - /myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml

[aw...@apache.org]

Author: awiner
Date: Tue Jul 24 16:40:18 2007
New Revision: 559261

URL: http://svn.apache.org/viewvc?view=rev&rev=559261
Log:
Document (at long last!) the CACHE_VIEW_ROOT config flag

Modified:
    myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml

Modified: myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml?view=diff&rev=559261&r1=559260&r2=559261
==============================================================================
--- myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml (original)
+++ myfaces/trinidad/trunk/trinidad/src/site/xdoc/devguide/configuration.xml Tue Jul 24 16:40:18 2007
@@ -277,6 +277,26 @@
 <code>&lt;context-param&gt;</code> elements in your
 <code>WEB-INF/web.xml</code>file.
 </p>
+<subsection name="org.apache.myfaces.trinidad.CACHE_VIEW_ROOT">
+<p>
+Enables or disables UIViewRoot caching;  defaults to true.
+</p>
+<p>
+When "token" client-side state saving is enabled, Trinidad applies
+an additional optimization by caching an entire UIViewRoot tree
+with each token.  (Care has been taken to ensure that this
+does not affect thread safety or session failover.)
+This is a major optimization for AJAX-intensive
+systems, as postbacks can be processed far more rapidly without
+the need to reinstantiate the UIViewRoot tree.  However, 
+it is known to interfere with some other JSF technologies.
+In particular, the Apache MyFaces Tomahawk <code>saveState</code> component
+does not work, and template text in Facelets may appear in duplicate.
+This optimization can be disabled by setting this context parameter
+to <code>false</code>.
+</p>
+</subsection>
+
 <subsection name="org.apache.myfaces.trinidad.CLIENT_STATE_METHOD">
 <p>
 Chooses the type of client-side state saving used when client-side state saving is enabled (with the JSF standard <code>javax.faces.STATE_SAVING_METHOD</code>