Vikipedio:Lua/Paĝa organizado kaj dokumentado
| |||
| Kategorioj | |||
|---|---|---|---|
| Ŝablonoj | |||
| |||
| Vidu ankaŭ | |||
| Komentoj | |||
|
|||
Ĉi tiu paĝo priskribas la strukturon de la Vikitekstaj paĝoj ligataj kun Lua-modulo kaj la grupigo de la dokumentado pri Lua-modulo.
Paĝa organizado redakti
Multoblaj Vikitekstaj paĝoj pri modulo (ekzemple por ŝablono-testoj, testorezultoj aŭ plurlingvaj dokumentadoj) ne eblas ene de la nomspaco Modulo: (828).
- Por ĉiu modulo (aŭ submodulo) nur povas ekzisti ekzakte unu paĝo, kies nomo finiĝas je
/dokumentado. Nur tiu povas enhavi Vikitekston; ĉiuj ceteraj paĝoj estas traktataj kiel Lua-fontokodo. Tial ĉiuj paĝoj kun Vikiteksto estas unue transmetataj al alia loko kiel subpaĝoj de Vikipedio:Lua/Moduloj. - Krome estas je dispono la Ŝablono {{LuaModuleDoc}}, kiu sur ĉiuj koncernataj Vikitekstaj paĝoj povas esti enplektata. Ĝi zorgas por unueca navigada skemo. Krome ĝi disponigas ĉiujn necesajn ligilojn kaj kategoriigas aŭtomate.
Diskutopaĝoj redakti
Ĉiuj diskutoj pri ĉiuj subpaĝoj estas aranĝataj centre je ununura loko. Por ĉi tiu celo ricevu ĉiuj aliaj videblaj paĝoj alidirektilojn tien.
Strukturo redakti
La sekvaj paĝoj interrilatas kun Ekzempla modulo:
Modulo:Ekzempla modulo- Lua-fontoteksto.
Modulo:Ekzempla modulo/dokumentado- Ĉi tiu paĝo estas nur (aŭtomate) enplektata sur
Modulo:Ekzempla modulo kaj enhavas nur ununuran linion:
{{LuaModuleDoc}}
- Ĉi tiu paĝo estas nur (aŭtomate) enplektata sur
Vikipedio:Lua/Moduloj/Ekzempla modulo- Ĉi tiu paĝo montras la informojn, kiuj gravas por la uzado enkadre de ŝablono; alie neniun. Ĝi tamen enhavas nur ununuran linion:
{{LuaModuleDoc}}
- Ĉi tiu estas la centra "kunvena paĝo" kaj ĝi ankaŭ estas metata en kategorion.
Vikipedia:Lua/Moduloj/Ekzempla modulo/eo- Vikiteksto (esperanta) pri la dokumentado de la ekstera funkcieco (ŝablona programado) kaj la interna strukturo (Lua-programado). Ekzemplon vidu malsupre.
- Antaŭmeta estas:
{{LuaModuleDoc}}
Vikipedio:Lua/Moduloj/Ekzempla modulo/en- Ekzakte kiel antaŭe, sed en la angla lingvo.
Vikipedio:Lua/Moduloj/Ekzempla modulo/****- Ekzakte kiel antaŭe, sed en la lingvo ****.
{{LuaModuleDoc|****}}estu tiam uzata sur ĉiuj paĝoj pri la modulo.
Modulo-Diskuto:Lua/Modulo/Ekzempla modulo#ALIDIREKTU [[Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo]]
Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo- Centra diskutopaĝoj por ĉiuj paĝoj apartenantaj al Ekzempla modulo.
- Estas antaŭmetata:
{{LuaModuleDoc}}
Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo/eo#ALIDIREKTU [[Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo]]
Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo/en#ALIDIREKTU [[Vikipedia diskuto:Lua/Moduloj/Ekzempla modulo]]
La surekranigo de nur unu dokumentado supre de la fontoteksta kadro sur la paĝo de Modulo:Ekzempla modulo (kiel tio estas antaŭdifinata de MediaWiki) estus senca nur ĉe tre mallongaj moduloj. Por la ŝablonoprogramistoj tamen la Lua-fontoteksto estas neinteresa, kaj ĉe longa Lua-fontoteksto kaj sufiĉe longa dokumentado estas la kombino sur unu sama paĝo kun daŭra rolado ne sencoplena. Krome direndas, ke plurlingveco kaj subpaĝoj ne estas subtenataj.
Submoduloj redakti
Ĉiu modulo estu memstare uzebla; tio jam per la nomo estas supozigata.
Povas esti necese, transmeti al alia loko nememstarajn submodulojn:
- Superrigardo ĉe tre vasta kodo.
- Apartigo de puraj datumaj tabeloj.
- Aparta evoluado kaj plibonigo de kompleksaj subtaksoj kun la eblo de sendependa provado.
- Paĝoprotektado.
- Aŭtomatigita testado.
Submoduloj ne estu mem enplektataj per #invoke en ŝablonojn. Ili tamen povus esti uzataj per mw.loadData() aŭ en maloftaj esceptaj okazoj de forte rilataj moduloj per require(); en la lasta kazo tamen oni strebu al pura eligo kiel biblioteka modulo por la ĝenerala uzado.
Tipa kazo estus unit test kun la paĝonomoj /testo – certe ne de alia modulo uzebla.
Al diskuto estu alidirektata al la centra diskutopaĝo. Dokumentado ankaŭ povas esti integrata en la dokumentadopaĝon de memstara modulo.
Paĝoprotektado redakti
Ĉiu produktive en la projekto uzata modulo estu duonprotektata kontraŭ IP-prilaborado kaj per move:sysop estu tute protektata. Ĉe biblioteka modulo tendencas la nombro de enplektoj rapide al dekmiloj; elementaraj taskoj povus koncerni poste eĉ centmilojn da artikoloj.
Dokumentado redakti
Ĉiu produktive en la projekto uzata modulo bezonas dokumentadon. Apud la aktuala uzado ĉe la ŝablona programado estu pripensata ankaŭ la posta prizorgado.
Poste estas priskribata la esperanta versio.
Minimuma amplekso redakti
{{LuaModuleDoc}}
<onlyinclude>'''<code>Ekzempla modulo</code>''' – Modulo por ĉi tiu kaj tiu celo.
- {{Ankro3|Ŝablono}} Funkcioj por ŝablonoj
-
- ; FunkcioA
- : Efiko
- : Parametroj
- ; FunkcioB
- : Efiko
- : Parametroj
- ; FunkcioC
- : Efiko
- : Parametroj
</onlyinclude>{{Ankro3|Lua}}Funkcioj por Lua-moduloj- (forfalas, se ne subtenata)
- Alirebloj
;FunkcioX
:Efiko:Parametroj
;FunkcioY
:Efiko:Parametroj
- Uzado
- Fakultative:
- Ĝenerala biblioteko.
- Subteno de speciale ĉi tiuj kaj tiuj ŝablonoj ktp.
- Dependeco
- Fakultative:
- Neniu.
- Moduloj kun require ktp.
Plia ĉapitroj estas eblaj depende de individua konstelacio; volonte ankaŭ dokumento de internaj funkcioj.
- Vidu ankaŭ
- Se io rilata ekzistas.
Nur la verde markita parto estas por programistoj de ŝablonoj videbla kaj relevanta.
Programisto de ŝablonoj ricevas eltiron el la unua trovebla lingva versio.
Kopiebla skizo redakti
{{LuaModuleDoc}}
<onlyinclude>'''<code></code>''' – Modulo
== {{Ankro2|Ŝablono}} Funkcioj por ŝablonoj ==
;
:
</onlyinclude>
== {{Ankro2|Lua}} Funkcioj por Lua-moduloj ==
== Uzado ==
== Dependeco ==
Plurlingvo redakti
Estas atendeble, ke ni importos version de modulo el alia Vikia projekto; nome el la angla Vikipedio. Tiam la apartenanta dokumentado (se ĝi ekzistas) devus esti konvene alĝustigata kaj enigata; pli poste ankaŭ esperanta versio estu kreata.
Same, kiel ni importas, ni metu je dispono universalajn normtaskojn ankaŭ mondvaste al ĉiuj Vikioj; konforme al tio tiam estu programata kaj dokumentata en angla lingvo.
Ekzemplaj paĝoj redakti
Ĉe la sekvaj moduloj estas realigata la strukturo ekzemplodona: