Helpo:Lua/Modulo por certa ŝablono

Lua
Programado Modulo en Vikio Certa ŝablono Signoĉenoj Ligiloj Ĉirkaŭaĵo Internaciigo Koderoj Fontokodo+antaŭrigardo
VP:LUA Moduloj Organizado Funkcioj kaj vikitekstoj Petoj
Kategorioj
Ŝablonoj Moduloj
Ŝablonoj
{{LuaModuleDoc}} por la dokumentado de modulo, por aranĝi la keston kun ligiloj {{Modula statuso}} por la dokumentadoj de modulo, por indiki la evoluan statuson de modulo {{Kun Lua-modulo}} por la dokumentado de ŝablono, kiu uzas Lua-modulon aŭ eĉ entute baziĝas sur modulo {{Uzanto Projekto/Lua}} por uzantopaĝoj
Vidu ankaŭ
Lua mw:Manual 5.1 Manual germane enwiki
Komentoj

Ĉi tiu helpopaĝo donas por Lua-programistoj startan punkton, kiel eblas skribi modulon, kiu subtenu ekzakte unu ŝablonon.

La malo estus biblioteka modulo, kiu povas esti alvokata de iom ajn multaj diversaj ŝablonoj.

Baza principo

• La modulo ricevas la nomon

  Modulo:Ŝablono:Ŝablona titolo

  • Per tio estas facile ekkompreni la grupigon.
• La laboro de la ŝablono estas eksklude farata per la modulo.
  • La ŝablono enhavas kutime nur ununura linion:

    {{#invoke:Ŝablono:Ŝablona titolo|f}}<noinclude>{{Dok}}</noinclude>

• La funkcio f (aŭ laŭ prefero alie nomita) estas la ununura por ŝablonoj disponebla interfaco.
• Parametroj de la ŝablona enplektado ne devas esti transdonataj; ili povas esti determinataj pli bone kaj pli komplete ene de la modulo.
• Ene de Vikia projekto ne necesas aliaj parametroj; apartaj kazoj estus Pluraj ŝablonoj aŭ Internaciigo.

Modelo

--[=[ 2013-05-19
Subteno por {{Ŝablona titolo}}
f() test()
]=]


--
--


local function x( u )
    local r
    --
    return  r
end -- x()


local function main( a )
    local r
    --
    r = x( u )
    --
    return  r or ""
end -- main()



-- Export
local p = {}

function p.test( a )
    local lucky, r = pcall( main, a )
    return r
end

function p.f( frame )
    local lucky, r = pcall( main, frame:getParent().args )
    return r
end

return p

Ŝablona interfaco

La funkcio f transprenas per getParent() la parametrojn de la ŝablona enplekto.

Ĝi alvokas la ĉefan funkcion en protekta ekzekutado.

Redona valoro estas la de main() redonita signoĉeno aŭ la de pcall() asignita signoĉeno de la erarmesaĝo.

Testa interfaco

• Por aŭtomatigitaj testoj povas esti antaŭdifintaj de koncerna Lua-modulo pli granda serio de parametraj aroj kaj esti komparataj kun la atendataj rezultoj.
• La parametraj aroj estas aranĝataj en sama maniero, kiel ili estus uzataj ĉe la ŝablona enplektado.
• La ĉefa funkcio estas alvokata ekzakte analoge.

Ĉefa funkcio

• La funkcio main() (aŭ laŭ prefero alie nomita) estas la vera labora funkcio.
• Ĝi ricevas ĉiujn parametrajn asignojn kiel a, egale ĉu tiuj devenas al #invoke aŭ de la simulado.
• La redona valoro estas la por ŝablonoj taŭga signoĉeno; kaj tio identa por la ŝablona enplekto kaj la simulado, por ke la rezultoj estu kompareblaj.
• frame ne estas transdonata. Se la objekto foje estas bezonata, ĝi povas esti determinata per mw.getCurrentFrame(). Ĝi estus tiu de la ŝablona enplekto aŭ eble tiu nepre ie ekzistanta #invoke de la simulado.
• La loka funkcio main() devas esti fiksita kiel lasta de ĉiuj lokaj funkcioj.

Protekta ekzekutado

La alvoko de la ĉefa funkcio estas ĉiam protektata en pcall().

• Se okazas nun iu eraro dum ekzekutado, aŭ eraro estas kaŭzata per la propra modulo per assert() aŭ error(), tiam r estas la erarmesaĝo.
• Per tio estas evitata la notore nespecifa „Skripteraro“.

Pluraj ŝablonoj

Se ekzistas sufiĉe limigita grupo de ŝablonoj (ekzemple Ŝablono:Lin*), ĉe kiuj ne valoras la penon por unuopaj moduloj, ili povas esti lokataj en unu komuna modulo.

Jen ekzemplo de Ŝablono:Lin longo:

{{#invoke:S|f|f=len}}

kun ununura Modulo:String por ĉiuj.

La funkcio f devas esti tiam modifata kiel sekvas:

function p.f( frame )
    local a = frame:getParent().args
    a.f = frame.args.f
    local lucky, r = pcall( main, a )
    return r
end

Dum ke ĉiuj aliaj parametroj devenas de la ĉirkaŭanta ŝablono, f estas prenata el la argumentoj de #invoke.

La funkcio test devas konvene antaŭdifini al si la ŝablonan nomon en sia simulado.