Module:Params/doc/examples/check for unknown parameters: Difference between revisions
From Kenshi Wiki
More actions
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
|{{Error|Error: The only parameters accepted are {{para|hello}} and {{para|wind}}.}} | |{{Error|Error: The only parameters accepted are {{para|hello}} and {{para|wind}}.}} | ||
|Everything is good: do something | |Everything is good: do something | ||
}}</includeonly><noinclude>{{Documentation|heading=[[File:Test Template Info-Icon - Version (2).svg|50px|alt=|link=]] Template documentation}}</noinclude> | }}</includeonly><noinclude>{{Documentation|heading=[[File:Test Template Info-Icon - Version (2).svg|50px|alt=|link=]] Template documentation}} | ||
[[Category:Module data pages]] | |||
</noinclude> | |||
Latest revision as of 23:57, 14 March 2025
This example template shows to use {{#invoke:params|discarding|...}} to check for unknown parameters.
Usage
For instance, writing
{{module:params/doc/examples/check for unknown parameters
| hello = world
| wind = surfing
}}will generate
- Everything is good: do something
while writing
{{module:params/doc/examples/check for unknown parameters
| hello = world
| wind = surfing
| wrong = ups!
}}will generate
- Error: The only parameters accepted are
|hello=and|wind=.
For simple cases like this specialized modules are available; you might want to have a look at:
- {{#invoke:Check for unknown parameters|check}}
- {{#invoke:Check for deprecated parameters|check}}
- {{#invoke:Check for clobbered parameters|check}}
- {{#invoke:Parameter validation|validateparams}}
- {{#invoke:TemplatePar|valid}}