Difference between revisions of "Template:Purge/doc"
(Import from Wikipedia (CC BY-SA license)) |
m |
||
| Line 3: | Line 3: | ||
==Purpose== | ==Purpose== | ||
| − | For efficiency in service, [[MediaWiki]] [[Cache (computing)|cache]]s 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 [[Wikipedia:Transclusion costs and benefits|transclusion]]. | + | For efficiency in service, [[w:MediaWiki]] [[w:Cache (computing)|cache]]s 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 [[w:Wikipedia:Transclusion costs and benefits|transclusion]]. |
| − | {{Tlx|Purge}} adds to any page a link that, when clicked, not only reloads the page, but [[WP:PURGE|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. | + | {{Tlx|Purge}} adds to any page a link that, when clicked, not only reloads the page, but [[w:WP:PURGE|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== | ==Examples== | ||
Latest revision as of 12:01, 7 March 2020
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is a documentation subpage for Template:Purge. It contains usage information, categories and other content that is not part of the original template page. |
{{Purge}} produces a link that will purge the page's cache and rebuild it from the wikitext.
Contents
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}}
|
Creates a purge link for the page it is used on. | |
{{Purge|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}}
|
Creates a purge link for Main Page. | |
{{Purge|Purge this page's server cache.|page=Main Page}}
|
Creates a purge link for Main Page, but with the text "Purge this page's server cache." | |
{{Purge|anchor=TemplateData}}
|
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
