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.

EXT: Yet Another Calendar

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Andreas
Changed:2012-10-11T16:51:14
Email:kiefer@kennziffer.com
Info 2:
Info 3:
Info 4:

EXT: Yet Another Calendar

Extension Key: ke_yac

Copyright 2006-2012, Andreas Kiefer (kennziffer.com) <kiefer@kennziffer.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Yet Another Calendar 1

Introduction 2

Screenshots 2

Installation 5

Configuration 5

Bug reports and feature requests 7

Known problems 7

Changelog 8

Introduction

This extension provides a calendar for events . It includes frontend editing functionality. The singleview is enhanced with a GoogleMap if a valid address is set for an event. Frontend editing of events possible, with invitations and notifications for other users.

The calendar view includes a nice tooltip function that is realized with jQuery plugin “qTip”. The datetime fields include the jQuery UI datepicker plugin.

Update from version < 3.0.0

Please note that the version 3.0.0 is optimized for TYPO3 v6.0. There might be errors in earlier TYPO3 versions.

If you want to update to 3.0.0 from an earlier versions, please note the following things:

  • You will have to insert all YAC plugins again, so that the configuration changes can take part
  • Heavy changes on HTML template and CSS files were done. You will have to update all your customized files. Otherwise the plugin output will be broken.

Screenshots

Some screenshots that show you the output of the extension (configurable by CSS):

Calendar and list view

with navigation, calendars, tooltips and list view

img-1

Single view

img-2

img-3 Invitations view

Edit view

img-4

Delete view

img-5

Teaser View

img-6

“My events” view

img-7

Installation

  • Get the extension ke_yac from the extension repository and install it.
  • Include the static typoscript code from the extension(“Edit whole template record” > “Include static (from extensions)” > “Show Calendar (ke_yac)”)
  • Insert the plugin
  • Edit the plugin settings (see detailed information in “Configuration”).
  • You have to create events and event categories in a sysfolder. After creating this folder, go there and choose “Create new record”. Choose “Calendar Category” and “Calendar date” for creating your data.For creating the categories, there are some default category icons in the subfolder “pi1/images”. The colors used in this images are corresponding to the colors used in the default stylesheet.
  • In the plugin, set the “Startingpoint” to the created sysfolder(s) where your data is stored in.

Configuration

Configuration can either be done by flexforms in the plugin itself or in TYPOScript setup. If a value is set in both places, the flexform value overrides the TYPOScript setting.

Main settings

templateFile

Parameter

templateFile

Description

Path to HTML-Template

Default value

EXT:ke_yac/res/yac-template.html

CssPath

Parameter

CssPath

Description

Path to CSS files

Default value

EXT:ke_yac/res/css/

includeJQuery

Parameter

includeJQuery

Description

Include jQuery library?

Default value

1

jQueryPath

Parameter

jQueryPath

Description

Path to jquery library

Default value

EXT:ke_yac/res/js/jquery-1.8.2.min.js

includeJQueryDateTimePicker

Parameter

includeJQueryDateTimePicker

Description

Include jquery ui for a nice datetimepicker in edit form?

Default value

1

includeJQueryTooltips

Parameter

includeJQueryTooltips

Description

Include jquery plugin “qTip” for nice tooltips in calendar view?

Default value

1

dataPids

Parameter

dataPids

Description

Storage PID of YAC records

Default value

showEventsWithoutCat

Parameter

showEventsWithoutCat

Description

If activated, all events that are not categorized are shown in listview, too

Default value

1

mode

Parameter

mode

Description

Set the plugin mode

Default value

0

Calendar

rows

parameter

rows

description

Set numbers of calendars in calendar view (1-24 allowed)

default value

2

columns

parameter

columns

description

Deactivate navigation with “0”. If value > 0 it defines the number of links in the navigation bar.

default value

4

showDaysRow

parameter

showDaysRow

description

show row with first letter of day name (“M T W T F S S”)

default value

0

showMonths Navigation

parameter

showMonths Navigation

description

If value is positive, this amount of links is rendered in months navigation. Set to 0 if you want to deactivate the navigation

default value

4

showWeekNumberRow

parameter

showWeekNumberRow

description

show column with number of week

default value

1

showLegend

parameter

showLegend

description

show the category legend

default value

0

showList

parameter

showList

description

show events list

default value

1

linkToSingleView

parameter

linkToSingleView

description

Links in calendars point directly to single view if set. Otherwise it points to anchors in the event list.

default value

0

Calendar images

calendar.prevIcon

parameter

calendar.prevIcon

description

IMAGE object configuration for the “previous” icon

Default value

IMAGE

calendar.prevIcon.file

parameter

calendar.prevIcon.file

description

File path for “previous” icon

Default value

EXT:ke_yac/res/images/prev.gif

calendar.nextIcon

parameter

calendar.nextIcon

description

IMAGE object configuration for the “next” icon

Default value

IMAGE

calendar.nextIcon.file

parameter

calendar.nextIcon.file

description

Fiel path for “next” icon

Default value

EXT:ke_yac/res/images/next.gif

Dateformat

strftimeFormatStringWithoutTime

parameter

strftimeFormatStringWithoutTime

description

format string for php-function strftime(), see http://php.net/manual/en/function.strftime.php for further information

default value

%d.%m.%Y

strftimeFormatStringWithTime

parameter

strftimeFormatStringWithTime

description

format string for php-function strftime(), see http://php.net/manual/en/function.strftime.php for further information

default value

%d.%m.%Y %H:%M

strftimeFormatTime

parameter

strftimeFormatTime

description

format string for php-function strftime(), see http://php.net/manual/en/function.strftime.php for further information

default value

%H:%M

Listview

