Skip to content

Commit

Permalink
fix vale errors pt.8
Browse files Browse the repository at this point in the history
Signed-off-by: Priyanshi Gaur <[email protected]>
  • Loading branch information
nox1134 committed Apr 23, 2024
1 parent ec6d0e4 commit 3204e6e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/components/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -279,20 +279,20 @@ Progressive profiling is a powerful feature used to reduce the length of Forms b
Configuration
==============

There are two ways to configure a Form Field to only display when the asked values are unknown.
There are two ways to configure a Form field to only display when the asked values are unknown.

Check warning on line 282 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form Field' instead of 'Form field'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form Field' instead of 'Form field'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 282, "column": 35}}}, "severity": "INFO"}

First, choose the Form that you want to use for progressive profiling. Go to the Form Fields and open the field configuration of the field you want to use for progressive profiling. Change to the Behavior tab. Here, you can configure the behavior of the fields.
First, choose the Form that you want to use for progressive profiling. Go to the Form fields and open the field configuration of the field you want to use for progressive profiling. Change to the Behavior tab. Here, you can configure the behavior of the fields.

Check warning on line 284 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form Fields' instead of 'Form fields'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form Fields' instead of 'Form fields'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 284, "column": 82}}}, "severity": "INFO"}

.. note::
It's always recommended to use the Email field, even if it's already known because Mautic uses the Email as a unique identifier for Contacts. Additionally, ensure the submit button field is always visible. Otherwise, the Contact can't submit the Form.
It's always recommended to use the Email field, even if it's already known, because Mautic uses the Email as a unique identifier for Contacts. Additionally, ensure the submit button field is always visible. Otherwise, the Contact can't submit the Form.

1. **Show when value exists**:
if set to 'No,' Mautic checks whether the value for this field exists in the database or was provided in a former Form submission. If a value is found, Mautic won't display the field in the Form. If set to 'Yes,' Mautic displays the field regardless of whether a value is found or not. The default configuration for this option is 'Yes'.
if set to 'No,' Mautic checks whether the value for this field exists in the database or if a previous Form submission provided it. If found, Mautic won't display the field in the Form. If set to 'Yes,' Mautic displays the field regardless of the existence of a value in the field. The default configuration for this option is 'Yes'.

2. **Display field only after X submissions**:
if you have a Form that you'd like to use multiple times, with more fields appearing the more times a Contact fills it out, while still using only a single Form, the option 'Display field only after X submissions' is what you're looking for. As the name suggests, the field appears only after the Form has received X submissions. This feature pairs well with the ability to hide fields if the value is already known.

For example, on the first time the Form is filled out, it asks for the Email, first, and last name of a Contact. When the Contact fills out the Form a second time, it hides the first and last name fields, and instead, it prompts the Contact to fill in their Company and phone.
For example, on the first time of completing the Form, it asks for the Email, first, and last name of a Contact. When the Contact fills out the Form a second time, it hides the first and last name fields, and instead, it prompts the Contact to fill in their Company and phone.

.. vale off
Expand All @@ -302,7 +302,7 @@ Limits of Progressive Profiling
**The search history limit**

Mautic Forms which don't use progressive profiling are as fast as they can be. The HTML of the Form renders once, gets stored, and Mautic uses this "cached" HTML for the next Form load. When a progressive profiling configuration is turned on for any of the Form Fields, the Form HTML might be different for each Contact. It can even change for each Contact after each submission. The impact of this is that Form-caching can't be used, and the Form load time will be slower for a progressive profiling Forms.
Mautic Forms which don't use progressive profiling are as fast as they can be. The HTML of the Form renders once, gets stored, and Mautic uses this "cached" HTML for the next Form load. When turning on progressive profiling for any of the Form Fields, the Form HTML might be different for each Contact. It can even change for each Contact after each submission. The impact of this is that you can't use Form-caching, and the Form load time is slower for a progressive profiling Form.

Mautic imposed a limit of 200 submissions from which it searches for existing Form values. This limit aims to prevent possible long Form loading times or hitting the server time or memory limits when a Contact has several thousand Form submissions. Exceeding this limit might cause Mautic to display/hide the wrong fields for a Contact.

Expand All @@ -312,7 +312,7 @@ Progressive Profiling Forms don't function if you embed your Form as static HTML

**The kiosk mode limit**

When you switch the Form to Kiosk Mode, the Progressive Profiling features are turn off. In Kiosk Mode, the Form always creates a new Contact upon each submission and doesn't track the device from which the Form was submitted.
When you switch the Form to Kiosk Mode, the Progressive Profiling features are turn off. In Kiosk Mode, the Form always creates a new Contact upon each submission and doesn't track the device submitting the Form.

Form actions
************
Expand Down

0 comments on commit 3204e6e

Please sign in to comment.