Module:checkparams/documentation

Hello, you have come here looking for the meaning of the word Module:checkparams/documentation. In DICTIOUS you will not only get to know all the dictionary meanings for the word Module:checkparams/documentation, but we will also tell you about its etymology, its characteristics and you will know how to say Module:checkparams/documentation in singular and plural. Everything you need to know about the word Module:checkparams/documentation you have here. The definition of the word Module:checkparams/documentation will help you to be more precise and correct when speaking or writing your texts. Knowing the definition ofModule:checkparams/documentation, as well as those of other words, enriches your vocabulary and provides you with more and better linguistic resources.

Information for editors

If you encounter a warning stating that "The template does not use the parameter(s)" while editing a page, the error is generated by this module. The module detects all parameters used by a template and issues a warning when a template is called with an unexpected parameter. In many cases, the error might be generated by a typo in the parameter name (eg, "pge" instead of "page") and can simply be corrected by consulting the template's documentation.

If you're absolutely certain that a template should allow the parameter even though it's not going to actually use the parameter, you can override the automatic parameter detection by adding | plus a comma separated list of additional parameters that should be accepted to the {{#invoke:checkparams|warn}} or the {{#invoke:checkparams|error}} line at the top of the template.

For example, to allow parameters "3" and "comment" in the following template

{{#invoke:checkparams|warn}}<!-- Validate template parameters
-->Written by {{{1}}} and {{{2}}} in {{{year}}}

change it to:

{{#invoke:checkparams|warn|3,comment}}<!-- Validate template parameters
The parameters '3' and 'comment' are not used, but are explicitly allowed because ....
-->Written by {{{1}}} and {{{2}}} in {{{year}}}

Developer information

This module generates warnings when passing invalid parameters to a template. It adds a user-visible warning to the preview, an {{attention}} warning to the page, and categorizes the page into ].

Parameters

|1=
A comma separated list of additional allowed parameters, in addition to those automatically detected by the module.
|nocat= (optional)
Suppress categorization.