Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<noinclude>{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<languages /></noinclude>{{#switch:
| =
<includeonly>{{Languages|Module:Message box/doc}}</includeonly>


{{Used in system}}
{{module rating|r}}
{{module rating|p}}
{{Lua|Module:Message box/configuration|Module:Arguments|Module:Category handler|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
}}

<span lang="en" dir="ltr" class="mw-content-ltr">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/>}}.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It is intended to be used from Lua modules, and should not be used directly from wiki pages.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you want to use this module's functionality from a wiki page, please use the individual message box templates instead.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Usage ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To use this module from another Lua module, first you need to load it.
</div>

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

<span lang="en" dir="ltr" class="mw-content-ltr">To create a message box, use the <code>main</code> function.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It takes two parameters:</span>

{{Unordered list
|1=
<span lang="en" dir="ltr" class="mw-content-ltr">the first is the box type (as a string).</span>
|2=
<span lang="en" dir="ltr" class="mw-content-ltr">the second is a table containing the message box parameters.</span>
}}

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

<div lang="en" dir="ltr" class="mw-content-ltr">
There are seven available box types:
</div>

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

<div lang="en" dir="ltr" class="mw-content-ltr">
See the template page of each box type for the available parameters.
</div>

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

<span lang="en" dir="ltr" class="mw-content-ltr">As well as the <code>main</code> function, this module has separate functions for each box type.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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>.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Technical details ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
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]].
</div>

<includeonly>{{Sandbox other||

[[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}}}}
}}