Manual:Pywikibot/archivebot.py/setup

The archivebot.py is a script to archive discussion pages. Here we explain how to set up discussion pages on-wiki for the automatic archiving done by this bot. For a documentation on how to operate the bot, please see Manual:Pywikibot/archivebot.py.

How to set up for a discussion page
This bot only processes pages that are explicitly marked by transcluding a marker template. A commonly used marker template is  . The template may have anchor>#parameters|parameters described below. (Most of them are optional.)

Template parameters
Meanings of the template's parameters are:

Variables for page name patterns
In the   parameter in the template, following variables can be used.

How to prevent archiving
To prevent a section (thread) from being archived, you can edit the section and insert a signature with a future timestamp indicating the deadline. (Remember that the bot will archive after the period specified in the template has passed after the newest timestamp in a section.)

You can imitate an indefinite block of archiving using a reasonably distant future timestamp, such as " (UTC)". The dummy signature could be written as a comment to not confuse readers.

You might want to have on your wiki a substitutable template for this particular purpose. See English Wikipedia's template for an example: w:Template:DNAU.