Module:Calendar widget/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:31:51Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:31, 29 August 2024
Line 73:		Line 73:
	[[Category:Time, date and calendar modules]]		[[Category:Time, date and calendar modules]]
	}}</includeonly>		}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

JPxG: /* Usage */

2024-02-13T22:35:09Z

Usage

← Previous revision		Revision as of 22:35, 13 February 2024
Line 2:		Line 2:
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	== Usage ==		== Usage ==
	syntaxhighlight lang="wikitext">{{#invoke:Calendar widget\|calendar}}</syntaxhighlight>		<syntaxhighlight lang="wikitext">{{#invoke:Calendar widget\|calendar}}</syntaxhighlight>
	{{#invoke:Calendar widget\|calendar}}		{{#invoke:Calendar widget\|calendar}}

JPxG: /* Usage */

2024-02-13T22:34:56Z

Usage

← Previous revision		Revision as of 22:34, 13 February 2024
Line 2:		Line 2:
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	== Usage ==		== Usage ==
	~~<code><nowiki~~>{{~~</nowiki>~~#invoke:~~{{BASEPAGENAME}}~~\|calendar}}</~~code~~>		syntaxhighlight lang="wikitext">{{#invoke:Calendar widget\|calendar}}</syntaxhighlight>
			{{#invoke:Calendar widget\|calendar}}

	==Parameters==		==Parameters==

Gonnym: /* Examples */

2021-12-26T20:45:40Z

Examples

← Previous revision		Revision as of 20:45, 26 December 2021
Line 69:		Line 69:
	::in <code>../</code>, <code>..</code> is the parent (<code><nowiki>[[An example page]]</nowiki></code>) and <code>/</code> is the required path separator; see [[Uniform Resource Identifier]]		::in <code>../</code>, <code>..</code> is the parent (<code><nowiki>[[An example page]]</nowiki></code>) and <code>/</code> is the required path separator; see [[Uniform Resource Identifier]]

	<includeonly>{{~~#ifeq:{{SUBPAGENAME}}\|sandbox~~ \| \|		<includeonly>{{Sandbox other\|\|
			[[Category:Time, date and calendar modules]]
	<!-- Categories below this line, please; interwikis at Wikidata -->

	}}</includeonly>		}}</includeonly>

Trappist the monk: /* Linking parameters */

2019-07-09T14:34:44Z

Linking parameters

← Previous revision		Revision as of 14:34, 9 July 2019
Line 43:		Line 43:

	====Link prefixes and suffixes====		====Link prefixes and suffixes====
			These parameters require {{para\|lk}}:
			*{{para\|lk_pref}} – prefix for all day, month, and year links enabled by {{para\|lk}}; yields to specific {{para\|lk_pref_{{var\|x}}}} parameters
			*{{para\|lk_suff}} – suffix for all day, month, and year links enabled by {{para\|lk}}; yields to specific {{para\|lk_suff_{{var\|x}}}} parameters
			These parameters automatically set {{para\|lk}} to the appropriate value; override values assigned to {{para\|lk_pref}} and {{para\|lk_suff}}:
	*{{para\|lk_pref_d}} – prefix for day links		*{{para\|lk_pref_d}} – prefix for day links
	*{{para\|lk_pref_m}} – prefix for month and composite month/year links		*{{para\|lk_pref_m}} – prefix for month and composite month/year links
Line 49:		Line 53:
	*{{para\|lk_suff_m}} – suffix for month links and composite month/year links		*{{para\|lk_suff_m}} – suffix for month links and composite month/year links
	*{{para\|lk_suff_y}} – suffix for year links		*{{para\|lk_suff_y}} – suffix for year links
	*{{para\|prevnext}} – stand-alone month calendars only~~; accepts the single value <code>yes</code>; adds generic << and >>~~ links to ~~month header linked to the preceding~~ and next month ~~articles~~		For stand-alone month calendars only, links to previous- and next-month targets:
			*{{para\|prevnext}} – accepts the single value <code>yes</code>; 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:
	*{{para\|lk_pref_mprev}} – stand-alone month calendars only; prefix for previous-month link
	*{{para\|~~lk_suff_mprev~~}} – ~~stand-alone month calendars only; suffix~~ for previous-month link		**{{para\|lk_pref_mprev}} – prefix for previous-month link
	*{{para\|~~lk_pref_mnext~~}} – ~~stand-alone month calendars only; prefix~~ for ~~next~~-month link		**{{para\|lk_suff_mprev}} – suffix for previous-month link
	*{{para\|~~lk_suff_mnext~~}} – ~~stand-alone month calendars only; suffix~~ for next-month link		**{{para\|lk_pref_mnext}} – prefix for next-month link
			**{{para\|lk_suff_mnext}} – suffix for next-month link

	=====Examples=====		=====Examples=====

Trappist the monk: /* Styling parameters */

2019-07-09T14:19:25Z

Styling parameters

← Previous revision		Revision as of 14:19, 9 July 2019
Line 23:		Line 23:
	*:<code>right</code> – at the right page margin		*:<code>right</code> – at the right page margin
	*{{para\|hide_year}} – accepts the single value <code>yes</code>; suppresses display of year in calendar headers; alias {{para\|show_year\|off}}		*{{para\|hide_year}} – accepts the single value <code>yes</code>; suppresses display of year in calendar headers; alias {{para\|show_year\|off}}
	*{{para\|~~show-today~~}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar		*{{para\|show_today}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar
	*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}		*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}
	*{{para\|title_color}} – set background color for the month title bar; overrides {{para\|color}}; alias: {{para\|title_colour}}		*{{para\|title_color}} – set background color for the month title bar; overrides {{para\|color}}; alias: {{para\|title_colour}}

Trappist the monk: /* Calendar parameters */

2019-07-09T14:18:59Z

Calendar parameters

← Previous revision		Revision as of 14:18, 9 July 2019
Line 6:		Line 6:
	==Parameters==		==Parameters==
	===Calendar parameters===		===Calendar parameters===
	*{{para\|year}} – specifies the year to be used when creating a monthly or yearly calendar; when omitted uses current year		*{{para\|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
	*{{para\|month}} – specifies the month to be used when creating an stand-alone month calendar in the year specified by {{para\|year}}; accepts a variety values:		*{{para\|month}} – specifies the month to be used when creating an stand-alone month calendar in the year specified by {{para\|year}}; accepts a variety values:
	*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range		*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range
Line 15:		Line 15:
	*::<code>next</code> – display the month that occurs after the current month		*::<code>next</code> – display the month that occurs after the current month
	*{{para\|cols}} – yearly calendars only; number of columns <code>{{var\|n}}</code> to be used for calendar rendering; default is <code>4</code>; values of <code>{{var\|n}}</code> less than 1 or greater than 12 ignored		*{{para\|cols}} – yearly calendars only; number of columns <code>{{var\|n}}</code> to be used for calendar rendering; default is <code>4</code>; values of <code>{{var\|n}}</code> less than 1 or greater than 12 ignored
	*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday); not needed if {{para\|~~iso-wk~~}} set		*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday); not needed if {{para\|iso_wk}} set
	*{{para\|~~iso-wk~~}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|~~iso-wk~~\|yes}} automatically sets {{para\|iso\|yes}}		*{{para\|iso_wk}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|iso_wk\|yes}} automatically sets {{para\|iso\|yes}}

	===Styling parameters===		===Styling parameters===

Trappist the monk: /* Parameters */

2019-07-08T20:02:19Z

Parameters

← Previous revision		Revision as of 20:02, 8 July 2019
Line 7:		Line 7:
	===Calendar parameters===		===Calendar parameters===
	*{{para\|year}} – specifies the year to be used when creating a monthly or yearly calendar; when omitted uses current year		*{{para\|year}} – specifies the year to be used when creating a monthly or yearly calendar; when omitted uses current year
	*{{para\|month}} – specifies the month to be used when creating an ~~individual~~ month calendar in the year specified by {{para\|year}}; accepts a variety values:		*{{para\|month}} – specifies the month to be used when creating an stand-alone month calendar in the year specified by {{para\|year}}; accepts a variety values:
	*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range		*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range
	*:month names (<code>January</code>, <code>March</code>, etc) – defaults to current month when month name is not recognized		*:month names (<code>January</code>, <code>March</code>, etc) – defaults to current month when month name is not recognized
Line 14:		Line 14:
	*::<code>last</code> – display the month that occurs before the current month		*::<code>last</code> – display the month that occurs before the current month
	*::<code>next</code> – display the month that occurs after the current month		*::<code>next</code> – display the month that occurs after the current month
			*{{para\|cols}} – yearly calendars only; number of columns <code>{{var\|n}}</code> to be used for calendar rendering; default is <code>4</code>; values of <code>{{var\|n}}</code> less than 1 or greater than 12 ignored
	*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday); not needed if {{para\|iso-wk}} set		*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday); not needed if {{para\|iso-wk}} set
	*{{para\|iso-wk}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|iso-wk\|yes}} automatically sets {{para\|iso\|yes}}		*{{para\|iso-wk}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|iso-wk\|yes}} automatically sets {{para\|iso\|yes}}
