EXT: kool_leute Extension Key: kool_leute Copyright 28-29, Renzo Lauper, <renzo.lauper@kircheonline.ch> 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: kool_leute... Introduction... What does it do?... Screenshots... Users manual...2 Frontend Plugin...2 Backend module (Filtervorlagen)...3 Configuration...3 Reference...3 To-Do list...5 Changelog...5 Introduction What does it do? 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 http://www.churchtool.org. Mit dieser Extension können Sie Adressen aus kool auf Ihrer Webseite publizieren. Zur Ausgabe stehen Ihnen verschiedene Möglichkeiten zur Verfügung: Einzelansicht Liste Sortierbare 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 TYPO3, da die Extension direkt auf die Datenbank zugreifen können muss. Damit diese Extension funktioniert, muss ebenfalls kool_base installiert sein. kool muss mindestens in der Version R3 vorliegen und mit einem Encryption-Key konfiguriert sein. Damit Filtervorlagen aus kool im TYPO3 verwendet werden können, muss das kool-plugin t3_kool_leute installiert sein. (Mehr dazu weiter unten) Screenshots Einstellungen zum Plugin im TYPO3 mittels Flexforms: EXT: kool_leute -
Users manual Frontend Plugin Wenn alle Voraussetzungen gegeben sind, ist die Verwendung dieser Extension denkbar einfach.. Extensions installieren Als erstes muss die Extension kool_base installiert werden (falls nicht schon vorhanden). Bei der Konfiguration müssen die Angaben zur kool-url, dem kool-port, dem kool Encryption Key und der kool Datenbank gemacht werden. Der Encryption Key muss der selbe sein, der auch in kool in der Datei config/ko-config.inc konfiguriert wurde (KOOL_ENCRYPTION_KEY). Nun muss die Extension kool_leute installiert werden. Dazu muss lediglich die Extension über den TYPO3-Extension-Manager installiert werden, sonst nichts.. Plugin einfügen Fügen Sie auf einer Seite im TYPO3 ein neues Inhaltselement vom Typ kool Leute ein. Dieses finden Sie auf der Liste der Inhaltselemente ganz unten im Bereich Plugins. 2. Einstellungen vornehmen Darstellung: Wählen Sie die gewünschte Ausgabe der Adressen: Liste: Eine einfache Liste Tabelle: Sortierbare Tabelle Einzelansicht: Eine Detaildarstellung einer einzelnen Adresse. Anzuzeigende Spalten: Wählen Sie aus, welche Informationen zu den Adressen dargestellt werden sollen. Anzuwendende Gruppen-Filter: Hier können Sie die ausgegebenen Adressen mit hilfe eines Gruppen/Rollen-Filters einschränken. Weitere Filter anwenden: Mit diesen Filtern können Sie die darzustellenden Adressen weiter einschränken. Hier erscheinen einerseits die Filtervorlagen, die in kool exportiert wurden wie auch die über TypoScript definierten Filter. Mehr dazu finden Sie weiter unten. Filter verknüpfen mit: Wählen Sie, wie die verschiedenen Filter verknüpft werden sollen. Gemischt heisst, dass Filter vom selbem Typ mit ODER verknüpft werden, aber die einzelnen Filtertypen unter sich mit UND. Sortiere Geburtsdatum nach: Definieren Sie, ob die Sortierung nach Alter oder nach den Geburtstagen sortiert werden sollen. Template-Datei: Wählen Sie eine HTML-Datei, die als Template (Vorlage) für die Darstellung dienen soll. Mehr dazu weiter unten. Seite für Details-Ansicht: Geben Sie an, auf welcher Seite Sie die Einzelansicht vornehmen lassen möchten. In den verschiedenen Tabs können Sie noch feiner Einstellungen für das gewählte Layout vornehmen: EXT: kool_leute - 2
Liste Nach dieser Spalte sortieren Reihenfolge der Sortierung Bildbreite: für das Dienstleiter-Bild in Pixeln Anzahl Einträge pro Seite Vor/zurück Links verstecken, falls nur eine Seite: Damit lassen sich die Links zum Seiten blättern ausblenden, falls diese nicht benötigt werden. Tabelle Spalten sortieren lassen: Wählen Sie, ob der Webseiten-Benutzer die Spalten selber sortieren darf oder nicht. Sortierreihenfolge limitieren: Wenn der Webseiten-Benutzer die Spalten sortieren darf, können Sie die Sortierreihenfolge limitieren. Dies dient hauptsächlich der Vermeidung von Missverständnissen. Anzahl Einträge pro Seite Bildbreite: für das Bild in Pixeln Vor/zurück Links verstecken, falls nur eine Seite: Damit lassen sich die Links zum Seiten blättern ausblenden, falls diese nicht benötigt werden. Einzelansicht Bildbreite: für das Bild in Pixeln Backend module (Filtervorlagen) Nach der Installation der Extension finden Sie ein neues Backend-Modul kool->leute. Dort finden Sie eine Liste aller in TYPO3 verfügbaren Filtervorlagen. Hier sehen Sie, welcher kool-benutzer diese wann erstellt hat und können vorhandene Filtervorlagen wieder löschen. In der hintersten Spalte finden Sie neben der Möglichkeit, diese Filtervorlage zu löschen auch die Anzahl Plugins, in der diese Filtervorlage verwendet wird (Im Screenshot wird die zweite Vorlage mal verwendet). Diese Filtervorlagen werden über ein kool-plugin aus kool heraus gespeichert. kool-plugin t3_kool_leute installieren Im Extension-Verzeichnis der Extension kool_leute befindet sich ein Ordner t3_kool_leute, welcher das kool-plugin enthält. Diesen Ordner können Sie in den plugin-ordner von kool kopieren und dieses Plugin über das Tools-Modul installieren. Danach erscheint im Leute-Modul im Filter-Submenu eine neue Option Für TYPO3 speichern. Damit wird der aktuell angewandte Filter unter dem definierten Namen in TYPO3 gespeichert und kann danach beim Plugin ausgewählt werden. Configuration Zugriff auf die kool-datenbank Die Extension kool_leute holt die Angaben zu den Adressen mittels SQL-Befehlen direkt aus der kool-datenbank. Deshalb muss der TYPO3 MySQL-Benutzer SELECT-Rechte auf die kool-datenbank haben. Damit die Filtervorlagen aus kool in TYPO3 gespeichert werden können, muss der kool MySQL-Benutzer ebenfalls INSERT-Rechte auf der TYPO3-Datenbank haben. Zusätzlich benötigt kool_leute get.php von kool, welche seit Version R3 eine XML-Schnittstelle zur Verfügung stellt. 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: EXT: kool_leute - 3
Beispiel: Verwendung im TS-Template plugin.tx_koolleute_pi.layout = table plugin.tx_koolleute_pi.templatefile = fileadmin/template/kool_dienste.tmpl temp.liste = COA temp.liste. = TEXT temp.liste..value = <div>adressen:</div> temp.liste.2 < plugin.tx_koolleute_pi Reference TypoScript: layout string Layout der Ausgabe. Mögliche Werte sind: list, table, single list templatefile string Template-Datei, die zur Darstellung verwendet EXT:kool_leute/pi /template.tmpl columns string Eine kommagetrennte Liste der darzustellenden Spalten pro Adresse. Mögliche Werte sind der kool-datenbank zu entnehmen (vorname, nachname, firm, usw.) singlepid int ID der Seite, die für die Detaildarstellung verwendet imagelinkwrap imagelinkwrap Konfiguration für die Darstellung von Klick-vergrössern- Bildern. TypoScript für Filter filter : Zusätzlich zu den Gruppen/Rollen-Filtern und den aus kool exportierten Filtervorlagen können über TS weitere Filter definiert werden, die im SQL-Query verwendet werden, um die Adressen 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 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_koolleute_pi.filter = plugin.tx_koolleute_pi.filter. { name = Geschlecht sql = `geschlecht` = '[VALUE]' dbcol = geschlecht values = m w } TypoScript für Liste list : list.sort string Definiert die Spalte, nach der die Liste sortiert wird name list.sortorder string ASC oder DESC um eine auf- oder absteigende Sortierung zu erzwingen ASC list.imagewidth int Bildbreite, die für ein Bild in der Tabelle verwendet 5 list.imageclickenlarge Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt list.limit int Maximale Anzahl Einträge pro Seite 2 list.hidepaging Boolean Definiert, ob die paging-links (vor zurück) ausgeblendet werden sollen, wenn es nur eine Seite gibt. list.linktext string Text der für die Spalte Web verwendet wird anstelle der URL list.linktextemail string Text der für die Spalte E-Mail verwendet wird anstelle der E-Mail Adresse EXT: kool_leute - 4
TypoScript für Tabelle table : table.allowsort boolean Gibt an, ob der Webseiten-Benutzer die Tabelle selber sortieren darf oder nicht. table.limit int Definieren Sie die maximale Anzahl Einträge pro Seite 2 table.imagewidth int Bildbreite, die für ein Bild in der Tabelle verwendet 5 table.imageclickenlarge Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt table.header.useimages boolean Entscheiden Sie, ob für die Spaltenüberschriften Bilder oder Text verwendet werden sollen table.header.images IMAGE Damit können Sie z.b. mittels GIFBUILDER ein dynamisches Bild für die Spaltenüberschrift erstellen lassen. table.header.imageshig hlight file Analog zu table.header.images, einfach für die aktuell sortierte Spalte. table.linktext string Text der für die Spalte Web verwendet wird anstelle der URL table.linktextemail string Text der für die Spalte E-Mail verwendet wird anstelle der E-Mail Adresse table.defaultsort string Spalte, nach der standardmässig sortiert werden soll table.defaultsortorder string ASC oder DESC für aufsteigende oder absteigende Standard-Sortierung TypoScript für Einzelansicht single : single.imagewidth int Bildbreite, die für ein Bild in der Tabelle verwendet 25 single.imageclickenlarg e Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt single.linktext string Text der für die Spalte Web verwendet wird anstelle der URL single.linktextemail string Text der für die Spalte E-Mail verwendet wird anstelle der E-Mail Adresse To-Do list Adressänderungen mittels Formular Changelog.3.: DefaultSort für Tabellen.3: Gruppen- und Datenfelder-Spalten können auch ausgegeben werden.2: Bessere Filter und erhöhte Effizienz (kein SQL mehr vor XML).: Erste öffentliche Version EXT: kool_leute - 5