Package: mezzanine-events
mezzanine-events================This plugin gives you an "Event" page type for your Mezzanine sites.Features---------  Show your visitors where to go-  Embed a map of the location in one line of code with the GoogleStatic Maps template tag-  Provide a "Get Directions" link so users can go there in one click-  Let your visitors add a single event or subscribe to all futureevents in Google Calendar, Outlook, iCal and more with GoogleCalendar and webcal:// URLs and iCalendar files-  The usual stuff - dates, times, speakers, rsvpScreenshots-----------These screenshots show what the plugin looks like with the defaulttemplates. To see it in action with custom templates, look at the`Events page of the St Barnabas'website <http://www.sbtc.org.au/events/>`__.-  `An event container containing oneevent <https://raw.github.com/stbarnabas/mezzanine-events/master/screenshots/eventcontainer.png>`__-  `An example eventpage <https://raw.github.com/stbarnabas/mezzanine-events/master/screenshots/event.png>`__Installation-------------  Run ``pip install mezzanine-events`` (or, if you want to hack onmezzanine-events, clone it and run ``pip install -e path/to/repo``)-  Add ``"mezzanine_events"`` to your ``INSTALLED_APPS``-  Add ``("^", include("mezzanine_events.urls"))`` to your ``urls.py``(this is so that mezzanine-events can serve up iCalendar files).-  Set either the ``TIME_ZONE`` or ``MZEVENTS_TIME_ZONE`` settings. (Ifneither of these settings are set, the Google Calendar links will notwork as expected.)-  Migrate your databaseUsage-----mezzanine-events provides two page types: "Event Container" and "Event".The Event Container page type is the 'Events' (note plural) page on yourwebsite; you'll probably want it to have a list of events. The Eventpage type represents a single event.Create an Event Container page in the Mezzanine admin (naming itsomething like "Events"), then create your first Event page inside it(naming it with the name of your event).Creating Templates------------------In addition to the documentation here, take a look at how the defaulttemplates in the ``mezzanine_events/templates`` directory are written.Event pages~~~~~~~~~~~The template for an Event page is ``templates/pages/event.html``.The Event object is available at ``page.event``. It has the followingproperties:-  Dates and times: ``date``, ``start_time``, ``end_time``-  Location info: ``location``, ``mappable_location``, ``lat``, ``lon``-  Text data: ``speakers``, ``rsvp``-  ``speakers_list`` - the speakers as a list you can iterate over-  Generated start and end datetimes at ``start_datetime`` and``end_datetime``The following template tags and filters can be used:-  ``{{ page.event.rsvp|link_emails }}`` - Wraps anything that lookslike an email in a ``mailto:`` link.-  ``{{ page.event|google_calendar_url }}`` - Returns a Google Calendartemplate URL. Google Calendar users can click a link to this URL toadd the event to their calendar.-  ``{{ page.event|icalendar_url }}`` - Returns the URL to an iCalendarfile containing this event. Upon downloading this file, most calendarsoftware including Outlook and iCal will handle this by adding it totheir calendars.-  ``{{ page.event|google_nav_url }}`` - Returns the URL to a page onGoogle Maps showing the location .-  ``{{ google_static_map page.event <width> <height> <zoom> }}`` -Produces a Google static map centred around the event location,zoomed to the specified level. Produces the entire ``img`` tag, notjust the URL.-  ``{% for speaker in page.speakers_list %} - Iterate over the speakers listed, e.g. to put them in``.. raw:: html<li>\`s.Event pages default to being not visible in navigation, unless "showevents in navigation" is checked in their parent EventContainer.Event Container pages~~~~~~~~~~~~~~~~~~~~~The template for an Event Container page is``templates/pages/eventcontainer.html``.Iterate over ``page.eventcontainer.events`` to get at the events insidethe container. You can then use all of the properties and template tagslisted above on these objects.The template filter ``{{ page.eventcontainer|icalendar_url:"webcal" }}``can be used to produce a webcal URL. When a link containing this URL isclicked, the user's default calendaring app will subscribe to events inthis eventcontainer.Notes~~~~~The ``icalendar_url`` template filter actually takes one optional,arbitrary string argument that specifies the protocol to use in the URLit gives, defaulting to ``http``. This means that you can generate``webcal`` URLs for single events and downloadable ``.ics`` files forevent containers.In practice, most clients *import* downloaded iCalendar files into anexisting calendar, and add webcal URLs as a *separate calendar*, so thebehaviour described above is usually the desired one.Settings---------  ``MZEVENTS_GOOGLE_MAPS_DOMAIN`` - The Google Maps country domain toquery for geocoding. Setting this accurately improves results whenusers forget to enter a country in the mappable address. Default:``'maps.google.com.au'``.-  ``MZEVENTS_HIDPI_STATIC_MAPS`` - Whether the``{% google_static_map %}`` template tag generates a map suitable forhigh DPI displays such as the MacBook Pro with Retina Display andmany newer smartphones. Default: ``True``.-  ``MZEVENTS_TIME_ZONE`` - The time zone that the event dates and timesare in. Either this or the ``TIME_ZONE`` setting needs to be set.License-------Copyright (C) 2012 St Barnabas Theological CollegePermission is hereby granted, free of charge, to any person obtaining acopy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:The above copyright notice and this permission notice shall be includedin all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.