Modul:Tjek for ukendte parametre

Moduldokumentation

Dette modul kan indsættes i skabelonkoden for at tjekke om ukendte parametre bliver anvendt blandt de sider, der benytter skabelonen.

Brug

{{#invoke:Tjek for ukendte parametre|check|unknown=[[Kategori:Navn på ønsket sporingskategori|_VALUE_|ignoreblank=ja]]|arg1|arg2|...|argN}}

Her er arg1, arg2, ..., argN de kendte parametre. Enhver parameter der er brugt, men ikke befinder sig i denne liste, vil få modulet til at tilføje siden til den angivne sporingskategori. Værdien _VALUE_ vil blive erstattet med navnet på den ukendte parameter. Dette er praktisk, fordi det vil sortere siderne i kategorien baseret på den ukendte parameters navn. På den måde kan man nemmere finde frem til den ukendte parametre, fordi man kender parameterens begyndelsesbogstav.

Som regel ønsker man ikke at medtage ukendte parametre som er blanke (uden værdi). Dette kan undgås ved at tilføje parameteren |ignoreblank=ja. Man kan også udfylde parameteren |unknown= med mere information som vist i eksemplet neden for.

Eksempel

Eksempel med skabelonkode med kun fire parametre

{{Infoboks | above = {{{navn|}}}| label1 = Højde| data1 = {{{height|}}}| label2 = Vægt| data2 = {{{vægt|}}}| label3 = Hjemmeside| data3 = {{{website|}}}}}<!--   slut på selve skabelonen-->{{#invoke:Tjek for ukendte parametre|check| unknown = <span class=error> Ukendt parameter i [[Skabelon:skabelonnavn]]: _VALUE_</span>[[Kategori:Navn på ønsket sporingskategori|_VALUE_]]| ignoreblank = ja| navn | højde| vægt | website }}

Et tip

Hvis skabelonen indeholder mange kendte parametre, kan det være upraktisk at skulle skrive deres navne ind manuelt. I stedet kan man skaffe en liste over parametrene ved at vælge knappen Manage TemplateData, der kommer frem øverst på siden når man i skabelonen klikker på "Rediger wikikode". Listen kommer frem når man trykker "Add xxx suggested parameters". Når listen er kopieret til et tekstdokument, siger man "Cancel", så Templatedata ikke gemmes. I tekstdokumentet erstatter man samtlige kommaer med |, inden listen kopieres ind i skabelonkoden på det rigtige sted forklaret oven for.

Skabeloner der bruger dette modul

Et par af de skabeloner der i øjeblikket anvender modulet:

Skabeloner der anvender "Modul:Tjek for ukendte parametre"
Skabelon	Sporingskategori
{{Infoboks Wikidata person}}	Kategori:Sider med ukendte parametre i Infoboks Wikidata person ( 127 )
{{Infoboks skuespiller}}	Kategori:Sider med ukendte parametre i Infoboks skuespiller ( 48 )

Se også

-- 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>Advarsel:</strong> ' .. preview .. ' (denne besked vises kun i forhåndsvisning).</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

Search