Módulo:Check for unknown parameters

[ máis información | ver o historial | purgar | editar as instrucións | ver as instrucións ]

Indicacións de uso do módulo

Obxectivo

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

Uso

{{#invoke:check for unknown parameters|check|unknown=[[Categoría:Unha categoría de seguemento]]|arg1|arg2|...|argN}}

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_"|arg1|arg2|...|argN}}

Para amosar unha mensaxe de erro explícita

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

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

{{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|[[Categoría:Unha categoría de seguemento|_VALOR_]]}}| preview = Parámetro descoñecido: "_VALOR_"| name| height | weight| website}}

[ máis información | ver o historial | purgar | editar as instrucións | ver as instrucións ]

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 listlocal p = {}local function trim(s)return s:match('^%s*(.-)%s*$')endlocal function isnotempty(s)return s and s:match('%S')endlocal 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, truncatedlocal function truncate(text)if truncated thenreturn ''endif mw.ustring.len(text) > 25 thentruncated = truetext = mw.ustring.sub(text, 1, 25) .. '...'endreturn mw.text.nowiki(text)endlocal parts = {}for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') dopos = remaindertable.insert(parts, truncate(before) .. '&lt;' .. tag .. '&gt;...&lt;/' .. tag .. '&gt;')endtable.insert(parts, truncate(text:sub(pos or 1)))return table.concat(parts)endfunction p._check(args, pargs)if type(args) ~= "table" or type(pargs) ~= "table" then-- TODO: error handlingreturnendlocal 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 stringfor k, v in pairs(args) doif type(k) == 'number' thenv = trim(v)knownargs[v] = 1elseif k:find('^regexp[1-9][0-9]*$') thentable.insert(regexps, '^' .. v .. '$')endendif isnotempty(preview) thenpreview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'elseif preview == nil thenpreview = unknownend-- loop over the parent args, and make sure they are on the listfor k, v in pairs(pargs) doif type(k) == 'string' and knownargs[k] == nil thenlocal knownflag = falsefor _, regexp in ipairs(regexps) doif mw.ustring.match(k, regexp) thenknownflag = truebreakendendif not knownflag and ( not ignoreblank or isnotempty(v) )  thentable.insert(values, clean(k))endelseif type(k) == 'number' andknownargs[tostring(k)] == nil and( showblankpos or isnotempty(v) )thentable.insert(values, k .. ' = ' .. clean(v))endend-- add results to the output tablesif #values > 0 thenif mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" thenunknown = previewendfor _, v in pairs(values) doif v == '' then-- Fix odd bug for | = which gets stripped to the empty string and-- breaks category linksv = ' 'end-- avoid error with v = 'example%2' ("invalid capture index")local r =  unknown:gsub('_VALUE_', {_VALUE_ = v})table.insert(res, r)endendreturn table.concat(res)endfunction p.check(frame)local args = frame.argslocal pargs = frame:getParent().argsreturn p._check(args, pargs)endreturn p