Template:Calendar/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

This template displays either a yearly or monthly calendar (from 1970–2037).

Parameters

month
To display a single month the parameter month must be defined. This parameter can be a month name or number, the current month use month=current (next and last are also accepted).
year
The parameter year sets the year of the calendar the default being the current year.
format
To start the week on Monday use either format=Mon1st or, to include ISO week numbers, format=iso. The keywords are case-sensitive.
December
Wk Mo Tu We Th Fr Sa Su
48 01
49 02 03 04 05 06 07 08
50 09 10 11 12 13 14 15
51 16 17 18 19 20 21 22
52 23 24 25 26 27 28 29
01 30 31  
2024
show_year
To display the year use show_year=on. To show the year after the month use show_year=with month.
txt_pref_m
This adds a prefix to the month name.
txt_suff_m
This adds a suffix to the month name.
float
To float the calendar left or right use float=left or float=right.
lk
To link days, months and years use lk=on.
To link days and months use lk=dm.
To link months and years use lk=my.
To link days and years use lk=dy.
To link days only use lk=d.
To link months only use lk=m.
To link years only use lk=y.
lk_pref
This adds a prefix to all links.
lk_pref_d
This adds a prefix to day links.
lk_pref_m
This adds a prefix to month links.
lk_pref_mnext
This adds a prefix to the next month's link.
lk_pref_mprev
This adds a prefix to the previous month's link.
lk_suff
This adds a suffix to all links.
lk_suff_d
This adds a suffix to day links.
lk_suff_m
This adds a suffix to month links.
lk_suff_mnext
This adds a suffix to the next month's link.
lk_suff_mprev
This adds a suffix to the previous month's link.
prevnext
To add links to the previous and next months use prevnext=on.
title_colour
Use this to change the background colour of the title bar with name of the month, and the bottom bar (e.g. title_colour=#2e8b57).
week_colour
Use this to change the colour of the bar listing the days of the week (e.g. week_colour=#2e8b57).
colour
This is shorthand for both of the above.
wknum_colour
Use this to change the background colour of the ISO week numbers, when using format=iso (e.g. wknum_colour=#2e8b57).
wk5253
Use wk5253=on to start the year with week 52/53, when using format=iso with a year calendar. The only use case for this, is when the year is unknown and it starts with a Saturday. See Common year starting on Saturday as an example.
EndNote
This adds text to the bottom bar.
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Calendar in articles based on its TemplateData.

TemplateData for Calendar

<templatedata>{ "description": "Display a year or month calendar", "params": {

"year": {

"label": "Year",
"description": "the ordinal year number of the calendar",
"suggested": true,
"default": "current",
"type": "number"

},

"month": {

"label": "Month",
"description": "whether to display a single month instead of a whole year, and which one",
"example": "current, next, last, 1, January",
"default": "empty",
"suggested": true,
"type": "string"

},

"show_year": {

"label": "Show year",
"description": "whether to display the year number, and where",
"example": "with month, off",
"default": "on",
"type": "boolean"

},

"title": {

"label": "Title text",
"description": "text in the top bar",
"type": "content"

},

"EndNote": {

"label": "End note",
"description": "text in the bottom bar",
"type": "content"

},

"format": {

"label": "Week format",
"description": "The string to be trimmed and counted",
"example": "iso, Mon1st",
"default": "Sun1st",
"type": "string"

},

"col": {

"label": "Months per row",
"description": "Display this many months per row (1, 3, 4 or 6 rows)",
"example": "2, 3, 12",
"default": "4",
"type": "number"

},

"row": {

"label": "Months per column",
"description": "Display this many months per column (3 or 4 cols). If set, overrides ‘col’ parameter.",
"example": "3, 4",
"default": "empty",
"type": "number"

},

"float": {

"label": "Float side",
"description": "Horizontally align the calendar",
"example": "right, left",
"default": "none",
"required": false,
"type": "string"

},

"prevnext": {

"label": "Serial navigation",
"description": "Add links to the previous and next months",
"example": "on",
"type": "boolean"

},

"colour": {

"label": "Background color",
"description": "Default for Title and Week background",
"example": "#2E8B57",
"type": "string"

},

"title_colour": {

"label": "Title background",
"description": "change the background colour of the title bar with name of the month, and the bottom bar",
"inherits": "colour"

},

"week_colour": {

"label": "Week background",
"description": "change the colour of the bar listing the days of the week",
"inherits": "colour"

},

"wknum_colour": {

"label": "ISO week numbers background",
"description": "change the colour of the bar listing the ISO week numbers",
"inherits": "colour"

},

"wk5253": {

"label": "Fixed starting week workaround",
"description": "start the year with week 52/53, when the first day is a Saturday.",
"required": false,
"type": "boolean"

},

"txt_pref_m": {

"label": "Month name prefix",
"description": "Text to add before month names",
"required": false,
"type": "line"

},

"txt_suff_m": {

"label": "Month name suffix",
"description": "Text to add after month names",
"inherits": "txt_pref_m"

},

"lk": {

"label": "Link",
"description": "whether to automatically link days (d), months (m) and years (y)",
"example": "on = dmy, dm, my, dy, d, m, y",
"default": "off",
"required": false,
"type": "string"

},

"lk_pref": {

"label": "Link prefix",
"description": "Text to add before all links",
"inherits": "txt_pref_m"

},

"lk_suff": {

"label": "Link suffix",
"description": "Text to add after all links",
"inherits": "txt_pref_m"

},

"lk_pref_d": {

"label": "Day link prefix",
"description": "Text to add before links to days",
"inherits": "txt_pref_m"

},

"lk_suff_d": {

"label": "Day link suffix",
"description": "Text to add after links to days",
"inherits": "txt_pref_m"

},

"lk_pref_m": {

"label": "Month link prefix",
"description": "Text to add before links to months",
"inherits": "txt_pref_m"

},

"lk_suff_m": {

"label": "Month link suffix",
"description": "Text to add after links to months",
"inherits": "txt_pref_m"

},

"lk_pref_mnext": {

"label": "Next link prefix",
"description": "Text to add before the link to the next month (or year)",
"inherits": "txt_pref_m"

},

"lk_suff_mnext": {

"label": "Next link suffix",
"description": "Text to add after the link to the next month (or year)",
"inherits": "txt_pref_m"

},

"lk_pref_mprev": {

"label": "Previous link prefix",
"description": "Text to add before the link to the previous month (or year)",
"inherits": "txt_pref_m"

},

"lk_suff_mprev": {

"label": "Previous link suffix",
"description": "Text to add after the link to the next month (or year)",
"inherits": "txt_pref_m"

}

}}</templatedata>

Examples

{{calendar|lk=on|show_year=on|float=right|month=current}} produces the calendar above. The calendars below are produced by {{calendar}} and {{calendar|prevnext=true|format=iso|zero=0|row=3}}, respectively.

2024
January
Su Mo Tu We Th Fr Sa
01 02 03 04 05 06
07 08 09 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31  
 
February
Su Mo Tu We Th Fr Sa
01 02 03
04 05 06 07 08 09 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29
 
March
Su Mo Tu We Th Fr Sa
01 02
03 04 05 06 07 08 09
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
31  
April
Su Mo Tu We Th Fr Sa
01 02 03 04 05 06
07 08 09 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30  
 
May
Su Mo Tu We Th Fr Sa
01 02 03 04
05 06 07 08 09 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31  
 
June
Su Mo Tu We Th Fr Sa
01
02 03 04 05 06 07 08
09 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30  
July
Su Mo Tu We Th Fr Sa
01 02 03 04 05 06
07 08 09 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31  
 
August
Su Mo Tu We Th Fr Sa
01 02 03
04 05 06 07 08 09 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29 30 31
 
September
Su Mo Tu We Th Fr Sa
01 02 03 04 05 06 07
08 09 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30  
 
October
Su Mo Tu We Th Fr Sa
01 02 03 04 05
06 07 08 09 10 11 12
13 14 15 16 17 18 19
20 21 22 23 24 25 26
27 28 29 30 31  
 
November
Su Mo Tu We Th Fr Sa
01 02
03 04 05 06 07 08 09
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
 
December
Su Mo Tu We Th Fr Sa
01 02 03 04 05 06 07
08 09 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31  
 
2024
January
Wk Mo Tu We Th Fr Sa Su
01 01 02 03 04 05 06 07
02 08 09 10 11 12 13 14
03 15 16 17 18 19 20 21
04 22 23 24 25 26 27 28
05 29 30 31  
   
February
Wk Mo Tu We Th Fr Sa Su
05 01 02 03 04
06 05 06 07 08 09 10 11
07 12 13 14 15 16 17 18
08 19 20 21 22 23 24 25
09 26 27 28 29  
   
March
Wk Mo Tu We Th Fr Sa Su
09 01 02 03
10 04 05 06 07 08 09 10
11 11 12 13 14 15 16 17
12 18 19 20 21 22 23 24
13 25 26 27 28 29 30 31
   
April
Wk Mo Tu We Th Fr Sa Su
14 01 02 03 04 05 06 07
15 08 09 10 11 12 13 14
16 15 16 17 18 19 20 21
17 22 23 24 25 26 27 28
18 29 30  
   
May
Wk Mo Tu We Th Fr Sa Su
18 01 02 03 04 05
19 06 07 08 09 10 11 12
20 13 14 15 16 17 18 19
21 20 21 22 23 24 25 26
22 27 28 29 30 31  
   
June
Wk Mo Tu We Th Fr Sa Su
22 01 02
23 03 04 05 06 07 08 09
24 10 11 12 13 14 15 16
25 17 18 19 20 21 22 23
26 24 25 26 27 28 29 30
   
July
Wk Mo Tu We Th Fr Sa Su
27 01 02 03 04 05 06 07
28 08 09 10 11 12 13 14
29 15 16 17 18 19 20 21
30 22 23 24 25 26 27 28
31 29 30 31  
   
August
Wk Mo Tu We Th Fr Sa Su
31 01 02 03 04
32 05 06 07 08 09 10 11
33 12 13 14 15 16 17 18
34 19 20 21 22 23 24 25
35 26 27 28 29 30 31  
   
September
Wk Mo Tu We Th Fr Sa Su
35 01
36 02 03 04 05 06 07 08
37 09 10 11 12 13 14 15
38 16 17 18 19 20 21 22
39 23 24 25 26 27 28 29
40 30  
October
Wk Mo Tu We Th Fr Sa Su
40 01 02 03 04 05 06
41 07 08 09 10 11 12 13
42 14 15 16 17 18 19 20
43 21 22 23 24 25 26 27
44 28 29 30 31  
   
November
Wk Mo Tu We Th Fr Sa Su
44 01 02 03
45 04 05 06 07 08 09 10
46 11 12 13 14 15 16 17
47 18 19 20 21 22 23 24
48 25 26 27 28 29 30
   
December
Wk Mo Tu We Th Fr Sa Su
48 01
49 02 03 04 05 06 07 08
50 09 10 11 12 13 14 15
51 16 17 18 19 20 21 22
52 23 24 25 26 27 28 29
01 30 31  

See also

Multiple units of time

Type Adjustable Current Last Next
Date and time {{time}} {{Currentdate}} (MDY)
{{Plain now}} (DMY)
{{Now}} (DMY in a complete sentence)
{{Simple now}}
Date only {{Dateonly}}
{{Datedow}}
(Has the day of the week)
{{Date}} (Chose format)
{{DATE}} (prefixed by date=)
{{TODAY}} (DMY)
{{Yesterday}}
{{Day-1}}
{{Tomorrow}}
{{Day+1}}
Month and year only {{Monthyear}} {{Monthyear-1}} {{Monthyear+1}}
Time only {{Timeonly}} {{CURRENTTIME}} (12 h format)
{{CURRENTTIME24}} (24 h format)
Banners {{Right now}}
(Blue with time and number of Wikipedia articles)
Timestamp {{Timestamp}}
(Format YYYYMMDDhhmmss)

Single units of time

Unit of time Adjustable Current Last Next
SECOND {{CURRENTSECOND}}
MINUTE {{CURRENTMINUTE}}
HOUR {{CURRENTHOUR}}
WEEK {{CURRENTWEEK}}
{{CURRENTWEEKOFMONTH}}
Day of Week {{DAYOFWEEK}} {{CURRENTDAYNAME}}
{{CURRENTWEEKDAYABBREV}}
{{CURRENTWEEKDAY}}
MONTH {{MONTHNAME}}
{{MONTHABBREV}}
{{MONTHNUMBER}}
{{MONTH}} (zero padded)
{{CURRENTMONTHNAME}}
{{CURRENTMONTHABBREV}}
{{CURRENTMONTH1}}
{{CURRENTMONTHDAYS}}
{{LASTMONTHNAME}} {{NEXTMONTHNAME}}
Day of Month {{CURRENTDAY}}
{{CURRENTDAY2}} (zero padded)
YEAR {{CURRENTYEARCC}}
{{CURRENTYEARYY}}
{{CURRENTISOYEAR}}
{{CURRENTYEAR}}
{{LASTYEAR}} {{NEXTYEAR}}
Day of Year {{CURRENTDAYOFYEAR}}
DECADE {{DECADE}} {{CURRENTDECADE}}
CENTURY {{CENTURY}} {{CURRENTCENTURY}}
MILLENNIUM {{MILLENNIUM}}

Date and time templates made for substitution:

Month:
{{Lmonth}} produces Nov
{{Nmonth}} produces Jan
{{LastMonth}} produces November 2024
{{NextMonth}} produces January 2025


Individual templates

Categories of templates