Template:Auto-archive/doc

This template is used to set up the user:cewbot for automatic archiving. The robot runs the program once a day.

Usage

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

{{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

• If the robot fails to write to the archive page, the original discussion will not be deleted.

How to avoid being archived

You can use {{Pin message}}.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Auto-archive in articles based on its TemplateData.

TemplateData for Auto-archive

Configurations for robot archiving discussions

Template parameters

Parameter		Description	Type	Status
Length of time	archive_after_last_comment	Archive discussions that no one has responded to in this time. Default 1 week Example "7d", "7 days", "1w", "1 week", "1m", "1 month"	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". Default Archive %1 Example Archive %1	Page name	optional
Archiving chapter level	section_level	Generally archiving level 2 chapters Default 2 Example 3	Number	optional