svn commit: r587865 - /tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml

[an...@apache.org]

Author: andyhot
Date: Wed Oct 24 05:11:32 2007
New Revision: 587865

URL: http://svn.apache.org/viewvc?rev=587865&view=rev
Log:
TAPESTRY-1711: Docs on client:app, client:page

Modified:
    tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml

Modified: tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml?rev=587865&r1=587864&r2=587865&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/usersguide/state.xml Wed Oct 24 05:11:32 2007
@@ -437,6 +437,30 @@
                             (approximately 4000 characters is a good guideline). This is less a
                             problem for forms.
                         </dd>
+                        <dd>
+	                        <p>
+	                            In Tapestry 4.0 the concept of a <em>scope</em> was introduced,
+	                            specifying how long a property will persist.
+	                            For <code>client</code> there exist two scopes: <code>page</code> and
+	                            <code>app</code>. If you omit the scope it will default to
+	                            <code>client:page</code>.
+	                        </p>
+                            <dl>
+                                <dt>client:page</dt>
+                                <dd>
+                                    <p>
+                                        Persisted properties will be available
+                                        until another page is activated and rendered.
+                                    </p>
+                                </dd>
+                                <dt>client:app</dt>
+                                <dd>
+                                    <p>
+                                        Persisted properties will always be available.
+                                    </p>
+                                </dd>
+                            </dl>
+                        </dd>
                         <dt>session</dt>
                         <dd>
                             The traditional style of property persistence (and the only kind
@@ -450,13 +474,6 @@
                         lifecycle of the page property.
                     </p>
 
-                    <span class="info">
-                        <strong>Fixme:</strong>
-                        <p>
-                        Mind Bridge has added (or changed) these, adding a concept of "scope" for
-                        how long a property will persist. This documentation needs to be updated.
-                        </p>
-                    </span>
                 </subsection><!-- state.page-properties.types -->
 
             </section><!-- state.page-properties -->