Discourse Calendar (and Event)

[Discourse]

	Summary	Discourse Calendar and Event adds dynamic and interactive calendar and event features to your Discourse site.
	Repository Link	https://github.com/discourse/discourse-calendar
	Install Guide	How to install plugins in Discourse

As this is an official plugin maintained by the Discourse team, support, bug, ux, and feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Enabling Calendar (and Event)

The Calendar plugin can be enabled either by the toggle or from its settings, both accessible from your admin/plugins page:

Features

Somewhat unsurprisingly, Discourse Calendar (and Event) adds both the calendar and event features to your Discourse site. With these, you can create individual topic calendars to track important occasions or timelines, display calendars in categories, add a holiday calendar to mark vacations, absences, or sick days, create interactive event topics, as well as show an easy-access calendar summary of all of your upcoming events.

Calendars

Bespoke calendars can be created in multiple topics, and ones you wish to give higher visibility to can be displayed above a category’s topic list.

You can find more detailed information on how to create and use calendars in:

Creating and managing calendars

This guide explains how to create and manage calendars in Discourse using the Calendar (and Event) plugin. Required user level: All users Calendars are a powerful feature in Discourse that allow you to organize and display events within your community. This guide will walk you through the process of creating calendars, adding events, and managing them effectively. Summary Enable the Calendar plugin Create a calendar in a topic or category Add events to you…

Events

The Event feature allows interactive elements to be inserted into topics which your members can use to sign up to attend or participate in your community’s activities. These are all summarised in a dedicated site-wide calendar, with the option to add an easy-access link to your navigation menu. You can find more information on how to create and use this feature in:

Creating and managing events

This guide explains how to create and manage events using the Calendar (and Event) plugin in Discourse. It covers how to create events, set event options, interact with events, and view the upcoming events calendar. Required user level: All users (with appropriate permissions) Enabling events Events are a feature of the Calendar (and Event) plugin. To use this feature: Enable the Calendar (and Event) plugin Configure related settings For detailed instruct…

This should not be confused with Pavilion’s Events plugin (note the plural)

Calendar Settings

Name	Description
calendar enabled	Enable the discourse-calendar plugin. This will add support for a [calendar][/calendar] tag in the first post of a topic.
holiday calendar topic id	Topic ID of staffs holiday / absence calendar.
holiday status emoji	Defines the emoji used for the holiday status.
delete expired event posts after	Posts with expired events will be automatically deleted after (n) hours. Set to -1 to disable deletion.
all day event start time	Events that do not have a start time specified will start at this time. Format is HH:mm. For 6:00 am, enter 06:00
all day event end time	Events that do not have a end time specified will end at this time. Format is HH:mm. For 6:00 pm, enter 18:00
calendar categories	Display a calendar at the top of a category. Mandatory settings are categoryId and postId. eg: categoryId=6;postId=453[1] Other valid settings: tzPicker[2], weekends[3] and defaultView[4].
calendar categories outlet	Allows to change which outlet should show the category calendar.
working days	Set working days. You can display the availability of a group using the timezones tag in a post, eg: [timezones group=admins][timezones]
working day start hour	Start time of the working day hours.
working day end hour	End time of the working day hours.
close to working day hours extension	Set extension time in working day hours to highlight the timezones.
calendar automatic holidays enabled	Automatically set holiday status based on a users region (note: you can disable specific automatic holidays in plugin settings)

Event Settings

Name	Description
discourse post event enabled	Enables the Event features. Note: also needs calendar enabled to be enabled.
discourse post event allowed on groups	Groups that are allowed to create events.
displayed invitees limit	Limits the numbers of invitees displayed on an event.
display post event date on topic title	Displays the date of the event after the topic title.
use local event date	Use local date after topic title instead of relative time.
discourse post event edit notifications time extension	Extends (in minutes) the period after the end of an event when going invitees are still being notified from edit in the original post.
discourse post event allowed custom fields	Allows to let each event to set the value of custom fields.
events calendar categories	Display an events calendar at the top of a category.
sort categories by event start date enabled	Enable the sorting of category topics by event start date.
disable resorting on categories enabled	Allow categories to disable the ability for users to sort on the event category.
sidebar show upcoming events	Show upcoming events link in the sidebar under ‘More’. Requires post event enabled

The discourse-post-event/events.json endpoint now has an added parameter to switch between simple and detailed response. To get the detailed response you can add ?include_details=true:

/discourse-post-event/events.json?include_details=true

Integrations with Other Plugins

You can use a component from this plugin with Right Sidebar Blocks. You’ll want to ensure the desired route is enabled via the events calendar categories setting. In Right Sidebar Block’s settings, the block name will be upcoming-events-list, and its optional params (monthFormat, dateFomat, and timeFormat) use this syntax (for example, MMMM D, YYYY).

This is how the sidebar calendar will appear by default.

This is how the sidebar calendar will appear with an empty monthFormat value.

Similarly, if you don’t want the time shown you can add an empty timeFormat value.

Hosted by us? This plugin is available on our Business and Enterprise tiers Calendar | Discourse - Civilized Discussion

---

1. categoryId is the category the calendar will be displayed on top of.
   postId is the post in which you put the calendar in with [calendar][/calendar] ↩︎

2. it can display a time zone picker on the upper right of the calendar. False by default, you can enable it with tzPicker=true ↩︎

3. it can hide Saturdays and Sundays from the calendar. True by default. You can set it to false with weekends=false. ↩︎

4. defaultView will set the calendar’s view (day, week, etc;). It can be set as:
   
   defaultView=agendaDay
defaultView=agendaWeek
defaultView=month (default)
   defaultView=listNextYear ↩︎

Last edited by @benji 2024-09-10T19:25:31Z

Check document

Perform check on document: