VCE - Versatile Calendar Extension¶

FE¶

Monatsansicht:

• 

• Monatsansicht (gefiltert):

  

• Wochenansicht:

Detailansicht:

• 
• PDF Jahresplaner:

BE¶

VCE Event Editor:

Installationsvorbereitung¶

Bevor Sie die VCE installieren, sollten Sie sich innerhalb Ihres Seitenbaums zunächst einen eigenen Sysfolder für Ihre VCE Daten anlegen und sich dessen ID merken. Installieren Sie dann mithilfe des Extension Managers VCE und geben Sie den Wert für centralStoragePid ein (in unserem Beispiel die Nummer 84 “Termine VCE”).

Konfiguration¶

Wechseln Sie in die Listenansicht und wählen Sie Ihren VCE Sysfolder. Legen Sie einen neuen Datensatz an.

Hier sehen Sie zum ersten Mal alle Kategoriesierungmöglichkeiten, welche Ihnen VCE zur Verfügung stellt: Kategorie, Veranstalter, Veranstaltungsort und Zielgruppe. Daneben natürlich noch die Einträge für Termine und Ausnahmen von Wiederholungsterminen.

Grundeinstellungen¶

Bevor wir Termine in den Kalender eintragen, legen wir eine Reihe von Datensätzen in den verschiedenen Kategorien an. Diese Kategorien dienen später dazu, Termine nach Ihren Wünschen zu filtern.

VCE Frontend Plugin installieren und konfigurieren¶

Legen Sie nun eine Seite an, auf der Sie Ihren Kalender anzeigen möchten. Installieren Sie das Plugin “VCE Kalender” als Inhaltselement vom Typ Plugin und speichern Sie die Seite.Wenn Sie anschliessend das Plugin zur Bearbeitung aufrufen, erscheint folgende Konfigurationsmaske:

Belassen Sie einfach alle Voreinstellungen und wählen Sie unter “Ausgangspunkt” noch Ihren VCE Sysfolder “Termine VCE”. Speichern Sie Ihre Eingaben, wechseln Sie ins Frontend und lassen Sie sich die Kalenderseite anzeigen. Abhängig vom jeweiligen generellen Design Ihrer Website sollten Sie nun den VCE Kalender in der Monatsansicht sehen.

Spielen Sie ein wenig mit den verschiedenen Ansichten und Filtermöglichkeiten und erzeugen Sie sich Ihren ersten personalisierten, d.h. nach Ihren Vorstellungen gefilterten Jahresplaner als PDF.

Herzlichen Glückwunsch, Sie haben VCE erfolgreich installiert und in Betrieb genommen =:o)

Die nachfolgenden Kapitel sind den Einstellmöglichkeiten gewidmet, mit denen Sie das Erscheinungsbild und die Funktionalitäten von VCE an Ihre Bedürfnisse anpassen können.

Reiter “Allgemein”¶

