User:C.A.T 3000/archive
Jump to navigation
Jump to search
This template can be added to your talkpage, or any active talk/forumpage, where it will automatically archive messages on that page.
(Abandoned talk pages will have the template commented out, because the more pages which use the template, the longer it will take to archive them all).
Arguments
You can add arguments to the template to configure how the bot works.
| Argument Name | Default Value* | Example Value | Description | More Info |
|---|---|---|---|---|
| page | (required) | User talk:L10nM4st3r/ Archive%(counter) |
The page where archived messages are put. This value must be a subpage, or it will not work. | This value supports variables. The complete list of supported variables are found below. |
| maxArchiveSize | 100K | 1,500K OR 1.5M | The maximum number of bytes which are allowed in an archive page, when using the %(counter) variable in page. | The minimum supported value is 1K, and the maximum is 2M. Whatever number you input will be clamped to these values. |
| counter | 1 | 1 | The number to start counting when using the %(counter) variable in page. | -- |
| messageAge_hours | 0 | 24 | The number of hours old a message has to be to be archived. | This value has very little effect in most cases, because the archive bot is only ran once a week. You can use decimal places if you want more precision. |
| messageAge_days | 0 | 10 | The number of days old a message has to be to be archived. | You can use decimal places if you want more precision. |
| messageAge_weeks | 0 | 2 | The number of weeks old a message has to be to be archived. | You can use decimal places if you want more precision. |
| messageAge_months | 0 | 11.9 | The number of (approxomated 30-day long) months old a message has to be to be archived. | You can use decimal places if you want more precision. |
| messageAge_years | 0 | 2.5 | The number of years old a message has to be to be archived. | You can use decimal places if you want more precision. |
| minSections | 0 | 0 | The minimum amount of sections which will be left on a page. If set to 0, it will archive all the sections. | -- |
| minArchiveSections | 0 | 3 | The minimum amount of sections which can be archived in one go. If set to 1 or less, it will behave normally. | -- |
| minPageSize | 0 | 100K | The minimum number of characters the page needs to have in order for it to be archived (this is different to bytes, some characters will be larger than one byte). | -- |
| archiveHeader | {{TalkArchive}} | {{TalkArchive}} | The wikitext to be placed on top of new archive subpages. | -- |
| archivelist | archiveList | listOfArchibes | The name of the subpage which will include a link to all archive subpages. | To disable this feature, simply add this parameter, and leave it blank. |
| archiveListSeperator | \n | <br/>\n | The wikitext placed in-between archive sections. | If left blank, will default to a single line break. Any "\n" will be replaced with a line break. |
- * If the value is (required), then there is no default value, and you must give that argument a value.
Supported page variables
- %(counter) - Will increment with a counter, until it finds a page smaller than a certain amount of bytes. The byte count can be configured with the
maxArchiveSizeargument. - %(currentday), %(currentmonthname), %(currentmonth), %(currentyear) - Will be replaced with their respective values. Note: %(currentmonth) will be replaced with the number, while %(currentmonthname) will be replaced with the full name of the month.