EXT: kool_daten. Extension Key: kool_daten Copyright , Renzo Lauper,

Transkript

1 EXT: kool_daten Extension Key: kool_daten Copyright 27-29, Renzo Lauper, This document is published under the Open Content License available from The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from Table of Contents EXT: kool_daten...1 Introduction...1 What does it do?...1 Screenshots...1 Users manual...2 Configuration...3 Reference...4 Tutorial...6 To-Do list...6 Changelog...6 Einleitung Was macht diese Extension? Diese Extension bildet die Schnittstelle zwischen der Webseite und kool - dem Kirchen-Tool. Ohne kool macht diese Extension keinen Sinn. Mehr über kool erfahren Sie unter Mit dieser Extension können Sie Termine aus der kool-terminedatenbank auf Ihrer Webseite publizieren. Damit müssen die Termine nur einmal erfasst werden (im kool) und erscheinen auch auf der Webseite immer aktuell. Zur Ausgabe stehen Ihnen verschiedene Möglichkeiten zur Verfügung: Terminliste Monatsliste Monatskalender Teaser Tabelle Voraussetzungen Die wichtigsten Voraussetzungen zum Einsatz dieser Extension sind eine TYPO3-basierte Webseite und ein kool. Im Moment ist es zwingend, dass die kool-datenbank auf dem gleichen Webserver liegt, wie das TYPO3, da die Extension direkt auf die Datenbank zugreifen können muss. Dabei muss der TYPO3-MySQL-Benutzer Zugriff auf die kool Datenbank haben. kool_daten hängt von der Extension kool_base ab. Zur Darstellung der Termin-Details in der Kalenderansicht, muss die Extension overlib installiert sein. Screenshots Einstellungen zum Plugin im TYPO3 mittels Flexforms: EXT: kool_daten - 1

2 FE-Ausgaben: Monats-Kalender, Monatsliste, Terminliste, Teaser Benutzerhandbuch Wenn alle Voraussetzungen gegeben sind, ist die Verwendung dieser Extension denkbar einfach.. Extension installieren Als erstes muss natürlich die Extension kool_daten installiert werden. Dazu muss lediglich die Extension über den TYPO3- Extension-Manager installiert werden, sonst nichts. EXT: kool_daten - 2

3 1. Plugin einfügen Fügen Sie auf einer Seite im TYPO3 ein neues Inhaltselement vom Typ kool Termine darstellen ein. Dieses finden Sie auf der Liste der Inhaltselemente ganz unten im Bereich Plugins. 2. Einstellungen vornehmen Layout: Wählen Sie die gewünschte Ausgabe der Termine: Terminliste: Eine einfache Auflistung der nächsten x Termine. Liste nach Monaten: Eine nach Datum sortierte Liste der Anlässe pro Monat für die nächsten x Monate Kalender: Monatskalender aller Anlässe für die nächsten x Monate Teaser: Eine Kurzdarstellung der nächsten x Anlässe Tabelle: Sortierbare Tabelle Anzuzeigende Spalten: Wählen Sie die Spalten aus, die in der Liste, dem Teaser oder in der Monatsliste erscheinen sollen. Bei der Tabellen-Ansicht werden hiermit die dargestellten Spalten und beim Kalender die Details bei MouseOver definiert. Termingruppen: Es werden nur die Termine der ausgewählten Termingruppen dargestellt. Ebenfalls erscheinen hier die Kalender, falls solche in kool definiert sind. Damit können alle Termine dargestellt werden, welche zu einer Termingruppe dieser Kalender gehören. Termingruppen verlinken: Falls im kool für die Termingruppen eine URL eingetragen ist, werden mit dieser Option die Termingruppen-Namen auf der Webseite mit dieser URL verlinkt. Es ist auch möglich, Adressen als URL im kool zu erfassen, welche dann als s Links dargestellt werden. Globale Filter anwenden?: Falls Sie im kool einen globalen Filter definiert haben, können Sie diese hier ebenfalls anwenden lassen. Folgende Filter anwenden: Diese Liste zeigt die mittels TS definierten Filter an, die angewandt werden können. Mehr zur Definition von Filtern siehe weiter unten. Filter verknpüfen mit: Hier können Sie auswählen wie die verschiedenen Filter verknüpft werden sollen. Gemischt heisst, dass Filter gleichen Typs mit ODER und andersartige Filter unter einandern mit UND verknüpft werden. Template-Datei: Wählen Sie eine HTML-Datei, die als Template (Vorlage) für die Darstellung dienen soll. Mehr dazu weiter unten. In den verschiedenen Tabs können Sie noch feiner Einstellungen für das gewählte Layout vornehmen: Liste Nach dieser Spalte sortieren: Wählen Sie die Spalte aus, nach der die ausgegebenen Termine sortiert werden sollen. Reihenfolge der Sortierung: Die Termine können auf- oder absteigend sortiert werden. Anzahl Einträge pro Seite: Geben Sie an, wie viele Termine maximal in der Listenansicht dargestellt werden sollen. Diese Einstellung gilt über alle Termingruppen und nicht pro Termingruppe. Es werden nur heute und zukünftige Anlässe dargestellt. Monatsliste Anzahl Monate: Wählen Sie die Anzahl Monate, die dargestellt werden sollen. Ab heute: Aktivieren Sie diese Option, damit die vergangenen Termin des aktuellen Monats ausgeblendet werden und nur Termine ab heute erscheinen. Teaser EXT: kool_daten - 3

