Editing Module:Purge/doc

{{documentation}}
Provides a purge link. Can be customised if used by lua, or lesser customisation via [[Template:Purge]].

{{Helper module
|name=Purge
|fname1=_purge( anchor, text, tag, noinplace )
|ftype1=string/table, string, string, boolean
|fuse1=Generates a purge link
All args are optional.
* <code>anchor</code> - The ID of the tag, used for an anchor link; default <code>res</code>
* <code>text</code> - Link text; default <code>(wrong?)</code>
* <code>tag</code> - HTML tag to use; default <code>sup</code>
* <code>noinplace</code> - If defined, will suppress the addition of the <code>jsPurgeLink</code> class, which makes the link do an in-place purge rather than going to a purge confirmation
|example=<syntaxhighlight lang='lua'>
local purge = require( 'Module:Purge' )._purge

local refreshLink = purge( nil, 'refresh' )
-- Or
local refreshLink = purge{ text = 'refresh' }
</syntaxhighlight>
}}