1.1 --- a/resource_pages/EventSourcesDict Sun Mar 30 20:04:32 2014 +0200
1.2 +++ b/resource_pages/EventSourcesDict Sun Mar 30 20:32:50 2014 +0200
1.3 @@ -1,9 +1,33 @@
1.4 The following event sources are defined for !EventAggregator:
1.5
1.6 - GriCal:: http://grical.org/s/?query=%23free-software+{start}+{end}&view=ical ical
1.7 + GriCal:: url http://grical.org/s/?query=%23free-software+{start}+{end}&view=ical ical
1.8 +
1.9 +To add a new source, extend the above definition list, putting the name of the source (to be used with the !EventAggregator macro) as the definition title, and putting the source's URL and the format of the data provided by the source, separated by whitespace, as the definition body. An expected content type can also be specified if the source provides content labelled with an unconventional content type.
1.10 +
1.11 +Other types of sources can be specified by replacing `url` with another source type and using the appropriate parameters. See the syntax description below for details.
1.12 +
1.13 +== Syntax ==
1.14 +
1.15 +For a `url` source indicating a source accessible via a specified URL:
1.16 +
1.17 +{{{
1.18 + name:: url <url> <format> [ <content-type> ]
1.19 +}}}
1.20
1.21 -To add a new source, extend the above definition list, putting the name of the source (to be used with the !EventAggregator macro) as the definition title, and putting the source's URL and the format of the data provided by the source, separated by whitespace, as the definition body.
1.22 +For `store` source types indicating a sources accessible via an item store associated with a wiki page:
1.23 +
1.24 +{{{
1.25 + name:: store <page-name> <store-name> [ <lock-directory-name> ]
1.26 +}}}
1.27 +
1.28 +== Formats ==
1.29
1.30 -Currently, `ical` is the only supported format, referring to iCalendar ([[http://tools.ietf.org/html/rfc2445|RFC 2445]] and [[http://tools.ietf.org/html/rfc5545|RFC 5545]]).
1.31 +Currently, the supported formats are:
1.32 +
1.33 + * `ical`: iCalendar ([[http://tools.ietf.org/html/rfc5545|RFC 5545]])
1.34 + * `xcal`: xCalendar ([[http://tools.ietf.org/html/draft-hare-xcalendar-03|draft-hare-xcalendar-03]])
1.35 + * `mbox`: [[http://tools.ietf.org/html/rfc2045|multipart]] e-mail messages containing iCalendar or xCalendar content parts
1.36 +
1.37 +== Caching ==
1.38
1.39 Events from sources for a particular view are cached in !EventAggregator for a period of time. The default period of 300 seconds (5 minutes) can be changed by defining the `event_aggregator_max_cache_age` in the [[HelpOnConfiguration|Wiki configuration]], specifying a number of seconds to be used for the maximum age of a cache entry.