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 CategoryEvent). 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 Installation
12 ------------
13
14 To install the macro in a Wiki, consider using the instmacros script provided:
15
16 ./instmacros path-to-wiki
17
18 On non-UNIX platforms, it is necessary to manually copy the contents of the
19 macros directory in this distribution into the macros directory of your Wiki.
20
21 It should now be possible to edit pages and use the macro as follows. For
22 MoinMoin 1.5:
23
24 [[EventAggregator(CategoryEvent)]]
25
26 For MoinMoin 1.6 and above:
27
28 <<EventAggregator(CategoryEvent)>>
29
30 As arguments to the macro, you must indicate a comma-separated list of
31 categories to be inspected for event data. For example:
32
33 <<EventAggregator(CategoryEvent,CategoryTraining)>>
34
35 By default, this should display a calendar in a collection of tables, one for
36 each month containing events. To show a collection of month-by-month listings,
37 use the 'mode' argument as follows:
38
39 <<EventAggregator(CategoryEvent,mode=list)>>
40
41 It is highly recommended that the tables and listings be styled according to
42 the stylesheet provided, and you can use this file as a starting point for
43 your own modifications. To install the stylesheet, consider using the
44 insttheme script provided:
45
46 ./insttheme path-to-wiki theme-name
47
48 Again, on non-UNIX platforms, it is necessary to manually copy the files. In
49 this case, just copy the contents of the css directory into the css directory
50 of themes which will support styling of event calendars and listings.
51
52 To activate the styles provided by the stylesheet in the css directory, you
53 will need to edit the screen.css file in each affected theme's css directory,
54 adding the following before any style rules:
55
56 /* Event aggregation... */
57
58 @import "event-aggregator.css";
59
60 This ensures that the styles are made available to the browser.
61
62 Recommended Software
63 --------------------
64
65 The Xapian search software is highly recommended, if not technically
66 essential, for the acceptable performance of the EventAggregator macro since
67 the macro makes use of search routines in MoinMoin that can dominate the time
68 spent processing requests.
69
70 See the following page for information on Xapian and MoinMoin:
71
72 http://moinmo.in/HelpOnXapian
73
74 Troubleshooting
75 ---------------
76
77 See here for a bug related to category recognition:
78
79 http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
80
81 This affects installations where migrations between versions have occurred,
82 yet the Wiki configuration retains old regular expression details.
83
84 Contact, Copyright and Licence Information
85 ------------------------------------------
86
87 See the following Web page for more information about this work:
88
89 http://moinmo.in/MacroMarket/EventAggregator
90
91 The author can be contacted at the following e-mail address:
92
93 paul@boddie.org.uk
94
95 Copyright and licence information can be found in the docs directory - see
96 docs/COPYING.txt and docs/LICENCE.txt for more information.
97
98 Release Procedures
99 ------------------
100
101 Update the EventAggregator.py __version__ attribute.
102 Change the version number and package filename/directory in the documentation.
103 Update the release notes (see above).
104 Tag, export.
105 Archive, upload.
106 Update the MacroMarket (see above for the URL).