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