Jump to content
Wikipedia The Free Encyclopedia

Module:Check for deprecated parameters

From Wikipedia, the free encyclopedia
Module documentation[view] [edit] [history] [purge]
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.
Page template-protected This module is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.
Warning This Lua module is used on approximately 673,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 = {{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

  • |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=x and |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_

See also

The above documentation is transcluded from Module:Check for deprecated parameters/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

 -- 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 list
 localp={}

 localfunctiontrim(s)
 returns:match('^%s*(.-)%s*$')
 end

 localfunctionisnotempty(s)
 returnsandtrim(s)~=''
 end

 functionp.check(frame)
 -- create the table of deprecated values and their matching new value
 localargs=frame.args
 localdep_values={}
 fork,vinpairs(args)do
 ifk=='ignoreblank'ork=='preview'ork=='deprecated'thenelse
 dep_values[k]=v
 end
 end

 -- Parse params to remove
 localremoves={}
 ifframe.args['_remove']then
 forrinframe.args['_remove']:gmatch("([^;]+)")do
 r=mw.ustring.gsub(r,'^%s*','')
 r=mw.ustring.gsub(r,'%s*$','')
 removes[r]=1
 end
 end

 -- loop over the parent args and see if any are deprecated
 localvalues={}
 localremove_values={}
 localignoreblank=isnotempty(frame.args['ignoreblank'])
 localpargs=frame:getParent().args
 fork,vinpairs(pargs)do
 ifignoreblankthen
 ifdep_values[k]andv~=''then
 table.insert(values,k)
 elseifremoves[k]andv~=''then
 table.insert(remove_values,k)
 end
 else
 ifdep_values[k]then
 table.insert(values,k)
 elseifremoves[k]then
 table.insert(remove_values,k)
 end
 end
 end

 -- add results to the output tables
 localres={}
 if#values>0then
 localpreview=frame.args['preview']or
 'Page using [['..frame:getParent():getTitle()..']] with deprecated parameter _VALUE_'
 ifisnotempty(preview)then
 preview=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)do
 localc=category:gsub('_VALUE_',v)
 table.insert(res,c)
 ifv==''then
 -- Fix odd bug for | = which gets stripped to the empty string
 -- and breaks category links
 v=' '
 end
 localp=preview:gsub(
 '_VALUE_',
 '"'..v..'". Replace with "'..dep_values[v]..'".'
 )
 table.insert(res,p)
 end
 end

 if#remove_values>0then
 localpreview=frame.args['preview']or
 'Page using [['..frame:getParent():getTitle()..']] with deprecated parameter _VALUE_'
 ifisnotempty(preview)then
 preview=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(remove_values)do
 localc=category:gsub('_VALUE_',v)
 table.insert(res,c)
 ifv==''then
 -- Fix odd bug for | = which gets stripped to the empty string
 -- and breaks category links
 v=' '
 end
 localp=preview:gsub(
 '_VALUE_',
 '"'..v..'". It should be removed.'
 )
 table.insert(res,p)
 end
 end

 returntable.concat(res)
 end

 returnp

AltStyle によって変換されたページ (->オリジナル) /