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