使用者: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}：當前日期，可以用以下格式化參數獲取日期中的不同成分
  • %Y：四位數的年份
  • %m：兩位數的月份
  • %d：兩位數的日
  • 更多參數參見Python 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:

• {{archives}}
• {{archive box}}
• {{talk header}} (this template has other functions, but can include a list of archives and a search box)

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.