Module:Check for unknown parameters/doc - Revision history

Annh07: Reverted edit by 2001:D08:1391:1BDF:6226:D3B1:EBFC:9742 (talk) to last version by Gonnym

2025-02-15T14:18:41Z

Reverted edit by 2001:D08:1391:1BDF:6226:D3B1:EBFC:9742 (talk) to last version by Gonnym

← Previous revision		Revision as of 14:18, 15 February 2025
Line 2:		Line 2:
	{{Module rating\|p}}		{{Module rating\|p}}
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}
	{{Lua\|Module:If preview\|noprotcat=No}}		{{Lua\|Module:If preview\|noprotcat=yes}}

	'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module		'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

	== Usage ==		== Usage ==
			=== From a template ===
	To sort entries into a tracking category by parameter, use:		To sort entries into a tracking category by parameter, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN} K9}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}

	To sort the entries into a tracking category by parameter with a preview error message, use:		To sort the entries into a tracking category by parameter with a preview error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\| {{\|argN}}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN}}

	For an explicit red message, use:		For an explicit red error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|..\|argN}}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}

	To use Lua patterns, use:		To use Lua patterns, use:
Line 31:		Line 32:
	* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.		* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.
	* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.		* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
	* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-7]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.		* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
	* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.		* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
	* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.		* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.

2001:D08:1391:1BDF:6226:D3B1:EBFC:9742 at 14:12, 15 February 2025

2025-02-15T14:12:38Z

← Previous revision		Revision as of 14:12, 15 February 2025
Line 2:		Line 2:
	{{Module rating\|p}}		{{Module rating\|p}}
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}
	{{Lua\|Module:If preview\|noprotcat=~~yes~~}}		{{Lua\|Module:If preview\|noprotcat=No}}

	'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.		'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module

	== Usage ==		== Usage ==
	=== From a template ===
	To sort entries into a tracking category by parameter, use:		To sort entries into a tracking category by parameter, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN} K9}

	To sort the entries into a tracking category by parameter with a preview error message, use:		To sort the entries into a tracking category by parameter with a preview error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|~~...~~\|argN}}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\| {{\|argN}}

	For an explicit red ~~error~~ message, use:		For an explicit red message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}		* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|..\|argN}}

	To use Lua patterns, use:		To use Lua patterns, use:
Line 32:		Line 31:
	* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.		* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.
	* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.		* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
	* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.		* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-7]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
	* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.		* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
	* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.		* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.

Gonnym: Undid revision 1264223588 by 188.236.228.176 (talk)

2024-12-21T14:55:00Z

Undid revision 1264223588 by 188.236.228.176 (talk)

