Template:Purge page

From Kerbal Space Program Wiki
Jump to: navigation, search

Purge

Documentation icon Template documentation[view] [edit] [history] [purge]Pages that link to Template:Purge page

{{Purge}} produces a link that will purge the page's cache and rebuild it from the wikitext.

Purpose

For efficiency in service, w:MediaWiki caches pages. Depending on the exact sequence of actions editors follow, one may view an out-of-date version of a given page. This happens most often on heavily-edited pages and on pages which contain an instance of transclusion.

{{Purge}} adds to any page a link that, when clicked, not only reloads the page, but clears the server cache, forcing the page to be completely rendered "from scratch". This is not a one-time solution; generally, editing a page is itself sufficient to purge cache. Rather, it is a measure taken in anticipation of the frequent need to purge.

Examples

Code Yields Result
{{Purge}} Purge Creates a purge link for the page it is used on.
{{Purge|Purge this page's server cache.}} Purge this page's server cache. Creates a purge link for the page it is used on, but with the text "Purge this page's server cache."
{{Purge|page=Main Page}} Purge Creates a purge link for Main Page.
{{Purge|Purge this page's server cache.|page=Main Page}} Purge this page's server cache. Creates a purge link for Main Page, but with the text "Purge this page's server cache."
{{Purge|anchor=TemplateData}} Purge Creates a purge link for Main Page, but with the text "Purge this page's server cache."

When you are linking to a section, purging that page will cause you to lose the section link.

TemplateData

<templatedata> { "description": "A template that produces a link that will clear the cache and rebuild page from the wikitext", "params": { "1": { "label": "Label", "description": "The label of the purge link", "type": "string", "default": "Purge", "required": false }, "page": { "label": "Page", "description": "The page to purge", "type": "string/wiki-page-name", "required": false }, "anchor": { "label": "Anchor", "description": "An anchor to jump to after the page is purged", "type": "line", "required": false } } } </templatedata>

See also