Module:Message box/configuration/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 13:42, 16 October 2026

This module is used in system messages.
Changes to it can cause immediate changes to the MediaWiki user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space.The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This module contains configuration data for Module:Message box.

Configuration options

Option	Explanation
`types`	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.
`default`	The type to use if no value was passed to the type parameter, or if an invalid value was specified.
`showInvalidTypeError`	Whether to show an error if the value passed to the type parameter was invalid.
`allowBlankParams`	Usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the `allowBlankParams` table.
`allowSmall`	Whether a small version of the message box can be produced with `\|small=1`.
`smallParam`	A custom value for the `\|small=` parameter. For example, if set to `"left"` you can produce a small message box using `\|small=left`.
`smallClass`	The class to use for small message boxes.
`substCheck`	Whether to perform a subst check or not.
`classes`	An array of classes to use with the message box.
`imageEmptyCell`	Whether to use an empty `‎<td>...‎</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.
`imageEmptyCellStyle`	Whether empty image cells should be styled.
`imageCheckBlank`	Whether `\|image=blank` results in no image being displayed.
`imageSmallSize`	Usually, images used in small message boxes are set to 30x30px. This sets a custom size.
`imageCellDiv`	Whether to enclose the image in a `‎<div>` enforcing a maximum image size.
`useCollapsibleTextFields`	Whether to use text fields that can be collapsed, i.e. `"issue"`, `"fix"`, `"talk"`, etc. Currently only used in {{ambox}}.
`imageRightNone`	Whether `\|imageright=none` results in no image being displayed on the right-hand side of the message box.
`sectionDefault`	The default name for the `\|section=` parameter. Depends on `useCollapsibleTextFields`.
`allowMainspaceCategories`	Allow categorisation in the main namespace.
`templateCategory`	The name of a category to be placed on the template page.
`templateCategoryRequireName`	Whether the `\|name=` parameter is required to display the template category.
`templateErrorCategory`	The name of the error category to be used on the template page.
`templateErrorParamsToCheck`	An array of parameter names to check. If any are absent, the `templateErrorCategory` is applied to the template page.

@@ Line 1: / Line 1: @@
 <noinclude><!--
 -->{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<!--
---><!--
+--><languages /><!--
---></noinclude>{{#switch:
+--></noinclude>{{#switch:<translate></translate>
 | =
 <includeonly>{{Languages|Module:Message box/configuration/doc}}</includeonly>
@@ Line 8: / Line 8: @@
 {{Used in system}}
 {{Module rating|protected}}
+<translate>
-This module contains configuration data for [[Module:Message box]].
+<!--T:1-->
+This module contains configuration data for <tvar name=1>[[Module:Message box]]</tvar>.
-== Configuration options ==
+== Configuration options == <!--T:2-->
+</translate>
 {{(!}} class="wikitable plainrowheaders"
-! scope="col" {{!}} Option
+! scope="col" {{!}} <translate><!--T:3--> Option</translate>
-! scope="col" {{!}} Explanation
+! scope="col" {{!}} <translate><!--T:4--> Explanation</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <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.
+{{!}} <translate><!--T:5--> A table containing data used by the type parameter of the message box.</translate> <translate><!--T:6--> 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.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>default</code>
-{{!}} The type to use if no value was passed to the type parameter, or if an invalid value was specified.
+{{!}} <translate><!--T:7--> The type to use if no value was passed to the type parameter, or if an invalid value was specified.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>showInvalidTypeError</code>
-{{!}} Whether to show an error if the value passed to the type parameter was invalid.
+{{!}} <translate><!--T:8--> Whether to show an error if the value passed to the type parameter was invalid.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>allowBlankParams</code>
-{{!}} Usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the <code>allowBlankParams</code> table.
+{{!}} <translate><!--T:9--> Usually blank values are stripped from parameters passed to the module.</translate> <translate><!--T:10--> However, whitespace is preserved for the parameters included in the <tvar name=1><code>allowBlankParams</code></tvar> table.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>allowSmall</code>
-{{!}} Whether a small version of the message box can be produced with {{para|small|1}}.
+{{!}} <translate><!--T:11--> Whether a small version of the message box can be produced with <tvar name=1>{{para|small|1}}</tvar>.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>smallParam</code>
-{{!}} A custom value for the {{para|small}} parameter. For example, if set to {{inline-code|lang=lua|"left"}} you can produce a small message box using {{para|small|left}}.
+{{!}} <translate><!--T:12--> A custom value for the <tvar name=1>{{para|small}}</tvar> parameter.</translate> <translate><!--T:13--> For example, if set to <tvar name=1>{{inline-code|lang=lua|"left"}}</tvar> you can produce a small message box using <tvar name=2>{{para|small|left}}</tvar>.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>smallClass</code>
-{{!}} The class to use for small message boxes.
+{{!}} <translate><!--T:14--> The class to use for small message boxes.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>substCheck</code>
-{{!}} Whether to perform a subst check or not.
+{{!}} <translate><!--T:15--> Whether to perform a subst check or not.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>classes</code>
-{{!}} An array of classes to use with the message box.
+{{!}} <translate><!--T:16--> An array of classes to use with the message box.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <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.
+{{!}} <translate><!--T:17--> Whether to use an empty <tvar name=1>{{tag|td}}</tvar> cell if there is no image set.</translate> <translate><!--T:18--> This is used to preserve spacing for message boxes with a width of less than <tvar name=1>100%</tvar> of the screen.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>imageEmptyCellStyle</code>
-{{!}} Whether empty image cells should be styled.
+{{!}} <translate><!--T:19--> Whether empty image cells should be styled.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>imageCheckBlank</code>
-{{!}} Whether {{para|image|blank}} results in no image being displayed.
+{{!}} <translate><!--T:20--> Whether <tvar name=1>{{para|image|blank}}</tvar> results in no image being displayed.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>imageSmallSize</code>
-{{!}} Usually, images used in small message boxes are set to 30x30px. This sets a custom size.
+{{!}} <translate><!--T:21--> Usually, images used in small message boxes are set to <tvar name=1>30x30px</tvar>.</translate> <translate><!--T:22--> This sets a custom size.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>imageCellDiv</code>
-{{!}} Whether to enclose the image in a {{tag|div|o}} enforcing a maximum image size.
+{{!}} <translate><!--T:23--> Whether to enclose the image in a <tvar name=1>{{tag|div|o}}</tvar> enforcing a maximum image size.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>useCollapsibleTextFields</code>
-{{!}} Whether to use text fields that can be collapsed, i.e. {{inline-code|lang=lua|"issue"}}, {{inline-code|lang=lua|"fix"}}, {{inline-code|lang=lua|"talk"}}, etc. Currently only used in {{tlx|ambox}}.
+{{!}} <translate><!--T:24--> Whether to use text fields that can be collapsed, i.e. <tvar name=1>{{inline-code|lang=lua|"issue"}}</tvar>, <tvar name=2>{{inline-code|lang=lua|"fix"}}</tvar>, <tvar name=3>{{inline-code|lang=lua|"talk"}}</tvar>, etc.</translate> <translate><!--T:25--> Currently only used in <tvar name=1>{{tlx|ambox}}</tvar>.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>imageRightNone</code>
-{{!}} Whether {{para|imageright|none}} results in no image being displayed on the right-hand side of the message box.
+{{!}} <translate><!--T:26--> Whether <tvar name=1>{{para|imageright|none}}</tvar> results in no image being displayed on the right-hand side of the message box.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>sectionDefault</code>
-{{!}} The default name for the {{para|section}} parameter. Depends on <code>useCollapsibleTextFields</code>.
+{{!}} <translate><!--T:27--> The default name for the <tvar name=1>{{para|section}}</tvar> parameter.</translate> <translate><!--T:28--> Depends on <tvar name=1><code>useCollapsibleTextFields</code></tvar>.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>allowMainspaceCategories</code>
-{{!}} Allow categorisation in the main namespace.
+{{!}} <translate><!--T:29--> Allow categorisation in the main namespace.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>templateCategory</code>
-{{!}} The name of a category to be placed on the template page.
+{{!}} <translate><!--T:30--> The name of a category to be placed on the template page.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>templateCategoryRequireName</code>
-{{!}} Whether the {{para|name}} parameter is required to display the template category.
+{{!}} <translate><!--T:31--> Whether the <tvar name=1>{{para|name}}</tvar> parameter is required to display the template category.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>templateErrorCategory</code>
-{{!}} The name of the error category to be used on the template page.
+{{!}} <translate><!--T:32--> The name of the error category to be used on the template page.</translate>
 {{!}}-
 ! scope="row" style="text-align:left;font-weight:normal" {{!}} <code>templateErrorParamsToCheck</code>
-{{!}} An array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.
+{{!}} <translate><!--T:33--> An array of parameter names to check.</translate> <translate><!--T:34--> If any are absent, the <tvar name=1><code>templateErrorCategory</code></tvar> is applied to the template page.</translate>
 {{!)}}
 <includeonly>{{Sandbox other||

Majestix (talk | contribs)

Latest revision as of 13:42, 16 October 2026

Configuration options