• Voreinstellung Ansicht : legt fest, welche Kalenderansicht standardmäßig beim ersten Aufruf des Kalenders angezeigt werden soll. Wählen Sie eine der möglichen Ansichten aus dem Dropdown-Menü.
• Keine Links zu anderen Ansichten : normalerweise zeigt VCE auf allen Seiten Navigationslinks zu allen anderen Kalenderansichten an. Mit dieser Option wird dieses Verhalten deaktiviert.
• Seite zur Anzeige der Details : legt fest, auf welcher Seite des Seitenbaumes die Detailansicht zu einem Kalendereintrag angezeigt werden soll. Diese Seite muss dann selbstverständlich ebenfalls das Plugin VCE Kalender enthalten. Wenn Sie diesen Wert leer lassen, wird die aktuelle Seite verwendet.
• Eigenes HTML-Template : geben Sie hier Ihr eigenes HTML-Template an (siehe VCE HTML-Template ).
• Eigenes PDF-Template : geben Sie hier Ihr eigenes PDF-Template zur Erstellung des Jahresplaners an (siehe VCE PDF-Template .
• Template Erweiterungsklasse : VCE lässt sich um eigene Funktionen erweitern. Wählen Sie hier die PHP-Datei, die Ihre Erweiterungen enthält (Details hierzu finden Sie im Kapitel “ VCE erweitern” ).
• Ausgangspunkt : geben Sie hier den Speicherort für Ihre VCE Daten (Termine und Kategorien) an. Lassen Sie dieses Feld leer, um VCE Daten von der aktuellen Seite zu beziehen.

Reiter “Ansichten”¶

Mit diesen Optionen legen Sie fest, wie viele Termine Sie in den verschiedenen Ansichten darstellen wollen. Gerade bei umfangreichen Terminkalendern kann es sinnvoll sein, die Anzahl der Termine zu beschränken, da die Listen sonst sehr lang und unübersichtlich werden. Die Standardwerte sind jeweils in eckigen Klammer [] dargestellt.

• Anzahl der Tage in der Boxansicht [7]
• Anzahl der Einträge in “Nächste Termine” [10]
• Anzahl der Einträge in der Listenansicht [20]
• In der Listenansicht Dropdown für die nächsten 2 Jahre nicht zeigen : blendet das Dropdown Menü aus, welches die nächsten 24 Monate anzeigt.

Reiter “Warnungen”¶

Normalerweise warnt VCE den Benutzer, wenn auf einer Seite nicht genügend Informationen vorhanden sind, um eine sinnvolle Filterfunktionen einblenden zu können. Das geschieht zum Beispiel immer dann, wenn nicht genug Kategorien definiert wurden. Mit dieser Option wird der Benutzer darauf aufmerksam gemacht, dass er unter Umständen nicht alle Termine angezeigt bekommt. Hier können Sie diese Warnmeldung ausschalten.

Aufbau¶

Das Standardtemplate html_template.html befindet sich im Ordner EXT:sk_calendarpi1. Dieses Template wird immer dann verwendet, wenn der Benutzer kein eigenes Template angibt.

Innerhalb des Templates finden Sie neben weiteren Angaben zu den verwendeten Markern die Definition für die verschiedenen Ansichten. Wir erklären den generellen Aufbau einer Ansicht am Beispiel Monatsansicht

1: <!--###MONTH_VIEW_ITEM### begin
2:     item for monthview
3:     -->
4: <div style="background: ###C_color###; clear: all; border-top: 1px dotted #a3a3a3; padding: 0px 0px 0px 0px;"><img src="/uploads/tx_skcalendar/###C_icon###">&nbsp;###DETAILLINK###</div>
5: <!--###MONTH_VIEW_ITEM### end -->

 7: <!--###MONTH_VIEW_DAYWRAP### begin
 8:     wrap day
 9:     -->
10:     <td height=50 width=14% class="###DAYSTYLE###">###DAYNAME###<br>###WRAPIT###</td>
11: <!--###MONTH_VIEW_DAYWRAP### end -->

.month_weekday {
    color : #000000;
    background-color : #ffffff;
}

.month_today {
    background-color : #ff0000;
    border-color : #000000;
}

.month_holiday {
    color : #FF0000;
    background-color : #ffeeaa;
}

13: <!--###MONTH_VIEW_ROWWRAP### begin
14:     wrap row
15:     -->
16: <tr valign=top>
17: ###WRAPIT###
18: </tr>
19: <!--###MONTH_VIEW_ROWWRAP### end -->

21: <!--###MONTH_VIEW_CALENDARWRAP### begin
22:     wrap calendar
23:     -->
24: <tr>
25:     <td>
26:         <table cellspacing=0 cellpadding=3>
27:             <tr valign=top>
28:                 <td><b>###LABEL_month_view### ###MONTHNAME###</b></td>
29:             </tr>
30:         </table>
31:     </td>
32: </tr>
33: <tr>
34:     <td>
35:         <table cellspacing=0 cellpadding=2 border=1 width=100%>
36:             <tr>
37:                 <td align=right><b>Mo</b></td>
38:                 <td align=right><b>Di</b></td>
39:                 <td align=right><b>Mi</b></td>
40:                 <td align=right><b>Do</b></td>
41:                 <td align=right><b>Fr</b></td>
42:                 <td align=right><b>Sa</b></td>
43:                 <td align=right class="month_holiday"><b>So</b></td>
44:             </tr>
45:             ###WRAPIT###
46:         </table>
47:     </td>
48: </tr>
49: <!--###MONTH_VIEW_CALENDARWRAP### end -->

51: <!--###MONTH_VIEW_NAVIGATION### begin
52:     navigation
53:     -->
54: <tr>
55:     <td>
56:         <table cellspacing=0 cellpadding=3 width=100%>
57:             <tr valign=bottom>
58:                 <td>
59:                     <table cellpadding=0 cellspacing=0 border=0 width=100%>
60:                         <tr>
61:                             <td align=left>###BACKLINK###</td>
62:                             <td align=right>###NEXTLINK###</td>
63:                         </tr>
64:                     </table>
65:                 </td>
66:             </tr>
67:         </table>
68:     </td>
69: </tr>
70: <!--###MONTH_VIEW_NAVIGATION### end -->

72: <!--###MONTH_VIEW_WHOLEWRAP### begin
73:     wrap whole month
74:     -->
75: <table cellspacing=0 cellpadding=0 border=0 width=100%>
76:     ###WRAPIT###
77: </table>
78: <!--###MONTH_VIEW_WHOLEWRAP### end -->

Sprachlabels¶

Im vorigen Abschnitt haben Sie bereits einige der Sprachlabels kennengelernt. Diese Labels wurden bereits in die verschiedenen TYPO3 Systemsprachen übersetzt, können von Ihnen aber auch nachträglich angepasst werden.

Ein Sprachlabel wird folgendermassen angesprochen: ###LABEL_<name>###. Die verschiedenen Werte für <name> finden Sie in der Datei EXT:sk_calendarpi1locallang. Hier einige Beispiele:

Template Marker¶

Neben den Sprachlabels gibt es es noch die Template Marker, welche die Inhalte der eigentlichen Datensätze für das Templatedesign verfügbar machen. Template Marker werden in Templates folgendermaßen angesprochen: ###X_yyy###. Xsteht dabei für eine der fünf möglichen Gruppen (Termin, Veranstalter, Veranstaltungsort, Kategorie und Zielgruppe) und yyyfür einen Wert aus der entsprechenden Datenbanktabelle.

Die Klasse class.tx_skcalendar_defaultTF.php¶

In dieser Klasse werden grundlegende Template-Funktionen ( *defaultT* emplate *F* unctions) definiert. Diese werden dem Benutzer dabei in Form von Template Markern zur Verfügung gestellt.

Hier einige Beispiele aus class.tx_skcalendar_defaultTF.php

[...]
class tx_skcalendar_defaultTF extends tx_skcalendar_te {
var $snippet;

function templatefunc_e_date () {
        $this->snippet = date('d.m.Y',$this->data['e_date']);
    }

Das ist die Funktion, mit der der Template Marker ###E_date### (Datum für Termin) bereitgestellt wird.

function templatefunc_e_start_time () {
    if ($this->data['e_start_time']) {
        $hours = floor($this->data['e_start_time']/3600);
        $minutes = ($this->data['e_start_time']%3600)/60; // modulus
        if ($minutes < 10) $minutes = '0' . $minutes;
        $this->snippet =  $hours . ':' . $minutes . ' ';
        }
    }

Der Template Marker ###E_start_time### (Anfang des Termins).

function templatefunc_dayname() {
    $this->snippet = $this->TempData['name'];
}

Der Template Marker ###DAYNAME### (numerischer Wert des Tages).

Sicher haben Sie das Prinzip schon Begriffen: jede Funktion, die über einen Template Marker angesprochen werden soll, muss mit mittels functiontemplatefunc_my_marker()deklariert werden. Der Funktion kann dabei kein Argument übergeben werden (Template Marker!).templatefunc_ist ein fester Bestandteil des Funktionsnamens, der Template Marker selber heisst dann ###my_marker###. Ihre Funktion muss den Rückgabewert dann in der Variablen$this->snippetbereitstellen.

Sie sollten keine Veränderungen an der Datei class.tx_skcalendar_defaultTF.php vornehmen. Ihre eigenen Funktionen gehören in die Datei class.tx_skcalendar_overrideTF.php.

Die Klasse class.tx_skcalendar_overrideTF.php¶

Gleich nach der defaultTF Klasse wird die Erweiterungs-Klasse overrideTF eingebunden. Hier können Sie zum Beispiel bestehende Funktionen überschreiben:

<?php
/* This is an example file for the template override function.
In this case the dayname of the monthfew is altered.
This example doesn't make much sence but you get the idea */

class tx_skcalendar_overrideTF extends tx_skcalendar_defaultTF  {

    function templatefunc_dayname() {
        $this->TempData['name'] = 'Hello world';// manipulates dayname
        parent::templatefunc_dayname(); // calls the parentfunction for returning the value
    }
}
?>

Der Marker ###DAYNAME### zeigt jetzt nicht mehr den numerischen Tageswert sonder stattdessen “Hello world” an. Achtung: Wenn Sie eine bereits bestehende Funktion defaultFunction überschreiben wollen, müssen Sie diese mit parent::templatefunc_defaultFunction();in Ihrer geänderten Funktion aufrufen.

Hier ein etwas sinnvolleres Beispiel:

function templatefunc_year() {
    $this->snippet = strftime('%Y',$this->TempData['date']);
}

Damit steht Ihnen ein neuer Marker ###YEAR### zur Verfügung.