Modul:Arguments/doc

Ez a modul az #invoke-kal hívott modulok paramétereinek egyszerű feldolgozását segíti. Ez egy meta-modul, azaz más modulok használják, ezért az #invoke-kal történő közvetlen hívása értelmetlen. Képességei:

• A paraméterek kezdő és záró szőközöktől való megtisztítása (trim). Az üres paraméterek eldobása
• A paramétereket az aktuális és a szülő feldolgozókeret is egyszerre át tudja adni. (Részletek lejjebb.)
• A paraméterek átadhatók: más Lua modulból közvetlenül, vagy hibakereső (debug) konzolról.
• A paraméterek, akkor kerülnek átvételre, amikor szükség van rájuk, ezzel elkerülhetők egyes, a referencia tag-ekből adódó problémák.
• A legtöbb képesség testreszabható.

Alap felhasználási mód

Legelőször be kell tölteni a modult. Egyetlen függvényt, a getArgs-ot tartalmazza.

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

A legegyszerűbb esetben a getArgs a hívó modul fő függvényből meghívható. Az args változó egy tábla, amely az #invoke-ból jövő paramétereket tartalmazza. (Részletek lejjebb.)

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

function p.main(frame)
	local args = getArgs(frame)
	-- Ide jön a modul fő kódja.
end

return p

Javasolt a függvényt elsősorban az #invoke-ból jövő paraméterek kezelésére használni. Azért, mert ha modulunkat egy másik Lua-modul közvetlenül hívja, nem kell külön keret-objektumot alkalmazni, ami növeli a kód futási teljesítményét.

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

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

function p._main(args)
	-- Ide jön a modul fő kódja.
end

return p

Ha több függvényben akarjuk felhasználni az #invoke-ból elérhető paramétereket, akkor egy külön függvénybe csomagolhatjuk a getArgs-ot:

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

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

local p = {}

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Ide jön az első függvény kódja.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Ide jön a második függvény kódja.
end

return p

Opciók

A következő opciók érhetők el (az alábbi szakaszokban elmagyarázzuk):

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- a paramétreket feldolgozó kód
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Sablon:Burkoló sablon',
		'Sablon:Másik burkoló sablon'
	},
	readOnly = true,
	noOverwrite = true
})

Szóközök elhagyása és üres paraméterek eltávolítása

Az üres paraméterek problémájába gyakran beleütköznek a MediaWiki-sablonokat Luába konvertálni kívánó kezdő programozók. A sablon szintaxisában az üres vagy csak white space-t tartalmazó karakterláncok hamis értékűnek számítanak. Ugyanakkor a Lua ezeket a karakterláncokat igaz értékűnek tekinti. Ha tehát nem figyelünk ezekre a különbségekre, akkor előfordulhat, hogy a Lua-modulban igazként kezelünk valamit, amit valójában hamis értékűnek kellene vennünk. Hogy az ilyen helyzeteket elkerülhessük, ez a modul alapértelmezésben eltávolítja az üres paramétereket.

Hasonló gondot okozhatnak a névtelen paraméterek is. Jóllehet a white space el van távolítva az #invoke-ból nevesített paraméterek elejéről és végéről, ez nem történik meg a névtelen, ún. pozicionális paraméterek esetén. A legtöbbször nincs szükség ezekre a karakterekre, ezért ez a modul alapértelmezésben eltávolítja azokat.

Ha mégis szükség van az üres paraméterekre, illetve a paraméterszéleken megtalálható white space-re, például bizonyos sablonok működésének pontos lemásolása céljából, akkor a trim illetve removeBlanks paramétereket hamisra (false) kell állítani.

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

A paraméterek testreszabott formázása

Néha bizonyos üres paramétereket el kívánunk hagyni, másokat azonban nem, vagy esetleg minden névtelen paramétert kisbetűssé kívánunk tenni. Ilyen feladatokat a valueFunc opció segítségével tudunk megoldani. Ennek a bemenete egy kétváltozós függvény (key és value), visszatérési értéke pedig egyetlen érték, ami az args táblában a key mezőben lesz található.

1. példa: A függvény az első névtelen paraméter értékét pontosan megtartja, az összes többi paraméter széleiről eltávolítja a white space-t, és a többi üres paramétert pedig elhagyja.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif value then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			end
		end
		return nil
	end
})

