Skip to content

Commit

Permalink
📝 [#4546] Document soft-required validation mechanism and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
sergei-maertens committed Oct 14, 2024
1 parent dc8ec36 commit ddef897
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/manual/forms/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <manual_form_fields>` en naar de
:ref:`formuliervelden <manual_form_fields>` en naar de
:ref:`voorbeelden <manual_examples>`.

Bevestiging
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/forms/form_fields.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Validatie
---------

* **Verplicht**: Indien aangevinkt dan is dit veld verplicht voor de
eindgebruiker.
eindgebruiker. Sommige velden ondersteunen :ref:`niet-blokkerende verplichting <manual_forms_soft_required_fields>`.

* **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
Expand Down
1 change: 1 addition & 0 deletions docs/manual/forms/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
56 changes: 56 additions & 0 deletions docs/manual/forms/soft_required_fields.rst
Original file line number Diff line number Diff line change
@@ -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 <manual_form_fields_validation>` 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 <manual_forms_basics>`.

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.

0 comments on commit ddef897

Please sign in to comment.