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