Events Calendar Configuration
Used to configure and provide functionality for an Events Calendar.
Content Type Details
- ID: 313
- Name: Events Calendar Configuration
- Minimum user level: Administrator
- Compatible with page layouts: Full Width
Guidance
- Location: The Events Calendar Configuration for the main Events Listing is added to section Home » Events.
- Output: The Events Calendar Configuration content type has no visible output on the page.
- Content: Content is pulled in from the Event content type, using 2x navigation objects to return past and future events. See the Events Calendar Module installation guide for an example of the navigations set up.
- Display: Events and filters are displayed using the Events Calendar View content type.
- Options: The Events Calendar Module has a range configurable options which are set using the options element. Please note that due to the design of the events listing some options may not be compatible.
- Multiple Listings: multiple events listings can be set up across the site if required in a different branch to the main events listing e.g., for creating a standalone listing/calendar for a department. To do this:
- Create a root section for the new listing
- Create 2x navigation objects to return past and future Event content from the new listing branch
- Add an Events Calendar Configuration to the root section of the new listing
- Add the Events Calendar View to the root section of the new listing
- Add Event content to year sections under the new listing branch
- In the Home section at the root of the main site in the .htaccess content item replicate the Events Listing redirect rule for the new listing
Content Type Elements Details
| Name | Description | Size | Type | Required | Conditionally Shown |
|---|---|---|---|---|---|
| Name | The Name element | 80 Characters | Plain Text | Yes | No |
| PHAR File | Select PHP Main Library PHAR file from the Media Library | N/A | Media | Yes | No |
| Sources | Choose which Sources to load Events from Choose from options: Terminalfour Events, Google Calendar Events, iCal Events | N/A | Check Box (List: Event Calendar Sources) | Yes | No |
| Events JSON or XML Source | Add the Handlebars expression for the navigation object that returns the Events JSON | 999 Characters | Plain Text | Yes | No |
| Max Events per Page | Set the number of events to output before pagination | N/A | Whole Number | Yes | No |
| Google Email | For Google Calendar Events - Client Email | 300 Characters | Plain Text | Yes | Yes |
| Google API Token | For Google Calendar Events - Google API P12 Token file | 300 Characters | Plain Text | Yes | Yes |
| Google Calendar IDs | For Google Calendar Events - Calendar ID | 5000 Characters | Plain Text | Yes | Yes |
| iCal Sources | For iCal Events - iCal ics sources files or URLs separated by pipe | 5000 Characters | Plain Text | Yes | Yes |
| Timezone | If not set, uses Europe/Dublin | 80 Characters | Plain Text | No | No |
| Options | Optional PHP Variables, please note due to the design of the events listing some options may not be compatible | 5000 Characters | Plain Text | No | No |
Example
See Events Listing.