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@6 | 6 | categories (such as CategoryEvent). 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@6 | 11 | Installation
|
paul@6 | 12 | ------------
|
paul@6 | 13 |
|
paul@6 | 14 | To install the macro in a Wiki, consider using the instmacros script provided:
|
paul@6 | 15 |
|
paul@6 | 16 | ./instmacros path-to-wiki
|
paul@6 | 17 |
|
paul@6 | 18 | On non-UNIX platforms, it is necessary to manually copy the contents of the
|
paul@6 | 19 | macros directory in this distribution into the macros directory of your Wiki.
|
paul@6 | 20 |
|
paul@6 | 21 | It should now be possible to edit pages and use the macro as follows. For
|
paul@6 | 22 | MoinMoin 1.5:
|
paul@6 | 23 |
|
paul@6 | 24 | [[EventAggregator(CategoryEvent)]]
|
paul@6 | 25 |
|
paul@6 | 26 | For MoinMoin 1.6 and above:
|
paul@6 | 27 |
|
paul@6 | 28 | <<EventAggregator(CategoryEvent)>>
|
paul@6 | 29 |
|
paul@6 | 30 | As arguments to the macro, you must indicate a comma-separated list of
|
paul@6 | 31 | categories to be inspected for event data. For example:
|
paul@6 | 32 |
|
paul@6 | 33 | <<EventAggregator(CategoryEvent,CategoryTraining)>>
|
paul@6 | 34 |
|
paul@6 | 35 | By default, this should display a calendar in a collection of tables, one for
|
paul@6 | 36 | each month containing events. To show a collection of month-by-month listings,
|
paul@6 | 37 | use the 'mode' argument as follows:
|
paul@6 | 38 |
|
paul@6 | 39 | <<EventAggregator(CategoryEvent,mode=list)>>
|
paul@6 | 40 |
|
paul@6 | 41 | It is highly recommended that the tables and listings be styled according to
|
paul@6 | 42 | the stylesheet provided, and you can use this file as a starting point for
|
paul@6 | 43 | your own modifications. To install the stylesheet, consider using the
|
paul@6 | 44 | insttheme script provided:
|
paul@6 | 45 |
|
paul@6 | 46 | ./insttheme path-to-wiki theme-name
|
paul@6 | 47 |
|
paul@6 | 48 | Again, on non-UNIX platforms, it is necessary to manually copy the files. In
|
paul@6 | 49 | this case, just copy the contents of the css directory into the css directory
|
paul@6 | 50 | of themes which will support styling of event calendars and listings.
|
paul@6 | 51 |
|
paul@6 | 52 | To activate the styles provided by the stylesheet in the css directory, you
|
paul@6 | 53 | will need to edit the screen.css file in each affected theme's css directory,
|
paul@6 | 54 | adding the following before any style rules:
|
paul@6 | 55 |
|
paul@6 | 56 | /* Event aggregation... */
|
paul@6 | 57 |
|
paul@6 | 58 | @import "event-aggregator.css";
|
paul@6 | 59 |
|
paul@6 | 60 | This ensures that the styles are made available to the browser.
|
paul@6 | 61 |
|
paul@6 | 62 | Recommended Software
|
paul@6 | 63 | --------------------
|
paul@6 | 64 |
|
paul@6 | 65 | The Xapian search software is highly recommended, if not technically
|
paul@6 | 66 | essential, for the acceptable performance of the EventAggregator macro since
|
paul@6 | 67 | the macro makes use of search routines in MoinMoin that can dominate the time
|
paul@6 | 68 | spent processing requests.
|
paul@6 | 69 |
|
paul@6 | 70 | See the following page for information on Xapian and MoinMoin:
|
paul@6 | 71 |
|
paul@6 | 72 | http://moinmo.in/HelpOnXapian
|
paul@6 | 73 |
|
paul@6 | 74 | Troubleshooting
|
paul@6 | 75 | ---------------
|
paul@6 | 76 |
|
paul@6 | 77 | See here for a bug related to category recognition:
|
paul@6 | 78 |
|
paul@6 | 79 | http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
|
paul@6 | 80 |
|
paul@6 | 81 | This affects installations where migrations between versions have occurred,
|
paul@6 | 82 | yet the Wiki configuration retains old regular expression details.
|
paul@6 | 83 |
|
paul@6 | 84 | Contact, Copyright and Licence Information
|
paul@6 | 85 | ------------------------------------------
|
paul@6 | 86 |
|
paul@6 | 87 | See the following Web page for more information about this work:
|
paul@6 | 88 |
|
paul@6 | 89 | http://moinmo.in/MacroMarket/EventAggregator
|
paul@6 | 90 |
|
paul@6 | 91 | The author can be contacted at the following e-mail address:
|
paul@6 | 92 |
|
paul@6 | 93 | paul@boddie.org.uk
|
paul@6 | 94 |
|
paul@6 | 95 | Copyright and licence information can be found in the docs directory - see
|
paul@6 | 96 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@6 | 97 |
|
paul@6 | 98 | Release Procedures
|
paul@6 | 99 | ------------------
|
paul@6 | 100 |
|
paul@6 | 101 | Update the EventAggregator.py __version__ attribute.
|
paul@6 | 102 | Change the version number and package filename/directory in the documentation.
|
paul@6 | 103 | Update the release notes (see above).
|
paul@6 | 104 | Tag, export.
|
paul@6 | 105 | Archive, upload.
|
paul@6 | 106 | Update the MacroMarket (see above for the URL).
|