User:Renamed user 63506961370/ArchiveConfig/doc

本模板作为自动存档的设置,用于指示机器人对包含本模板的页面存档。本模板应显式地放置在导言一节(第0节);如果本模板作为其他模板的内容而被使用,则会导致出错。

放置本模板表达了讨论页主人或其参与者希望机器人对该页存档的愿望,即使某时没有任何一个机器人执行自动存档任务,本模板也不应被移除。目前识别本模板并进行自动存档的机器人有User:Gqqnbot

话题的定义

自动化脚本认为每个二级标题代表一个话题,对二级标题整体存档。所以对形如

== 2009年 ==
=== 您好 ===
……
=== 看一看 ===
……

== 2010年 ==
===請求===
……
===候选===
……

的页面将会以年为单位存档,这可能不是用户想要的。

如果页面上存在一级标题(=一级标题=),

推荐设置

用户讨论页
{{User:gqqnb/ArchiveConfig
|maxarchivesize = 70
|counter = 1
|minthreadsleft = 5
|algo = old(31d)
|old=31
|archive = /存档{counter}
}}
条目讨论页
{{User:gqqnb/ArchiveConfig
|maxarchivesize = 70
|maxarchivethreads=50
|counter = 1
|minthreadsleft = 8
|old=60
|archive = /存档{counter}
}}

固定存档法

{{User:gqqnb/ArchiveConfig
| archive = /存档
| ......
}}

如果本模板标记放在User talk:gqqnb,则机器人会把该页不再活跃的讨论存档至User talk:gqqnb/存档(根据相对路径)。注意这个存档会一直增长,很有可能变得难以打开。尽管这是最简单的,但并不常用,通常使用计数存档法或日期存档法。

计数存档法

{{User:gqqnb/ArchiveConfig
| archive             = /存档{counter}
| counter             = 1
| maxarchivesize      = 70
| ......
}}

假设该标记放置在User talk:Gqqnb,那么现在机器人会将该页面的话题存档至User talk:Gqqnb/存档1。每当进行新的存档时,机器人会检查当前的存档页是否大于70KB,如果是则开第二个存档页(User talk:Gqqnb/存档2),(所以存档页的大小并不会严格地接近70KB)并更新设置中的counter参数。更新时参数的顺序可能被打乱。

请注意要设置一个maxarchivesize参数,否则会像第一种情况一样。此外,每个存档页顶部会加上{{talkarchive}}模板,你也可以选择其他模板。

变量存档法

{{User:gqqnb/ArchiveConfig
| archive             = /存档{n-counter}
| maxarchivesize      = 70
| ......
| n-counter             = 1
| n-counter-update= INC
}}

一开始n-counter的值为1,于是archive的计算值为/存档1。等到它大小超过70KB,程序重新计算n-counter的值,根据n-counter-update,n-counter的更新算法是递增,于是n-counter=2。程序会写回此设置,并新建讨论页/存档2

可以省略n-counter的初始值,因为程序中会默认为0。然后用INC算法更新,n-counter就等于1了。

此方法的缺点在于存档以1、2、3、4计数的,没有“历史感”。

{{User:gqqnb/ArchiveConfig
| archive             = /存档/{n-year}年
| maxarchivesize      = 70
| ......
| n-year-update= {datetime:%Y}
}}

此例没有设置n-year的初始值,程序就用n-year-update为其计算初始值,它将是当前的年份;然后程序再创建存档页。当存档页的大小超过的maxarchivesize所指定的值,程序会用n-year-update重新计算n-year的值。对于讨论页活动量不大的用户,其存档页很可能是2001、2005、2007、2010等不连续的年份。

比如旧存档开始名称为/存档/2013年,然后在2013年11月的时候旧存档已经达到了70KB。那么程序重新计算n-year,但结果还是2013,那么程序还是会往/存档/2013年写入话题。

比如旧存档开始名称为/存档/2013年,到2015年大小才达到70KB。那么程序重新计算n-year,结果为2015,于是程序开新存档/存档/2015年

此方法的存档名仅含有开始的年份,没有存档结束的年份。适合讨论页活动量不大的用户。

