Template:Purge link/doc

This is a subpage documenting Template:Purge link. To change the template, edit that page; to change the template's documentation (seen below), edit this one.

Documentation

This template produces a link that can be used to purge the cached version of a specified page (that is, to re-render the page immediately rather than waiting for MediaWiki to get around to it). It is intended to be used on pages where content is being transcluded from another page or from a template, since changes to transcluded content don't always show up immediately. This is provided by Template:Doc for all templates that call it to display their documentation. It also can be used on other kinds of pages, if the need arises.

This template is used on a great many pages. Making any changes to it will cause lots of jobs to be added to the processing queue.

Usage

• {{purge link|target page}}
• {{purge link|target page|link label}}
• {{purge link|target page|link label|float=text}}
• {{purge link|target page|link label|indent=text}}
• {{purge link|page=|purge=|float=|indent=}}

Either float or indent can be set to any true value to (respectively) float the purge link to the right or merely separate it a bit from the preceding text. It doesn't make sense to set both, but if that is done, float takes precedence over indent.

Note that the purge parameter provides a mechanism to override the default "show changes" linktext; it does not specify the page to be purged (that's page). Sorry if this is confusing.

Examples

• {{purge link}} ⇒ [show changes]
• {{purge link|Main Page|apply changes to Main Page}} ⇒ [apply changes to Main Page]
• {{purge link|Main Page|update this panel|float=y}} ⇒
  [update this panel]
• …{{purge link|Main Page|update this panel|indent=y}} ⇒ …    [update this panel]

The last three examples might be used to update the appearance of our Main Page, if it relied on dynamically chosen content, like some portals at Wikipedia^↗ do (for example).