1 Introduction
2 ------------
3
4 The EventAggregator macro for MoinMoin can be used to display event calendars
5 or listings which obtain their data from pages belonging to specific
6 categories (such as CategoryEvents) or from remote event sources. The start
7 and end dates are read from the page describing each event, and the calendar
8 is automatically filled out with the details of each event, colouring each
9 event period in a specially generated colour. Maps showing event locations are
10 also supported, given the availability of appropriate map images and location
11 information.
12
13 The EventAggregatorSummary action can be used to provide iCalendar and RSS
14 summaries of event data based on pages belonging to specific categories, as
15 described above. The category, start and end parameters are read directly from
16 the request as URL or form parameters: these restrict the extent of each
17 generated summary.
18
19 The EventAggregatorNewEvent action can be used to conveniently create new
20 event pages, displaying a simple form which can be filled out in order to
21 provide elementary event details such as the event title or summary, the
22 categories to which the page will be assigned, and the start and end dates of
23 the event.
24
25 The eventfeed script can be used to import events from RSS feeds, inserting
26 new pages into a Wiki.
27
28 Important Notices
29 -----------------
30
31 Release 0.8.4 fixes time zone offset calculations for time regimes west of the
32 prime meridian.
33
34 Release 0.8.3 fixes end dates in events aggregated from remote iCalendar
35 sources.
36
37 Release 0.7.1 restores MoinMoin 1.9.x compatibility which was accidentally
38 lost in the 0.7 release.
39
40 Release 0.6.2 fixes various bugs in HTML production done by the actions. It is
41 strongly recommended to upgrade from earlier versions to this or a later
42 release.
43
44 In release 0.6.2, support for MoinMoin 1.5.x has been dropped. Since usage of
45 the Xapian search software is practically a necessary part of deploying this
46 solution, and yet Xapian only became integrated with MoinMoin from version 1.6
47 onwards, few deployments should have involved MoinMoin 1.5.x.
48
49 In release 0.6, support for event times has been introduced. Due to the
50 complicated nature of times, time zones, time regimes, and so on, the
51 behaviour of the software may change in future versions to support common
52 use-cases in a more convenient fashion. Please be aware that implicitly chosen
53 or generated time or time zone information may change for events, particularly
54 those whose times are ambiguous or ill-defined. It is highly recommended that
55 the pytz library be installed - see the documentation regarding dependencies
56 for more information.
57
58 In release 0.5, the "download this calendar" and "subscribe to this calendar"
59 links have been fixed to return only events within the specified period and to
60 work with day- and month-relative calendars. Users who have bookmarks in their
61 Web browser or feed reader should replace these bookmarks by visiting the
62 bookmarked page and acquiring new versions of these links, once
63 EventAggregator has been upgraded.
64
65 Installation
66 ------------
67
68 To install the support library and MoinMoin-related scripts, consider using
69 the moinsetup tool. See the "Recommended Software" section below for more
70 information.
71
72 With moinsetup and a suitable configuration file, the installation is done as
73 follows with $EADIR referring to the EventAggregator distribution directory
74 containing this README.txt file:
75
76 python moinsetup.py -f moinsetup.cfg -m install_extension_package $EADIR
77 python moinsetup.py -f moinsetup.cfg -m install_actions $EADIR/actions
78 python moinsetup.py -f moinsetup.cfg -m install_macros $EADIR/macros
79 python moinsetup.py -f moinsetup.cfg -m install_theme_resources $EADIR
80 python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet screen.css event-aggregator.css
81 python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css event-aggregator.css
82 python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css event-aggregator-print.css
83
84 The first command above uses the setup.py script provided as follows:
85
86 python setup.py install --prefix=path-to-moin-prefix
87
88 The second and third commands install the actions and macros respectively.
89
90 The fourth command installs the theme resources in the available theme
91 directories.
92
93 The remaining commands activate the styles provided by EventAggregator by
94 editing the screen.css and print.css files which are typically provided by
95 themes. These commands add imports of the following form to the theme
96 stylesheets:
97
98 @import "event-aggregator.css";
99
100 Optional Installation Tasks
101 ---------------------------
102
103 To add the capability of aggregating iCalendar format event sources, the
104 vContent software needs to be obtained and installed. See the "Recommended
105 Software" section below for details.
106
107 The following command can be run with $VCDIR referring to the vContent
108 distribution directory:
109
110 python moinsetup.py -f moinsetup.cfg -m install_extension_package $VCDIR
111
112 This merely runs the setup.py script provided by that software, installing
113 the software under the configured installation "prefix".
114
115 Useful Pages
116 ------------
117
118 The pages directory contains a selection of useful pages using a syntax
119 appropriate for use with MoinMoin 1.6 or later. These pages can be created
120 through the Wiki and their contents copied in from each of the files. An
121 easier installation method is to issue the following commands:
122
123 python moinsetup.py -f moinsetup.cfg -m make_page_package $EADIR/pages pages.zip
124 python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
125
126 You may need to switch user in order to have sufficient privileges to copy the
127 page package into the Wiki. For example:
128
129 sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
130
131 Resource Pages
132 --------------
133
134 For the map view, some resource pages are provided with EventAggregator.
135 Unlike the help pages which are most likely to be left unedited, the resource
136 pages should be modified and updated with additional map and place details.
137 Consequently, upgrading these pages is not necessarily desirable when new
138 releases of EventAggregator are made available, and thus these pages are kept
139 separate from the help pages.
140
141 To install the resource pages, use the following commands:
142
143 python moinsetup.py -f moinsetup.cfg -m make_page_package $EADIR/resource_pages resource_pages.zip
144 python moinsetup.py -f moinsetup.cfg -m install_page_package resource_pages.zip
145
146 You may need to switch user in order to have sufficient privileges to copy the
147 page package into the Wiki. For example:
148
149 sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package resource_pages.zip
150
151 Using the Macro
152 ---------------
153
154 It should now be possible to edit pages and use the macro as follows:
155
156 <<EventAggregator(CategoryEvents)>>
157
158 As arguments to the macro, you must indicate a comma-separated list of
159 categories to be inspected for event data. For example:
160
161 <<EventAggregator(CategoryEvents,CategoryTraining)>>
162
163 By default, this should display a calendar in a collection of tables, one for
164 each month containing events. To show a collection of month-by-month listings,
165 use the 'mode' argument as follows:
166
167 <<EventAggregator(CategoryEvents,mode=list)>>
168
169 To use remote event sources instead of categories in the Wiki, specify each
170 source using explicit source parameters:
171
172 <<EventAggregator(source=GriCal,source=FSFE)>>
173
174 This will aggregate events from the GriCal and FSFE calendars residing on
175 remote Web sites, provided that these sources have been defined in the event
176 sources dictionary.
177
178 See pages/HelpOnEventAggregator for more detailed information.
179
180 Using the Actions
181 -----------------
182
183 To obtain an iCalendar summary, the EventAggregatorSummary action can be
184 selected from the actions menu on any page. Alternatively, a collection of
185 parameters can be specified in the URL of any Wiki page.
186
187 See pages/HelpOnEventAggregatorSummary for more detailed information.
188
189 To create new events using the EventAggregatorNewEvent action, the appropriate
190 menu entry can be selected in the actions menu. Alternatively, clicking on a
191 day number in a calendar view will invoke the action and pre-fill the form
192 with the start date set to the selected day from the calendar.
193
194 See pages/HelpOnEventAggregatorNewEvent for more detailed information.
195
196 Running the Scripts
197 -------------------
198
199 Note that remote event sources are likely to be more useful than the scripts
200 described below. However, these scripts may be useful for certain kinds of
201 application.
202
203 To import events from an RSS feed, the eventfeed script integrated with the
204 moin program can be used as follows:
205
206 moin --config-dir=path-to-wiki --wiki-url=example.com/ \
207 import eventfeed --url=url-of-events-feed
208
209 Thus, to import events from the FSFE events RSS feed, the following command
210 could be used:
211
212 moin --config-dir=path-to-wiki --wiki-url=example.com/ \
213 import eventfeed --url=http://www.fsfe.org/events/events.en.rss
214
215 If this command is being used with sudo, make sure to use the -u option so
216 that the script can operate as the appropriate user. For example:
217
218 sudo -u www-data moin --config-dir=path-to-wiki --wiki-url=example.com/ \
219 import eventfeed --url=http://www.fsfe.org/events/events.en.rss
220
221 It may also be necessary to set PYTHONPATH directly before the moin program
222 name and even to explicitly use the path to that program.
223
224 Recommended Software
225 --------------------
226
227 See the "Dependencies" section below for essential software.
228
229 The moinsetup tool is recommended for installation since it aims to support
230 all versions of MoinMoin that are supported for use with this software.
231
232 See the following page for information on moinsetup:
233
234 http://moinmo.in/ScriptMarket/moinsetup
235
236 The Xapian search software is highly recommended, if not technically
237 essential, for the acceptable performance of the EventAggregator macro since
238 the macro makes use of search routines in MoinMoin that can dominate the time
239 spent processing requests.
240
241 See the following page for information on Xapian and MoinMoin:
242
243 http://moinmo.in/HelpOnXapian
244
245 The vContent software is required for the parsing of iCalendar information
246 from remote event sources.
247
248 See the following page for information on vContent:
249
250 https://hg.boddie.org.uk/vContent
251
252 Troubleshooting
253 ---------------
254
255 See here for a bug related to category recognition:
256
257 http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
258
259 This affects installations where migrations between versions have occurred,
260 yet the Wiki configuration retains old regular expression details.
261
262 Xapian can be troublesome, especially where file permissions are concerned: if
263 something acquires a lock on the index (for example, the moin script, possibly
264 invoked via moinsetup) nothing else will be able to modify the index, and this
265 may cause pages to become detached from their categories in the index.
266
267 To resolve index issues, try and run the following command (with the appropriate
268 options):
269
270 moin --config-dir=path-to-wiki --wiki-url=example.com/ index build --mode=rebuild
271
272 It may be necessary to manually remove locks. This can be done as follows:
273
274 find path-to-wiki/data/cache/xapian -depth -name "*-lock" -type d -exec rmdir '{}' \;
275
276 Contact, Copyright and Licence Information
277 ------------------------------------------
278
279 See the following Web pages for more information about this work:
280
281 http://moinmo.in/MacroMarket/EventAggregator
282 http://moinmo.in/ActionMarket/EventAggregator
283
284 The author can be contacted at the following e-mail address:
285
286 paul@boddie.org.uk
287
288 Copyright and licence information can be found in the docs directory - see
289 docs/COPYING.txt and docs/LICENCE.txt for more information.
290
291 Dependencies
292 ------------
293
294 EventAggregator has the following basic dependencies:
295
296 Packages Release Information
297 -------- -------------------
298
299 pytz Tested with 2007k (specifically 2007k-0ubuntu2)
300 Source: http://pytz.sourceforge.net/
301
302 If time zone handling is not required, pytz need not be installed, but this
303 may result in iCalendar summaries being produced that provide insufficient
304 time zone information for the correct interpretation of time information in
305 those summaries. Thus, it is highly recommended that pytz be installed.
306
307 New in EventAggregator 0.8.4 (Changes since EventAggregator 0.8.3)
308 ------------------------------------------------------------------
309
310 * The calculation of hour and minute offsets for time regimes west of the
311 prime meridian was not producing correct results since the day offset
312 provided by pytz was not being considered in the calculation. Such regimes
313 should now produce the expected (hour, minute) offsets such that events
314 employing these regimes can be positioned correctly on a UTC timescale.
315
316 New in EventAggregator 0.8.3 (Changes since EventAggregator 0.8.2)
317 ------------------------------------------------------------------
318
319 * The end dates defined in events from remote iCalendar event sources were
320 not correctly adjusted when aggregating such events. Thus, events with a
321 day-level resolution will have appeared one day longer in calendars and
322 summaries than was actually specified in the source data. This adjustment
323 has now been introduced.
324
325 New in EventAggregator 0.8.2 (Changes since EventAggregator 0.8.1)
326 ------------------------------------------------------------------
327
328 * Improved the error handling around remote event source data retrieval,
329 introducing handling of missing resources and unsupported content types.
330 * Improved the presentation of download and subscription links, adding
331 webcal: URL links for suitable calendar clients.
332
333 New in EventAggregator 0.8.1 (Changes since EventAggregator 0.8)
334 ----------------------------------------------------------------
335
336 * Changed the EventAggregatorNewEvent action to not save new event pages
337 directly, instead invoking the textual page editor for the page so that
338 the page text can be changed and the page saved without a redundant
339 initial version being created. Cancelling the editing operation will also
340 avoid the creation of unwanted event pages.
341 * Added a page break before each map in the print view, adding a page break
342 after each map to fully isolate unpositioned events on separate pages.
343 * Fixed errors where empty location fields were given in vCalendar events.
344 * Reintroduced event sorting in the list and table views.
345 * Fixed location positioning where some events employing an unknown location
346 do not position that location whereas others do (using "geo" information).
347
348 New in EventAggregator 0.8 (Changes since EventAggregator 0.7.1)
349 ----------------------------------------------------------------
350
351 * Added remote event aggregation with support for iCalendar event sources.
352 * Added support for explicit latitude and longitude event properties.
353 * Added support for decimal latitude and longitude values.
354 * Introduced in-page updates of the new event form, avoiding full-page
355 reloads when editing the initial details of an event.
356
357 New in EventAggregator 0.7.1 (Changes since EventAggregator 0.7)
358 ----------------------------------------------------------------
359
360 * Restored MoinMoin 1.9.x compatibility around WikiDict access.
361
362 New in EventAggregator 0.7 (Changes since EventAggregator 0.6.4)
363 ----------------------------------------------------------------
364
365 * Added a day view which shows events ordered according to their timespans
366 within each day.
367 * Added a map view which shows events according to their location. This
368 requires map images to be uploaded to a designated page, and map locations
369 to be defined on a designated page.
370 * Switched to using moinsetup for the installation procedure.
371 * Introduced formatting of description, location and topic information in
372 the list and table views and in RSS format summaries.
373 * Introduced support for days as calendar period units in the list view.
374 * Added "Help" and "New event" links alongside the calendar view controls,
375 giving the download and view controls centre alignment.
376
377 New in EventAggregator 0.6.4 (Changes since EventAggregator 0.6.3)
378 ------------------------------------------------------------------
379
380 * Fixed pop-up element labels where one limit of a calendar has not been
381 specified.
382
383 New in EventAggregator 0.6.3 (Changes since EventAggregator 0.6.2)
384 ------------------------------------------------------------------
385
386 * Fixed category membership parsing.
387 * Fixed open-ended calendars and their pop-up summaries.
388
389 New in EventAggregator 0.6.2 (Changes since EventAggregator 0.6.1)
390 ------------------------------------------------------------------
391
392 * Fixed HTML encoding in the forms generated by the actions.
393 * Dropped MoinMoin 1.5.x support, since Xapian search is not available for
394 that version and is virtually a necessity.
395 * Fixed form handling to be compatible with MoinMoin 1.9.x, since that
396 particular release series introduced an incompatible request API that
397 breaks existing code (no longer providing access to query string
398 parameters via the form attribute, and only returning single values
399 unless the new getlist method on form-like objects is used).
400 * Fixed the direct writing of requests to be compatible with MoinMoin 1.9.
401 * Added pop-up elements showing information about the calendar/view
402 resources available for download or subscription.
403 * Added download/subscription links which open the form associated with the
404 EventAggregatorSummary action and permit editing of the supplied values.
405
406 New in EventAggregator 0.6.1 (Changes since EventAggregator 0.6)
407 ----------------------------------------------------------------
408
409 * Fixed HTML encoding in the forms generated by the actions.
410
411 New in EventAggregator 0.6 (Changes since EventAggregator 0.5)
412 --------------------------------------------------------------
413
414 * Added print stylesheet rules in order to improve the printed versions of
415 calendars.
416 * Fixed definition list parsing to handle completely empty definitions
417 (having no space after the "::" token) which previously captured text from
418 subsequent lines, and merely empty definitions which previously would have
419 produced a single empty value for definitions providing lists of values.
420 * Added a script to import events from RSS feeds.
421 * Added support for a link entry in event pages, although this does not
422 replace the link information provided by the RSS and iCalendar summaries.
423 * Fixed the production of the summaries when pages with no available edit
424 log information are to be included.
425 * Added support for event times and time zone/regime information. This is
426 subject to revision.
427
428 New in EventAggregator 0.5 (Changes since EventAggregator 0.4)
429 --------------------------------------------------------------
430
431 * Changed the EventAggregatorNewEvent action to substitute only the stated
432 title, not the full page title, into the new page.
433 * Changed event colouring to use the event summary as the basis for
434 calculating the colour used in the calendar. This means that related
435 events can be coloured identically if their summaries are the same.
436 * Added support for multiple events on a single event page.
437 * Introduced EventPage and Event abstractions in order to better support new
438 features.
439 * Introduced basic and advanced modes to the EventAggregatorNewEvent action,
440 along with date swapping to correct cases where the start is given as
441 being later than the end of an event.
442 * Fixed the "download this calendar" and "subscribe to this calendar" links
443 by propagating the "raw" calendar start and end values within the macro.
444 These links should yield events only within the period defined for a
445 calendar, not all events in a calendar's categories. This fix also ensures
446 that the links for year- and month-relative calendars are correct, rather
447 than the specific links generated previously. Thus, a "this year's events"
448 link will now continue to produce a resource with the current year's
449 events, rather than the events from the year when the link was generated.
450
451 New in EventAggregator 0.4 (Changes since EventAggregator 0.3)
452 --------------------------------------------------------------
453
454 * Added a table view in the macro, using special topic/category styles to
455 provide background colours for events.
456 * Added category propagation from calendars to the new event form provided
457 by the EventAggregatorNewEvent action.
458 * Added a default template parameter to the macro, employed by the new event
459 form.
460 * Added a parent page parameter which is used by the new event form to place
461 new event pages in a particular location specific to a calendar or
462 collection of events.
463 * Improved the presentation of pop-up event information elements.
464 * Added navigation between display modes (calendar, list and table views).
465 * Ensured that calendar settings are retained when creating new events for a
466 calendar.
467 * Fixed various problems with events not having topics.
468
469 New in EventAggregator 0.3 (Changes since EventAggregator 0.2)
470 --------------------------------------------------------------
471
472 * Added a parameter to the EventAggregatorSummary action to select the
473 source of event descriptions for the RSS feed.
474 * Updated the documentation to cover the RSS support.
475 * Added the EventAggregatorNewEvent action.
476
477 New in EventAggregator 0.2 (Changes since EventAggregator 0.1)
478 --------------------------------------------------------------
479
480 * Improved the calendar view in the macro to use the fixed table layout
481 algorithm and to provide cells spanning potentially many columns for
482 continuing events. Introduced pop-up elements in order to show truncated
483 event names.
484 * Made the "weekly" naming policy the default in the calendar view.
485 * Improved the list view in the macro.
486 * Introduced RSS 2.0 feed support.
487 * Improved the help pages.
488
489 Release Procedures
490 ------------------
491
492 Update the EventAggregatorSupport.py __version__ attribute and the setup.py
493 version details.
494 Change the version number and package filename/directory in the documentation.
495 Update the setup.py and PKG-INFO files.
496 Update the release notes (see above).
497 Tag, export.
498 Archive, upload.
499 Update the MacroMarket and ActionMarket (see above for the URLs).