VarVARCACHE < System

#VarVARCACHE
---+++ VARCACHE{ _attributes_ } -- cache the results of Foswiki macros in selected topics for faster page rendering
%STARTSECTION{name="detail"}%
   * Syntax: =%<nop>VARCACHE{ "24" }%=
   * Supported attributes:
     | *Attribute* | *Comment* | *Default* |
     | ="..."= or%BR% =refresh="..."= | 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 ([<nop>[$link][refresh]])= |
     | =updatemsg="..."= | Message shown after a cache refresh. Use =$link= to indicate the refresh URL | =This topic is now cached ([<nop>[$link][refresh]])= |
   * Example: =%<nop>VARCACHE{"168"}%= caches the current page for 7 days
   * The standard Foswiki [[FormatTokens][format tokens]] are supported in =cachmsg= and =updatemsg=.
%ENDSECTION{name="detail"}%
   * Related: VarCachePlugin, VarCachePluginTest
   * The =%<nop>VARCACHE{}%= variable is handled by the VarCachePlugin.

This topic: System > WebHome > Macros > VarVARCACHE
Topic revision: 31 Mar 2010, FoswikiContributor (raw view)

Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback