Šablon:Godina u drugim kalendarima/dok

Ovo je stranica dokumentacije za {{Šablon:Godina u drugim kalendarima}} (pogledajte tu stranicu za sam šablon).
Sadrži informacije za korištenje, kategorije i drugi sadržaj koji nije dio stranice originalnog šablona.

Dodavanje novih kalendara

Ovaj modul je namješten da omogući lahko dodavanje novih kalendara. Jednostavno treba skrolovati do sekcije "napravi kutiju" unutar koda modula, te dodati novi kalendar na sljedeći način:

Za prikaz jedne godine:

    local myCalendar = calendar:new()
    myCalendar:setLink( 'My calendar article' ) -- Naziv članka novog kalendara na Wikipediji.
    myCalendar:setYear( year + 10 ) -- Lua code koji povezuje godinu gregorijanskog kalendara sa godinom novog kalendara.
    box:addCalendar( myCalendar )

Za prikaz raspona godina:

    local myCalendar = calendar:new()
    myCalendar:setLink( 'My calendar article' ) -- Naziv članka novog kalendara na Wikipediji.
    myCalendar:setYearRange( year + 10, year + 11 ) -- Lua code koji izbacuje početnu i krajnju godinu u nekom rasponu godina.
    box:addCalendar( myCalendar )

Za složenije kalendare potrebno je izbaciti pomoću stringa calendar:setYear().

Tehnički detalji

Modul definira tri klase koje obavljaju zadatak postavka navigacijske kutije sa strane i prikaza podataka koje dobije iz definiranih funkcija. To su klasa calendarBox, koja definira navigacijsku kutiju; klasa calendar, koja sadrži podatke za neki kalendar; i klasa calendarGroup, koja definira grupu objekata kalendara sa naslovima.

Za učitavanje ovih klasa iz nekog drugog modula potrebno je sljedeće:

local yearInOtherCalendars = require( 'Module:Godina u drugim kalendarima' )
local calendarBox = yearInOtherCalendars.calendarBox
local calendarGroup = yearInOtherCalendars.calendarGroup
local calendar = yearInOtherCalendars.calendar