Template:Khóa toàn cục/doc

Đây là một trang con tài liệu sử dụng bản mẫu dành cho Template:Khóa toàn cục (xem template tại trang đó). Nó gồm có các thông tin hướng dẫn sử dụng, thể loại và các nội dung khác không thuộc về phần template trang gốc.

Đây là {{pp-meta}}, một tiêu bản chung dùng để tạo ra các hộp thông báo khóa trang.

1. Nếu trên một bài viết (không gian chính) nó sẽ tạo ra một hộp thông báo chuẩn hóa theo kiểu hộp thông báo bài viết (ambox).
2. Nếu trên bất kỳ loại trang thảo luận nào nó sẽ tạo ra một hộp thông báo được chuẩn hóa theo phong cách "cuộn cà phê" trang thảo luận.
3. Nếu trên bất kỳ trang nào khác nó sẽ tạo ra một hộp thông báo theo kiểu tiêu bản khóa cũ.

Tiêu bản chung này cũng xử lý một phần mã theo chữ "nhỏ" với chỉ có một biểu tượng ở phía bên phải trang.

Ví dụ

Chú ý rằng ổ khóa nhỏ ở phía trên bên phải trang này cũng là một ví dụ do siêu tiêu bản này tạo ra.

Cách sử dụng

{{pp-meta
 |kiểu= <chọn một trong "hoàn toàn", "nửa", "vô hạn", "di chuyển", "khởi tạo", hoặc "văn phòng" tùy vào kiểu khóa>
 |small={{{small|}}} <trừ khi tiêu bản lúc nào cũng phải nhỏ, thì ghi là "yes", hoặc nếu không bao giờ thu nhỏ, ghi là "no" hoặc bỏ>
 |hết hạn={{{hết hạn|}}} <bỏ đối với tiêu bản vô hạn>
 |lý do= <lý do của bạn ở đây>
 |xfd=<nếu kiểu là "khởi tạo", thì "{{{xfd|}}}", không thì bỏ>
 |không gian={{{không gian|}}} <trừ khi tiêu bản chỉ nên dùng trong không gian chính, khi nó thích hợp để gán "chính", "thảo luận", hoặc "khác" trong đó thảo luận là tất cả các không gian tên số lẻ>
 |hình=<hình của bạn ở đây không có tiền tố Hình:, bỏ nó trừ khi là không chuẩn>
 |lk icon=<liên kết của bạn không có [[]] nhưng có thể có #đề mục ở đây, áp dụng cho phiên bản biểu tượng>
 |chữ icon=<chữ icon thay thế *hoàn toàn* của bạn bao gồm dấu chấm câu.
   Chỉ dùng chữ thưởng. Bỏ đi trừ khi không chuẩn.>
 |lý do icon=<nowiki> </nowiki><lý do cụ thể của bạn tại đây mà không dùng chấm câu, chỉ sử dụng văn bản thường>
 |chữ lý do=<dòng đầu tiên của bạn mà không có định dạng nhưng bao gồm dấu chấm câu và cho phép liên kết wiki.>
 |chữ giải thích=<Giải thích đầy đủ của bạn ở đây>
 |thể loại={{{thể loại|<thể loại của bạn ở đây, còn không thay tất cả bằng "không">}}}}}

Tham số

Tiêu bản này được thiết kế để định nghĩa cho cho các loại thông báo khóa chính, nhưng cũng đủ uyển chuyển để cho phép các ngoại lệ. Tất cả các tham số đều có cách khác để cho phép hiện mặc định nếu thất bại, nhưng một số nên luôn luôn dùng.

Tham số "thường" cần thiết

kiểu

Tham số kiểu áp dụng cho hầi hết các loại tiêu bản khóa mặc định. Nó có thể có giá trị là một trong các cách sau: hoàn toàn, nửa, vô hạn, di chuyển, khởi tạo, và văn phòng (không kể hoa/thường). Những giá trị này áp dụng chữ, hình ảnh, và liên kết mặc định. Tham số này nên luôn luôn được dùng, vì những thiết lập mặc định cần cho những đầu vào khác, khiến cho mã tiêu bản như {{pp-semi-protected}} được sạch sẽ. Chú ý rằng không cung cấp tham số này sẽ cho ra hình ảnh mặc định là Hình:Transparent.gif.

small

Tham số small cho phép tiêu bản quyết định xem có hiển thị biểu tượng nhỏ hay hiện cả một khung lớn. Nó có thể lấy bất kỳ giá trị nào, nhưng chỉ có một có thể đáp ứng là "yes" (không hoa/thường). Vì tiêu bản nên có thể quyết định điều này, nó nên được đặt là {{{small|}}}, mặc định là không nhỏ, nhưng sẽ nhỏ đi nếu chỉ định. Không cung cấp tham số sẽ khiến tiêu bản lúc nào cũng lớn.

hết hạn

Tham số hết hạn cho phép, khi kiểu đwuowcj định nghĩa bình thường, ngày hết hạn có thể tự động hiển thị đúng cho cả tooltip của phiên bản nhỏ và trong văn bản phiên bản lớn. Nó nên lấy giá trị là {{{hết hạn|}}}, để cho phép các tiêu bản con dùng tiêu bản này để cung cấp ngày hết hạn. Nó nên được để trống đối với tiêu bản mà ở đó kiểu được gán là vô hạn, vì nó không tác dụng vì tiêu bản khóa vô hạn rõ ràng không cần ngày tháng hết hạn.

