手册:Pywikibot/archivebot.py/setup

From mediawiki.org
This page is a translated version of the page Manual:Pywikibot/archivebot.py/setup and the translation is 100% complete.

archivebot.py是一個存檔討論頁的程序。 本文檔說明如何在wiki上設定要讓機器人存檔的討論頁。 操作機器人的完整說明文件請見手册:Pywikibot/archivebot.py

如何設定討論頁

機器人只處理明確透過嵌入引用標記模板的頁面,且不活躍指定時間的討論頁。 常用的標記模板是{{User:MiszaBot/config|...}}。 該模板應該有以下所列的這些參數。 (大多是可選的)

{{TEMPLATE_PAGE
|archive             =
|algo                =
|counter             =
|maxarchivesize      =
|minthreadsleft      =
|minthreadstoarchive =
|archiveheader       =
|key                 =
}}

要存檔的章節必須是2級章節,由==所標記。可設定不存檔特定的章節,見底下的說明

模板參數

模板參數的意義如下所示:

模板參數 描述
archive 存檔被放置的頁面名稱,必須是當前頁面的子頁面,支援使用變數
algo 指定區塊的最長保留時間,必須是這樣的格式:old(時長),時長必須是以小時或天為單位,例如24h(24小時)或5d(5天),預設是old(24h)
counter 可被傳入參數的計數器當前數值,將會由機器人產生,初始值為1
maxarchivesize 增加計數器的最大存檔頁大小,數值可以附加字母KM,代表千位元組或百萬位元組,預設值為1000M(1000百萬位元組)
minthreadsleft 應該被留在頁面上最少的區塊數,預設值是5
minthreadstoarchive 一次存檔區塊的最小數量,預設值是2
archiveheader 被放置在新存檔頁序言章節的內容,此參數支援使用變數,預設值是{{talkarchive}}
key 允許存檔頁不是當前頁面子頁面的密鑰(如有有效)。

頁面名稱模式的變數

archive這個參數中,可以使用以下的變數。

变量 展開為...
%(counter)d counter的目前數值
%(year)d 要存檔區塊的年份
%(quarter)d 要存檔區塊的季度(1到4)
%(month)d 要存檔區塊的月份(1到12)
%(month)02d 要存檔區塊的2位數月份(01到12)
%(monthname)s 月份的英语名称
%(monthnameshort)s 月份名称的前三个字母

如何避免被存檔

要防止一個章節(區塊)在指定的時間內被存檔,您可以編輯該章節並插入一個包含未來時間戳的簽名。在這個時間之前機器人不會將章節存檔。必須保證簽名的格式是正確的,簽名必須包含一個用戶名和一個與正確簽名完全相同格式的日期,否則將不能被機器人辨認。

您可以永遠防止一個段落被存檔,只要使用非常遙遠未來的時間戳,例如「3024年3月28日 (日) 00:06 (UTC)」。

為了不讓讀者感到困惑,虛擬簽名可以虛擬用戶名DoNotArchiveUntil作為留言的簽名,其他的留言將被機器人忽略。

您可能希望在您的wiki上為此目的使用可替換的模板,參見維基數據項目d:Q83461268

參見