{{User:gqqnb/ArchiveConfig
| archive             = /存档/{n-year}年{n-month}月
| maxarchivesize      = 70
| ......
| n-year-update= {datetime:%Y}
| n-month-update= {datetime:%m}
}}

同样,n-year和n-month初始化为当前的年份和月份。当讨论页大小超过maxarchivesize时,重新计算n-year和n-month。这个设置创建的存档页很可能是不连续的月份,或许用户看起来会有点奇怪,以为某一个月的话题不见了。

{{User:gqqnb/ArchiveConfig
| archive             = /存档/{n-year}年{n-month}月
| ......
| n-year-update= {datetime:%Y}
| n-month-update= {datetime:%m}
}}

没有设置maxarchivesize,那样的话程序每次都重新计算n-year和n-month的值,也不再写回值。这样创建的存档页是连续的。

日期存档法

{{User:gqqnb/ArchiveConfig
| archive = {datetime:/存档/%Y年/%m月%d日}
| ......
}}

这样设置以后,2013年2月10日的讨论会存档至/存档/2013年2月10日{datetime:/存档/%Y年/%m月%d日}整个是变量替换符,%Y表示当前年份,%m表示当前月份,%d表示日。详见下面的参数设置。

参数解释

  • archive:存档页名称。这个参数支持使用变量,可以由机器人根据变量的值(比如月份)来建立存档页。请注意不要加入模板或魔术字之类的东西。如果值以斜杠(/)开头,则是相对于当前页面的路径;否则就是绝对路径,需要被认可才能将旧话题存档至该页。
{{User:gqqnb/ArchiveConfig
| archive = /存档
| ......
}}
{{User:gqqnb/ArchiveConfig
| archive = Wikipedia:互助客栈/消息/存档/2013年12月
| ......
}}
如果本模板标记放在User talk:gqqnb,则机器人会话题存档至User talk:gqqnb/存档 名称不以/开头,则认为是绝对路径。所以无论本模板标记放在哪个页面,机器人都会把话题存档至Wikipedia:互助客栈/消息/存档/2013年12月
参数 介绍
counter 存档页数的计数器。如果不提供本参数,则机器人认为archive不使用counter变量。如果你现在已有存档页,请把它设为当前的存档页数目。机器人在需要时会自动更新这个数值。
maxarchivesize 存档页的最大长度,在计数存档法中使用。值为整数,单位为KB。例如maxarchivesize=256表示最大长度为256KB。1KB=1024字节。如果与maxarchivethreads连用则任一条件满足都会新开存档。
maxarchivethreads 存档页的最多包括多少话题,在计数存档法中使用。如果没有使用{counter}则会被忽略。值为整数。例如maxarchivethreads=50表示存档页的最多包括50个话题(二级标题)。如果与maxarchivesize连用则任一条件满足都会新开存档。
minthreadsleft 页面上最少留下的讨论数目(防止页面被清空),默认值为5。
minthreadstoarchive 每次存档的讨论数目的最小值,用于降低编辑频率。机器人在可存档讨论数目低于此数值时不会进行存档,默认值为2。
archiveheader 加在存档页顶部的内容。这个参数支持使用变量。注意这个参数不能使用多行文字。你可以在存档页顶部加上你的存档索引,默认值为{{talk archive}}。

变量

  • {counter}counter的当前数值
  • {datetime}:当前日期,可以用以下格式化参数获取日期中的不同成分

After you have set up archiving

The bot runs once a day at a preset hour, or twice a day for WP:AN and WP:AN/I. Simply wait for the next cycle and you should see the bot's entries in the history list of your article providing there was anything to archive, and the history list entry should provide a link to the archive page you specified.

Various templates will produce an automatic list of archive subpages. Typically, such a template will be added to the top-level talk page to make archives easier to find. Simply add the template name in {{curly-braces}} where you want it to appear. Popular templates used for this purpose include:

Delaying or preventing archiving of particular threads

Archiving can be delayed for a particular thread by substituting the template {{DNAU}} into the thread. Use {{subst:DNAU}} to retain a thread indefinitely, or {{subst:DNAU|<integer>}} to retain a thread for <integer> days. see the template documentation for details about its use and function.