Module:Purge/doc: Difference between revisions
Content deleted Content added
No edit summary Tags: Reverted Mobile edit Mobile web edit |
m Undid edits by 201.130.59.7 (talk) to last revision by Pppery: nonconstructive edits |
||
| Line 1: | Line 1: | ||
Module rating|protected |
{{Module rating|protected}} |
||
used in system |
{{used in system}} |
||
This module produces a link to WP:PURGE|purge a page's cache. This is usually the current page, but can be another page. |
This module produces a link to [[WP:PURGE|purge a page's cache]]. This is usually the current page, but can be another page. |
||
== Usage == |
|||
=== From wiktext === |
|||
From wikitext, this module should be accessed via Template:Purge. Please see the template page for documentation. |
From wikitext, this module should be accessed via [[Template:Purge]]. Please see the template page for documentation. |
||
=== From Lua === |
|||
From Lua, first you need to load the module: |
From Lua, first you need to load the module: |
||
syntaxhighlight lang="lua" |
<syntaxhighlight lang="lua"> |
||
local mPurge = require'Module:Purge' |
local mPurge = require('Module:Purge') |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
Then you can create purge links with the code>_main</code function: |
Then you can create purge links with the <code>_main</code> function: |
||
syntaxhighlight lang="lua" |
<syntaxhighlight lang="lua"> |
||
mPurge._main(args) |
mPurge._main(args) |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
var>args</var is a table of arguments, identical to the ones accepted by Template:Purge. Please see the template documentation for more details. |
<var>args</var> is a table of arguments, identical to the ones accepted by [[Template:Purge]]. Please see the template documentation for more details. |
||
includeonly#ifeq:SUBPAGENAME|sandbox |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
||
!-- Categories below this line, please; interwikis at Wikidata |
<!-- Categories below this line, please; interwikis at Wikidata --> |
||
/includeonly |
}}</includeonly> |
||
Latest revision as of 07:34, 14 June 2023
 | This Lua module is used in system messages, and on approximately 357,000 pages, or roughly 1% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module produces a link to purge a page's cache. This is usually the current page, but can be another page.
Usage
[edit]From wiktext
[edit]From wikitext, this module should be accessed via Template:Purge. Please see the template page for documentation.
From Lua
[edit]From Lua, first you need to load the module:
local mPurge = require('Module:Purge')
Then you can create purge links with the _main function:
mPurge._main(args)
args is a table of arguments, identical to the ones accepted by Template:Purge. Please see the template documentation for more details.