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 module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This Lua module is used on approximately 326,000 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.
For testing, see the output of the test cases. You should view that both normally and in preview mode to fully test the module.
Usage
[edit]{{#invoke:Check for deprecated parameters|check
| _category = {{main other|[[Category:Pages using TEMPLATENAME with deprecated parameters|_VALUE_]]}}
| _remove = RemoveParam1; RemoveParam2
| old_param1 = new_param1
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}
Parameters
[edit]|_category=- what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use deprecated parameters, or an error.|_remove=- a;separated list of parameters that should simply be removed from the template, not replaced with another. For example:|_remove=Param1; Param2; Param3|ignoreblank=– by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted|foo=xand|foo=are reported. To only track non-blank parameters use|ignoreblank=1. If you clean your arguments with Module:Arguments and call this module afterwards, you need not use this parameter as that module ignores blank arguments by default.|preview=– set a custom preview warning message. Note the default is Page using LINKED_TEMPLATE_NAME with deprecated parameter _VALUE_|_regexp#=- set regular expressions to deprecate and replace with a corresponding regular expression.
Regex example
[edit]The following code will look for any supplied parameter of the format suc-type# and indicate that it should be replace with suc_type#. So for example, you will get suc-type4 needing to replaced with suc_type4.
{{#invoke:Check for deprecated parameters|check
| _regexp1 = (suc)%-(type%d?) = %1_%2
| _regexp2 =
| _regexp3 =
...
}}
See also
[edit]- Template:Deprecated parameters category
- Category:Deprecated parameters
- Module:Check for unknown parameters
- Module:Check for conflicting parameters – module that checks for conflicting parameters