Module:Check for deprecated parameters/doc
 | This is a documentation subpage for Module:Check for deprecated parameters. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used on approximately 824,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
Module:Check for deprecated parameters may be appended to a template to check for uses of deprecated parameters. It will place the page in a specific category, and display a preview message, when it finds deprecated parameter uses.
Note: due to the nature of deprecations, this module will often have no templates implementing it.
Usage
[edit]{{#invoke:Check for deprecated parameters|check
| category = [[Category:category_name|_VALUE_]]
| old_param1 = new_param1
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}
By default, this module will flag empty uses of deprecated parameters. To turn this off, set |ignoreblank=yes.
See also
[edit]- Category:Deprecated parameters
- Module:Params – for complex operations involving parameters
- Module:Check for unknown parameters
- Module:Check for clobbered parameters – module that checks for conflicting parameters