EXT: Readable name of your extension¶

What does it do?¶

A Calendar extension with month, week and dayview as well as an upcoming events view in list style. Supports selections by category and recurring events. Also supports exception events to accent parts of the calendar view an/or hide recurring events on special days like holidays. Supports multiple views on the same page and caching. Tooltips are based on jQuery. T3jqery is supported.

This extension is based on the outdated jw_calendar extension of Jens Witt. Because it was removed from TER by the TYPO3-Security Team, the calendar extension was fully rebuild to solve security problems. That's, why I'm proud to say, that it is possible to transfer old jw_calendar entries to this extensions. But because it's an ALPHA- Version, there is not the full line-up of functions of jw_calendar, yet. Some of them will definitely not return, some will be inserted in future versions. Today it's fully deployable for use in frontend view with backend adminstration. Frontend editing will be supported in version ALPHA 0.2.0. Also .ics and rss export such as .ics import is planned in upcoming versions.

Screenshots¶

Month view of td_calendar: shows the standard template with some test events and exception events

Single view of td_calendar: shows single view in standard template

Installation¶

Install the extension with the extension manager. The extension manager creates the new database tables and fields for td_calendar. That's it.

Quick Start¶

This section will give you a short overview about the basic setup requirements for td_calendar to work. For more detailed informations you can have a look in the sections “Configuration” and “Administration” in this manual.

Include static extension template

You should than integrate the static template to your page template record. td_calendar also works without it, but it brings all the stuff as jQuery support, CSS-Configuartion and standard template.

Creating requiered pages (best practice):

Normally you want to display a new calendar on a new page. Therefore you have to create in minimal two (better three) new pages: The first one as a sysfolder for your calendar records, the second one for a record overview as month view or week view and the last one for single view. If you want to show single view on same page, please make sure, that you have selected “Do not show error, if no UID is given” and “Single view on same page as other views” is activated in configuration (See also: Configuration/Reference → Single view).

Creating a “TD Calendar” content element:

For a useful integration of td_calendar you have to create in mimimum two content elements of the type “TD Calendar”: One for overview and one for single view. To create a new content element, cahnge to the web-module “Site”, change to the page, where you want to create the overview and click on the “create new content element” link:

The “New content element” wizard opens. There you will find the icon called “TD Calendar”. Select it and choose the position (column) of the new content element:

Select the Tab “Plugin” in the new form that will shown up. That should look like that by default:

You should select an item from the "What to display" field. If you don't do this, there's a double backfall: one to typoscript, the second hardcoded. Hardcoded standard is month view, also the default TS-Setup. To select an item, click on its name in the right list. (For the first test choose “Month” and leave the other settings at their defaults)

The “Site(s) with calendar records” is the page/sysfolder, where the extension looks for calendar records. It is not required to set this value in this field, you can also define it with TypoScript for the whole page. (Also see: section “Configuration/Reference” in this manual -> pidList).

“Site of Single view” is your single view page, you have created. Select this page or leave it free, if you have set the single pid by TS. Save & Close the form for the calendar content-element, change to the you site, where you ant to create your single view and repeat the whole thing, but instead of “Month”, you have to select the “Singleview” item from the "What to display" field. That's it. The calendar is now configured for your testing.

Creating the first calendar database records

To test the functionality of the extension you'll also need at least two calendar records, one category and one event. First change to the Web-module “List”, change to your Sysfolder for calendar records and click on the "create new record" link.

In the wizard you should see the following record types for td_calendar: Event, Category, location, Organizer, Exception event and Exception event category.

First select “Category”. The new form wizard opens up and you have to fill in title as minimal. Save & close and click “create new record” again. Now you have to choose record type “Event”. The new wizard looks like that:

Choose the category, the datetime of begin and a title as minimal and click save & close. The calendar record should now visible in the frontend. If this is not the case, check, if the “hidden” field is activated or repeat the steps above.

Overview of calendar records¶

Of course td_calendar does not ends up with events and categories. There is really much more to do. There are several other record types for you. A complete list with a description of record fields you will find below.

Category

Calendar categories are requiered for events. You have to set minimal one to show up events in the frontend. Every event has exact one category to be choosen.

realUrl-Configuration¶

td_calendar supports realURL. At the moment there are no known problems. You can find two examples of real-URL-Configurations in this package at EXT:td_calendar/res/examples/realurl.example.txt

References¶

plugin.tx_tdcalendar_pi1 properties: TS configuration. Configuration starts with this line

plugin.tx_tdcalendar_pi1 {

General Settings

plugin.tx_tdcalendar_pi1 {
  jQueryRes= fileadmin/myjs/jquery.js
}

plugin.tx_tdcalendar_pi1 {
  jQueryRes >
}

plugin.tx_tdcalendar_pi1 {
  jQueryRes= fileadmin/myjs/td_tooltips.js
}

plugin.tx_tdcalendar_pi1 {
  templateFile= fileadmin/my_template/td_calendar.tmpl
}

plugin.tx_tdcalendar_pi1 {
  templateFile= fileadmin/my_style/td_calendar.css
}

# view mode is day
plugin.tx_tdcalendar_pi1 {
  view= day
}

# clear the value
plugin.tx_tdcalendar_pi1.pidList >
# display calendar records located in page 582 & 584
plugin.tx_tdcalendar_pi1.pidList = 582,584

plugin.tx_tdcalendar_pi1.recursive = 3

# PIDeventDisplay for a calendar element inserted by TS
plugin.tx_tdcalendar_pi1.singlePid = 590

# show selected categories
plugin.tx_tdcalendar_pi1 {
  categoryMode= 1
}

plugin.tx_tdcalendar_pi1.single.image {
    file.maxW = 120
    file.maxH = 90
    imageLinkWrap = 1
    stdWrap.spaceAfter = 5
}