diff --git a/docs/manual/forms/basics.rst b/docs/manual/forms/basics.rst index b4134f4bcb..8cf25b73c9 100644 --- a/docs/manual/forms/basics.rst +++ b/docs/manual/forms/basics.rst @@ -142,7 +142,7 @@ stap. In deze sectie kunt u velden (ook wel componenten genoemd) naar de formulier stap slepen en configureren. Kijk voor alle mogelijkheden naar het overzicht van -:ref:`formulier velden ` en naar de +:ref:`formuliervelden ` en naar de :ref:`voorbeelden `. Bevestiging diff --git a/docs/manual/forms/form_fields.rst b/docs/manual/forms/form_fields.rst index 7ffae425a7..75e6828349 100644 --- a/docs/manual/forms/form_fields.rst +++ b/docs/manual/forms/form_fields.rst @@ -108,7 +108,7 @@ Validatie --------- * **Verplicht**: Indien aangevinkt dan is dit veld verplicht voor de - eindgebruiker. + eindgebruiker. Sommige velden ondersteunen :ref:`niet-blokkerende verplichting `. * **Plugin**: U kunt gebruik maken van een externe plugin om een veld te valideren. De waarde van het veld wordt naar de plugin gestuurd en diff --git a/docs/manual/forms/index.rst b/docs/manual/forms/index.rst index 685a9fb122..651f3e372e 100644 --- a/docs/manual/forms/index.rst +++ b/docs/manual/forms/index.rst @@ -11,6 +11,7 @@ De kern van Open Formulieren is uiteraard het beheren van formulieren. variables form_fields logic + soft_required_fields logic_dmn translations registrator diff --git a/docs/manual/forms/soft_required_fields.rst b/docs/manual/forms/soft_required_fields.rst new file mode 100644 index 0000000000..9b55904fa2 --- /dev/null +++ b/docs/manual/forms/soft_required_fields.rst @@ -0,0 +1,56 @@ +.. _manual_forms_soft_required_fields: + +================================================= +Formuliervelden met niet-blokkerende verplichting +================================================= + +Sommige velden laten toe om ze als "aangeraden" te markeren. In deze configuratie wordt +de gebruiker er van bewust gemaakt dat ze velden onbedoeld leeg laten, maar het blokkeert +ze niet om het formulier in te zenden. + +.. note:: De meeste formuliervelden ondersteunen een + :ref:`validatie-optie ` om het veld verplicht te + maken. Deze kan echter soms (om juridische redenen) niet gebruikt worden omdat een + gebruiker de aanvraag móet kunnen insturen en de organisatie verplicht is om + deze te beoordelen. Het is dan netjes om de gebruiker te kunnen wijzen op eventuele + kosten en gevolgen van het niet aanleveren van alle uitgevraagde gegevens. + +Formulierconfiguratie +===================== + +.. note:: deze documentatie gaat ervan uit dat je bekend met de basis van + :ref:`formulieren beheren `. + +Het is belangrijk dat je in de betreffende formulierstap(pen) een component toevoegt +die de foutmeldingen weergeeft, anders krijgt de gebruiker geen feedback van eventuele +ontbrekende gegevens. + +Voor elke relevante formulierstap: + +1. Sleep zoals je gewend bent de velden uit het menu aan de linkerkant, en stel de + relevante configuraties in. +2. In het instellingenscherm, klik op de "Validatie"-tab. +3. Schakel vervolgens het selectievakje "Aangeraden (niet-blokkerend verplicht)" in. + Indien je deze niet kan aanvinken, controleer dan dat de optie "Verplicht" uitgevinkt + is - een veld kan namelijk niet tegelijk blokkerend en niet-blokkerend verplicht zijn. +4. Sla de veldinstellingen op. +5. Herhaal stap 1 tot en met 4 voor alle benodigde velden. +6. Klik in het menu aan de linkerkant de categorie "Opmaak" open. +7. Sleep het component "Foutmeldingen aangeraden velden" in de formulierstap. + + * De inhoud zal enkel getoond worden als er "aangeraden velden" een lege waarde + hebben. + * Je kan het bericht voor de gebruiker naar wens instellen. Hierin kan je de + sjabloonvariabele ``{{ missingFields }}`` gebruiken die getoond wordt als lijst + van veld-labels met ontbrekende waarde. + * Andere sjabloonvariabelen of -uitdrukkingen kunnen niet gebruikt worden. + * Je kan hier ook vertalingen toepassen. + +Ondersteunde velden +=================== + +De velden die "Aangeraden (niet-blokkerend verplicht)"-validatie ondersteunen zijn: + +* Bestandsupload + +Neem contact op indien je deze functionaliteit ook bij andere veldsoorten wenst.