2. példa: Ez a függvény elhagyja az üres paramétereket, és valamennyi értékét kisbetűsíti, de nem távolítja el a white space-t.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})

Megjegyzés: a fenti függvény hibás, ha a bemenete nem string típusú vagy nil. Ez olyankor fordulhat elő, ha a getArgs függvényt modulunk fő függvényében használjuk, amelyet viszont egy másik Lua-modul hív meg. Ebben az esetben ellenőrizni kell a bemeneti paraméter típusát. Ilyen gond nem lép fel, ha egy speciális függvényt használunk fel az #invoke paramétereinek beolvasására (pl. p.main a fő kódunk és a p._main speciális függvényt alkalmazzuk).

A valueFunc függvényt szinte minden alkalommal meghívjuk, ha szükségünk van a args tábla egy elemére; ha szempont számunkra a kód hatékonysága, akkor figyeljük, hogy ne maradjanak a kódunkban rossz hatékonyságú elemek.

Keretek és szülő-keretek

Mind az aktuális, mind a szülősablon kerete adhat át paramétereket az args táblába. A legegyszerűbben ezt egy példán keresztül érthetjük meg. Legyen ez a Modul:ExampleArgs modul. Ez a neki átadott két első névtelen paramétert írja ki.

A Modul:ExampleArgs modulunkat meghívja a Sablon:ExampleArgs sablon, amely a következő kódot tartalmazza: {{#invoke:ExampleArgs|main|firstInvokeArg}}. Ez a hívás a firstInvokeArg kimenetet eredményezi.

Ha most meghívjuk aSablon:ExampleArgs-t, a következő történik:

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg secondTemplateArg

Három kapcsoló áll rendelkezésünkre, hogy ezt a viselkedést megváltoztassuk: a frameOnly, a parentOnly és a parentFirst. Ha frameOnly kapcsolót használjuk, akkor csak az aktuális keret paramétereit fogadjuk el; ha a parentOnly kapcsolót állítjuk be, akkor csak szülőkeret paramétereit fogadjuk el, ha a parentFirst kapcsolót állítjuk be, mindkét helyről megkapjuk a paramétereket, de a szülőkeret élvez elsőbbséget az aktuálissal szemben. Ezek a TSAblonExampleArgs futásának eredményei:

frameOnly

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg

parentOnly

Kód	Eredmény
{{ExampleArgs}}
{{ExampleArgs|firstTemplateArg}}	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

parentFirst

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

Megjegyzések:

1. Ha a frameOnly és a parentOnly kapcsolót is beállítjuk, a modul egyik paramétert sem fogja beolvasni. Valószínűleg ilyet nem akarunk.
2. Bizonyos esetekben a szülő-keret nem elérhető: pl. getArgs eleve a szülőkeretet kapja meg aktuális helyett. Ebben az esetben csak az átadott keret paraméterei használhatóak (kivéve ha a parentOnly be van kapcsolva, mert ilyenkor egyetlen paramétert sem használunk fel). Ilyenkor a parentFirst és frameOnly kapcsolók hatástalanok.

Burkolósablonok (Wrappers)

A wrappers kapcsolót arra használjuk, hogy megjelöljük az ún. burkolósablonokat, vagyis olyan sablonokat, amelyeknek egyetlen funkciója az, hogy egy adott modult meghívjanak. Ha a modul érzékeli, hogy a burkolósablon hívja, akkor csak a szülősablon keretének paramétereit fogja tekintetbe venni, azaz csak a getArgs-nak átadott keret paramétereit fogja ellenőrizni. Ezzel elérjük, hogy a modult akár #invoke-kal, akár burkolósablonnal hívjuk, csak a szükséges paramétereket fogja ellenőrizni, növelve ezzel a kód hatékonyságát.

Például: Ha Sablon:Side box összes valódi tartalma (a noinclude tag-ek en kívül): {{#invoke:Side box|main}}, akkor semmi értelme, hogy megpróbáljuk megkeresni az #invoke parancsnak átadott paramétereket, mivel ilyenek egyszerűen nincsenek. Az #invoke paramétereinek fölösleges ellenőrzése elkerülhető parentOnly kapcsoló használatával is, de ha ezt tesszük, akkor a más sablonokban elhelyezett #invoke-ok paramétereit sem fogjuk látni. Pl. a |text=Some text a {{#invoke:Side box|main|text=Some text}} kódban mindig figyelmen kívül maradna, függetlenül attól, hogy mely lapról alkalmaznánk. A wrappers kapcsoló segítségével a Sablon:Side boxot burkolósablonként jelöljük meg, így a {{#invoke:Side box|main|text=Some text}} kód a legtöbb lapról működni fog, míg magán a Sablon:Side box lapon továbbra sem történik meg a fölösleges paraméter-ellenőrzés.

A burkolósablonokat karakterláncként, vagy azok tömbjeként adhatjuk meg.

local args = getArgs(frame, {
	wrappers = 'Sablon:Burkolósablon'
})

local args = getArgs(frame, {
	wrappers = {
		'Template:Burkoló 1',
		'Template:Burkoló 2',
		-- akárhány további (burkoló-) sablon neve megadható itt
	}
})

Megjegyzések:

1. A modul automatikusan érzékeli, ha burkolósablon /sandbox allapjáról hívják, ezért a homokozóallapokat nem szükséges explicit módon megadni.
2. A wrappers kapcsoló automatikusan igazítja a frameOnly és parentOnly kapcsolókat az értelemszerűen helyes működésre. Például, ha parentOnly kapcsolót a wrappers beállításával automatikusan false-ra állítanánk, akkor a burkolósablonon keresztül történő hívások a keret és a szülőkeret paramétereit minden esetben beolvasnák, míg a nem burkolósablonokon keresztül történő hívások mindig csak a keret paramétereit adnák át.
3. Ha a wrappers kapcsoló be van állítva, de nem érhető el szülő keret, a modul monden esetben a getArgs-nak átadott keret paramétereit fogja kiolvasni.

Az args paramétertábla írása

Néha hasznosnak bizonyulhat, ha a paraméterek táblájába új értékeket tudunk elhelyezni. Ez ennek a modulnak az alapbeállításaival is lehetséges. (Jóllehet, általában véve jobb kódolási gyakorlat, ha új táblát hozunk létre az új értékekkel, és belemásoljuk a paraméterek közül a szükségeseket.)

args.foo = 'valamilyen érték'

Ez az alapviselkedés megváltoztatható a readOnly és noOverwrite kapcsolókkal. Ha a readOnly kapcsoló be van állítva, akkor az args paramétertáblába nem írható semmilyen új érték. Ha a noOverwrite be van állítva, akkor új értékek adhatók a táblához, de meglévőek nem írhatóak felül.

Lábjegyzetek

Ez a modul metatáblákat használ arra, hogy a paramétereket olvassanak ki az #invoke-ból. Ez lehetővé teszi, hogy mind a keret, és mind a szülőkeret paramétereit kiolvassuk anélkül, hogy a pairs() függvényt használnánk. Ez hasznos lehet akkor, ha a modulunk lábjegyzeteket (<ref> címkéket) tartalmazó bemenetet kaphat.

Ha a Luából <ref> címkét tartalmazó szöveget érünk el, a MediaWiki szoftver azonnal feldolgozza azt, és a lábjegyzet megjelenik a cikk alján. Amennyiben a szöveg végül nem kerül bele a kimenetbe, egy fantomjegyzet keletkezik – a listában megjelenik, de nem mutat rá hivatkozás. Ez olyan modulok számára volt probléma, amelyek a pairs() függvényt használták annak eldöntésére, hogy a paramétereket az aktuális keretből vagy annak szülőkeretéből vegyék, mivel ezek a modulok így automatikusan minden elérhető paramétert feldogoztak.

Ez a modul megoldja ezt a problémát azzal, hogy lehetővé teszi mind az aktuális, mind a szülő keret paramétereinek kiolvasását, de csak akkor, ha ténylegesen szükség van rájuk. A probléma azonban még előfordulhat, ha a pairs(args) függvényt a modul másik részén felhasználjuk.

Ismert problémák

A metatáblák használatának hátrányai is vannak. A legtöbb szokásos Lua-táblaeszköz nem működik rendesen az args táblán, beleértve a # operátort, a next() függvényt és a table könyvtár függvényeit. Ha mindenképpen szükséged van ezekre a modulodban, saját paraméterfeldolgozó függvényt kell írnod ennek a modulnak a használata helyett.