4 Nach dieser Spalte sortieren: Wählen Sie die Spalte aus, nach der die ausgegebenen Termine sortiert werden sollen. Reihenfolge der Sortierung: Die Termine können auf- oder absteigend sortiert werden. Anzahl Anlässe: Definieren Sie die maximale Anzahl Termine, die in der Teaser-Darstellung erscheinen sollen. Kalender Anzahl Monate: Definieren Sie die Anzahl Monate, die als Monatskalender ausgegeben werden sollen. Details zu Anlässen anzeigen: Aktivieren Sie diese Option, um die Details zu einem Anlass als Overlib-Text anzeigen zu lassen. Diese Details erscheinen, sobald der Benutzer mit der Maus über den Termineintrag fährt. Maximale Länger für Termingruppen-Name: Definieren Sie, nach wie vielen Zeichen der Termingruppen-Name abgebrochen werden soll. Dies wird dann mit zwei Punkten am Schluss dargestellt. Lassen Sie dieses Feld leer, um immer die ganzen Namen darzustellen. Tabelle Spalten sortieren lassen: Wenn Sie diese Option aktivieren, kann die Tabelle durch einen Klick auf den Spaltentitel sortiert werden. Sortierreihenfolge limitieren: Wählen Sie hier aus, ob der Benutzer die Spalten ohne Limitierung sortieren darf. Oft kann es sinnvoll sein, die Limitierung auf z.b. nur Aufsteigend zu beschränken, damit es zu weniger Verwirrung in der Anwendung kommt. Maximale Anzahl Einträge pro Seite: Anzahl Termine, die pro Seite dargestellt werden sollen Vor-/Zurück-Links ausblenden: Damit werden die Links zum Blättern ausgeblendet, was bedeutet, dass man nur die oben angegebene Anzahl Termine sieht. Konfiguration TypoScript vs. Flexform-Werte Alle Einstellungen, die über TS vorgenommen wurden, können mit den Werten in der Flexform überschrieben werden. Weiter kann die Extension auch direkt als cobj über TypoScript ins Template eingebunden werden: Beispiel: Verwendung im TS-Template plugin.tx_kooldaten_pi1.layout = list plugin.tx_kooldaten_pi1.templatefile = fileadmin/template/kool_daten.tmpl plugin.tx_kooldaten_pi1.list.numevents = 3 plugin.tx_kooldaten_pi1.uselink = 1 plugin.tx_kooldaten_pi1.eventgroupids = 1,3,8,3,7,31 temp.daten = COA temp.daten.1 = TEXT temp.daten.1.value = <div class="frontpage_dates">nächste Termine:</div> temp.daten.2 < plugin.tx_kooldaten_pi1 Reference TypoScript: layout string Layout der Ausgabe. Mögliche Werte sind: teaser, list, monthlist, table templatefile string Template-Datei, die zur Darstellung verwendet werden soll. EXT:kool_daten/pi 1/template.tmpl uselink boolean 1/: Geben Sie an, ob die Termingruppen-Namen in der Ausgabe verlinkt werden sollen oder nicht. Als Link werden die Angaben zur Termingruppe aus dem kool verwendet. usepermfilter boolean Definieren Sie, ob die globalen Filter aus kool auch hier angewandt werden sollen oder nicht. eventgroupids string Kommagetrennte Liste der Termingruppen, für die Anlässe ausgegeben werden sollen. Die IDs der Termingruppen stehen bei den Termingruppen in Klammern. Für Kalender muss ein _CAL der ID vorangestellt werden, z.b. _CAL12. Um alle Termingruppen darzustellen, kann auch _all verwendet werden. overlibdefaults. string Hier können Sie das Layout des Overlib-Divs definieren. Die möglichen Angaben entnehmen Sie der Dokumentation der Extension overlib oder direkt der Webpage von overlib. [tsref:(cobject).tx_kooldaten_pi1] ol_fgcolor= #eee ol_bgcolor= #555 EXT: kool_daten - 4

