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.6.2 fixes various bugs in HTML production done by the actions. It is
30 strongly recommended to upgrade from earlier versions to this or a later
31 release.
32
33 In release 0.6.2, support for MoinMoin 1.5.x has been dropped. Since usage of
34 the Xapian search software is practically a necessary part of deploying this
35 solution, and yet Xapian only became integrated with MoinMoin from version 1.6
36 onwards, few deployments should have involved MoinMoin 1.5.x.
37
38 In release 0.6, support for event times has been introduced. Due to the
39 complicated nature of times, time zones, time regimes, and so on, the
40 behaviour of the software may change in future versions to support common
41 use-cases in a more convenient fashion. Please be aware that implicitly chosen
42 or generated time or time zone information may change for events, particularly
43 those whose times are ambiguous or ill-defined. It is highly recommended that
44 the pytz library be installed - see the documentation regarding dependencies
45 for more information.
46
47 In release 0.5, the "download this calendar" and "subscribe to this calendar"
48 links have been fixed to return only events within the specified period and to
49 work with day- and month-relative calendars. Users who have bookmarks in their
50 Web browser or feed reader should replace these bookmarks by visiting the
51 bookmarked page and acquiring new versions of these links, once
52 EventAggregator has been upgraded.
53
54 Installation
55 ------------
56
57 To install the support library and MoinMoin-related scripts, consider using
58 the setup.py script provided:
59
60 python setup.py install
61
62 You may wish to indicate a specific prefix if MoinMoin is not installed in the
63 traditional location:
64
65 python setup.py install --prefix=path-to-moin-prefix
66
67 To install the macro in a Wiki, consider using the instmacros script provided:
68
69 ./instmacros path-to-wiki
70
71 On non-UNIX platforms, it is necessary to manually copy the contents of the
72 macros directory in this distribution into the macros directory of your Wiki.
73
74 It is highly recommended that the tables and listings be styled according to
75 the stylesheet provided, and you can use this file as a starting point for
76 your own modifications. To install the stylesheet, consider using the
77 insttheme script provided:
78
79 ./insttheme path-to-wiki theme-name
80
81 Again, on non-UNIX platforms, it is necessary to manually copy the files. In
82 this case, just copy the contents of the css directory into the css directory
83 of themes which will support styling of event calendars and listings.
84
85 To activate the styles provided by the stylesheet in the css directory, you
86 will need to edit the screen.css file in each affected theme's css directory,
87 adding the following before any style rules:
88
89 /* Event aggregation... */
90
91 @import "event-aggregator.css";
92
93 This ensures that the styles are made available to the browser. Additionally,
94 to make sure that printed pages are correctly styled, the following also needs
95 to be added to the print.css file in each affected theme's css directory:
96
97 /* Event aggregation... */
98
99 @import "event-aggregator-print.css";
100 @import "event-aggregator.css";
101
102 To install the actions in a Wiki, consider using the instactions script
103 provided:
104
105 ./instactions path-to-wiki
106
107 On non-UNIX platforms, it is necessary to manually copy the contents of the
108 actions directory in this distribution into the actions directory of your
109 Wiki.
110
111 Useful Pages
112 ------------
113
114 The pages directory contains a selection of useful pages using a syntax
115 appropriate for use with MoinMoin 1.6 or later. These pages can be created
116 through the Wiki and their contents copied in from each of the files.
117
118 Using the Macro
119 ---------------
120
121 It should now be possible to edit pages and use the macro as follows:
122
123 <<EventAggregator(CategoryEvents)>>
124
125 As arguments to the macro, you must indicate a comma-separated list of
126 categories to be inspected for event data. For example:
127
128 <<EventAggregator(CategoryEvents,CategoryTraining)>>
129
130 By default, this should display a calendar in a collection of tables, one for
131 each month containing events. To show a collection of month-by-month listings,
132 use the 'mode' argument as follows:
133
134 <<EventAggregator(CategoryEvents,mode=list)>>
135
136 See pages/HelpOnEventAggregator for more detailed information.
137
138 Using the Actions
139 -----------------
140
141 To obtain an iCalendar summary, the EventAggregatorSummary action can be
142 selected from the actions menu on any page. Alternatively, a collection of
143 parameters can be specified in the URL of any Wiki page.
144
145 See pages/HelpOnEventAggregatorSummary for more detailed information.
146
147 To create new events using the EventAggregatorNewEvent action, the appropriate
148 menu entry can be selected in the actions menu. Alternatively, clicking on a
149 day number in a calendar view will invoke the action and pre-fill the form
150 with the start date set to the selected day from the calendar.
151
152 See pages/HelpOnEventAggregatorNewEvent for more detailed information.
153
154 Running the Scripts
155 -------------------
156
157 To import events from an RSS feed, the eventfeed script integrated with the
158 moin program can be used as follows:
159
160 moin --config-dir=path-to-wiki --wiki-url=example.com/ \
161 import eventfeed --url=url-of-events-feed
162
163 Thus, to import events from the FSFE events RSS feed, the following command
164 could be used:
165
166 moin --config-dir=path-to-wiki --wiki-url=example.com/ \
167 import eventfeed --url=http://www.fsfe.org/events/events.en.rss
168
169 If this command is being used with sudo, make sure to use the -u option so
170 that the script can operate as the appropriate user. For example:
171
172 sudo -u www-data moin --config-dir=path-to-wiki --wiki-url=example.com/ \
173 import eventfeed --url=http://www.fsfe.org/events/events.en.rss
174
175 It may also be necessary to set PYTHONPATH directly before the moin program
176 name and even to explicitly use the path to that program.
177
178 Recommended Software
179 --------------------
180
181 The Xapian search software is highly recommended, if not technically
182 essential, for the acceptable performance of the EventAggregator macro since
183 the macro makes use of search routines in MoinMoin that can dominate the time
184 spent processing requests.
185
186 See the following page for information on Xapian and MoinMoin:
187
188 http://moinmo.in/HelpOnXapian
189
190 Troubleshooting
191 ---------------
192
193 See here for a bug related to category recognition:
194
195 http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
196
197 This affects installations where migrations between versions have occurred,
198 yet the Wiki configuration retains old regular expression details.
199
200 Contact, Copyright and Licence Information
201 ------------------------------------------
202
203 See the following Web pages for more information about this work:
204
205 http://moinmo.in/MacroMarket/EventAggregator
206 http://moinmo.in/ActionMarket/EventAggregator
207
208 The author can be contacted at the following e-mail address:
209
210 paul@boddie.org.uk
211
212 Copyright and licence information can be found in the docs directory - see
213 docs/COPYING.txt and docs/LICENCE.txt for more information.
214
215 Dependencies
216 ------------
217
218 EventAggregator has the following basic dependencies:
219
220 Packages Release Information
221 -------- -------------------
222
223 pytz Tested with 2007k (specifically 2007k-0ubuntu2)
224 Source: http://pytz.sourceforge.net/
225
226 If time zone handling is not required, pytz need not be installed, but this
227 may result in iCalendar summaries being produced that provide insufficient
228 time zone information for the correct interpretation of time information in
229 those summaries. Thus, it is highly recommended that pytz be installed.
230
231 New in EventAggregator 0.6.4 (Changes since EventAggregator 0.6.3)
232 ------------------------------------------------------------------
233
234 * Fixed pop-up element labels where one limit of a calendar has not been
235 specified.
236
237 New in EventAggregator 0.6.3 (Changes since EventAggregator 0.6.2)
238 ------------------------------------------------------------------
239
240 * Fixed category membership parsing.
241 * Fixed open-ended calendars and their pop-up summaries.
242
243 New in EventAggregator 0.6.2 (Changes since EventAggregator 0.6.1)
244 ------------------------------------------------------------------
245
246 * Dropped MoinMoin 1.5.x support, since Xapian search is not available for
247 that version and is virtually a necessity.
248 * Fixed form handling to be compatible with MoinMoin 1.9.x, since that
249 particular release series introduced an incompatible request API that
250 breaks existing code (no longer providing access to query string
251 parameters via the form attribute, and only returning single values
252 unless the new getlist method on form-like objects is used).
253 * Fixed the direct writing of requests to be compatible with MoinMoin 1.9.
254 * Added pop-up elements showing information about the calendar/view
255 resources available for download or subscription.
256 * Added download/subscription links which open the form associated with the
257 EventAggregatorSummary action and permit editing of the supplied values.
258
259 New in EventAggregator 0.6.1 (Changes since EventAggregator 0.6)
260 ----------------------------------------------------------------
261
262 * Fixed HTML encoding in the forms generated by the actions.
263
264 New in EventAggregator 0.6 (Changes since EventAggregator 0.5)
265 --------------------------------------------------------------
266
267 * Added print stylesheet rules in order to improve the printed versions of
268 calendars.
269 * Fixed definition list parsing to handle completely empty definitions
270 (having no space after the "::" token) which previously captured text from
271 subsequent lines, and merely empty definitions which previously would have
272 produced a single empty value for definitions providing lists of values.
273 * Added a script to import events from RSS feeds.
274 * Added support for a link entry in event pages, although this does not
275 replace the link information provided by the RSS and iCalendar summaries.
276 * Fixed the production of the summaries when pages with no available edit
277 log information are to be included.
278 * Added support for event times and time zone/regime information. This is
279 subject to revision.
280
281 New in EventAggregator 0.5 (Changes since EventAggregator 0.4)
282 --------------------------------------------------------------
283
284 * Changed the EventAggregatorNewEvent action to substitute only the stated
285 title, not the full page title, into the new page.
286 * Changed event colouring to use the event summary as the basis for
287 calculating the colour used in the calendar. This means that related
288 events can be coloured identically if their summaries are the same.
289 * Added support for multiple events on a single event page.
290 * Introduced EventPage and Event abstractions in order to better support new
291 features.
292 * Introduced basic and advanced modes to the EventAggregatorNewEvent action,
293 along with date swapping to correct cases where the start is given as
294 being later than the end of an event.
295 * Fixed the "download this calendar" and "subscribe to this calendar" links
296 by propagating the "raw" calendar start and end values within the macro.
297 These links should yield events only within the period defined for a
298 calendar, not all events in a calendar's categories. This fix also ensures
299 that the links for year- and month-relative calendars are correct, rather
300 than the specific links generated previously. Thus, a "this year's events"
301 link will now continue to produce a resource with the current year's
302 events, rather than the events from the year when the link was generated.
303
304 New in EventAggregator 0.4 (Changes since EventAggregator 0.3)
305 --------------------------------------------------------------
306
307 * Added a table view in the macro, using special topic/category styles to
308 provide background colours for events.
309 * Added category propagation from calendars to the new event form provided
310 by the EventAggregatorNewEvent action.
311 * Added a default template parameter to the macro, employed by the new event
312 form.
313 * Added a parent page parameter which is used by the new event form to place
314 new event pages in a particular location specific to a calendar or
315 collection of events.
316 * Improved the presentation of pop-up event information elements.
317 * Added navigation between display modes (calendar, list and table views).
318 * Ensured that calendar settings are retained when creating new events for a
319 calendar.
320 * Fixed various problems with events not having topics.
321
322 New in EventAggregator 0.3 (Changes since EventAggregator 0.2)
323 --------------------------------------------------------------
324
325 * Added a parameter to the EventAggregatorSummary action to select the
326 source of event descriptions for the RSS feed.
327 * Updated the documentation to cover the RSS support.
328 * Added the EventAggregatorNewEvent action.
329
330 New in EventAggregator 0.2 (Changes since EventAggregator 0.1)
331 --------------------------------------------------------------
332
333 * Improved the calendar view in the macro to use the fixed table layout
334 algorithm and to provide cells spanning potentially many columns for
335 continuing events. Introduced pop-up elements in order to show truncated
336 event names.
337 * Made the "weekly" naming policy the default in the calendar view.
338 * Improved the list view in the macro.
339 * Introduced RSS 2.0 feed support.
340 * Improved the help pages.
341
342 Release Procedures
343 ------------------
344
345 Update the EventAggregatorSupport.py __version__ attribute and the setup.py
346 version details.
347 Change the version number and package filename/directory in the documentation.
348 Update the setup.py and PKG-INFO files.
349 Update the release notes (see above).
350 Tag, export.
351 Archive, upload.
352 Update the MacroMarket and ActionMarket (see above for the URLs).