Events Addon

The Events Addon is a comprehensive event management system for organizing, scheduling, and displaying events and calendars. It allows you to create detailed event listings with date and time information, locations, recurring schedules, and rich content.

Introduction

What is the Events Addon?

The Events Addon is a comprehensive event management system for organizing, scheduling, and displaying events and calendars. It allows you to create detailed event listings with date and time information, locations, recurring schedules, and rich content.

What can you do with it?

Key Features

Who is this for?

This addon is designed for:

Getting Started

Accessing the Events Module

  1. Log into the admin panel
  2. Navigate to the Events module in the main navigation menu
  3. You'll see the main Events dashboard with various sections

Overview of the Admin Interface

The Events module is organized into several sections accessible from the left sidebar:

Basic Navigation

Understanding Content Types

The Events Addon uses several content types to organize and classify events. Understanding these types will help you effectively manage your event data.

Events

What are events?

Events are the main content type in this addon. An event represents a scheduled occurrence at a specific date and time. Examples include concerts, festivals, workshops, meetings, performances, or any time-based activity.

What information do they contain?

Events can store a wide variety of information including:

When to use it:

Create an event entry for any scheduled activity you want to feature in your system.

Categories

What are categories?

Categories are used to organize events into groups. Examples include "Music", "Sports", "Arts & Culture", "Food & Drink", or "Community Events". Categories help visitors find events by topic or type.

How do they relate to events?

Events can be assigned to one or more categories. When a visitor searches for events in a specific category, they'll see all events assigned to that category.

When to use it:

Create category types that represent the different kinds of events you host. Then assign these categories to relevant events.

Types

What are types?

Event types represent different kinds of events that may have different layouts or configurations. Each type can have its own custom layout template and theme layout, allowing different event types to be displayed differently.

How do they work?

When to use it:

Create event types for different presentation needs. For example, you might have different types for "Concert Events", "Workshop Events", or "Festival Events" that display differently.

Managing Events

This section provides step-by-step guides for managing event entries.

Creating a New Event

  1. Navigate to Events in the admin panel
  2. Click the New Event button
  3. You'll be prompted to choose an event type
  4. Select the appropriate event type
  5. Fill in the required fields:
    • Title: The event name (required)
    • Slug: A URL-friendly version of the name (required, must be unique)
    • Type: The event type (required)
    • Starts At: Start date and time (required)
    • Ends At: End date and time (required)
    • Publish At: When the event should be published (required)
    • Author: Event creator (required)
  6. Fill in optional fields as needed (see Event Fields Reference for details)
  7. Click Save to create the event

Editing Event Information

  1. Navigate to Events
  2. Click on the event you want to edit
  3. Make your changes
  4. Click Save to update

Setting Date and Time Information

Date and Time Fields:

Tips:

Adding Location Information

Events can be linked to destinations or have custom location information:

Linking to a Destination:

  1. Find the Destination field
  2. Select a destination from the list
  3. The event will inherit location information from the destination

Custom Location:

Adding Images

Events support three types of images:

Main Image:

Header Image:

Image Upload:

To add images:

  1. Open the event for editing
  2. Find the image field you want to use (Main Image, Header Image, Image Upload, or Gallery Images)
  3. Click to upload or select an existing image
  4. Save your changes

Adding Contact Information

Contact Fields:

Adding Categories

To assign an event to categories:

  1. Open the event for editing
  2. Find the Categories field
  3. Select one or more categories from the list
  4. You can select multiple categories
  5. Save your changes

Tips:

Setting Event Status

Status Fields:

Controlling Visibility:

Linking Events to Destinations

Events can be linked to destinations to show where they take place:

  1. Open the event for editing
  2. Find the Destination field
  3. Select a destination from the list
  4. The event will inherit location information from the destination
  5. Save your changes

Benefits:

Managing Related Content

This section covers how to manage the various content types that support events.

Creating and Managing Categories

  1. Navigate to Categories in the admin panel
  2. Click New Category
  3. Enter:
    • Name: The category name (e.g., "Music Events")
    • Slug: URL-friendly version (auto-generated from name)
    • Description: Brief description of the category
    • Content: Detailed content about the category
    • Images: Main image and/or header image
  4. Save

Categories help visitors find events by topic or type.

Creating and Managing Event Types

  1. Navigate to Types in the admin panel
  2. Click New Type
  3. Enter:
    • Name: The type name (e.g., "Concert")
    • Slug: URL-friendly version
    • Layout: Template layout for this event type
    • Theme Layout: Theme layout configuration
    • Description: Description of the event type
  4. Save

