Module:Message box/doc: Difference between revisions

Revision as of 14:54, 14 April 2014

Latest revision as of 02:03, 19 October 2024

(83 intermediate revisions by 60 users not shown)

Line 1:

{{Used in system}}

{{High-risk|3,600,000}}

{{module rating|p}}

{{cascade-protected template|page=module}}

{{Lua|Module:Message box/configuration|Module:Yesno|Module:Arguments|Module:Category handler}}

{{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 {{tl|mbox}}, {{tl|ambox}}, {{tl|cmbox}}, {{tl|fmbox}}, {{tl|imbox}}, {{tl|ombox}}, and {{tl|tmbox}}. 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.

Line 8 ⟶ 11:

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

<sourcesyntaxhighlight lang="lua">

local messageBox = require('Module:Message box')

</syntaxhighlight>

</source>

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.

<sourcesyntaxhighlight lang="lua">

local box = messageBox.main( boxType, {

param1 = param1,

Line 20 ⟶ 23:

-- More parameters...

})

</syntaxhighlight>

</source>

There are seven available box types:

Line 52 ⟶ 55:

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>allowIdallowSmall</code> -– whether ita issmall possibleversion toof setthe anmessage "id"box attributecan tobe theproduced htmlwith table tag"small=yes".

* <code>allowSmallsmallParam</code> - whether– a smallcustom versionname offor the messagesmall boxparameter. For example, if set to "left" you can beproduce produceda small message box withusing "small=yesleft".

* <code>smallParamsmallClass</code> - a custom name for– the small parameter. For example, if setclass to "left"use you can produce afor small message box using "small=left"boxes.

* <code>smallClasssubstCheck</code> -– the classwhether to useperform a forsubst smallcheck messageor boxesnot.

* <code>substCheckclasses</code> -– whetheran toarray performof classes to ause substwith checkthe ormessage notbox.

* <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>classes</code> - an array of classes to use with the message box.

* <code>usePlainlinksParamimageEmptyCellStyle</code> -– whether toempty allowimage "plainlinks=no"cells toshould turnbe off the plainlinks classstyled.

* <code>imageRightNoneimageCheckBlank</code> -– whether imageright"image=noneblank" results in no image being displayed on the right-hand side of 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>imageSmallSize</code> -– usually, images used in small message boxes are set to 30x30px. This sets a custom size.

* <code>imageEmptyCellStyle</code> - whether empty image cells should be styled.

* <code>imageCheckBlankimageCellDiv</code> -– whether "image=blank"to resultsenclose the image in noa imagediv beingenforcing a maximum image displayedsize.

* <code>useCollapsibleTextFields</code> -– whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.

* <code>imageSmallSize</code> - usually, images used in small message boxes are set to 30x30px. This sets a custom size.

* <code>imageCellDivimageRightNone</code> -– whether toimageright=none encloseresults thein no image inbeing adisplayed divon enforcingthe aright-hand maximumside imageof the message sizebox.

* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.

* <code>useCollapsibleTextFields</code> - whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.

* <code>allowMainspaceCategories</code> -– allow categorisation in the main namespace.

* <code>imageRightNone</code> - whether imageright=none results in no image being displayed on the right-hand side of the message box.

* <code>sectionDefaulttemplateCategory</code> -– the default name forof thea "section"category parameter.to Dependsbe placed on <code>useCollapsibleTextFields</code>the template page.

* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.

* <code>allowMainspaceCategories</code> - allow categorisation in the main namespace.

* <code>templateCategorytemplateErrorCategory</code> -– the name of athe error category to be placedused on the template page.

* <code>templateCategoryRequireNametemplateErrorParamsToCheck</code> -– whetheran array of parameter names to check. If any are absent, the <code>nametemplateErrorCategory</code> parameter is requiredapplied to display the template categorypage.

* <code>templateErrorCategory</code> - the name of the error category to be used on the template page.

<includeonly>{{Sandbox other||

* <code>templateErrorParamsToCheck</code> - an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

[[Category:Wikipedia modules]]

}}</includeonly>