%SEARCH{}%
and %INCLUDE{}%
.
This plugin caches all %MACROS%
located in a topic so that the topic can get rendered as quickly as one without macros. An outdated cache gets refreshed when a user is looking at a topic; in which case it will take longer to render the page. Time-based refresh can also be disabled in favor of an on-demand cache update.
The rendering of Foswiki topic markup to HTML is not cached. That is, user specific HTML rendering based on skin settings is not affected by the caching.
%VARCACHE{}%
variable to the topic you want to cache
%VARCACHE{ "24" }%
Attribute | Comment | Default |
---|---|---|
"..." orrefresh="..." | Cache refresh period in hours (maximum age of cache). Accepts decimals, such as 0.25 | 24 |
cachemsg="..." | Message shown when looking at a cached topic. Use $age to indicate the age of cache, $link to indicate the refresh URL | This topic was cached $age ago ([[$link][refresh]]) |
updatemsg="..." | Message shown after a cache refresh. Use $link to indicate the refresh URL | This topic is now cached ([[$link][refresh]]) |
%VARCACHE{"168"}%
caches the current page for 7 days
cachmsg
and updatemsg
.
%VARCACHE{}%
gets: cachemsg
message when looking at a cached topic
updatemsg
message if the cache has just been updated
%VARCACHE{}%
variable)
?varcache=refresh
URL parameter (usually by following the refresh link in the cache message)
varcache
(e.g. to show dynamic content properly, such as table sorting, filtering, searching)
%WIKIUSERNAME%
of the person who refreshed the cache (on demand or by looking at a topic with an expired cache)
0
, default: 24
$age
to indicate age of cache, $link
to indicate the refresh URL
configure
, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.
Author: | Design and original implementation: PeterThoeny |
Copyright: | © 2004-2007, TWIKI.NET and TWiki Contributors © 2008-2012 Foswiki Contributors |
License: | GPL (GNU General Public License) |
Plugin Release: | 1.2 |
Plugin Version: | 14435 (2012-03-23) |
Change History: | |
1.2 (23 Mar 2012) | Foswikitask:Item5414: support header zones -- Foswiki:Main.CrawfordCurrie |
1.1 (28 Jul 2011) | Minor bugfix -- Foswiki:Main.CrawfordCurrie |
1.0 (05 May 2011) | Foswikitask:Item10713: cache is now stored in the plugins work area, not under pub Foswikitask:Item10712: No longer read preferences from plugin topic -- Foswiki:Main.AndrewJones |
29 Jan 2009: | Foswiki version -- Foswiki:Main.KennethLavrsen |
Plugin Home: | http://foswiki.org/Extensions/VarCachePlugin |
Support: | http://foswiki.org/Support/VarCachePlugin |