Wiki-Quellcode von Gewinnspiel-Portal-Plugin

Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/Gewinnspiel-Portal (fc-portal-contest)&fileid=13794||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 {{info}}
6 {{version major="6" minor="5"}}{{/version}}Für das Gewinnspiel-Portal-Plugin wird mindestend {{formcycle/}} in der Version 6.5.0 benötigt
7 {{/info}}
8
9 {{figure image="beispiel_de.jpg" clear="h2"}}
10 Beispiel für ein mit dem Plugin erstelltes Gewinnspiel-Portal.
11 {{/figure}}
12
13 Das kostenpflichtige Gewinnspiel-Portal bietet die Möglichkeit, Portale für eine beliebige Anzahl an Gewinnspielen innerhalb von {{formcycle/}} zu erstellen und verwalten. Diese Gewinnspiele nutzen für die Dateneingabe der Teilnehmer {{formcycle/}} Formulare. Das Gewinnspiel-Portal kann auf allen Mandanten auf dem {{fcserver/}} genutzt werden, wobei auf jedem Mandanten ein eigenes Gewinnspiel-Portal eingerichtet werden kann.
14
15 == Installation ==
16
17 Das Gewinnspiel-Portal kann nur als [[Systemplugin>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] installiert werden und ist daher automatisch für alle Mandanten auf dem {{formcycle/}} Server nutzbar. Das Gewinnspiel-Portal besteht aus zwei separaten Plugins, //contest-view-portal.jar// und //contest-management-portal.jar//, welche zwingend zusammen installiert werden müssen. Es ist dabei egal, in welcher Reihenfolge die beiden Plugins installiert werden.
18
19 == Rollenrechte ==
20
21 {{figure image="rollenrechte_de.png" clear="h2"}}
22 Nach der Installation des Plugins zusätzlich konfigurierbare [[Rollenrechte>>doc:Formcycle.UserInterface.UserSettings.Roles]] in der Benuterverwaltung.
23 {{/figure}}
24
25 Die Menüeinträge des Gewinnspielportals sind auf der {{formcycle/}} Oberfläche standardmäßig nicht sichtbar. Es müssen daher bei den entsprechenden Nutzergruppen unter [[Rollen>>doc:Formcycle.UserInterface.UserSettings.Roles]] die Rechte für das Konfigurieren und für das Öffnen des Gewinnspielportals gesetzt werden. Diese Rechte sind wie folgt untergliedert:
26
27 === Gewinnspiel-Portal verwalten ===
28
29 Unter diesem Hauptpunkt können alle für die Administration des Gewinnspiel-Portals nötigen Rechte vergeben werden.
30
31 ==== Gewinnspiele verwalten ====
32
33 ; Gewinnspiel anlegen (leer)
34 : Berechtigung ein neues Gewinnspiel anzulegen, welches nicht auf einer Vorlage beruht
35
36 ; Gewinnspiel importieren
37 : Berechtigung ein exportiertes Gewinnspiel importieren zu dürfen
38
39 ; Gewinnspiel aus Vorlage anlegen
40 : Berechtigung ein neues Gewinnspiel anzulegen, welches auf einer Vorlage aufbaut
41
42 ; Gewinnspiel kopieren
43 : Berechtigung ein vorhandenes Gewinnspiel kopieren zu dürfen
44
45 ; Gewinnspiel exportieren
46 : Berechtigung ein vorhandenes Gewinnspiel exportieren zu dürfen
47
48 ; Gewinnspiel löschen
49 : Berechtigung ein vorhandenes Gewinnspiel löschen zu dürfen
50
51 ; Gewinnspiel-Formular bearbeiten
52 : Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
53
54 ; Gewinner ermitteln {{version major="1" minor="4"}}{{/version}}
55 : Berechtigung um nach Ablauf des Gewinnspiels Gewinner zu ermitteln, diese ggf. inkl Verarbeitung in einen anderen Status zu verschieben und anschließend per Excel zu explorieten.
56
57 ; Teilnehmer exportieren {{version major="1" minor="5"}}{{/version}}
58 : Berechtigung zum Exportieren der aktuellen Liste der Gewinnspiel-Teilnahmer
59
60 ; Ersatzgewinner ermitteln {{version major="1" minor="4"}}{{/version}}
61 : Ermöglicht es wiederholt Ersatzgewinner zu ermitteln.
62
63 ==== Vorlagen verwalten ====
64
65 Notwendige Berechtigung, um neue Gewinnspielvorlagen erstellen und vorhandene Gewinnspielvorlagen bearbeiten und löschen zu dürfen. Nur wenn dieses Recht aktiv ist, kann der Nutzer ein vorhandenes Gewinnspiel als Vorlage speichern.
66
67 ==== Konfigurieren ====
68
69 Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen
70
71 === Gewinnspiel-Portal öffnen ===
72
73 Berechtigung, das Gewinnspiel-Portal aus {{formcycle/}} heraus direkt öffnen zu dürfen
74
75 == Menüpunkte auf der Verwaltungsoberfläche ==
76
77 {{figure image="portal_menue_elemente_de.png" clear="h2" width="150"}}
78 Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.
79 {{/figure}}
80
81
82 {{html wiki="true"}}
83 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='Zusätzliche Menüpunkte auf der Verwaltungsoberfläche.'><div class='xm-figure-inner' style='width:160px'>{{lightbox image='portal_menue_elemente_de.png' width='150' group='$height' group='$group' title='Zusätzliche Menüpunkte auf der Verwaltungsoberfläche.'/}}<div class='xm-figure-caption'>Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.</div></div></div>
84 {{/html}}
85
86
87 Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
88
89
90 === Gewinnspiele ===
91
92 Nachdem das Gewinnspiel-Portal installiert wurde und der entsprechende Nutzer die Berechtigungen erhalten hat, befinden sich auf der {{formcycle/}} Verwaltungsoberfläche ein neuer Menüpunkt //Gewinnspiele// mit den folgenden drei Unterpunkten:
93
94 ; Gewinnspiele verwalten
95 : Unter diesem Punkt können Gewinnspiele angelegt und die Einstellungen von vorhandenen Gewinnspielen eingesehen und angepasst werden. Siehe [[Gewinnspiele verwalten>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_gewinnspiele"]].
96
97 ; Vorlagen verwalten
98 : Unter diesem Punkt können neue Vorlagen für Gewinnspiele angelegt und vorhandene Vorlagen eingesehen und angepasst werden. Siehe [[Vorlagen verwalten>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_vorlagen"]].
99
100 ; Konfiguration
101 : Unter diesem Punkt können Stuktur, Aussehen und Verhalten des Gewinnspiel-Portals konfiguriert werden. Siehe [[Portal konfigurieren>>doc:Formcycle.PluginDocumentation.ContestPortalPlugin.WebHome||anchor="backend_portal"]].
102
103 === Gewinnspiel öffnen ===
104
105 Wenn für den Benutzer in den Rollenrechten die Berechtigung zum Öffnen des Gewinnspiel-Portals gegeben wurde, erscheint im Hauptmenü auf der {{formcycle/}} Verwaltungsoberfläche eine zusätzliche Schaltfläche //Gewinnspiel öffnen//.
106
107 == Grundstruktur des Gewinnspiel-Portals ==
108
109 Mit dem Gewinnspiel-Portal kann aus mehreren vorgegebenen Elementen eine Portal-Webseite konfiguriert werden, in welcher die für ein Gewinnspiel-Portal benötigten Elemente enthalten sind. Die Webseite untergliedert sich in die folgenden Elemente:
110
111 ; (1) Kopfbereich, (7) Fußbereich und (4) Trenner vom Portal
112 : Diese Elemente werden einmal konfiguriert und werden für alle Gewinnspiele im Gewinnspiel-Portal genutzt.
113
114 ; (2) Bannergrafik, (3) Inhalt (Formular, Beschreibung, ggf. Ankündigungen oder Mitteilungen über den Beginn oder das Ende des Gewinnspiels), (5) Teilnahmebedingungen und (6) Datenschutz
115 : Diese Elemente können für jedes Gewinnspiel individuell konfiguriert werden.
116
117 {{lightbox image="portal_aufbau_de.jpg" group="g0" width="800"/}}
118
119 == Verwaltungsoberfläche im FORMCYCLE Backend ==
120
121 {{id name="backend_gewinnspiele"/}}
122
123 === Gewinnspiele verwalten ===
124
125 {{figure image="gewinnspiele_ui_de.png" clear="h2"}}
126 Verwaltungsoberfläche für den Menüpunkt //Gewinnspiele verwalten//
127 {{/figure}}
128
129 Unter diesem Menüpunkt können die vorhandenen Gewinnspiele verwaltet und neue Gewinnspiele angelegt werden.
130
131 ==== Menü ====
132
133 Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden {{ficon name="plus-circle-outline"/}} oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}}, exportiert {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}}, als Vorlage gespeichert {{icon name="fa-save" title="Als Vorlage speichern" size="1x" cssClass="fa-save"/}} oder gelöscht {{ficon name="trash-alt2"/}} werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinnspiel-Liste automatisch gefiltert wird. Beim Anlegen eines neuen Gewinnspiels kan entweder ein neues leeres Gewinnspiel angelegt, ein zuvor exportiertes Gewinnspiel wieder geladen oder eine Vorlage als Grundlage für das Gewinnspiel verwendet werden.
134
135 Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
136
137 ; {{ficon name="checkbox-marked-circle"/}}
138 : Ein ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist und sich aktuell innerhalb des konfigurierten Online-Zeitraumes befindet
139 ; {{ficon name="checkbox-marked-circle-outline"/}}
140 : Ein nicht ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist, sich aber aktuell nicht innerhalb des konfigurierten Online-Zeitraumes befindet. Das heißt dass das Gewinnspiel entweder nicht mehr oder noch nicht online ist.
141 ; {{ficon name="circle-outline"/}}
142 : Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
143
144 ==== Einstellungen ====
145
146 {{figure image="gs_onlineeinstellungen_de.png" clear="h2"}}
147 Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes
148 {{/figure}}
149
150
151 {{html wiki="true"}}
152 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='gs_onlineeinstellungen_de.png' width='300' group='$height' group='$group' title='Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes'/}}<div class='xm-figure-caption'>Mögliche Optionen zum Konfigurieren der (datumsabhängigen) Sichtbarkeit des Gewinnspiels und der Positionierung des Beschreibungstextes</div></div></div>
153 {{/html}}
154
155
156 Nachdem auf die //Neues Gewinnspiel//-Schaltfläche geklickt oder ein Gewinnspiel in der Liste ausgewählt wurde, erscheint rechts die Konfigurationsseite für das Gewinnspiel. Hier können im oberen Bereich links konfiguriert werden, wann und wie das Gewinnspiel sichtbar sein soll. Die foldenden Optionen können konfiguriert werden:
157
158
159 ; **Aktiviert (Das Gewinnspiel ist aufrufbar)**
160 : Das Gewinnspiel kann über einen Link aufgerufen werden
161
162 ; **Gewinnspiel im Portal anzeigen**
163 : Das Gewinnspiel wird im Portal angezeigt; Nur anwählbar, wenn die Option //**Aktiviert** (Das Gewinnspiel ist aufrufbar)// zuvor angewählt wurde; Anderenfalls ist diese Option ausgegraut und das Gewinnspiel wird nicht im Portal angezeigt
164
165 ; **Name des Gewinnspiels:**
166 : Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.
167
168 ; **UUID des Gewinnspiels:**
169 : Gibt die eindeutige UUID des Gewinnspiels aus um dieses identifizieren zu können.
170
171 ; **Online von:**
172 : Zeitpunkt, ab dem das Gewinnspiel online geschaltet wird. Falls die Option //**Aktiviert** (Das Gewinnspiel ist aufrufbar)// angewählt wurde, wird vor dem an dieser Stelle konfigurierten Zeitpunkt beim Öffnen des Gewinnspiels nur die //Ankündigung// des Gewinnspiels angezeigt. Sofern //Gewinnspiel im Portal anzeigen// angewählt wurde, wird das Gewinnspiel auch vor dem hier konfigurierten Zeitpunkt bereits im Gewinnspiel-Portal angezeigt. Auch in diesem Fall wird beim Öffnen des Gewinnspiels die //Ankündigung// gezeigt.
173
174 ; **Online bis:**
175 : Zeitpunkt, ab dem das Gewinnspiel offline geschaltet wird. Falls die Option //**Aktiviert** (Das Gewinnspiel ist aufrufbar)// angewählt wurde, wird ab dem an dieser Stelle konfigurierten Zeitpunkt beim Öffnen des Gewinnspiels nur die //Abgelaufen//-Mitteilung des Gewinnspiels angezeigt. Sofern //Gewinnspiel im Portal anzeigen// angewählt wurde, wird das Gewinnspiel auch vor dem hier konfigurierten Zeitpunkt bereits im Gewinnspiel-Portal angezeigt. Auch in diesem Fall wird beim Öffnen des Gewinnspiels die //Ankündigung// gezeigt.
176
177 ; **Layout:**
178 : An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte //Beschreibungstext// angezeigt werden soll. Zur Auswahl stehen:
179 :; **Formular links**
180 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
181 :; **Formular rechts**
182 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
183 :; **Formular oben**
184 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
185 :; **Formular unten**
186 :: Der //Beschreibungstext// wird über dem Formular angezeigt
187 :; **ohne Beschreibung**
188 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
189
190 {{figure image="gs_microsite_de.png" clear="h2"}}
191 Mögliche Optionen zum Öffnen des Gewinnspiels bzw. zum Generieren von Code zum Einbetten des Gewinnspiels im Punkt //Microsite//
192 {{/figure}}
193
194 ; **Microsite**
195 : An dieser Stelle werden drei Schaltflächen angezeigt, mit denen das ausgewählte Gewinnspiel geöffnet oder ein Link zum Gewinnspiel ermittelt werden kann. Die Buttons haben dabei die folgenden Funktionen:
196 :; **Öffnen**
197 :: Öffnet das Gewinnspiel so, wie es aktuell sichtbar ist. Dabei werden alle durch das Gewinnspiel konfigurieten Inhalte angezeigt. Die durch das Gewinnspiel-Portal bereitgestellten Inhalte wie Kopfbereich, Furßbereich, usw. werden nicht mit dargestellt.
198 :; **Vorschau**
199 :: Selbe Funktion wie die //Öffnen//-Schaltfläche, allerdings wird das Formular im Vorschaumodus geöffnet. Beim Absenden des Formulars wird inneralb des zuvor vom Formualar verwendeten Bildschirmbereichs die Zusammenfassung über die an den Server übertragenen Daten angezeigt, welche auch bei einem normalen {{formcycle/}}-Formular nach dem Absenden aus der Vorschau angezeigt. Am rechten Rand der Schaltfläche kann durch den Klick auf den nach unten gerichteten Pfeil ein Menü geöffnet werden, welches zwei weitere Vorschau-Optionen enthält. Diese sind:
200 :; **Vorschau als angekündigt**
201 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
202 :; **Vorschau als abgelaufen**
203 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
204 :; **Bereitstellen**
205 :: Öffnet einen Dialog, in dem die URL zum Öffnen des Gewinnspiels ermittelt werden kann. Hierbei können die folgenden Optionen konfiguriert werden, welche das Aussehen des Gewinnspiels beeinflussen:
206 ::; **Kopfbereich des Gewinnspiels ausblenden (Bilder)**
207 ::: Wenn diese Option gewählt wird, wird die Bannergrafik nicht angezeigt.
208 ::; **Beschreibung des Gewinnspiels ausblenden**
209 ::: Wenn diese Option gewählt wird, wird die Beschreibung des Gewinnspiels nicht angezeigt, unabhängig davon, was unter //Layout// konfiguriert wurde.
210 ::; **Fußbereich des Gewinnspiels ausblenden (Datenschutz & Teilnahmebedingungen)**
211 ::: Wenn diese Option gewählt wird, werden die für das Gewinnspiel konfigurierten Inhalte für //Datenschutz// und //Teilnahmebedingungen// nicht angezeigt.
212 ::; **Zu verwendender Server**
213 ::: Auswahl, über welchen Server das Gewinnspiel geöffnet werden soll. Zur Auswahl stehen Master- und eventuell vorhande Frontend-Server.
214 :: Darunter wird die sich aufgrund der selektierten Optionen ergebende URL angezeigt. Durch einen Klick auf die //Quellcode kopieren//-Schaltfläche rechts kann diese in die Zwischenablage kopiert werden.
215 :: Alternativ kann durch einen Klick auf den nach unten gerichteten Pfeil am rechten Rand der Schaltfläche ein Menü geöffnet werden, welches drei weitere Optionen enthält. Diese öffnen jeweils einen Dialog, dessen Konfigurationsmöglichkeiten den bereits beschriebenen entsprecht. Anstelle einer URL werden allerdings in eine Webseite einzufügende Inhalte zum Einbinden des Gewinnspiels angezeigt. Die drei Optionen sind:
216 :; **Bereitstellen als HTML Link**
217 :: Generiert Quellcode, mit dem das Gewinnspiel direkt als HTML-Code in eine Webseite eingebunden werden kann.
218 :; **Bereitstellen als Inlineframe**
219 :: Generiert Quellcode, mit dem das Gewinnspiel als Inlineframe in eine Webseite eingebunden werden kann.
220 :; **Bereitstellen als Ajax/JavaScript**
221 :: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
222
223 {{figure image="gs_inhalt_de.png" clear="h2"}}
224 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
225 {{/figure}}
226
227 ; **Inhalt**
228 : An dieser Stelle wird der eigentliche Inhalt des Gewinnspiels konfiguriert. Die einzelnen Inhaltselemente des Gewinnspiels können über die oben befindlichen Schaltflächen ausgewählt werden. Danach kann in dem darunter befindlichen WYSIWYG-Editor der jeweilige Inhalt eingefügt werden. Bei den HTML-Inhalten kann durch einen Klick auf //Quellcode// jeweils in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden. Falls das Gewinnspiel nicht im Portal geöffnet werden soll, aber zusätzlicher JavaScript- und CSS-Code dafür benötigt wird, kann dieser unter //JavaScript (Microsite)// bzw. unter //CSS (Microsite)// definiert werden.
229 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
230 :; **Beschreibung**
231 :: Beschreibungstext zum Gewinnspiel. Wird neben bzw. über oder unter dem Formular angezeigt.
232 :; **Teilnahmebedingungen**
233 :: Teilnahmebedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
234 :; **Datenschutz**
235 :: Datenschutzbedingungen des Gewinnspiels. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
236 :; **Ankündigung**
237 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
238 :; **Abgelaufen**
239 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
240 :; **CSS (Microsite)**
241 :: Zusätzlicher CSS-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
242 :; **JavaScript (Microsite)**
243 :: Zusätzlicher JavaScript-Code, welcher nur für dieses Gewinnspiel verwendet werden soll.
244 :; **HTML header (Microsite)**
245 :: Zusätzlicher HTML-Code, welcher nur im Headerbereich dieses Gewinnspiels verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
246
247 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
248 Vorhandene Schaltflächen unter //Bannergrafiken//.
249 {{/figure}}
250
251 ; Bannergrafiken
252 : Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels und auf der Microsite angezeigten Bannergrafiken konfiguriert werden. Für unterschiedliche Geräteklassen bzw. Bildschirmauflösungen können dabei verschiedene Grafiken genutzt werden. Zur Auswahl stehen die folgenden Größen:
253 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
254 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
255 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
256 : Wenn eine Bannergrafik für eine Geräteklasse nicht explizit konfiguriert wird, wird bei der Anzeige die Grafik des nächstgrößeren Formats verwendet. Dementsprechend sollte die Grafik für //Desktop// immer konfiguriert werden, während //Tablet// und //Mobile// optional sind. Unterstützt werden alle im Browser zulässigen Bildformate.
257
258 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
259 :; **Desktop**, **Tablet** und **Mobile**
260 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
261 :; **+ Bannergrafik ändern**
262 :: Öffnet einen Dateiauswahldialog zum selektieren einer lokal gespeicherten Grafik. Nach dem Bestätigen der Auswahl wird die Datei hochgeladen. Falls bereits zuvor eine Grafik vorhanden war, wird dieser ersetzt.
263 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
264 :: Löschen der Grafik
265
266 ==== Fußzeile ====
267
268 Hier befinden sich die folgenden zwei Schaltflächen:
269
270 ; **Formular bearbeiten**
271 : Öffnet den Formulardesigner für den Formularteil des Gewinnspiels. Da es sich um ein normales {{formcycle/}}-Formular handelt, erfolgt die Erstellung und Konfiguration des Formulars analog. Vom Designer aus kann dementsprechend auch die Statusverarbeitung des Formulars konfiguriert werden.
272
273 ; **Gewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
274 : Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist. Ferner ist er auch nicht mehr verfügbar sobald eine Gewinnerziehung durchgeführt wurde. Er öffnet den Dialog zu Konfiguration und zum Starten der Gewinnerziehung.
275
276 ; **Ersatzgewinner ermitteln** {{version major="1" minor="4"}}{{/version}}
277 : Diese Schaltfläche ist bei entsprechender Berechtigung erst verfügbar sobald das Gewinnspiel offline geschalten wurde oder der Teilnahme-Zeitraum abgelaufen ist sowie bereits eine Gewinnerziehung stattgefunden hat. Er öffnet den Dialog zu Konfiguration und zum Starten der Nachziehung von Gewinnern.
278
279 ; **Teilnehmer exportieren** {{version major="1" minor="5"}}{{/version}}
280 : Diese Schaltfläche ist bei entsprechender Berechtigung nur verfügbar wenn zum ausgewählten Gewinnspiel eine Projekt-spezifische Postfach-Ansicht definiert wurde. Beim Betätigen dieser Schaltfläche wird ein EXCEL-Export angesoßen welcher die dort definierten Formular-Felder inkl. aller Metadaten-Felder exportiert. Je nach Anzahl der Teilnehmer kann dieser Export mehrere Sekunden lang dauern.
281
282 ; **Speichern**
283 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
284 \\\\{{id name="backend_vorlagen"/}}
285
286 === Gewinner ermitteln {{version major="1" minor="4"}}{{/version}} ===
287
288 Sobald der Teilnahmezeitraum abgelaufen ist oder ein Gewinnspiel deaktiviert wurde ist es mit den entsprechenden Berechtigungen möglich Gewinner zu ermitteln.
289
290 {{figure image="dialog_1_de.png" clear="h2"}}
291 Dialog zu Konfiguration der Gewinnerziehung.
292 {{/figure}}
293
294 ==== Konfiguration ====
295
296 Startet man über die entsprechenden Schaltflächen die Ermittlung der Gewinner eines Gewinnspiels, so öffnet sich hierbei ein Konfigurationdialog. In diesem wird angegeben aus welchem Status die Teilnehmer-Datensätze herangezogen werden, sowie die Anzahl der eigentlichen Gewinner in ihren Ausprägungen. Hierbei wird unterschieden zwischen Hauptgewinnern, Nebengewinnern und zusätzlichen Ersatzgewinnern. Die Datensätze die für die jeweilige Ausprägung gezogen weden, werden anschließen je nach Auswahl mit oder ohne ausgeführter Statusverarbeitgung in den zugehörigen Zielstatus überführt.
297
298 {{figure image="dialog_2_de.png" clear="h2"}}
299 Anzeige der ermittelten Gewinner
300 {{/figure}}
301
302 ==== Asuwertung ====
303
304 Nach der Ziehung wird eine Übersicht mit den ermittelten Gewinnern angezeigt. Hierbei werden je nach Verfügbarkeit Spalten der Projekt-spezifischen Postfach-Ansicht oder der Betreff inkl. von Standard-Spalten angezeigt. Ferner sind die Spalten über die zugehörige Auswahl anpassbar. Über die Schlatfläche "Export" steht zusätzlich diese Tabelle mit allen vorhandenen Spalten als Excel-Datei zur Verfügung. Ferner kann über "Export" > "... mit kompletten Datensätzen" das Excel auch um alle im Formular vorhandenen Eingabedaten erweitert werden.
305
306
307 ==== Gewinner nachziehen ====
308
309 Nach einer initial durchgeführen Gewinnerziehung steht diese Option nicht mehr zur Verfügung. Ferner gibt es mit der entsprechenden Berechtigung die Möglichkeit weitere Ersatzgewinner zu ermitteln. Hierbei kommt der selbe Dialog zum Einsatz, jedoch ist nur die Konfiguration der Ersatzgewinner verfügbar.
310
311
312 === Vorlagen verwalten ===
313
314 {{figure image="vorlagen_ui_de.png" clear="h2"}}
315 Verwaltungsoberfläche für den Menüpunkt //Vorlagen verwalten//.
316 {{/figure}}
317
318 Unter diesem Menüpunkt können die vorhandenen Vorlagen für Gewinnspiele verwaltet und neue Vorlagen angelegt werden. An der Oberfläche kann eine Teilmenge der bei //Gewinnspiele verwalten// vorhandenen Optionen konfiguriert werden.
319
320 ==== Menü ====
321
322 Auf der linken Seite befindet sich die Liste aller vorhandenen Vorlagen. Über die Schaltfläche {{ficon name="plus-circle-outline"/}} über der Liste kann eine neue Vorlage angelegt werden, indem ein zuvor exportiertes Gewinnspiel oder eine zuvor exportierte Vorlage wieder importiert wird. Eine vorhandene Vorlage kann mit der sich daneben befindenden Schaltfläche {{icon name="fa-files-o" title="Kopieren" size="1x" cssClass="fa-files-o"/}} kopiert, mit {{icon name="fa-download" title="Exportieren" size="1x" cssClass="fa-download"/}} exportiert und mit {{ficon name="trash-alt2"/}} gelöscht werden. Über die Suchen-Schaltfläche {{icon name="fa-search" title="Suchen" size="1x" cssClass="fa-search"/}} kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Vorlagen-Liste automatisch gefiltert wird.
323
324 ==== Einstellungen ====
325
326 Nachdem eine Vorlage angelegt bzw. in der Liste ausgewählt wurde, erscheint rechts die Konfigurationsseite für diese. Die foldenden Optionen können konfiguriert werden:
327
328 ; **Name der Vorlage:**
329 : Innerhalb von {{formcycle/}} angezeigter Name der Vorlage.
330
331 ; **Layout:**
332 : An dieser Stelle kann über 5 Buttons konfiguriert werden, ob und wenn ja an welcher Stelle der konfigurierte //Beschreibungstext// angezeigt werden soll. Zur Auswahl stehen:
333 :; **Formular links**
334 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
335 :; **Formular rechts**
336 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
337 :; **Formular oben**
338 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
339 :; **Formular unten**
340 :: Der //Beschreibungstext// wird über dem Formular angezeigt
341 :; **ohne Beschreibung**
342 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
343
344 ; **Microsite**
345 : An dieser Stelle wird nur eine Schaltflächen angezeigt, mit der die ausgewählte Vorlage wie ein normales Gewinnspiel im Vorschaumodus geöffnet werden kann. Der Button hat dabei die folgenden Funktionen:
346 :; **Vorschau**
347 :: Die Gewinnspiel-Vorlage bzw. das Formular wird im Vorschaumodus geöffnet. Beim Absenden des Formulars wird inneralb des zuvor vom Formualar verwendeten Bildschirmbereichs die Zusammenfassung über die an den Server übertragenen Daten angezeigt, welche auch bei einem normalen {{formcycle/}}-Formular nach dem Absenden aus der Vorschau angezeigt. Am rechten Rand der Schaltfläche kann durch den Klick auf den nach unten gerichteten Pfeil ein Menü geöffnet werden, welches zwei weitere Vorschau-Optionen enthält. Diese sind:
348 :; **Vorschau als angekündigt**
349 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
350 :; **Vorschau als abgelaufen**
351 :: Öffnet die Gewinnspiel-Vorlage so, wie das Gewinnspiel sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
352
353 {{figure image="gs_inhalt_de.png" clear="h2"}}
354 Quellcode-Ansicht eines Editors im Reiter //Teilnahmebedingungen// von //Inhalt//.
355 {{/figure}}
356
357 ; **Inhalt**
358 : An dieser Stelle wird der eigentliche Inhalt der Gewinnspiel-Vorlage konfiguriert. Die vorhandenen Optionen entsprechen exakt dem, was im Menüpunkt //Gewinnspiele verwalten// konfiguriert werden kann. Die einzelnen Inhaltselemente der Gewinnspiel-Vorlage können über die oben befindlichen Schaltflächen ausgewählt werden. Danach kann in dem darunter befindlichen WYSIWYG-Editor der jeweilige Inhalt eingefügt werden. Bei den HTML-Inhalten kann durch einen Klick auf //Quellcode// jeweils in die Quellcodeansicht gewechselt werden. Hierdurch können zum Beispiel für bestimmte Inhalte auch eigene IDs oder CSS-Klassen genutzt werden. Falls das in der Gewinnspiel-Vorlage konfigurierte Gewinnspiel später nicht im Portal geöffnet werden soll, aber zusätzlicher JavaScript- und CSS-Code dafür benötigt wird, kann dieser unter //JavaScript (Microsite)// bzw. unter //CSS (Microsite)// definiert werden.
359 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
360 :; **Beschreibung**
361 :: Beschreibungstext der Gewinnspiel-Vorlage. Wird neben bzw. über oder unter dem Formular angezeigt.
362 :; **Teilnahmebedingungen**
363 :: Teilnahmebedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben dem //Datenschutz// angezeigt.
364 :; **Datenschutz**
365 :: Datenschutzbedingungen der Gewinnspiel-Vorlage. Wird im Portal unterhalb des Trenners neben den //Teilnahmebedingungen// angezeigt.
366 :; **Ankündigung**
367 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, wenn das Gewinnspiel noch nicht gestartet ist.
368 :; **Abgelaufen**
369 :: Inhalt, welcher anstelle vom Formular und dem Beschreibungstext angezeigt wird, nachdem das Gewinnspiel beendet wurde.
370 :; **CSS (Microsite)**
371 :: Zusätzlicher CSS-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
372 :; **JavaScript (Microsite)**
373 :: Zusätzlicher JavaScript-Code, welcher nur für diese Gewinnspiel-Vorlage verwendet werden soll.
374 :; **HTML header (Microsite)**
375 :: Zusätzlicher HTML-Code, welcher nur im Headerbereich dieses Gewinnspiels verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
376
377 {{figure image="gs_bannergrafiken_de.png" clear="h2"}}
378 Vorhandene Schaltflächen unter //Bannergrafiken//.
379 {{/figure}}
380
381 ; Bannergrafiken
382 : Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels und auf der Microsite angezeigten Bannergrafiken für diese Gewinnspiel-Vorlage konfiguriert werden. Für unterschiedliche Geräteklassen bzw. Bildschirmauflösungen können dabei verschiedene Grafiken genutzt werden. Zur Auswahl stehen die folgenden Größen:
383 :: **Desktop** - ab 1026 px Bildschirmbreite; Muss konfiguriert werden
384 :: **Tablet** - zwischen 642 px und 1025 px Bildschirmbreite
385 :: **Mobile** - bei 641 px oder weniger Bildschirmbreite
386 : Wenn eine Bannergrafik für eine Geräteklasse nicht explizit konfiguriert wird, wird bei der Anzeige die Grafik des nächstgrößeren Formats verwendet. Dementsprechend sollte die Grafik für //Desktop// immer konfiguriert werden, während //Tablet// und //Mobile// optional sind. Unterstützt werden alle im Browser zulässigen Bildformate.
387
388 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
389 :; **Desktop**, **Tablet** und **Mobile**
390 :: Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
391 :; **+ Bannergrafik ändern**
392 :: Öffnet einen Dateiauswahldialog zum selektieren einer lokal gespeicherten Grafik. Nach dem Bestätigen der Auswahl wird die Datei hochgeladen. Falls bereits zuvor eine Grafik vorhanden war, wird dieser ersetzt.
393 :; {{ficon name="trash-alt2"/}}-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik
394 :: Löschen der Grafik
395
396 ==== Fußzeile ====
397
398 Hier befinden sich die folgenden zwei Schaltflächen:
399
400 ; **Formular bearbeiten**
401 : Öffnet den Formulardesigner für den Formularteil der Gewinnspiel-Vorlage. Da es sich um ein normales {{formcycle/}}-Formular handelt, erfolgt die Erstellung und Konfiguration des Formulars analog. Vom Designer aus kann dementsprechend auch die Statusverarbeitung des Formulars konfiguriert werden.
402
403 ; **Speichern**
404 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen.
405 \\\\{{id name="backend_portal"/}}
406
407 === Konfiguration ===
408
409 {{figure image="portal_ui_de.png" clear="h2"}}
410 Verwaltungsoberfläche für den Menüpunkt //Portal konfigurieren//.
411 {{/figure}}
412
413 In diesem Menüpunkt kann das Aussehen des Gewinnspiel-Portals angepasst werden. Die folgenden Reiter stehen für die Konfiguration des Portals zur Verfügung:
414
415 ; Kopfbereich
416 : Über dem Formular angezeigter Inhalt.
417
418 ; Trenner
419 : Bereich, welcher zwischen Formular/Beschreibung und den Teilnahmebedingungen/Datenschutz angezeigt wird.
420
421 ; Fußbereich
422 : Unter Teilnahmebedingungen/Datenschutz angezeigter Inhalt.
423
424 ; Abgelaufen-Overlay
425 : Hier kann eine Grafik definiert werden welche über der Bannergrafik bei einem abgelaufenen Gewinnspiel angezeigt wird.
426
427 ; CSS (Portal)
428 : Innerhalb des Gewinnspiel-Portals zu verwendender CSS-Code.
429
430 ; JavaScript (Portal)
431 : Innerhalb des Gewinnspiel-Portals zu verwendender JavaScript-Code.
432
433 ; HTML header (Portal)
434 : Zusätzlicher HTML-Code, welcher im Headerbereich des Gewinnspiel-Portals verwendet werden soll. Dies können zum Beispiel Metadaten oder Verweise auf andere CSS- oder JavaScript-Dateien sein.
435
436 == Speicherort der Inhalte des Gewinnspiel-Portals ==
437
438 Die unter //Konfiguration// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].
439
440 **Es handelt sich um die folgenden Dateien:**
441
442 |=Dateiname|=Inhalt
443 |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
444 |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
445 |contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite
446 |contest-portal.js.txt|JavaScript der Gewinnspiel-Portalseite
447 |contest-portal.meta.html|HTML header der Gewinnspiel-Portalseite
448 |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
449 |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
450 |expired-overlay.png|Overlay-Grafik welche über dem Gewinnspielbanner angezeigt wird sobald dieses abgelaufen ist
451
452 == JavaScript-Schnittstellen ==
453
454 === Allgemein ===
455
456 Allgemein stehen den Gewinnspielen sowohl in Kontext der Microsite als auch innerhalb des Portals folgende Funktionen zur Verfügung:
457
458 ==== Scrollen zum Seitenanfang: ====
459
460 {{code language="none"}}
461 // Innerhalb des Kontextes
462 Contest.scrollToTop();
463
464 // Innerhalb des Formulares
465 // - falls dies in der selben Domaine betrieben wird
466 window.parent.Contest.scrollToTop();
467
468 // - falls dies nicht in der selben Domaine betrieben wird
469 window.parent.postMessage('scrollToTop', '*');
470
471 // Allgemein ansprechbar über postMessage:
472 <window>.postMessage('scrollToTop', '*');
473 {{/code}}
474
475 ==== Scrollen zu den Teilnahmebedingungen: ====
476
477 {{code language="none"}}
478 // Innerhalb des Kontextes
479 Contest.scrollToTerms();
480
481 // Innerhalb des Formulares
482 // - falls dies in der selben Domaine betrieben wird
483 window.parent.Contest.scrollToTerms();
484
485 // - falls dies nicht in der selben Domaine betrieben wird
486 window.parent.postMessage('scrollToTerms', '*');
487
488 // Allgemein ansprechbar über postMessage:
489 <window>.postMessage('scrollToTerms', '*');
490 {{/code}}
491
492 ==== Scrollen zur Datenschutz-Erklärung: ====
493
494 {{code language="none"}}
495 // Innerhalb des Kontextes
496 Contest.scrollToPrivacy();
497
498 // Innerhalb des Formulares
499 // - falls dies in der selben Domaine betrieben wird
500 window.parent.Contest.scrollToPrivacy();
501
502 // - falls dies nicht in der selben Domaine betrieben wird
503 window.parent.postMessage('scrollToPrivacy', '*');
504
505 // Allgemein ansprechbar über postMessage:
506 <window>.postMessage('scrollToPrivacy', '*');
507
508 {{/code}}
509
510 ==== Scrollen zum Formular: {{version major="1" minor="4"}}{{/version}} ====
511
512 {{code language="none"}}
513 // Innerhalb des Kontextes
514 Contest.scrollToForm();
515
516 // Innerhalb des Formulares
517 // - falls dies in der selben Domaine betrieben wird
518 window.parent.Contest.scrollToForm();
519
520 // - falls dies nicht in der selben Domaine betrieben wird
521 window.parent.postMessage('scrollToForm', '*');
522
523 // Allgemein ansprechbar über postMessage:
524 <window>.postMessage('scrollToForm', '*');
525
526 {{/code}}
527
528 ==== Scrollen zum Anfang des Gewinnspiels: {{version major="1" minor="4"}}{{/version}} ====
529
530 {{code language="none"}}
531 // Innerhalb des Kontextes
532 Contest.scrollToContestTop();
533
534 // Innerhalb des Formulares
535 // - falls dies in der selben Domaine betrieben wird
536 window.parent.Contest.scrollToContestTop();
537
538 // - falls dies nicht in der selben Domaine betrieben wird
539 window.parent.postMessage('scrollToContestTop', '*');
540
541 // Allgemein ansprechbar über postMessage:
542 <window>.postMessage('scrollToContestTop', '*');
543
544 {{/code}}
545
546 ==== Scrollen zum Anfang des Inhaltbereichs: {{version major="1" minor="4"}}{{/version}} ====
547
548 {{code language="none"}}
549 // Innerhalb des Kontextes
550 Contest.scrollToContent();
551
552 // Innerhalb des Formulares
553 // - falls dies in der selben Domaine betrieben wird
554 window.parent.Contest.scrollToContent();
555
556 // - falls dies nicht in der selben Domaine betrieben wird
557 window.parent.postMessage('scrollToContent', '*');
558
559 // Allgemein ansprechbar über postMessage:
560 <window>.postMessage('scrollToContent', '*');
561
562 {{/code}}
563
564 ==== Berechnung eines Scroll-Offsets: {{version major="1" minor="5"}}{{/version}} ====
565
566 Mit der Funktion Contest.calcScrollOffset() steht eine überschreibbare Schnittstelle zur Verfügung, welche innerhalb der Scroll-Funktionen (außer scrollToTop()) gerufen wird um den berechneten Offset anzupassen. So ist es z.B. ggf. nötig bei mobilen Ansichten absolut positionierte Header in diesem mit zu berücksichtigen. Der zurückgegebene Wert wird zum Offset addiert. Die Überlagerung kann innerhalb des Portal-JavaScripts oder innerhalb einer einbettenden Seite stattfinden.
567
568 {{code language="none"}}
569 // Liefert standardmäßig 0 zurück
570 Contest.calcScrollOffset();
571
572 // Reduktion des Scroll-Offsets um 60 Pixel innerhalb einer mobilen Ansicht (Breite kleiner 960px).
573 Contest.calcScrollOffset = function(){
574 if(window.matchMedia('(min-width: 960px)').matches){
575 return 0;
576 }else{
577 return -60;
578 }
579 }
580 {{/code}}
581
582
583 === Portal-spezifisch ===
584
585 Innerhalb des Portals wird für die Carousel-Darstellung die Bibliothekt [[slick>>https://kenwheeler.github.io/slick/||rel="noopener noreferrer" target="_blank"]] verwendet. Dies lässt sich hierbei wie folgt ansprechen und umkonfigurieren:
586
587 {{code language="none"}}
588 // Abholen des entsprechenden Carousel-Objekts
589 var carousel = $('.portal-carousel-images');
590
591 // Beispielhafte konfiguration des Autoplay-Features
592 if (carousel && carousel.length > 0) {
593 carousel.slick('slickSetOption', 'speed', 1000)
594 carousel.slick('slickSetOption', 'autoplaySpeed', 5000);
595 carousel.slick('slickPlay');
596 }
597 {{/code}}
598
599 (% class="wikigeneratedid" id="HSelektioneinesbestimmtenGewinnspiels:" %)
600 Ferner lässt sich die wie folgt ein gewünschtes Gewinnspiel anhand der entsprechenden UUID selektieren:
601
602 {{code language="none"}}
603 // Innerhalb des Kontextes
604 Portal.goToContest(<uuid>);
605
606 // Innerhalb des Formulares
607 // - falls dies in der selben Domaine betrieben wird
608 window.parent.Portal.goToContest(<uuid>);
609
610 // - falls dies nicht in der selben Domaine betrieben wird
611 var data = {
612 msg: 'goToContest',
613 uuid: <uuid>
614 };
615 window.parent.postMessage(data, '*')
616
617 // Allgemein ansprechbar über postMessage:
618 var data = {
619 msg: "goToContest",
620 uuid: <uuid>
621 };
622 <window>.postMessage(data , '*')
623 {{/code}}
624
625 === Microsite-spezifisch ===
626
627 Die Microsite besitzt neben den allgemeinen Funkationalitäten einen postMessage-Proxy welcher alle Nachrichten an das Formular-Fenster weiterreicht. Ferner wird die Bibliothek [[iFrame Resizer>>https://github.com/davidjbradshaw/iframe-resizer||rel="noopener noreferrer" target="_blank"]] bereitgestellt.
628
629 == Einbinden als Microsite ==
630
631 Für die Integration einer Gewinnspiel-Microsite als IFrame stehen verschiedene Hilfsmethoden für das Anpassen der Fenstergröße sowie das Scrolling der Site zur Verfügung. Diese sind hierbei folgende:
632
633 ==== Resizing der IFrame anhand ihres Inhaltes ====
634
635 Hier kommt die Bibliothekt [[iFrame  Resizer>>https://github.com/davidjbradshaw/iframe-resizer||rel="noopener noreferrer" target="_blank"]] zum Einsatz. Es muss hierfür auf der Seite die die Microsite einbindet die Datei //iframeResizer.min.js// einbgebunden und der Resizer beispielsweise wie folgt initialisiert werden:
636
637 {{code language="none"}}
638 iFrameResize({log: false}, '<CSS-Selektor der iframe>');
639 {{/code}}
640
641 ==== Scrolling zu gewünschten Stellen auf der Microsite ====
642
643 Für diese Funktionalität werden an die Zielseite durch die Microsite entsprechende postMessages gesendet. Unter der Verwendung von [[jQuery>>https://jquery.com/||rel="noopener noreferrer" target="_blank"]] kann dessen Auswertung wie folgt stattfinden:
644
645 {{code language="none"}}
646 // Behandelt Messages der Microsite
647 function _handleMessage(event){
648
649 // Prüfung ob es sich um eine Scroll-Message handelt
650 if(event.data.scrollTarget || event.data.scrollOffset){
651
652 // Berechnung des Offsets der iFrame zum Seitenanfang. als scrollTarget sind die Werte "top", "terms" und "privacy" möglich.
653 var frameOffset = (event.data.scrollTarget == 'top') ? 0 : $('<CSS-Selektor der iFrame>').offset().top;
654
655 // Animiertes Scrolling zum Ziel. Dieses ergibt sich aus dem Offset der iFrame und dem Offset der Position innerhalb der iFrame
656 $('html, body').animate({
657 scrollTop : event.data.scrollOffset + frameOffset
658 }, 'slow');
659
660 // Weiterleitung aller weiteren postMessages an die Microsite
661 }else{
662 $('<CSS-Selektor der iFrame>').each(function(){
663 var iframewindow = this.contentWindow ? this.contentWindow : this.contentDocument.defaultView;
664 iframewindow.postMessage(event.data,"*");
665 });
666 }
667 }
668
669 // Registireren der Message-Behandlung
670 if (window.addEventListener) {
671 window.addEventListener('message', _handleMessage, false);
672 } else if (window.attachEvent) { // ie8
673 window.attachEvent('onmessage', _handleMessage);
674 }
675
676 {{/code}}
677
678 {{info}}
679 Wie in diesem Beispiel erkennbar werden alle nicht postMessage-Nachrichten der Zielseite an die Microsite weitergegeben. Dies ist wichtig um z.B. interne Resize-Nachrichten des Formulars bis in die Microsite zu geben!
680 {{/info}}
681
682 == Versionshistorie ==
683
684 === 1.5.0 ===
685
686 * Funktionalität zum Exportieren der aktuellen Teilnehmer-Liste anhand der Porjekt-spezifischen Postfach-Ansicht
687 * JavaScript-Schnittstelle zum Anpassen der Scroll-Offsets
688
689 === 1.4.0 ===
690
691 * Funktionalität zum Ermitteln von Gewinnern und deren Excel-Export
692 * Erweiterung der scrollTo-Funktionen
693 * Kleinere CSS-Anpassungen
694
695 === 1.3.4 ===
696
697 * CSS-Anpassung um einen Layout-Unterschied zwischen Microsmite und Portal-Einbeung zu entfernen
698
699 === 1.3.3 ===
700
701 * Encoden der Vorschau-URLs und Formular-URL für die Unterstützung von deaktivierten Cookies
702 * Korrektur der Formular- und iFrameResizer-URL in der Vorschau
703
704 === 1.3.2 ===
705
706 * Korrektur falscher Bilder in der Lightbox der Gewinnspielübersicht
707
708 === 1.3.1 ===
709
710 * Über den Plugin-Parameter //portal.usebaseurl// kann aktiviert werden, dass für die Gewinnspiel-URLs die hinterlegten Basis-URLs benutzt werden.
711 * Ausgabe der UUID des Gewinnspiels auf entsprechender Konfigurations-Seite
712
713 === 1.3.0 ===
714
715 * Fehlerbehebung beim Ausliefern über den Frontend-Server
716 * Einbau eines iFrame-Resizer für Microseiten
717 * Weitergabe von scroll-Nachrichten an top-window
718
719 === 1.2.4 ===
720
721 * Weiterleitung von postMessage an iframe innerhalb von Microsites
722
723 === 1.2.3 ===
724
725 * Durchreichen von URL-Parametern an IFames im Portal
726 * Fix zum direkten Selektieren eines Gewinnspiels im Portal per URL-Parameter
727
728 === 1.2.2 ===
729
730 * Undo/Redo-Funktionalität an Editoren aktiviert
731 * Zentral pflegbares Overlay für abgelaufene Gewinnspiele eingebaut
732 * Kleinere Anpassungen/Bugfixes
733
734 === 1.2.0 ===
735
736 * Einbinden von grid.css auch in Portal- und Gewinnspiel-Text-Editoren
737 * Überarbeitung des Portal-Layoutings und Anpassung responsiver Breakpoints
738 * Separate Einbindung von jQuery um dass unnötigen Laden von Primefaces zu umgehen
739
740 === 1.1.0 ===
741
742 * Anpassungen für FORMCYCLE Version 6.5.x und PrimeFaces 8
743
744 === 1.0.1 ===
745
746 * Anpassungen für FORMCYCLE Version 6.4.x

Navigation

Copyright 2000-2025