| Name | Calendar Plugin |
|---|---|
| Vendor | Atlassian Software Systems (Website) |
| Authors | David Peterson, Mike Cannon-Brookes, Jens Schumacher, Jeremy Higgs, Dan Hardiker, James Matheson, Swee Wan Tan, Richard Wallace |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Calendar+Plugin |
| Issue Management | http://developer.atlassian.com/jira/browse/CAL |
| Categories | Content Macros |
| Version | 2.7.1 |
| Availability | Confluence v2.8.1 to v2.9-m2-r2 |
| State | Stable |
| License | Freeware / Open Source (BSD) |
| Price | Free |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Calendar+Plugin |
| Java API Docs | n/a |
| Download Source | http://svn.atlassian.com/svn/public/contrib/confluence/calendar-plugin/tags/calendar-plugin-2.7.1/ |
| Download JAR | calendar-plugin-2.7.1.jar |
 | This plugin now accessible through the Confluence Repository Client. |
Description
This plug-in puts a dynamically updated calendar into any page. The calendar stores its data in iCal format and allows incoming and outgoing calendar subscription.
The plugin offers day, week and month views. You can have multiple calendars per page. And your items can link to other pages for elaborating details.
 | Possible Bug Users have reported that some accounts cannot see scheduled events. We recommend that you notify your users about the risk until we can fully re-test the plugin. |
Downloading & Installing
 | Due to changes in Daylight Savings Time laws in the US, it is important to update your JDK if you are having issues with dates after March 11, 2007. See the following page for details: http://java.sun.com/javase/tzupdater_README.html |
| Due to changes in Confluence, there are separate versions for Confluence 1.4.4, 2.0 and 2.1. Uploading the plugin is only supported from plugin version 2.3 onwards. |
Screenshots
| (view as slideshow) | ||||||
|---|---|---|---|---|---|---|
|
|
|
||||
| The vacation calendar. | Adding a multi-day all-day event. | An event in the Brisbane timezone. | ||||
|
|
|
||||
| Add events by clicking the icon. | Adding an event in the Bangkok timezone. | |||||
|
|
|
||||
| Adding a calendar - step 1 | ||||||
Macros
{calendar:id=mycal|title=My Calendar}
Details: Outputs an editable dynamic calendar.
Parameters:
| Name | Required | Description |
|---|---|---|
| id | |
The unique identifier that identifies this calendar. Must be unique per page. May only contain numbers and letters of the alphabet. |
| title |  |
The human-friendly title for the default sub-calendar. Not necessarily unique. |
| defaultView | |
Allows the default view of the calendar to be specified. May be 'event', 'day', 'week' or 'month' (the default) |
| firstDay | |
Allows the specification of the first day of the week. May be any day of the week. Defaults to Monday. |
{calendar-events:page=Page Name|calendarId=mycal|}
Details: Outputs the events for the named calendar.
Parameters: PLEASE COMPLETE MACRO DESCRIPTION
| Name | Required | Description |
|---|---|---|
| page | |
The name of the page containing the calendar. May be just the page name ('My Page') for local pages, or prefixed with the space key ('SPACE:My Page') for those elsewhere. |
| calendarId | |
The ID of the calendar to display events for. |
Examples
Creating the basic calendar
Creating a calendar is a two-stage process. Firstly, you have to define where the calendar will appear on the page. Edit a page in Wiki Markup mode:
Below is my vacation calendar.
{calendar:id=vacation|title=My Vacation}
By specifying the title, a new calendar called 'My Vaction' will automatically be created for you. It should look something like this:
You can add events to this immediately.
Adding Events
To add a new event, hover your mouse over a day on the main calendar display and click the 'add event' icon which appears:
Next, a panel asking which calendar you want to add to will appear:
Select 'My Vacaction' and click next. Enter the details for the event:
Click 'Add' to finish the job.
Adding a new calendar
Alternately, you might want to add a new calendar, either one allowing events to be added via Confluence, or one which subscribes to an iCal file elsewhere on the Internet.
Firstly, click the 'Add a calendar link'. If more than one type of calendar is available, you will have to select the calendar type:
Then, enter the calendar details:
The example above is subscribing to the 'Australian Holidays' calendar. You can subscribe to it yourself by entering the following URL as the subscription location:
http://icalx.com/public/rohanl/Australian32Holidays.ics
If you want to be able to add events through Confluence, set the location to 'Local'.
Timezones
With version 2.1.10 of the plugin, you can now specify both specific event timezones as well as the display timezone for the main calendar.
Adding events in different timezones
Setting the timezone for an event is simple - just change the the option below the event time. Note that all-day events do not have a timezone - they apply to the whole day on the specified date, regardless of the timezone. An example is below:
Viewing the main calendar in a different timezone
You can change what timezone you view calendars in. Note that you must be logged in for this to work, and the setting will apply to all calendars on the site. You can change the display timezone at any time.
To do so, simply click on the name of the current timezone in the top-left of the calendar display:
You will then be asked to select a new timezone. Choose the one you want and click 'Save'. You will be returned to the page you came from.
Note: In Confluence 2.3+, this now uses the standard user-set timezone, available in the user's preferences.
Publicly Available Calendars
There are numerous public calendars for things like holidays, regional events, etc. One of the best repositories can be found at http://icalshare.com/.
Custom Themes
If you are using a custom theme, you need to ensure that some javascripts are included in your theme (or create a user macro to get them included on your page). This is also important to ensure that other Confluence features like labels are correctly supported.
The scripts are prototype.js and effects.js - both of which can be obtained from http://script.aculo.us
These scripts are usually included with Confluence 2.x standard themes.
Internationalization
The plugin is mostly internationalized. 95% of the text has been put into a properties file (CalendarMacro.properties. Other languages can be added by creating modified versions of this file and saving them with the appropriate language code (eg. CalendarMacro_de.properties, etc.)
How this file is linked into Confluence depends on the version of Confluence you are using.
Confluence 2.3+
The files must now be loaded into the plugin to work, although alternately a separate plugin can be created for additional language files if this works out to be simpler. In the meantime, the German translation has been added to Calendar 2.3. Please feel free to supply translations into other languages.
- In Confluence 2.3 (using Calendar 2.3+), the locale will be that specified by the user themselves, or the server default if they do not have one. If a translation is not available for the current locale, it will display the default English translation.
Also, feel free to contribute any translations you produce here and they will be added to future versions of the plugin. Contributions so far are listed here:
| Name | Size | Creator (Last Modifier) | Creation Date | Last Mod Date | Comment | ||
|---|---|---|---|---|---|---|---|
 |
 CalendarMacro_de.properties |
5 kb | MartinMitry | Feb 21, 2007 | Feb 21, 2007 | German localization |
User contributed information
 | Performance Advisory This is one of the best plugins for Confluence, however it's also one of the most system and database intensive and is susceptible to users inadvertently creating calendar pages that can consume massive amounts of system resources while rendering the page. |
Open Issues
Open
Reopened
Release History
| Version | Date | State | License | Price |
2.7.1
(#26)
|
20 Jun 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
2.7
(#25)
|
06 Jun 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
2.6.1
(#24)
|
10 Jan 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
2.6
(#23)
|
18 Dec 2007 | Stable | Freeware / Open Source (BSD) | Free |
|
2.5
(#22)
|
15 Nov 2007 | Stable | Freeware / Open Source (BSD) | Free |
Resolved
Closed
