Skip to content

Commit

Permalink
fix vale errors pt.6
Browse files Browse the repository at this point in the history 
Signed-off-by: Priyanshi Gaur <[email protected]>
  • Loading branch information
@nox1134
nox1134 committed Apr 22, 2024
1 parent 0e672dc commit f5762bb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/components/forms.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,10 +284,10 @@ There are two ways to configure a Form Field to only display when the asked valu
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.

.. 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, the submit button field must always be visible; otherwise, the Form can't be submitted by the Contact.
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, the submit button field must always be visible. Otherwise, the Form can't be submitted by the Contact.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be submitted').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be submitted').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 233}}}, "severity": "INFO"}

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

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is set').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 290, "column": 16}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('was provided').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was provided').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 290, "column": 113}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is set').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 290, "column": 243}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is found').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is found').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 290, "column": 314}}}, "severity": "INFO"}

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 been submitted X times. This feature pairs well with the ability to hide fields if the value is already known.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('been submitted').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('been submitted').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 293, "column": 307}}}, "severity": "INFO"}
Expand All @@ -302,7 +302,7 @@ Limits of Progressive Profiling
**The search history limit**

Mautic Forms, which don't use progressive profiling, operate at their maximum speed. The HTML of the Form renders once, gets stored, and this 'cached' HTML is utilized for subsequent Form loads. However, when progressive profiling configuration is enabled for any of the Form fields, the Form HTML might differ for each Contact. It could even change for each Contact after every submission. Consequently, Form caching can't be utilized, leading to slower Form load times for progressive profiling Forms.
Mautic Forms, which don't use progressive profiling, operate at their maximum speed. The HTML of the Form renders once, gets stored, and this 'cached' HTML is utilized for subsequent Form loads. However, when progressive profiling configuration is enabled for any of the Form Fields, the Form HTML might differ for each Contact. It could even change for each Contact after every submission. Consequently, Form caching can't be utilized, leading to slower Form load times for progressive profiling Forms.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is utilized').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is utilized').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 305, "column": 157}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is enabled').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is enabled').", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 305, "column": 246}}}, "severity": "INFO"}

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 Down

0 comments on commit f5762bb

Please sign in to comment.