Mô đun:Protection banner/tài liệu

Mô-đun này tạo biểu ngữ bảo vệ và biểu tượng ổ khóa được đặt ở đầu trang được khóa.

Sử dụng

Hầu hết người dùng sẽ không cần sử dụng mô-đun này trực tiếp. Để thêm các bản mẫu khóa vào các trang, bạn có thể sử dụng bản mẫu hoặc bạn có thể thấy thuận tiện hơn khi sử dụng một trong các bản mẫu khóa cụ thể hơn trong bảng bên dưới.

Từ wikitext

&123;{invoke:Protection banner|main
| 1 = lý do
| small = yes/no
| action = hành động
| date = ngày khóa
| user = tên thành viên
| section = tên đề mục trang thảo luận
| category = no
}&125;

Cú pháp invoke có thể được sử dụng để tạo các bản mẫu khóa cụ thể hơn . Ví dụ: có thể tạo một bản mẫu khóa luôn hiển thị biểu tượng ổ khóa bằng cách sử dụng mã . Các trang gọi bản mẫu này vẫn có thể sử dụng các đối số khác, như action. Tuy nhiên, điều này chỉ hoạt động sâu một cấp; một trang gọi một bản mẫu gọi một bản mẫu khác chứa mã ở trên sẽ không thể tự động sử dụng các tham số như action.

Note: Bạn không còn có thể chỉ định hết hạn, vì nó được tự động truy xuất trong mọi trường hợp.

Từ Lua

Đầu tiên, gọi mô đun:

local mProtectionBanner = require('Module:Protection banner')

Sau đó, bạn có thể tạo các biểu ngữ bảo vệ bằng cách sử dụng chức năng _main.

mProtectionBanner._main(args, cfg, titleObj)

args là một bảng các đối số để truyền cho mô-đun. Để biết các khóa và giá trị có thể cho bảng này, hãy xem phần tham số. Biến cfg và titleObj chỉ dành cho thử nghiệm; cfg chỉ định một bảng cấu hình tùy chỉnh để sử dụng thay vì Module:Protection banner/config, and titleObj chỉ định một đối tượng mw.title để sử dụng thay vì tiêu đề hiện tại. args, cfg và titleObj đều là tùy chọn.

Tham số

Tất cả tham số đều là tùy chọn:
1 – Lý do mà trang được khóa. Nếu được đặt, đây phải là một trong các giá trị được liệt kê trong bảng lý do.
small – Nếu đặt là "yes", "y", "1", hoặc "true", một biểu tượng ổ khóa được tạo ra thay vì biểu ngữ khóa đầy đủ.
action – Các hành động khóa. Phải là một trong số các dạng sau đây: "edit" (đối với khóa thông thường), "move" (đối với khóa di chuyển). Giá trị mặc định là "edit".
date – Ngày khóa. Đây phải là đầu vào hợp lệ cho tham số thứ hai của time parser function. Đối số này có hiệu lực vì những lý do sử dụng tham số PROTECTIONDATE trong cấu hình của chúng. Đối số này chỉ có hiệu lực cho các lý do "office" và "reset".
user – Tên thành viên của thành viên để tạo liên kết cho. Kể từ tháng 7 năm 2014, điều này chỉ có hiệu lực khi lý do "usertalk" được chỉ định.
section – Tên phần của trang thảo luận của trang được khóa nơi diễn ra cuộc thảo luận. Tham số này hầu hết đều hoạt động, nhưng không phải tất cả, các giá trị của reason.
category – Không thêm thể loại nếu tham số này được đặt thành "no", "n", "0", hoặc "false".

Lý do

Bảng sau đây chứa các lý do có sẵn, cộng với các hành động có sẵn.

Lỗi

Dưới đây là danh sách một số lỗi phổ biến mà mô-đun này có thể tạo ra và cách khắc phục chúng.

Sai ngày khóa trang

Lỗi này được tạo ra nếu bạn cung cấp một tham số mà giá trị của nó không được công nhận là ngày hợp lệ bởi chức năng phân tích cú pháp time. Nếu nghi ngờ, bạn chỉ có thể sử dụng một ngày ở định dạng "dd Month YYYY", ví dụ "". Để xem đầy đủ các đầu vào hợp lệ, xem time documentation (chỉ tham số đầu tiên, chuỗi định dạng, có thể được chỉ định).

Sai hành động

Lỗi này được tạo ra nếu bạn chỉ định một hành động khóa không hợp lệ. Chỉ có ba hành động hợp lệ: edit (mặc định, cho khóa thường) và move (cho khóa di chuyển). Điều này chỉ có thể nếu bạn đang sử dụng một bản mẫu hỗ trợ chỉ định thủ công hành động khóa, chẳng hạn như hoặc nếu bạn đang sử dụng trực tiếp invoke. Nếu đây không phải là trường hợp, vui lòng để lại tin nhắn trên Thảo luận Mô đun:Protection banner.

Lý do không thể chứa ký tự cây đứng

Lỗi này được tạo ra nếu bạn chỉ định một lý do sử dụng tham số bao gồm ký tự cây đứng ("&124;"). Vui lòng kiểm tra xem bạn có đang nhập sai bản mẫu vào tham số này không. Ký tự cây đứng không được phép vì mô-đun sử dụng nó trong nội bộ. Có thể xem danh sách các lý do hợp lệ trong phần lý do.

Một số lỗi khác

Nếu bạn thấy một lỗi khác ngoài các lỗi ở trên, đó có thể là lỗi trong mô-đun hoặc lỗi trong cấu hình. Xin vui lòng gửi một tin nhắn về nó tại Thảo luận Mô đun:Protection banner.

Thông tin kỹ thuật

Mô-đun này sử dụng dữ liệu cấu hình từ Module:Protection banner/config. Hầu hết các hành vi của mô-đun có thể được cấu hình ở đó, làm cho nó dễ dàng di chuyển qua các wiki khác nhau và các ngôn ngữ khác nhau.

Các trường hợp thử nghiệm chung cho mô-đun có thể được tìm thấy tại Module:Protection banner/testcases, và các trường hợp thử nghiệm cụ thể cho cấu hình của enwiki có thể được tìm thấy tại Module:Protection banner/config/testcases.

Báo cáo lỗi và yêu cầu tính năng nên được thực hiện trên the module's talk page.

|sandbox||

}}