Template:Auto-archive/doc
 | This is a documentation subpage for Template:Auto-archive. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used to set up the user:cewbot for automatic archiving. The robot runs the program once a day.
Usage[edit]
This template must be embedded directly into the page you want to archive. Including it in a header subpage will not work; instead, it will archive the header subpage itself. The robot will only work on pages that explicitly transcluding this template, and will archive discussions that are not active for the specified time.
It is usually presented as {{Auto-archive}}, {{Auto-archive|...}}.
Example[edit]
{{Auto-archive}}- Archive discussions that no one has responded to in a week.
{{Auto-archive|archive_after_last_comment=1m}}- Archive discussions that no one has responded to in a month.
{{Auto-archive|archive_to_subpage=Archive %Y-%2m}}- Archive to the subpage using the pattern by year and month.
Notes[edit]
- If the robot fails to write to the archive page, the original discussion will not be deleted.
How to avoid being archived[edit]
You can use {{Pin message}}.
TemplateData[edit]
TemplateData for Auto-archive
Configurations for robot archiving discussions
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Length of time | archive_after_last_comment | Archive discussions that no one has responded to in this time.
| Date | optional |
| Archive to which subpage | archive_to_subpage | If this parameter is not set, the robot will automatically detect the name and the latest index of the subpage. If there is no such page, a new one will be created. It is recommended to use auto-detection so that you can skip to the next number when the archive page is too large. The "%1" will be replaced by the latest index. There is always only "%1", there is no "%2".
| Page name | optional |
| Archiving chapter level | section_level | Generally archiving level 2 chapters
| Number | optional |