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