Module:Arguments/doc

🛑

Ipgelet: Ôog risico module!

Dit module wordt gebruukt in systeem-berichtn of ip exôct 0 bloadn (da's oungeveer 0% van oalle artikeln). Een anpassienge an dees code kan d'n uutkyk van de gansche wiki direct verandern. Test anpassiengn êest in e zandbak of discuteer d'rover ip 't overlegblad vôoda je ze definitief bywerkt.

Moduleinfo: Arguments

Dit is e Lua-script (meta-module) da 't makkelik makt oem argumentn (parameters) uut #invoke te verwerkn. 't Is gemakt oem te wordn gebruukt deur andere modules, en mag nie direct angereoepn wordn vanuut #invoke. De belangrykste funcsjes zyn:

• Et makkelik wegsnyen (trimming) van spaties en 't verwydern van lege argumentn.
• Argumentn kunn teglykertyd wordn deuregegeevn uut et hudige frame én uut 't oofd-frame (parent frame).
• Argumentn kunn direct wordn deuregegeevn uut een andre Lua-module of uut de debug-console.
• De mêeste funcsjes kunn wordn anepast noa joun eign wensn.

Boasisgebruuk

Êest moe je de module inleezn. 't Bevat êen funcsje, genaamd getArgs.

local getArgs = require('Module:Arguments').getArgs

In 't mêest simpele scenario ku je getArgs in joun oofdfuncsje gebruukn. De variabele args is e tabelle mèi d' argumentn uut #invoke.

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- D'echte code van joun module komt ier.
end

return p

Angeroadn praktyk

D' angeroadn praktyk is oem een aparte funcsje te gebruukn as ingangspunt vanuut #invoke, allêne moa vo 't verwerkn van d' argumentn. Dit lat andere Lua-modules toe oem joun kern-logica direct an te roepn, wuk dat de prestoasjes verbetert omda je 't frame-object nie iddere kêe moe anspreekn.

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- D'echte code van joun module komt ier.
end

return p

De maniere oe da dit wordt angereoepn vanuut e patrôon is {{#invoke:Vôorbeeld|main}} (optioneel mèi parameters lik {{#invoke:Vôorbeeld|main|arg1=woarde1|arg2=woarde2}}). De maniere oem dit an te roepn vanuut e module is require('Module:Vôorbeeld')._main({arg1 = 'woarde1', arg2 = woarde2, 'spaced arg3' = 'woarde3'}). Wuk da die twidde maniere doet, is e tabelle moakn mèi d' argumentn d'rin, en gèeft die tabelle toun an de p._main(args) funcsje.

Mêerdere funcsjes

O je wilt da mêerdere funcsjes d' argumentn gebruukn, en je wilt ôok da ze toegankelik zyn vanuut #invoke, ku je e wrapper-funcsje gebruukn.

local getArgs = require('Module:Arguments').getArgs

local p = {}

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Code vo d' êerste funcsje komt ier.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Code vo de twidde funcsje komt ier.
end

return p

Opsjes

De volgende opsjes zyn beschikboar. Ze wordn uutgelegd in de stikkn ieroender.

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Code vo 't verwerkn van êen argument
	end,

	frameOnly = true,
	parentOnly = true,
	parentFirst = true,

	wrappers = {
		'Patrôon:Ne wrapper',
		'Patrôon:Een andre wrapper'
	},

	readOnly = true,
	noOverwrite = true
})

Spaties wegsnyen (Trimming)

MediaWiki snydt spaties otematisch weg by benoamde argumentn die uut #invoke of e patrôon kommn, moa lat spaties stoan by positionele (numerieke) argumentn. Standoard ept deze module oem ôok spaties by positionele argumentn weg te snyen. Oem spaties te beoudn, zet je d' opsje trim ip false.

local args = getArgs(frame, {
	trim = false
})

A je d' opsje valueFunc gebruukt, is de valueFunc funcsje verantwoordelik vo 't wegsnyen van spaties, en eit de trim opsje gèn effect mêer.

Lege argumentn verwydern

"Lege argumentn" zyn argumentn uut #invoke of e patrôon die bestoan uut e lege tekst of allêne spaties. Standoard smyt deze module ol die lege argumentn weg. Oem ze te beoudn, zet je d' opsje removeBlanks ip false.

local args = getArgs(frame, {
	removeBlanks = false
})

A je MediaWiki patrôonn omzet noa Lua, moe je d'r rekening mee oedn dat in Lua, lege tekstn anzien wordn as "woar" (true). O je ier gèn rekening mee oudt, ku je verkêerde resultoatn krygn. As valueFunc actief is, reegelt die funcsje 't verwydern, en eit removeBlanks gèn effect.

Eign opmoak van argumentn (valueFunc)

Soms wil je sommigte lege argumentn verwydern moa andere nie, of wil je aolle positionele argumentn omzettn noa klêne letters. Iervôorn ku je d' opsje valueFunc gebruukn. De input moe e funcsje zyn die twêe parameters pakt (key en value) en êen woarde weregèeft.

Klik ier oem de vôorbeeldn mèi valueFunc te tôgen

Vôorbeeld 1: Beoudt spaties vo 't êerste positionele argument, moa snydt ol de reste weg en verwydert lege argumentn. local args = getArgs(frame, { valueFunc = function (key, value) if key == 1 then return value elseif type(value) == 'string' then value = mw.text.trim(value) if value ~= '' then return value else return nil end else return value end end }) Vôorbeeld 2: Verwydert lege argumentn en zet aol d' argumentn in klêne letters, moa snydt gèn spaties weg van positionele parameters. local args = getArgs(frame, { valueFunc = function (key, value) if type(value) == 'string' then value = mw.ustring.lower(value) if mw.ustring.find(value, '%S') then return value else return nil end else return value end end })

Frames en oofd-frames (Parent frames)

Argumentn in de args tabelle kunn teglykertyd wordn deuregegeevn vanuut et hudige frame of uut 't oofd-frame (parent). Stel da we e module eit die Module:ExampleArgs noemt, die d' êerste twêe argumentn print:

Klik ier oem de code te tôgen
local getArgs = require('Module:Arguments').getArgs local p = {} function p.main(frame) local args = getArgs(frame) return p._main(args) end function p._main(args) local first = args[1] or '' local second = args[2] or '' return first .. ' ' .. second end return p

As Patrôon:ExampleArgs de code {{#invoke:ExampleArgs|main|''firstInvokeArg''}} bevat, kunn we 't gedrag anpassn mèi frameOnly, parentOnly en parentFirst.

• frameOnly: Pakt allêne argumentn uut et hudige frame (#invoke).
• parentOnly: Pakt allêne argumentn uut 't oofd-frame (et patrôon zelve).
• parentFirst: Pakt ze van aolle twêe, moa et patrôon eit vôorrang ip de #invoke argumentn.

Wrappers

De wrappers opsje wordt gebruukt oem e bepeirkt antol patrôonn an te duudn as "wrapper patrôonn" (patrôonn woavan 't ênigste doel is oem de module an te roepn). As de module ziet da ze vanuut e wrapper wordt angereoepn, goat ze allêne in 't oofd-frame (parent) kykn achter argumentn. Dit is vele betr vo de prestoasjes.

Wrappers kunn as e tekst of as e lyste van tekstn wordn meegegeevn.

local args = getArgs(frame, {
	wrappers = {
		'Patrôon:Wrapper 1',
		'Patrôon:Wrapper 2'
	}
})

De module goa ôok otematisch herkenn of 't angeroept wordt uut de /zandbak (sandbox) van e wrapper.

Wegschryvn noa de args-tabelle

Soms is 't andig oem nieuwe woardn in de args-tabelle te schryvn. Dit kut mèi de standoard instelliengn van deze module:

args.foo = 'een extra woarde'

Je kut dit teegnoudn mèi readOnly (gèn inkoamende woardn anpassn) en noOverwrite (nieuwe woardn zyn toegestoan, moa je meugt gèn bestoande argumentn uut #invoke overschryvn).

Ipmerkiengn

Ref-tags: Deze module gebruukt Lua-metatabellen oem argumentn ip te aaln. Dit zorgt d'rvoorn da je toegang eit toet aolle argumentn zounder d'n trage pairs() funcsje te gebruukn. Dit is vrêe andig a joun module e <ref>-tag as input krygt, omda MediaWiki ref-tags direct verwerkt zodra ze in Lua wordn angereoepn.

Gekende beperkiengn: 't Gebruuk van metatabellen eit wok zyn noadêeln. De mêeste normoale Lua-tabel funcsjes goan nie tegoei wirkn ip de args-tabelle, woarounder den #-operator, de next() funcsje, en de funcsjes uut de table library.

Broncode & Mêer Info

D'originele, vrêe uutgebreide (technische) documentuoasje is te viendn ip de Engelstoalige Wikipedia.