Dokumentation Events (Plugin für Shopware)

Link zum Plugin: http://bit.ly/netzperfekt-events

In dieser Dokumentation wird das Plugin  Events, Messen und Veranstaltungen beschrieben. Mit Hilfe dieses Plugins können Sie Ihre Veranstaltungen, Messetermine oder andere Events leicht und schnell im Backend eingeben, pflegen und im Frontend des Shops anzeigen. Wiederkehrende Termine müssen nur einmal eingetragen werden, was eine erhebliche Erleichterung bei der Pflege bedeutet.

Zweck

Das Plugin dient zur Verwaltung und Anzeige von Terminen wie Events, Messen und anderen Veranstaltungen. Sie können so Ihre Shopnutzer darauf aufmerksam machen. Abgelaufene Termine werden nicht mehr angezeigt. Es lassen sich beliebig viele Termine anlegen, im Frontend werden diese übersichtlich dargestellt. Überdies können wiederkehrende Termine angelegt und bestehende Termine kopiert werden.

Neben der Darstellung Ihrer Termine und Events auf einer beliebigen Shopseite kann der nächstfolgende Termin in einer Einkaufswelt, oder - sofern Sie dieses Plugin verwenden - auch in einem Digital Publishing Element dargestellt werden. Dabei wird natürlich das aktuelle Datum berücksichtigt, so dass Sie sich um die Anzeige der korrekten Termine nicht mehr manuell kümmern müssen. 

Installation und Einrichtung

