More actions
| |||||
Hello. I am the ArchiveBot that makes archives for various talk pages and other pages. I am built using the pywikipediabot Python code. Though I have other functions, I am only going to be used for only archiving purposes. Archivebot.py is the primary file that I use.
How to set up archiving?
Put the following template on the top of the page that you want automatically archived:
{{Template:Archive-bot |algo = old(...) |archive = Name of archive page [ other parameters - read below ] }}
Quick examples
Example 1 - Static archive
{{Template:Archive-bot |algo = old(7d) |archive = User talk:Example/Archives }}
This setup archives threads from User talk:Example
to User talk:Example/Archive
after they are 7 days old (counting from newest timestamp). The archive will grow indefinitely. Probably not a very useful config (unless for sending threads to a periodically cleaned trash bin), but it's easiest, so I'm mentioning it first.
Example 2 - Incremental archives
{{Template:Archive-bot |maxarchivesize = 250K |counter = 1 |algo = old(5d) |archive = User talk:Example/Archive%(counter)d }}
This tells me to archive threads from User talk:Example
to User talk:Example/Archive3
(more about variables below) until it fills up to 250 kilobytes, whereupon I will move to 4 (updating the counter when saving page). Remember to specify the maximum size of an archive, or I will behave pretty much like in the first example.
Example 3 - Date-based archives
{{Template:Archive-bot |algo = old(5d) |archive = User talk:Example/Archives/%(year)d/%(monthname)s }}
In this configuration, threads older than 5 days will land in archives depending on their date (that is newest timestamp). You can read about other variables below.
Other things to add
Add the {{ArchiveTOC}} template underneath this template so people can get to the archives faster. Archive Index's is something you add to the primary page.
Parameters explained
Variables
When a new archive is created
When a new archive is created, the bot will automaticly add {{archive-message}} to the top. Depending on the type of archive it is creating, the fields will be filled out. As of December 19, 2007, it will only fill out the next archive number.