Modul Lua ini digunakan pada sekitar257.000halaman, atau sekira 6% dari keseluruhan halaman. Untuk mencegah suntingan mengganggu skala besar dan beban peladen, setiap perubahan harus diuji di subhalaman /bak pasir atau /kasus uji Modul:Message box, atau bak pasir modul Anda. Perubahan yang telah diuji kemudian dapat ditambahkan ke halaman ini dalam satu suntingan. Pertimbangkan untuk mendiskusikan perubahan di halaman pembicaraan sebelum mengimplementasikannya.
Modul ini dilindungi. Modul ini sangat mencolok yang digunakan oleh banyak halaman, atau sangat sering disubstitusikan. Karena vandalisme atau kesalahan akan mempengaruhi banyak halaman, dan suntingan kecil dapat memberi beban besar pada server, modul ini dilindungi dari penyuntingan.
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:
localmessageBox=require('Modul:Message box')
Untuk membuat message box, gunakan fungsi main. Diperlukan dua parameter: string dan tabel yang berisi parameter message box.
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
Modul ini menggunakan kode dasar yang sama untuk setiap templat yang tercantum di atas;
perbedaan antara masing-masing templat dikonfigurasi menggunakan data di Module:Message box/configuration.
Berikut adalah berbagai opsi konfigurasi yang tersedia dan penjelasannya:
types – tabel yang berisi data yang digunakan oleh parameter type pada kotak pesan. Kunci tabel adalah nilai-nilai yang dapat diteruskan ke parameter type, dan nilai tabelnya adalah tabel lain yang berisi kelas dan gambar yang digunakan oleh tipe tersebut.
default – tipe yang akan digunakan jika tidak ada nilai yang diberikan pada parameter type, atau jika nilai yang diberikan tidak valid.
showInvalidTypeError – menentukan apakah kesalahan akan ditampilkan jika nilai yang diteruskan ke parameter type tidak valid.
allowBlankParams – secara umum, nilai kosong dihapus dari parameter yang diteruskan ke modul. Namun, spasi tetap dipertahankan untuk parameter yang disertakan dalam tabel allowBlankParams.
allowSmall – menentukan apakah versi kecil dari kotak pesan dapat dibuat dengan menggunakan small=yes.
smallParam – nama khusus untuk parameter small. Misalnya, jika diatur menjadi "left", kamu dapat membuat kotak pesan kecil menggunakan small=left.
smallClass – kelas CSS yang digunakan untuk kotak pesan kecil.
substCheck – menentukan apakah pemeriksaan subst akan dilakukan atau tidak.
classes – array kelas CSS yang akan digunakan pada kotak pesan.
imageEmptyCell – menentukan apakah akan menggunakan sel <td>...</td> kosong jika tidak ada gambar yang ditetapkan. Hal ini digunakan untuk menjaga jarak (spasi) pada kotak pesan yang lebarnya kurang dari 100% dari layar.
imageEmptyCellStyle – menentukan apakah sel gambar kosong akan diberi gaya (styled) atau tidak.
imageCheckBlank – menentukan apakah image=blank berarti tidak ada gambar yang ditampilkan.
imageSmallSize – biasanya gambar pada kotak pesan kecil diatur berukuran 30x30px. Opsi ini memungkinkan untuk menetapkan ukuran khusus.
imageCellDiv – menentukan apakah gambar harus dibungkus dalam elemen div yang membatasi ukuran maksimum gambar.
useCollapsibleTextFields – menentukan apakah akan menggunakan kolom teks yang dapat diciutkan (collapsible), seperti "issue", "fix", "talk", dan sebagainya. Saat ini hanya digunakan pada modul ambox.
imageRightNone – menentukan apakah imageright=none berarti tidak ada gambar yang ditampilkan di sisi kanan kotak pesan.
sectionDefault – nama default untuk parameter section. Nilainya bergantung pada pengaturan useCollapsibleTextFields.
allowMainspaceCategories – mengizinkan pengkategorian di ruang nama utama (main namespace).
templateCategory – nama kategori yang akan ditempatkan pada halaman templat.
templateCategoryRequireName – menentukan apakah parameter name diperlukan agar kategori templat dapat ditampilkan.
templateErrorCategory – nama kategori kesalahan (error category) yang akan digunakan di halaman templat.
templateErrorParamsToCheck – array nama parameter yang harus diperiksa. Jika salah satunya tidak ada, maka templateErrorCategory akan diterapkan pada halaman templat.
