.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========================= 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: EXT: Yet Another Calendar ========================= Extension Key: **ke\_yac** Copyright 2006-2012, Andreas 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: 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: 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: 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: Screenshots ----------- Some screenshots that show you the output of the extension (configurable by CSS): .. _Calendar-and-list-view: Calendar and list view ^^^^^^^^^^^^^^^^^^^^^^ with navigation, calendars, tooltips and list view .. _img-1: |img-1| ^^^^^^^ .. _Single-view: Single view ^^^^^^^^^^^ |img-2| .. _img-3-Invitations-view: |img-3| Invitations view ^^^^^^^^^^^^^^^^^^^^^^^^ .. _Edit-view: Edit view ^^^^^^^^^ |img-4| .. _Delete-view: Delete view ^^^^^^^^^^^ |img-5| .. _Teaser-View: Teaser View ^^^^^^^^^^^ |img-6| .. _My-events-view: “My events” view ^^^^^^^^^^^^^^^^ |img-7| .. _Installation: 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 ------------- 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: Main settings ^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile """""""""""" .. container:: table-row Parameter templateFile Description Path to HTML-Template Default value EXT:ke\_yac/res/yac-template.html .. _CssPath: CssPath """"""" .. container:: table-row Parameter CssPath Description Path to CSS files Default value EXT:ke\_yac/res/css/ .. _includeJQuery: includeJQuery """"""""""""" .. container:: table-row Parameter includeJQuery Description Include jQuery library? Default value 1 .. _jQueryPath: jQueryPath """""""""" .. container:: table-row Parameter jQueryPath Description Path to jquery library Default value EXT:ke\_yac/res/js/jquery-1.8.2.min.js .. _includeJQueryDateTimePicker: includeJQueryDateTimePicker """"""""""""""""""""""""""" .. container:: table-row Parameter includeJQueryDateTimePicker Description Include jquery ui for a nice datetimepicker in edit form? Default value 1 .. _includeJQueryTooltips: includeJQueryTooltips """"""""""""""""""""" .. container:: table-row Parameter includeJQueryTooltips Description Include jquery plugin “qTip” for nice tooltips in calendar view? Default value 1 .. _dataPids: dataPids """""""" .. container:: table-row Parameter dataPids Description Storage PID of YAC records Default value .. _showEventsWithoutCat: showEventsWithoutCat """""""""""""""""""" .. container:: table-row Parameter showEventsWithoutCat Description If activated, all events that are not categorized are shown in listview, too Default value 1 .. _mode: mode """" .. container:: table-row Parameter mode Description Set the plugin mode Default value 0 .. ###### END~OF~TABLE ###### .. _Calendar: Calendar ^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _rows: rows """" .. container:: table-row parameter rows description Set numbers of calendars in calendar view (1-24 allowed) default value 2 .. _columns: columns """"""" .. container:: table-row parameter columns description Deactivate navigation with “0”. If value > 0 it defines the number of links in the navigation bar. default value 4 .. _showDaysRow: showDaysRow """"""""""" .. container:: table-row parameter showDaysRow description show row with first letter of day name (“M T W T F S S”) default value 0 .. _showMonths-Navigation: showMonths Navigation """"""""""""""""""""" .. container:: table-row 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: showWeekNumberRow """"""""""""""""" .. container:: table-row parameter showWeekNumberRow description show column with number of week default value 1 .. _showLegend: showLegend """""""""" .. container:: table-row parameter showLegend description show the category legend default value 0 .. _showList: showList """""""" .. container:: table-row parameter showList description show events list default value 1 .. _linkToSingleView: linkToSingleView """""""""""""""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _Calendar-images: Calendar images ^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _calendar-prevIcon: calendar.prevIcon """"""""""""""""" .. container:: table-row parameter calendar.prevIcon description IMAGE object configuration for the “previous” icon Default value IMAGE .. _calendar-prevIcon-file: calendar.prevIcon.file """""""""""""""""""""" .. container:: table-row parameter calendar.prevIcon.file description File path for “previous” icon Default value EXT:ke\_yac/res/images/prev.gif .. _calendar-nextIcon: calendar.nextIcon """"""""""""""""" .. container:: table-row parameter calendar.nextIcon description IMAGE object configuration for the “next” icon Default value IMAGE .. _calendar-nextIcon-file: calendar.nextIcon.file """""""""""""""""""""" .. container:: table-row parameter calendar.nextIcon.file description Fiel path for “next” icon Default value EXT:ke\_yac/res/images/next.gif .. ###### END~OF~TABLE ###### .. _Dateformat: Dateformat ^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _strftimeFormatStringWithoutTime: strftimeFormatStringWithoutTime """"""""""""""""""""""""""""""" .. container:: table-row 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: strftimeFormatStringWithTime """""""""""""""""""""""""""" .. container:: table-row 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: strftimeFormatTime """""""""""""""""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _Listview: Listview ^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _showDefaultImageInListview: showDefaultImageInListview """""""""""""""""""""""""" .. container:: table-row parameter showDefaultImageInListview description Show default image in listview if no image is set default value 0 .. _moreIcon: moreIcon """""""" .. container:: table-row parameter moreIcon description IMAGE object for “more” icon default value IMAGE .. _moreIcon-file: moreIcon.file """"""""""""" .. container:: table-row parameter moreIcon.file description Listview “more” icon file default value EXT:ke\_yac/res/images/more.gif .. _thumbnail: thumbnail """"""""" .. container:: table-row parameter thumbnail description IMAGE object for “thumbnail” default value IMAGE .. _listviewDefaultImg: listviewDefaultImg """""""""""""""""" .. container:: table-row parameter listviewDefaultImg description IMAGE object for “listview default image” default value IMAGE .. _listviewDefaultImg-file: listviewDefaultImg.file """"""""""""""""""""""" .. container:: table-row parameter listviewDefaultImg.file description Listview default image default value EXT:ke\_yac/res/images/defaultImage.gif .. _attendeesIcon: attendeesIcon """"""""""""" .. container:: table-row parameter attendeesIcon description IMAGE object for attendees icon default value IMAGE .. _AttendeesIcon-file: AttendeesIcon.file """""""""""""""""" .. container:: table-row parameter AttendeesIcon.file description Listview attendees icon file default value EXT:ke\_yac/res/images/attendees-icon-listview.png .. ###### END~OF~TABLE ###### .. _Singleview: Singleview ^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _showDefaultImageInSingleview: showDefaultImageInSingleview """""""""""""""""""""""""""" .. container:: table-row parameter showDefaultImageInSingleview description Show default image in singleview if no image is set default value 0 .. _singleviewImg: singleviewImg """"""""""""" .. container:: table-row parameter singleviewImg description IMAGE object for the singleview images default value IMAGE .. _singleviewDefaultImg: singleviewDefaultImg """""""""""""""""""" .. container:: table-row parameter singleviewDefaultImg description IMAGE object for the default singleview image default value IMAGE .. _backlinkIcon: backlinkIcon """""""""""" .. container:: table-row parameter backlinkIcon description IMAGE object for the backlink icon default value IMAGE .. _prevLinkIcon: prevLinkIcon """""""""""" .. container:: table-row parameter prevLinkIcon description IMAGE object for the “prev” link icon default value IMAGE .. _nextLinkIcon: nextLinkIcon """""""""""" .. container:: table-row parameter nextLinkIcon description IMAGE object for the “next” link icon default value .. _infolinkIcon: infolinkIcon """""""""""" .. container:: table-row parameter infolinkIcon description IMAGE object for the infolink icon default value .. ###### END~OF~TABLE ###### .. _Teaser-view: Teaser view ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _singlePid: singlePid """"""""" .. container:: table-row parameter singlePid description Defines the page where the teasers' singleview links point to default value .. _teaserHeader: teaserHeader """""""""""" .. container:: table-row parameter teaserHeader description Header text for the teaser view default value Coming events .. _teaserLimit: teaserLimit """"""""""" .. container:: table-row parameter teaserLimit description Max. number of entries to show in teaser default value 5 .. _teaserLength: teaserLength """""""""""" .. container:: table-row parameter teaserLength description Max length of event title in teaser view; text will be cropped at the defined position default value 50 .. _teaserviewImg: teaserviewImg """"""""""""" .. container:: table-row parameter teaserviewImg description IMAGE object for the teaser view images default value .. _teaser-strftimeFormatStringWithoutTime: teaser.strftimeFormatStringWithoutTime """""""""""""""""""""""""""""""""""""" .. container:: table-row parameter teaser.strftimeFormatStringWithoutTime description Dateformat for teaser entries (date without time) default value %d.%m. .. _teaser-strftimeFormatStringWithTime: teaser.strftimeFormatStringWithTime """"""""""""""""""""""""""""""""""" .. container:: table-row parameter teaser.strftimeFormatStringWithTime description Dateformat for teaser entries (date and time) default value %d.%m. %H:%M .. _teaser-strftimeFormatTime: teaser.strftimeFormatTime """"""""""""""""""""""""" .. container:: table-row parameter teaser.strftimeFormatTime description Dateformat for teaser entries (time only) default value %H:%M .. ###### END~OF~TABLE ###### .. _Google-maps: Google maps ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _defaultZoom: defaultZoom """"""""""" .. container:: table-row parameter defaultZoom description Defines the default zoom for Google Maps. Possible values between 0 and 17 default value 12 .. ###### END~OF~TABLE ###### .. _My-events: My events ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _myEvents-icon: myEvents.icon """"""""""""" .. container:: table-row parameter myEvents.icon description IMAGE object for the “My events” icon default value .. _myEvents-singleViewPid: myEvents.singleViewPid """""""""""""""""""""" .. container:: table-row parameter myEvents.singleViewPid description The links in this view will point to this page default value .. _myevents-strftimeFormatStringWithoutTime: myevents.strftimeFormatStringWithoutTime """""""""""""""""""""""""""""""""""""""" .. container:: table-row parameter myevents.strftimeFormatStringWithoutTime description Dateformat for “My events” entries (date without time) default value %d.%m. .. _myevents-strftimeFormatStringWithTime: myevents.strftimeFormatStringWithTime """"""""""""""""""""""""""""""""""""" .. container:: table-row parameter myevents.strftimeFormatStringWithTime description Dateformat for “My events” entries (date and time) default value %d.%m. %H:%M .. _myevents-strftimeFormatTime: myevents.strftimeFormatTime """"""""""""""""""""""""""" .. container:: table-row parameter myevents.strftimeFormatTime description Dateformat for “My events” entries (time only) default value %H:%M .. ###### END~OF~TABLE ###### .. _Set-creator-as-attendant: Set creator as attendant ^^^^^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _doNotSetOwnerAsAttendee: doNotSetOwnerAsAttendee """"""""""""""""""""""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _Category-icons: Category icons ^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _categoryIcon-def: categoryIcon.def """""""""""""""" .. container:: table-row parameter categoryIcon.def description Image object for default category icon default value IMAGE .. _categoryIcon-def-file: categoryIcon.def.file """"""""""""""""""""" .. container:: table-row parameter categoryIcon.def.file description Default category icon file default value EXT:ke\_yac/res/images/categoryIcons/catdefault.gif .. _categoryIcon-1: categoryIcon.1 """""""""""""" .. container:: table-row parameter categoryIcon.1 description Image ocject for category icon. In this example for category with uid 1. default value IMAGE .. _CategoryIcon-1-file: CategoryIcon.1.file """"""""""""""""""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _GoogleMaps-as-popup: 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: 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: 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 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 442 .. :id: Grafik1 .. :name: Grafik1 .. :width: 656 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 648 .. :id: Grafik2 .. :name: Grafik2 .. :width: 560 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 198 .. :id: Grafik10 .. :name: Grafik10 .. :width: 421 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 598 .. :id: Grafik11 .. :name: Grafik11 .. :width: 669 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 204 .. :id: Grafik12 .. :name: Grafik12 .. :width: 528 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 187 .. :id: Grafik3 .. :name: Grafik3 .. :width: 214 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 159 .. :id: Grafik14 .. :name: Grafik14 .. :width: 214 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102