EXT: kool_kgliste Extension Key: kool_kgliste Copyright 2007, 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_kgliste... Introduction... What does it do?... Screenshots... Users manual...2 Frontend Plugin...2 Backend Modul für Kartenansicht...3 Configuration...4 Reference...4 Tutorial...6 To-Do list...6 Changelog...6 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 Kleingruppen auf Ihrer Webseite publizieren. Zur Ausgabe stehen Ihnen verschiedene Möglichkeiten zur Verfügung: Karte 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 das Typo3, da die Extension direkt auf die Datenbank zugreifen können muss. Es wird in Zukunft (bei Bedarf) auch möglich sein, die SQL-Angaben mittels TypoScript zu definieren, damit die kool-datenbank auf einem anderen Server verwendet werden kann. In der Kartendarstellung ist für die Verwendung der Detailansicht die Extension overlib nötig. Screenshots Einstellungen zum Plugin im Typo3 mittels Flexforms: EXT: kool_kgliste -
FE-Ausgaben: Tabelle Users manual Frontend Plugin Wenn alle Voraussetzungen gegeben sind, ist die Verwendung dieser Extension denkbar einfach. 0. Extension installieren Als erstes muss natürlich die Extension kool_kgliste 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 Termine darstellen 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 Kleingruppen: Liste: Eine einfache Liste Tabelle: Sortierbare Tabelle Einzelansicht: Eine Detaildarstellung einer einzelnen Kleingruppe. Karte: Eine Karte mit allen Kleingruppen. Definierbar über das Backend-Modul. Zeige diese Typen: Wählen Sie, welche Kleingruppen-Typen dargestellt werden sollen. Folgende Filter anwenden: Wählen Sie einen oder mehrere Filter aus, damit Sie nur einen Teil der Kleingruppen EXT: kool_kgliste - 2
darstellen können. Filter für die gleiche Spalte werden mit ODER, andere mit UND verknüpft. Zeige diese Spalten: Wählen Sie aus, welche Informationen zu den Kleingruppen dargestellt 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 Detail-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: Liste Nach dieser Spalte sortieren Reihenfolge der Sortierung Bildbreite: für das Kleingruppenbild in Pixeln Bild auf Klick vergrössern 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 Kleingruppenbild in Pixeln Bild auf Klick vergrössern Einzelansicht Bildbreite: für das Kleingruppenbild in Pixeln Bild auf Klick vergrössern Karte Karte: Wählen Sie aus, welche Karte dargestellt werden soll. Dazu müssen erst Karten über das Backend-Modul definiert werden. Mehr dazu weiter unten. Details zeigen bei MouseOver: Ist diese Option aktiviert, erscheint beim Überfahren der Kleingruppe auf der Karte die Details in einem kleinen Text-Bereich unter der Mouse. Details nicht mit Maus mitlaufen lassen: Mit dieser Option bleibt die Detailanzeige stehen, was es ermöglicht, einen Link darin anzuklicken, oder Text darin zu markieren. Markierungs-Bild: Wählen Sie ein kleines Bild, das für die Markierung der Kleingruppen auf der Karte verwendet werden soll. Dies kann z.b. ein Punkt oder ein Flagge oder etwas ähnliches sein. Offset für Markierung: Geben Sie die Offsets in X- und Y-Richtung an, die für das Markierungsbild verwendet werden sollen. Diese Werte werden in Pixeln vom oberen linken Rand des Markierungs-Bilder interpretiert. Backend Modul für Kartenansicht Nach der Installation der Extension kool_kgliste erscheint in der Modulliste ein neues Modul KG- Karte in der Gruppe kool. Mit diesem Backend-Modul können Sie selber ein Bild für die Karte hochladen und die Positionen sämtlicher Kleingruppen mittels Mausklicks definieren. Neue Karte erstellen Wählen Sie einen Titel für die Karte. Dieser wird lediglich im Typo3-Backend zur Identifikation der Karte verwendet. Selektieren Sie ein Bild einer Karte und laden Sie dieses hoch. Nun sehen Sie in der Liste der Karten einen neuen Eintrag mit den beiden Möglichkeiten, die Karte zu bearbeiten oder wieder zu löschen. Karte bearbeiten - Positionen der Kleingruppen definieren Durch Klicken auf Karte bearbeiten gelangen Sie zur Kartendarstellung, bei der Sie für jede Kleingruppe die entsprechende EXT: kool_kgliste - 3
Position auf der Karte definieren können. Dazu wählen Sie zuerst die Kleingruppe in der Liste rechts neben der Karte aus und klicken anschliessend auf die Karte. Nachdem die Seite neu geladen wurde, erscheint an dieser Position ein kleines Kästchen mit der ID der Kleingruppe und die Kleingruppe wird fett dargestellt, damit Sie erkennen, für welche bereits eine Position definiert wurde. Wenn Sie mit der Maus über den Namen einer Kleingruppe fahren, die bereits eine zugewiesene Position hat, wird das entsprechende Kästchen auf der Karte mit einem roten Rahmen markiert. Die Angaben werden sofort gespeichert, Sie müssen also am Schluss nicht noch separat auf Speichern klicken. Um zur Liste der Karten zurück zu gelangen, klicken Sie erneut auf das Modul KG-Karte. Configuration Zugriff auf die kool-datenbank Die Extension kool_kgliste holt die Angaben zu den Kleingruppen mittels SQL-Befehlen direkt aus der kool-datenbank. Dabei wird das folgende Namens-Schema verwendet: Typo3-Datenbank: t3_meineseite kool-datenbank: kool_meineseite Dies ist momentan eine zwingende Voraussetzung (hard coded), kann aber bei Bedarf jederzeit erweitert werden. 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_koolkgliste_pi.layout = table plugin.tx_koolkgliste_pi.templatefile = fileadmin/template/kool_kgliste.tmpl temp.liste = COA temp.liste. = TEXT temp.liste..value = <div>unsere Kleingruppen:</div> temp.liste.2 < plugin.tx_koolkgliste_pi Reference TypoScript: layout string Layout der Ausgabe. Mögliche Werte sind: list, table, single, map list types string Kleingruppen-Typen, die dargestellt werden sollen. Mögliche Werte gemäss den Werten aus der kool-datenbank. Um alle Kleingruppen anzuzeigen, kann hier _all angegeben werden _all filters string Kommagetrennte Liste von anzuwendenen Filtern. Die Filter hat immer folgenden Aufbau: Spalte.Wert. Die Spalte, für die ein Filter angewandt werden soll, wird durch einen Punkt vom Wert getrennt, also z.b. geschlecht.weiblich. Filter der selben Spalte werden mit ODER, ansonsten werden die Filter mit AND verknüpft. templatefile string Template-Datei, die zur Darstellung verwendet werden soll. EXT:kool_kgliste/p i/template.tmpl columns string Eine kommagetrennte Liste der darzustellenden Spalten pro Kleingruppe. Mögliche Werte sind der kool-datenbank zu entnehmen (name, alter, geschlecht, wochentag, ort, zeit, treffen, anz_frei, kg-gen, type, region, comments, picture, url, eventgroupid) singlepid int ID der Seite, die für die Detaildarstellung verwendet werden soll. overlibdefaults imagelinkwrap [tsref:(cobject).tx_koolkgliste_pi] Standart-Werte für die Overlib-Darstellung bei der Kartenansicht. Siehe Manual der overlib-extension. imagelinkwrap Konfiguration für die Darstellung von Klick-vergrössern- Bildern. ol_fgcolor= #eee ol_bgcolor= #555* 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 werden soll. 50 EXT: kool_kgliste - 4
list.imageclickenlarge Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt werden soll. list.limit int Maximale Anzahl Einträge pro Seite 20 list.hidepaging Boolean Definiert, ob die paging-links (vor zurück) ausgeblendet werden sollen, wenn es nur eine Seite gibt. 0 TypoScript für Tabelle table : table.allowsort boolean Gibt an, ob der Webseiten-Benutzer die Tabelle selber sortieren darf oder nicht. 0 table.limit int Definieren Sie die maximale Anzahl Einträge pro Seite 20 table.imagewidth int Bildbreite, die für ein Bild in der Tabelle verwendet werden soll. 50 table.imageclickenlarge Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt werden soll. table.header.useimages boolean Entscheiden Sie, ob für die Spaltenüberschriften Bilder oder Text verwendet werden sollen 0 table.header.images.fie LD table.header.imageshig hlight.field file file Falls table.header.useimages gesetzt ist, können Sie hier die Bilder für die einzelnen Spalten angeben, die für unsortierte Spalten verwendet werden. Falls table.header.useimages gesetzt ist, können Sie hier die Bilder für die einzelnen Spalten angeben, die für die sortierte Spalte verwendet wird. TypoScript für Einzelansicht single : single.imagewidth int Bildbreite, die für ein Bild in der Tabelle verwendet werden soll. 250 single.imageclickenlarg e Boolean Definiert, ob ein Bild in der Tabelle durch Klicken vergrössert dargestellt werden soll. TypoScript für Karte map : map.map int ID der zu verwendenen Karte map.spot file Bilddatei zur Darstellung der Kleingruppen auf der Karte. EXT:kool_kgliste/i mages/spot.gif map.spotoffsetx int Offset in X-Richtung für die Markierung 4 map.spotoffsety int Offset in Y-Richtung für die Markierung 4 map.showdetails boolean Definiert, ob mittels overlib die Details zu einer Kleingruppe dargestellt werden, wenn der Benutzer mit der Maus über das Markierungsbild fährt map.stickydetails boolean Definiert, ob die Detailansicht sticky (also haftend) sein soll oder nicht Template: Marker: Description: ###KG_LIST### ###KG_TABLE### ###KG_TABLE_HEADER### ###KG_TABLE_HEADER_CELL### ###KG_TABLE_CONTENT_ROW_EVE N### ###KG_TABLE_CONTENT_CELL### Layout für die Listenansicht Layout für die Tabellendarstellung. TABLE_HEADER und TABLE_CONTENT werden durch die Überschrift-Zeile resp. den eigentlichen Tabelleninhalt ersetzt. Ganzer Header-Bereich Einzelner Eintrag im Header-Bereich Einzelne Datenzeile innerhalb der Tabelle (EVEN und ODD wechseln sich ab) Layout einer einzelnen Tabellenzelle ###KG_TABLE_CONTENT_CELL_HIGH LIGHT### ###PAGING_PREV### Layout einer einzelnen Tabellenzelle, in einer markierten Spalte. Eine Spalte wird markiert, wenn nach dieser sortiert wird. Link für vorherige Seite ###PAGING_NEXT### ###KG_SINGLE### Link für nächste Seite Bereich, der für die Darstellung der Einzelansicht verwendet wird. Pro dargestellter Spalte gibt es einen Eintrag: <!-- ###COLUMNNAME### --><div class= tx-koolkgliste-pi-singlecolumnname >###COLUMNNAME###</div><!-- ###COLUMNNAME### --> EXT: kool_kgliste - 5
Marker: ###EVENTS### ###EVENTS_DESCRIPTION### ###KG_SINGLE_EVENT### Description: Dieser Marker wird durch die Terminliste einer Kleingruppe ersetzt, falls der Kleingruppe eine Termingruppe mit Terminen zugewiesen ist. Dieser Marker wird durch den Beschreibungs-Text der Termingruppe ersetzt, die der entsprechenden Kleingruppe zugewiesen ist. Einzeldarstellung für die Terminliste in der Einzelansicht CSS: tx-koolkgliste-pi-paging Tutorial Siehe Users manual. Class: Description: Default: Klasse zur Darstellung der Seitenblätterung in der Tabellendarstellung To-Do list SQL-Angaben mittels TS definieren (Server, Datenbank, Authentication) Changelog 0.: Listen-Ansicht, Bilder und URL sauber verarbeiten. Nur noch ein BE-Modul. Hauptmodul kommt von kool_base. EXT: kool_kgliste - 6