Module:Purge/doc

This is a documentation subpage for Module:Purge. It contains usage information, categories, and other content that is not part of the original module page.

This module is unused. This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add {{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.

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

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See Brighter Shores:Lua/Helper modules for a full list and more information.

Function	Type	Use
_purge( anchor, text, tag, noinplace )	string/table, string, string, boolean	Generates a purge link All args are optional. anchor - The ID of the tag, used for an anchor link; default res text - Link text; default (wrong?) tag - HTML tag to use; default sup noinplace - If defined, will suppress the addition of the jsPurgeLink class, which makes the link do an in-place purge rather than going to a purge confirmation

Example:

local purge = require( 'Module:Purge' )._purge

local refreshLink = purge( nil, 'refresh' )
-- Or
local refreshLink = purge{ text = 'refresh' }