| paul@47 | 1 | ##master-page:HelpTemplate |
| paul@47 | 2 | ##master-date:Unknown-Date |
| paul@47 | 3 | #format wiki |
| paul@47 | 4 | #language en |
| paul@47 | 5 | |
| paul@47 | 6 | == EventAggregatorNewEvent == |
| paul@47 | 7 | |
| paul@203 | 8 | The !EventAggregatorNewEvent action provides support for creating new events more conveniently than manually editing an event page based on a template. The action can be selected from the actions menu on any page, or it can be invoked by selecting a day number in an !EventAggregator calendar view. |
| paul@47 | 9 | |
| paul@47 | 10 | Upon invoking the action, a form will be displayed requesting values for the following items: |
| paul@47 | 11 | |
| paul@47 | 12 | * The title or summary of the event; this will be used as the page name. |
| paul@294 | 13 | * The location of the event (optional). |
| paul@105 | 14 | * The start date of the event. |
| paul@105 | 15 | * A description of the event (optional). |
| paul@105 | 16 | * A canonical URL for the event (optional). |
| paul@105 | 17 | |
| paul@105 | 18 | Additional controls are available through a number of buttons: |
| paul@105 | 19 | |
| paul@294 | 20 | * `Specify a different location` exposes a field where a potentially new or not previously known location can be specified. The latitude and longitude of this new location can also be specified if desired. |
| paul@105 | 21 | * `Specify end date` exposes a field for the end date of the event (if different from the start date). |
| paul@105 | 22 | * `Specify times` exposes fields for the start and end times of the event. |
| paul@294 | 23 | * `Use local time` exposes a field which links time information to a time "regime" observed in a particular place. |
| paul@294 | 24 | * `Specify UTC offsets` exposes fields which allow times to be associated with particular time zones. Offsets can be written like, for example, `0200` or `+0200` for zones east of the prime meridian, and `-0200` for zones west of the prime meridian. |
| paul@294 | 25 | * `Make times apply everywhere` hides time zone-related fields, indicating that the time is to be considered local to the observer. |
| paul@105 | 26 | * `Add topic` permits topic information to be specified. |
| paul@105 | 27 | * `Show advanced options` permits advanced options to be inspected and changed. |
| paul@47 | 28 | |
| paul@47 | 29 | When the form is submitted, a new page will be created and the supplied details inserted into the appropriate locations in the page. The new page will then be opened for further editing. |
| paul@47 | 30 | |
| paul@47 | 31 | If a page already exists with a name identical to that provided as the event title, the form will prompt for an alternative title. If no end date is provided, the start and end dates will be identical in the newly created page. |
| paul@47 | 32 | |
| paul@294 | 33 | {{{#!wiki tip |
| paul@294 | 34 | If editing of the new page is cancelled, no new page should be created. Thus, it should be safe to create an event using the form, inspect the page, and then decide whether or not the page should really be created for the event. |
| paul@72 | 35 | }}} |
| paul@47 | 36 | |
| paul@55 | 37 | == Categories and Templates == |
| paul@55 | 38 | |
| paul@72 | 39 | {{{#!wiki tip |
| paul@72 | 40 | To manually select categories and templates, select the `Show advanced options` button in the form. |
| paul@72 | 41 | }}} |
| paul@72 | 42 | |
| paul@55 | 43 | If the action has been invoked by following a link from a calendar, then the default categories assigned to a new event are derived from those used to present events in the calendar. Otherwise, no categories are selected by default for a new event. |
| paul@55 | 44 | |
| paul@55 | 45 | New event pages are derived from a particular template page. If the action has been invoked by a link provided by a calendar, the `template` parameter of the !EventAggregator macro may specify the default template page for the new event. If no such parameter was used for the calendar, or if no calendar was involved (such as when the action is invoked from the editing menu), the EventTemplate page is chosen to be the default template page for the event. |
| paul@55 | 46 | |
| paul@55 | 47 | A technical note: this underlying default setting (the use of EventTemplate) can be changed by setting or editing the `event_aggregator_new_event_template` configuration setting for the Wiki. |
| paul@47 | 48 | |
| paul@72 | 49 | == Parent Page == |
| paul@72 | 50 | |
| paul@72 | 51 | {{{#!wiki tip |
| paul@72 | 52 | To manually select the parent page, select the `Show advanced options` button in the form. |
| paul@72 | 53 | }}} |
| paul@72 | 54 | |
| paul@203 | 55 | An event may be assigned a parent page, resulting in the event page being created as a sub-page of this parent page. For a collection of events, a parent page acts as a common container for all the event pages in the collection. For example, a parent page called '''Appointments''' could be defined for the events '''Summer Party''' and '''Winter Party''' with the pages for the events being created as '''Appointments/Summer Party''' and '''Appointments/Winter Party'''. In the calendar, these events would not include '''Appointments''' in their names by default. See the related [[HelpOnEventAggregator#Assigning_Templates_and_Parent_Pages|guide to these options]] for more information. |
| paul@72 | 56 | |
| paul@72 | 57 | If the action has been invoked by a link provided by a calendar, the `parent` parameter of the !EventAggregator macro may specify the default parent page for the new event. If no such parameter was used for the calendar, or if no calendar was involved (such as when the action is invoked from the editing menu), no parent page is chosen. |
| paul@72 | 58 | |
| paul@329 | 59 | == Overriding the Event Page == |
| paul@329 | 60 | |
| paul@329 | 61 | To completely override the choice of event page, select the `Choose page name` button in the form, and then specify an appropriate name. The following variables can be used in the chosen page name: |
| paul@329 | 62 | |
| paul@329 | 63 | || '''Variable''' || '''Description''' || |
| paul@329 | 64 | || `@TITLE@` || The title or summary of the event specified in the form || |
| paul@329 | 65 | || `@``PAGE@` || The current page name || |
| paul@329 | 66 | || `@PARENT@` || The parent page for events as described above || |
| paul@329 | 67 | || `@STARTDATE@` || The start date of the event having the form `YYYY-MM-DD` || |
| paul@329 | 68 | || `@ENDDATE@` || The end date of the event having the form `YYYY-MM-DD` || |
| paul@351 | 69 | || `@``DATE@` || A synonym for `@STARTDATE@` || |
| paul@329 | 70 | |
| paul@329 | 71 | As indicated initially, event pages have a page name of `@PARENT@/@TITLE@` unless this is overridden. |
| paul@329 | 72 | |
| paul@47 | 73 | == See Also == |
| paul@47 | 74 | |
| paul@47 | 75 | * HelpOnEventAggregator - a macro producing event calendars and listings |
