Editing Module:Message box/doc (section)

== Usage ==

To use this module from another Lua module, first you need to load it.

<syntaxhighlight lang="lua">
local messageBox = require('Module:Message box')
</syntaxhighlight>

To create a message box, use the <code>main</code> function. It takes two parameters: the first is the box type (as a string), and the second is a table containing the message box parameters.

<syntaxhighlight lang="lua">
local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})
</syntaxhighlight>

There are seven available box types:

{| class="wikitable"
! Box type !! Template !! Purpose
|-
| <code>mbox</code> || For message boxes to be used in multiple namespaces
|-
| <code>ambox</code> || For article message boxes
|-
| <code>cmbox</code> || For category message boxes
|-
| <code>fmbox</code> || For interface message boxes
|-
| <code>imbox</code> || For file namespace message boxes
|-
| <code>tmbox</code> || For talk page message boxes
|-
| <code>ombox</code> || For message boxes in other namespaces
|}

See {{Tl|mbox}] for the available parameters.