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