Editing Module:Year in various calendars/doc (section)

==== calendarBox class ====

A <code>calendarBox</code> object is initiated with:

{{pre|
<nowiki>local myCalendarBox = calendarBox:new{ year = </nowiki>''yyyy''<nowiki>, footnotes = </nowiki>''footnotes''<nowiki>, navbar = </nowiki>''page name''<nowiki> }</nowiki>
}}
* <code>year</code> - sets the Gregorian year to base calendar calculations on. If not specified, the current year is used.
* <code>footnotes</code> - sets text to be displayed in a footnotes section at the bottom of the sidebar.
* <code>navbar</code> - sets the page name to be used by the [[Template:Navbar|navbar]].

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

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