Module:Year in various calendars/doc

नएँ कालदर्शक जोड़ना

यह मॉड्यूल इस प्रकार स्थापित किया गया है कि नए कालदर्शक आसानी से जोड़े जा सकें। बस मॉड्यूल कोड के "बिल्ड द बॉक्स" ("Build the box") अनुभाग तक स्क्रोल डाउन करें, और आप अपना कालदर्शक (कैलेण्डर) निम्न प्रकार जोड़ सकते हैं:

एक वर्ष दर्शाने के लिए:

    local myCalendar = calendar:new()
    myCalendar:setLink( 'मेरे कालदर्शक का लेख' ) -- कालदर्शक के विकिपीडिया लेख का नाम।
    myCalendar:setYear( year + 10 ) -- लुआ कोड जो आपके कालदर्शक के वर्ष को ग्रेगोरी कालदर्शक के वर्ष से जोड़ सके।
    box:addCalendar( myCalendar )

वर्षों की एक रेंज दर्शाने के लिए:

    local myCalendar = calendar:new()
    myCalendar:setLink( 'मेरे कालदर्शक का लेख' ) -- कालदर्शक के विकिपीडिया लेख का नाम।
    myCalendar:setYearRange( year + 10, year + 11 ) -- लुआ कोड जो वर्ष रेंज के शुरुआती और अन्तिम वर्ष को दर्शा सकें।
    box:addCalendar( myCalendar )

अधिक जटिल कालदर्शक पास कियें जा सकते हैं स्ट्रिंग के रूप में ताकि calendar:setYear() हो सके।

तकनीकी जानकारी

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:

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

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.

इन्हें भी देखें