Module:Check for unknown parameters

    From Consumerium development wiki R&D Wiki
    Revision as of 14:41, 23 June 2016 by w>Frietjes
    (diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

    This module may be appended to a template to check for uses of unknown parameters.

    Usage

    Basic usage

    {{#invoke:check for unknown parameters|check
    |unknown=[[Category:Some tracking category]]
    |arg1|arg2|...|argN}}
    

    or to sort the entries in the tracking category by parameter with a preview error message

    {{#invoke:check for unknown parameters|check
    |unknown=[[Category:Some tracking category|_VALUE_]]
    |preview=unknown parameter "_VALUE_"
    |arg1|arg2|...|argN}}
    

    or for an explicit red error message

    {{#invoke:check for unknown parameters|check
    |unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
    |arg1|arg2|...|argN}}
    

    Here, arg1, arg2, ..., argN, are the known parameters. Unnamed (positional) parameters can be added too: |1|2|argname1|argname2|.... Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the unknown parameter. The _VALUE_ keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.

    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.

    By default, the module ignores blank positional parameters. That is, an unlisted |2= is ignored. To include blank positional parameters in the tracking use |showblankpositional=1.

    Lua patterns

    This module supports Lua patterns (similar to regular expressions), which are useful when there are many known parameters which use a systematic pattern. For example, template:infobox3cols uses

    | regexp1 = header[%d][%d]*
    | regexp2 = label[%d][%d]*
    | regexp3 = data[%d][%d]*[abc]?
    | regexp4 = class[%d][%d]*[abc]?
    | regexp5 = rowclass[%d][%d]*
    | regexp6 = rowstyle[%d][%d]*
    | regexp7 = rowcellstyle[%d][%d]*
    

    to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.

    Example

    {{Infobox
    | above = {{{name|}}}
    
    | label1 = Height
    | data1 = {{{height|}}}
    
    | label2 = Weight
    | data2 = {{{weight|}}}
    
    | label3 = Website
    | data3 = {{{website|}}}
    }}<!-- 
      end infobox, start tracking
    -->{{#invoke:Check for unknown parameters|check
    | unknown = {{main other|[[Category:Some tracking category|_VALUE_]]}}
    | preview = unknown parameter "_VALUE_"
    | name
    | height | weight
    | website
    }}
    

    Templates invoking this module

    The following is a list of some of the templates which invoke this module, with the associated category for each.

    For a more up-to-date list, search for the "check for unknown parameters" within the template namespace.

    See also

    • Category:Unknown parameters (0) (category page can have {{Unknown parameters category}})
    • module:TemplatePar - similar function (originally from dewiki)
    • Template:Parameters and Module:Parameters – generates a list of parameter names for a given template
    • he:Module:ParamValidator - parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:
      • use of undeclared parameters
      • use of parameters marked in templatedata "deprecated"
      • mistyped (mainly, parameters declared in templatedata as "number" receiving non-numerical value)
      • missing parameters marked in TemplateData as "required"
      • understands aliases, and warns when more than one alias of a parameter is used



    -- 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
    -- not on the list
    local p = {}
    
    local function trim(s)
    	return s:match('^%s*(.-)%s*$')
    end
    
    local function isnotempty(s)
    	return s and trim(s) ~= ''
    end
    
    function p.check (frame)
    	local args = frame.args
    	local pargs = frame:getParent().args
    	local ignoreblank = isnotempty(frame.args['ignoreblank'])
    	local showblankpos = isnotempty(frame.args['showblankpositional'])
    	local knownargs = {}
    	local unknown = frame.args['unknown'] or 'Found _VALUE_, '
    	local preview = frame.args['preview']
    
    	local values = {}
    	local res = {}
    	local regexps = {}
    
    	-- create the list of known args, regular expressions, and the return string
    	for k, v in pairs(args) do
    		if type(k) == 'number' then
    			v = trim(v)
    			knownargs[v] = 1
    		elseif k:find('^regexp[1-9][0-9]*$') then
    			table.insert(regexps, '^' .. v .. '$')
    		end
    	end
    	if isnotempty(preview) then 
    		preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
    	elseif preview == nil then
    		preview = unknown
    	end
    
    	-- loop over the parent args, and make sure they are on the list
    	for k, v in pairs(pargs) do
    		if type(k) == 'string' and knownargs[k] == nil then
    			local knownflag = false
    			for i, regexp in ipairs(regexps) do
    				if mw.ustring.match(k, regexp) then
    					knownflag = true
    					break
    				end
    			end
    			if not knownflag and ( not ignoreblank or isnotempty(v) )  then
    				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
    				table.insert(values, k)
    			end
    		elseif type(k) == 'number' and 
    			knownargs[tostring(k)] == nil and
    			( showblankpos or isnotempty(v) )
    		then
    			local vlen = mw.ustring.len(v)
    			v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25) 
    			v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
    			table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
    		end
    	end
    
    	-- add resuls to the output tables
    	if #values > 0 then
    		if frame:preprocess( "{{REVISIONID}}" ) == "" then
    			unknown = preview
    		end
    		for k, v in pairs(values) do
    			if v == '' then
    			-- Fix odd bug for | = which gets stripped to the empty string and
    			-- breaks category links
    			v = ' '
    			end
    			local r =  unknown:gsub('_VALUE_', v)
    			table.insert(res, r)
    		end
    	end
    
    	return table.concat(res)
    end
    
    return p