模組:Message box/doc

本模塊適用於{{mbox}}、{{fmbox}}、{{dmbox}}。

用法

在其它模塊中引用本模塊，您需要事先加載：

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

為創建一個消息框，您需要使用main函數，並給出兩個參數：第一個對應消息框類型（字符串），第二個對應消息。

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})

可用信息框類型：

類型	原對應模板	用途
ambox	{{ambox}}	條目命名空間
dmbox	{{dmbox}}	消歧義頁面
fmbox	{{fmbox}}	界面消息及表單
tmbox	{{tmbox}}	討論命名空間
ombox	{{ombox}}	其他命名空間

「#invoke」引入

除main函數外，本模塊為每個消息框類型對應了分別的函數，例如{{#invoke:Message box|ombox|...}}、{{#invoke:Message box|ambox|...}}等。

技術細節

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.
• allowId - whether it is possible to set an "id" attribute to the html table tag.
• 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.