# HG changeset patch # User Paul Boddie # Date 1238882887 -7200 # Node ID 5582d8b9d3ed697ebc79744a94a885e7a7eaf404 # Parent 913dc30323da0c0fcfe7d60c9d4155d2f62fb9af Added RSS notes. diff -r 913dc30323da -r 5582d8b9d3ed README.txt --- a/README.txt Sat Apr 04 23:49:49 2009 +0200 +++ b/README.txt Sun Apr 05 00:08:07 2009 +0200 @@ -8,11 +8,11 @@ the details of each event, colouring each event period in a specially generated colour. -The EventAggregatorSummary action can be used to provide an iCalendar summary -of event data based on pages belonging to specific categories, as described -above. The category, start and end parameters are read directly from the -request as URL or form parameters: these restrict the extent of each generated -summary. +The EventAggregatorSummary action can be used to provide iCalendar and RSS +summaries of event data based on pages belonging to specific categories, as +described above. The category, start and end parameters are read directly from +the request as URL or form parameters: these restrict the extent of each +generated summary. Installation ------------ diff -r 913dc30323da -r 5582d8b9d3ed pages/HelpOnEventAggregatorSummary --- a/pages/HelpOnEventAggregatorSummary Sat Apr 04 23:49:49 2009 +0200 +++ b/pages/HelpOnEventAggregatorSummary Sun Apr 05 00:08:07 2009 +0200 @@ -36,6 +36,19 @@ This restricts the initial query to only retrieve events occurring in the months of June 2009 (`2009-06`) and July 2009 (`2009-07`). +=== RSS 2.0 Feeds === + +By adding the `format` parameter, an RSS feed resource can be produced: + +{{{ +http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&doit=1& +format=RSS +}}} + +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. + +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. + == See Also == * HelpOnEventAggregator - a macro producing event calendars and listings