paul@6 | 1 | Introduction
|
paul@6 | 2 | ------------
|
paul@6 | 3 |
|
paul@6 | 4 | The EventAggregator macro for MoinMoin can be used to display event calendars
|
paul@6 | 5 | or listings which obtain their data from pages belonging to specific
|
paul@20 | 6 | categories (such as CategoryEvents). The start and end dates are read from the
|
paul@6 | 7 | page describing each event, and the calendar is automatically filled out with
|
paul@6 | 8 | the details of each event, colouring each event period in a specially
|
paul@6 | 9 | generated colour.
|
paul@6 | 10 |
|
paul@44 | 11 | The EventAggregatorSummary action can be used to provide iCalendar and RSS
|
paul@44 | 12 | summaries of event data based on pages belonging to specific categories, as
|
paul@44 | 13 | described above. The category, start and end parameters are read directly from
|
paul@44 | 14 | the request as URL or form parameters: these restrict the extent of each
|
paul@44 | 15 | generated summary.
|
paul@10 | 16 |
|
paul@47 | 17 | The EventAggregatorNewEvent action can be used to conveniently create new
|
paul@47 | 18 | event pages, displaying a simple form which can be filled out in order to
|
paul@47 | 19 | provide elementary event details such as the event title or summary, the
|
paul@47 | 20 | categories to which the page will be assigned, and the start and end dates of
|
paul@47 | 21 | the event.
|
paul@47 | 22 |
|
paul@88 | 23 | The eventfeed script can be used to import events from RSS feeds, inserting
|
paul@88 | 24 | new pages into a Wiki.
|
paul@88 | 25 |
|
paul@80 | 26 | Important Notices
|
paul@80 | 27 | -----------------
|
paul@80 | 28 |
|
paul@139 | 29 | Release 0.7 fixes various bugs in HTML production done by the actions. It is
|
paul@139 | 30 | strongly recommended to upgrade from earlier versions to this release.
|
paul@139 | 31 |
|
paul@117 | 32 | In release 0.7, support for MoinMoin 1.5.x has been dropped. Since usage of
|
paul@117 | 33 | the Xapian search software is practically a necessary part of deploying this
|
paul@117 | 34 | solution, and yet Xapian only became integrated with MoinMoin from version 1.6
|
paul@117 | 35 | onwards, few deployments should have involved MoinMoin 1.5.x.
|
paul@117 | 36 |
|
paul@102 | 37 | In release 0.6, support for event times has been introduced. Due to the
|
paul@102 | 38 | complicated nature of times, time zones, time regimes, and so on, the
|
paul@102 | 39 | behaviour of the software may change in future versions to support common
|
paul@102 | 40 | use-cases in a more convenient fashion. Please be aware that implicitly chosen
|
paul@102 | 41 | or generated time or time zone information may change for events, particularly
|
paul@106 | 42 | those whose times are ambiguous or ill-defined. It is highly recommended that
|
paul@106 | 43 | the pytz library be installed - see the documentation regarding dependencies
|
paul@106 | 44 | for more information.
|
paul@102 | 45 |
|
paul@80 | 46 | In release 0.5, the "download this calendar" and "subscribe to this calendar"
|
paul@80 | 47 | links have been fixed to return only events within the specified period and to
|
paul@80 | 48 | work with day- and month-relative calendars. Users who have bookmarks in their
|
paul@80 | 49 | Web browser or feed reader should replace these bookmarks by visiting the
|
paul@88 | 50 | bookmarked page and acquiring new versions of these links, once
|
paul@88 | 51 | EventAggregator has been upgraded.
|
paul@80 | 52 |
|
paul@6 | 53 | Installation
|
paul@6 | 54 | ------------
|
paul@6 | 55 |
|
paul@90 | 56 | To install the support library and MoinMoin-related scripts, consider using
|
paul@90 | 57 | the setup.py script provided:
|
paul@10 | 58 |
|
paul@10 | 59 | python setup.py install
|
paul@10 | 60 |
|
paul@10 | 61 | You may wish to indicate a specific prefix if MoinMoin is not installed in the
|
paul@10 | 62 | traditional location:
|
paul@10 | 63 |
|
paul@10 | 64 | python setup.py install --prefix=path-to-moin-prefix
|
paul@10 | 65 |
|
paul@6 | 66 | To install the macro in a Wiki, consider using the instmacros script provided:
|
paul@6 | 67 |
|
paul@6 | 68 | ./instmacros path-to-wiki
|
paul@6 | 69 |
|
paul@6 | 70 | On non-UNIX platforms, it is necessary to manually copy the contents of the
|
paul@6 | 71 | macros directory in this distribution into the macros directory of your Wiki.
|
paul@6 | 72 |
|
paul@10 | 73 | It is highly recommended that the tables and listings be styled according to
|
paul@10 | 74 | the stylesheet provided, and you can use this file as a starting point for
|
paul@10 | 75 | your own modifications. To install the stylesheet, consider using the
|
paul@10 | 76 | insttheme script provided:
|
paul@10 | 77 |
|
paul@10 | 78 | ./insttheme path-to-wiki theme-name
|
paul@10 | 79 |
|
paul@10 | 80 | Again, on non-UNIX platforms, it is necessary to manually copy the files. In
|
paul@10 | 81 | this case, just copy the contents of the css directory into the css directory
|
paul@10 | 82 | of themes which will support styling of event calendars and listings.
|
paul@10 | 83 |
|
paul@10 | 84 | To activate the styles provided by the stylesheet in the css directory, you
|
paul@10 | 85 | will need to edit the screen.css file in each affected theme's css directory,
|
paul@10 | 86 | adding the following before any style rules:
|
paul@10 | 87 |
|
paul@10 | 88 | /* Event aggregation... */
|
paul@10 | 89 |
|
paul@10 | 90 | @import "event-aggregator.css";
|
paul@10 | 91 |
|
paul@82 | 92 | This ensures that the styles are made available to the browser. Additionally,
|
paul@82 | 93 | to make sure that printed pages are correctly styled, the following also needs
|
paul@82 | 94 | to be added to the print.css file in each affected theme's css directory:
|
paul@82 | 95 |
|
paul@82 | 96 | /* Event aggregation... */
|
paul@82 | 97 |
|
paul@82 | 98 | @import "event-aggregator-print.css";
|
paul@82 | 99 | @import "event-aggregator.css";
|
paul@10 | 100 |
|
paul@88 | 101 | To install the actions in a Wiki, consider using the instactions script
|
paul@88 | 102 | provided:
|
paul@10 | 103 |
|
paul@10 | 104 | ./instactions path-to-wiki
|
paul@10 | 105 |
|
paul@10 | 106 | On non-UNIX platforms, it is necessary to manually copy the contents of the
|
paul@88 | 107 | actions directory in this distribution into the actions directory of your
|
paul@88 | 108 | Wiki.
|
paul@88 | 109 |
|
paul@27 | 110 | Useful Pages
|
paul@27 | 111 | ------------
|
paul@27 | 112 |
|
paul@27 | 113 | The pages directory contains a selection of useful pages using a syntax
|
paul@27 | 114 | appropriate for use with MoinMoin 1.6 or later. These pages can be created
|
paul@27 | 115 | through the Wiki and their contents copied in from each of the files.
|
paul@27 | 116 |
|
paul@10 | 117 | Using the Macro
|
paul@10 | 118 | ---------------
|
paul@10 | 119 |
|
paul@117 | 120 | It should now be possible to edit pages and use the macro as follows:
|
paul@6 | 121 |
|
paul@20 | 122 | <<EventAggregator(CategoryEvents)>>
|
paul@6 | 123 |
|
paul@6 | 124 | As arguments to the macro, you must indicate a comma-separated list of
|
paul@6 | 125 | categories to be inspected for event data. For example:
|
paul@6 | 126 |
|
paul@20 | 127 | <<EventAggregator(CategoryEvents,CategoryTraining)>>
|
paul@6 | 128 |
|
paul@6 | 129 | By default, this should display a calendar in a collection of tables, one for
|
paul@6 | 130 | each month containing events. To show a collection of month-by-month listings,
|
paul@6 | 131 | use the 'mode' argument as follows:
|
paul@6 | 132 |
|
paul@20 | 133 | <<EventAggregator(CategoryEvents,mode=list)>>
|
paul@20 | 134 |
|
paul@20 | 135 | See pages/HelpOnEventAggregator for more detailed information.
|
paul@6 | 136 |
|
paul@47 | 137 | Using the Actions
|
paul@47 | 138 | -----------------
|
paul@6 | 139 |
|
paul@20 | 140 | To obtain an iCalendar summary, the EventAggregatorSummary action can be
|
paul@20 | 141 | selected from the actions menu on any page. Alternatively, a collection of
|
paul@24 | 142 | parameters can be specified in the URL of any Wiki page.
|
paul@6 | 143 |
|
paul@24 | 144 | See pages/HelpOnEventAggregatorSummary for more detailed information.
|
paul@6 | 145 |
|
paul@47 | 146 | To create new events using the EventAggregatorNewEvent action, the appropriate
|
paul@47 | 147 | menu entry can be selected in the actions menu. Alternatively, clicking on a
|
paul@47 | 148 | day number in a calendar view will invoke the action and pre-fill the form
|
paul@47 | 149 | with the start date set to the selected day from the calendar.
|
paul@47 | 150 |
|
paul@47 | 151 | See pages/HelpOnEventAggregatorNewEvent for more detailed information.
|
paul@47 | 152 |
|
paul@88 | 153 | Running the Scripts
|
paul@88 | 154 | -------------------
|
paul@88 | 155 |
|
paul@88 | 156 | To import events from an RSS feed, the eventfeed script integrated with the
|
paul@88 | 157 | moin program can be used as follows:
|
paul@88 | 158 |
|
paul@88 | 159 | moin --config-dir=path-to-wiki --wiki-url=example.com/ \
|
paul@88 | 160 | import eventfeed --url=url-of-events-feed
|
paul@88 | 161 |
|
paul@88 | 162 | Thus, to import events from the FSFE events RSS feed, the following command
|
paul@88 | 163 | could be used:
|
paul@88 | 164 |
|
paul@88 | 165 | moin --config-dir=path-to-wiki --wiki-url=example.com/ \
|
paul@88 | 166 | import eventfeed --url=http://www.fsfe.org/events/events.en.rss
|
paul@88 | 167 |
|
paul@88 | 168 | If this command is being used with sudo, make sure to use the -u option so
|
paul@88 | 169 | that the script can operate as the appropriate user. For example:
|
paul@88 | 170 |
|
paul@88 | 171 | sudo -u www-data moin --config-dir=path-to-wiki --wiki-url=example.com/ \
|
paul@88 | 172 | import eventfeed --url=http://www.fsfe.org/events/events.en.rss
|
paul@88 | 173 |
|
paul@88 | 174 | It may also be necessary to set PYTHONPATH directly before the moin program
|
paul@88 | 175 | name and even to explicitly use the path to that program.
|
paul@88 | 176 |
|
paul@6 | 177 | Recommended Software
|
paul@6 | 178 | --------------------
|
paul@6 | 179 |
|
paul@6 | 180 | The Xapian search software is highly recommended, if not technically
|
paul@6 | 181 | essential, for the acceptable performance of the EventAggregator macro since
|
paul@6 | 182 | the macro makes use of search routines in MoinMoin that can dominate the time
|
paul@6 | 183 | spent processing requests.
|
paul@6 | 184 |
|
paul@6 | 185 | See the following page for information on Xapian and MoinMoin:
|
paul@6 | 186 |
|
paul@6 | 187 | http://moinmo.in/HelpOnXapian
|
paul@6 | 188 |
|
paul@6 | 189 | Troubleshooting
|
paul@6 | 190 | ---------------
|
paul@6 | 191 |
|
paul@6 | 192 | See here for a bug related to category recognition:
|
paul@6 | 193 |
|
paul@6 | 194 | http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
|
paul@6 | 195 |
|
paul@6 | 196 | This affects installations where migrations between versions have occurred,
|
paul@6 | 197 | yet the Wiki configuration retains old regular expression details.
|
paul@6 | 198 |
|
paul@6 | 199 | Contact, Copyright and Licence Information
|
paul@6 | 200 | ------------------------------------------
|
paul@6 | 201 |
|
paul@10 | 202 | See the following Web pages for more information about this work:
|
paul@6 | 203 |
|
paul@6 | 204 | http://moinmo.in/MacroMarket/EventAggregator
|
paul@10 | 205 | http://moinmo.in/ActionMarket/EventAggregator
|
paul@6 | 206 |
|
paul@6 | 207 | The author can be contacted at the following e-mail address:
|
paul@6 | 208 |
|
paul@6 | 209 | paul@boddie.org.uk
|
paul@6 | 210 |
|
paul@6 | 211 | Copyright and licence information can be found in the docs directory - see
|
paul@6 | 212 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@6 | 213 |
|
paul@106 | 214 | Dependencies
|
paul@106 | 215 | ------------
|
paul@106 | 216 |
|
paul@106 | 217 | EventAggregator has the following basic dependencies:
|
paul@106 | 218 |
|
paul@106 | 219 | Packages Release Information
|
paul@106 | 220 | -------- -------------------
|
paul@106 | 221 |
|
paul@106 | 222 | pytz Tested with 2007k (specifically 2007k-0ubuntu2)
|
paul@106 | 223 | Source: http://pytz.sourceforge.net/
|
paul@106 | 224 |
|
paul@106 | 225 | If time zone handling is not required, pytz need not be installed, but this
|
paul@106 | 226 | may result in iCalendar summaries being produced that provide insufficient
|
paul@106 | 227 | time zone information for the correct interpretation of time information in
|
paul@106 | 228 | those summaries. Thus, it is highly recommended that pytz be installed.
|
paul@106 | 229 |
|
paul@109 | 230 | New in EventAggregator 0.7 (Changes since EventAggregator 0.6)
|
paul@109 | 231 | --------------------------------------------------------------
|
paul@109 | 232 |
|
paul@136 | 233 | * Fixed HTML encoding in the forms generated by the actions.
|
paul@117 | 234 | * Dropped MoinMoin 1.5.x support, since Xapian search is not available for
|
paul@117 | 235 | that version and is virtually a necessity.
|
paul@109 | 236 | * Fixed form handling to be compatible with MoinMoin 1.9.x, since that
|
paul@109 | 237 | particular release series introduced an incompatible request API that
|
paul@109 | 238 | breaks existing code (no longer providing access to query string
|
paul@109 | 239 | parameters via the form attribute, and only returning single values
|
paul@109 | 240 | unless the new getlist method on form-like objects is used).
|
paul@110 | 241 | * Fixed the direct writing of requests to be compatible with MoinMoin 1.9.
|
paul@113 | 242 | * Added pop-up elements showing information about the calendar/view
|
paul@113 | 243 | resources available for download or subscription.
|
paul@113 | 244 | * Added download/subscription links which open the form associated with the
|
paul@113 | 245 | EventAggregatorSummary action and permit editing of the supplied values.
|
paul@129 | 246 | * Added a day view which shows events ordered according to their timespans
|
paul@129 | 247 | within each day.
|
paul@109 | 248 |
|
paul@139 | 249 | New in EventAggregator 0.6.1 (Changes since EventAggregator 0.6)
|
paul@139 | 250 | ----------------------------------------------------------------
|
paul@139 | 251 |
|
paul@139 | 252 | * Fixed HTML encoding in the forms generated by the actions.
|
paul@139 | 253 |
|
paul@82 | 254 | New in EventAggregator 0.6 (Changes since EventAggregator 0.5)
|
paul@82 | 255 | --------------------------------------------------------------
|
paul@82 | 256 |
|
paul@82 | 257 | * Added print stylesheet rules in order to improve the printed versions of
|
paul@82 | 258 | calendars.
|
paul@84 | 259 | * Fixed definition list parsing to handle completely empty definitions
|
paul@84 | 260 | (having no space after the "::" token) which previously captured text from
|
paul@84 | 261 | subsequent lines, and merely empty definitions which previously would have
|
paul@84 | 262 | produced a single empty value for definitions providing lists of values.
|
paul@88 | 263 | * Added a script to import events from RSS feeds.
|
paul@88 | 264 | * Added support for a link entry in event pages, although this does not
|
paul@88 | 265 | replace the link information provided by the RSS and iCalendar summaries.
|
paul@89 | 266 | * Fixed the production of the summaries when pages with no available edit
|
paul@89 | 267 | log information are to be included.
|
paul@102 | 268 | * Added support for event times and time zone/regime information. This is
|
paul@102 | 269 | subject to revision.
|
paul@82 | 270 |
|
paul@65 | 271 | New in EventAggregator 0.5 (Changes since EventAggregator 0.4)
|
paul@65 | 272 | --------------------------------------------------------------
|
paul@65 | 273 |
|
paul@65 | 274 | * Changed the EventAggregatorNewEvent action to substitute only the stated
|
paul@65 | 275 | title, not the full page title, into the new page.
|
paul@66 | 276 | * Changed event colouring to use the event summary as the basis for
|
paul@66 | 277 | calculating the colour used in the calendar. This means that related
|
paul@66 | 278 | events can be coloured identically if their summaries are the same.
|
paul@71 | 279 | * Added support for multiple events on a single event page.
|
paul@71 | 280 | * Introduced EventPage and Event abstractions in order to better support new
|
paul@71 | 281 | features.
|
paul@78 | 282 | * Introduced basic and advanced modes to the EventAggregatorNewEvent action,
|
paul@78 | 283 | along with date swapping to correct cases where the start is given as
|
paul@78 | 284 | being later than the end of an event.
|
paul@77 | 285 | * Fixed the "download this calendar" and "subscribe to this calendar" links
|
paul@77 | 286 | by propagating the "raw" calendar start and end values within the macro.
|
paul@77 | 287 | These links should yield events only within the period defined for a
|
paul@77 | 288 | calendar, not all events in a calendar's categories. This fix also ensures
|
paul@77 | 289 | that the links for year- and month-relative calendars are correct, rather
|
paul@77 | 290 | than the specific links generated previously. Thus, a "this year's events"
|
paul@77 | 291 | link will now continue to produce a resource with the current year's
|
paul@77 | 292 | events, rather than the events from the year when the link was generated.
|
paul@65 | 293 |
|
paul@51 | 294 | New in EventAggregator 0.4 (Changes since EventAggregator 0.3)
|
paul@51 | 295 | --------------------------------------------------------------
|
paul@51 | 296 |
|
paul@51 | 297 | * Added a table view in the macro, using special topic/category styles to
|
paul@51 | 298 | provide background colours for events.
|
paul@56 | 299 | * Added category propagation from calendars to the new event form provided
|
paul@56 | 300 | by the EventAggregatorNewEvent action.
|
paul@56 | 301 | * Added a default template parameter to the macro, employed by the new event
|
paul@56 | 302 | form.
|
paul@56 | 303 | * Added a parent page parameter which is used by the new event form to place
|
paul@56 | 304 | new event pages in a particular location specific to a calendar or
|
paul@56 | 305 | collection of events.
|
paul@56 | 306 | * Improved the presentation of pop-up event information elements.
|
paul@59 | 307 | * Added navigation between display modes (calendar, list and table views).
|
paul@59 | 308 | * Ensured that calendar settings are retained when creating new events for a
|
paul@59 | 309 | calendar.
|
paul@59 | 310 | * Fixed various problems with events not having topics.
|
paul@51 | 311 |
|
paul@45 | 312 | New in EventAggregator 0.3 (Changes since EventAggregator 0.2)
|
paul@45 | 313 | --------------------------------------------------------------
|
paul@45 | 314 |
|
paul@45 | 315 | * Added a parameter to the EventAggregatorSummary action to select the
|
paul@45 | 316 | source of event descriptions for the RSS feed.
|
paul@45 | 317 | * Updated the documentation to cover the RSS support.
|
paul@47 | 318 | * Added the EventAggregatorNewEvent action.
|
paul@45 | 319 |
|
paul@41 | 320 | New in EventAggregator 0.2 (Changes since EventAggregator 0.1)
|
paul@41 | 321 | --------------------------------------------------------------
|
paul@41 | 322 |
|
paul@41 | 323 | * Improved the calendar view in the macro to use the fixed table layout
|
paul@41 | 324 | algorithm and to provide cells spanning potentially many columns for
|
paul@41 | 325 | continuing events. Introduced pop-up elements in order to show truncated
|
paul@41 | 326 | event names.
|
paul@41 | 327 | * Made the "weekly" naming policy the default in the calendar view.
|
paul@41 | 328 | * Improved the list view in the macro.
|
paul@41 | 329 | * Introduced RSS 2.0 feed support.
|
paul@41 | 330 | * Improved the help pages.
|
paul@41 | 331 |
|
paul@6 | 332 | Release Procedures
|
paul@6 | 333 | ------------------
|
paul@6 | 334 |
|
paul@18 | 335 | Update the EventAggregatorSupport.py __version__ attribute and the setup.py
|
paul@18 | 336 | version details.
|
paul@6 | 337 | Change the version number and package filename/directory in the documentation.
|
paul@51 | 338 | Update the setup.py and PKG-INFO files.
|
paul@6 | 339 | Update the release notes (see above).
|
paul@6 | 340 | Tag, export.
|
paul@6 | 341 | Archive, upload.
|
paul@10 | 342 | Update the MacroMarket and ActionMarket (see above for the URLs).
|