Open main menu
Home
Random
Donate
Recent changes
Special pages
Community portal
Preferences
About Stockhub
Disclaimers
Search
User menu
Talk
Contributions
Create account
Log in
Editing
Module:Parameter validation/doc
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{Lua|Module:If preview}} This module helps you find problematic usages of a template's parameters. Compared to [[Module:Check for unknown parameters]], you do not need to create long lists of parameters which should be categorised; it will automatically read them from the template's TemplateData. This means you don't need to define the parameter configuration in multiple places, which will inevitably lead to it being out of sync. As well as that, it supports a few other types of errors, such as defining the same parameter multiple times, or using deprecated parameters (useful to do so you can replace usages before removing support for a parameter entirely). == Basic usage == Add this to the bottom of a template: <syntaxhighlight> {{#invoke:Parameter validation|validateparams|module_options = Module:Parameter validation/default config}} </syntaxhighlight> This will use the default config defined in [[Module:Parameter validation/default config]]. The module will begin to populate the following categories: * [[:Category:Pages using TEMPLATE_NAME with unknown parameters]] * [[:Category:Pages using TEMPLATE_NAME with deprecated parameters]] * [[:Category:Pages using TEMPLATE_NAME with duplicate parameters]] For example, for {{t|Infobox station}}, it will populate: * [[:Category:Pages using infobox station with unknown parameters]] * [[:Category:Pages using infobox station with deprecated parameters]] * [[:Category:Pages using infobox station with duplicate parameters]] Note that: * Unknown parameters means a page calling the template used a parameter that does not exist * Deprecated parameters means a page calling the template used a parameter which, in the template's TemplateData, has the 'deprecated' option ticked * Duplicate parameters means a page calling the template set a value for the same parameter multiple times == Full documentation == This module is based on idea and original code of [[User:IKhitron]]. The source of this module, along with the original documentation, can be found at [[:he:Module:ParamValidator]].
Summary:
Please note that all contributions to Stockhub may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Stockhub:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Lua
(
edit
)
Template:T
(
edit
)