Module:Message box/doc - Revision history

64.114 etc at 02:03, 19 October 2024

2024-10-19T02:03:55Z

← Previous revision		Revision as of 02:03, 19 October 2024
Line 1:		Line 1:
	{{Used in system}}		{{Used in system}}
	{{module rating\|p}}		{{module rating\|p}}
			{{cascade-protected template\|page=module}}
	{{Lua\|Module:Message box/configuration\|Module:Yesno\|Module:Arguments\|Module:Category handler}}		{{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}}		{{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}}

Materialscientist: Reverted edits by 212.252.118.132 (talk) (HG) (3.4.12)

2024-07-01T12:14:42Z

Reverted edits by 212.252.118.132 (talk) (HG) (3.4.12)

← Previous revision	Revision as of 12:14, 1 July 2024
Line 1:	Line 1:
		{{Used in system}}
		{{module rating\|p}}
		{{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.

		== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
		\|-
		\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
		\|-
		\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
		\|-
		\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
		\|-
		\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
		\|-
		\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
		\|-
		\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
		\|}

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

		== Usage from #invoke ==

		As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
		* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
		* <code>smallClass</code> – the class to use for small message boxes.
		* <code>substCheck</code> – whether to perform a subst check or not.
		* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
		* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
		* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
		* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
		* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
		* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
		* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
		* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
		* <code>templateCategory</code> – the name of a category to be placed on the template page.
		* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

		<includeonly>{{Sandbox other\|\|
		[[Category:Wikipedia modules]]
		}}</includeonly>

212.252.118.132: ←Blanked the page

2024-07-01T12:14:15Z

←Blanked the page

← Previous revision		Revision as of 12:14, 1 July 2024
Line 1:		Line 1:
	{{Used in system}}
	{{module rating\|p}}
	{{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.

	== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
	\|-
	\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
	\|-
	\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
	\|-
	\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
	\|-
	\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
	\|-
	\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
	\|-
	\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
	\|}

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

	== Usage from #invoke ==

	As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
	* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
	* <code>smallClass</code> – the class to use for small message boxes.
	* <code>substCheck</code> – whether to perform a subst check or not.
	* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
	* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
	* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
	* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
	* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
	* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
	* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
	* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
	* <code>templateCategory</code> – the name of a category to be placed on the template page.
	* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

	<includeonly>{{Sandbox other\|\|
	[[Category:Wikipedia modules]]
	}}</includeonly>

Andrybak: Category:Wikipedia modules

2024-06-16T14:48:15Z

Category:Wikipedia modules

← Previous revision		Revision as of 14:48, 16 June 2024
Line 76:		Line 76:
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

			<includeonly>{{Sandbox other\|\|
			[[Category:Wikipedia modules]]
			}}</includeonly>

Vanished User 345678909876: Reverted 1 edit by 2806:106E:22:1F0A:5111:4AE7:DD5C:ABD3 (talk) to last revision by Philipnelson99

2024-03-04T14:55:05Z

Reverted 1 edit by 2806:106E:22:1F0A:5111:4AE7:DD5C:ABD3 (talk) to last revision by Philipnelson99

← Previous revision	Revision as of 14:55, 4 March 2024
Line 1:	Line 1:
		{{Used in system}}
		{{module rating\|p}}
		{{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.

		== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
		\|-
		\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
		\|-
		\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
		\|-
		\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
		\|-
		\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
		\|-
		\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
		\|-
		\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
		\|}

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

		== Usage from #invoke ==

		As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
		* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
		* <code>smallClass</code> – the class to use for small message boxes.
		* <code>substCheck</code> – whether to perform a subst check or not.
		* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
		* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
		* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
		* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
		* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
		* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
		* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
		* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
		* <code>templateCategory</code> – the name of a category to be placed on the template page.
		* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

2806:106E:22:1F0A:5111:4AE7:DD5C:ABD3: ←Blanked the page

2024-03-04T14:54:47Z

←Blanked the page

← Previous revision		Revision as of 14:54, 4 March 2024
Line 1:		Line 1:
	{{Used in system}}
	{{module rating\|p}}
	{{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.

	== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
	\|-
	\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
	\|-
	\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
	\|-
	\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
	\|-
	\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
	\|-
	\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
	\|-
	\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
	\|}

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

	== Usage from #invoke ==

	As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
	* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
	* <code>smallClass</code> – the class to use for small message boxes.
	* <code>substCheck</code> – whether to perform a subst check or not.
	* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
	* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
	* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
	* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
	* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
	* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
	* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
	* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
	* <code>templateCategory</code> – the name of a category to be placed on the template page.
	* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

Philipnelson99: Reverted edits by 2409:4052:2E99:527:0:0:4F49:A903 (talk): page blanking (HG) (3.4.11)

2023-11-27T02:45:01Z

Reverted edits by 2409:4052:2E99:527:0:0:4F49:A903 (talk): page blanking (HG) (3.4.11)

← Previous revision	Revision as of 02:45, 27 November 2023
Line 1:	Line 1:
		{{Used in system}}
		{{module rating\|p}}
		{{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.

		== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
		\|-
		\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
		\|-
		\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
		\|-
		\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
		\|-
		\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
		\|-
		\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
		\|-
		\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
		\|}

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

		== Usage from #invoke ==

		As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
		* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
		* <code>smallClass</code> – the class to use for small message boxes.
		* <code>substCheck</code> – whether to perform a subst check or not.
		* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
		* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
		* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
		* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
		* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
		* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
		* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
		* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
		* <code>templateCategory</code> – the name of a category to be placed on the template page.
		* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

2409:4052:2E99:527:0:0:4F49:A903: ←Blanked the page

2023-11-27T02:44:53Z

←Blanked the page

← Previous revision		Revision as of 02:44, 27 November 2023
Line 1:		Line 1:
	{{Used in system}}
	{{module rating\|p}}
	{{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.

	== 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: the first is the box type (as a string), and 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> \|\| {{tl\|mbox}} \|\| For message boxes to be used in multiple namespaces
	\|-
	\| <code>ambox</code> \|\| {{tl\|ambox}} \|\| For article message boxes
	\|-
	\| <code>cmbox</code> \|\| {{tl\|cmbox}} \|\| For category message boxes
	\|-
	\| <code>fmbox</code> \|\| {{tl\|fmbox}} \|\| For interface message boxes
	\|-
	\| <code>imbox</code> \|\| {{tl\|imbox}} \|\| For file namespace message boxes
	\|-
	\| <code>tmbox</code> \|\| {{tl\|tmbox}} \|\| For talk page message boxes
	\|-
	\| <code>ombox</code> \|\| {{tl\|ombox}} \|\| For message boxes in other namespaces
	\|}

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

	== Usage from #invoke ==

	As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #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]]. 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>allowSmall</code> – whether a small version of the message box can be produced with "small=yes".
	* <code>smallParam</code> – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
	* <code>smallClass</code> – the class to use for small message boxes.
	* <code>substCheck</code> – whether to perform a subst check or not.
	* <code>classes</code> – an array of classes to use with 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>imageEmptyCellStyle</code> – whether empty image cells should be styled.
	* <code>imageCheckBlank</code> – whether "image=blank" results in no image being displayed.
	* <code>imageSmallSize</code> – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
	* <code>imageCellDiv</code> – whether to enclose the image in a div enforcing a maximum image size.
	* <code>useCollapsibleTextFields</code> – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
	* <code>imageRightNone</code> – whether imageright=none results in no image being displayed on the right-hand side of the message box.
	* <code>sectionDefault</code> – the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>.
	* <code>allowMainspaceCategories</code> – allow categorisation in the main namespace.
	* <code>templateCategory</code> – the name of a category to be placed on the template page.
	* <code>templateCategoryRequireName</code> – whether the <code>name</code> parameter is required to display the template category.
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.

Philipnelson99: Reverted edits by 2409:4052:2E99:527:0:0:4F49:A903 (talk) (HG) (3.4.11)

2023-11-27T02:27:35Z

Reverted edits by 2409:4052:2E99:527:0:0:4F49:A903 (talk) (HG) (3.4.11)

← Previous revision		Revision as of 02:27, 27 November 2023
Line 1:		Line 1:
	{{Used in system ~~is/in my life~~ }}		{{Used in system}}
	{{module ~~bugrating~~\|p}}		{{module rating\|p}}
	{{Lua\|Module:~~Mes sage~~ box/configuration \|Module:Yesno\|Module:Arguments\|Module:Category handler}}		{{Lua\|Module:Message box/configuration\|Module:Yesno\|Module:Arguments\|Module:Category handler}}
	{{Uses TemplateStyles\|Module:Message box/ambox.css\|Module:~~reel~~ box/cmbox.css\|Module:~~reel~~		{{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}}
	box/fmbox.css\|Module:reel box/imbox.css\|Module:reel box/ombox.css\|Module:reel 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.		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 22:		Line 21:
	param2 = param2,		param2 = param2,
	-- More parameters...		-- More parameters...
			})
	\|- (http//.markesbug)//{{time}}\|\|for
	</syntaxhighlight>		</syntaxhighlight>

Line 50:		Line 49:

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

	https://en.wikipedia.org/w/index.php?title=Module%3AMessage_box%2Fdoc&action=edit
	== Technical details ==		== Technical details ==

	The module uses the ~~different~~ 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:		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>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.
Line 77:		Line 76:
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.



	https://en.wikipedia.org/w/index.php?title=Module%3AMessage_box%2Fdoc&action=edit°

2409:4052:2E99:527:0:0:4F49:A903: Vigo

2023-11-27T02:27:28Z

Vigo

← Previous revision		Revision as of 02:27, 27 November 2023
Line 1:		Line 1:
	{{Used in system}}		{{Used in system is/in my life }}
	{{module ~~rating~~\|p}}		{{module bugrating\|p}}
	{{Lua\|Module:~~Message~~ box/configuration\|Module:Yesno\|Module:Arguments\|Module:Category handler}}		{{Lua\|Module:Mes sage 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}}		{{Uses TemplateStyles\|Module:Message box/ambox.css\|Module:reel box/cmbox.css\|Module:reel
			box/fmbox.css\|Module:reel box/imbox.css\|Module:reel box/ombox.css\|Module:reel 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.		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 21:		Line 22:
	param2 = param2,		param2 = param2,
	-- More parameters...		-- More parameters...
			\|- (http//.markesbug)//{{time}}\|\|for
	})
	</syntaxhighlight>		</syntaxhighlight>

Line 49:		Line 50:

	As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #invoke, and so calling them will be less efficient than calling <code>main</code>.		As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box\|mbox\|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box\|ambox\|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #invoke, and so calling them will be less efficient than calling <code>main</code>.
			https://en.wikipedia.org/w/index.php?title=Module%3AMessage_box%2Fdoc&action=edit

	== Technical details ==		== 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]]. Here are the various configuration options and what they mean:		The module uses the different 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>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.
Line 76:		Line 77:
	* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.		* <code>templateErrorCategory</code> – the name of the error category to be used on the template page.
	* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.		* <code>templateErrorParamsToCheck</code> – an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.



			https://en.wikipedia.org/w/index.php?title=Module%3AMessage_box%2Fdoc&action=edit°

← Previous revision		Revision as of 02:03, 19 October 2024
Line 1:		Line 1:
	{{Used in system}}		{{Used in system}}
	{{module rating\|p}}		{{module rating\|p}}
			{{cascade-protected template\|page=module}}
	{{Lua\|Module:Message box/configuration\|Module:Yesno\|Module:Arguments\|Module:Category handler}}		{{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}}		{{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}}