EvEvent Plugin
==============

Authors:
- Andy Carter
- Rick Mills


Introduction
------------

Event listing plugin featuring:

- Categorised display of events
- Widgets to show an archive of events and event categories
- Support for displaying event addresses and maps


Backward Compatability
-----------------------
**As of version 2.2.0.0 this plugin is no longer backward compatible (this includes the migration files).**

A number of fixes and new features were introduced in 2.2.0.0 that break support on older sites. These include:

- Removed reliance on a standalone country table, and instead now uses EvCountry
- Refactored templates to be BEM and bootstrap compatible, and removed breaking code errors
- Added support for hiding maps and addresses within templates
- Added support for the newer way of handling maps within a single db field
- Added support for extending the plugin
- Added support for custom routing via the config file
- Added support for hiding individual events from non-logged in users
- Reset migration files due to issues with the original routes not being generated by the console.

Installation
------------

This is a composer plugin so from www/app just run composer as:-

	composer require evoluted/event

To setup the database use the CakeDC Migrations plugin. To run the migrations and setup the database run:-

	Console/cake Migrations.migration run all --plugin EvEvent

Add the following to the plugin load array in 'app/Config/bootstrap.php':-

	'EvEvent' => array(
		'bootstrap' => true
	)

You will want to add a couple of entries to the admin menu for managing events:-

* /admin/ev_event/events/
* /admin/ev_event/event_categories/

To setup/override the plugin's default config create a new config file 'app/Config/Plugin/ev_event.php'. The following options are available:-

* page_id - page to use for setting the events listing page's title, description and meta data.
* snippet_length - allows you to set the maximum length of description text used on listing pages (default: 85).
* default_country_id - default country_id to be used on the admin forms for setting the event address.

In addition you've now got the route definitons located in the config file.

Everything should be good to go after this with an events section found at '/events'.


Extending Plugin
----------------

As with all plugins, if you're doing something that'll be useful for all sites (and can be
enable/disabled as needed), then go ahead and add it to the plugin. Otherwise, please extend it
and add your site-specific customisations the usual way.