1.1 --- a/README.txt Sat Feb 27 01:43:30 2010 +0100
1.2 +++ b/README.txt Sat Mar 06 22:51:27 2010 +0100
1.3 @@ -20,6 +20,9 @@
1.4 categories to which the page will be assigned, and the start and end dates of
1.5 the event.
1.6
1.7 +The eventfeed script can be used to import events from RSS feeds, inserting
1.8 +new pages into a Wiki.
1.9 +
1.10 Important Notices
1.11 -----------------
1.12
1.13 @@ -27,8 +30,8 @@
1.14 links have been fixed to return only events within the specified period and to
1.15 work with day- and month-relative calendars. Users who have bookmarks in their
1.16 Web browser or feed reader should replace these bookmarks by visiting the
1.17 -bookmarked page and acquiring new versions of these links, once EventAggregator
1.18 -has been upgraded.
1.19 +bookmarked page and acquiring new versions of these links, once
1.20 +EventAggregator has been upgraded.
1.21
1.22 Installation
1.23 ------------
1.24 @@ -77,12 +80,24 @@
1.25 @import "event-aggregator-print.css";
1.26 @import "event-aggregator.css";
1.27
1.28 -To install the actions in a Wiki, consider using the instactions script provided:
1.29 +To install the actions in a Wiki, consider using the instactions script
1.30 +provided:
1.31
1.32 ./instactions path-to-wiki
1.33
1.34 On non-UNIX platforms, it is necessary to manually copy the contents of the
1.35 -actions directory in this distribution into the actions directory of your Wiki.
1.36 +actions directory in this distribution into the actions directory of your
1.37 +Wiki.
1.38 +
1.39 +To install the eventfeed script which can import events from RSS feeds, use
1.40 +the instscripts script, making sure to set your PYTHONPATH so that the script
1.41 +can find your MoinMoin installation:
1.42 +
1.43 + PYTHONPATH=path-to-site-packages ./instscripts
1.44 +
1.45 +This script should work on UNIX and non-UNIX systems, although the above
1.46 +example demonstrates setting the PYTHONPATH in the bash shell on UNIX-like
1.47 +systems.
1.48
1.49 Useful Pages
1.50 ------------
1.51 @@ -132,6 +147,30 @@
1.52
1.53 See pages/HelpOnEventAggregatorNewEvent for more detailed information.
1.54
1.55 +Running the Scripts
1.56 +-------------------
1.57 +
1.58 +To import events from an RSS feed, the eventfeed script integrated with the
1.59 +moin program can be used as follows:
1.60 +
1.61 +moin --config-dir=path-to-wiki --wiki-url=example.com/ \
1.62 + import eventfeed --url=url-of-events-feed
1.63 +
1.64 +Thus, to import events from the FSFE events RSS feed, the following command
1.65 +could be used:
1.66 +
1.67 +moin --config-dir=path-to-wiki --wiki-url=example.com/ \
1.68 + import eventfeed --url=http://www.fsfe.org/events/events.en.rss
1.69 +
1.70 +If this command is being used with sudo, make sure to use the -u option so
1.71 +that the script can operate as the appropriate user. For example:
1.72 +
1.73 +sudo -u www-data moin --config-dir=path-to-wiki --wiki-url=example.com/ \
1.74 + import eventfeed --url=http://www.fsfe.org/events/events.en.rss
1.75 +
1.76 +It may also be necessary to set PYTHONPATH directly before the moin program
1.77 +name and even to explicitly use the path to that program.
1.78 +
1.79 Recommended Software
1.80 --------------------
1.81
1.82 @@ -178,6 +217,9 @@
1.83 (having no space after the "::" token) which previously captured text from
1.84 subsequent lines, and merely empty definitions which previously would have
1.85 produced a single empty value for definitions providing lists of values.
1.86 + * Added a script to import events from RSS feeds.
1.87 + * Added support for a link entry in event pages, although this does not
1.88 + replace the link information provided by the RSS and iCalendar summaries.
1.89
1.90 New in EventAggregator 0.5 (Changes since EventAggregator 0.4)
1.91 --------------------------------------------------------------