Pojmenování

Tuto sekci lze ignorovat u modulů určených k volání pouze ze šablon.

Globální moduly, které mají být používány jinými moduly, by měly být ve všech wikinách pojmenovány stejně, aby se zabránilo přerušení závislostí s jinými globálními moduly. Například pokud modul s názvem A vyžaduje modul s názvem B, ale v nějaké wiki je modul B pojmenován C, pak modul A v této wiki nebude fungovat, pokud se zdrojový kód modulu A lokálně nezmění tak, aby vyžadoval C místo B, což by znemožnilo globalizaci (modulu A).

Pokud lokální komunita neakceptuje globální název nebo je přejmenování příliš problematické, pak je řešením vytvořit "modul přesměrování" s globálním názvem, který jednoduše vyžaduje a vrací modul s lokálním názvem.

Naštěstí skutečnost, že jmenný prostor modulu je v každém jazyce pojmenován jinak, nenarušuje závislosti, protože "Module" je alias pro jmenný prostor modulu ve všech jazycích.

Master (hlavní) modul

Globální moduly by si měly vybrat jednu wiki, kde se bude provádět vývoj. Obecně se jedná o domovskou wiki modulu, ale může se z různých důvodů přesunout, například aby se zvýšila šance na nábor nových vývojářů centralizací vývoje do větší nebo vhodnější wiki.

Globální moduly by měly začínat komentářem, který obsahuje odkaz na hlavní modul, aby se snížilo riziko větvení a pomohlo se s náborem nových vývojářů (příklad).

Sandbox

Globální moduly by měly mít podstránku /sandbox, kde je možné testovat změny před jejich nasazením do hlavního modulu a ostatních wikin (příklad).

Zkušební testy

Globální moduly by měly mít podstránku /testcases s kvalitními jednotkovými testy, aby byla zajištěna vysoká kvalita a stabilita modulu (příklad). Zkušební testy by měly:

• Používat Module:ScribuntoUnit
• Spustit s hlavním modulem i sandboxovou verzí, abychom mohli porovnat výsledky (příklad)
• Použít require('strict') , k zabránění nechtěnému použití nedeklarovaných proměnných.
• Výsledky vypisat na stránku modulu /testcases/doc i na hlavní stránku /doc, aby se chyby odhalily co nejdříve.

Dokumentace

Globální moduly by měly mít podstránku /doc s dokumentací všech veřejných funkcí modulu (příklad) a sekci s testovacími případy běžícími pro primární i sandbox verzi modulu (příklad).

Konfigurace

Globální moduly, které vyžadují konfiguraci, by měly mít samostatný submodul /config, aby se zabránilo lokálním wikinám v úpravě zdrojového kódu za účelem konfigurace modulu (příklad).

Synchronizace

Jakmile je možné modul zkopírovat beze změny do jiných wikin, lze k jeho zkopírování a synchronizaci napříč všemi wikinami Wikimedie použít nástroj Synchronizátor .

Zpětná kompatibilita

Globální moduly by obecně měly zajišťovat zpětnou kompatibilitu vývoje, protože změny, které nejsou zpětně kompatibilní, často vyžadují ruční aktualizace každé wiki, šablony a modulu, který daný modul používá.

Lokalizace parametrů šablony

Parametry globálních modulů mohou být lokalizovány volajícími šablonami. Uvažujme například následující modul, který jednoduše vypíše zadaný text (nebo "Example", pokud žádný není zadán):

local p = {}

function p.main(frame)
 	 local args = frame.args
 	 local text = args['text'] or 'Example'
 	 return text
end

return p

Španělská šablona by pak lokalizovala modul takto:

{{#invoke:Example|main
| text = {{{texto|Ejemplo}}}
}}

Všimněte si, že šablona nejen lokalizuje název parametru "text" ("texto" znamená ve španělštině "text"), ale také výchozí text ("Ejemplo" znamená ve španělštině "Example" (příklad)).

Viz Plantilla:Extracto pro reálný případ šablony, která lokalizuje globální modul pomocí této techniky. Viz také Template:Excerpt pro případ, kdy je globální modul lokalizován do anglické Wikipedie, což ukazuje, že lokalizace není vždy totéž co překlad.

Lokalizace uživatelsky čitelných řetězců

Mnoho modulů potřebuje vytvářet uživatelsky čitelné řetězce, jako jsou chybové zprávy a prvky rozhraní (jako jsou tlačítka). Pevné kódování textu těchto řetězců nutí ostatní wikiny upravovat kód za účelem jejich lokalizace, což brání globalizaci. Aby se tomu zabránilo, vývojáři by měli poskytnout způsoby, jak lokalizovat uživatelsky čitelné řetězce, aniž by bylo nutné upravovat samotný kód. Tato část vysvětluje několik způsobů, jak toho dosáhnout.

local p = {}

function p.main(frame)
 	 local args = frame.args
 	 local text = args['text'] or 'Example'
 	 return text
end

return p

{{#invoke:Example|main
| text = Ejemplo
}}

local config = require('Module:Example/config')

local p = {}

function p.main(frame)
 	 local text = config.text or 'Example'
 	 return text
end

return p

return {
 	 text = 'Ejemplo'
}

local TNT = require('Module:TNT')

local p = {}

function p.main(frame)
 	 local text = TNT.format('I18n/Example', 'text')
 	 return text
end

return p

local p = {}

function p.main(frame)
 	 local msg = mw.message.new('newpage')
 	 local text = msg:plain()
 	 return text
end

return p

Template data

Parametry šablony se obvykle ukládají jako blok JSON templatedata uvnitř podstránky šablony s hodnotou /doc. Díky tomu je překlad pohodlný, ale když je do globální šablony přidán nový parametr, je nutné aktualizovat všechny stránky s kódem /doc v každém jazyce. Module:TNT s tím pomáhá automatickým generováním bloku templatedata z tabulky uložené na Commons. Vložením následujícího řádku do každé podstránky /doc se pomocí tabulky Data:Templatedata/Graph:Lines.tab vygenerují všechny potřebné informace o templatedata v každém jazyce. I když místní komunita nepřeložila kompletní dokumentaci k šabloně, bude si moci prohlédnout všechny parametry šablony, centrálně aktualizované.

{{#invoke:TNT|doc|Graph:Lines}}