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