EventAggregator

pages/HelpOnEventAggregatorSummary

70:007ddda87bdb
2010-02-01 Paul Boddie Added multiple events per page support notes.
     1 ##master-page:HelpTemplate     2 ##master-date:Unknown-Date     3 #format wiki     4 #language en     5      6 == EventAggregatorSummary ==     7      8 The !EventAggregatorSummary action provides iCalendar summaries of events whose details are recorded in pages belonging to specific categories (such as CategoryEvents). These summaries can then be imported into applications which understand the iCalendar format.     9     10 Upon invoking the action, an iCalendar response will be produced. If the action is invoked in a browser, it is most likely that a dialogue box will appear asking you whether you would like to save the response to a file or to open the response in a suitable application. This behaviour is slightly different to many !MoinMoin actions.    11     12 == Using the Actions Menu Entry ==    13     14 The action can be selected from the actions menu on any page; this will produce a form requesting values for the following items:    15     16  * The names of categories known to the Wiki.    17  * The start (first month) of the summary (optional).    18  * The end (last month) of the summary (optional).    19     20 Where no start or end values are specified, all events in the chosen categories are included in the summary.    21     22 == Making Direct Requests to the Action ==    23     24 Alternatively, a collection of parameters can be specified in the URL of any Wiki page. For example:    25     26 {{{    27 http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&doit=1    28 }}}    29     30 This should produce an iCalendar resource in response. By specifying `start` and `end` parameters, a restricted view can be obtained. For example:    31     32 {{{    33 http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents    34 &start=2009-06&end=2009-07&doit=1    35 }}}    36     37 This restricts the initial query to only retrieve events occurring in the months of June 2009 (`2009-06`) and July 2009 (`2009-07`).    38     39 === RSS 2.0 Feeds ===    40     41 By adding the `format` parameter, an RSS feed resource can be produced:    42     43 {{{    44 http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&doit=1&    45 format=RSS    46 }}}    47     48 This resource produces a description of all events within the stated criteria. Updated events should be detected by feed readers and each subscriber notified of such updates, with the comment made when the affected event was edited being provided as the event description in the feed.    49     50 A technical note: feed readers will typically detect updated events by consulting the content of each event description's `guid` element, notifying the user of changes if the content of that element has itself changed.    51     52 == See Also ==    53     54  * HelpOnEventAggregator - a macro producing event calendars and listings