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