Template:DW/Purge/doc

Template documentation (for the above template, sometimes hidden or invisible)

Help out by writing some. There may also be documentation on Wikia Templates which can be copied.

This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
If you're done making changes, please refresh the text.
Please add categories and interwikis to Template:DW/Purge/doc/doc. (View all subpages of this page.)

Place this template on a page that uses any sort of time based parser to display information to allow readers to see up to date information. It includes its own anchor (#res) so that clicking the link will take the reader right back to where they clicked it. By default, the tag used will be a small tag (but can be changed), and the link will be an in-place style purge (uses javascript to purge via the API and reload the page) (but can be suppressed to purge via ?action=purge instead, which requires a confirmation).

Usage

{{Purge|optional text|tag=(optional) <small> by default|noinplace=(optional) suppress in-place purging|hover=(optional) input custom mouse-over text}}

Examples

This week's featured Distraction and Diversion is Evil Tree.<sup>{{Purge}}</sup>

This week's featured Distraction and Diversion is Evil Tree.^Purge

This week's featured Distraction and Diversion is Evil Tree. Click {{Purge|here|tag=span}} to purge the page.

This week's featured Distraction and Diversion is Evil Tree. Click here to purge the page.

This week's featured Distraction and Diversion is Evil Tree. Click {{Purge|here|tag=span|noinplace=true}} to purge the page via ?action=purge.