Line 37:		Line 38:
	*:<code>dy</code> – link to days and year		*:<code>dy</code> – link to days and year
	*:<code>my</code> – link to month and year		*:<code>my</code> – link to month and year
	*:<code>yes</code> – link all date components		*:<code>yes</code> – individually link all date components
			*:<code>m&y</code> – stand-alone month calendars only; link month and year together as a single composite link – <code><nowiki>[[</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]</code>
			*:<code>dm&y</code> – stand-alone month calendars only; link to days and composite month/year

	====Link prefixes and suffixes====		====Link prefixes and suffixes====
	*{{para\|lk_pref_d}} – prefix for day links		*{{para\|lk_pref_d}} – prefix for day links
	*{{para\|lk_pref_m}} – prefix for month links		*{{para\|lk_pref_m}} – prefix for month and composite month/year links
			*{{para\|lk_pref_y}} – prefix for year links
	*{{para\|lk_suff_d}} – suffix for day links		*{{para\|lk_suff_d}} – suffix for day links
	*{{para\|lk_suff_m}} – suffix for month links		*{{para\|lk_suff_m}} – suffix for month links and composite month/year links
	*{{para\|prevnext}} – ~~individual~~ month calendars only; accepts the single value <code>yes</code>; adds generic << and >> links to month header linked to the preceding and next month articles		*{{para\|lk_suff_y}} – suffix for year links
			*{{para\|prevnext}} – stand-alone month calendars only; accepts the single value <code>yes</code>; adds generic << and >> links to month header linked to the preceding and next month articles
	*{{para\|lk_pref_mprev}} – ~~individual~~ month calendars only; prefix for previous-month link		*{{para\|lk_pref_mprev}} – stand-alone month calendars only; prefix for previous-month link
	*{{para\|lk_suff_mprev}} – ~~individual~~ month calendars only; suffix for previous-month link		*{{para\|lk_suff_mprev}} – stand-alone month calendars only; suffix for previous-month link
	*{{para\|lk_pref_mnext}} – ~~individual~~ month calendars only; prefix for next-month link		*{{para\|lk_pref_mnext}} – stand-alone month calendars only; prefix for next-month link
	*{{para\|lk_suff_mnext}} – ~~individual~~ month calendars only; suffix for next-month link		*{{para\|lk_suff_mnext}} – stand-alone month calendars only; suffix for next-month link

	=====Examples=====		=====Examples=====

Trappist the monk: /* Styling parameters */

2019-07-07T22:33:51Z

Styling parameters

← Previous revision		Revision as of 22:33, 7 July 2019
Line 21:		Line 21:
	*:<code>center</code> – middle of the page		*:<code>center</code> – middle of the page
	*:<code>right</code> – at the right page margin		*:<code>right</code> – at the right page margin
			*{{para\|hide_year}} – accepts the single value <code>yes</code>; suppresses display of year in calendar headers; alias {{para\|show_year\|off}}
	*{{para\|show-today}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar		*{{para\|show-today}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar
	*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}		*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}

Trappist the monk: /* Calendar parameters */

2019-07-07T22:01:52Z

Calendar parameters

← Previous revision		Revision as of 22:01, 7 July 2019
Line 7:		Line 7:
	===Calendar parameters===		===Calendar parameters===
	*{{para\|year}} – specifies the year to be used when creating a monthly or yearly calendar; when omitted uses current year		*{{para\|year}} – specifies the year to be used when creating a monthly or yearly calendar; when omitted uses current year
	*{{para\|month}} – specifies the month to be used when creating a ~~monthly~~ calendar in the year specified by {{para\|year}}; accepts a variety values:		*{{para\|month}} – specifies the month to be used when creating an individual month calendar in the year specified by {{para\|year}}; accepts a variety values:
	*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range		*:numbers <code>1</code> to <code>12</code> – defaults to current month when month number is out of range
	*:month names (<code>January</code>, <code>March</code>, etc) – defaults to current month when month name is not recognized		*:month names (<code>January</code>, <code>March</code>, etc) – defaults to current month when month name is not recognized
	*:keywords:		*:keywords:
	*::<code>current</code> – display ~~this~~ current month		*::<code>current</code> – display the current month
	*::<code>last</code> – display the month that occurs before the ~~present~~ month		*::<code>last</code> – display the month that occurs before the current month
	*::<code>next</code> – display the month that occurs after the ~~present~~ month		*::<code>next</code> – display the month that occurs after the current month
	*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday)		*{{para\|iso}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday); not needed if {{para\|iso-wk}} set
	*{{para\|iso-wk}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|iso-wk\|yes}} automatically sets {{para\|iso\|yes}}		*{{para\|iso-wk}} – accepts the single value <code>yes</code>; calendar renders in [[ISO week]] format (Monday through Sunday) with ISO week number in the left column; setting {{para\|iso-wk\|yes}} automatically sets {{para\|iso\|yes}}

