Modul:Message box/doc

Modul-meta ini digunakan oleh templat message box seperti, {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}}, dan {{tmbox}}. Harus dijalankan melalui modul Lua, tidak boleh digunakan langsung pada halaman wiki. Jika Anda ingin menggunakan fungsi modul ini dari halaman wiki, gunakan templat message box sebagai gantinya.

Penggunaan

Untuk bisa menggunakan modul ini dari Lua yang lain, anda perlu memuat seperti ini:

local messageBox = require('Modul:Message box')

Untuk membuat message box, gunakan fungsi main. Diperlukan dua parameter: string dan tabel yang berisi parameter message box.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- Parameter lainnya...
})

Ada 7 jenis box yang tersedia:

Jenis box	Templat	Kegunaan
mbox	{{mbox}}	Untuk pembuatan message box yang akan digunakan dalam beberapa ruang nama
ambox	{{ambox}}	Untuk pembuatan message box pada artikel
cmbox	{{cmbox}}	Untuk pembuatan message box pada kategori
fmbox	{{fmbox}}	Untuk pembuatan message box antarmuka
imbox	{{imbox}}	Untuk pembuatan message box pada ruang nama berkas
tmbox	{{tmbox}}	Untuk pembuatan message box pada halaman pembicaraan
ombox	{{ombox}}	Untuk pembuatan message box pada ruang nama lainnya

Lihat halaman templat masing-masing jenis message box untuk parameter yang tersedia.

Gunakan #invoke

Disertai fungsi main, modul ini memiliki fungsi terpisah untuk message box masing-masing. Dijalankan menggunakan kode {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}}, dsb. Fungsi ini akan bekerja ketika dipanggil melalui modul lain, tetapi masing-masing menjalankan kode yang digunakan untuk memproses argumen menggunakan #invoke, dan tentu saja memanggil mereka akan kurang efisien daripada memanggil fungsi main.

Detail teknis

The module uses the same basic code for each of the templates listed above; the differences between each of them are configured using the data at Module:Message box/configuration. Here are the various configuration options and what they mean:

• types - a table containing data used by the type parameter of the message box. The table keys are the values that can be passed to the type parameter, and the table values are tables containing the class and the image used by that type.
• default - the type to use if no value was passed to the type parameter, or if an invalid value was specified.
• showInvalidTypeError - whether to show an error if the value passed to the type parameter was invalid.
• allowBlankParams - usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the allowBlankParams table.
• allowSmall - whether a small version of the message box can be produced with "small=yes".
• smallParam - a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
• smallClass - the class to use for small message boxes.
• substCheck - whether to perform a subst check or not.
• classes - an array of classes to use with the message box.
• imageEmptyCell - whether to use an empty <td>...</td> cell if there is no image set. This is used to preserve spacing for message boxes with a width of less than 100% of the screen.
• imageEmptyCellStyle - whether empty image cells should be styled.
• imageCheckBlank - whether "image=blank" results in no image being displayed.
• imageSmallSize - usually, images used in small message boxes are set to 30x30px. This sets a custom size.
• imageCellDiv - whether to enclose the image in a div enforcing a maximum image size.
• useCollapsibleTextFields - whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
• imageRightNone - whether imageright=none results in no image being displayed on the right-hand side of the message box.
• sectionDefault - the default name for the "section" parameter. Depends on useCollapsibleTextFields.
• allowMainspaceCategories - allow categorisation in the main namespace.
• templateCategory - the name of a category to be placed on the template page.
• templateCategoryRequireName - whether the name parameter is required to display the template category.
• templateErrorCategory - the name of the error category to be used on the template page.
• templateErrorParamsToCheck - an array of parameter names to check. If any are absent, the templateErrorCategory is applied to the template page.