Difference between revisions of "Template:Purge/doc"

From Wazeopedia
(updated doc)
m (WPCleaner v1.34 - Real time closures - Road closures)
Line 1: Line 1:
{{doc subpage}}
+
#REDIRECT [[Real time closures]]
{{Tlx|Purge}} produces a link that will clear the cache and rebuild page from the wikitext.
 
 
 
==Purpose==
 
For efficiency in service, 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 [[Wikipedia:Transclusion costs and benefits|transclusion]].
 
 
 
{{Tlx|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==
 
{| class="wikitable"
 
|-
 
! Code
 
! Yields
 
! Result
 
|-
 
| <tt><nowiki>{{Purge}}</nowiki></tt>
 
| {{Purge}}
 
| Creates a purge link for the page it is used on.
 
|-
 
| <tt><nowiki>{{Purge|Purge this page's server cache.}}</nowiki></tt>
 
| {{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."
 
|-
 
| <tt><nowiki>{{Purge|page=Main Page}}</nowiki></tt>
 
| {{Purge|page=Main Page}}
 
| Creates a purge link for [[Main Page]].
 
|-
 
| <tt><nowiki>{{Purge|Purge this page's server cache.|page=Main Page}}</nowiki></tt>
 
| {{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."
 
|}
 
 
 
When you are linking to a section, purging that page will cause you to lose the section link.
 
 
 
==TemplateData==
 
{{Pre2|
 
<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
 
                }
 
        }
 
}
 
</templatedata>
 
}}
 
 
 
==See also==
 
* {{Tlx|Purge box}}
 
* {{Tlx|Purge button}}
 
* {{Tlx|Purge page}}
 
* [[Wikipedia:Purge]]
 
* [[commons:Template:Purge]]
 
 
 
<includeonly>
 
[[Category:Maintenance navigation]]
 
[[Category:Internal link templates]]
 
[[Category:Template Management]]
 
</includeonly>
 

Revision as of 13:44, 23 March 2015

Redirect to: