1.1 --- a/README.txt Fri Mar 27 01:00:15 2009 +0100
1.2 +++ b/README.txt Sat Mar 28 01:11:39 2009 +0100
1.3 @@ -3,7 +3,7 @@
1.4
1.5 The EventAggregator macro for MoinMoin can be used to display event calendars
1.6 or listings which obtain their data from pages belonging to specific
1.7 -categories (such as CategoryEvent). The start and end dates are read from the
1.8 +categories (such as CategoryEvents). The start and end dates are read from the
1.9 page describing each event, and the calendar is automatically filled out with
1.10 the details of each event, colouring each event period in a specially
1.11 generated colour.
1.12 @@ -66,35 +66,38 @@
1.13 It should now be possible to edit pages and use the macro as follows. For
1.14 MoinMoin 1.5:
1.15
1.16 - [[EventAggregator(CategoryEvent)]]
1.17 + [[EventAggregator(CategoryEvents)]]
1.18
1.19 For MoinMoin 1.6 and above:
1.20
1.21 - <<EventAggregator(CategoryEvent)>>
1.22 + <<EventAggregator(CategoryEvents)>>
1.23
1.24 As arguments to the macro, you must indicate a comma-separated list of
1.25 categories to be inspected for event data. For example:
1.26
1.27 - <<EventAggregator(CategoryEvent,CategoryTraining)>>
1.28 + <<EventAggregator(CategoryEvents,CategoryTraining)>>
1.29
1.30 By default, this should display a calendar in a collection of tables, one for
1.31 each month containing events. To show a collection of month-by-month listings,
1.32 use the 'mode' argument as follows:
1.33
1.34 - <<EventAggregator(CategoryEvent,mode=list)>>
1.35 + <<EventAggregator(CategoryEvents,mode=list)>>
1.36 +
1.37 +See pages/HelpOnEventAggregator for more detailed information.
1.38
1.39 Using the Action
1.40 ----------------
1.41
1.42 -To obtain an iCalendar summary, a collection of parameters can be specified in
1.43 -the URL of any Wiki page. For example:
1.44 +To obtain an iCalendar summary, the EventAggregatorSummary action can be
1.45 +selected from the actions menu on any page. Alternatively, a collection of
1.46 +parameters can be specified in the URL of any Wiki page. For example:
1.47
1.48 - http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents
1.49 + http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&doit=1
1.50
1.51 This should produce an iCalendar resource in response. By specifying 'start'
1.52 and 'end' parameters, a restricted view can be obtained. For example:
1.53
1.54 - http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&start=2009-06&end=2009-07
1.55 + http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&start=2009-06&end=2009-07&doit=1
1.56
1.57 This would restrict the initial query to events occurring in the months of
1.58 June 2009 ('2009-06') and July 2009 ('2009-07').