编辑“︁模块:Message box/doc”︁

{{Used in system}}
{{module rating|p}}
{{uses Lua|Module:Message box/configuration}}

本模块适用于{{tl|mbox}}、{{tl|fmbox}}、{{tl|dmbox}}。

== 用法 ==
在其它模块中引用本模块，您需要事先加载：
<syntaxhighlight lang="lua">
local messageBox = require('Module:Message box')
</syntaxhighlight>

为创建一个消息框，您需要使用<code>main</code>函数，并给出两个参数：第一个对应消息框类型（字符串），第二个对应消息。
<syntaxhighlight lang="lua">
local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})
</syntaxhighlight>

可用信息框类型：
{| class="wikitable"
! 类型 !! 原对应模板 !! 用途
|-
| <code>ambox</code> || {{tl|ambox}} || 条目命名空间
|-
| <code>dmbox</code> || {{tl|dmbox}} || 消歧义页面
|-
| <code>fmbox</code> || {{tl|fmbox}} || 界面消息及表单
|-
| <code>tmbox</code> || {{tl|tmbox}} || 讨论命名空间
|-
| <code>ombox</code> || {{tl|ombox}} || 其他命名空间
|}

== “#invoke”引入 ==
除<code>main</code>函数外，本模块为每个消息框类型对应了分别的函数，例如<code><nowiki>{{#invoke:Message box|ombox|...}}</nowiki></code>、<code><nowiki>{{#invoke:Message box|ambox|...}}</nowiki></code>等。

== 技术细节 ==
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:

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