Skip to content

Commit

Permalink
fix vale errors
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 7ed7fbf commit cd8a344
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/components/forms.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,20 +274,20 @@ Progressive profiling
*********************
.. vale on
Progressive profiling is a powerful feature used to reduce the length of forms by hiding all the fields which are already known. This will prevent your contacts from feeling overwhelmed by massive forms and will even reduce the time it takes to fill out a form if fields are already known to your Mautic instance and thus are hidden for the contact.
Progressive profiling is a powerful feature used to reduce the length of Forms by hiding all the fields that are already known. This prevents your Contacts from feeling overwhelmed by massive forms and even reduces the time it takes to fill out a Form if fields are already known to your Mautic instance and thus hidden for the Contact.

Check warning on line 277 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 'Forms' instead of 'forms'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Forms' instead of 'forms'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 277, "column": 193}}}, "severity": "INFO"}

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.

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 behaviour 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' instead of 'form'.

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

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Semicolons] Use semicolons judiciously.

Raw Output:
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 284, "column": 209}}}, "severity": "INFO"}

.. note::
We recommend to always use the email field, even though it might already be known, because Mautic uses the email as a unique identifier for contacts. Also the submit button field must be always visible because otherwise the form can not 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.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 3}}}, "severity": "WARNING"}

Check warning on line 287 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 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 34}}}, "severity": "INFO"}

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 known').

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

Check warning on line 287 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 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 110}}}, "severity": "INFO"}

Check warning on line 287 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 'Contacts' instead of 'contacts'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 143}}}, "severity": "INFO"}

Check warning on line 287 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' instead of 'form'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form' instead of 'form'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 287, "column": 227}}}, "severity": "INFO"}

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": 240}}}, "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 a value is found, the field won't be displayed in the form. If this option is set to "Yes", Mautic will show the field, regardless 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 a value is found, the field won't be displayed in the form. If this option is set to 'Yes' Mautic will show the field, regardless of whether a value is found or not. The default configuration for this option is 'Yes'.

2. **Display field only after X submissions**:
If you have a form that you would like to use multiple times, with more fields occuring the more times a contact fills it out, while still only using a single form, the option "Display field only after X submissions" is what you are looking for. As the name already states, the field will only appear once the form hast been submitted X times. This goes hand in hand very well with the ability to hide fields if the value is already known.
Expand Down

0 comments on commit cd8a344

Please sign in to comment.