Calendar Plugin

Introduction

The CalendarPlugin handles the %CALENDAR% variable which 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.

Note: This Plugin does not observe topic permissions.

Syntax Rules

CALENDAR Parameters

Event Syntax

Events are defined by bullets with the following syntax:

Event formatting

For a table-style calendar, each day which has one or more events will have a list of the descriptions of those events. Each event description will be set in a small font. In other words, format is:

$old<br /><small>$description</small>

For a list-style calendar, if an event falls in the selected time period, then it is displayed (by default) as a bullet item with the date as dd Mmm yyyy In other words, datenumberformat is:

   * $day $mon $year

$old - $description

This displays the events in a form very similar to that in which they are specified (although specific to a particular date).

Multi-Day Event Formatting

The multidayformat option allows the description of each day of a multiday event to be displayed differently. This could be used to visually or textually annotate the description to indicate continuance from or to other days.

The option consists of a comma separated list of formats for each type of day in a multiday event:

first, middle, last, middle-unseen, last-unseen

Where:

• first is the format used when the first day of the event is displayed
• middle is the format used when the day being displayed is not the first or last day
• last is the format used when the last day of the event is displayed
• middle-unseen is the format used when the day being displayed is not the first or last day of the event, but the preceding days of the event have not been displayed. For example, if an event runs from 29 Apr to 2 May and a May calendar is being displayed, then this format would be used for 1 May.
• last-unseen is the format used when the day being displayed is the last day of the event, but the preceding days of the event have not been displayed. For example, if an event runs from 29 Apr to 1 May and a May calendar is being displayed, then this format would be used for 1 May. Note that in the previous example (event from 29 Apr to 2 May), this format would not be used for a May calendar because the event was "seen" on 1 May; so, the last format would be used for 2 May.

Within each format, date information for the current day can be substituted using the same format codes as accepted by %GMTIME%. An extension to these codes allows the date of the first and/or last day of the event to also be rendered.

• $first(format) will render the first date of the event according to format, where format is, again, a string of codes acceptable to %GMTIME%.
• $last(format) will render the last date of the event in the way just described for $first()

Missing formats will be filled in as follows:

• middle will be set to first
• last will be set to middle
• middle-unseen will be set to middle
• last-unseen will be set to last

Missing formats are different from empty formats. For example,

multidayformat="$description (until $last($day $month)),,"

specifies an empty format for middle and last. The result of this is that only the first day will be shown. Note that since an unspecified middle-unseen is set from the (empty) middle format, an event that begins prior to the calendar being displayed but ending in the current calendar will not be displayed. In contrast, multidayformat="$description" will simply display the description for each day of the event; all days (within the scope of the calendar) will be displayed.

The default format is to simply display the description of the event.

Examples

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %CALENDARPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Show a monthly calendar with highlighted events

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• How the cell content is formatted

      * #Set FORMAT = $old<br /><small>$description</small>

