Calendar

The CalendarPlugin handles the tag %CALENDAR% that inserts a monthly calendar in the page. Multiple topics can be specified as the source of the events, and these can be in any web. The calendar marks dates corresponding to the events.

Tags:

create new tag

Syntax Rules

You type	you get
%CALENDAR%	a monthly calendar for the current month/year, with events taken from the current topic
%CALENDAR{<attributes>}%	is the full syntax

Event Syntax

Events are defined by bullets with the following syntax:

Event type	Syntax	Example
Single:	* dd MMM yyyy - description	09 Dec 2002 - Expo
Interval:	* dd MMM yyyy - dd MMM yyyy - description	02 Feb 2002 - 04 Feb 2002 - Vacation
Yearly:	* dd MMM - description	05 Jun - Every 5th of June
	* w DDD MMM - description	2 Tue Mar - Every 2nd Tuesday of March
	* L DDD MMM - description	L Mon May - The last Monday of May
	* A dd MMM yyyy - description	A 20 Jul 1969 - First moon landing This style will mark anniversaries of an event that occurred on the given date. The description will have " (x)" appended to it, where "x" indicates how many years since the occurence of the first date. The first date is not annotated.
Monthly:	* w DDD - description	1 Fri - Every 1st Friday of the month
	* L DDD - description	L Mon - The last Monday of each month
	* dd - description	14 - The 14th of every month
Weekly:	* E DDD - description	E Wed - Every Wednesday
	* E DDD dd MMM yyyy - description	E Wed 27 Jan 2005 - Every Wednesday Starting 27 Jan 2005
	* E DDD dd MMM yyyy - dd MMM yyyy - description	E Wed 1 Jan 2005 - 27 Jan 2005 - Every Wednesday from 1 Jan 2005 through 27 Jan 2005 (inclusive)
Periodic:	* En dd MMM yyyy - description	E3 02 Dec 2002 - Every three days starting 02 Dec 2002
	* En dd MMM yyyy - dd MMM yyyy - description	E3 12 Apr 2005 - 31 Dec 2005 - Every three days from 12 Apr 2005 through 31 Dec 2005 (inclusive)
Exception:	Insert the following between the above syntax and the description: X { dd MMM yyyy, dd MMM yyyy - dd MMM yyyy }	1 Fri X { 01 Dec 2002, 06 Dec 2002 - 14 Dec 2002 } - Every first Friday except on the 01 Dec 2002 and between 06 Dec 2002 and 14 Dec 2002

Attributes recognized

Attribute	Meaning	Default
year="yyyy"	The year	Current year
year="+yy" or "-yy"	Relative year	Current year
month="mm"	The month	Current month
month="+mm" or "-mm"	relative month	Current month
gmtoffset="+/-hh"	Timezone expressed as number of hours offset from GMT	Server timezone
topic="TopicName"	Topic containing events	The topic containing the tag
topic="Web.TopicName1, Web.TopicName2"	Topics containing events	The topics containing the tags
web="Webname"	Web containing the event topic	The current web
lang="language"	Language: First few characters of "English", "Français", "Deutsch", "Español", "Português", "Nederlands", "Italiano", "Norsk", "Svenska", "Dansk", "suomi", "Magyar", "Polski	"English"
daynames="Mon¦Tue¦..."	Custom day names	"Monday¦Tuesday¦Wednesday¦Thursday¦ Friday¦Saturday¦Sunday"
header="..."	Text at the top of the calendar; use $m for current month, $y for year	Current month and year
weekstartsonmonday="1" or "0"	Flag to start week on Monday	"0" (Sunday)
showdatenumbers="0"	Show day numbers 1...31 in date cells. Note that showdatenumbers=1 means that HTML::CalendarMonthSimple will add the date numbers to the cells. If showdatenumbers=0, then the plugin adds the date numbers. The result of this is that a calendar will always show the date numbers.	"0" (except with aslist="1", see below)
showweekdayheaders="1"	Show the weekday headers	"0"
weekdayheadersbig="0"	If enabled, show weekday headers in bold cell headings	"1"
cellalignment="left"	Horizontal cell alignment of day cells: "left", "center", "right", "justify", "char"	"center"
vcellalignment="middle"	Vertical cell alignment of day cells: "top", "middle", "bottom", "baseline"	"top"
cellheight="n"	Height in pixels of each cell in the calendar	Minimum height needed
format="..."	How to highlight a date	See Event Formatting below
width="n" or "n%"	Width of calendar table in pixels or percent	Minimum width needed
border="n"	Border width of calendar table	"1"
nowrap="1" or "0"	Prevent cell content from wrapping	"0"
bgcolor="#nnnn"	Default background color of all cells unless redefined by other color settings below (use an HTML color-code like "#000000" as defined in StandardColors)	white
contentcolor="#nnnn"	Default content color of all cells unless redefined	black
headercolor="#nnnn"	Background color of the Month+Year header	The web bgcolor
headercontentcolor="#nnnn"	Content color of the Month+Year header	contentcolor setting
weekdayheadercolor="#nnnn"	Background color of weekdays' headers	bgcolor setting
weekdayheadercontentcolor= "#nnnn"	Content color of weekdays' headers	contentcolor setting
weekendheadercolor="#nnnn"	Background color of weekends' headers	bgcolor setting
weekendheadercontentcolor= "#nnnn"	Content color of weekends' headers	contentcolor setting
weekdaycolor="#nnnn"	Background color of weekday cells	bgcolor setting
weekdaycontentcolor="#nnnn"	Content color of weekday cells	contentcolor setting
weekendcolor="#nnnn"	Background of weekend cells	light gray
weekendcontentcolor="#nnnn"	Content color of weekend cells	contentcolor setting
todaycolor="#nnnn"	Background of today's cell	The web bgcolor
todaycontentcolor="#nnnn"	Content color of today's cell	contentcolor setting
and other attributes of HTML::CalendarMonthSimple
aslist	Controls whether events displayed in calendar style (aslist=0) or list style (aslist=1). Note that specifying aslist=1 forces showdatenumbers=1. This is done to ensure that the date number is formatted according to datenumberformat and that only the days that have an event are listed.	0
days	Specifies how many days of calendar data to list. Only valid if aslist=1.	1
months	Specifies how many months of calendars to display. Only valid if aslist=0.	1
datenumberformat	Specifies formatting for the date number in each cell. The formatting codes accepted are the same as those for the %GMTIME% variable.	'$day' (if aslist=0) ' * $day $mon $year' (if aslist=1)
todaydatenumberformat	Specifies formatting for the date number for the current day (today) in the calendar. The formatting codes accepted are the same as those for the %GMTIME% variable.	datenumberformat
multidayformat	Specifies formatting of the description for multi-day events. See Multi-Day Event Formatting for details.	$description

Links

• Related: HelpIndex, CalendarHolidays, PersonalCalendarTemplate, ProjectCalendarTemplate

This Topic Is Referenced By These Topics:
Related Links: CalendarHolidays, HelpIndex, JimCrum, JimCrumCalendar, JimCrumCalendarHistory, PersonalCalendarTemplate, ProjectCalendarTemplate

---

---

Was This Topic Useful to You?

Others rated this topic as shown. Please include your rating.

Choice

Select ...Very UsefulSomewhat UsefulNo OpinionNot Useful

Somewhat Useful (1) Very Useful (1)

Collaborating Authors and Reviewers: -- JimCrum - 28 May 2008