View source for Module:Message box/doc/en

<noinclude><!--
-->{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<!--
--><languages /><!--
--></noinclude>{{#switch:
| =
<includeonly>{{Languages|Module:Message box/doc}}</includeonly>
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!-- {{Shared Template Warning|Module:Message box}} -->
{{Used in system}}
{{module rating|r}}
{{module rating|p}}
{{Lua|Module:Message box/configuration|Module:Arguments|Module:No globals|Module:Yesno}}
{{Uses TemplateStyles
| Module:Message box/ambox.css
| Module:Message box/cmbox.css
| Module:Message box/fmbox.css
| Module:Message box/imbox.css
| Module:Message box/ombox.css
| Module:Message box/tmbox.css
}}

This is a meta-module that implements the message box templates {{separated entries|{{tlx|mbox}}|{{tlx|ambox}}|{{tlx|cmbox}}|{{tlx|fmbox}}|{{tlx|imbox}}|{{tlx|ombox}}|{{tlx|tmbox}}|separator=<nowiki/>{{int|lang=en|comma-separator}}<nowiki/>|conjunction=<nowiki/>{{int|lang=en|and}}{{int|lang=en|word-separator}}<nowiki/>}}.
It is intended to be used from Lua modules, and should not be used directly from wiki pages.
If you want to use this module's functionality from a wiki page, please use the individual message box templates instead.

== 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:

{{Unordered list
|1=
the first is the box type (as a string).
|2=
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>
{{!}} {{tlx|mbox}}
{{!}} For message boxes to be used in multiple namespaces
{{!}}-
{{!}} <code>ambox</code>
{{!}} {{tlx|ambox}}
{{!}} For article message boxes
{{!}}-
{{!}} <code>cmbox</code>
{{!}} {{tlx|cmbox}}
{{!}} For category message boxes
{{!}}-
{{!}} <code>fmbox</code>
{{!}} {{tlx|fmbox}}
{{!}} For interface message boxes
{{!}}-
{{!}} <code>imbox</code>
{{!}} {{tlx|imbox}}
{{!}} For file namespace message boxes
{{!}}-
{{!}} <code>tmbox</code>
{{!}} {{tlx|tmbox}}
{{!}} For talk page message boxes
{{!}}-
{{!}} <code>ombox</code>
{{!}} {{tlx|ombox}}
{{!}} For message boxes in other namespaces
{{!)}}

See the template page of each box type for the available parameters.

== Usage from <code>#invoke</code> ==

As well as the <code>main</code> function, this module has separate functions for each box type.
They are accessed using the code {{magic word|ext=Scribunto|nowrap=1|code=1|#invoke|[[Module:Message box|Message box]]<nowiki>|mbox|...</nowiki>}}, {{tlc|#invoke:Message box|ambox|...}}, etc.
These will work when called from other modules, but they access code used to process arguments passed from {{tlc|#invoke:...}}, and so calling them will be less efficient than calling <code>main</code>.

== Technical details ==

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]].

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Modules{{#translation:}}]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
  {{#invoke:Template translation|renderTranslatedTemplate|template=Module:Message box/doc|noshift=1|uselang={{int:lang}}}}
}}