Wiki-Quellcode von ContestPortalPlugin

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}}{{version major="6" minor="1" patch="0"}}Für das Gewinnspiel-Portal-Plugin wird mindestend {{formcycle/}} in der Version 6.1.0 benötigt{{/info}}
6
7 {{figure image="beispiel_de.jpg" clear="h2"}}Beispiel für ein mit dem Plugin erstelltes Gewinnspiel-Portal.{{/figure}}
8
9 Das 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.
10
11 == Installation ==
12
13 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.
14
15 == Rollenrechte ==
16
17 {{figure image="rollenrechte_de.png" clear="h2"}}Nach der Installation des Plugins zusätzlich konfigurierbare [[Rollenrechte>>doc:Formcycle.UserInterface.UserSettings.Roles]] in der Benuterverwaltung.{{/figure}}
18
19 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:
20
21 === Gewinnspiel-Portal verwalten ===
22
23 Unter diesem Hauptpunkt können alle für die Administration des Gewinnspiel-Portals nötigen Rechte vergeben werden.
24
25 ==== Gewinnspiele verwalten ====
26
27
28 ; Gewinnspiel anlegen (leer)
29 : Berechtigung ein neues Gewinnspiel anzulegen, welches nicht auf einer Vorlage beruht
30
31 ; Gewinnspiel importieren
32 : Berechtigung ein exportiertes Gewinnspiel importieren zu dürfen
33
34 ; Gewinnspiel aus Vorlage anlegen
35 : Berechtigung ein neues Gewinnspiel anzulegen, welches auf einer Vorlage aufbaut
36
37 ; Gewinnspiel kopieren
38 : Berechtigung ein vorhandenes Gewinnspiel kopieren zu dürfen
39
40 ; Gewinnspiel exportieren
41 : Berechtigung ein vorhandenes Gewinnspiel exportieren zu dürfen
42
43 ; Gewinnspiel löschen
44 : Berechtigung ein vorhandenes Gewinnspiel löschen zu dürfen
45
46 ; Gewinnspiel-Formular bearbeiten
47 : Berechtigung ein vorhandenes Gewinnspiel bearbeiten zu dürfen
48
49 ==== Vorlagen verwalten ====
50 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.
51
52 ==== Portal konfigurieren ====
53 Berechtigung, um die für alle Gewinnspiele verwendete Oberfläche konfigurieren zu dürfen
54
55 === Gewinnspiel-Portal öffnen ===
56 Berechtigung, das Gewinnspiel-Portal aus {{formcycle/}} heraus direkt öffnen zu dürfen
57
58 == Menüpunkte auf der Verwaltungsoberfläche ===
59 {{figure image="portal_menue_elemente_de.png" clear="h1" width="150"}}Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.{{/figure}}
60 Durch die Konfiguration der entprechenden Rollenrechte erscheinen die folgenden neuen Menüeinträge auf der Verwaltungsoberfläche:
61
62 === Gewinnspiele ===
63
64 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:
65
66 ; Gewinnspiele verwalten
67 : Unter diesem Punkt können Gewinnspiele angelegt und die Einstellungen von vorhandenen Gewinnspielen eingesehen und angepasst werden.
68
69 ; Vorlagen verwalten
70 : Unter diesem Punkt können neue Vorlagen für Gewinnspiele angelegt und vorhandene Vorlagen eingesehen und angepasst werden.
71
72 ; Portal konfigurieren
73 : Unter diesem Punkt können Stuktur, Aussehen und Verhalten des Gewinnspiel-Portals konfiguriert werden.
74
75 Die möglichen Einstellungen finden Sie auf den verlinkten Unterseiten.
76
77 === Gewinnspiel öffnen ===
78
79 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//.
80
81 == Grundstruktur des Gewinnspiel-Portals ==
82
83 {{figure image="portal_aufbau_de.jpg" clear="h1"}}Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.{{/figure}}
84
85 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:
86
87 ; (1) Kopfbereich, (7) Fußbereich und (4) Trenner vom Portal
88 : Diese Elemente werden einmal konfiguriert und werden für alle Gewinnspiele im Gewinnspiel-Portal genutzt.
89
90 ; (2) Bannergrafik, (3) Inhalt (Formular, Beschreibung, ggf. Ankündigungen oder Mitteilungen über das Ende des Gewinnspiels), (5) Teilnahmebedingungen und (6) Datenschutz
91 : Diese Elemente können für jedes Gewinnspiel individuell konfiguriert werden.
92
93 == Verwaltungsoberfläche im FORMCYCLE Backend ==
94
95 {{figure image="gewinnspiele_ui_de.jpg" clear="h3"}}Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.{{/figure}}
96 === Gewinnspiele verwalten ===
97
98 Unter diesem Menüpunkt können die vorhandenen Gewinnspiele verwaltet und neue Gewinnspiele angelegt werden.
99
100 ==== Menü ====
101
102 Auf der linken Seite befindet sich die Liste aller vorhandenen Gewinnspiele. Über die Buttons über der Liste kann ein neues Gewinnspiel angelegt werden (+) oder ein zuvor in der Liste ausgewähltes Gewinnspiel kopiert [Symbol], exportiert [Symbol], als Vorlage gespeichert [Symbol] oder gelöscht [Symbol] werden. Über die Suchen-Schaltfläche [Symbol] kann ein Eingabefeld eingeblendet werden, nach dessen Inhalt die Gewinnspiel-Liste automatisch gefiltert wird.
103
104 Links neben dem Namen des Gewinnspiels wird jeweils ein Symbol angezeigt, welches die folgende Bedeutung hat:
105
106 : Ein ausgefüllter Kreis mit Haken bedeutet, dass das Gewinnspiel aktiviert ist und sich aktuell innerhalb des konfigurierten Online-Zeitraumes befindet
107 : Ein 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.
108 : Ein leerer Kreis bedeutet, dass das Gewinnspiel momentan nicht aktiv ist
109
110 ==== Einstellungen ====
111
112 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:
113
114 ; **Aktiviert (Das Gewinnspiel ist aufrufbar)**
115 : Das Gewinnspiel kann über einen Link aufgerufen werden
116
117 ; **Gewinnspiel im Portal anzeigen**
118 : 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
119
120 ; **Name des Gewinnspiels:**
121 : Im Portal angezeigter Name des Gewinnspiels. Wird zudem als //title//-Attribut für das {{formcycle/}}-Formular des Gewinnspiels verwendet.
122
123 ; **Online von:**
124 : 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.
125
126 ; **Online bis:**
127 : 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.
128
129 ; **Layout:**
130 : 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:
131 :; **Formular links**
132 :: Der //Beschreibungstext// wird rechts neben dem Formular angezeigt
133 :; **Formular rechts**
134 :: Der //Beschreibungstext// wird links neben dem Formular angezeigt
135 :; **Formular oben**
136 :: Der //Beschreibungstext// wird unter dem Formular angezeigt
137 :; **Formular unten**
138 :: Der //Beschreibungstext// wird über dem Formular angezeigt
139 :; **ohne Beschreibung**
140 :: Es wird nur das Formular und kein //Beschreibungstext// angezeigt
141
142 ; **Microsite**
143 : 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:
144 :; **Öffnen**
145 :: Ö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.
146 :; **Vorschau**
147 :: 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:
148 :; **Vorschau als angekündigt**
149 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt ab dem es online ist noch nicht erreicht wurde.
150 :; **Vorschau als abgelaufen**
151 :: Öffnet das Gewinnspiel so, wie es sichtbar ist, wenn der Zeitpunkt bis zu dem es online war überschritten wurde.
152 :; **Bereitstellen**
153 :: Ö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:
154 ::; **Kopfbereich des Gewinnspiels ausblenden (Bilder)**
155 ::: Wenn diese Option gewählt wird, wird die Bannergrafik nicht angezeigt.
156 ::; **Beschreibung des Gewinnspiels ausblenden**
157 ::: Wenn diese Option gewählt wird, wird die Beschreibung des Gewinnspiels nicht angezeigt, unabhängig davon, was unter //Layout// konfiguriert wurde.
158 ::; **Fußbereich des Gewinnspiels ausblenden (Datenschutz & Teilnahmebedingungen)**
159 ::: Wenn diese Option gewählt wird, werden die für das Gewinnspiel konfigurierten Inhalte für //Datenschutz// und //Teilnahmebedingungen// nicht angezeigt.
160 ::; **Zu verwendender Server**
161 ::: Auswahl, über welchen Server das Gewinnspiel geöffnet werden soll. Zur Auswahl stehen Master- und eventuell vorhande Frontend-Server.
162 :: 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.
163 :: 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:
164 :; **Bereitstellen als HTML Link**
165 :: Generiert Quellcode, mit dem das Gewinnspiel direkt als HTML-Code in eine Webseite eingebunden werden kann.
166 :; **Bereitstellen als Inlineframe**
167 :: Generiert Quellcode, mit dem das Gewinnspiel als Inlineframe in eine Webseite eingebunden werden kann.
168 :; **Bereitstellen als Ajax/JavaScript**
169 :: Generiert Quellcode, mit dem das Gewinnspiel per Ajax (JavaScript) in eine Webseite eingebunden werden kann.
170
171 ; **Inhalt**
172 : 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. JavaScript-Code und CSS-Regeln dafür können anschließend unter //JavaScript (Microsite)// bzw. unter //CSS (Microsite)// definiert werden.
173 : Folgende Inhalte können an dieser Stelle konfiguriert werden:
174 :; **Beschreibung**
175 ::
176 :; **Teilnahmebedingungen**
177 ::
178 :; **Datenschutz**
179 ::
180 :; **Ankündigung**
181 ::
182 :; **Abgelaufen**
183 ::
184 :; **CSS (Microsite)**
185 ::
186 :; **JavaScript (Microsite)**
187 ::
188 :; **HTML header (Microsite)**
189 ::
190
191 ; Bannergrafiken
192 : Oben rechts können die auf der Gewinnspiel-Portalseite beim Auswählen dieses Gewinnspiels 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:
193 :: **Desktop** - ab xxx px Bildschirmbreite; Muss konfiguriert werden
194 :: **Tablet** - zwischen xxx px und xxx px Bildschirmbreite
195 :: **Mobile** - bei xxx px oder weniger Bildschirmbreite
196 : 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.
197 : Die folgenden Schaltflächen dienen der Konfiguration der Bannergrafiken:
198 :: **Desktop**, **Tablet** und **Mobile** - Durch anklicken dieser Schaltflächen kann zwischen den Grafiken für die einzelnen Geräteklassen gewchselt werden
199 :: **+ Bannergrafik ändern** - Ö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.
200 :: [Mülltonne]-Symbol rechts neben dem Dateinamen einer bereits vorhandenen Grafik - Löschen der Grafik
201
202 ==== Fußzeile ====
203
204 Hier befinden sich die folgenden zwei Schaltflächen:
205
206 ; **Formular bearbeiten**
207 : Ö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.
208
209 ; **Speichern**
210 : Speichert die auf dieser Seite gemachten Einstellungen bzw. Änderungen an den Einstellungen
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232 {{figure image="vorlagen_ui_de.jpg" clear="h3"}}Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.{{/figure}}
233 === Vorlagen verwalten ===
234
235
236
237 {{figure image="portal_ui_de.jpg" clear="h3"}}Zusätzliche Menüpunkte auf der {{formcycle/}} Verwaltungsoberfläche.{{/figure}}
238 === Portal konfigurieren ===
239
240 In diesem Menüpunkt kann das Aussehen des Gewinnspiel-Portals angepasst werden. Die folgenden ... können konfiguriert werden:
241
242
243
244
245 == Speicherort der Inhalte des Gewinnspiel-Portals ==
246
247 Die unter //Portal konfigurieren// getätigten Einstellungen werden in {{formcycle/}} als Dateien hinterlegt. Diese befinden sich unter [[Dateien und Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]].
248
249 **Es handelt sich um die folgenden Dateien:**
250 {{table dataTypeAlpha="0-1" preSort="0-asc" caption=""}}
251 |=Dateiname|=Inhalt
252 |contest-portal.css.txt|CSS-Code für das Gewinnspiel-Portal; Als txt-Datei hinterlegt, damit es nicht automatisch in alle Formulare eingebunden wird
253 |contest-portal.footer.html|Inhalt des Fußbereiches der Gewinnspiel-Portalseite
254 |contest-portal.header.html|Inhalt des Kopfbereiches der Gewinnspiel-Portalseite
255 |contest-portal.separator.html|Inhalt des Trenners in der Mitte auf der Gewinnspiel-Portalseite
256 |contest-portal.title.html|Titel der Gewinnspiel-Portalseite
257 {{/table}}
258
259 {{id name="sec_user_variables" /}}

Navigation

Copyright 2000-2025