5 TypoScript für Terminliste filter : Hiermit können eigene Filter definiert werden, die im SQL-Query verwendet werden, um die Daten aus der kool-datenbank auszulesen. Mehrere ausgewählte Filter mit der selben ID werden mittels OR verknüpft, Filter mit verschiedenen IDs mittels AND. Dies entspricht der Option Gemischt für die Verlinkung und kann in der Flexform geändert werden. filter int Muss 1 sein, damit Filter verwendet werden. filter.id array Jeder Filter muss eine eindeutige ID haben (z.b. Integer) mit folgenden Einträgen: - name: Name, der im BE in der Flexform-Auswahlliste erscheint - sql: SQL-Befehl, der zur Filterung verwendet wird. Kann [VALUE] enthalten, welches mit dem entsprechenden Wert aus values ersetzt wird - values: Mehrere Werte durch getrennt. Für jeden Wert wird in der Flexform-Auswahlliste ein einzelner Eintrag erstellt. Beispiel: plugin.tx_kooldaten_pi1.filter = 1 plugin.tx_kooldaten_pi1.filter.1 { name = Raum sql = `room` = '[VALUE]' dbcol = room values = Hauptsaal Jugendraum Cafeteria } TypoScript für Terminliste fields : Hiermit können weitere Spalten für die Darstellung definiert werden. Dies ist primär für die Tabellen-Darstellung sinnvoll, womit z.b. kombinierte Spalten möglich sind. Es kann aber auch für Liste oder Teaser verwendet werden. In diesen Layouts müssen im HTML-Template die entsprechenden Subparts ###SUBPART USERFIELD_ID### eingefügt werden (es sind zwei _ zwischen SUBPART und USERFIELD!) fields.ignore commalist Hiermit können einzelne Spalten deaktiviert werden, welche dann auch im BE nicht mehr ausgewählt werden können. Mehrere Einträge können durch Kommas getrennt werden. fields.add boolean Muss 1 sein, damit weitere Spalten verwendet werden können 1 fields.add.id array Jede zusätzliche Spalte wird mit den folgenden Angaben definiert: - name: Name, der im BE in der Flexform-Auswahlliste erscheint - header: Titel dieser Spalte, wie sie z.b. als Spaltenüberschrift für die Tabelle verwendet werden soll - output: Hier kann definiert werden, wie diese neue Spalte dargestellt werden soll. Es können Werte von den eigentlichen DB-Spalten ausgegeben werden, indem Platzhalter ###COLNAME### verwendet werden. Beispiel: plugin.tx_kooldaten_pi1.fields { add = 1 add.datetime { name = Datum und Zeit header = Start output = ###STARTDATUM###<br />###STARTZEIT### } } TypoScript für Terminliste list : list.limit int Anzahl Termine, die ausgegeben werden sollen. Es werden nur Termine mit Datum ab heute angezeigt. 5 list.datelayout strftime strftime-wert, der die Formatierung des Datums definiert. %A, %d. %B %Y list.timelayout strftime strftime-wert, der die Formatierung der Zeiten definiert %H:%M list.datelink string Text zwischen Start- und Enddatum, falls beide dargestellt werden - list.timelink string Text zwischen Start- und Endzeit, falls beide dargestellt werden - list.sort string Sortierung der Termine startdatum list.sortorder string Art der Sortierung der Termine ASC list.forcecolumns string Kommagetrennte Liste von Spalten, die für dieses Layout immer verwendet EXT: kool_daten - 5

