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