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