Template:Template cache/doc

From IxWiki
Jump to navigation Jump to search

This template is used to "cache" a template with a long runtime. This is primarily intended for automated portals transcluding selected current events or DYKs, but can be used for other purposes.

Usage

The template will make PearBOT replace the text between the comments <!--Template cache top--> and <!--Template cache bottom--> with the substituted version of the template defined in the first unnamed parameter. Parameters can be added in subsequent unnamed parameters. For technical reasons the = sign has to be replaced with {{=}} for instance {{foo|para=bar}} is cached by using {{Template cache|foo|para{{=}}bar}}. The frequency of cache updates can be chosen with the frequency parameter. The bot will update the table at the first run |frequency= hours after the last update. If |frequency= is omitted it will default to daily updates. The bot currently runs once an hour at 30 past, if your task require other run times ask at User talk:Trialpears.

If the updated line is not desired it can be noincluded using |noupdated=yes.