Note: Event types are typically configured by developers or administrators. They control how events are displayed and may have different field configurations.

Managing Fields

Custom fields can be created for events:

  1. Navigate to Fields in the admin panel
  2. Click New Field
  3. Choose a field type
  4. Configure the field
  5. Assign it to event types as needed

Note: Field management is typically done by administrators or developers. Custom fields allow you to add additional information to events beyond the standard fields.

Recurring Events

The Events Addon supports powerful recurring event functionality, allowing you to create events that repeat on a schedule.

Understanding Recurrence Patterns

Events can recur in four ways:

Daily Recurrence:

Weekly Recurrence:

Monthly Recurrence:

Yearly Recurrence:

Setting Up Recurring Events

Basic Recurrence Setup:

  1. Open the event for editing
  2. Find the Recurrence field
  3. Select the recurrence type: Daily, Weekly, Monthly, or Yearly
  4. Configure the recurrence options based on the type selected

Recurrence End Date:

Daily Recurrence:

Weekly Recurrence:

Monthly Recurrence:

Yearly Recurrence:

How Recurring Events Work

When you create a recurring event:

Important Notes:

Searching and Filtering

The Events Addon provides powerful search and filtering capabilities through both the admin interface and the API.

How to Search Events

In the Admin Interface:

Available Search Filters

You can filter events by:

Search results include:

Results can be sorted by:

Date Filtering:

User-Submitted Content

The Events Addon allows authenticated users to submit their own events through the API.

How Users Can Submit Events

Users with authenticated API access can:

  1. Create new events using the API
  2. Update their existing events
  3. Delete their events

Reviewing and Approving Submissions

Review Process:

  1. Navigate to Events in the admin panel
  2. Look for events where Approved is unchecked
  3. Review all submitted information:
    • Verify accuracy of date and time information
    • Check that location information is correct
    • Ensure content meets your standards
    • Verify images are appropriate
  4. Make any necessary edits
  5. Check the Approved checkbox
  6. Ensure Enabled is checked if you want it visible immediately
  7. Save

What Happens:

Managing User-Created Content

Best Practices:

Common Tasks:

Event Fields Reference

This section provides a comprehensive reference for all fields available on event entries. Use this as a guide when creating or editing events.

Basic Information

Field Type Required Description
Title Text Yes The event's title
Slug Text Yes URL-friendly version of the title (must be unique)
Summary Text No Brief summary or excerpt
Content Rich Text No Full detailed description of the event
String ID Text Yes Unique string identifier (auto-generated)

Date and Time

Field Type Required Description
Starts At DateTime Yes When the event begins
Ends At DateTime Yes When the event ends
Publish At DateTime Yes When the event should be published

Location Information

Field Type Required Description
Destination Select No Link to a destination entry
Location Name Text No Name of the venue or location
Address Text No Street address
City Text No City name
State Text No State or province
Zip Text No Zip or postal code
Country Text No Country name
Location Geolocation No Geographic coordinates (auto-populated)

Contact Information

Field Type Required Description
Published Contact Text No Contact name to display publicly
Published Phone Text No Phone number to display publicly
Published Email Text No Email address to display publicly
Contact Text No Internal contact name (not displayed)
Phone Text No Internal phone number
Email Text No Internal email address
Website URL No Event website URL
Comments Text No Internal notes or comments

Event Details

Field Type Required Description
Producer Text No Event producer or organizer
Duration Text No Event duration description
Times Text No Additional time information
Admission Text No Admission information (price, requirements, etc.)

Images

Field Type Required Description
Main Image Image No Primary image (used in listings)
Header Image Image No Large header image (used on detail pages)
Image Upload Image No Additional header image upload
Gallery Images Multiple Images No Image gallery (multiple images)
Map Image Image No Static map image

Recurrence Settings

Field Type Required Description
Recurrence Select No Recurrence type: daily, weekly, monthly, yearly, or none
Range Select No Recurrence range type
Range Occurrences Number No Number of occurrences
R End Date Date No When recurring events should stop

Daily Recurrence:

Weekly Recurrence:

Monthly Recurrence:

Yearly Recurrence:

RRULE Support:

Relationships

Field Type Required Description
Type Select Yes Event type (controls layout)
Categories Multiple Select No Associated categories
Author Select Yes Event creator
Entry Select Yes Content entry (for rich content)

Status and Visibility

Field Type Required Description
Enabled Checkbox No Whether the event is visible to the public
Approved Checkbox No Whether the event has been approved by an admin
Featured Checkbox No Whether the event is featured

