Display a small calendar contained in a panel with support for the FullCalendar application

Description

Display a small calendar contained in a panel with support for the FullCalendar application.

Features

- the current day number is contained by a gray circle
- each day which has events will be marked with a little dot under it
- days from the previous and next month are of a different color
- clicking the month name will send you to a page showing the events from the respective month
- clicking any of the day numbers will send you to a page showing the events from the respective day

Requirements

In order to display the events for each day, the calendar panel uses the FullCalendar Application as it's data source.

Usage

Overview

The macro does not require any content and does not need any parameters.

Configuration

The configuration for the data source is done by editing the 'XWiki.Calendar' page and filling in the required information.

###############
## Configuration ##
###############
##
#set($source              = 'class')                                   ## The source for the calendar, either 'json' or 'class'
##
#set($json                   = 'Calendar.ExampleJSON') ## The page that acts as the json source for the calendar
#set($className       = 'Blog.BlogPostClass')         ## The class that defines a calendar event
#set($classDateField = 'publishDate')                     ## The field in which the date for the event is set

Examples

Panel view

Day view

Month view

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki