Template:Purge/doc - Revision history

Caleb Cooper at 18:05, 22 October 2020

2020-10-22T18:05:54Z

← Older revision		Revision as of 18:05, 22 October 2020
Line 6:		Line 6:
	{{Commons Import}}		{{Commons Import}}

	{{tlx\|Purge}} produces a link that will [[WP:PURGE\|purge the page's cache]] and rebuild it from the wikitext.		{{tlx\|Purge}} produces a link that will [[Wikipedia:WP:PURGE\|purge the page's cache]] and rebuild it from the wikitext.

	==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, [[Wikipedia:MediaWiki]] [[Wikipedia: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]].

	{{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 [[Wikipedia: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==

Caleb Cooper: /* TemplateData */

2020-10-22T18:05:03Z

TemplateData

← Older revision		Revision as of 18:05, 22 October 2020
Line 71:		Line 71:
	}		}
	</templatedata>		</templatedata>


	{{When on basepage
	\|<!-- ADD CATEGORIES BELOW THIS LINE -->
	[[Category:Wikipedia utility templates]]
	[[Category:Internal link templates]]

	}}

Caleb Cooper: /* TemplateData */

2020-10-22T18:04:50Z

TemplateData

← Older revision		Revision as of 18:04, 22 October 2020
Line 72:		Line 72:
	</templatedata>		</templatedata>

	{{Purge Pages}}

	{{When on basepage		{{When on basepage

Caleb Cooper at 18:04, 22 October 2020

2020-10-22T18:04:35Z

← Older revision		Revision as of 18:04, 22 October 2020
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	{{high-risk~~\| 125848~~ }}		{{high-risk}}
	{{lua\|Module:Purge}}		{{lua\|Module:Purge}}
	{{used in system}}		{{used in system}}

Caleb Cooper: Created page with "{{Documentation subpage}} {{high-risk| 125848 }} {..."

2020-10-22T18:04:14Z

Created page with "{{Documentation subpage}}  {{high-risk| 125848 }} {..."

New page

{{Documentation subpage}}

{{high-risk| 125848 }}
{{lua|Module:Purge}}
{{used in system}}
{{Commons Import}}

{{tlx|Purge}} produces a link that will [[WP:PURGE|purge the page's cache]] and rebuild it from the wikitext.

==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]].

{{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.

==Examples==
{| class="wikitable"
|-
! Code
! Yields
! Result
|-
| {{tlx|Purge}}
| {{Purge}}
| Creates a purge link for the page it is used on.
|-
| {{tlx|Purge|Purge this page's server cache.}}
| {{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."
|-
| {{tlx|Purge|page{{=}}Main Page}}
| {{Purge|page=Main Page}}
| Creates a purge link for [[Main Page]].
|-
| {{tlx|Purge|Purge this page's server cache.|page{{=}}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."
|-
| {{tlx|Purge|anchor{{=}}TemplateData}}
| {{Purge|anchor=TemplateData}}
| 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==
{{TemplateData header}}
<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>

{{Purge Pages}}

{{When on basepage
|
[[Category:Wikipedia utility templates]]
[[Category:Internal link templates]]

}}