← Previous revision		Revision as of 14:55, 21 December 2024
Line 1:		Line 1:
			{{Used in system}}
	#update
			{{Module rating\|p}}
			{{cascade-protected template\|page=module}}
			{{Lua\|Module:If preview\|noprotcat=yes}}

			'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

			== Usage ==
			=== From a template ===
			To sort entries into a tracking category by parameter, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}

			To sort the entries into a tracking category by parameter with a preview error message, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN}}

			For an explicit red error message, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}

			To use Lua patterns, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN\|regexp1{{=}}header[%d]+\|regexp2{{=}}date[1-9]}}

			===From a module===
			To call from a module, use:
			<syntaxhighlight lang="lua">
			local checkForUnknownParameters = require("Module:Check for unknown parameters")
			local result = checkForUnknownParameters._check(validArgs, args)
			</syntaxhighlight>

			Where the first set of args are the module args below and the second set of args are the parameters that are checked.

			== Parameters ==
			* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.
			* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
			* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
			* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
			* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.
			* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.
			* {{para\|ignoreblank\|1}} – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted {{Para\|foo\|x}} and {{Para\|foo}} are reported. To only track non-blank parameters use {{para\|ignoreblank\|1}}.
			* {{para\|showblankpositional\|1}} – by default, the module ignores blank positional parameters. That is, an unlisted {{para\|2}} is ignored. To {{em\|include}} blank positional parameters in the tracking use {{para\|showblankpositional\|1}}.

			== Example ==
			<syntaxhighlight lang="wikitext">
			{{Infobox
			\| above = {{{name\|}}}

			\| label1 = Height
			\| data1 = {{{height\|}}}

			\| label2 = Weight
			\| data2 = {{{weight\|}}}

			\| label3 = Website
			\| data3 = {{{website\|}}}
			}}<!--
			end infobox, start tracking
			-->{{#invoke:Check for unknown parameters\|check
			\| unknown = {{Main other\|[[Category:Some tracking category\|_VALUE_]]}}
			\| preview = unknown parameter "_VALUE_" \| height \| name \| website \| weight
			}}
			</syntaxhighlight>

			==Call from within Lua code==
			See the end of [[Module:Rugby box]] for a simple example or [[Module:Infobox3cols]] or [[Module:Flag]] for more complicated examples.

			==See also==
			* {{Clc\|Unknown parameters}} (category page can have header {{tl\|Unknown parameters category}})
			* [[Module:Params]] – for complex operations involving parameters
			* [[Template:Checks for unknown parameters]] – adds documentation to templates using this module
			* [[Module:Check for deprecated parameters]] – similar module that checks for deprecated parameters
			* [[Module:Check for clobbered parameters]] – module that checks for conflicting parameters
			* [[Module:TemplatePar]] – similar function (originally from dewiki)
			* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template
			* [[Project:TemplateData]] based template parameter validation
			* [[Module:Parameter validation]] checks a lot more
			* [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters

			<includeonly>{{Sandbox other\|\|
			<!-- Categories go here and interwikis go in Wikidata. -->
			[[Category:Modules that add a tracking category]]
			[[Category:Template metamodules]]
			}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

188.236.228.176: Fixed typo by wiki administrator

2024-12-21T03:33:55Z

Fixed typo by wiki administrator

← Previous revision		Revision as of 03:33, 21 December 2024
Line 1:		Line 1:
			#update
	{{Used in system}}
	{{Module rating\|p}}
	{{cascade-protected template\|page=module}}
	{{Lua\|Module:If preview\|noprotcat=yes}}

	'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

	== Usage ==
	=== From a template ===
	To sort entries into a tracking category by parameter, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}

	To sort the entries into a tracking category by parameter with a preview error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN}}

	For an explicit red error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}

	To use Lua patterns, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN\|regexp1{{=}}header[%d]+\|regexp2{{=}}date[1-9]}}

	===From a module===
	To call from a module, use:
	<syntaxhighlight lang="lua">
	local checkForUnknownParameters = require("Module:Check for unknown parameters")
	local result = checkForUnknownParameters._check(validArgs, args)
	</syntaxhighlight>

	Where the first set of args are the module args below and the second set of args are the parameters that are checked.

	== Parameters ==
	* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.
	* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
	* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
	* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
	* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.
	* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.
	* {{para\|ignoreblank\|1}} – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted {{Para\|foo\|x}} and {{Para\|foo}} are reported. To only track non-blank parameters use {{para\|ignoreblank\|1}}.
	* {{para\|showblankpositional\|1}} – by default, the module ignores blank positional parameters. That is, an unlisted {{para\|2}} is ignored. To {{em\|include}} blank positional parameters in the tracking use {{para\|showblankpositional\|1}}.

	== Example ==
	<syntaxhighlight lang="wikitext">
	{{Infobox
	\| above = {{{name\|}}}

	\| label1 = Height
	\| data1 = {{{height\|}}}

	\| label2 = Weight
	\| data2 = {{{weight\|}}}

	\| label3 = Website
	\| data3 = {{{website\|}}}
	}}<!--
	end infobox, start tracking
	-->{{#invoke:Check for unknown parameters\|check
	\| unknown = {{Main other\|[[Category:Some tracking category\|_VALUE_]]}}
	\| preview = unknown parameter "_VALUE_" \| height \| name \| website \| weight
	}}
	</syntaxhighlight>

	==Call from within Lua code==
	See the end of [[Module:Rugby box]] for a simple example or [[Module:Infobox3cols]] or [[Module:Flag]] for more complicated examples.

	==See also==
	* {{Clc\|Unknown parameters}} (category page can have header {{tl\|Unknown parameters category}})
	* [[Module:Params]] – for complex operations involving parameters
	* [[Template:Checks for unknown parameters]] – adds documentation to templates using this module
	* [[Module:Check for deprecated parameters]] – similar module that checks for deprecated parameters
	* [[Module:Check for clobbered parameters]] – module that checks for conflicting parameters
	* [[Module:TemplatePar]] – similar function (originally from dewiki)
	* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template
	* [[Project:TemplateData]] based template parameter validation
	* [[Module:Parameter validation]] checks a lot more
	* [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters

	<includeonly>{{Sandbox other\|\|
	<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Modules that add a tracking category]]
	[[Category:Template metamodules]]
	}}</includeonly>
	<noinclude>
	[[Category:Module documentation pages]]
	</noinclude>

