Ŝablono:Kun Lua-modulo

Dokumentado Dokumentado

Ĉi tiu ŝablono kreas mesaĝan ŝablonon, kiu estu metata en dokumentadojn de ŝablonoj, kiuj uzas Lua-modulon.

Uzado

Sen kategorio
{{Kun Lua-modulo
|parametro=
|modulo=
}}
Kun kategorio
{{Kun Lua-modulo
|parametro=
|modulo=
|kategorio=
}}
Kompleta varianto por kutima uzado
{{Kun Lua-modulo
|parametro=
|modulo=
|kategorio=
|detaloj=
}}
Kompleta varianto por indiko pri subŝablono
{{Kun Lua-modulo
|subŝablono=
|parametro=
|modulo=
|kategorio=
|detaloj=
}}
Varianto kun ĉiuj sennombraj parametroj
{{Kun Lua-modulo
|subŝablono=
|parametro=
|modulo=
|kategorio=
|detaloj=
|funkcio=
}}

Parametroj

  • parametro - koncernata(j) parametro(j) (Bonvolu atenti, ke ĉe pli ol unu parametro la parametroj estu disigataj per komo. Vidu malsupre)
    • Se la modulo estas uzata por pli ol unu parametro, uzeblas la valoroj kelkakelkaj (Prefere uzata kune kun detaloj.), multaj, (por "preskaŭ ĉiuj") resp. ĉiuĉiuj.
  • modulo - nomo de enplektita modulo
  • kategorio - nomo de kategorio, sed sen la komenca parto Kategorio:Vikipedio:. Se la parametro mankas, aŭtomate validas la Kategorio:Ŝablono:Kun Lua. Lasante ĝin malplena (kategorio = ) faras, ke neniu kategoriigo okazas.
  • detaloj - difinas informon pri detaloj, prefere kun ligilo al ĉapitro kun pliaj detaloj. Ĝi estu prefere uzata kune kun parametro=kelkaj.
  • subŝablono - ebligas krei ligilon al la koncerna ŝablono.
  • funkcio - ebligas eĉ mencii la funkciojn de la Lua-modulo. Tie eblas listo, same kiel ĉe "parametro", sed ĝi aperas en alia formo.

Ekde la 11-a de oktobro 2015 eblas pliaj informoj, ĉe kiuj la rilataj aldonaj parametroj havas finan ciferon, nome 2 ĝis 5. Vidu ekzemplon. Ĉi tiuj aldonaj parametroj havas la parametron moduloX kiel minimuman parton, por povi aperi. (X = 2 ĝis 5.)

Ekde la 7-a de decembro 2015 eblas aldoni informon pri eventuala helpa ŝablono por la dokumentado, kiu siavice uzas Lua-modulon. Por tio ekzistas grupo de parametroj:

  • dokumentado - dokumentado por tuta grupo de ŝablonoj, kiu siavice uzas Lua-modulon
  • dok-modulo - nomo de la koncerna modulo

Se estas uzataj iuj nombritaj parametroj, enkondukitaj la 11-an de oktobro 2015, la ĉisupraj parametroj havas ekvivalenton kun la sama nombrado (do dokumentado2 ĝis dokumentado5 kaj dok-modulo2 ĝis dok-modulo5). Vidu ekzemplon

Ekzemploj

Pri unu parametro aranĝata per Lua-modulo
{{Kun Lua-modulo
|parametro=dosiero
|modulo=InfoboxImage
}}

fariĝas

Pri du parametroj aranĝataj per Lua-modulo
{{Kun Lua-modulo
|parametro=bildo, blazono
|modulo=InfoboxImage
}}

fariĝas

Varianto, se estas detaloj en aparta ĉapitro
{{Kun Lua-modulo
|parametro=kelka
|detaloj=en la ĉapitro [[#Lua-subteno|Parametroj kun Lua-subteno]]
}}

fariĝas

Varianto kun indiko pri subŝablono
{{Kun Lua-modulo
|subŝablono=Ŝablono:Informkesto/bildoj
|parametro=dosiero
|modulo=InfoboxImage
}}

fariĝas

Varianto kun mencio de Lua-funkcio
{{Kun Lua-modulo
|parametro=kelka
|modulo=Biografio
|funkcio=enkonduko
}}

fariĝas

Varianto kun du funkcioj
{{Kun Lua-modulo
|parametro=kelka
|modulo=Biografio
|funkcio=enkonduko, kategorio
}}

Varianto kun pluraj moduloj
{{Kun Lua-modulo
|modulo=InfoboxImage
|parametro=Dosiero
|modulo2=Biografio
|parametro2=kelka
}}

Varianto kun dokumentado uzante Lua-modulon
{{Kun Lua-modulo
|parametro=ĉiuj
|modulo=Lingvonomo
|dokumentado=Lingva adverbo
|dok-modulo=Lingvonomo/dok
}}

Se vi havas demandon pri ĉi tiu ŝablono, tiam vi povas demandi en la ŝablonprojekta diskutejo. La Intervikiaj ligiloj estu metataj al Vikidatumoj. (Vidu Helpopaĝon pri tio.)