← Previous revision		Revision as of 14:34, 9 July 2019
Line 43:		Line 43:

	====Link prefixes and suffixes====		====Link prefixes and suffixes====
			These parameters require {{para\|lk}}:
			*{{para\|lk_pref}} – prefix for all day, month, and year links enabled by {{para\|lk}}; yields to specific {{para\|lk_pref_{{var\|x}}}} parameters
			*{{para\|lk_suff}} – suffix for all day, month, and year links enabled by {{para\|lk}}; yields to specific {{para\|lk_suff_{{var\|x}}}} parameters
			These parameters automatically set {{para\|lk}} to the appropriate value; override values assigned to {{para\|lk_pref}} and {{para\|lk_suff}}:
	*{{para\|lk_pref_d}} – prefix for day links		*{{para\|lk_pref_d}} – prefix for day links
	*{{para\|lk_pref_m}} – prefix for month and composite month/year links		*{{para\|lk_pref_m}} – prefix for month and composite month/year links
Line 49:		Line 53:
	*{{para\|lk_suff_m}} – suffix for month links and composite month/year links		*{{para\|lk_suff_m}} – suffix for month links and composite month/year links
	*{{para\|lk_suff_y}} – suffix for year links		*{{para\|lk_suff_y}} – suffix for year links
	*{{para\|prevnext}} – stand-alone month calendars only~~; accepts the single value <code>yes</code>; adds generic << and >>~~ links to ~~month header linked to the preceding~~ and next month ~~articles~~		For stand-alone month calendars only, links to previous- and next-month targets:
			*{{para\|prevnext}} – accepts the single value <code>yes</code>; 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:
	*{{para\|lk_pref_mprev}} – stand-alone month calendars only; prefix for previous-month link
	*{{para\|~~lk_suff_mprev~~}} – ~~stand-alone month calendars only; suffix~~ for previous-month link		**{{para\|lk_pref_mprev}} – prefix for previous-month link
	*{{para\|~~lk_pref_mnext~~}} – ~~stand-alone month calendars only; prefix~~ for ~~next~~-month link		**{{para\|lk_suff_mprev}} – suffix for previous-month link
	*{{para\|~~lk_suff_mnext~~}} – ~~stand-alone month calendars only; suffix~~ for next-month link		**{{para\|lk_pref_mnext}} – prefix for next-month link
			**{{para\|lk_suff_mnext}} – suffix for next-month link

	=====Examples=====		=====Examples=====

← Previous revision		Revision as of 14:19, 9 July 2019
Line 23:		Line 23:
	*:<code>right</code> – at the right page margin		*:<code>right</code> – at the right page margin
	*{{para\|hide_year}} – accepts the single value <code>yes</code>; suppresses display of year in calendar headers; alias {{para\|show_year\|off}}		*{{para\|hide_year}} – accepts the single value <code>yes</code>; suppresses display of year in calendar headers; alias {{para\|show_year\|off}}
	*{{para\|~~show-today~~}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar		*{{para\|show_today}} – accepts the single value <code>yes</code>; highlights the current date in the current-month calendar
	*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}		*{{para\|today_color}} – set the highlight color used by {{para\|show-today}}; alias: {{para\|today_colour}}
	*{{para\|title_color}} – set background color for the month title bar; overrides {{para\|color}}; alias: {{para\|title_colour}}		*{{para\|title_color}} – set background color for the month title bar; overrides {{para\|color}}; alias: {{para\|title_colour}}