EventAggregator

Annotated README.txt

47:1cbad5c4b7f0
46:8337b0b6177d
45:f87374e888a2
2009-06-06 Paul Boddie file changeset files shortlog Added an action which adds new events, displaying a form for the event parameters, then copies an event template and makes a new page containing substituted values for each of the specified parameters. Added day number links from the HTML produced by the macro in order to invoke the action.
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@6     17 
Installation

 
 paul@6     18 
------------

 
 paul@6     19 
 
 paul@10     20 
To install the support library, consider using the setup.py script provided:

 
 paul@10     21 
 
 paul@10     22 
  python setup.py install

 
 paul@10     23 
 
 paul@10     24 
You may wish to indicate a specific prefix if MoinMoin is not installed in the

 
 paul@10     25 
traditional location:

 
 paul@10     26 
 
 paul@10     27 
  python setup.py install --prefix=path-to-moin-prefix

 
 paul@10     28 
 
 paul@6     29 
To install the macro in a Wiki, consider using the instmacros script provided:

 
 paul@6     30 
 
 paul@6     31 
  ./instmacros path-to-wiki

 
 paul@6     32 
 
 paul@6     33 
On non-UNIX platforms, it is necessary to manually copy the contents of the

 
 paul@6     34 
macros directory in this distribution into the macros directory of your Wiki.

 
 paul@6     35 
 
 paul@10     36 
It is highly recommended that the tables and listings be styled according to

 
 paul@10     37 
the stylesheet provided, and you can use this file as a starting point for

 
 paul@10     38 
your own modifications. To install the stylesheet, consider using the

 
 paul@10     39 
insttheme script provided:

 
 paul@10     40 
 
 paul@10     41 
  ./insttheme path-to-wiki theme-name

 
 paul@10     42 
 
 paul@10     43 
Again, on non-UNIX platforms, it is necessary to manually copy the files. In

 
 paul@10     44 
this case, just copy the contents of the css directory into the css directory

 
 paul@10     45 
of themes which will support styling of event calendars and listings.

 
 paul@10     46 
 
 paul@10     47 
To activate the styles provided by the stylesheet in the css directory, you

 
 paul@10     48 
will need to edit the screen.css file in each affected theme's css directory,

 
 paul@10     49 
adding the following before any style rules:

 
 paul@10     50 
 
 paul@10     51 
  /* Event aggregation... */

 
 paul@10     52 
 
 paul@10     53 
  @import "event-aggregator.css";

 
 paul@10     54 
 
 paul@10     55 
This ensures that the styles are made available to the browser.

 
 paul@10     56 
 
 paul@10     57 
To install the action in a Wiki, consider using the instactions script provided:

 
 paul@10     58 
 
 paul@10     59 
  ./instactions path-to-wiki

 
 paul@10     60 
 
 paul@10     61 
On non-UNIX platforms, it is necessary to manually copy the contents of the

 
 paul@10     62 
actions directory in this distribution into the actions directory of your Wiki.

 
 paul@10     63 
 
 paul@27     64 
Useful Pages

 
 paul@27     65 
------------

 
 paul@27     66 
 
 paul@27     67 
The pages directory contains a selection of useful pages using a syntax

 
 paul@27     68 
appropriate for use with MoinMoin 1.6 or later. These pages can be created

 
 paul@27     69 
through the Wiki and their contents copied in from each of the files.

 
 paul@27     70 
 
 paul@10     71 
Using the Macro

 
 paul@10     72 
---------------

 
 paul@10     73 
 
 paul@6     74 
It should now be possible to edit pages and use the macro as follows. For

 
 paul@6     75 
MoinMoin 1.5:

 
 paul@6     76 
 
 paul@20     77 
  [[EventAggregator(CategoryEvents)]]

 
 paul@6     78 
 
 paul@6     79 
For MoinMoin 1.6 and above:

 
 paul@6     80 
 
 paul@20     81 
  <<EventAggregator(CategoryEvents)>>

 
 paul@6     82 
 
 paul@6     83 
As arguments to the macro, you must indicate a comma-separated list of

 
 paul@6     84 
categories to be inspected for event data. For example:

 
 paul@6     85 
 
 paul@20     86 
  <<EventAggregator(CategoryEvents,CategoryTraining)>>

 
 paul@6     87 
 
 paul@6     88 
By default, this should display a calendar in a collection of tables, one for

 
 paul@6     89 
each month containing events. To show a collection of month-by-month listings,

 
 paul@6     90 
