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 Installation
24 ------------
25
26 To install the support library, consider using the setup.py script provided:
27
28 python setup.py install
29
30 You may wish to indicate a specific prefix if MoinMoin is not installed in the
31 traditional location:
32
33 python setup.py install --prefix=path-to-moin-prefix
34
35 To install the macro in a Wiki, consider using the instmacros script provided:
36
37 ./instmacros path-to-wiki
38
39 On non-UNIX platforms, it is necessary to manually copy the contents of the
40 macros directory in this distribution into the macros directory of your Wiki.
41
42 It is highly recommended that the tables and listings be styled according to
43 the stylesheet provided, and you can use this file as a starting point for
44 your own modifications. To install the stylesheet, consider using the
45 insttheme script provided:
46
47 ./insttheme path-to-wiki theme-name
48
49 Again, on non-UNIX platforms, it is necessary to manually copy the files. In
50 this case, just copy the contents of the css directory into the css directory
51 of themes which will support styling of event calendars and listings.
52
53 To activate the styles provided by the stylesheet in the css directory, you
54 will need to edit the screen.css file in each affected theme's css directory,
55 adding the following before any style rules:
56
57 /* Event aggregation... */
58
59 @import "event-aggregator.css";
60
61 This ensures that the styles are made available to the browser.
62
63 To install the actions in a Wiki, consider using the instactions script provided:
64
65 ./instactions path-to-wiki
66
67 On non-UNIX platforms, it is necessary to manually copy the contents of the
68 actions directory in this distribution into the actions directory of your Wiki.
69
70 Useful Pages
71 ------------
72
73 The pages directory contains a selection of useful pages using a syntax
74 appropriate for use with MoinMoin 1.6 or later. These pages can be created
75 through the Wiki and their contents copied in from each of the files.
76
77 Using the Macro
78 ---------------
79
80 It should now be possible to edit pages and use the macro as follows. For
81 MoinMoin 1.5:
82
83 [[EventAggregator(CategoryEvents)]]
84
85 For MoinMoin 1.6 and above:
86
87 <<EventAggregator(CategoryEvents)>>
88
89 As arguments to the macro, you must indicate a comma-separated list of
90 categories to be inspected for event data. For example:
91
92 <<EventAggregator(CategoryEvents,CategoryTraining)>>
93
94 By default, this should display a calendar in a collection of tables, one for
95 each month containing events. To show a collection of month-by-month listings,
96 use the 'mode' argument as follows:
97
98 <<EventAggregator(CategoryEvents,mode=list)>>
99
100 See pages/HelpOnEventAggregator for more detailed information.
101
102 Using the Actions
103 -----------------
104
105 To obtain an iCalendar summary, the EventAggregatorSummary action can be
106 selected from the actions menu on any page. Alternatively, a collection of
107 parameters can be specified in the URL of any Wiki page.
108
109 See pages/HelpOnEventAggregatorSummary for more detailed information.
110
111 To create new events using the EventAggregatorNewEvent action, the appropriate
112 menu entry can be selected in the actions menu. Alternatively, clicking on a
113 day number in a calendar view will invoke the action and pre-fill the form
114 with the start date set to the selected day from the calendar.
115
116 See pages/HelpOnEventAggregatorNewEvent for more detailed information.
117
118 Recommended Software
119 --------------------
120
121 The Xapian search software is highly recommended, if not technically
122 essential, for the acceptable performance of the EventAggregator macro since
123 the macro makes use of search routines in MoinMoin that can dominate the time
124 spent processing requests.
125
126 See the following page for information on Xapian and MoinMoin:
127
128 http://moinmo.in/HelpOnXapian
129
130 Troubleshooting
131 ---------------
132
133 See here for a bug related to category recognition:
134
135 http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
136
137 This affects installations where migrations between versions have occurred,
138 yet the Wiki configuration retains old regular expression details.
139
140 Contact, Copyright and Licence Information
141 ------------------------------------------
142
143 See the following Web pages for more information about this work:
144
145 http://moinmo.in/MacroMarket/EventAggregator
146 http://moinmo.in/ActionMarket/EventAggregator
147
148 The author can be contacted at the following e-mail address:
149
150 paul@boddie.org.uk
151
152 Copyright and licence information can be found in the docs directory - see
153 docs/COPYING.txt and docs/LICENCE.txt for more information.
154
155 New in EventAggregator 0.3 (Changes since EventAggregator 0.2)
156 --------------------------------------------------------------
157
158 * Added a parameter to the EventAggregatorSummary action to select the
159 source of event descriptions for the RSS feed.
160 * Updated the documentation to cover the RSS support.
161 * Added the EventAggregatorNewEvent action.
162
163 New in EventAggregator 0.2 (Changes since EventAggregator 0.1)
164 --------------------------------------------------------------
165
166 * Improved the calendar view in the macro to use the fixed table layout
167 algorithm and to provide cells spanning potentially many columns for
168 continuing events. Introduced pop-up elements in order to show truncated
169 event names.
170 * Made the "weekly" naming policy the default in the calendar view.
171 * Improved the list view in the macro.
172 * Introduced RSS 2.0 feed support.
173 * Improved the help pages.
174
175 Release Procedures
176 ------------------
177
178 Update the EventAggregatorSupport.py __version__ attribute and the setup.py
179 version details.
180 Change the version number and package filename/directory in the documentation.
181 Update the setup.py file.
182 Update the release notes (see above).
183 Tag, export.
184 Archive, upload.
185 Update the MacroMarket and ActionMarket (see above for the URLs).
