Module:Check for deprecated parameters
.svg/60px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This Lua module is used on approximately 819,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
{{#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
- 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
-- This module may be used to compare the arguments passed to the parent-- with a list of arguments, returning a specified result if an argument is-- on the listlocalp={}localfunctiontrim(s)returns:match('^%s*(.-)%s*$')endlocalfunctionisnotempty(s)returnsandtrim(s)~=''endfunctionp.check(frame)-- create the table of deprecated values and their matching new valuelocalargs=frame.argslocaldep_values={}fork,vinpairs(args)doifk=='ignoreblank'ork=='preview'ork=='deprecated'thenelsedep_values[k]=vendend-- loop over the parent args and see if any are deprecatedlocalvalues={}localignoreblank=isnotempty(frame.args['ignoreblank'])localpargs=frame:getParent().argsfork,vinpairs(pargs)doifignoreblankthenifdep_values[k]andv~=''thentable.insert(values,k)endelseifdep_values[k]thentable.insert(values,k)endendend-- add results to the output tableslocalres={}if#values>0thenlocalpreview=frame.args['preview']or'Page using [['..frame:getParent():getTitle()..']] with deprecated parameter _VALUE_'ifisnotempty(preview)thenpreview=require('Module:If preview')._warning({preview})end-- Kind of dangerous to trust that this is never nil, but I guess it's-- preferable to display that the use of the module is broken rather than-- have some sort of tracking category for pages which have an unknown-- parent tracking template.localcategory=frame.args['category']fork,vinpairs(values)dolocalc=category:gsub('_VALUE_',v)table.insert(res,c)ifv==''then-- Fix odd bug for | = which gets stripped to the empty string-- and breaks category linksv=' 'endlocalp=preview:gsub('_VALUE_','"'..v..'". Replace with "'..dep_values[v]..'".')table.insert(res,p)endendreturntable.concat(res)endreturnp