Hướng dẫn:Pywikibot/archivebot.py/thiết lập

archivebot.py là một đoạn mã cho phép lưu trữ thảo luận trên các trang thảo luận. Trang này sẽ cho biết làm thế nào để thiết lập bot lưu trữ tự động các trang thảo luận trong wiki của bạn. Đối với tài liệu hướng dẫn cách vận hành bot, vui lòng xem trang Manual:Pywikibot/archivebot.py .

Cách thiết lập cho trang thảo luận

Bot này chỉ vận hành trên các trang đã được đánh dấu rõ ràng bằng cách nhúng bản mẫu đánh dấu, đồng thời các đề mục cần lưu trữ không có bình luận mới trong một khoảng thời gian nhất định. Bản mẫu đánh dấu được sử dụng phổ biến là {{User:MiszaBot/config|...}}. Bản mẫu có thể có các tham số được miêu tả bên dưới. (Phần lớn trong số đó là tùy chọn.)

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

Để một đề mục có thể được lưu trữ, nó phải là một đề mục cấp 2, được đánh dấu bằng ==. Có thể bỏ qua một số đề mục: xem phần giải thích ở bên dưới.

Các tham số cho bản mẫu

Ý nghĩa của các tham số trong bản mẫu như sau:

Tham số bản mẫu	Miêu tả
archive	tên trang mà các thảo luận cần lưu trữ sẽ được đặt vào. Nó phải là trang con của trang hiện tại. Tên trang hỗ trợ việc sử dụng các biến.
algo	cho biết thời gian tối đa của thảo luận trước khi được lưu trữ. Nó phải có dạng old(thời gian chờ) trong đó thời gian chờ cho biết thời gian chờ dưới dạng giờ hoặc ngày, chẳng hạn như 24h (24 giờ) hoặc 5d (5 ngày). Mặc định là old(24h).
counter	Giá trị hiện tại của bộ đếm có thể được gán làm biến. Bot sẽ tự hiện thực hóa giá trị này. Giá trị ban đầu là 1.
maxarchivesize	Kích cỡ tối đa của trang lưu trữ trước khi bộ đếm tăng giá trị lên. Có thể cho giá trị đó với ký tự đi kèm như K hoặc M chỉ định KByte hoặc MByte. Giá trị mặc định là 1000M (1000 megabytes).
minthreadsleft	Số thảo luận tối thiểu cần được để lại trên trang. Giá trị mặc định là 5.
minthreadstoarchive	Số thảo luận tối thiểu cần được lưu trữ cùng một lúc. Giá trị mặc định là 2.
archiveheader	Nội dung sẽ được đặt trên trang lưu trữ mới dưới dạng một phần mở đầu. Tham số này hỗ trợ việc sử dụng các biến. Giá trị mặc định là {{talkarchive}}.
key	Một chìa khóa bí mật mà (nếu hợp lệ) sẽ cho phép lưu trữ các trang lưu trữ không phải là trang con của trang đó.

Biến để định dạng tên trang

Trong tham số archive của bản mẫu, có thể sử dụng các biến sau.

Biến	Mở rộng cho...
%(counter)d	giá trị hiện tại của counter
%(year)d	năm của thảo luận cần lưu trữ
%(quarter)d	quý trong năm (1-4) của thảo luận cần lưu trữ
%(month)d	tháng dạng số (1-12) của thảo luận cần lưu trữ
%(month)02d	tháng dạng hai chữ số (01-12)
%(monthname)s	tên tháng bằng tiếng Anh
%(monthnameshort)s	ba ký tự đầu tiên của tên tháng

Làm cách nào để tránh việc lưu trữ

Để tránh việc một đề mục (thảo luận) được lưu trữ trong khoảng thời gian hữu hạn, bạn có thể sửa đổi đề mục và chèn chữ ký với khoảng thời gian trong tương lai. Bot sẽ không lưu trữ thảo luận cho đến lúc đó. Hãy đảm bảo rằng chữ ký được định dạng đúng; nó phải bao gồm tên thành viên và ngày đúng như định dạng của một chữ ký hợp lệ, nếu không bot sẽ không nhận ra nó.

Bạn có thể ngăn một thảo luận được lưu trữ trong thời gian có thể được coi là vô thời hạn, chẳng hạn như "19:07, 19 tháng 4 2044 (UTC)".

Để tránh gây nhầm lẫn cho người đọc, chữ ký giả chỉ có thể được viết dưới dạng một bình luận cùng với tên thành viên giả "DoNotArchiveUntil". Các bình luận khác sẽ bị bot bỏ qua.

Bạn có thể cần có một bản mẫu có thể thay thế được trên wiki của bạn dành cho mục đích cụ thể này. Xem bản mẫu ví dụ trên Wikipedia tiếng Anh: w:Template:DNAU.

Xem thêm

• w:Help:Archiving a talk page#Automated_archival - phần lớn những gì được viết tại đó không dành riêng cho Wikipedia tiếng Anh.
• w:User:MiszaBot/config