• Note: You can add settings of any of the recognized attributes (in upper case like SHOWWEEKDAYHEADERS). Examples are shown below:
  • #Set CELLALIGNMENT = center
  • #Set VCELLALIGNMENT = center
  • #Set WIDTH = 100%
  • #Set GMTOFFSET = +10
  • #Set SHOWWEEKDAYHEADERS = 0
  • #Set WEEKSTARTSONMONDAY = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins web (see below)
  • The Plugin uses the HTML::CalendarMonthSimple and Date::Calc CPAN packages (see http://www.cpan.org)
  • Install Date::Calc
  • Install HTML::CalendarMonthSimple
  • To avoid an annoying log message, change line 272 of CalendarMonthSimple.pm v1.25 by adding the section marked in RED :
    if ($self->year = $todayyear && $self->month = $todaymonth && defined $thisday && $thisday == $todaydate)
    • For earlier or later versions where the line number may be different, search for todayyear. It currently (v1.22-v1.25) only appears twice: once to declare and set it, once to use it. On the line that uses it, add the && defined $thisday as shown above. -- TWiki:Main.AngusRogerson - 16 Aug 2004
  • Unzip CalendarPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/CalendarPlugin.txt	Plugin topic
    data/TWiki/VarCALENDAR.txt	CALENDAR variable documentation topic
    lib/TWiki/Plugins/CalendarPlugin.pm	Plugin Perl module
    pub/TWiki/CalendarPlugin/exclam.gif	Image file

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:
  • You should see two calendars near the Event list above and a current month calendar below:

Plugin Info

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.NathanKerr, TWiki:Main.DavidBright, TWiki:Main.DanielRohde
Copyright:	© 2001 TWiki:Main.AndreaSterbini © 2002-2012 TWiki:Main.PeterThoeny © 2002-2012 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2012-12-03
Change History:
2012-12-03:	TWikibug:Item7020: Add VarCALENDAR with category; doc improvements -- TWiki:Main.PeterThoeny
2011-07-10:	TWikibug:Item6725: Change global package variables from "use vars" to "our" -- TWiki:Main.PeterThoeny
2011-02-18:	TWikibug:Item6650: Add cellspacing, cellpadding parameters; fix sharpborders="0" issue -- TWiki:Main.PeterThoeny
2011-02-17:	TWikibug:Item6649: Support anniversary, yearly, weekly and periodic events with ISO date format -- TWiki:Main.PeterThoeny
2011-02-16:	TWikibug:Item6649: Support exceptions with ISO date format -- TWiki:Main.PeterThoeny
2011-02-15:	TWikibug:Item6649: Support calendar events with ISO date format, such as 2011-02-15 -- TWiki:Main.PeterThoeny
V1.020:	TWiki:Main.DavidBright: Bug fix from TWiki:Main.MarcLangheinrich for multiday events that were not properly displayed because the first day occurred in the current month, but before the first day included in the list.
V1.019:	TWiki:Main.DavidBright: Added support for monthly repeaters specified as "L Fri" (last Friday in all months).
V1.018:	TWiki:Main.DavidBright: Added capability to display multiple months in one call, display events in a list, and provided for more extensive formatting of date and description of events.
V1.017:	TWiki:Main.DanielRohde: Added start and end date support for periodic repeaters; Added initlang patch by TWiki:Main.JensKloecker; Changed 'my' to 'local' so exceptions working again; Removed fetchxmap debug message; Fixed illegal date bug; Allowed month abbreviations in month attribute
V1.016:	TWiki:Main/DavidBright: Added support for anniversary events; changed "our" to "my" in module to support perl versions prior to 5.6.0
V1.015:	TWiki:Main.PatriceFournier: Added back support for preview showing unsaved events; Two loop fixes from TWiki:Main.DanielRohde
V1.014:	TWiki:Main.NathanKerr: Added start and end date support for weekly repeaters
V1.013:	TWiki:Main.MartinCleaver: Added multiple topic=web.topic parameters
V1.012:	TWiki:Main/PeterThoeny: Added missing doc of gmtoffset parameter (was deleted in V1.011)
V1.011:	TWiki:Main/PeterThoeny: Fixed deep recursion bug; preview shows now unsaved events; performance and resource improvements; documented most of HTML::CalendarMonthSimple attributes; TWiki:Main/PaulineCheung: Fixed uninitialized value in join
V1.010:	TWiki:Main/DanBoitnott: Fixed variable conflict in timezone code
V1.009:	TWiki:Main/DanBoitnott: Added ability to have event topics in other webs
V1.008:	TWiki:Main/AnthonPang: Added daynames attribute; TWiki:Main/JensKloecker: Added lang attribute; TWiki:Main/DanBoitnott: Added yearly, monthly, weekly, and periodic events and exceptions
V1.006:	TWiki:Main/DanBoitnott: Added monthly date support
V1.005:	TWiki:Main/AkimDemaille: handle date intervals (thanks!)
V1.004:	uses only HTML::CalendarMonthSimple, ISO dates, all possible settings, fixed month bug
V1.003:	introducing HTML::CalendarMonthSimple
V1.002:	TWiki:Main/ChristianSchultze: highlight today, relative month/year and debugging (thanks!)
V1.001:	delayed load of used packages
V1.000:	first release using only HTML::CalendarMonth
TWiki Dependency:	$TWiki::Plugins::VERSION 1.010
CPAN Dependencies:	CPAN:HTML::CalendarMonthSimple >= v1.23, CPAN:Date::Calc
Other Dependencies:	none
Perl Version:	5.000 and up
TWiki:Plugins/Benchmark:	GoodStyle 95%, FormattedSearch 97%, CalendarPlugin 88% with installed Plugin
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/CalendarPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/CalendarPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/CalendarPluginAppraisal

Related Topics: VarCALENDAR, TWikiPreferences, TWikiPlugins