Installieren Sie bitte das Shopware-Plugin wie gewohnt über den Plugin-Manager. (Bitte beachten Sie, dass dieses Plugin das netzperfekt Basis Plugin benötigt.)
(Allgemeine Hinweise dazu finden sich unter http://community.shopware.com/Plugin-Manager-ab-Shopware-5_detail_1856_643.html). Bitte compilieren Sie das Template nach der Installation und Aktivierung des Plugins und laden das Backend neu, damit der Menüpunkt angezeigt wird. 

Im Shopware-Plugin selbst können Sie folgende Einstellungen vornehmen:

Über die Vorauswahl des Zeitraums können Sie bestimmen, welcher Zeitraum beim Aufruf der Event-Seite im Shopware-Frontend standardmässig dargestellt werden soll. Sie können hier zwischen Woche, Monat und Jahr wählen. Der Nutzer kann dies im Frontend jederzeit ändern. Wenn Sie eher wenige Termine oder Veranstaltungen haben, können Sie hier auf Monat oder Jahr umstellen, so dass dem Nutzer möglichst viele Termine auf einen Blick angezeigt werden.

Als Standard werden die Theme Farben auch bei der Darstellung der Events verwendet. Machmal ist allerdings eine Kombination dieser Farben nicht wirklich gut lesbar. Dann können Sie mit Farbe Header, Farbe Hintergrund und Farbe Titel (Hintergrund) eigene Farben setzen. Sind die Felder leer, wird der Standard übernommen.
Wichtig: Bitte kompilieren Sie nach Änderungen in diesen Feldern das Theme neu.

Die Darstellung Eventliste kann als Spalten (Events als Karten auch nebeneinander) oder als Liste erfolgen.

Zusätzliche Filter - verwenden Sie das Events buchen Plugin, können zusätzliche Filter verwendet werden: nach Ort oder auch nach einem beliebigen "Filtername", der im Event jeweils gesetzt wird.

Kategoriemodus - gibt an, wie sich die Filterung nach Kategorien verhält:
- Kategorien abwählbar: Es werden alle zunächst angezeigt, ein Klick schaltet die angeklickte Kategorie dann aus.
- Einzeln selektierbar: Es werden alle zunächst angezeigt, ein Klick schaltet alle anderen aus und nur die ausgewählte ist aktiv.

Zielseite für Suchergebnisse - tragen Sie hier den Pfad zur Eventseite ein.

Einrichten von Kategorien

Bevor Sie Ihre Termine und Veranstaltungen anlegen können, müssen Sie zumindest eine (oder auch mehrere) Kategorien eintragen. Eine Kategorie kann z.B. „Messen“, „Workshops“, „Events“ oder Ähnliches sein.

Bitte wählen Sie im Shopware-Backend den Menüpunkt Inhalte / Events & Veranstaltungen / Event-Kategorien. Sie sehen folgende Maske:

Mit dem Button Hinzufügen legen Sie eine neue Kategorie an, das Feld Bezeichnung muss zwingend ausgefüllt werden. Die Beschreibung ist ebenso optional wie das Icon, das Sie über die Shopware-Medienverwaltung hochladen oder zuweisen können.

Über die Spalte Shopware-Kategorie können Sie Events direkt einer Shopware-Kategorie zuordnen. Die zugehörigen Events werden dann in der Listendarstellung zu Beginn dargestellt. 

Ein Doppelklick auf den gewünschten Eintrag erlaubt die nachträgliche Bearbeitung. 

Anlegen von Events

Termineinträge legen Sie im Backend unter dem Menüpunkt Inhalte / Events & Veranstaltungen an:

Die Liste ist dabei zur besseren Übersicht in einmalige und wiederkehrende Termine (wöchentlich, monatlich, jährlich) gegliedert. 

Bereits abgelaufene Termine können Sie durch die Option Vergangene Termine anzeigen sichtbar machen, um diese etwa kopieren oder löschen zu können.

Einen neuen Termineintrag erzeugen Sie mit dem Button Hinzufügen, einen bestehenden Eintrag können Sie wie von Shopware gewohnt mit dem Bleistift-Symbol am rechten Fensterrand bearbeiten oder mit dem Minus-Button löschen.

Im Detailfenster können Sie alle Informationen zu einem Termineintrag bearbeiten:

Die Bedeutung der Felder ist nachfolgend aufgeführt. Einige Felder müssen zwingend ausgefüllt werden, dies ist dann jeweils vermerkt. Vergessen Sie nicht, zu Speichern!


Bezeichnung: ein prominenter Titel des Events, der Messe oder der Veranstaltung (Pflichtfeld).

Kategorie: die zuvor angelegte Kategorie (Pflichtfeld).

Veranstaltungsort: hier können Sie einen Ort (z.B. einer Messe) eintragen.

Link / Homepage: falls gewünscht, können Sie einen Link zu weiteren Informationen eintragen.

Linktext: ein hier optional eingegebener Text wird auf dem Link-Button ausgegeben.

Preis/Eintritt: hier können Sie Preisinformationen eintragen.

Hervorheben: sofern dieses Feld angekreuzt ist, wird der Eintrag optisch etwas hervorgehoben

Event aktiv: standardmässig sind alle Termineinträge aktiv und werden angezeigt. Falls dies für einzelne Einträge nicht gewünscht ist, können Sie dieses Feld ausschalten.

Filtername (nur mit "Events buchen"): hier kann eine Filtermöglichkeit definiert werden.

Beginn: Hier können Sie den Beginn des Termins (Datum und Uhrzeit) eintragen (Pflichtfeld). 

Ende: Ebenso kann ein Ende festgelegt werden. Bei eintägigen Terminen sollte das Enddatum auf das Beginndatum gesetzt werden, die Uhrzeit ist dann egal. 

Bei wiederkehrenden Terminen hat dieses Feld eine etwas andere Bedeutung. Hier wird dann darüber gesteuert, wie lange der Termin wiederholt werden soll. Wenn Sie also etwa einen 

Workshop wöchentlich wiederholen möchten und diesen erstmals am 1.6.2017 anbieten und letztmalig am 31.12.2017, können Sie dies bei Beginn und Ende eintragen. 

Datum noch offen: Falls der exakte Termin noch nicht genau feststeht, können Sie dieses Feld ankreuzen. Im Frontend wird dann „voraussichtlich am …“ angezeigt.

Wiederholen: Hier haben Sie die Möglichkeit, wiederkehrende Termine anzulegen. Dabei müssen Sie den Termin nur ein einziges Mal eingeben, dieser wird dann je nach gewähltem Intervall automatisch passend im Frontend dargestellt. Sie können hier zwischen einmalig, wöchentlich, monatlich und jährlich auswählen.

Bild: Wenn Sie möchten, können Sie über die Shopware-Medienverwaltung ein Bild für den Termin zuordnen. Das Bild wird dann bei der Detailansicht im Frontend dargestellt.

Kurzbeschreibung: Hier können Sie einen kurzen Anreißertext für den Termin eintragen. Fassen Sie sich möglichst kurz und prägnant!

Beschreibung: Entsprechend kann in diesem Feld eine ausführliche Beschreibung des Termins erfolgen. Diese wird im Frontend bei der Detailansicht der Veranstaltung ausgegeben.


Vergessen Sie nach der Bearbeitung des Termins nicht, Ihre Eingaben zu Speichern!

Anzeigen der Events im Frontend

Legen Sie zunächst eine beliebige Shopseite (Menüpunkt Inhalte / Shopseite) im Backend anAchten Sie darauf, dass diese einen Titel hat und der gewünschten Gruppe zugeordnet ist.

Im Inhalt der Shopseite können Sie einen beliebigen Text voranstellen oder nachstellen.

Die eigentlichen Events werden über einen Shortcode eingefügt:

    {events}{/events}

Bitte achten Sie auf die exakte Schreibweise! Der selbe Shortcode funktioniert auch in Blog-Seiten.

Optional können Sie noch die anzuzeigende Kategorie einschränken, verändern Sie den Shortcode dann wie folgt:

    {events catid=1}{/events}

Die ID (die 1 im obigen Beispiel) finden Sie im Backend in der Liste der Event-Kategorien.

Unter Umständen müssen Sie den Shopware-Cache leeren, danach sollten die Termineinträge in der angelegten Shopseite dargestellt werden. Die Seitenadresse ergibt sich üblicherweise aus dem verwendeten Titel.

Ein Klick auf Infos zeigt die Detailinformationen zum Termin an:

Standardmässig orientiert sich die grafische Darstellung an den Farbeinstellungen des aktiven Shopware-Templates.

Sie können die CSS-Angaben auf Wunsch jedoch mit eigenen Angaben überschreiben. Orientieren Sie sich dazu bitte an der LESS-Datei in engine/Shopware/Plugins/Community/Frontend/NetzpEvents/Views/_public/src/less/less.all. Sie können die Angaben in der LESS-Datei in Ihrem eigenen Shopware-Template überschreiben bzw. anpassen. 

Weitere Informationen zur Erstellung bzw. Anpassung von eigenen Shopware-Templates finden Sie unter https://developers.shopware.com/designers-guide/theme-startup-guide

Denken Sie bei Änderungen bitte daran, das Template neu zu compilieren!

Achtung: Sie sollten die vom Plugin ausgelieferte LESS-Datei nicht direkt ändern, da Ihre Anpassungen sonst bei einem Update des Events-Plugins wieder überschrieben würden!

Anzeigen der Events in Einkaufswelten

Um auf den nächsten Termin (oder auch mehrere kommende Termine) in einer Einkaufswelt hinzuweisen, gehen Sie bitte wie folgt vor:

  • Wählen Sie die gewünschte Einkaufswelt aus (oder legen diese an)
  • Ziehen Sie das Element Events (unter weitere Elemente) an die gewünschte Position im Raster.
  • Klicken Sie auf das Bleistift-Symbol des Event-Elements, um folgende Einstellungen zu bearbeiten:

Über die Kategorie können Sie bestimmen, welche Termine angezeigt werden sollen. Der Titel wird als kurze Überschrift ausgegeben. Anzahl Events steuert, auf wieviele kommende Termine hingewiesen werden soll. Aus Platzgründen können hier maximal 5 Einträge dargestellt werden, aber die maximale Anzahl sollten Sie selbst ausprobieren, da diese ein wenig von der Länge Ihrer Terminbeschreibungen abhängt. 

Über Link zur Eventseite können Sie festlegen, welche Seite bei einem Klick auf das Einkaufswelten-Element aufgerufen werden soll (typischerweise die zuvor angelegte Termin-Übersichtsseite).


Anzeigen der Events in Digital Publishing Elementen

Achtung: Um diese Funktion nutzen zu können, benötigen Sie das Shopware Premium Plugin „Digital Publishing“, das Sie gesondert bei Shopware erwerben können.

Der Hinweis auf den nächsten, kommenden Termin wird hier über bestimmte Platzhalter im regulären Text realisiert. Sie können also ein beliebiges Text-Element auf einer Digital Publishing-Ebene platzieren.

Das nächste Event wird über {nextevent.XXX} angesprochen, wobei insgesamt folgende Platzhalter zur Verfügung stehen:

  • {nextevent.name} - der Titel des Events
  • {nextevent.date} - das Datum inkl. Uhrzeit
  • {nextevent.category} - die Kategorie
  • {nextevent.categoryicon} - das Kategorie-Icon
  • {nextevent.dateDay} - der Tag des Events (numerisch)
  • {nextevent.dateMonth} - Monatsname des Events
  • {nextevent.dateRangeString} - Datum oder Zeitraum (ohne Uhrzeit)
  • {nextevent.timeRangeString} - Uhrzeit (von - bis)
  • {nextevent.place} - Veranstaltungsort
  • {nextevent.url} - eingetragener Link
  • {nextevent.urltext} - der eingegebene Linktext
  • {nextevent.image} - das Bild des Events
  • {nextevent.shortdescription} - die Kurzbeschreibung
  • {nextevent.description} - Langbeschreibung


Die folgende Texteingabe im Feld Text produziert also das im Screenshot abgebildete Ergebnis:

{nextevent.name} am {nextevent.dateDay}. {nextevent.dateMonth} bei {nextevent.place}


Schritt für Schritt Doku

Schauen Sie auch in unsere Schritt-für-Schritt Doku zum Einrichten eines Veranstaltungskalenders.


Wir wünschen Ihnen viel Erfolg 
mit unserem Plugin und 
gute Geschäfte mit Shopware.