Template:Purge/doc

A checked version of this page, approved on 22 October 2020, was based on this revision.

This content is in the Template Namespace. Used for page-templates that can be re-used across the wiki.

This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Purge

This template is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

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

Purpose

For efficiency in service, Wikipedia: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 the page it is used on, which points to the "TemplateData" section.

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Purge/doc

A template that produces a link that will clear the cache and rebuild page from the wikitext

Template parameters[Edit template data]
Parameter		Description	Type	Status
Label	`1`	The label of the purge link Default Purge	String	optional
Page	`page`	The page to purge	Page name	optional
Anchor	`anchor`	An anchor to jump to after the page is purged	Line	optional