1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sun Mar 22 21:49:44 2009 +0100
1.3 @@ -0,0 +1,106 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The EventAggregator macro for MoinMoin can be used to display event calendars
1.8 +or listings which obtain their data from pages belonging to specific
1.9 +categories (such as CategoryEvent). The start and end dates are read from the
1.10 +page describing each event, and the calendar is automatically filled out with
1.11 +the details of each event, colouring each event period in a specially
1.12 +generated colour.
1.13 +
1.14 +Installation
1.15 +------------
1.16 +
1.17 +To install the macro in a Wiki, consider using the instmacros script provided:
1.18 +
1.19 + ./instmacros path-to-wiki
1.20 +
1.21 +On non-UNIX platforms, it is necessary to manually copy the contents of the
1.22 +macros directory in this distribution into the macros directory of your Wiki.
1.23 +
1.24 +It should now be possible to edit pages and use the macro as follows. For
1.25 +MoinMoin 1.5:
1.26 +
1.27 + [[EventAggregator(CategoryEvent)]]
1.28 +
1.29 +For MoinMoin 1.6 and above:
1.30 +
1.31 + <<EventAggregator(CategoryEvent)>>
1.32 +
1.33 +As arguments to the macro, you must indicate a comma-separated list of
1.34 +categories to be inspected for event data. For example:
1.35 +
1.36 + <<EventAggregator(CategoryEvent,CategoryTraining)>>
1.37 +
1.38 +By default, this should display a calendar in a collection of tables, one for
1.39 +each month containing events. To show a collection of month-by-month listings,
1.40 +use the 'mode' argument as follows:
1.41 +
1.42 + <<EventAggregator(CategoryEvent,mode=list)>>
1.43 +
1.44 +It is highly recommended that the tables and listings be styled according to
1.45 +the stylesheet provided, and you can use this file as a starting point for
1.46 +your own modifications. To install the stylesheet, consider using the
1.47 +insttheme script provided:
1.48 +
1.49 + ./insttheme path-to-wiki theme-name
1.50 +
1.51 +Again, on non-UNIX platforms, it is necessary to manually copy the files. In
1.52 +this case, just copy the contents of the css directory into the css directory
1.53 +of themes which will support styling of event calendars and listings.
1.54 +
1.55 +To activate the styles provided by the stylesheet in the css directory, you
1.56 +will need to edit the screen.css file in each affected theme's css directory,
1.57 +adding the following before any style rules:
1.58 +
1.59 + /* Event aggregation... */
1.60 +
1.61 + @import "event-aggregator.css";
1.62 +
1.63 +This ensures that the styles are made available to the browser.
1.64 +
1.65 +Recommended Software
1.66 +--------------------
1.67 +
1.68 +The Xapian search software is highly recommended, if not technically
1.69 +essential, for the acceptable performance of the EventAggregator macro since
1.70 +the macro makes use of search routines in MoinMoin that can dominate the time
1.71 +spent processing requests.
1.72 +
1.73 +See the following page for information on Xapian and MoinMoin:
1.74 +
1.75 +http://moinmo.in/HelpOnXapian
1.76 +
1.77 +Troubleshooting
1.78 +---------------
1.79 +
1.80 +See here for a bug related to category recognition:
1.81 +
1.82 +http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
1.83 +
1.84 +This affects installations where migrations between versions have occurred,
1.85 +yet the Wiki configuration retains old regular expression details.
1.86 +
1.87 +Contact, Copyright and Licence Information
1.88 +------------------------------------------
1.89 +
1.90 +See the following Web page for more information about this work:
1.91 +
1.92 +http://moinmo.in/MacroMarket/EventAggregator
1.93 +
1.94 +The author can be contacted at the following e-mail address:
1.95 +
1.96 +paul@boddie.org.uk
1.97 +
1.98 +Copyright and licence information can be found in the docs directory - see
1.99 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.100 +
1.101 +Release Procedures
1.102 +------------------
1.103 +
1.104 +Update the EventAggregator.py __version__ attribute.
1.105 +Change the version number and package filename/directory in the documentation.
1.106 +Update the release notes (see above).
1.107 +Tag, export.
1.108 +Archive, upload.
1.109 +Update the MacroMarket (see above for the URL).
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
2.2 +++ b/instmacros Sun Mar 22 21:49:44 2009 +0100
2.3 @@ -0,0 +1,13 @@
2.4 +#!/bin/bash
2.5 +
2.6 +if [[ ! $1 ]] ; then
2.7 + echo "Please specify a directory such as ../mysite/wiki or /tmp/mysite/wiki."
2.8 + echo "This should be the root of your Wiki installation and contain the data"
2.9 + echo "directory."
2.10 + echo
2.11 + echo "You may wish to uncomment and modify the chown command in this script."
2.12 + exit
2.13 +fi
2.14 +
2.15 +cp macros/*.py $1/data/plugin/macro/
2.16 +#chown www-data: $1/data/plugin/macro/*.py
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
3.2 +++ b/insttheme Sun Mar 22 21:49:44 2009 +0100
3.3 @@ -0,0 +1,29 @@
3.4 +#!/bin/bash
3.5 +
3.6 +if [[ ! $2 ]] ; then
3.7 + echo "Please specify a directory such as ../mywiki or /tmp/mywiki along"
3.8 + echo "with the name of the theme into which the EventAggregator styles will be"
3.9 + echo "copied."
3.10 + echo
3.11 + echo "The specified directory should be the root of your Wiki resources"
3.12 + echo "and contain the different theme resources directories, such as classic,"
3.13 + echo "modern, hypermodern, and so on, each containing css and img directories."
3.14 + echo
3.15 + echo "The specified directory may be called htdocs, but sometimes it is called"
3.16 + echo "something like moin_static160."
3.17 + echo
3.18 + echo "In more recent versions of MoinMoin, the htdocs directory is found within"
3.19 + echo "a shared directory such as ../moin/share/moin or /tmp/moin/share/moin,"
3.20 + echo "and you should specify the htdocs directory in this location instead."
3.21 + echo "For example: ../moin/share/moin/htdocs"
3.22 + echo
3.23 + echo "You may wish to uncomment and modify the chown command in this script."
3.24 + exit
3.25 +fi
3.26 +
3.27 +cp -i css/*.css $1/$2/css/
3.28 +#chown www-data: $1/$2/css/
3.29 +echo "Don't forget to update the screen.css file:"
3.30 +echo $1/$2/css/screen.css
3.31 +echo
3.32 +echo "See the README.txt file for details."