Module:Calendar widget/doc explained

Usage

Parameters

Calendar parameters

• – 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
• – specifies the month to be used when creating an stand-alone month calendar in the year specified by ; accepts a variety values:

numbers 1 to 12 – defaults to current month when month number is out of range

month names (January, March, etc) – defaults to current month when month name is not recognized

keywords:

current – display the current month

last – display the month that occurs before the current month

next – display the month that occurs after the current month

• – yearly calendars only; number of columns {{var|n}} to be used for calendar rendering; default is 4; values of {{var|n}} less than 1 or greater than 12 ignored
• – accepts the single value yes; calendar renders in ISO week format (Monday through Sunday); not needed if set
• – accepts the single value yes; calendar renders in ISO week format (Monday through Sunday) with ISO week number in the left column; setting automatically sets

Styling parameters

• – position the rendered calendar; default position is at the left page margin:

center – middle of the page

right – at the right page margin

• – accepts the single value yes; suppresses display of year in calendar headers; alias
• – accepts the single value yes; highlights the current date in the current-month calendar
• – set the highlight color used by ; alias:
• – set background color for the month title bar; overrides ; alias:
• – set background color for the day-abbreviations title bar; overrides ; alias:
• – shorthand for both and ; yields to and ; alias:
• – set background color for ISO week numbers; alias:

Linking parameters

• – various date component linking options:

d – link days in calendar to calendar day of calendar month – <nowiki>[[</nowiki>{{CURRENTMONTHNAME}} {{CURRENTDAY}}]]

m – link month in calendar header to month article – <nowiki>[[</nowiki>{{CURRENTMONTHNAME}}]] 2019

y – link year in calendar header to year article – {{CURRENTMONTHNAME}} <nowiki>[[</nowiki>{{CURRENTYEAR}}]]

dm – link to days and month

dy – link to days and year

my – link to month and year

yes – individually link all date components

m&y – stand-alone month calendars only; link month and year together as a single composite link – <nowiki>[[</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]

dm&y – stand-alone month calendars only; link to days and composite month/year

Link prefixes and suffixes

These parameters require :

• – prefix for all day, month, and year links enabled by ; yields to specific parameters
• – suffix for all day, month, and year links enabled by ; yields to specific parameters

These parameters automatically set to the appropriate value; override values assigned to and :

• – prefix for day links
• – prefix for month and composite month/year links
• – prefix for year links
• – suffix for day links
• – suffix for month links and composite month/year links
• – suffix for year links

For stand-alone month calendars only, links to previous- and next-month targets:

• – accepts the single value yes; adds generic << and >> links to month header linked to the preceding and next month articles; automatically set if any of the following parameters are set:
  • – prefix for previous-month link
  • – suffix for previous-month link
  • – prefix for next-month link
  • – suffix for next-month link

Examples

if the current page and section is <nowiki>[[An example page#May]]</nowiki> and there is a May calendar there, to offer links to the previous month (April) and next month (June) sections set:

– creates link to <nowiki>[[An example page#April]]</nowiki>

– creates link to <nowiki>[[An example page#June]]</nowiki>if the current page is a subpage <nowiki>[[An example page/May]]</nowiki> and there is a May calendar there, to offer links to the previous month and next month subpages set:

– creates link to <nowiki>[[An example page/April]]</nowiki>

– creates link to <nowiki>[[An example page/June]]</nowiki>

in ../, .. is the parent (<nowiki>[[An example page]]</nowiki>) and / is the required path separator; see Uniform Resource Identifier