Index: openacs-4/packages/rss-support/www/doc/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/rss-support/www/doc/index.html,v diff -u -r1.1 -r1.2 --- openacs-4/packages/rss-support/www/doc/index.html 4 Nov 2001 23:17:40 -0000 1.1 +++ openacs-4/packages/rss-support/www/doc/index.html 5 Nov 2001 02:53:33 -0000 1.2 @@ -63,15 +63,17 @@

-The feed generation service contract consists of two operations. +The feed generation service contract is called RssGenerationSubscriber and consists of two operations.

    -
  1. RssGenDatasource. The return value of RssGenDatasource -contains all required metadata fields as well as configuration -information such as the RSS version to be used (0.91 or 1.00 are -supported at present). -
  2. RssLastUpdated. Used to determine if the live summary -is out of date. +
  3. Datasource(context_identifier) returns a data +structure that contains all required metadata fields plus +configuration information such as the RSS version to be used (0.91 or +1.00 are supported at present). This data structure contains +everything needed to run rss_gen. + +
  4. LastUpdated(context_identifier) returns a timestamp +that is used to determine if the live summary is out of date.

@@ -97,13 +99,15 @@

  • A scheduled proc runs through all registered contexts, checking to see if the live summary is stale and also if the minimum "quiet time" has elapsed. -
  • If the conditions for rebuild are met for a context, the scheduled proc pulls - out the context's summary data via RssGenDatasource and uses the - information to build a new summary page. This generic and simple scheme - can be used to dispatch different versions of the summary builder as well - as to support extensibility via modules. Warning: - This design expects the output of RssGenDatasource to be reasonably small, - as we will have to parse this list-of-lists to generate a summary. +
  • If the conditions for rebuild are met for a context, the scheduled + proc pulls out the context's summary data via + Datasource and uses the information to build a new + summary page. This generic and simple scheme can be used to + dispatch different versions of the summary builder as well as to + support extensibility via modules. Warning: + This design expects the output of Datasource to be + reasonably small, as we will have to parse this list-of-lists to + generate a summary.