Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

To download an event, look for the download icon on the event details page or in a list view.  To download a calendar, visit the "All “All Topical Areas" Areas” section of a public calendar suite and select the icon to download the calendar.  Calendars can be downloaded from today into the future, for past dates, or for a date range.

...

Subscriptions to Bedework's public events can be pulled for use in Bedework's user client, where there is built in integration for subscribing to public calendars, and from any ical capable calendar client.  RSS and javascript feeds are also available (see "Data feeds" “Data feeds” below).

Data feeds - ical, raw xml, rss, json, js, etc.

Bedework 3.6 ships with a specialized application for serving data feeds: the "feeder" “feeder” web app found at http://localhost:8080/feeder.  The feeder app comes with a number of skins, the default being clean XML. 

Bedework has a special action for generating a discreet list of events most useful to data feeds: the listEvents action.  If you want to produce feeds from other Bedework actions, see the stylesheet examples in the feeder app's "default" “default” directory. 

Data feeds rely on XSL stylesheets to transform Bedework XML into a proper output format, except for the case of iCalendar feeds which are converted by the system directly.

Be aware: data feeds can potentially request large amounts of data which can be further compounded by a high request rate.  The core Bedework system should be protected by a front end caching system, and Bedework 3.6 ships with an example cache and URL builder packaged in Tomcat (see: http://localhost:9090/urlbuilder ).  For more information about the URL builder and web cache, see  the section 6.9 in this chapter,  "Cached “Cached Feed and URL Builder"Builder”

Several caching systems have been recently developed for use with Bedework.  Please visit the Bedework webite, wiki, and mailing lists for information about caching if you anticipate using the feed API directly against your system.

...

2.    Return a list of events within a specified date range; if no start date is supplied, begin today. The maximum number of days returned is limited to 31. Requesting a range larger than this limit will return an error.

The action's action’s simplest form looks like:
http://localhost:8080/cal/listEvents.do
and returns the discrete events for the next seven days.

...

A number of Bedework skins provide a means for arbitrary filtering, and are easily extended.  For example, the list-json.xsl skin found in the feeder app allows for the a key/value pair to be sent with a filter name as an application variable.  By extending this file you could, for example, send the parameter: "setappvar“setappvar=filter(location:Jefferson Hall)" and then use this to filter events in the stylesheet.

...

(note: these exclude the calPath parameter.  In most cases, you should append the calPath to the query string shown.  e.g.  "&calPath=/public/cals/MainCal"MainCal”).

/listEvents.do?days=4
returns the next four days' events

...

/listEvents.do?days=3&catuid=ff808181-1fd7389e-011f-d7389eff-00000004
returns the next three days worth of events filtered by the category "Exhibits" (as found in the quickstart).

*http://localhost:8080/cal/main/listEvents.do?start=2009-06-07&format=text/calendar\* (http://localhost:8080/cal/main/listEvents.do?start=2009-06-07&format=text/calendar*)
returns events in icalendar format for seven days starting June 7, 2009

...

To output the data in RSS, append the query string with "&skinName=rss-list"list”, e.g.

/listEvents.do?days=4&skinName=rss-list

To output the data in json, append the query string with "&skinName=json-list-src"src”, e.g.

/listEvents.do?days=4&skinName=json-list-src

Starting with the rss-list.xsl or json-list-src.xsl files it is easy to build your own output types and data feeds.  For more information on these topics, see the chapter 6 "Bedework Theming" “Bedework Theming” and the Bedework wiki: "Using “Using json Feeds in Static Web Pages"Pages”.

http://www.bedework.org/trac/bedework/wiki/BedeworkManual/v3.6/DesignGuide/jsonFeeds

...