SEO Fields

Field Type Required Description
Meta Title Text No SEO meta title
Meta Description Text No SEO meta description
Meta Keywords Text No SEO meta keywords

Additional Fields

Field Type Required Description
Tags Tags No Tags for additional organization
Google ID Text No Google Calendar event ID (for sync)
Google Link URL No Link to Google Calendar event
Yodel ID Text No Yodel integration ID
Auto Updates Checkbox No Whether to automatically update from external sources

Common Tasks and Workflows

This section provides step-by-step guides for common tasks you'll perform when managing events.

Setting Up a New Event from Scratch

What you'll need:

Steps:

  1. Navigate to EventsNew Event
  2. Choose an event type
  3. Fill in required fields:
    • Title
    • Slug (or let it auto-generate)
    • Type
    • Starts At
    • Ends At
    • Publish At
    • Author
  4. Add location information (link to destination or enter custom address)
  5. Upload a main image
  6. Write a description in the Content field
  7. Select at least one category
  8. Fill in contact information if needed
  9. Check Enabled to make it visible
  10. Check Approved (if you're an admin creating it directly)
  11. Click Save

Tips:

Creating a Recurring Event

Setting up weekly recurring events:

  1. Create a new event with the first occurrence's date and time
  2. Set Recurrence to "Weekly"
  3. Set Weekly Weeks (e.g., 1 for weekly, 2 for bi-weekly)
  4. Select Weekly Day(s) (e.g., Mon, Wed, Fri)
  5. Set R End Date (when recurring should stop)
  6. Save

Setting up monthly recurring events:

  1. Create a new event
  2. Set Recurrence to "Monthly"
  3. Choose pattern:
    • Monthly First: Specific day of month (e.g., 15th of every month)
    • Monthly Second: Specific weekday occurrence (e.g., first Monday)
  4. Set Monthly Months (e.g., 1 for monthly, 3 for quarterly)
  5. Configure the specific day/weekday settings
  6. Set R End Date
  7. Save

Adding Multiple Events

When adding many events:

  1. Prepare your data in a spreadsheet with columns for:

    • Title, start date/time, end date/time
    • Location, contact information
    • Categories, etc.
  2. Create events one at a time:

    • Start with the first event
    • Fill in all information
    • Save and move to the next
  3. Use consistent naming for easier management later

Time-saving tips:

Organizing Events with Categories

Planning your category structure:

  1. List all the main types of events you have
  2. Group them into categories
  3. Create the categories in the admin panel

Example categories:

Assigning categories:

  1. Open an event for editing
  2. Find the Categories field
  3. Select one or more appropriate categories
  4. Save

Best practices:

To highlight special events:

  1. Identify events you want to feature
  2. Open each event for editing
  3. Check the Featured checkbox
  4. Save

Tips:

Managing User Submissions

Daily workflow:

  1. Check for new unapproved events
  2. Review each submission:
    • Verify date and time information is accurate
    • Check that location information is correct
    • Ensure descriptions are complete and well-written
    • Verify images are appropriate
    • Check recurrence patterns if applicable
  3. Make any necessary edits
  4. Approve and enable if ready, or contact the user for more information

Communication:

Quality control:

Updating Event Information

When to update:

How to update:

  1. Find the event (use search if needed)
  2. Open it for editing
  3. Make your changes
  4. Save

For user-submitted events:

For recurring events:

Archiving or Removing Events

Disabling an event:

  1. Open the event
  2. Uncheck the Enabled checkbox
  3. Save

The event will no longer appear in public listings but remains in the system.

Deleting an event:

  1. Open the event
  2. Use the delete option (if available)
  3. Confirm deletion

Note: Deleting a recurring event's master will remove all future recurring instances. Past instances may remain in search results until they expire.

When to archive vs. delete:

Tips and Best Practices

Best Practices for Event Descriptions

Writing effective descriptions:

Content structure:

  1. Opening hook (what makes it special)
  2. Key details (date, time, location, admission)
  3. What to expect
  4. How to participate or attend
  5. Contact information

Image Recommendations

Main Image:

Header Image:

General tips:

Category Organization Tips

Creating an effective category structure:

Common mistakes to avoid:

Recurring Events Best Practices

Setting up recurring events:

Managing recurring events:

SEO Tips

Optimizing for search engines:

Meta title best practices:

Meta description best practices:

Performance Considerations

For content managers:

For API consumers:

For recurring events:

General tips: