Module:Year in various calendars/doc

2024 in various calendars

Gregorian calendar	2024 MMXXIV
Ab urbe condita	2777
Armenian calendar	1473 ԹՎ ՌՆՀԳ
Assyrian calendar	6774
Bahá'í calendar	180–181
Balinese saka calendar	1945–1946
Bengali calendar	1431
Berber calendar	2974
British Regnal year	72 Eliz. 2 – 73 Eliz. 2
Buddhist calendar	2568
Burmese calendar	1386
Byzantine calendar	7532–7533
Chinese calendar	癸卯年 (Water Rabbit) 4720 or 4660     — to — 甲辰年 (Wood Dragon) 4721 or 4661
Coptic calendar	1740–1741
Discordian calendar	3190
Ethiopian calendar	2016–2017
Hebrew calendar	5784–5785
Hindu calendars
- Vikram Samvat	2080–2081
- Shaka Samvat	1945–1946
- Kali Yuga	5124–5125
Holocene calendar	12024
Igbo calendar	1024–1025
Iranian calendar	1402–1403
Islamic calendar	1445–1446
Japanese calendar	Reiwa 6 (令和６年)
Javanese calendar	1957–1958
Juche calendar	113
Julian calendar	Gregorian minus 13 days
Korean calendar	4357
Minguo calendar	ROC 113 民國113年
Nanakshahi calendar	556
Thai solar calendar	2567
Tibetan calendar	阴水兔年 (female Water-Rabbit) 2150 or 1769 or 997     — to — 阳木龙年 (male Wood-Dragon) 2151 or 1770 or 998
Unix time	1704067200 – 1735689599

Adding new calendars

The module is set up to allow for easy addition of new calendars. Just scroll down to the "Build the box" section of the module code, and add your calendar as follows:

To display one year:

<syntaxhighlight lang="lua">

   local myCalendar = calendar:new()
   myCalendar:setLink( 'My calendar article' ) -- The name of the calendar's Wikipedia article.
   myCalendar:setYear( year + 10 ) -- Lua code linking the Gregorian calendar year to your calendar's year.
   box:addCalendar( myCalendar )

</syntaxhighlight>

To display a year range:

<syntaxhighlight lang="lua">

   local myCalendar = calendar:new()
   myCalendar:setLink( 'My calendar article' ) -- The name of the calendar's Wikipedia article.
   myCalendar:setYearRange( year + 10, year + 11 ) -- Lua code outputting the start year and the end year of the year range.
   box:addCalendar( myCalendar )

</syntaxhighlight>

More complicated calendars can be passed as a string to calendar:setYear().

Technical details

The module defines three classes which do the work of setting up the sidebar and displaying the data provided by the calendar functions. These are the calendarBox class, which defines the sidebar; the calendar class, which holds the data for one calendar; and the calendarGroup object, which defines a group of calendar objects with a heading.

To load these classes from another module, use the following:

<syntaxhighlight lang="lua">

local yearInOtherCalendars = require( 'Module:Year in various calendars' ) local calendarBox = yearInOtherCalendars.calendarBox local calendarGroup = yearInOtherCalendars.calendarGroup local calendar = yearInOtherCalendars.calendar

</syntaxhighlight>

calendarBox class

A calendarBox object is initiated with:

• year - sets the Gregorian year to base calendar calculations on. If not specified, the current year is used.
• footnotes - sets text to be displayed in a footnotes section at the bottom of the sidebar.
• navbar - sets the page name to be used by the navbar.

Calendar box objects have the following properties:

• calendarBox.year - the Gregorian year number. This is negative for BC years; for example, for the year 100 BC the value of calendarBox.year is -99. (BC years are calculated by "1 - n" rather than "0 - n", as there is no year zero.)
• calendarBox.yearText - the Gregorian year text. This is a string value of the format "n" for AD years and "n BC" for BC years.
• calendarBox.caption - the text of the box caption (the bold text that appears directly above the box). The default caption is the value of calendarBox.yearText.
• calendarBox.footnotes - the text of the box footnotes.
• calendarBox.navbar - the page name used by the navbar.

Calendar box objects have the following methods:

• calendarBox:setCaption( caption ) - sets the box caption (the bold text that appears directly above the box). The default caption is the value of calendarBox.yearText.
• calendarBox:addCalendar( obj ) - adds a calendar object or a calendar group object to the calendar box.
• calendarBox:addCalendarGroup( obj ) - an alias for myCalendarBox:addCalendar().
• calendarBox:export() - converts the calendar box object to wikicode. This calls calendar:export() and calendarGroup:export() to export calendar objects and calendar group objects.

calendar class

A calendar object is initiated with:

Calendar objects have the following properties:

• calendar.link - the link name.
• calendar.year - the year value. This is always a string value.

Calendar objects have the following methods:

• calendar:setLink( link, display ) - sets the link name for the calendar object. link is the name of Wikipedia's article about the calendar, and display is an optional display name for the article link.
• calendar:setRawLink( wikitext ) - sets the calendar link as raw wikitext.
• calendar:getLink() - gets the link value.
• calendar:setYear( year ) - sets the year value for the calendar. year can be a number or a string.
• calendar:setYearRange( startYear, endYear ) - sets the year value for the calendar as a year range. Both startYear and endYear must be number values.
• calendar:export() - exports the calendar to wikitext. If no link value was found, this returns nil. If a link was found but no year value was found, the calendar is output with a value of N/A for the year.

calendarGroup class

A calendarGroup object is initiated with:

• heading - the wikitext heading for the calendar group (e.g. [[Hindu calendar]]s).

Calendar group objects have one property:

• calendarGroup.heading - the calendar group heading text.

Calendar group objects have the following methods:

• calendarGroup:addCalendar( obj ) - adds a calendar object to the calendar group.
• calendarGroup:export() - converts a calendar group to wikitext. Calls calendar:export() to export individual calendar objects.

See also

{{Year in various calendars}}