From: <de...@de...> - 2010-04-06 20:35:30
|
Author: PeterThoeny Date: 2010-04-06 15:35:23 -0500 (Tue, 06 Apr 2010) New Revision: 18430 Trac url: http://develop.twiki.org/trac/changeset/18430 Added: twiki/branches/TWikiRelease04x03/twikiplugins/VarCachePlugin/data/TWiki/VarVARCACHE.txt Log: Item5414: Added VarVARCACHE variable documentation topic Added: twiki/branches/TWikiRelease04x03/twikiplugins/VarCachePlugin/data/TWiki/VarVARCACHE.txt =================================================================== --- twiki/branches/TWikiRelease04x03/twikiplugins/VarCachePlugin/data/TWiki/VarVARCACHE.txt (rev 0) +++ twiki/branches/TWikiRelease04x03/twikiplugins/VarCachePlugin/data/TWiki/VarVARCACHE.txt 2010-04-06 20:35:23 UTC (rev 18430) @@ -0,0 +1,13 @@ +%META:TOPICINFO{author="TWikiContributor" date="1270067368" format="1.1" version="$Rev$"}% +%META:TOPICPARENT{name="TWikiVariables"}% +#VarVARCACHE +---+++ VARCACHE{ _attributes_ } -- cache TWiki variables in selected topics for faster page rendering + * The =%<nop>VARCACHE{}%= variable is handled by the VarCachePlugin. + * Syntax: =%<nop>VARCACHE{ "24" }%= + * Supported attributes: + | *Attribute* | *Comment* | *Default* | + | ="..."= or%BR% =refresh="..."= | Cache refresh period in hours (maximum age of cache) | =REFRESH= setting | + | =cachemsg="..."= | Message shown when looking at a cached topic. Use =$age= to indicate the age of cache, =$link= to indicate the refresh URL | =CACHEMSG= setting | + | =updatemsg="..."= | Message shown after a cache refresh. Use =$link= to indicate the refresh URL | =UPDATEMSG= setting | + * Example: =%<nop>VARCACHE{"168"}%= caches the current page for 7 days + * Related: VarCachePlugin, VarCachePluginTest |