# HG changeset patch # User Paul Boddie # Date 1297901736 -3600 # Node ID cbc55e9d19865b34ba8747a1ba3b3c6a412e6ac2 # Parent 13c0c0957fe7e2f07ba74b8daaabd0b5a09b5203 Switched to using moinsetup as the means to install EventAggregator. diff -r 13c0c0957fe7 -r cbc55e9d1986 README.txt --- a/README.txt Wed Feb 16 01:11:14 2011 +0100 +++ b/README.txt Thu Feb 17 01:15:36 2011 +0100 @@ -54,65 +54,50 @@ ------------ To install the support library and MoinMoin-related scripts, consider using -the setup.py script provided: +the moinsetup tool. See the "Recommended Software" section below for more +information. + +With moinsetup and a suitable configuration file, the installation is done as +follows with $EADIR referring to the EventAggregator distribution directory +containing this README.txt file: - python setup.py install + python moinsetup.py -f moinsetup.cfg install_extension_package $EADIR + python moinsetup.py -f moinsetup.cfg install_actions $EADIR/actions + python moinsetup.py -f moinsetup.cfg install_macros $EADIR/macros + python moinsetup.py -f moinsetup.cfg install_theme_resources $EADIR + python moinsetup.py -f moinsetup.cfg edit_theme_stylesheet screen.css event-aggregator.css + python moinsetup.py -f moinsetup.cfg edit_theme_stylesheet print.css event-aggregator.css + python moinsetup.py -f moinsetup.cfg edit_theme_stylesheet print.css event-aggregator-print.css -You may wish to indicate a specific prefix if MoinMoin is not installed in the -traditional location: +The first command above uses the setup.py script provided as follows: python setup.py install --prefix=path-to-moin-prefix -To install the macro in a Wiki, consider using the instmacros script provided: - - ./instmacros path-to-wiki +The second and third commands install the actions and macros respectively. -On non-UNIX platforms, it is necessary to manually copy the contents of the -macros directory in this distribution into the macros directory of your Wiki. - -It is highly recommended that the tables and listings be styled according to -the stylesheet provided, and you can use this file as a starting point for -your own modifications. To install the stylesheet, consider using the -insttheme script provided: +The fourth command installs the theme resources in the available theme +directories. - ./insttheme path-to-wiki theme-name - -Again, on non-UNIX platforms, it is necessary to manually copy the files. In -this case, just copy the contents of the css directory into the css directory -of themes which will support styling of event calendars and listings. - -To activate the styles provided by the stylesheet in the css directory, you -will need to edit the screen.css file in each affected theme's css directory, -adding the following before any style rules: - - /* Event aggregation... */ +The remaining commands activate the styles provided by EventAggregator by +editing the screen.css and print.css files which are typically provided by +themes. These commands add imports of the following form to the theme +stylesheets: @import "event-aggregator.css"; -This ensures that the styles are made available to the browser. Additionally, -to make sure that printed pages are correctly styled, the following also needs -to be added to the print.css file in each affected theme's css directory: - - /* Event aggregation... */ - - @import "event-aggregator-print.css"; - @import "event-aggregator.css"; - -To install the actions in a Wiki, consider using the instactions script -provided: - - ./instactions path-to-wiki - -On non-UNIX platforms, it is necessary to manually copy the contents of the -actions directory in this distribution into the actions directory of your -Wiki. - Useful Pages ------------ The pages directory contains a selection of useful pages using a syntax appropriate for use with MoinMoin 1.6 or later. These pages can be created -through the Wiki and their contents copied in from each of the files. +through the Wiki and their contents copied in from each of the files. An +easier installation method is to issue the following commands: + + python moinsetup.py -f moinsetup.cfg make_page_package pages pages.zip + python moinsetup.py -f moinsetup.cfg install_page_package pages.zip + +You may need to switch user in order to have sufficient privileges to copy the +page package into the Wiki. Using the Macro --------------- @@ -177,6 +162,13 @@ Recommended Software -------------------- +The moinsetup tool is recommended for installation since it aims to support +all versions of MoinMoin that are supported for use with this software. + +See the following page for information on moinsetup: + +http://moinmo.in/ScriptMarket/moinsetup + The Xapian search software is highly recommended, if not technically essential, for the acceptable performance of the EventAggregator macro since the macro makes use of search routines in MoinMoin that can dominate the time @@ -245,6 +237,7 @@ EventAggregatorSummary action and permit editing of the supplied values. * Added a day view which shows events ordered according to their timespans within each day. + * Switched to using moinsetup for the installation procedure. New in EventAggregator 0.6.1 (Changes since EventAggregator 0.6) ---------------------------------------------------------------- diff -r 13c0c0957fe7 -r cbc55e9d1986 instactions --- a/instactions Wed Feb 16 01:11:14 2011 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -#!/bin/bash - -if [[ ! $1 ]] ; then - echo "Please specify a directory such as ../mysite/wiki or /tmp/mysite/wiki." - echo "This should be the root of your Wiki installation and contain the data" - echo "directory." - echo - echo "You may wish to uncomment and modify the chown command in this script." - exit -fi - -cp actions/*.py $1/data/plugin/action/ -#chown www-data: $1/data/plugin/action/*.py diff -r 13c0c0957fe7 -r cbc55e9d1986 instmacros --- a/instmacros Wed Feb 16 01:11:14 2011 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -#!/bin/bash - -if [[ ! $1 ]] ; then - echo "Please specify a directory such as ../mysite/wiki or /tmp/mysite/wiki." - echo "This should be the root of your Wiki installation and contain the data" - echo "directory." - echo - echo "You may wish to uncomment and modify the chown command in this script." - exit -fi - -cp macros/*.py $1/data/plugin/macro/ -#chown www-data: $1/data/plugin/macro/*.py diff -r 13c0c0957fe7 -r cbc55e9d1986 insttheme --- a/insttheme Wed Feb 16 01:11:14 2011 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -#!/bin/bash - -if [[ ! $2 ]] ; then - echo "Please specify a directory such as ../mywiki or /tmp/mywiki along" - echo "with the name of the theme into which the EventAggregator styles will be" - echo "copied." - echo - echo "The specified directory should be the root of your Wiki resources" - echo "and contain the different theme resources directories, such as classic," - echo "modern, hypermodern, and so on, each containing css and img directories." - echo - echo "The specified directory may be called htdocs, but sometimes it is called" - echo "something like moin_static160." - echo - echo "In more recent versions of MoinMoin, the htdocs directory is found within" - echo "a shared directory such as ../moin/share/moin or /tmp/moin/share/moin," - echo "and you should specify the htdocs directory in this location instead." - echo "For example: ../moin/share/moin/htdocs" - echo - echo "You may wish to uncomment and modify the chown command in this script." - exit -fi - -cp -i css/*.css $1/$2/css/ -#chown www-data: $1/$2/css/ -echo "Don't forget to update the CSS files:" -echo $1/$2/css/screen.css -echo $1/$2/css/print.css -echo -echo "See the README.txt file for details."