Shonebrooks: /* Parameters */ I corrected the spelling of "unknown." WP:TYPO

2024-12-12T20:15:21Z

Parameters: I corrected the spelling of "unknown." WP:TYPO

← Previous revision		Revision as of 20:15, 12 December 2024
Line 33:		Line 33:
	* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.		* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
	* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.		* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
	* {{para\|unknown}} – what happens when an ~~uknown~~ parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.		* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
	* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.		* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.
	* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.		* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.

Discospinster: Reverted edits by 109.177.178.255 (talk) (HG) (3.4.12)

2024-11-11T18:54:04Z

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

← Previous revision		Revision as of 18:54, 11 November 2024
Line 1:		Line 1:
			{{Used in system}}
			{{Module rating\|p}}
			{{cascade-protected template\|page=module}}
			{{Lua\|Module:If preview\|noprotcat=yes}}

			'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

			== Usage ==
			=== From a template ===
			To sort entries into a tracking category by parameter, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}

			To sort the entries into a tracking category by parameter with a preview error message, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN}}

			For an explicit red error message, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}

			To use Lua patterns, use:
			* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN\|regexp1{{=}}header[%d]+\|regexp2{{=}}date[1-9]}}

			===From a module===
			To call from a module, use:
			<syntaxhighlight lang="lua">
			local checkForUnknownParameters = require("Module:Check for unknown parameters")
			local result = checkForUnknownParameters._check(validArgs, args)
			</syntaxhighlight>

			Where the first set of args are the module args below and the second set of args are the parameters that are checked.

	== Parameters ==		== Parameters ==
	* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.		* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.

109.177.178.255 at 18:47, 11 November 2024

2024-11-11T18:47:10Z

← Previous revision		Revision as of 18:47, 11 November 2024
Line 1:		Line 1:
	{{Used in system}}
	{{Module rating\|p}}
	{{cascade-protected template\|page=module}}
	{{Lua\|Module:If preview\|noprotcat=yes}}

	'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

	== Parameters ==		== Parameters ==
	* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.		* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.

109.177.178.255 at 18:46, 11 November 2024

2024-11-11T18:46:50Z

← Previous revision		Revision as of 18:46, 11 November 2024
Line 5:		Line 5:

	'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.		'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.

	== Usage ==
	=== From a template ===
	To sort entries into a tracking category by parameter, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|arg1\|arg2\|arg3\|argN}}

	To sort the entries into a tracking category by parameter with a preview error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN}}

	For an explicit red error message, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>\|arg1\|arg2\|...\|argN}}

	To use Lua patterns, use:
	* {{mlx\|Check for unknown parameters\|check\|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category\|_VALUE_]]\|preview{{=}}unknown parameter "_VALUE_"\|arg1\|arg2\|...\|argN\|regexp1{{=}}header[%d]+\|regexp2{{=}}date[1-9]}}

	===From a module===
	To call from a module, use:
	<syntaxhighlight lang="lua">
	local checkForUnknownParameters = require("Module:Check for unknown parameters")
	local result = checkForUnknownParameters._check(validArgs, args)
	</syntaxhighlight>

	Where the first set of args are the module args below and the second set of args are the parameters that are checked.

	== Parameters ==		== Parameters ==

64.114 etc at 02:22, 19 October 2024

2024-10-19T02:22:22Z

← Previous revision		Revision as of 02:22, 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:If preview\|noprotcat=yes}}		{{Lua\|Module:If preview\|noprotcat=yes}}

BrandonXLF: Add Category:Template metamodules

2024-09-01T22:20:51Z

Add Category:Template metamodules

← Previous revision		Revision as of 22:20, 1 September 2024
Line 77:		Line 77:
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Modules that add a tracking category]]		[[Category:Modules that add a tracking category]]
			[[Category:Template metamodules]]

	}}</includeonly>		}}</includeonly>
	<noinclude>		<noinclude>

← Previous revision		Revision as of 20:15, 12 December 2024
Line 33:		Line 33:
	* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.		* Unnamed (positional) parameters can be added too: <code>\|1\|2\|arg1\|arg2\|...</code>.
	* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.		* [[:mw:Extension:Scribunto/Lua reference manual#Patterns\|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para\|regexp1\|header[%d]+}}, {{para\|regexp2\|date[1-9]}}, {{para\|regexp3\|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
	* {{para\|unknown}} – what happens when an ~~uknown~~ parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.		* {{para\|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
	* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.		* {{para\|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.
	* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.		* The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.