Help/CalendarPlugin

Note: You are viewing an old revision of this page. View the current version.

The Calendar plugin can be used to generate a monthly calendar in a wiki page. It's handy for personal wikis.

Individual dates in the calendar link to specially named wiki pages. The names for the “day pages” are by default formed by appending the date to the pagename on which the calendar appears.

Usage

<<Calendar>>

will get you:

< November 2024 >
Mon Tue Wed Thu Fri Sat Sun
 1   2   3 
 4   5   6   7   8   9   10 
 11   12   13   14   15   16   17 
 18   19   20   21   22   23   24 
 25   26   27   28   29   30 

Arguments

Argument

Description

Default value

Selection of Month

year

Specify the year for the calendar.

Current year

month

Specify the month for the calendar.

Current month

month_offset

Added to month. Can be used to include several months worth of calendars on a single wiki page.

0

“Day Page” Names

date_format

strftime style format string used to generate page names for the “day pages.”

The default value is %Y-%m-%d.

prefix

Prepended to the date (formatted per date_format) to generate the “day page” names.

The default value is [pagename]/.

Appearance

month_format

strftime style format string used to generate the title of the calendar.

(Default: %B %Y.)

wday_format

strftime style format string used to generate the day-of-week names at the top of the calendar.

start_wday

What day of the week does the calendar start on. This should be specified as an integer in the range zero (Sunday) through six (Saturday), inclusive.

Examples

<<Calendar month_offset=+1>>

will get you:

< December 2024 >
Mon Tue Wed Thu Fri Sat Sun
 1 
 2   3   4   5   6   7   8 
 9   10   11   12   13   14   15 
 16   17   18   19   20   21   22 
 23   24   25   26   27   28   29 
 30   31  
<<Calendar start_wday=0>>

will get you:

< November 2024 >
Sun Mon Tue Wed Thu Fri Sat
 1   2 
 3   4   5   6   7   8   9 
 10   11   12   13   14   15   16 
 17   18   19   20   21   22   23 
 24   25   26   27   28   29   30 

See Also

Often used together like this:

<<Calendar>>
<<CalendarList>>

Authors

This feature was inspired by Calendar, and first implemented by Gary Benson. It was later implemented as a plugin by Jeff Dairiki.