Änderungen von Dokument Leitfaden-Plugin

Von Version < 15.1 >

bearbeitet von sas
am 17.05.2021, 17:04

Auf Version < 12.2 >

bearbeitet von gru
am 17.05.2021, 11:02

< >

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

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1
          +1,1 @@
--XWiki.sas
++XWiki.gru

Inhalt

@@ -15,7
          +15,7 @@
  == Vorbemerkungen ==
--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.
++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.
  Das //Leitfaden-Plugin// stellt Funktionalitäten zur Verfügung, welche im Leitfaden beschrieben wurden, aber nicht standardmäßig in {{formcycle/}} umsetzbar sind.
@@ -137,12
          +137,10 @@
  * 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>>Formcycle.UserInterface.Data.Sources]] hinterlegt und dadurch einfach eingebunden und für alle Formulare zentral gepflegt werden.
@@ -177,6
          +177,7 @@
  * 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 Statusinformation 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.
@@ -208,96
          +208,46 @@
  : Validierung für Eingabefelder, in die der Benutzer eine steuerliche Identifikationsnummer nach § 139b, Abgabenordnung eingibt
  === Formularwidget: Hinweis ===
--
  {{figure image="leitfaden_widget_hinweis.png" clear="h3"}}
  Symbol des //Hinweis//-Widgets und Aussehen im Formular
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  Mit diesem Widget können farblich abgehobene Hinweistexte leichter im Formular platziert werden. Die Konfigurationsoptionen entsprechen denen von [[Text-Elementen>>Formcycle.FormDesigner.FormElements.Text]].
--
  === Formularwidget: Kontaktdaten ===
--
  {{figure image="leitfaden_widget_kontaktdaten.png" clear="h3"}}
  Symbol des //Kontaktdaten//-Widgets und Aussehen im Formular
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
--{{figure image="leitfaden_widget_kontaktdaten_quelle.png" clear="h3"}}Verwendung einer //CSV-Datenquelle// für den Inhalt des //Kontaktdaten//-Widgets{{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
++{{figure image="leitfaden_widget_kontaktdaten_quelle.png" clear="h3"}}
++Verwendung einer //CSV-Datenquelle// für den Inhalt des //Kontaktdaten//-Widgets
++{{/figure}}
  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.
++Der Inhalt des Widgets kann auch aus einer [[//CSV-Datenquelle//>>Formcycle.UserInterface.Data.Sources||anchor="HCSV"]] entnommen werden. Diese muss die einen Header aufweisen und in diesem eine Spalte mit der Bezeichung //id//.
--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]].
++Die Zeile in der Datenquelle, aus der die Daten entnommen werden, wird über den in //ID Wert// festgelegten Wert ermittelt, indem in der Tabelle nach einer Zeile mit diesem Wert in der //id//-Spalte gesucht wird. Bei den anderen Konfigurationsoptionen werden jeweils die Spaltenbezeichnungen angegeben, aus denen die Daten entnommen werden sollen.
--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.
--
  === Formularwidget: Unsichtbarer Container ===
--
  {{figure image="leitfaden_widget_unsichtbarer_container.png" clear="h3"}}
  Symbol des //Unsichtbarer Container//-Widgets
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  Mit diesem Widget können Formularinhalte wie in einem normalen [[Container>>Formcycle.FormDesigner.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.
--
  === Zusammenfassung ===
--
  {{figure image="leitfaden_zusammenfassung_beispiel.png" clear="h4"}}
  Beispiel für das Aussehen einer Zusammenfassung mit in [[Fieldsets>>Formcycle.FormDesigner.FormElements.Fieldset]] gruppierten Formularelementen.
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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.FormDesigner.FormElements.Fieldset]] gruppierten Formularelementen.</div></div></div>
--{{/html}}
--
--
  Durch das Plugin werden im {{designer/}} zusätzliche Konfigurationsmöglichkeiten hinzugefügt, welche es ermöglichen, auf der letzten im Formular vorhandenen [[Seite>>Formcycle.FormDesigner.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.
--
  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.FormDesigner.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.FormDesigner.FormElements.Container]] und Unsichtbaren Containern vorhanden.
  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.
  ==== Konfiguration von Formularelementen ====
--
  {{figure image="leitfaden_zusammenfassung_elemente.png" clear="h4"}}
  Konfigurationsmöglichkeiten für die Sichtbarkeit eines Formularelements in der Zusammenfassung
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  Über die unter //Darstellung// zu findende Option //Bei Zusammenfassung// kann die Sichtbarkeit von Formularelementen in der Zusammenfassung gesteuert werden.
--
  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.
  Folgende Optionen stehen zur Auswahl:
@@ -308,21
          +308,13 @@
  ; nicht sichtbar
  : Das Element wird nicht in der Zusammenfassung angezeigt
--==== Konfiguration der Schaltfläche ====
++==== Konfiguration der Schaltfläche ====
  {{figure image="leitfaden_zusammenfassung_buttons.png" clear="h4"}}
  Aktion //Leitfaden-Plugin// in den Konfigurationseinstellungen einer Schaltfläche
  {{/figure}}
--
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  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.
--
  ==== Überschrift auf der Zusammenfassungsseite ====
  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.

Änderungen von Dokument Leitfaden-Plugin

Zusammenfassung

Details

Navigation