Contents
EventAggregator
Description
The EventAggregator macro for MoinMoin can be used to display event calendars or listings which obtain their data from pages belonging to specific categories (such as CategoryEvents) or from remote event sources. The start and end dates are read from the page describing each event, and the calendar is automatically filled out with the details of each event, colouring each event period in a specially generated colour. Maps showing event locations are also supported, given the availability of appropriate map images and location information.
Download & Release Notes
Download |
Release Version |
Moin Version |
Release Notes |
0.8.1 |
1.6, 1.7, 1.8, 1.9 |
||
0.8 |
1.6, 1.7, 1.8, 1.9 |
||
0.7.1 |
1.6, 1.7, 1.8, 1.9 |
||
0.7 |
1.6, 1.7, 1.8, 1.9 |
||
0.6.4 |
1.6, 1.7, 1.8, 1.9 |
||
0.6.3 |
1.6, 1.7, 1.8, 1.9 |
||
0.6.2 |
1.6, 1.7, 1.8, 1.9 |
||
0.6.1 |
1.5, 1.6, 1.7, 1.8 |
||
0.6 |
1.5, 1.6, 1.7, 1.8 |
||
0.5 |
1.5, 1.6, 1.7, 1.8 |
||
0.4 |
1.5, 1.6, 1.7, 1.8 |
||
0.3 |
1.5, 1.6, 1.7, 1.8 |
||
0.2 |
1.5, 1.6, 1.7, 1.8 |
||
0.1 |
1.5, 1.6, 1.7, 1.8 |
Installation
See the bundled documentation for installation instructions. EventAggregator is most conveniently installed using moinsetup.
Usage
Put <<EventAggregator(CategoryEvents)>>, substituting your preferred category names as the arguments to select categories from which events will be aggregated and shown. Alternatively, put <<EventAggregator(source=GriCal)>>, substituting your preferred event source (or sources, one per parameter) from which events will be aggregated and shown.
See also ActionMarket/EventAggregator for documentation on the EventAggregatorSummary action which provides iCalendar and RSS 2.0 download support for this macro, together with details of the EventAggregatorNewEvent action which provides convenient event creation through a form displayed on the currently shown page.
Examples
## Show multiple categories: <<EventAggregator(CategoryEvents,CategoryTraining)>> ## Show a category's events as a list: <<EventAggregator(CategoryEvents,mode=list)>> ## Show a category's events repeating the name in every consecutive day of an event: <<EventAggregator(CategoryEvents,names=daily)>> ## Show a category's events for this and next month: <<EventAggregator(CategoryEvents,start=current,end=current+1)>> ## Show a category's events for this and next month with navigation controls: <<EventAggregator(CategoryEvents,start=current,end=current+1,calendar=events)>> ## Show the events published in a Wiki category and by the GriCal service for this month with controls and a map view showing a European map: <<EventAggregator(CategoryEvents, source=GriCal, start=current, end=current, calendar=sources, map=europe)>>
Screenshots
Map View
(New in 0.7)
Day View
(New in 0.7)
Month Calendar View
Copyright
Copyright (C) 2008, 2009, 2010, 2011 Paul Boddie <paul AT boddie DOT org DOT uk>
Some patches provided by the following contributors:
Copyright (C) 2009 Cristian Rigamonti <rigamonti AT fsfeurope DOT org>
Some pieces of MoinMoin code were used in this work - typically pieces which demonstrate how to perform certain common tasks (as found in various macros and actions) - and are thus covered by the following copyrights:
Copyright (C) 2000-2004 Juergen Hermann <jh AT web DOT de>
Copyright (C) 2003-2008 ThomasWaldmann
Copyright (C) 2004-2006 AlexanderSchremmer
Copyright (C) 2007 ReimarBauer
License
GNU General Public License version 2 or later
Important Notices
Release 0.7.1 restores MoinMoin 1.9.x compatibility which was accidentally lost in the 0.7 release.
Release 0.6.4 fixes the download/subscription pop-up elements where calendars are open-ended, this having caused the macro to fail completely when showing such calendars.
Release 0.6.2 fixes various bugs in HTML production done by the actions. It is strongly recommended to upgrade from earlier versions to this release.
In release 0.6.2, support for MoinMoin 1.5.x has been dropped. Since usage of the Xapian search software is practically a necessary part of deploying this solution, and yet Xapian only became integrated with MoinMoin from version 1.6 onwards, few deployments should have involved MoinMoin 1.5.x.
In release 0.6, support for event times has been introduced. Due to the complicated nature of times, time zones, time regimes, and so on, the behaviour of the software may change in future versions to support common use-cases in a more convenient fashion. Please be aware that implicitly chosen or generated time or time zone information may change for events, particularly those whose times are ambiguous or ill-defined. It is highly recommended that the pytz library be installed - see the documentation regarding dependencies for more information.
In release 0.5, the "download this calendar" and "subscribe to this calendar" links have been fixed to return only events within the specified period and to work with day- and month-relative calendars. Users who have bookmarks in their Web browser or feed reader should replace these bookmarks by visiting the bookmarked page and acquiring new versions of these links, once EventAggregator has been upgraded.
Bugs
Fixed in 0.7.1: MoinMoin 1.9.x support is broken in 0.7.
Fixed in 0.6.4: Calendars which are open-ended caused the macro to fail due to a bug in the preparation of the download/subscription pop-up elements.
Fixed in 0.6.2: EventAggregator does not yet work with MoinMoin 1.9, although the repository version is very close to working fully.
Fixed in 0.6.2: Calendars (as opposed to views of calendars) for download and subscription don't readily reflect what the download/subscription will contain, nor is there a convenient link to customise their content.
Fixed in 0.7: Event metadata should support Wiki text so that links (for example) are shown correctly in the table view.
Fixed in 0.5: Perhaps event colours should be based on the label instead of the page name, so that identically labelled events have identical colours.
Fixed in 0.2: Event regions sometimes don't maintain the same height across multiple days, despite hacks to attempt to produce event boxes with a consistent height across consecutive days without using fixed dimensions.
Suggestions
- Views should expose more metadata such as topics and locations and possibly permit filtering according to such metadata.
Support for recurring events would be nice. -- MelaEckenfels 2010-01-02 22:03:46
Multiple events per page is now supported - not quite recurring events, but movement in that direction.
-- PaulBoddie 2010-02-16 23:38:02
- Support localised keywords when describing events.
- Styles should be obtained from a theme-independent stylesheet, if possible.
Added in 0.7: Events at different times within the same day could be shown in order, possibly using a day view.
Discussion
The Xapian search software is highly recommended, if not technically essential, for the acceptable performance of the EventAggregator macro since the macro makes use of search routines in MoinMoin that can dominate the time spent processing requests. See HelpOnXapian for installing Xapian and getting acceptable performance.