Wiki source code of Leitfaden-Plugin


Show last authors
1 {{info}}
2 {{version major="7" minor="2" /}} Für die {{formcycle/}} Version 7.2.0 muss das Plugin auf die Pluginversion 2.2.0 (oder höher) aktualisiert werden.
3 {{/info}}
4
5 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/Leitfaden%3Aleitfaden-resources&fileid=25265||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung) - Bitte beachten Sie, dass für {{formcycle/}} in der Version 7 das Plugin zwingend in der Version 2.0.0 pder höher benötigt wird
6
7 {{content/}}
8
9 {{velocity}}
10 ##{{info}}
11 ##Hinweis, dass das für bayr. LK ist.
12 ##Über das //???? Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt.
13 ##{{/info}}
14 ##{{figure image="formular_vorlage.png"}}
15 ##TBD
16 ##{{/figure}}
17 {{/velocity}}
18
19
20 == Vorbemerkungen ==
21
22 In dem vom Bayerischen Landkreistag und dem Bayerischen Staatsministerium für Digitales herausgegebenen [[//Leitfaden zur nutzerorientierten und einheitlichen Formulargestaltung für die bayerischen Landkreise//>>https://www.stmd.bayern.de/wp-content/uploads/2020/10/10-2020_Leitfaden-nutzerfreundlicher-Formulargestaltung.pdf||rel="noopener noreferrer" target="_blank"]] werden für die Umsetzung von Online-Formularen konkrete Vorschläge gemacht und Empfehlungen gegeben.
23
24 Das kostenpflichtige //Leitfaden-Plugin// stellt Funktionalitäten zur Verfügung, welche im Leitfaden beschrieben wurden, aber nicht standardmäßig in {{formcycle/}} umsetzbar sind. Das Plugin wird nur für die öffentliche Verwaltung in Bayern angeboten.
25
26 Im folgenden wird nach allgemeinen Installationshinweisen zunächst beschrieben, wie die einzelnen Punkte im Leitfaden unter Zuhilfenahme des Plugins [[umgesetzt werden können>>||anchor="HUmsetzungvonFormularengemE4DFdesLeitfadens"]]. Danach folgt eine detaillierte Beschreibung der durch das Plugin vorgenommenen Anpassungen an der Darstellung von Formularen und der durch das Plugin hinzugefügten [[Widgets>>Formcycle.Designer.Form.FormElements.Widgets]] und Funktionalitäten im Punkt [[Technische Dokumentation>>||anchor="HTechnischeDokumentationdesLeitfaden-Plugins"]].
27
28 == Hinweis zur Verwendung des Leitfaden-Plugins zusammen mit dem Theme-Konfigurator-Plugin ==
29
30 Das //Leitfaden-Plugin// nimmt wie auch das [[Theme-Konfigurator-Plugin>>Formcycle.PluginDocumentation.ThemeConfiguratorPlugin]] Änderungen am Aussehen von Formularen vor. Daher kann es beim parallelen Betrieb von beiden Plugins zu Konflikten kommen, wodurch die Darstellungsoptionen des Leitfaden-Plugins eventuell überschrieben werden. Daher sollte bei einem parallelen Einsatz beider Plugins darauf geachtet werden, dass möglichst nur Dinge durch das //Theme-Konfigurator-Plugin// angepasst werden, bei denen nicht auch durch das //Leitfaden-Plugin// Veränderungen vorgenommen werden, wie zum Beispiel das Logo.
31
32
33 == Installation ==
34
35 Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
36
37
38 == Umsetzung von Formularen gemäß des Leitfadens ==
39
40 Im Folgenden wird auf die einzelnen Punkte des Leitfadens stichpunktartig eingegangen und gezeigt, wie diese nach der Installation des //Leitfaden-Plugins// in {{formcycle/}} realisiert werden können.
41
42 === #1 Frage den Bürger als erstes, was er möchte. ===
43
44 * Diese Anforderung wird dadurch umgesetzt, dass das Formular beim Erstellen bereits entsprechend aufgebaut wird
45 * Dem Bürger können nach der Auswahl des Anliegens über [[Sichtbarkeitsbedingungen>>Formcycle.Designer.Form.ElementProperties.Constraints]] nur diejenigen Seiten und Formularelemente angezeigt werden, die für sein Anliegen notwendig sind
46
47 === #2 Unterteile dein Formular in sinnvolle Prozessschritte und gebe Orientierung ===
48
49 * Für einen Fortschrittsanzeige kann das kostenfreie [[Widget-Plugin Navigationsleiste>>Formcycle.PluginDocumentation.WidgetXNavigationBar]] verwendet werden
50 * Das Widget muss entweder je einmal am Anfang von jeder Formularseite oder genau einmal im Header-Bereich (empfohlen) platziert werden
51 * Details zur Konfiguration des Widgets werden auf der Seite des Plugins genauer [[beschrieben>>Formcycle.PluginDocumentation.WidgetXNavigationBar||anchor="HKonfiguration"]]
52
53 === #3 Gib dem Bürger eine Übersicht über seine Angaben und verlinke zu den Seiten ===
54
55 * Auf der letzten Seite des Formulars kann mithilfe des //Leitfaden-Plugins// eine Zusammenfassung angezeigt werden
56 * Bei der Schaltfläche, mit der zu dieser letzten Seite gewechselt wird, muss dafür //Zusammenfassung + prüfen// als Aktion festgelegt werden
57 * In der Zusammenfassung werden für Fieldsets die Verlinkungen zu den entsprechenden Seiten gemäß des Leitfadens automatisch generiert
58 * Mehr Informationen finden sich unter dem Punkt [[Zusammenfassung>>||anchor="HZusammenfassung"]]
59
60 === #4 Biete jederzeit die Möglichkeit an Kontakt aufzunehmen ===
61
62 * Das //Leitfaden-Plugin// bietet hierfür ein Widget [[Kontaktdaten>>||anchor="HFormularwidget:Kontaktdaten"]] an, mit dem die Kontaktdaten einfach eingepflegt werden können
63 * Diese können beispielsweise in den Header und/oder Footer platziert werden
64
65 === #5 Gib dem Bürger die Möglichkeit sich zu erklären ===
66
67 * Bemerkungsfelder können an geeigneten Stellen als [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]] hinzugefügt werden
68 * Durch Anpassung der Option //Max. Zeichen// unter [[Bedingungen>>Formcycle.Designer.Form.FormElements.Textarea||anchor="HBedingungen"]] und //Höhe (in px)// unter [[Darstellung>>Formcycle.Designer.Form.FormElements.Textarea||anchor="HDarstellung"]] kann das Bemerkungsfeld individuell an die Situation angepasst werden
69
70 === #6 Komme den Fragen deiner Bürger zuvor ===
71
72 * Das //Leitfaden-Plugin// bietet hierfür ein Widget [[Hinweis>>||anchor="HFormularwidget:Hinweis"]] an, mit dem fertig gesetzte Hilfeblöcke einfach in Formulare eingepflegt werden können
73 * Die Konfiguration entspricht dabei der eines normalen [[Text-Elements>>Formcycle.Designer.Form.FormElements.Text]]
74
75 === #7 Positioniere die Feldbezeichnungen oberhalb des Feldes ===
76
77 * Die Position von Feldbezeichnungen ist in {{formcycle/}} standardmäßig über dem Element
78 * Bei Formularelementen kann die Positionierung unter Elementeigenschaften [[Label>>Formcycle.Designer.Form.ElementProperties.Label]] angepasst werden
79
80 === #8 Bilde sinnvolle visuelle Hierarchien ===
81
82 * Die in diesem Punkt angeregten Hervorhebungen durch Farbe und Fettschreibung werden durch das //Leitfaden-Plugin// vorgenommen
83 * Zusammenhängende Formularelemente können durch Verwendung von Fieldsets und Containern gruppiert werden
84 * Durch die Funktionsweise der [[Zusammenfassungs-Funktion>>||anchor="HZusammenfassung"]] des //Leitfaden-Plugins// wird folgende Verwendung empfohlen:
85 ** Verwendung von Fieldsets als erste Gruppierungsstufe, da durch diese in der Zusammenfassung Verlinkungen auf den jeweiligen Block vorhanden sind
86 ** Innerhalb von Fieldsets nur mit Containern oder [[unsichtbaren Containern>>||anchor="HFormularwidget:UnsichtbarerContainer"]] gruppieren
87 ** Container ermöglichen dem Bürger durch Ihre Hintergrundfarbe, die darin enthaltenen Formularelemente deutlich als Gruppe wahrzunehmen
88
89 === #9 Weise deinen Bürgern den Weg ===
90
91 * Durch das //Leitfaden-Plugin// wird das gerade aktive Formularelemente durch einen blauen Rahmen und eine dunklere Hintergrundfarbe hervorgehoben
92 * Bestimmte Webbrowser setzen selbstständig einen dicken schwarzen Rahmen um das aktive Formularelement, wodurch der vom //Leitfaden-Plugin// gesetzte farbige Rahmen wieder überdeckt wird - Dieses Verhalten kann nicht verändert werden
93 * Erledigte Felder werden in der aktuellen Version des //Leitfaden-Plugin// nicht visuell zurückgestellt
94
95 === #10 Gib deinen Bürgern auch Rückmeldungen ===
96
97 * In der aktuellen Version des //Leitfaden-Plugin// werden bereits richtig ausgefüllte Felder nicht optisch belohnt
98
99 === #11 Wähle sinnvolle Feldgrößen ===
100
101 * Für das Eingeben von Text bietet {{formcycle/}} die Formularelemente [[Eingabefeld>>Formcycle.Designer.Form.FormElements.Input]] und [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]]
102 * Eingabefelder eignen sich für die meisten Eingaben
103 ** Durch Platzieren von mehreren Eingabefeldern in einer Zeile und dem Hinzufügen von [[Abstandselmenten>>Formcycle.Designer.Form.FormElements.Spacer]] können Eingabefelder bei Bedarf kleiner gemacht werden
104 ** Der relative Anteil, den einzelne Formularfeld in einer Zeile annimmt kann durch das Anpassen des Wertes der Option //Bereite// in den [[Grundeigenschaften>>Formcycle.Designer.Form.ElementProperties.BaseProperties]] angepasst werden
105 ** Durch das Einfügen von Abständen, kann die anteilige Größe eines Formularelements in einer Zeile verringert werden, ohne das weitere Formularelemente in der Zeile vorhanden sein müssen
106 * Textareas können zum Beispiel für längere Freitextabschnitte verwendet werden
107 ** Standardmäßig ist bereits die [[Darstellungsoption>>Formcycle.Designer.Form.FormElements.Textarea||anchor="HDarstellung"]] //Größe anpassen// aktiv, wodurch das Feld mit den Eingaben des Nutzers mitwächst
108 ** Durch //Höhe (in px)// kann zudem die initiale Höhe der Textarea festgelegt werden
109 ** Die maximale mögliche Zeichenananzahl kann unter [[Bedingungen>>Formcycle.Designer.Form.FormElements.Textarea||anchor="HDarstellung"]] im Paramerter //Max. Zeichen// konfiguriert werden
110 ** Durch die Option //Zeichenanzahl anzeigen// wird unter dem Feld die aktuell vorhandene und die maximal erlaube Zeichenmenge angezeigt, was dem Bürger einen Hinweis auf die ungefähr erwartete Informationsmenge liefern kann
111
112 === #12 Gehe sorgsam mit Auszeichnungen für Schrift um ===
113
114 * Verwendung von Fettschrift, Großschreibungen und Kursivschrift wird vom Formularersteller bestimmt
115 * Inhalte von Feldbezeichnungen und Textelementen werden in einem Rich-Text-Editor eingegeben und können dadurch im {{designer/}} beliebig formatiert werden
116
117 === #13 Mache Pflichtfelder in jeder Situation deutlich sichtbar ===
118
119 * Durch das //Leitfaden-Plugin// werden die Sterne, durch die Pflichtfelder gekennzeichnet werden, deutlich vergrößert
120 * Überschriften und Beschriftungen von Schaltflächen sind in {{formcycle/}} bereits standardmäßig in Fettschrift und Fließtexte sind auch standardmäßig in normaler Schrift
121
122 === #14 Hebe Schaltflächen hervor und beschrifte sie ===
123
124 * Bei den Kontrollschaltflächen von wiederholten Elementen werden durch das //Leitfaden-Plugin// entsprechend ihrer Funktion beschriftet und die Icons heben sich farblich deutlich ab
125
126 === #15 Vermeide doppelte Eingaben ===
127
128 * Durch Verwendung von Auswahlfeldern mit Radiobuttons kann der Bürger gefragt werden, ob vorangegangene Eingaben oder ob er abweichende Daten eingeben möchte
129 * Die Felder für abweichende Daten sind zunächst versteckt und werden über [[//Sichtbar wenn//-Bedingungen>>Formcycle.Designer.Form.ElementProperties.Constraints]] sichtbar
130 * Um die abhängig sichtbaren Eingabeelemente gruppieren zu können, können diese Beispielsweise in einen Container oder einen [[Unsichtbaren Container>>||anchor="HFormularwidget:UnsichtbarerContainer"]] platziert werden
131
132 === #16 Verwende vorausgefüllte Standardtexte als Beispielangabe ===
133
134 * Platzhalter können bei allen Eingabeelementtypen für Text unter [[Label {{rarrow/}} Platzhalter>>Formcycle.Designer.Form.ElementProperties.Label]] eingetragen werden
135
136 === #17 Gib proaktiv hilfreiche Hinweise und Erklärungen ===
137
138 * Hilfetexte können standardmäßig für alle Eingabeelemente in {{formcycle/}} definiert werden
139 * Durch das //Leitfaden-Plugin// werden sie standardmäßig geöffnet werden, wenn das Feld ausgewählt wird
140
141 === #18 Biete so oft wie möglich Auswahlfelder an ===
142
143 {{velocity}}
144 ##* Mehrstufige Abfrage können mit Radiobuttons für die wichtigsten Auswahloptionen und Auswahlfeldern für sonstige Auswahlen umgesetzt werden
145 ##, bei den können mit {{formcycle/}} einfach mit [[Sichtbarkeitsbedingungen>>Formcycle.Designer.Form.ElementProperties.Constraints]] umgesetzt werden.
146 {{/velocity}}
147
148 * Dropdown-Auswalelemente sind eine Ansichtsform des Elementtyps [[Auswahl>>Formcycle.Designer.Form.FormElements.Selection]]
149 * Wenn Abfragen (z.B. Anrede, Staatsbürgerschaft, etc.) häufiger in Formularen vorkommen, können diese als [[Datenquelle>>Formcycle.UserInterface.Data.Sources]] hinterlegt und dadurch einfach eingebunden und für alle Formulare zentral gepflegt werden.
150
151 === #19 Hilf deinen Bürgern Dokumente anzuhängen ===
152
153 * Das //Leitfaden-Plugin// passt das Aussehen des [[Uploadelements>>Formcycle.Designer.Form.FormElements.Upload]] so an, dass die Standardansicht des verwendeten Webbrowsers durch eine neue Schaltfläche ersetzt wird
154 * Dadurch wird Schaltfläche situationsabhängig beschriftet und die verunsichernde Darstellung des gesamten Dateipfades der Datei in //Microsoft Internet Explorer// und //Edge (Alt)// entfällt
155
156 === #20 Überprüfe die Angaben deiner Bürger ===
157
158 * An Eingabefeldern können im {{designer/}} einfache Validatoren ausgewählt werden
159 * Zusätzliche Kontextabhängige Prüfungen können per JavaScript vorgenommen werden
160
161 === #21 Mache Fehler sichtbar und erkläre sie ===
162
163 * {{formcycle/}} markiert standardmäßig Felder, bei denen Angaben fehlen oder nicht valide sind und zeigt eine passende Fehlermeldung an.
164 * Texte von Fehlermeldungen können im {{formcycle/}} Backend unter [[i18n-Variablen>>Formcycle.UserInterface.FilesAndTemplates.I18nVariables]] gepflegt werden oder [[per JavaScript>>Formcycle.Designer.Form.CodingPanel.ScriptTab]] im Formular individuell überschrieben werden
165 * Das Aussehen von Fehlermeldungen kann über [[CSS>>Formcycle.Designer.Form.CodingPanel.CSSTab]] zusätzlich angepasst werden
166
167 === #22 Unterstütze die AutoFill-Funktion der Browser ===
168
169 * In {{formcycle/}} ab Version 6.6.10 für Eingabefelder unter //Erweitert {{rarrow/}} Automatisch ausfüllen// konfigurierbar
170 * Alternativ können die entsprechenden Attribute auch bei //Erweitert {{rarrow/}} Attribute// festgelegt werden
171
172 === #23 Kommuniziere mit deinen Bürgern auf Augenhöhe ===
173
174 * Zusätzliche Hinweise können als [[Textelement>>Formcycle.Designer.Form.FormElements.Text]] im Formular eingefügt werden
175
176 === #24 Halte deine Bürger auf dem Laufenden ===
177
178 * Bei normaler Bearbeitung des Formulars durch die Sachbearbeiter kann nach jeder Bearbeitung eine E-Mail-Aktion zum Informieren des Kunden verwendet werden
179 * Analog kann für Vorgänge, bei denen der Bürger sich mit der AKDB authentifiziert hat, [[eine Nachricht an den AKDB-Postkorb gesendet werden>>Formcycle.PluginDocumentation.AkdbBuergerkontoServicePlugin||anchor="HAKDBPostkorbanbindunginderStatusverarbeitung"]]
180 * Über Statusverarbeitung kann zum Beispiel mithilfe eines [[//Datum und Uhrzeit// Trigger>>Formcycle.Designer.Workflow.Events.DateAndTime]] bzw. eines [[Zeitgesteuerten Statuswechsel>>Formcycle.Designer.Workflow.LegacyWorkflow.States||anchor="HZeigesteuerterStatuswechsel"]] nach einer definierten Zeitspanne in einen anderen Status gewechselt werden, in welchem dem Bürger eine automatische Statusinformation zugesendet wird
181
182 == Technische Dokumentation des Leitfaden-Plugins ==
183
184 Das Plugin stellt Ressourcen zur Verfügung, welche in Formularen automatisch verwendet werden und fügt neue Validierungsreglen und Widgets hinzu. Diese werden im folgenden genauer beschrieben.
185
186 === Designanpassungen ===
187
188 Das //Leitfaden-Plugin// stellt folgende das Aussehen von Formularen beeinflussende Inhalte bereit und bindet diese automatisch in alle Formulare ein:
189
190 ; CSS-Designanpassungen
191 : Optische Anpassungen am Formular wie das Aussehen der Labels von Elementen, Upload-Elemente, Mussfeld-Sterne, usw.
192
193 ; Roboto-Schriftart
194 : Das Plugin stellt diese Schriftart als Ressource auf dem Server bereit und verwendet diese in den Formularen für alle Texte.
195
196 === Validatoren ===
197
198 Durch das Plugin werden 4 neue [[Validatoren>>Formcycle.Designer.Form.CodingPanel.Validators]] bereitgestellt. Zu beachten ist bei allen, dass sie nur überprüfen können, ob eine Eingabe formal dem Aufbau des jeweiligen Wertetyps entspricht. Es kann aber nicht überprüft werden, ob es tatsächlich einen solchen Wert, wie zum Beispiel eine konkrete BIC, gibt. Folgende Regeln werden hinzugefügt:
199
200 ; xm-vdt-bic
201 : Validierung für Eingabefelder, in die der Benutzer ein Geschäftskennzeichen (SWIFT-BIC) für Kontodaten eingibt
202
203 ; xm-vdt-iban
204 : Validierung für Eingabefelder, in die der Benutzer eine Bankverbindung in Schreibweise der internationalen Bankkontonummer (IBAN) eingibt
205
206 ; xm-vdt-iban-de
207 : Validierung für Eingabefelder, in die der Benutzer eine Bankverbindung in Schreibweise der internationalen Bankkontonummer (IBAN) eingibt
208
209 ; xm-vdt-steuerid
210 : Validierung für Eingabefelder, in die der Benutzer eine steuerliche Identifikationsnummer nach § 139b, Abgabenordnung eingibt
211
212 === Formularwidget: Hinweis ===
213
214 {{figure image="leitfaden_widget_hinweis.png" clear="h3"}}
215 Symbol des //Hinweis//-Widgets und Aussehen im Formular
216 {{/figure}}
217
218
219 {{html wiki="true"}}
220 <div class='xm-figure xm-float-right xm-clear-h3' data-alt='Symbol des Hinweis-Widgets und Aussehen im Formular'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_widget_hinweis.png' width='300' group='$height' group='$group' title='Symbol des Hinweis-Widgets und Aussehen im Formular'/}}<div class='xm-figure-caption'>Symbol des //Hinweis//-Widgets und Aussehen im Formular</div></div></div>
221 {{/html}}
222
223
224 Mit diesem Widget können farblich abgehobene Hinweistexte leichter im Formular platziert werden. Die Konfigurationsoptionen entsprechen denen von [[Text-Elementen>>Formcycle.Designer.Form.FormElements.Text]].
225
226
227 === Formularwidget: Kontaktdaten ===
228
229 {{figure image="leitfaden_widget_kontaktdaten.png" clear="h3"}}
230 Symbol des //Kontaktdaten//-Widgets und Aussehen im Formular
231 {{/figure}}
232
233
234 {{html wiki="true"}}
235 <div class='xm-figure xm-float-right xm-clear-h3' data-alt='Symbol des Kontaktdaten-Widgets und Aussehen im Formular'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_widget_kontaktdaten.png' width='300' group='$height' group='$group' title='Symbol des Kontaktdaten-Widgets und Aussehen im Formular'/}}<div class='xm-figure-caption'>Symbol des //Kontaktdaten//-Widgets und Aussehen im Formular</div></div></div>
236 {{/html}}
237
238
239 {{figure image="leitfaden_widget_kontaktdaten_quelle.png" clear="h3"}}
240 Verwendung einer //CSV-Datenquelle// für den Inhalt des //Kontaktdaten//-Widgets
241 {{/figure}}
242
243
244 {{html wiki="true"}}
245 <div class='xm-figure xm-float-right xm-clear-h3' data-alt='Verwendung einer CSV-Datenquelle für den Inhalt des Kontaktdaten-Widgets'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_widget_kontaktdaten_quelle.png' width='300' group='$height' group='$group' title='Verwendung einer CSV-Datenquelle für den Inhalt des Kontaktdaten-Widgets'/}}<div class='xm-figure-caption'>Verwendung einer //CSV-Datenquelle// für den Inhalt des //Kontaktdaten//-Widgets</div></div></div>
246 {{/html}}
247
248
249 Mit diesem Widget können Kontaktinformationen leicht im Formular eingebunden und in einer leitfadengemäßen Form dargestellt werden. Unter //Optionen// kann der Inhalt des Widgets direkt konfiguriert werden.
250
251
252 Der Inhalt des Widgets kann auch aus einer [[//CSV-Datenquelle//>>Formcycle.UserInterface.Data.Sources||anchor="HCSV"]] bezogen werden. Dabei ist zu beachten, dass im Header eine Spalte mit der Bezeichnung //id// vorhanden ist. Diese dient als Bezugspunkt zur Ermittlung der Daten. Das Gleiche gilt für [[DB-Abfragen>>doc:Formcycle.UserInterface.Data.DBQueries||target="_blank"]].
253
254 Die Zeile in der Datenquelle, aus der die Daten gelesen werden, wird über den eingetragenen //ID Wert// unter Optionen ermittelt und muss einem Wert in der Tabelle entsprechen. Bei den anderen Konfigurationsoptionen werden jeweils die Spaltenbezeichnungen angegeben, aus denen die Daten entnommen werden sollen.
255
256 === Formularwidget: Unsichtbarer Container ===
257
258 {{info}}
259 {{version major="7" minor="2" /}} Ab der {{formcycle/}} Version 7.2.0 wird dieses Element direkt von {{formcycle/}} bereitgestellt. In früheren Versionen erstellte //unsichtbare Container// sind vollständig kompatibel zur der in {{formcycle/}} integrierten Variante. Für {{formcycle/}} Version 7.2.0 muss lediglich das //Leitfaden-Plugin// auf die Pluginversion 2.2.0 oder höher aktualisiert werden.
260 {{/info}}
261
262 {{figure image="leitfaden_widget_unsichtbarer_container.png" clear="h3"}}
263 Symbol des //Unsichtbarer Container//-Widgets
264 {{/figure}}
265
266
267 {{html wiki="true"}}
268 <div class='xm-figure xm-float-right xm-clear-h3' data-alt='Symbol des Unsichtbarer Container-Widgets'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_widget_unsichtbarer_container.png' width='300' group='$height' group='$group' title='Symbol des Unsichtbarer Container-Widgets'/}}<div class='xm-figure-caption'>Symbol des //Unsichtbarer Container//-Widgets</div></div></div>
269 {{/html}}
270
271
272 Mit diesem Widget können Formularinhalte wie in einem normalen [[Container>>Formcycle.Designer.Form.FormElements.Container]] gruppiert werden, der Container ist jedoch unsichtbar. Dadurch ist es leichter möglich Dinge wie Sichtbarkeitsbedingungen an mehreren Formularelementen gleichzeitig zu konfigurieren, da die entsprechenden Einstellungen dann nur noch an dem die Elemente beinhaltenden //Unsichtbaren Container// vorgenommen werden müssen.
273
274
275 === Zusammenfassung ===
276
277 {{figure image="leitfaden_zusammenfassung_beispiel.png" clear="h4"}}
278 Beispiel für das Aussehen einer Zusammenfassung mit in [[Fieldsets>>Formcycle.Designer.Form.FormElements.Fieldset]] gruppierten Formularelementen.
279 {{/figure}}
280
281
282 {{html wiki="true"}}
283 <div class='xm-figure xm-float-right xm-clear-h4' data-alt='Beispiel für das Aussehen einer Zusammenfassung mit in Fieldsets gruppierten Formularelementen.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_zusammenfassung_beispiel.png' width='300' group='$height' group='$group' title='Beispiel für das Aussehen einer Zusammenfassung mit in Fieldsets gruppierten Formularelementen.'/}}<div class='xm-figure-caption'>Beispiel für das Aussehen einer Zusammenfassung mit in [[Fieldsets>>Formcycle.Designer.Form.FormElements.Fieldset]] gruppierten Formularelementen.</div></div></div>
284 {{/html}}
285
286
287 Durch das Plugin werden im {{designer/}} zusätzliche Konfigurationsmöglichkeiten hinzugefügt, welche es ermöglichen, auf der letzten im Formular vorhandenen [[Seite>>Formcycle.Designer.Form.FormElements.Page]] eine Zusammenfassung anzuzeigen. Auf dieser Seite wird zuerst die Zusammenfassung aller vorangegangen Seiten angezeigt und darunter alle Elemente, welche im {{designer/}} auf dieser Seite platziert wurden.
288
289
290 In der Zusammenfassung tauchen nur die Formularelemente auf, welche sichtbar sind und einen Wert haben. Das bedeutet, dass leere Eingabefelder nicht in der Zusammenfassung aufgeführt werden. Werden Formularfelder in einem [[Fieldset>>Formcycle.Designer.Form.FormElements.Fieldset]] platziert, werden diese auch in der Zusammenfassung als Block dargestellt, in welchem oben rechts ein Link //Angaben ändern// angezeigt wird. Mit diesem kann im Formular zurück zum jeweiligen Fieldset gesprungen werden, um eingegebene Daten zu korrigieren. Diese Funktionalität ist nur bei Fieldsets, aber nicht bei [[Containern>>Formcycle.Designer.Form.FormElements.Container]] und Unsichtbaren Containern vorhanden.
291
292 Um die Zusammenfassung nutzen zu können, muss bei einer [[Schaltfläche>>Formcycle.Designer.Form.FormElements.Button]] //Zusammenfassung + prüfen// als Aktion konfiguriert werden. Dadurch wird beim Klicken auf diese Schaltfläche auf die Zusammenfassungsseite gesprungen.
293
294 ==== Konfiguration von Formularelementen ====
295
296 {{figure image="leitfaden_zusammenfassung_elemente.png" clear="h4"}}
297 Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formularelements in der Zusammenfassung
298 {{/figure}}
299
300
301 {{html wiki="true"}}
302 <div class='xm-figure xm-float-right xm-clear-h4' data-alt='Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formularelements in der Zusammenfassung'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_zusammenfassung_elemente.png' width='300' group='$height' group='$group' title='Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formularelements in der Zusammenfassung'/}}<div class='xm-figure-caption'>Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formularelements in der Zusammenfassung</div></div></div>
303 {{/html}}
304
305
306 Über die unter //Darstellung// zu findende Option //Bei Zusammenfassung// kann die Sichtbarkeit von Formularelementen in der Zusammenfassung gesteuert werden.
307
308
309 Diese Option wird bei allen [[Formularelementen>>Formcycle.Designer.Form.FormElements.WebHome]] und [[Widgets>>Formcycle.Designer.Form.FormElements.Widgets]] angezeigt, ist aber nur sinnvoll bei Bildern und bei Formularelementen, in denen der Nutzer eine Eingabe tätigen kann. Andere Elemente wie Schaltflächen werden generell nicht in der Zusammenfassung angezeigt.
310
311 Folgende Optionen stehen zur Auswahl:
312
313 ; Sichtbarkeit automatisch
314 : Das Element wird in der Zusammenfassung angezeigt, wenn es sichtbar ist und einen Wert hat oder vom Typ [[Bild>>Formcycle.Designer.Form.FormElements.Image]] ist. Standmäßig ist diese Option ausgewählt
315
316 ; nicht sichtbar
317 : Das Element wird nicht in der Zusammenfassung angezeigt
318
319 ==== Konfiguration der Schaltfläche ====
320
321 {{figure image="leitfaden_zusammenfassung_buttons.png" clear="h4"}}
322 Aktion //Leitfaden-Plugin// in den Konfigurationseinstellungen einer Schaltfläche
323 {{/figure}}
324
325
326 {{html wiki="true"}}
327 <div class='xm-figure xm-float-right xm-clear-h4' data-alt='Aktion Leitfaden-Plugin in den Konfigurationseinstellungen einer Schaltfläche'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='leitfaden_zusammenfassung_buttons.png' width='300' group='$height' group='$group' title='Aktion Leitfaden-Plugin in den Konfigurationseinstellungen einer Schaltfläche'/}}<div class='xm-figure-caption'>Aktion //Leitfaden-Plugin// in den Konfigurationseinstellungen einer Schaltfläche</div></div></div>
328 {{/html}}
329
330
331 Das //Leitfaden-Plugin// fügt für [[Schaltflächen>>Formcycle.Designer.Form.FormElements.Button]] eine neue Aktion mit dem Namen //Zusammenfassung + prüfen// hinzu. Diese Aktion springt dabei immer auf die letzte im Formular vorhandene Seite.
332
333
334 ==== Überschrift auf der Zusammenfassungsseite ====
335
336 Um mit standardmäßig in {{formcycle/}} vorhandenen Mitteln auf der letzten Seite über der Zusammenfassung Informationen wie zum Beispiel eine Überschrift oder einen Hinweis anzuzeigen, kann auf der für die Zusammenfassung verwendeten letzten Formularseite ein Titel oder/und Untertitel definiert werden.
337
338 Falls dies beispielsweise nur eine einfache Nachricht sein soll und die standardmäßig verwendeten Schriftgrößen dafür zu groß sind, kann das Aussehen des (Unter-)titels per [[//CSS//>>Formcycle.Designer.Form.CodingPanel.CSSTab]] angepasst werden. Dies könnte für eine Zusammenfassungsseite mit dem technischen Namen //pZusammenfassung// beispielsweise wie folgt aussehen:
339
340 {{code language="css"}}
341 .CXPage[xn="pZusammenfassung"] .header h1 {
342 font-size: 20px; /* Setzt die Schriftgröße des Titels der Zusammenfassungsseite auf 20 Pixel */
343 }
344 .CXPage[xn="pZusammenfassung"] .header h2 {
345 font-size: 14px; /* Setzt die Schriftgröße des Untertitels der Zusammenfassungsseite auf 14 Pixel */
346 font-weight: normal; /* Sorgt dafür, dass der Text des Untertitel normal und nicht fett dargestellt wird */
347 }
348 {{/code}}
349
350 === i18n Variablen ===
351
352 {{figure image="leitfaden_i18n.jpg" clear="h4"}}
353 In die Tabelle der [[i18n-Variablen>>Formcycle.UserInterface.FilesAndTemplates.I18nVariables]] eingefügte Variablen des //Leitfaden-Plugins//.
354 {{/figure}}
355
356 Verschiedene im //Leitfaden-Plugin// verwendete Texte können unter dem Menüpunkt [[Dateien & Templates {{rarrow/}} i18n-Variablen>>Formcycle.UserInterface.FilesAndTemplates.I18nVariables]] angepasst und internationalisiert werden. Hierfür muss in der Tabelle der Variablenname und der gewünschte Text in einer neuen Zeile eingetragen werden.
357
358 {{table dataTypeAlpha="0-1"}}
359 |=Variablenname|=Standardwert
360 |leitfadenUploadButtonSelect|Datei auswählen
361 |leitfadenUploadButtonChange|Datei ändern
362 |leitfadenUploadNone keine|Datei ausgewählt
363 |leitfadenUploadFormat|Erlaubte Formate:
364 |leitfadenUploadAnd|und
365 |leitfadenUploadMax|Maximal mögliche Dateigröße:
366 |summary_header|Bitte überprüfen Sie Ihre Angaben
367 |xm_summary_goto_page_link|Angaben ändern
368 {{/table}}
369
370 === Einführungsvideo ===
371
372 Für die vorhergehende {{formcycle/}} Version 6 gibt es ein Einführungsvideo für das Leitfaden-Plugin.
373
374 {{externalVimeoVideo id="562734466" image="Workshops.WebHome@fc_video_play.png" height="400"/}}
375
376 == Versionshistorie ==
377
378 === 2.2.0 ===
379
380 * Anpassungen für {{formcycle/}} Version 7.2, erfordert mindestens Version 7.2
381 * Das Element //Unsichtbarer Container// wird nicht mehr vom Plugin bereitgestellt, da dieses Element jetzt direkt von {{formcycle/}} angeboten wird.
382
383 === 2.1.0 ===
384
385 * Anpassungen für {{formcycle/}} Version 7.1, verwendbar nur mit {{formcycle/}} Version 7.1.x
386
387 === 2.0.28 ===
388
389 * Fix: Zusammenfassung mit Upload-Elementen funktioniert auch wieder in älteren FORMCYCLE-Versionen
390
391 === 2.0.27 ===
392
393 * Minor: Die JavaScript-Funktion //showSummary(button: HTMLElement): void// wurde unter //window.jQuery.showSummary// nach außen zur Verfügung gestellt. Hiermit ist es möglich, die Zusammenfassung auch manuell via JavaScript anzuzeigen.
394
395 === 2.0.26 ===
396
397 * Fix: Alle Texte im Kontaktdaten-Element haben wieder die Textfarbe schwarz
398
399 === 2.0.25 ===
400
401 * Fix: Bedingungen wie //versteckt wenn// funktionieren wieder in Verbindung mit dem Kontaktdaten-Element.
402
403 === 2.0.24 ===
404
405 * Fix: Drag&Drop von Elementen in Fieldsets und Container im Formulardesigner funktioniert wieder korrekt
406 * Fix: Upload-Elemente, welche gesperrt sind, sehen nun auch optisch wie gesperrt aus
407 * Fix: Breite von wiederholten Fieldsets und Containern im Formular ist wieder korrekt
408
409 === 2.0.23 ===
410
411 * Fix: Upload-Felder mit automatischen Upload werden in der Zusammenfassung berücksichtigt
412 * Fix: Layout-Problem bezüglich fehlender Abstände in der Zusammenfassung mit wiederholten Elementen behoben
413
414 === 2.0.22 ===
415
416 * Fix: Fehlerbehebungen für ältere Browser im Zusammenhang mit Upload-Feldern.
417 * Fix: Bei der Wiederanzeige von Formularen mit wiederholten Uploads werden die vorhandenen Dateien am richtigen Upload-Element angezeigt.
418
419 === 2.0.21 ===
420
421 * Fix: Fehlerbehebungen für ältere Browser
422
423 === 2.0.20 ===
424
425 * Fix: Bei Fragenelementen mit Labeldarstellung "oben" nimmt das Label nun die volle zur Verfügung stehende Breite ein und bricht nicht mehr frühzeitig um.
426
427 === 2.0.19 ===
428
429 * Fix: Der Löschen-Knopf bei wiederholten Elementen in Container und Fieldsets wird nun mit etwas Abstand dargestellt, sodass der Knopf nicht mehr den Inhalt der Container und Fieldsets überlagert.
430 * Fix: Schrifstärke von Überschriften und fetten Texten wurde verringert, um das Aussehen voriger Versionen besser nachzustellen.
431
432 === 2.0.18 ===
433
434 * Fix: Die Schriftart Roboto wird nun in allen Varianten (Schriftstärke / Kursiv) mit einer korrekten Schriftartdatei eingebunden. Vorher waren erzeugte PDF-Dateien sehr groß, da die Glyphen mit fetter Schriftstärke berechnet werden mussten und direkt im PDF eingebettet wurden. Da vorher eine nicht existente (berechnete) Schriftart verwendet wurde, kann es sein, dass Texte nun geringfügig anders aussehen.
435
436 === 2.0.17 ===
437
438 * Fix: Schriftarten werden auch richtig geladen, wenn Formular inline ausgeliefert wird (etwa bei Wechsel der Sprache via Sprachwechsel-Plugin)
439 * Erfordert wenigstens FORMCYCLE 7.0.7+
440
441 === 2.0.16 ===
442
443 * Fix: Setzt die CSS-Klasse //.active-before// an der Navigationsleiste, wenn die Zusammenfassung ausgeführt wird.
444
445 === 2.0.15 ===
446
447 * Fix: Weiteres Problem beim Ausblenden von Zeilen in der Zusammenfassung, wenn kein anderes Formularelement darin enthalten ist.
448
449 === 2.0.14 ===
450
451 * Fix: CSS-Problem bei Einheiten an Textfelder in der Zusammenfassung behoben
452
453 === 2.0.13 ===
454
455 * Fix: Autocomplete-Felder werden nicht mehr doppelt in der Zusammenfassung dargestellt.
456
457 === 2.0.12 ===
458
459 * Fix: Ausblenden leerer Reihen in der Zusammenfassung, wenn keine darin Elemente enthalten sind.
460
461 === 2.0.11 ===
462
463 * Fix: CSS für W3C-konformen Modus im Designer
464 * Erfordert wenigstens FORMCYCLE 7.0.3+
465
466 === 2.0.10 ===
467
468 * Fix: Darstellungsprobleme in der Zusammenfassung
469 * Fix: Einrückung von unsichtbaren Containern
470
471 === 2.0.9 ===
472
473 * Fix: Darstellung von Umlauten
474
475 === 2.0.8 ===
476
477 * Change: Unsichtbarer Container hat Mindestöhe von 45 Pixel
478
479 === 2.0.7 ===
480
481 * Fix: Zurück-Knopf in der Zusammenfassung funktioniert wieder richtig
482
483 === 2.0.6 ===
484
485 * Fix: Zusammenfassung funktioniert auch mit einigen anderen Widgets sowie anderen eingebauten Elementen
486
487 === 2.0.5 ===
488
489 * Fix: Darstellung der Upload-Element im Designer wieder korrekt
490 * Erfordert wenigstens FORMCYCLE 7.0.1+
491
492 === 2.0.4 ===
493
494 * Fix: Uploads sind nur noch auf der Zusammenfassungsseite deaktiviert
495
496 === 2.0.3 ===
497
498 * Fix: Es werden nur noch sichtbare Seiten validiert.
499
500 === 2.0.2 ===
501
502 * Fix: Der Text //Keine Datei ausgewählt// wird nicht mehr angezeigt, wenn das Formular in der Wiederanzeige geöffnet wird und es bereits eine hochgeladene Datei gibt.
503
504 === 2.0.1 ===
505
506 * Feature: Bei Upload-Element wird nun auch die Dateierweiterung und die Größe der ausgewählten Datei angezeigt.
507
508 === 2.0.0 ===
509
510 * Initiales öffentliches Release des //Leitfaden-Plugins// für {{formcycle/}} Version 7.
511
512 {{velocity}}
513 ##== Weitere Anpassungen am Aussehen der Formulare ==
514 ##
515 ##-> jenseits von Leitfaden
516 ##
517 ##Logo einbinden als BILD oder per CSS. -> allgemeine links
518 ##Hier empfihlt sich
519 {{/velocity}}