Module:Calendar widget/doc

Module rating

Calendar parameters

 * year – specifies the year to be used when creating a monthly or yearly calendar; Gregorian calendar only; minimum 1583 for yearly calendar; minimum October 1582 for stand-alone month calendar; when omitted or out of range, uses current year
 * month – specifies the month to be used when creating an stand-alone month calendar in the year specified by year; accepts a variety values:
 * numbers  to   – defaults to current month when month number is out of range
 * month names (, , etc) – defaults to current month when month name is not recognized
 * keywords:
 * – display the current month
 * – display the month that occurs before the current month
 * – display the month that occurs after the current month
 * cols – yearly calendars only; number of columns  to be used for calendar rendering; default is  ; values of   less than 1 or greater than 12 ignored
 * iso – accepts the single value ; calendar renders in ISO week format (Monday through Sunday); not needed if iso_wk set
 * iso_wk – accepts the single value ; calendar renders in ISO week format (Monday through Sunday) with ISO week number in the left column; setting yes automatically sets yes

Styling parameters

 * float – position the rendered calendar; default position is at the left page margin:
 * – middle of the page
 * – at the right page margin
 * hide_year – accepts the single value ; suppresses display of year in calendar headers; alias off
 * show_today – accepts the single value ; highlights the current date in the current-month calendar
 * today_color – set the highlight color used by show-today; alias: today_colour
 * title_color – set background color for the month title bar; overrides color; alias: title_colour
 * week_color – set background color for the day-abbreviations title bar; overrides color; alias: week_colour
 * color – shorthand for both title_color and week_color; color yields to title_color and week_color; alias: colour
 * wknum_color – set background color for ISO week numbers; alias: wknum_colour

Linking parameters

 * lk – various date component linking options:
 * – link days in calendar to calendar day of calendar month –
 * – link month in calendar header to month article –
 * – link year in calendar header to year article –
 * – link to days and month
 * – link to days and year
 * – link to month and year
 * – individually link all date components
 * – stand-alone month calendars only; link month and year together as a single composite link –
 * – stand-alone month calendars only; link to days and composite month/year

Link prefixes and suffixes
These parameters require lk: These parameters automatically set lk to the appropriate value; override values assigned to lk_pref and lk_suff: For stand-alone month calendars only, links to previous- and next-month targets:
 * lk_pref – prefix for all day, month, and year links enabled by lk; yields to specific lk_pref_x parameters
 * lk_suff – suffix for all day, month, and year links enabled by lk; yields to specific lk_suff_x parameters
 * lk_pref_d – prefix for day links
 * lk_pref_m – prefix for month and composite month/year links
 * lk_pref_y – prefix for year links
 * lk_suff_d – suffix for day links
 * lk_suff_m – suffix for month links and composite month/year links
 * lk_suff_y – suffix for year links
 * prevnext – accepts the single value ; adds generic < > links to month header linked to the preceding and next month articles; automatically set if any of the following parameters are set:
 * lk_pref_mprev – prefix for previous-month link
 * lk_suff_mprev – suffix for previous-month link
 * lk_pref_mnext – prefix for next-month link
 * lk_suff_mnext – suffix for next-month link

Examples
if the current page and section is  and there is a May calendar there, to offer links to the previous month (April) and next month (June) sections set:
 * – creates link to
 * – creates link to

if the current page is a subpage  and there is a May calendar there, to offer links to the previous month and next month subpages set:
 * ../ – creates link to
 * ../ – creates link to
 * in,   is the parent  and   is the required path separator; see Uniform Resource Identifier