Module:Message box/doc

{{#ifeq:doc|doc||{{#ifeq:doc |doc

    | 

{{#ifeq:show |show

|

        }}{{#if: |
         |   {{#ifexist:Module:Message box
                  | [[Category:{{#switch:Module |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  | 
                 }}
        }}
    | 
   }}}}{{#switch:

| =

This is a meta-module that implements the message box templates Template:Separated entries. 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 main function. It takes two parameters:

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

There are seven available box types:

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

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

Usage from #invoke

As well as the main function, this module has separate functions for each box type. They are accessed using the code Template:Magic word, Template:Tlc, etc. These will work when called from other modules, but they access code used to process arguments passed from Template:Tlc, and so calling them will be less efficient than calling main.

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.

| #default=

 {{#switch:

| = Template:Languages Template:Used in system Template:Module rating Template:Module rating Template:Lua Template:Uses TemplateStyles

This is a meta-module that implements the message box templates Template:Separated entries. 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 main function. It takes two parameters:

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

There are seven available box types:

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

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

Usage from #invoke

As well as the main function, this module has separate functions for each box type. They are accessed using the code Template:Magic word, Template:Tlc, etc. These will work when called from other modules, but they access code used to process arguments passed from Template:Tlc, and so calling them will be less efficient than calling main.

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.

{{safesubst:#if:{{safesubst:#ifeq:doc|sandbox|1}}{{safesubst:#ifeq:doc|doc|1}}|| }} | #default=

}} }}