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