Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

1.4. Users manual

The plugins

The extension provides two plugins:

  • The 'Events' plugin

  • The 'Event sponsors' plugin

The 'Events' plugin is the content element that actually puts content on your website. On the page where you want the events shown, add a new contentelement, choose the type 'plugin', and choose the plugin 'Events'.

The plugin has two different listing types: 'Full listing' and 'Frontpage teaser' . The events are displayed in the same way in the list view. But the full listing shows a search box and a 'browse box', that is: a possibility to browse through the results. The frontpage teaser only show the wanted number of events. Also the display of a single event can only be done by a plugin in the 'Full listing' mode

It is very important that the starting point of the plugin element is choosen correctly. The plugin shows the events defined by the 'starting point' and the 'recursive' settings of the plugin, if none are given the starting point will be the page itself. (Note: the recursive option is only showed if the 'Show secondary options (palettes)'-flag i set. Thus the plugin can handle events from different pages/folders, and this way share some events between different plugins, but also still have specific events for that plugin. Ie. If you have local hubs of your organisation you could have some events shown only locally, some shown only globally, and some shown on both the local and the global part of your website.

The starting point option has a very signifcant meaning for the 'Frontpage teaser'-mode: The first page reffered to is the page linked to from the 'Frontpage'. So make sure that the first page in the 'starting point' field is where you want the user to go, even if this page (or the branch defined by it) does not contain any events! This page must contain an 'Events'-plugin in 'Full listing'-mode, in order to show the events.

If any categories is available, the plugin will show a selectorbox of the categories and will allow the user to choose from these categories. It is possible to select a default category for each plugin, and to have the selectorbox not shown. If a default category is selected and the 'do not show'-box is ticked, only events witin this category is shown and the website user cannot choose otherwise.

If any cities is available from the database, events can be related to these instead of having a text entered into the form. If this is used a selectorbox filtering the listing by city is shown in frontend. Similar to categories.

The 'Event sponsors' plugin is a simple litte plugin that finds the sponsors related to an event and shows their logo  linking to their webpage. Ie. you could put this plugin in the margin of your website, and when a single event is shown, the logo of the sponsors will appear in the margin. This plugin has to be located on the same page as the 'Events' plugin, and does only output content when a single event is shown.

The elements

The extension provides four types of elements (records):

  • Events

  • Sponsors

  • Participants

  • Categories

And has the following relations:

  • Each sponsor relates to any number of events.

  • Each participant relates to exactly one event.

  • Each category relates to any number of events.

  • Each event relates to any number of sponsors, any number of particpants, and any number of categories.

Also an event has relations to any number of pages. These are the regular pages that describe the event, and could be placed anywhere in the pagetree (although it probably will be handy to store them in a sysfolder or similar). The menu in the top of the event (in singleview) is made out of these pages, plus the registration, and possibly the list of participants.

Entering data into these elements should be pretty straight forward and self explanatory.  Please refer to standard TYPO3 element editing.  Sponsors and categories can only be created in sysfolders and will be looked for in the folder set as 'storage folder'.

The priority option of the event element is there since it is possible to include events from different pages, and so the normal backend ordering of elements doesn't necessarily make sense. It's possible, however, to change this behaviour through Typoscript-settings.

It will probaly rarely be necessary to add/edit participants or make relations between them and an event, as this is done through the registration page of the event. However the option for editing is left as possibility to change wrong data submitted by the front end users. Participants are stored on the page contaning the plugin or on the general record storage page, if defined (see page header).

The module

The extension also provides a module to download a list of information about the particpants registered at an event. Click the module in the left side of your backend, the page will show a list of pages containg events, and the events for the page chosen. Select the event that you want to get information about. Choose your mode in the selectorbox in the top. In the csv-mode make sure you set the fields you want to have in your csv file, and press 'Update list' and copy from the field or 'Download as file'.