DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Users Manual

Creating and editing events

After installing the extension (see "Configuration" for more details) you can start adding events to the calendar. Simply activate the list-module in the Typo3 backend, navigate to the folder where the events should be stored (most probably called "Events") and click the add button at the top of the page. Then you choose the entry Event located under Simple Calendar.

Event

Now you simply fill in all the information you wish to and save your changes. The event should then appear in the calendar in the frontend. Events can be edited in the same way.

Available options for events

The following fields may be filled by you for every event:

  • Title (required) – the title of the event, for example "Matt's birthday".
  • Start (required) – starting date and time of the event. Just enter a time and a day. If the time is 00:00, no time is shown.
  • End – ending date and time of the event. Should be later than the start of the event, otherwise the event will not be shown in the calendar. If the end-date is on a different day than the start, the event is displayed on all days inbetween. If the time is 00:00, no time is shown.
  • Description – just a text describing the event. Additional information can be placed here.
  • Location – here you can enter an address where the event is located. Will provide a link to the google maps route planner.
  • URL – if needed, you can enter an URL where the user can get more information about the event. Will be displayed as a link.
  • Hide – hidden events will not be shown in the calendar

Adding the calendar-plugin to the frontend

If you want to add the calendar plugin to a page in your frontend, simply activate the page module and navigate to the page the calendar should be shown at. Then click the add button to create a new content element. Choose the calendar plugin from the plugins list.

You may define a heading, but that is not neccessary. More important are the options you need to set under "Plugin".

First you define the view mode, most of the time you may choose "Month", which results in the standard month view. The mode "Month (simple)" can be used to place the calendar in a small space, e.g. a sidebar, it results in a month view without all the buttons and with smaller fields.

The option "Reacting to GET-parameters" is useful if you place the simplified month-view in the sidebar. When the user navigates to the page where the full-size-calender is shown and clicks a day to get to the day-view-mode, both the main-version and the sidebar-version of the plugin would react to the parameters and display the day-view. This would totally ruin the sidebar-layout, as the day-view takes as much space as normal content. To prevent this, uncheck the "Reacting to GET-parameters"-option in the sidebar instance of the plugin and the sidebar plugin will stay in simplified month mode.

Now you have to set the option "Target Page". This tells the plugin where the primary calendar is shown. The buttons and links in the calender will all lead to this page. In case the primary calendar is on the page you are editing, you can leave this empty.

Finally you should define where the events are stored with the option "Record Storage Page" on the behaviour tab. Most of the time this will be the folder "Events".

FAQ

There are no questions asked yet. If you have a question that is not answered in this manual, do not hesitate to write a mail to info@advitum.de.