NOTE: This is a DistributionDocument.

• Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content.
• Put questions and suggestions concerning the documentation of this topic in the comments section below.
• Use the Support web for problems you are having using TWiki.
• Use the Sandbox web to evaluate & test TWiki.

VARCACHE{ attributes } -- cache TWiki variables in selected topics for faster page rendering

• The %VARCACHE{}% variable is handled by the VarCachePlugin.
• Syntax: %VARCACHE{ "24" }%
• Supported attributes:

  Attribute	Comment	Default
  "..." or 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

• Use <varcache_exclude> ... </varcache_exclude> to exclude sections of a page from getting cached
• Example: %VARCACHE{"168"}% caches the current page for 7 days
• Category: AdministrationVariables, DevelopmentVariables
• Related: VarCachePlugin, VarCachePluginTest

Comments & Questions about this Distribution Document Topic