[TWiki-Dev] [SVN] HideyoImazu r30297 - twiki/branches/TWikiRelease06x00/VarCachePlugin/data/TWiki

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

Author: HideyoImazu
Date: 2017-01-13 00:51:51 +0000 (Fri, 13 Jan 2017)
New Revision: 30297
Trac url: http://develop.twiki.org/trac/changeset/30297

Modified:
   twiki/branches/TWikiRelease06x00/VarCachePlugin/data/TWiki/VarCachePlugin.txt
Log:
Item7703: minor document update for VarCachePlugin

Modified: twiki/branches/TWikiRelease06x00/VarCachePlugin/data/TWiki/VarCachePlugin.txt
===================================================================
--- twiki/branches/TWikiRelease06x00/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2017-01-13 00:51:10 UTC (rev 30296)
+++ twiki/branches/TWikiRelease06x00/VarCachePlugin/data/TWiki/VarCachePlugin.txt	2017-01-13 00:51:51 UTC (rev 30297)
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="TWikiContributor" date="1484203439" format="1.1" version="$Rev$"}%
+%META:TOPICINFO{author="TWikiContributor" date="1484268621" format="1.1" version="$Rev$"}%
 ---+!! Variable Cache Plugin 
 <!--
    Contributions to this plugin are appreciated. Please update the plugin page at
@@ -55,7 +55,10 @@
 
 ---++ Plugin Settings
 
-This plugin can be configured with preferences settings in [[%LOCALSITEPREFS%]] (site level), a WebPreferences (web level) or in a topic (page level). Do not change the settings here, they are here only to illustrate the default values. To overload, copy the settings to one of the aforementioned topics. On a large site having many webs, it's recommended to set VARCACHEPLUGIN_INVALIDATEONUPDATE =none= at the site level to prevent save slowness to happen unexpectedly.
+This plugin can be configured with preferences settings in [[%LOCALSITEPREFS%]] (site level), a WebPreferences (web level) or in a topic (page level). Do not change the settings here, they are here only to illustrate the default values. To overload, copy the settings to one of the aforementioned topics. On a large site having many webs, it's recommended to set VARCACHEPLUGIN_INVALIDATEONUPDATE =none= at the site level to prevent save slowness from happening unknowingly. The current site level setting is %IF{"'%VAR{VARCACHEPLUGIN_INVALIDATEONUPDATE}%' != ''"
+ then="=%VARCACHEPLUGIN_INVALIDATEONUPDATE%="
+ else="undefined, which is the same as =include="
+}%.
 
    * Debug plugin: (See output in =data/debug.txt=)
       * Set VARCACHEPLUGIN_DEBUG = 0
@@ -65,7 +68,7 @@
 
    * On topic creation and topic update, invalidate cache of affected topics: =parent= (its parent topic), =parent(32)= (its parent topics on parent path up to 32 levels), =backlinks= (its backlink topics in current web), =include= (its including topics in current web), =none= (no invalidation), or a comma-list thereof. %BR% __Note:__ Invalidating affected topics can slow down topic save in very large webs; it is recommended to set this to =none= for webs that have 10K+ topics.
       * Set VARCACHEPLUGIN_INVALIDATEONCREATE = parent
-      * Set VARCACHEPLUGIN_INVALIDATEONUPDATE = include, parent
+      * <nop>Set VARCACHEPLUGIN_INVALIDATEONUPDATE = include, parent
 
    * Cache help messages. Use =$age= to indicate age of cache, =$link= to indicate the refresh URL:
       * Set VARCACHEPLUGIN_CACHEMSG = This topic was cached $age ago ([<nop>[$link][refresh]])