Wikipedia>Gonnym: /* Examples */

2021-12-26T20:45:40Z

Examples

New page

{{tl|Module rating |}}

== Usage ==
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|calendar}}</code>

==Parameters==
===Calendar parameters===
*{{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:
*: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
*:keywords:
*::<code>current</code> – display 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
*{{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_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===
*{{para|float}} – position the rendered calendar; default position is at the left page margin:
*:<code>center</code> – middle of the page
*:<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|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|week_color}} – set background color for the day-abbreviations title bar; overrides {{para|color}}; alias: {{para|week_colour}}
*{{para|color}} – shorthand for both {{para|title_color}} and {{para|week_color}}; {{para|color}} yields to {{para|title_color}} and {{para|week_color}}; alias: {{para|colour}}
*{{para|wknum_color}} – set background color for ISO week numbers; alias: {{para|wknum_colour}}

===Linking parameters===
*{{para|lk}} – various date component linking options:
*:<code>d</code> – link days in calendar to calendar day of calendar month – <code><nowiki>[[</nowiki>{{CURRENTMONTHNAME}} {{CURRENTDAY}}]]</code>
*:<code>m</code> – link month in calendar header to month article – <code><nowiki>[[</nowiki>{{CURRENTMONTHNAME}}]] 2019</code>
*:<code>y</code> – link year in calendar header to year article – <code>{{CURRENTMONTHNAME}} <nowiki>[[</nowiki>{{CURRENTYEAR}}]]</code>
*:<code>dm</code> – link to days and month
*:<code>dy</code> – link to days and year
*:<code>my</code> – link to month and year
*:<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====
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_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_m}} – suffix for month links and composite month/year links
*{{para|lk_suff_y}} – suffix for year links
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}} – prefix for previous-month link
**{{para|lk_suff_mprev}} – suffix for previous-month link
**{{para|lk_pref_mnext}} – prefix for next-month link
**{{para|lk_suff_mnext}} – suffix for next-month link

=====Examples=====
if the current page and section is <code><nowiki>[[An example page#May]]</nowiki></code> and there is a May calendar there, to offer links to the previous month (April) and next month (June) sections set:
:{{para|k_pref_mprev|#}} – creates link to <code><nowiki>[[An example page#April]]</nowiki></code>
:{{para|k_pref_mnext|#}} – creates link to <code><nowiki>[[An example page#June]]</nowiki></code>
if the current page is a subpage <code><nowiki>[[An example page/May]]</nowiki></code> and there is a May calendar there, to offer links to the previous month and next month subpages set:
:{{para|k_pref_mprev|../}} – creates link to <code><nowiki>[[An example page/April]]</nowiki></code>
:{{para|k_pref_mnext|../}} – creates link to <code><nowiki>[[An example page/June]]</nowiki></code>
::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>{{Sandbox other||
[[Category:Time, date and calendar modules]]
}}</includeonly>

Module:Calendar widget/doc - Revision history

Wikipedia>Gonnym: /* Examples */