User:ProcBot/PurgeList/doc
This is a documentation subpage for User:ProcBot/PurgeList. It may contain usage information, categories and other content that is not part of the original user template page. |
This bot task will purge pages either at regular intervals, or on absolute dates per year. This page is the purge list for that. To have the bot purge a page, add it to the relevant section below using the correct template. Changes to the list may take up to 15 minutes to be registered by the bot.
Note that a page can be added to the list multiple times. e.g. if you want a page to be purged 3x a year on particular dates, you can add three entries for that page.
Regular purges
[edit]Add the following on a new line:
{{/purge|PageTitle|Interval|IntervalUnit}}
Interval can be any positive integer. IntervalUnit can be "minute", "hour" or "day".
Example:
{{/purge|User:ProcrastinatingReader|15|minute}}
This will purge User:ProcrastinatingReader every 15 minutes.
Dated purges
[edit]Add the following on a new line:
{{/purge-absolute|PageTitle|Month|Day}}
Month and Day can be any positive integer.
Example:
{{/purge-absolute|User:ProcrastinatingReader|5|7}}
This will purge User:ProcrastinatingReader on the 7th of May each year.
Category purges
[edit]The bot can purge all members of a category, including their links and categories.
Add the following on a new line:
{{/purge-cat|CategoryTitle|Interval|IntervalUnit}}
CategoryTitle
should include the namespace. Interval
can be any positive integer. IntervalUnit
can be "minute", "hour" or "day". Be reasonable with intervals, especially for larger categories. Optionally, you can add |type=once
to make it only purge the category once and never again.
Template purges
[edit]The bot can purge all transclusions of a template.
Add the following on a new line:
{{/purge-once|TemplateTitle}}