Módulo:Check for unknown parameters

Na Galipedia, a Wikipedia en galego.
Indicacións de uso do módulo

Obxectivo[editar a fonte]

Módulo a incluír en modelos para realizar comprobacións de usos de parámetros descoñecidos.

Uso[editar a fonte]

{{#invoke:check for unknown parameters|check
|unknown=[[Categoría:Unha categoría de seguemento]]

Para ordenar as entradas na categoría de seguemento por un parámetro, cun erro na vista previa:

{{#invoke:check for unknown parameters|check
|unknown=[[Categoría:Unha categoría de seguemento|_VALOR_]]
|preview=Parámetro descoñecido: "_VALOR_"

Para amosar unha mensaxe de erro explícita

{{#invoke:check for unknown parameters|check
|unknown=<span class="error">Non se recoñece _VALOR_</span>

Por defecto o módulo non distingue entre parámetros definidos en branco e parámetros non en branco. Para revisar só parámetros non en branco: |ignoreblank=1.

Por defecto o módulo ignora parámetros posicionais en branco. Para incluír estes parámetros no seguemento: |showblankpositional=1.

Exemplo[editar a fonte]

| 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|[[Categoría:Unha categoría de seguemento|_VALOR_]]}}
| preview = Parámetro descoñecido: "_VALOR_"
| name
| height | weight
| website
Esta documentación está transcluída desde Módulo:Check for unknown parameters/uso. Os editores poden probar cambios no mesmo en Módulo:Check for unknown parameters/probas.
Por favor, engade as categorías na subpáxina de documentación e os interwikis no Wikidata. Ver as subpáxinas deste módulo.

-- 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*$')

local function isnotempty(s)
	return s and s:match('%S')

local function clean(text)
	-- Return text cleaned for display and truncated if too long.
	-- Strip markers are replaced with dummy text representing the original wikitext.
	local pos, truncated
	local function truncate(text)
		if truncated then
			return ''
		if mw.ustring.len(text) > 25 then
			truncated = true
			text = mw.ustring.sub(text, 1, 25) .. '...'
		return mw.text.nowiki(text)
	local parts = {}
	for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') do
		pos = remainder
		table.insert(parts, truncate(before) .. '&lt;' .. tag .. '&gt;...&lt;/' .. tag .. '&gt;')
	table.insert(parts, truncate(text:sub(pos or 1)))
	return table.concat(parts)

function p._check(args, pargs)
	if type(args) ~= "table" or type(pargs) ~= "table" then
		-- TODO: error handling

	local ignoreblank = isnotempty(args['ignoreblank'])
	local showblankpos = isnotempty(args['showblankpositional'])
	local knownargs = {}
	local unknown = args['unknown'] or 'Found _VALUE_, '
	local preview = 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 .. '$')
	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

	-- 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 _, regexp in ipairs(regexps) do
				if mw.ustring.match(k, regexp) then
					knownflag = true
			if not knownflag and ( not ignoreblank or isnotempty(v) )  then
				table.insert(values, clean(k))
		elseif type(k) == 'number' and
			knownargs[tostring(k)] == nil and
			( showblankpos or isnotempty(v) )
			table.insert(values, k .. ' = ' .. clean(v))

	-- add results to the output tables
	if #values > 0 then
		if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
			unknown = preview
		for _, v in pairs(values) do
			if v == '' then
				-- Fix odd bug for | = which gets stripped to the empty string and
				-- breaks category links
				v = ' '
			-- avoid error with v = 'example%2' ("invalid capture index")
			local r =  unknown:gsub('_VALUE_', {_VALUE_ = v})
			table.insert(res, r)

	return table.concat(res)

function p.check(frame)
	local args = frame.args
	local pargs = frame:getParent().args
	return p._check(args, pargs)

return p