1.1 --- a/pages/HelpOnEventAggregator Fri May 13 01:36:26 2011 +0200
1.2 +++ b/pages/HelpOnEventAggregator Sat May 28 21:45:53 2011 +0200
1.3 @@ -7,11 +7,13 @@
1.4
1.5 The !EventAggregator macro for !MoinMoin can be used to display event calendars or listings which obtain their data from pages belonging to specific categories (such as CategoryEvents).
1.6
1.7 +<<TableOfContents(2,3)>>
1.8 +
1.9 == Creating Events ==
1.10
1.11 The easiest way to create an event is to hover over a day number in a calendar and to follow the "New event" link. If you do not have a calendar set up, take a look at the instructions for [[#PreparingACalendar|preparing]] and [[#ShowingEventCalendars|showing]] calendars first.
1.12
1.13 -Each event must be created on a new page belonging to the appropriate event category. The following action can be used to create a new event page (using !EventAggregatorNewEvent) without looking at a calendar:
1.14 +Each event must be created on a new page belonging to the appropriate event category. The following action can be used to create a new event page (using [[HelpOnEventAggregatorNewEvent|EventAggregatorNewEvent]]) without looking at a calendar:
1.15
1.16 (!) <<Action(EventAggregatorNewEvent,Add an event)>>
1.17
1.18 @@ -77,7 +79,7 @@
1.19 Summary:: a synonym for title
1.20 Topics:: a list of topics related to the event - use a comma (`,`) to separate topic names
1.21 Categories:: a synonym for topics - note that this means "event categories", not "page categories" which are a distinct concept
1.22 - Location:: the location of the event
1.23 + Location:: the location of the event - this may [[#Showing_Events_on_Maps|position the event on maps]] if the location is known to !EventAggregator
1.24
1.25 These properties may be incorporated into representations or summaries of events.
1.26
1.27 @@ -203,6 +205,19 @@
1.28
1.29 Without any time period, the calendar would show all events, and there would be no real need to provide navigation, since there would be no events outside the displayed period to navigate to. It is possible to omit either the `start` or the `end` parameter and still provide navigation, however.
1.30
1.31 +=== Showing Calendar Days ===
1.32 +
1.33 +To view the individual days in a calendar, it is possible to hover over a day number and select the "View day" link. However, a calendar view can be set up using the macro as follows:
1.34 +
1.35 +{{{
1.36 +## Show yesterday, today and tomorrow.
1.37 +<<EventAggregator(CategoryEvents,start=current-1,end=current+1,mode=day)>>
1.38 +}}}
1.39 +
1.40 +In the above example, specifying a `mode` of `day` sets the resolution of the calendar to that of individual days, and thus the special value `current` refers to the current day (today) instead of the current month.
1.41 +
1.42 +In the day view, time information is shown so that it becomes possible to see whether events conflict with each other. In addition, location information is shown above columns of events to help with event scheduling.
1.43 +
1.44 === Assigning Templates and Parent Pages ===
1.45
1.46 New events can be added to a calendar by following the "New event" links provided when hovering over each of the day numbers; this opens the form provided by the !EventAggregatorNewEvent action. For all events belonging to a particular calendar, it can be convenient to assign a default template page, so that the information provided by such events is consistent. Thus, it is possible to specify such a template page using the `template` parameter. For example:
1.47 @@ -245,9 +260,27 @@
1.48
1.49 To define your own topic colours, edit the `event-aggregator.css` file which is provided with the !EventAggregator distribution, and then reinstall that file for each of the Wiki themes of interest. Topics involved in event colouring should be mutually exclusive: more than one such topic should not be specified for any given event.
1.50
1.51 -=== The Default View and Switching Views ===
1.52 +== Showing Events on Maps ==
1.53 +
1.54 +If a map is defined, as described below, and the name of such a map is given when using the macro, it becomes possible to allow a map view to be shown. For example:
1.55 +
1.56 +{{{
1.57 +<<EventAggregator(CategoryEvents,mode=map,map=europe)>>
1.58 +}}}
1.59 +
1.60 +The above example will show all events in the given category whose locations are known and are found to refer to places on the `europe` map.
1.61
1.62 -The `calendar` value for the `mode` parameter causes the default calendar view to be employed, but you can switch the view - effectively changing the `mode` - using the links provided below the view produced by this macro.
1.63 +=== Defining Maps ===
1.64 +
1.65 +!EventAggregator uses a page called EventMapsDict to define and retain the available maps (unless the `event_aggregator_maps_page` configuration setting has been changed). Follow the instructions on the EventMapsDict page to define new maps.
1.66 +
1.67 +=== Defining Locations ===
1.68 +
1.69 +!EventAggregator uses a page called EventLocationsDict to define known locations (unless the `event_aggregator_locations_page` configuration setting has been changed). Follow the instructions on the EventLocationsDict page to define new locations.
1.70 +
1.71 +== The Default View and Switching Views ==
1.72 +
1.73 +The `calendar` value for the `mode` parameter causes the default calendar view to be employed, but you can switch the view - effectively changing the `mode` - using the links provided below the view produced by this macro. The map view is only available via a link if a map name has been given using the `map` parameter.
1.74
1.75 == See Also ==
1.76