showDefaultImageInListview

parameter

showDefaultImageInListview

description

Show default image in listview if no image is set

default value

0

moreIcon

parameter

moreIcon

description

IMAGE object for “more” icon

default value

IMAGE

moreIcon.file

parameter

moreIcon.file

description

Listview “more” icon file

default value

EXT:ke_yac/res/images/more.gif

thumbnail

parameter

thumbnail

description

IMAGE object for “thumbnail”

default value

IMAGE

listviewDefaultImg

parameter

listviewDefaultImg

description

IMAGE object for “listview default image”

default value

IMAGE

listviewDefaultImg.file

parameter

listviewDefaultImg.file

description

Listview default image

default value

EXT:ke_yac/res/images/defaultImage.gif

attendeesIcon

parameter

attendeesIcon

description

IMAGE object for attendees icon

default value

IMAGE

AttendeesIcon.file

parameter

AttendeesIcon.file

description

Listview attendees icon file

default value

EXT:ke_yac/res/images/attendees-icon-listview.png

Singleview

showDefaultImageInSingleview

parameter

showDefaultImageInSingleview

description

Show default image in singleview if no image is set

default value

0

singleviewImg

parameter

singleviewImg

description

IMAGE object for the singleview images

default value

IMAGE

singleviewDefaultImg

parameter

singleviewDefaultImg

description

IMAGE object for the default singleview image

default value

IMAGE

backlinkIcon

parameter

backlinkIcon

description

IMAGE object for the backlink icon

default value

IMAGE

prevLinkIcon

parameter

prevLinkIcon

description

IMAGE object for the “prev” link icon

default value

IMAGE

nextLinkIcon

parameter

nextLinkIcon

description

IMAGE object for the “next” link icon

default value

infolinkIcon

parameter

infolinkIcon

description

IMAGE object for the infolink icon

default value

Teaser view

singlePid

parameter

singlePid

description

Defines the page where the teasers' singleview links point to

default value

teaserHeader

parameter

teaserHeader

description

Header text for the teaser view

default value

Coming events

teaserLimit

parameter

teaserLimit

description

Max. number of entries to show in teaser

default value

5

teaserLength

parameter

teaserLength

description

Max length of event title in teaser view; text will be cropped at the defined position

default value

50

teaserviewImg

parameter

teaserviewImg

description

IMAGE object for the teaser view images

default value

teaser.strftimeFormatStringWithoutTime

parameter

teaser.strftimeFormatStringWithoutTime

description

Dateformat for teaser entries (date without time)

default value

%d.%m.

teaser.strftimeFormatStringWithTime

parameter

teaser.strftimeFormatStringWithTime

description

Dateformat for teaser entries (date and time)

default value

%d.%m. %H:%M

teaser.strftimeFormatTime

parameter

teaser.strftimeFormatTime

description

Dateformat for teaser entries (time only)

default value

%H:%M

Google maps

defaultZoom

parameter

defaultZoom

description

Defines the default zoom for Google Maps. Possible values between 0 and 17

default value

12

My events

myEvents.icon

parameter

myEvents.icon

description

IMAGE object for the “My events” icon

default value

myEvents.singleViewPid

parameter

myEvents.singleViewPid

description

The links in this view will point to this page

default value

myevents.strftimeFormatStringWithoutTime

parameter

myevents.strftimeFormatStringWithoutTime

description

Dateformat for “My events” entries (date without time)

default value

%d.%m.

myevents.strftimeFormatStringWithTime

parameter

myevents.strftimeFormatStringWithTime

description

Dateformat for “My events” entries (date and time)

default value

%d.%m. %H:%M

myevents.strftimeFormatTime

parameter

myevents.strftimeFormatTime

description

Dateformat for “My events” entries (time only)

default value

%H:%M

Set creator as attendant

doNotSetOwnerAsAttendee

parameter

doNotSetOwnerAsAttendee

description

By default the creator of an event is set as attendant. This behaviour can be disabled by activating this option.

default value

0

Category icons

categoryIcon.def

parameter

categoryIcon.def

description

Image object for default category icon

default value

IMAGE

categoryIcon.def.file

parameter

categoryIcon.def.file

description

Default category icon file

default value

EXT:ke_yac/res/images/categoryIcons/catdefault.gif

categoryIcon.1

parameter

categoryIcon.1

description

Image ocject for category icon. In this example for category with uid 1.

default value

IMAGE

CategoryIcon.1.file

parameter

CategoryIcon.1.file

description

Icon file for category. In this example for category with uid 1.

default value

EXT:ke_yac/res/images/categoryIcons/cat1.gif

GoogleMaps as popup

If you don't want the map to be rendere inline in singleview, there is a simple way to just render a link that opens the map in a new window:

Install the EXT “ke_yac_googlemaps” from TER and clear the page cache. The changes will take part immediately. No further configuration necessary.

Bug reports and feature requests

Please use the projects' TYPO3 Forge page for your issues:

http://forge.typo3.org/projects/show/extension-ke_yac

Changelog

*Since version 3.0.0 the changelog can be found in file “Changelog” in EXT dir.*

TER version 2.0.3

  • bugfix: use correct api function for clearing page cache (earlier versions aren't compatible to TYPO3 4.5)
  • the address information is parsed by nlb2br() for a correct view in GoogleMaps when multiple lines are entered in this field
  • hook for additional markers in main template added

TER version 2.0.2

  • replaced hardcoded HTML
  • locallang updated

TER version 2.0.1

  • security improvements
  • documentation update

TER version 2.0.0

  • new feature: frontend editing
  • new feature: show Google Map if valid address data is set

TER version 1.1.2

security fix

img-8 EXT: Yet Another Calendar - 9