Zeige letzte Bearbeiter
1 [[**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)
2
3 {{content/}}
4
5 {{velocity}}
6 ##{{info}}
7 ##Hinweis, dass das für bayr. LK ist.
8 ##Über das //???? Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt.
9 ##{{/info}}
10 {{/velocity}}
11 {{figure image="formular_vorlage.png"}}
12 TBD
13 {{/figure}}
14
15 == Vorbemerkungen ==
16
17 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||target="_blank"]] werden für die Umsetzung von Online-Formularen konkrete Vorschläge gemacht und Empfehlungen gegeben.
18
19 Das //Leitfaden-Plugin// stellt Funktionalitäten zur Verfügung, welche im Leitfaden beschrieben wurden, aber nicht standardmäßig in {{formcycle/}} umsetzbar sind.
20
21 Im folgenden wird nach allgemeinen Installationshinweisen zunächst beschrieben, wie die einzelnen Punkte im Leitfaden unter Zuhilfenahme des Plugins [[umgesetzt werden können>>TODO]]. 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.FormDesigner.FormElements.Widgets]] und Funktionalitäten im Punkt [[XXX>>TODO]].
22
23 == Hinweis zur Verwendung des Leitfaden-Plugins zusammen mit dem Theme-Konfigurator-Plugin ==
24
25 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 parallen 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.
26
27 == Installation ==
28
29 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]].
30
31 == Umsetzung ,,, mithilfe des Leitfaden-Plugins ==
32
33 Im folgenden wird auf die einzelnen Punkte des Leitfadens kurz eingegangen und gezeigt, wie diese nach der Installation des Plugins in FORMCYCLE realisiert werden können.
34
35 === #1 Frage den Bürger als erstes, was er möchte. ===
36
37 Man muss Formular entsprechend aufbauen... Plugin stellt CSS bereit für Hilfehinweise
38
39 Nachdem Bürger angegeben hat, was er eigentlich will, können durch sichtbarkeitsbedingungen nun diejenigen Abfragen und Eingabefelder eingeblendet werden, die für das spezielle Anliegen des Bürgers absolut notwendig sind.
40
41 === #2 Unterteile dein Formular in sinnvolle Prozessschritte und gebe Orientierung ===
42
43
44 Siehe Widget-Plugin ...
45 Für bestimmte Punkte des Leitfadens wird zudem das [[Widget-Plugin Navigationsleiste>>Formcycle.PluginDocumentation.WidgetXNavigationBar]] benötigt.
46
47
48 === #3 Gib dem Bürger eine Übersicht über seine Angaben und verlinke zu den Seiten ===
49
50 Nach dem ltrzte seite stellt Plugin eine automatische Zusammenfassung bereit ...
51
52 === #4 Biete jederzeit die Möglichkeit an Kontakt aufzunehmen ===
53
54 Man muss in Header oder Footer halt die Kontaktinformationen packen...
55
56 === #5 Gib dem Bürger die Möglichkeit sich zu erklären ===
57
58 Bemerkungsfelder sollten an geeigneten Stellen hinzugefügt werden. Hier bietet sich die Textareas an.
59
60 Durch anpassung der maximal möglichen zeichenzahlö kann hier zum einen begrenzt werden, wieviel der Bürger schreiben kann. Durch die standardmäßig aktive Option ??? wird unter der Textare die Anzahl der maximal möglichen Zeichen und die Anzahl der aktuell bereits eingegebenen zeichen angezieigt.
61 Dadurch kann dem Bürger auch signalisiert werden, wie umfangreich eventuelle Bemerkungen an der jeeiligen Stelle ausfallen können.
62
63 === #6 Komme den Fragen deiner Bürger zuvor ===
64
65 Gibt es da eigentlich css klassen die wir mitliefern für diese Hinweisblöcke?
66 Ansonsten: Wie mache ich einen Hinweisblock ...
67
68 === #7 Positioniere die Feldbezeichnungen oberhalb des Feldes ===
69
70 Standardmäßig in FC so eingestellt
71
72 === #8 Bilde sinnvolle visuelle Hierarchien ===
73
74 Verwendung von Fieldsets
75 Fette Labelbeschriftungen und farbliche Hervorhebeung von Auswahloptionen sind Standardmäßig in FC so eingestellt und werden auch vom Leitfaden-Plugin so umgesetzt
76
77 === #9 Weise deinen Bürgern den Weg ===
78
79 Aktive Felder werden z.T: vom Browser hervorgehoben
80 ??? Mach das Plugin was mit ausgefüllten Feldern??? <- Setzt das Plugin wirklich Haken an die Felder?
81
82 === #10 Gib deinen Bürgern auch Rückmeldungen ===
83
84 ??? Mach das Plugin was mit ausgefüllten Feldern??? <- Frage auch für die HKK
85
86 === #11 Wähle sinnvolle Feldgrößen ===
87
88 Alles Standardoptionen von FORMCYCLE, die für das jeweilige Formular(-feld) individuell verwendet werden können.
89
90 === #12 Gehe sorgsam mit Auszeichnungen für Schrift um ===
91
92 Hier muss der Formularersteller entscheiden, was er wirklich hervorheben will. Da Labels und Textelemente einen Richtexteditor für die anzuzeigenden Texte haben, kann dies in FORMCYCLE sehr einfach gemacht werden.
93
94 === #13 Mache Pflichtfelder in jeder Situation deutlich sichtbar ===
95
96 Standardoption von FC, der Pflichtfeldstern sollte sich farblich vom restlichen Design der Kommune entsprechend abheben
97 ???Plugin vergrößert Stern???
98 Überschriften, buttons sind standardmäßig in FC und im Plugin in Fett und Fließtexte sind auch standardmäßig in normaler Schrift
99
100 === #14 Hebe Schaltflächen hervor und beschrifte sie ===
101
102 Plugin fügt für wiederholte elemente beschriftungen zu den Kontrollschaltflächen hinzu
103 Auch hier muss darauf geachtet werden, dass sich Schaltflächen farblich vom restlichen Design der Kommune entsprechend abheben
104
105 === #15 Vermeide doppelte Eingaben ===
106
107 Standardfunktionalität von FC: Per RB abfragen, ob Angaben von vorher bereits eingegebenen abweichen, Weitere zunächst versteckte Formularfelder werden dann über "sichtbar wenn" bedingungen einblenden.
108
109 === #16 Verwende vorausgefüllte Standardtexte als Beispielangabe ===
110
111 Platzhalter sind auch Standardfeature von FC
112
113 === #17 Gib proaktiv hilfreiche Hinweise und Erklärungen ===
114
115 Hilfefenster sind auch Standardfeature von FC, aber durch das Plugin erscheinen sie standardmäßig, wenn das Feld sichtbar ist
116
117 === #18 Biete so oft wie möglich Auswahlfelder an ===
118
119 Mehrstufige Abfrage mit RB für wichtigste Auswahl(en) und Auswahlfeldern für sonstige Auswahlen, bei den können mit FC einfach mit Sichtbarkeitsbedingungen umgesetzt werden.
120
121 Wenn Abfragen wie z.B. Stattsbürgerschaft häufiger in Formularen vorkommen, können diese als Datenquelle hinterlegt und dadurch einfach eingebunden und für alle Formulare gepflegt werden.
122
123 === #19 Hilf deinen Bürgern Dokumente anzuhängen ===
124
125 Wir haben noch kein neues Upload-Control und können das in FC daher momentan nicht umsetzen <- Oder ist das im Leitfaden?
126
127 === #20 Überprüfe die Angaben deiner Bürger ===
128
129 zusätzliche Köntextabhängige Prüfungen können per JavaScript vorgenommen werden.
130
131 === #21 Mache Fehler sichtbar und erkläre sie ===
132
133 FC markiert standardmäßig Felder, bei denen Angaben nicht valide sind. Durch Plugin wird das Aussehen deutlicher (??? und was ist mit Uploads?)
134
135 === #22 Unterstütze die AutoFill-Funktion der Browser ===
136
137 In FORMCYCLE ab Version 6.6.?? für jedes Formularelement wählbar.
138
139 === #23 Kommuniziere mit deinen Bürgern auf Augenhöhe ===
140
141 Kein technischer Inhalt...
142 Hinweise als Textelement(?)
143
144 === #24 Halte deine Bürger auf dem Laufenden ===
145
146 Über Statusverarbeitung kann zum Beispiel nach X Tagen ein Erinnerungsstatus aufgerufen werden, der eine E-Mail versendet.
147 Beispielformular? Oder Screenshot vom Workflow?
148
149
150
151 == Technische Dokumentation des Leitfaden-Plugins ==
152 oder lieber technische Details? war: Weitere Hinweise zum Aufbau von Formularen, Inhalt des Plugins
153
154 Das Plugin stellt Ressourcen zur Verfügung, welche in Formularen automatisch verwendet werden und fügt neue Validierungsreglen und Widgets hinzu. Im folgenden wird auf alle
155
156 js
157 schriftart verändern
158 uploads werden verändert
159 -> verlinken
160
161 === Designanpassungen ===
162
163 Das //Leitfaden-Plugin// stellt folgende das Aussehen von Formularen beeinflussende Inhalte bereit und bindet diese automatisch in alle Formulare ein:
164
165 ; CSS-Designanpassungen
166 : Optische Anpassungen am Formular wie das Aussehen der Labels von Elementen, Upload-Elemente, Mussfeld-Sterne, usw.
167
168 ; Roboto-Schriftart
169 : das Plugin stellt diese Schriftart als Ressource auf dem Server bereit und verwendet diese für alle Texte in den Formularen
170
171 === Validierungsregeln ===
172
173 Durch das Plugin werden 4 neue [[Validierungsregeln>>TODO]] bereitgestellt. Zu beachten ist 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:
174
175 ; xm-vdt-bic
176 : Validierung für Eingabefelder, in die der Benutzer ein Geschäftskennzeichen (SWIFT-BIC) für Kontodaten eingibt
177
178 ; xm-vdt-iban
179 : Validierung für Eingabefelder, in die der Benutzer eine Bankverbindung in Schreibweise der internationalen Bankkontonummer (IBAN) eingibt
180
181 ; xm-vdt-iban-de
182 : Validierung für Eingabefelder, in die der Benutzer eine Bankverbindung in Schreibweise der internationalen Bankkontonummer (IBAN) eingibt
183
184 ; xm-vdt-steuerid
185 : Validierung für Eingabefelder, in die der Benutzer eine steuerliche Identifikationsnummer nach § 139b, Abgabenordnung eingibt
186
187 === Formularwidget Hinweis ===
188 {{figure image="leitfaden_widget_Hinweis.png" clear="h3"}}
189 Symbol des Hinweis-Widgets und Aussehen im Formular
190 {{/figure}}
191 Mit diesem Widget können farblich abgehobene Hinweistexte leichter im Formular platziert werden. Die Konfigurationsoptionen entsprechen denen von [[Text-Elementen>>TODO]].
192
193 === Formularwidget Kontaktdaten ===
194 {{figure image="leitfaden_widget_kontaktdaten.png" clear="h3"}}
195 Symbol des Kontaktdaten-Widgets und Aussehen im Formular
196 {{/figure}}
197 Mit diesem Widget können Kontaktinformationen leicht im Formular eingebunden und in einer leitfadengemäßen Form dargestellt werden.
198
199 === Formularwidget Unsichtbarer Container ===
200 {{figure image="leitfaden_widget_unsichtbarer_container.png" clear="h3"}}
201 Symbol des Kontaktdaten-Widgets und Aussehen im Formular
202 {{/figure}}
203 Mit diesem Widget können Formularinhalte wie in einem normalen [[Container>>Formcycle.FormDesigner.FormElements.Container]] gruppiert werden.
204
205 === Zusammenfassung ===
206 {{figure image="leitfaden_zusammenfassung_beispiel.png" clear="h4"}}
207 Beispiel für das Aussehen einer Zusammenfassung mit in [[Fieldsets>>TODO]] gruppierten Formularelementen.
208 {{/figure}}
209 Durch das Plugin werden im {{designer/}} zusätzliche Konfigurationsmöglichkeiten hinzugefügt, welche es ermöglichen, auf der letzten im Formular vorhandenen [[Seite>>TODO]] 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.
210
211 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>>TODO]] 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.FormDesigner.FormElements.Container]] und Unsichtbaren Containern vorhanden.
212
213 Um die Zusammenfassung nutzen zu können, muss bei einer [[Schaltfläche>>Formcycle.FormDesigner.FormElements.Button]] //Zusammenfassung + prüfen// als Aktion konfiguriert werden. Dadurch wird beim klicken auf diese Schaltfläche auf die Zusammenfassungsseite gesprungen.
214
215 ==== Konfiguration von Formularelementen ====
216 {{figure image="leitfaden_zusammenfassung_elemente.png" clear="h4"}}
217 Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formualrelements in der Zusammenfassung
218 {{/figure}}
219 Über die unter //Darstellung// zu findende Option //Bei Zusammenfassung// kann die Sichtbarkeit von Formularelementen in der Zusamenfassung gesteuert werden.
220
221 Diese Option wird bei allen [[Formularelementen>>Formcycle.FormDesigner.FormElements.WebHome]] und [[Widgets>>Formcycle.FormDesigner.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.
222
223 Folgende Optionen stehen zur Auswahl:
224
225 ; Sichtbarkeit automatisch
226 : Das Element wird in der Zusammenfassung angezeigt, wenn es sichtbar ist und einen Wert hat oder vom Typ [[Bild>>Formcycle.FormDesigner.FormElements.Image]] ist. Standmäßig ist diese Option ausgewählt
227
228 ; nicht sichtbar
229 : Das element wird nicht in der Zusammenfassung angezeigt
230
231
232 ==== Konfiguration der Schaltfläche ====
233 {{figure image="leitfaden_zusammenfassung_buttons.png" clear="h4"}}
234 Aktion //Leitfaden-Plugin// in den Konfigurationseinstellungen einer Schaltfläche
235 {{/figure}}
236 Das //Leitfaden-Plugin// fügt für [[Schaltflächen>>Formcycle.FormDesigner.FormElements.Button]] eine neue Aktion mit dem Namen //Zusammenfassung + prüfen// hinzu. Diese Aktion springt dabei immer auf die letzte im Formular vorhandene Seite.
237
238 {{velocity}}
239 ##== Weitere Anpassungen am Aussehen der Formulare ==
240 ##
241 ##-> jenseits von Leitfaden
242 ##
243 ##Logo einbinden als BILD oder per CSS. -> allgemeine links
244 ##Hier empfihlt sich
245 {{/velocity}}
Copyright 2000-2025