Änderungen von Dokument Leitfaden-Plugin

Von Version < 7.18 >

bearbeitet von gru
am 10.05.2021, 10:24

Auf Version < 7.17 >

bearbeitet von gru
am 06.05.2021, 11:43

< >

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

@@ -18,8
          +18,11 @@
  Das //Leitfaden-Plugin// stellt Funktionalitäten zur Verfügung, welche im Leitfaden beschrieben wurden, aber nicht standardmäßig in {{formcycle/}} umsetzbar sind.
--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]].
++{{velocity}}
++##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]].
++{{/velocity}}
++
  == Hinweis zur Verwendung des Leitfaden-Plugins zusammen mit dem Theme-Konfigurator-Plugin ==
  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.
@@ -30,150
          +30,6 @@
  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]].
--== Umsetzung von Formularen gemäß des Leitfadens ==
--
--Im folgenden wird auf die einzelnen Punkte des Leitfadens stichpunktartig eingegangen und gezeigt, wie diese nach der Installation des Plugins in FORMCYCLE realisiert werden können.
--
--=== #1 Frage den Bürger als erstes, was er möchte. ===
--
--* Diese Anforderung wird dadurch umgesetzt, dass das Formular beim Erstellen bereits ensprechend aufgebaut wird
--* Dem Bürger können nach der Auswahl des Anliegens über [[Sichtbarkeitsbedingungen>>Formcycle.FormDesigner.ElementProperties.Constraints]] nur diejenigen Seiten und Formualarelemente angezeigt werden, die für sein Anliegen notwendig sind
--
--=== #2 Unterteile dein Formular in sinnvolle Prozessschritte und gebe Orientierung ===
--
--* Für einen Fortschrittsanzeige kann das kostenfreie [[Widget-Plugin Navigationsleiste>>Formcycle.PluginDocumentation.WidgetXNavigationBar]] verwendet werden
--* Das Widget muss entweder je einmal am Anfang von jeder Formualarseite oder genau einmal im Header-Bereich (empfohlen) platziert werden
--* Details zur Konfiguration des Widgets wirden auf der Seite des Plugins genauer [[beschrieben>>Formcycle.PluginDocumentation.WidgetXNavigationBar||anchor="HKonfiguration"]]
--
--=== #3 Gib dem Bürger eine Übersicht über seine Angaben und verlinke zu den Seiten ===
--
--* Auf der letzten Seite des Formulars kann mithilfe des //Leitfaden-Plugins// eine Zusammenfassung angezeigt werden
--* Bei der Schaltfläche, mit der zu dieser letzten Seite gewechselt wird, muss dafür //Zusammenfassung + prüfen// als Aktion festgelegt werden
--* In der Zusammenfassung werden für Fieldsets die Verlinkungen zu den ensprechenden Seiten gemäß des Leitfadens automatisch generiert
--* Mehr Informationen finden sich unter dem Punkt [[Zusammenfassung>>TODO]]
--
--=== #4 Biete jederzeit die Möglichkeit an Kontakt aufzunehmen ===
--
--* Das //Leitfaden-Plugin// bietet hierfür ein Widget [[Kontaktdaten>>TODO]] an, mit dem die Kontaktdaten einfach eingepfegt werden können
--* Diese können beispielsweise in den Header und/oder Footer platziert werden
--
--=== #5 Gib dem Bürger die Möglichkeit sich zu erklären ===
--
--* Bemerkungsfelder können an geeigneten Stellen als [[Textarea>>Formcycle.FormDesigner.FormElements.Textarea]] hinzugefügt werden
--* Durch Anpassung der Option //Max. Zeichen// unter [[Bedingungen>>TODO]] und //Höhe (in px)// unter [[Darstellung>>TODO]] kann das Bemerkungsfeld individuell an die Situation angepasst werden
--
--=== #6 Komme den Fragen deiner Bürger zuvor ===
--
--* Das //Leitfaden-Plugin// bietet hierfür ein Widget [[Hinweis>>TODO]] an, mit dem fertig gesetzte Hilfeblöcke einfach in Formulare eingepfegt werden können
--* Die Konfiguration entspricht dabei der eines normalen [[Text-Elements]]
--
--=== #7 Positioniere die Feldbezeichnungen oberhalb des Feldes ===
--
--* Die Position von Feldbezeichungen ist in FORMCYCLE standardmäßig über dem Element
--* Bei Formularlemementen kann die Postitionierung unter Elementeigenschaften [[Label>>Formcycle/FormDesigner/ElementProperties/Label]] angepasst werden
--
--=== #8 Bilde sinnvolle visuelle Hierarchien ===
--
--* Die in diesem Punkt angeregten Hervorhebungen durch Farbe und Fettschreibung werden durch das //Leitfaden-Plugin// vorgenommen
--* Zusammenhängende Formularelemente können durch Verwendung von Fieldsets und Containern gruppiert werden
--* Durch die Funktionsweise der [[Zusammenfassungs-Funktion>>TODO]] des //Leitfaden-Plugins// wird folgende Verwendung empfohlen:
--** Verwendung von Fieldsets als erste Gruppierungsstufe, da durch diese in der Zusammenfassung Verlinkungen auf den jeweiligen Block vorhanden sind
--** Innerhalb von Fieldsets nur mit Containern oder [[unsichtbaren Containern>>TODO]] gruppieren
--** Container ermöglichen dem Bürger durch Ihre Hintergrundfarbe, die darin enthaltenen Formularelemente deutlich als Gruppe wahrzunehmen
--
--=== #9 Weise deinen Bürgern den Weg ===
--
--* Durch das //Leitfaden-Plugin// wird das gerade aktive Formularelemente durch einen blauen Rahmen und eine dunklere Hintergrundfarbe hervorgehoben
--* 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
--* Erledigte Felder werden in der aktuellen Version des //Leitfaden-Plugin// nicht visuell zurückgestellt
--
--=== #10 Gib deinen Bürgern auch Rückmeldungen ===
--
--* In der aktuellen Version des //Leitfaden-Plugin// werden bereits richtig ausgefüllte Felder nicht optisch belohnt
--
--=== #11 Wähle sinnvolle Feldgrößen ===
--
--* Für das Eingeben von Text bietet FORMCYCLE die Formuarelemente [[Eingabefeld>>Formcycle.FormDesigner.FormElements.Input]] und [[Textarea>>Formcycle.FormDesigner.FormElements.Textarea]]
--* Eingabefelder eignen sich für die meisten Eingaben
--** Durch Platzieren von mehreren Eingabefeldern in einer Zeile und dem Hinzufügen von [[Abstandselmenten>>Formcycle.FormDesigner.FormElements.Spacer]] können Eingabefelder bei Bedarf kleiner gemacht werden
--** Der relative Anteil, den einzelne Formularfeld in einer Zeile annimmt kann durch das Anpassen des Wertes der Option //Bereite// in den [[Grundeigenschaften>>TODO]] angepasst werden
--** 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
--* Textareas können zum Beispiel für längere Freitextabschnitte verwendet werden
--** Standardmäßig ist bereits die [[Darstellungsoption>>TODO]] //Größe anpassen// aktiv, wodurch das Feld mit den Eingaben des Nutzers mitwächst
--** Durch //Höhe (in px)// kann zudem die initiale Höhe der Textarea festgelegt werden
--** Die maximale mögliche Zeichananzahl kann unter [[Bedingungen>>TODO]] im Paramerter //Max. Zeichen// konfiguriert werden
--** 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
--
--=== #12 Gehe sorgsam mit Auszeichnungen für Schrift um ===
--
--* Verwendung von Fettschrift, Großschreibungen und Kursivschrift wird vom Formularersteller bestimmt
--* Inhalte von Feldbezeichnungen und Textelementen werden in einem Rich-Text-Editor eingegeben und können dadurch im {{designer/}} beliebig formatiert werden
--
--=== #13 Mache Pflichtfelder in jeder Situation deutlich sichtbar ===
--
--* Durch das //Leitfaden-Plugin// werden die Sterne, durch die Pflichtfelder gekennzeichnet werden, deutlich vergrößert
--* Überschriften und Beschriftungen von Schaltflächen sind in FORMCYCLE bereits standardmäßig in Fettschrift und Fließtexte sind auch standardmäßig in normaler Schrift
--
--=== #14 Hebe Schaltflächen hervor und beschrifte sie ===
--
--* Bei den Kontrollschaltflächen von wiederholten Elementen werden werden durch das //Leitfaden-Plugin// entsprechend ihrer Funktion beschriftet und die Icons heben sich farblich deutlich ab
--
--=== #15 Vermeide doppelte Eingaben ===
--
--* Durch Verwendung von Auswahlfeldern mit Radiobuttons kann der Bürger gefragt werden, ob vorangegangene Eingaben oder ob er abweichende Daten eingeben möchte
--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.
--* Die Felder für abweichende Daten sind zunächst versteckt und werden über [[//Sichtbar wenn//-Bedingungen>>Formcycle.FormDesigner.ElementProperties.Constraints]] sichtbar
--* Um die abhängig sichtbaren Eingabeelemente gruppieren zu können, können diese Beispielsweise in einen Container oder einen [[Unsichtbaren Container>>TODO]] platziert werden
--
--=== #16 Verwende vorausgefüllte Standardtexte als Beispielangabe ===
--
--* Platzhalter können bei allen Eingabeelementtypen für Text unter [[Label {{rarrow/}} Platzhalter>>TODO]] eingetragen werden
--
--=== #17 Gib proaktiv hilfreiche Hinweise und Erklärungen ===
--
--* Hilfetexte können standardmäßig für alle Eingabeelemente in FORMCYCLE definiert werden
--* Durch das //Leitfaden-Plugin// werden sie standardmäßig geöffnet werden, wenn das Feld ausgewählt wird
--
--=== #18 Biete so oft wie möglich Auswahlfelder an ===
--{{velocity}}
--##* Mehrstufige Abfrage können mit Radiobuttons für die wichtigsten Auswahloptionen und Auswahlfeldern für sonstige Auswahlen umgesetzt werden
--##, bei den können mit FORMCYCLE einfach mit [[Sichtbarkeitsbedingungen>>Formcycle.FormDesigner.ElementProperties.Constraints]] umgesetzt werden.
--{{/velocity}}
--* Dropdown-Auswalelemente sind eine Ansichtsform des Elementtyps [[Auswahl>>Formcycle.FormDesigner.FormElements.Selection]]
--* Wenn Abfragen (z.B. Anrede, Staatsbürgerschaft, etc.) häufiger in Formularen vorkommen, können diese als [[Datenquelle>>TODO]] hinterlegt und dadurch einfach eingebunden und für alle Formulare zentral gepflegt werden.
--
--=== #19 Hilf deinen Bürgern Dokumente anzuhängen ===
--
--* Das //Leitfaden-Plugin// passt das Aussehen des [[Uploadelements>>Formcycle.FormDesigner.FormElements.Upload]] so an, dass die Standardansicht des verwendeten Webbrowsers durch eine neue Schaltfläche ersetzt wird
--* 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
--
--=== #20 Überprüfe die Angaben deiner Bürger ===
--
--* An Eingabefeldern können im {{designer/}} einfache Validatoren ausgewählt werden
--* Zusätzliche Köntextabhängige Prüfungen können per JavaScript vorgenommen werden
--
--=== #21 Mache Fehler sichtbar und erkläre sie ===
--
--* FORMCYCLE markiert standardmäßig Felder, bei denen Angaben fehlen oder nicht valide sind und zeigt eine passende Fehlermeldung an.
--* Texte von Fehlermeldungen können im FORMCYCLE Backend unter [[I18N-Variablen>>TODO]] gepflegt werden oder [[per JavaScript>>TODO]] im Formular individuell überschrieben werden
--* Das Aussehen von Fehlermeldungen kann über [[CSS>>TODO]] zusätzlich angepasst werden
--
--=== #22 Unterstütze die AutoFill-Funktion der Browser ===
--
--* In FORMCYCLE ab Version 6.6.10 für Eingabefelder unter //Erweitert {{rarrow/}} Automatisch ausfüllen// konfigurierbar
--* Alternativ können die entsprechenden Attribute auch bei //Erweitert {{rarrow/}} Automatisch ausfüllen// festgelegt werden
--
--=== #23 Kommuniziere mit deinen Bürgern auf Augenhöhe ===
--
--* Zusätzliche Hinweise können als als [[Textelement>>Formcycle.FormDesigner.FormElements.Text]] im Formular eingefügt werden
--
--=== #24 Halte deine Bürger auf dem Laufenden ===
--
--* Bei normaler Bearbeitung des Formulars durch die Sachbearbeiter kann nach jeder Bearbeitung eine E-Mail-Aktion zum Informieren des Kunden verwendet werden
--* 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"]]
--* Über Statusverarbeitung kann zum Beispiel mit einem [[Zeitgesteuerten Statuswechsel>>Formcycle/UserInterface.MyForms.WorkflowProcessing.States||anchor="HZeigesteuerterStatuswechsel"]] nach einer definierten Zeitspanne in einen anderen Status gewechselt werden, in welchem dem Bürger eine automatische Statusoinformation zugesendet wird
--
--
  == Technische Dokumentation des Leitfaden-Plugins ==
  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.