1.1 --- a/README.txt Sun Mar 22 22:46:53 2009 +0100
1.2 +++ b/README.txt Mon Mar 23 01:52:13 2009 +0100
1.3 @@ -8,9 +8,23 @@
1.4 the details of each event, colouring each event period in a specially
1.5 generated colour.
1.6
1.7 +The EventAggregatorSummary action can be used to provide an iCalendar summary
1.8 +of event data based on pages belonging to specific categories, as described
1.9 +above. The category, start and end parameters are read directly from the
1.10 +request as URL or form parameters.
1.11 +
1.12 Installation
1.13 ------------
1.14
1.15 +To install the support library, consider using the setup.py script provided:
1.16 +
1.17 + python setup.py install
1.18 +
1.19 +You may wish to indicate a specific prefix if MoinMoin is not installed in the
1.20 +traditional location:
1.21 +
1.22 + python setup.py install --prefix=path-to-moin-prefix
1.23 +
1.24 To install the macro in a Wiki, consider using the instmacros script provided:
1.25
1.26 ./instmacros path-to-wiki
1.27 @@ -18,6 +32,37 @@
1.28 On non-UNIX platforms, it is necessary to manually copy the contents of the
1.29 macros directory in this distribution into the macros directory of your Wiki.
1.30
1.31 +It is highly recommended that the tables and listings be styled according to
1.32 +the stylesheet provided, and you can use this file as a starting point for
1.33 +your own modifications. To install the stylesheet, consider using the
1.34 +insttheme script provided:
1.35 +
1.36 + ./insttheme path-to-wiki theme-name
1.37 +
1.38 +Again, on non-UNIX platforms, it is necessary to manually copy the files. In
1.39 +this case, just copy the contents of the css directory into the css directory
1.40 +of themes which will support styling of event calendars and listings.
1.41 +
1.42 +To activate the styles provided by the stylesheet in the css directory, you
1.43 +will need to edit the screen.css file in each affected theme's css directory,
1.44 +adding the following before any style rules:
1.45 +
1.46 + /* Event aggregation... */
1.47 +
1.48 + @import "event-aggregator.css";
1.49 +
1.50 +This ensures that the styles are made available to the browser.
1.51 +
1.52 +To install the action in a Wiki, consider using the instactions script provided:
1.53 +
1.54 + ./instactions path-to-wiki
1.55 +
1.56 +On non-UNIX platforms, it is necessary to manually copy the contents of the
1.57 +actions directory in this distribution into the actions directory of your Wiki.
1.58 +
1.59 +Using the Macro
1.60 +---------------
1.61 +
1.62 It should now be possible to edit pages and use the macro as follows. For
1.63 MoinMoin 1.5:
1.64
1.65 @@ -38,26 +83,21 @@
1.66
1.67 <<EventAggregator(CategoryEvent,mode=list)>>
1.68
1.69 -It is highly recommended that the tables and listings be styled according to
1.70 -the stylesheet provided, and you can use this file as a starting point for
1.71 -your own modifications. To install the stylesheet, consider using the
1.72 -insttheme script provided:
1.73 +Using the Action
1.74 +----------------
1.75
1.76 - ./insttheme path-to-wiki theme-name
1.77 +To obtain an iCalendar summary, a collection of parameters can be specified in
1.78 +the URL of any Wiki page. For example:
1.79 +
1.80 + http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents
1.81
1.82 -Again, on non-UNIX platforms, it is necessary to manually copy the files. In
1.83 -this case, just copy the contents of the css directory into the css directory
1.84 -of themes which will support styling of event calendars and listings.
1.85 +This should produce an iCalendar resource in response. By specifying 'start'
1.86 +and 'end' parameters, a restricted view can be obtained. For example:
1.87
1.88 -To activate the styles provided by the stylesheet in the css directory, you
1.89 -will need to edit the screen.css file in each affected theme's css directory,
1.90 -adding the following before any style rules:
1.91 + http://example.com/moin/FrontPage?action=EventAggregatorSummary&category=CategoryEvents&start=2009-06&end=2009-07
1.92
1.93 - /* Event aggregation... */
1.94 -
1.95 - @import "event-aggregator.css";
1.96 -
1.97 -This ensures that the styles are made available to the browser.
1.98 +This would restrict the initial query to events occurring in the months of
1.99 +June 2009 ('2009-06') and July 2009 ('2009-07').
1.100
1.101 Recommended Software
1.102 --------------------
1.103 @@ -84,9 +124,10 @@
1.104 Contact, Copyright and Licence Information
1.105 ------------------------------------------
1.106
1.107 -See the following Web page for more information about this work:
1.108 +See the following Web pages for more information about this work:
1.109
1.110 http://moinmo.in/MacroMarket/EventAggregator
1.111 +http://moinmo.in/ActionMarket/EventAggregator
1.112
1.113 The author can be contacted at the following e-mail address:
1.114
1.115 @@ -98,9 +139,9 @@
1.116 Release Procedures
1.117 ------------------
1.118
1.119 -Update the EventAggregator.py __version__ attribute.
1.120 +Update the EventAggregatorSupport.py __version__ attribute.
1.121 Change the version number and package filename/directory in the documentation.
1.122 Update the release notes (see above).
1.123 Tag, export.
1.124 Archive, upload.
1.125 -Update the MacroMarket (see above for the URL).
1.126 +Update the MacroMarket and ActionMarket (see above for the URLs).