use the 'mode' argument as follows:

 
 paul@6     91 
 
 paul@20     92 
  <<EventAggregator(CategoryEvents,mode=list)>>

 
 paul@20     93 
 
 paul@20     94 
See pages/HelpOnEventAggregator for more detailed information.

 
 paul@6     95 
 
 paul@10     96 
Using the Action

 
 paul@10     97 
----------------

 
 paul@6     98 
 
 paul@20     99 
To obtain an iCalendar summary, the EventAggregatorSummary action can be

 
 paul@20    100 
selected from the actions menu on any page. Alternatively, a collection of

 
 paul@24    101 
parameters can be specified in the URL of any Wiki page.

 
 paul@6    102 
 
 paul@24    103 
See pages/HelpOnEventAggregatorSummary for more detailed information.

 
 paul@6    104 
 
 paul@6    105 
Recommended Software

 
 paul@6    106 
--------------------

 
 paul@6    107 
 
 paul@6    108 
The Xapian search software is highly recommended, if not technically

 
 paul@6    109 
essential, for the acceptable performance of the EventAggregator macro since

 
 paul@6    110 
the macro makes use of search routines in MoinMoin that can dominate the time

 
 paul@6    111 
spent processing requests.

 
 paul@6    112 
 
 paul@6    113 
See the following page for information on Xapian and MoinMoin:

 
 paul@6    114 
 
 paul@6    115 
http://moinmo.in/HelpOnXapian

 
 paul@6    116 
 
 paul@6    117 
Troubleshooting

 
 paul@6    118 
---------------

 
 paul@6    119 
 
 paul@6    120 
See here for a bug related to category recognition:

 
 paul@6    121 
 
 paul@6    122 
http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing

 
 paul@6    123 
 
 paul@6    124 
This affects installations where migrations between versions have occurred,

 
 paul@6    125 
yet the Wiki configuration retains old regular expression details.

 
 paul@6    126 
 
 paul@6    127 
Contact, Copyright and Licence Information

 
 paul@6    128 
------------------------------------------

 
 paul@6    129 
 
 paul@10    130 
See the following Web pages for more information about this work:

 
 paul@6    131 
 
 paul@6    132 
http://moinmo.in/MacroMarket/EventAggregator

 
 paul@10    133 
http://moinmo.in/ActionMarket/EventAggregator

 
 paul@6    134 
 
 paul@6    135 
The author can be contacted at the following e-mail address:

 
 paul@6    136 
 
 paul@6    137 
paul@boddie.org.uk

 
 paul@6    138 
 
 paul@6    139 
Copyright and licence information can be found in the docs directory - see

 
 paul@6    140 
docs/COPYING.txt and docs/LICENCE.txt for more information.

 
 paul@6    141 
 
 paul@45    142 
New in EventAggregator 0.3 (Changes since EventAggregator 0.2)

 
 paul@45    143 
--------------------------------------------------------------

 
 paul@45    144 
 
 paul@45    145 
  * Added a parameter to the EventAggregatorSummary action to select the

 
 paul@45    146 
    source of event descriptions for the RSS feed.

 
 paul@45    147 
  * Updated the documentation to cover the RSS support.

 
 paul@45    148 
 
 paul@41    149 
New in EventAggregator 0.2 (Changes since EventAggregator 0.1)

 
 paul@41    150 
--------------------------------------------------------------

 
 paul@41    151 
 
 paul@41    152 
  * Improved the calendar view in the macro to use the fixed table layout

 
 paul@41    153 
    algorithm and to provide cells spanning potentially many columns for

 
 paul@41    154 
    continuing events. Introduced pop-up elements in order to show truncated

 
 paul@41    155 
    event names.

 
 paul@41    156 
  * Made the "weekly" naming policy the default in the calendar view.

 
 paul@41    157 
  * Improved the list view in the macro.

 
 paul@41    158 
  * Introduced RSS 2.0 feed support.

 
 paul@41    159 
  * Improved the help pages. 

 
 paul@41    160 
 
 paul@6    161 
Release Procedures

 
 paul@6    162 
------------------

 
 paul@6    163 
 
 paul@18    164 
Update the EventAggregatorSupport.py __version__ attribute and the setup.py

 
 paul@18    165 
version details.

 
 paul@6    166 
Change the version number and package filename/directory in the documentation.

 
 paul@42    167 
Update the setup.py file.

 
 paul@6    168 
Update the release notes (see above).

 
 paul@6    169 
Tag, export.

 
 paul@6    170 
Archive, upload.

 
 paul@10    171 
Update the MacroMarket and ActionMarket (see above for the URLs).