Editing Template:Purge/doc

{{Documentation}}

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 (<code>#res</code>) so that clicking the link will take the reader right back to where they clicked it. By default, the tag used will be a <code>small</code> 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==

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

===Examples===

<pre>This is the list of active discussions.<sup>{{Purge}}</sup></pre>

This is the list of active discussions.<sup>{{Purge}}</sup>

<pre>This is the list of active discussions. Click {{Purge|here|tag=span}} to purge the page.</pre>

This is the list of active discussions. Click {{Purge|here|tag=span}} to purge the page.

<pre>This is the list of active discussions. Click {{Purge|here|tag=span|noinplace=true}} to purge the page via ?action=purge.</pre>

<includeonly>[[Category:Formatting templates]]</includeonly>