Difference between revisions of "Template:Calendar/doc"

Revision as of 06:30, 7 February 2018

This is a documentation subpage for Template:Calendar.
It contains usage information, categories and other content that is not part of the original template page.

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.

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	November
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
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 documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Calendar

Display a year or month calendar

Template parameters
Parameter		Description	Type	Status
Year	`year`	the ordinal year number of the calendar Default current	Number	suggested
Month	`month`	whether to display a single month instead of a whole year, and which one Default empty Example current, next, last, 1, January	String	suggested
Show year	`show_year`	whether to display the year number, and where Default on Example with month, off	Boolean	optional
Title text	`title`	text in the top bar	Content	optional
End note	`EndNote`	text in the bottom bar	Content	optional
Week format	`format`	The string to be trimmed and counted Default Sun1st Example iso, Mon1st	String	optional
Months per row	`col`	Display this many months per row (1, 3, 4 or 6 rows) Default 4 Example 2, 3, 12	Number	optional
Months per column	`row`	Display this many months per column (3 or 4 cols). If set, overrides ‘col’ parameter. Default empty Example 3, 4	Number	optional
Float side	`float`	Horizontally align the calendar Default none Example right, left	String	optional
Serial navigation	`prevnext`	Add links to the previous and next months Example on	Boolean	optional
Background color	`colour`	Default for Title and Week background Example #2E8B57	String	optional
Title background	`title_colour`	change the background colour of the title bar with name of the month, and the bottom bar Example #2E8B57	String	optional
Week background	`week_colour`	change the colour of the bar listing the days of the week Example #2E8B57	String	optional
ISO week numbers background	`wknum_colour`	change the colour of the bar listing the ISO week numbers Example #2E8B57	String	optional
Fixed starting week workaround	`wk5253`	start the year with week 52/53, when the first day is a Saturday.	Boolean	optional
Month name prefix	`txt_pref_m`	Text to add before month names	Line	optional
Month name suffix	`txt_suff_m`	Text to add after month names	Line	optional
Link	`lk`	whether to automatically link days (d), months (m) and years (y) Default off Example on = dmy, dm, my, dy, d, m, y	String	optional
Link prefix	`lk_pref`	Text to add before all links	Line	optional
Link suffix	`lk_suff`	Text to add after all links	Line	optional
Day link prefix	`lk_pref_d`	Text to add before links to days	Line	optional
Day link suffix	`lk_suff_d`	Text to add after links to days	Line	optional
Month link prefix	`lk_pref_m`	Text to add before links to months	Line	optional
Month link suffix	`lk_suff_m`	Text to add after links to months	Line	optional
Next link prefix	`lk_pref_mnext`	Text to add before the link to the next month (or year)	Line	optional
Next link suffix	`lk_suff_mnext`	Text to add after the link to the next month (or year)	Line	optional
Previous link prefix	`lk_pref_mprev`	Text to add before the link to the previous month (or year)	Line	optional
Previous link suffix	`lk_suff_mprev`	Text to add after the link to the next month (or year)	Line	optional

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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	January
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	April
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	July
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	October
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	February
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	May
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	August
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	November
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	March
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	June
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	September
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

Wk	Mo	Tu	We	Th	Fr	Sa	Su
	December
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


Type	Adjustable	Current	Last	Next
Date and Time	{{time}}	{{Currentdate}} (MDY) {{Plain now}} (DMY) {{Now}} (Plan now in as sentence)
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}}
Time only	{{Timeonly}}	{{CURRENTTIME}} (12 h format) {{CURRENTTIME24}} (24 h format)
Banners		{{Right now}} (Blue with time and number of Wikipedia articles) {{Right now (User message)}} (Orange 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}}	{{Hour-1}}	{{Hour+1}}
WEEK		{{CURRENTWEEKOFYEAR}} {{CURRENTWEEKOFMONTH}}
Day of Week	{{Dow}}	{{CURRENTWEEKDAYNAME}} {{CURRENTWEEKDAYABBREV}} {{CURRENTWEEKDAY}}	{{LASTWEEKDAYNAME}} {{LASTWEEKDAYABBREV}}	{{NEXTWEEKDAYNAME}} {{NEXTWEEKDAYABBREV}}
MONTH	{{MONTHNAME}} {{MONTHABBREV}} {{MONTHNUMBER}} {{MONTH}} (zero padded)	{{Currentmonth}} {{CURRENTMONTHABBREV}} {{CURRENTMONTHNUMBER}} {{CURRENTMONTHDAYS}}	{{LASTMONTH}} (Can make not zero-padded) {{LASTMONTHNAME}} {{LASTMONTHABBR}}	{{NEXTMONTH}} (Can make not zero-padded) {{NEXTMONTHNAME}} {{NEXTMONTHABBR}}
Day of Month		{{Currentday}}
YEAR		{{CURRENTYEARCC}} {{CURRENTYEARYY}} {{CURRENTISOYEAR}} {{CURRENTYEAR}}	{{LASTYEAR}}	{{NEXTYEAR}}
Day of Year		{{CURRENTDAYOFYEAR}}
CENTURY	{{CENTURY}}	{{CURRENTCENTURY}}	{{LASTCENTURY}}	{{NEXTCENTURY}}
MILLENNIUM	{{MILLENNIUM}}	{{Currentmillennium}}

Date and time Templates made for substitution:

Month:
{{Lmonth}} produces Oct
{{Nmonth}} produces Dec
{{LastMonth}} produces October 2024
{{NextMonth}} produces December 2024

Individual Templates

Categories of Templates

Difference between revisions of "Template:Calendar/doc"

Revision as of 06:30, 7 February 2018

Parameters

Examples

See also

Multiple units of time

Single units of time

Date and time Templates made for substitution:

Individual Templates

Categories of Templates

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Nordiclarp.org

Navigation

Tools