6 TypoScript für Monatsliste monthlist : monthlist.nummonths int Anzahl Monate, die ab und mit dem aktuellen dargestellt werden sollen. 2 monthlist.starttoday boolean Alle vergangenen Termine ausblenden. Standard ist, dass der ganze aktuelle Monat angezeigt wird. monthlist.datelayout strftime siehe list %A, %d. %B %Y monthlist.timelayout strftime siehe list %H:%M monthlist.datelink string Text zwischen Start- und Enddatum, falls beide dargestellt werden - monthlist.timelink string Text zwischen Start- und Endzeit, falls beide dargestellt werden - monthlist.forcecolumns string Kommagetrennte Liste von Spalten, die für dieses Layout immer verwendet TypoScript für Monatskalender calendarbig : calendarbig.nummonths int Anzahl Monate, die ab und mit dem aktuellen dargestellt werden sollen. 2 calendarbig.showdetails boolean 1/: Geben Sie an, ob die Details zu einem Anlass als Overlib-Text erscheinen soll, wenn der Benutzer mit der Maus über den Text fährt. 1 calendarbig.titlelength int Maximale Länge des Termingruppen-Namens. Falls ein Titel länger als der hier angegebene Wert ist, wird er abgeschnitten und dies mit.. markiert. unbegrenzt () calendarbig.forcecolum ns string Kommagetrennte Liste von Spalten, die für dieses Layout immer verwendet TypoScript für Teaser teaser : teaser.limit int Anzahl Monate, die ab und mit dem aktuellen dargestellt werden sollen. 5 teaser.datelayout strftime strftime-wert, der die Formatierung des Datums definiert. %d.%m. teaser.timelayout strftime strftime-wert, der die Formatierung der Zeit definiert. %H:%M teaser.datelink string Text zwischen Start- und Enddatum, falls beide dargestellt werden - teaser.timelink string Text zwischen Start- und Endzeit, falls beide dargestellt werden - teaser.sort string Sortierung der Termine startdatum teaser.sortorder string Art der Sortierung der Termine ASC teaser.combineeventgr oups boolean 1/: Damit können Termingruppen zusammengefasst dargestellt werden. Hier ein Beispiel: teaser.combineeventgroups = 1 teaser.combineeventgroups.1.ids = 2,6,17 teaser.combineeventgroups.1.url = teaser.combineeventgroups.1.title = Gottesdienste teaser.combineeventgroups.2.ids = usw. Mit der ersten Zeile wird die Zusammenfassung überhaupt aktiviert. In der zweiten Zeile wird eine neue Zusammenfassung für die Termingruppen mit den IDs 2, 6 und 17 gestartet, und die nächsten beiden Zeilen definieren die URL und den Titel dieser neuen zusammengefassten Termingruppe. teaser.focecolumns string Kommagetrennte Liste von Spalten, die für dieses Layout immer verwendet TypoScript für Teaser table : table.fields intlist Eine Liste der Spalten, die angezeigt werden sollen. Mögliche Werte sind: date, time, datetime, event, comment, eventcomment, room, details table.datelayout strftime strftime-wert, der die Formatierung des Datums definiert. %d.%m.%y table.timelayout strftime strftime-wert, der die Formatierung der Zeit definiert. %H:%M table.combineeventgrou ps boolean 1/: Damit können Termingruppen zusammengefasst dargestellt werden. Hier ein Beispiel: teaser.combineeventgroups = 1 teaser.combineeventgroups.1.ids = 2,6,17 teaser.combineeventgroups.1.url = teaser.combineeventgroups.1.title = Gottesdienste teaser.combineeventgroups.2.ids = usw. Mit der ersten Zeile wird die Zusammenfassung überhaupt aktiviert. In der zweiten Zeile wird eine neue Zusammenfassung für die Termingruppen mit den IDs 2, 6 und 17 gestartet, und die nächsten beiden Zeilen definieren die URL und den Titel dieser neuen zusammengefassten Termingruppe. EXT: kool_daten - 6

7 table.sort boolean Definieren Sie, ob die Tabelle nach den verschiedenen Spalten sortiert werden kann oder nicht. table.limit int Maximale Anzahl Termine pro Seite 2 table.header.useimages boolean Entscheiden Sie, ob für die Spaltenüberschriften Bilder oder Text verwendet werden sollen table.forcecolumns string Kommagetrennte Liste von Spalten, die für dieses Layout immer verwendet Changelog See file ChangeLog. EXT: kool_daten - 7