Modulo:Controllo parametri sconosciuti

Istruzioni per l'uso
Questo è un modulo scritto in Lua. Le istruzioni che seguono sono contenute nella sottopagina Modulo:Controllo parametri sconosciuti/man (modifica · cronologia)
Sandbox: Modulo:Controllo parametri sconosciuti/sandbox (modifica · cronologia) · Sottopagine: lista · Test: Modulo:Controllo parametri sconosciuti/test (modifica · cronologia · Esegui)

Modulo per controllare se un template è utilizzato con parametri sconosciuti. Va usato nel template, specificando la lista dei nomi dei parametri validi e il testo da restituire in caso di errore, come un messaggio o una categoria di servizio.

Sintassi

{{#invoke:Controllo parametri sconosciuti|check|sconosciuto=...|elenco parametri validi}}

Parametri:

• sconosciuto = serve per definire il testo da restituire ogni volta che viene trovato un parametro sconosciuto. Può essere per esempio un messaggio di errore o una categoria, oppure entrambe le cose. Ha come valore predefinito "Trovato _VALUE_, " (dove _VALUE_ è un segnaposto che verrà sostituito col nome del parametro sconosciuto).
• ignoravuoti = se valorizzato con qualunque valore, per esempio 1, il controllo non viene effettuato sui parametri senza valore.
• controlloposizionali = se valorizzato con qualunque valore, per esempio 1, il controllo viene effettuato anche sui parametri posizionali.
• ns = quando il parametro "sconosciuto" restituisce una categoria, la categorizzazione è di default esclusa da tutti i namespace di discussione e da quello Utente; con questo parametro è invece possibile attivarla per il namespace specificato (qualunque esso sia) e circoscriverla unicamente a esso. Vengono accettati come valori solamente i numeri dei namespace, non i loro nomi per esteso.

Esempi

Gli esempi si riferiscono a un ipotetico template di nome Prova, che accetta solo tre parametri: Nome, Immagine e Anno. Il codice seguente andrebbe inserito all'interno del template Prova, preferibilmente al fondo.

1. Categorizza ogni voce che usa il template Prova e utilizza un parametro diverso da Nome, Immagine o Anno nella categoria "Voci con template Prova con parametri sconosciuti":

   {{#invoke:Controllo parametri sconosciuti|check|sconosciuto=[[Categoria:Voci con template Prova con parametri sconosciuti]]|Nome|Immagine|Anno}}

2. Visualizza il messaggio di errore "Errore il parametro ... è sconosciuto" in ogni voce che usa il template Prova e utilizza un parametro diverso da Nome, Immagine o Anno:

   {{#invoke:Controllo parametri sconosciuti|check|sconosciuto=<span class="error">Errore: il parametro _VALUE_ è sconosciuto</span>|Nome|Immagine|Anno}}

---

--[[
* Modulo per controllare se un template è utilizzato con parametri sconosciuti.
* Va usato nel template, specificando la lista dei nomi dei parametri validi e 
* il testo da ritornare in caso di errore, come un messaggio o una categoria di servizio.
*
* Il modulo è stato importato da:
* http://en.wikipedia.org/w/index.php?title=Module:Check_for_unknown_parameters&oldid=669492475
]]--

local p = {}

local function isnotempty(s)
	return s and s:match( '^%s*(.-)%s*$' ) ~= ''
end

function p.check (frame)
	local args = frame.args
	local pargs = frame:getParent().args
	local ignoreblank = isnotempty(frame.args['ignoravuoti'])
	local checkpos = isnotempty(frame.args['controlloposizionali'])
	local knownargs = {}
	local unknown = 'Trovato _VALUE_, '

	local res = {}
	local regexps = {}
	local comments = {}
	local commentstr = ''

	-- è abilitato in tutti i namespace non di discussione e non utente,
	-- oppure solo in quello definito nel parametro "ns"
	local ns = mw.title.getCurrentTitle().namespace
	if args.ns then
		if ns ~= tonumber(args.ns) then
			return ''
		end
	elseif ns == 2 or (ns % 2 == 1) then
		return ''
	end

	-- 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 = mw.ustring.gsub(v, '^%s*(.-)%s*$', '%1')
			knownargs[v] = 1
		else
			if (k == 'sconosciuto' and type(v) == 'string') then
				unknown = v
			elseif (mw.ustring.match(k, '^regexp[%d]*$') and type(v) == 'string') then
				table.insert(regexps, '^' .. v .. '$')
			end
		end
	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 = nil
			for r = 1,#regexps do
				if ( mw.ustring.match(k,regexps[r]) ) then
					knownflag = 1
				end
			end
			if ( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then
				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
				local r = mw.ustring.gsub(unknown, '_VALUE_', k)
				table.insert(res, r)
				table.insert(comments, '"' .. k .. '"')
			end
		elseif (checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then
			if ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then
				local r = mw.ustring.gsub(unknown, '_VALUE_', k)
				table.insert(res, r)
				table.insert(comments, '"' .. k .. '"')
			end
		end
	end

	if (#comments > 0) then
		commentstr = '<!-- Modulo:Controllo parametri sconosciuti: ' ..
			table.concat(comments, ', ') .. '-->'
	end
	
	return table.concat(res) .. commentstr
end

return p