Modul:Protection banner/doc

Modul ini digunakan untuk membuat tajuk pelindungan dan ikon gembok yang ditempatkan di atas halaman pelindungan.

Penggunaan

Tidak dapat digunakan secara langsung. Templat pelindungan memerlukan templat {{pp}}, atau menggunakan daftar templat di bawah

Dari teks wiki

{{#invoke:Protection banner|main
| 1        = reason
| small    = yes/no
| action   = action
| date     = protection date
| user     = username
| section  = talk page section name
| category = no
}}

Sintaksis #invoke digunakan untuk templat yang lebih spesifik daripada {{pp}}. Misalnya, it is possible to create a protection template which always shows a padlock icon by using the code {{#invoke:Protection banner|main|small=yes}}. Pages which call this template will still be able to use other arguments, like action. However, this only works one level deep; a page calling a template which calls another template containing the above code will not automatically be able to use parameters like action.

Note: You should no longer specify the expiry, as it is automatically retrieved in all cases.

Dari lua

First, load the module.

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

Then you can make protection banners by using the _main function.

mProtectionBanner._main(args, cfg, titleObj)

args is a table of arguments to pass to the module. For possible keys and values for this table, see the parameters section. The cfg and titleObj variables are intended only for testing; cfg specifies a customised config table to use instead of Module:Protection banner/config, and titleObj specifies a mw.title object to use instead of the current title. args, cfg and titleObj are all optional.

Parameters

All parameters are optional.

• 1 – the reason that the page was protected. If set, this must be one of the values listed in the reasons table.
• small – if set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.
• action – the protection action. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). The default value is "edit".
• date – the protection date. This must be valid input to the second parameter of the #time parser function. This argument has an effect for reasons that use the PROTECTIONDATE parameter in their configuration. As of July 2014, those were the "office" and "reset" reasons.
• user – the username of the user to generate links for. As of July 2014, this only has an effect when the "usertalk" reason is specified.
• section – the section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.
• category – categories are suppressed if this is set to "no", "n", "0", or "false".

Reasons

The following table contains the available reasons, plus the actions for which they are available.

Errors

Below is a list of some of the common errors that this module can produce, and how to fix them.

Invalid protection date

This error is produced if you supply an |date= parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "21 April 2024". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).

Invalid action

This error is produced if you specify an invalid protection action. There are only three valid actions: edit (the default, for normal protection), move (for move-protection), and autoreview (for pending changes). This should only be possible if you are using a template that supports manually specifying the protection action, such as {{pp}}, or if you are using #invoke directly. If this is not the case, please leave a message on Module talk:Protection banner.

Reasons cannot contain the pipe character

Galat ini dihasilkan jika Anda memberikan alasan pada parameter |1= mengandung karakter pipa ("|"). Periksa bahwa Anda tidak memasukkan templat {{!}} ke parameter ini. Karakter ini dilarang karena modul ini menggunakan karakter tersebut secara internal. Alasan yang valid dapat dilihat di bagian alasan.

Galat yang lain

Jika Anda melihat galat selain hal di atas, kemungkinan itu adalah kekutu atau kesalahan konfigurasi. Kirim pesan mengenai masalah ini di Pembicaraan Modul:Protection banner.

Detail teknis

Modul ini menggunakan konfigurasi Module:Protection banner/config. Kebanyakan perilaku modul, dikonfigurasi di sana sehingga sangat portabel di antara wiki dalam berbagai bahasa

Kasus uji umum modul ini dapat dilakukan di Modul:Protection banner/kasus uji, dan konfigurasinya dapat dilakukan di Modul:Protection banner/config/kasus uji.

Masalah kekutu dan fitur baru dapat dibicarakan di halaman pembicaraan modul ini.