Variable Cache Plugin

This Plugin caches Foswiki macros in selected topics for faster page rendering.

Most topics in a typical Foswiki installation are rendered within a small deviation in terms of speed. Exceptions are topics that contain a lot of dynamic content. This is mainly caused by CPU or I/O intensive Macros, such as %SEARCH{}% and %INCLUDE{}%.

This Plugin caches all %VARIABLES% located in a topic so that the topic can get rendered as quickly as one without variables. 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.

Syntax Rules and Cache Update Rules

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %VARCACHEPLUGIN_SHORTDESCRIPTION%

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the Plugin on the Foswiki server.

Plugin Info

Plugin Author: Original: TWiki:Main/PeterThoeny, In Foswiki context Foswiki:Main.KennethLavrsen
Copyright: © 2004-2007, TWIKI.NET, © Foswiki Contributors
License: GPL (GNU General Public License)
Plugin Version: 29 Jan 2009
Change History:  
29 Jan 2009: Foswiki version
06 Jan 2006: Small fix for TWiki 4.0
16 Jul 2004: Doc improvements (no code change)
15 Jul 2004: Initial version
Foswiki Dependency: $Foswiki::Plugins::VERSION 1.024 (15 Jul 2004)
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.008
Plugin Home: http://foswiki.org/Extensions/VarCachePlugin
Feedback: http://foswiki.org/Extensions/VarCachePluginDev

Related Topics: Plugins, DeveloperDocumentationCategory, AdminDocumentationCategory, DefaultPreferences, SitePreferences spacer