tranh chấp

Tham số tranh chấp thêm vài chữ trong khung nói rằng không thừa nhận phiên bản hoặc tựa đề hiện tại. Nó không phụ thuộc vào tham số kiểu, nhưng tham số chữ giải thích mô tả phía dưới sẽ ghi đè nó nếu có.

lý do

Tham số lý do cho phép áp dụng lý do cụ thể vào tiêu bản để giải thích tại sao trang bị khóa. Mã được dùng trong tham số nên được bắt đầu bằng   để có khoảng trắng hợp lý giữa những từ như {{{lý do|}}} trong mã không bắt đầu bằng khoảng trắng, sao cho dấu chấm câu không bắt đầu bằng khoảng trắng khi lý do bị để trống. Các tiêu bản con muốn truyền thông quan lý do nên sử dụng mã cùng với những dòng {{{lý do|một lý do mặc định}}}.

thể loại

Tham số thể loại là khá nghiêm khắc trong các mẫu nhập mà tiêu bản này nên dùng: nếu tiêu bản có thể loại mà nó nên áp dụng tại những trang nó xuất hiện, chúng nên được hiện thực trong ngoặc {{{thể loại| và }}}, sẽ tạo ra thể loại tắt nếu chúng được cho |thể loại=không làm tham số. Nếu tiêu bản không có thể loại, không cần dùng tham số này.

không gian

Mặc dù tham số không gian chủ yếu hữu ích để kiểm tra, nhưng có thể dùng để trình diễn. Các tiêu bản con nói chung nên sử dụng mã không gian={{{không gian|}}} để cho phép buộc phải hiển thị như thể chúng đang trong không gian nào đó. Nếu tiêu bản luôn được dùng trong một không gian cụ thể và không ở không gian khác, cũng có thể gắn không gian là bất kỳ chính, thảo luận, hay khác (tất cả không phân biệt hoa/thường) để xác định kiểu bảng thông báo cho không gian đó sao cho nó thống nhất với nhau.

Tham số tùy thuộc kiểu

xfd

Nếu kiểu áp dụng là khởi tạo, và chữ giải thích như ở dưới không ghi đè lên nó, thì tham số xfd nên được dùng là bằng {{{xfd|}}} để đầu vào nào được truyền thông qua và lời giải thích có thể rõ ràng hơn.

Tham số tùy chọn

hình

The hình parameter allows an alternate icon to be chosen if so desired. This image should typically be chosen from Commons:Padlock icons, though any image can be chosen. Only the name of the alternate image should be applied; do not supply the "Image:" prefix.

lk icon

The lk icon parameter allows one to change the page to which the small version's icon links. This probably shouldn't generally be used if kiểu is in use as kiểu applies proper links to Wikiquote:Protection policy, but it allows for exceptions and can define the link to sections within that page. Input given to this parameter should not be supplied within [[double brackets]].

chữ icon

The chữ icon parameter, like the lk icon parameter, affects only the small version. This one, however, affects the text outputted as the tooltip for the protection icon. It completely replaces, when used, the default text and any specified by kiểu, including the final full stop.

lý do icon

The lý do icon parameter allows text to be added to the default text of the small version's tooltip as supplied by kiểu. It should be started with the text <nowiki> </nowiki> so that there is a space after the description and expiry code. It is over-written by chữ icon if that parameter is used.

chữ lý do

This parameter, chữ lý do, allows one to over-ride the first, bolded line of the text of the expanded version of any instance. It, when used, over-rides input as initially defined by kiểu, hết hạn, and lý do, including the final full stop.

chữ giải thích

This code over-rides the explanation text following the bolded reason line; it over-rides text initially provided by the template itself, kiểu, tranh chấp, and, if applicable, xfd.

Danh sách đầy đủ các tham số

{{pp-meta
 |kiểu=
 |small=
 |hết hạn=
 |lý do=
 |xfd=
 |không gian=
 |hình=
 |lk icon=
 |chữ icon=
 |lý do icon=
 |chữ lý do=
 |chữ giải thích=
 |thể loại=}}

Xem thêm

Bản mẫu khóa
	{{Khóa toàn cục}}	Hoàn toàn	Nửa	Di chuyển
	Tranh chấp	{{Khóa tranh chấp}}	Không có || {{Khóa di chuyển}}
	Phá hoại	{{Khóa phá hoại}}		{{Khóa di chuyển-phá hoại}}
	Bản mẫu và hình ảnh có nguy cơ cao	{{Khóa bản mẫu}}		Không có
	Trang thảo luận của thành viên bị cấm	{{Khóa-thảo luận thành viên}}	{{Khóa-nửa-thảo luận thành viên}}	Không có
	Mục tiêu của spambot	Không có || {{Khóa-nửa-spambot}} || Không có
	Tài khoản rối	{{Khóa-rối}}
	WP:TSNDS	Không có || {{Khóa-nửa-tsnds}} || Không có
	Vô hạn	Không có || {{Khóa-nửa-vô hạn}} || Không có
	Chung chung (mục đích khác)	{{Khóa}}		Không có
	Văn phòng đang xem xét	{{Khóa-văn phòng}}	Không có || Không có
	Thông tin trang thảo luận	{{Thảo luận trang khóa}}	{{Thảo luận trang khóa nửa}}	Không có
	Tạo trang	{{Khóa-khởi tạo}}		Không có
	Hình từ Commons trong Trang Chính	{{Khóa-Commons}}		Không có