[TWiki-Dev] [SVN] PeterThoeny r26683 - twiki/trunk/VarCachePlugin/data/TWiki

[<de...@de...>]

Author: PeterThoeny
Date: 2013-12-29 16:00:53 -0600 (Sun, 29 Dec 2013)
New Revision: 26683
Trac url: http://develop.twiki.org/trac/changeset/26683

Modified:
   twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt
Log:
Item7396: Doc update on limitation of variable excludes

Modified: twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt
===================================================================
--- twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2013-12-21 07:47:30 UTC (rev 26682)
+++ twiki/trunk/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2013-12-29 22:00:53 UTC (rev 26683)
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="TWikiContributor" date="1386641708" format="1.1" version="$Rev$"}%
+%META:TOPICINFO{author="TWikiContributor" date="1388354366" format="1.1" version="$Rev$"}%
 ---+!! Variable Cache Plugin 
 <!--
    Contributions to this plugin are appreciated. Please update the plugin page at
@@ -42,17 +42,19 @@
       * the topic has URL parameters other than =varcache= and =topic= (e.g. to show dynamic content properly, such as table sorting, filtering, searching)
       * the topic is previewed after editing
    * Exclude variables from getting cached:
-      * Use =&lt;varcache_exclude&gt; ... &lt;/varcache_exclude&gt;= to exclude sections of a page from caching. Example:
+      * Prefix any variable with =VARCACHE_EXCLUDE_= and it will be excluded from caching. For example, to exclude =%<nop>WIKIUSERNAME%= write =%<nop>VARCACHE_EXCLUDE_WIKIUSERNAME%=. Make sure to escape all variables that depend on an escaped variable. For example, escape a FORMFIELD variable if it encloses an escaped WIKIUSERNAME:
         %BR% =%<nop>VARCACHE{"24"}%=
+        %BR% =%<nop>VARCACHE_EXCLUDE_FORMFIELD{ "FirstName" topic="%<nop>VARCACHE_EXCLUDE_WIKIUSERNAME%" }%=
+      * Or, use =&lt;varcache_exclude&gt; ... &lt;/varcache_exclude&gt;= to exclude sections of a page from caching. Example:
+        %BR% =%<nop>VARCACHE{"24"}%=
         %BR% =Cached: %<nop>SEARCH{ "." nonoise="on" format="$topic" separator=", " limit="10" }%=
         %BR% =&lt;varcache_exclude&gt;=
         %BR% =Not cached: %<nop>SEARCH{ "%<nop>WIKINAME%" nonoise="on" format="$topic" separator=", " limit="10" }%=
         %BR% =&lt;/varcache_exclude&gt;=
         %BR% =Cached: %<nop>WEBLIST{}%=
-      * Or, prefix any variable with =VARCACHE_EXCLUDE_= and it will be excluded from caching. For example, to exclude =%<nop>WIKIUSERNAME%= write =%<nop>VARCACHE_EXCLUDE_WIKIUSERNAME%=. Make sure to escape all variables that depend on an escaped variable. For example, escape a FORMFIELD variable if it encloses an escaped WIKIUSERNAME like this:
-        %BR% =%<nop>VARCACHE_EXCLUDE_FORMFIELD{ "FirstName" topic="%<nop>VARCACHE_EXCLUDE_WIKIUSERNAME%" }%=
    * Limitation:
       * The cache is not user specific. For example, all users see the expanded =%<nop>WIKIUSERNAME%= of the person who refreshed the cache (on demand or by looking at a topic with an expired cache) unless the variable is specifically excluded from caching.
+      * The =&lt;varcache_exclude&gt; ... &lt;/varcache_exclude&gt;= tags can't be used in included topics; use the =VARCACHE_EXCLUDE_= variable prefix in included topics.
 
 ---++ Plugin Settings
 
@@ -113,13 +115,14 @@
 |  Copyright: | &copy; 2004-2013, Peter Thoeny, [[http://twiki.org/][TWiki.org]] <br /> &copy; 2008-2013 TWiki:TWiki.TWikiContributor |
 |  Sponsor: | [[http://www.wave.com/][Wave Systems Corp.]] for VARCACHE_EXCLUDE_ variable prefix |
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
-|  Plugin Version: | 2013-12-09 |
+|  Plugin Version: | 2013-12-29 |
 %TWISTY{
  mode="div"
  showlink="Show Change History %ICONURL{toggleopen}%"
  hidelink="Hide Change History %ICONURL{toggleclose}% "
 }%
 %TABLE{ tablewidth="100%" columnwidths="170," }%
+|  2013-12-29: | TWikibug:Item7396: Doc update on limitation of variable excludes |
 |  2013-12-09: | TWikibug:Item7396: Cache topic also if topic parameter is used |
 |  2013-12-04: | TWikibug:Item7396: VARCACHE_EXCLUDE_ variable prefix to disable caching of selected variables |
 |  2012-11-14: | TWikibug:Item7020: Categorize TWiki Variable VARCACHE |