Template:Template cache/doc
![]() | This is a documentation subpage for Template:Template cache. It may contain usage information, categories and other content that is not part of the original template page. |
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. It should generally be placed on a subpage or in a template to not fill up the edit history of the main page with bot edits and avoid issues caused by the hidden comments being removed or modified.
Usage
[edit]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 runs once an hour.
If the updated line is not desired it can be noincluded using |noupdated=yes
. That means it's visible on the page containing {{Template cache}}, but not on pages transcluding said page.