Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds documentation for mautic/mautic/pull/14100 #317

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds documentation for mautic/mautic/pull/14100 #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/components/forms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@
.. note::
You can associate checkbox group fields with *boolean* and *select - multiple* fields, but not *select* fields.

- **Date** - This field allows the visitor to select a date with a calendar picker. The formatting of the date applies the default setting in your Configuration.
- **Date** - This field allows the visitor to select a date with a calendar picker. The formatting of the date applies the default setting in your Configuration. [A PHP parseable BNF-like string](https://www.php.net/manual/en/datetime.formats.php) can be used to set a dynamic/relative to now default value for this field.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 91, "column": 1}}}, "severity": "INFO"}

Check failure on line 91 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'parseable'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'parseable'?", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 91, "column": 173}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 91, "column": 183}}}, "severity": "INFO"}

Check warning on line 91 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 used').

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @putzwasser please use the command make link at the terminal, follow the steps and then use the xref macro here. For info, if you're doing internal linking check the docs on using the :ref: role for linking within the same document, and using :doc: to link across pages.

Please fix this in all the places you've mentioned it. Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Date** - This field allows the visitor to select a date with a calendar picker. The formatting of the date applies the default setting in your Configuration. [A PHP parseable BNF-like string](https://www.php.net/manual/en/datetime.formats.php) can be used to set a dynamic/relative to now default value for this field.
- **Date** - This field allows the visitor to select a date with a calendar picker. The formatting of the date applies the default setting in your Configuration. You can use [A PHP parseable BNF-like string](https://www.php.net/manual/en/datetime.formats.php) to set a dynamic/relative to now default value for this field.

Passive -> Active voice


- **Date/time** - Similar to the date field, this allows the visitor to select both the date and the time using a calendar picker.
- **Date/time** - Similar to the date field, this allows the visitor to select both the date and the time using a calendar picker. [A PHP parseable BNF-like string](https://www.php.net/manual/en/datetime.formats.php) can be used to set a dynamic/relative to now default value for this field.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 93, "column": 1}}}, "severity": "INFO"}

Check failure on line 93 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'parseable'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'parseable'?", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 93, "column": 142}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 93, "column": 152}}}, "severity": "INFO"}

Check warning on line 93 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 used').

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

- **Description** - A basic header field, most often used to provide a visual title for the Form. The header field acts as the field name or label. The description area - accessed under the Properties tab - is a free text WYSIWYG editor, where you can add a description of the Form. By default, the description shows immediately below the header field in paragraph text format.

Expand All @@ -103,7 +103,7 @@

- **HTML area** - This field allows marketers to add custom HTML to their Form.

- **Hidden** - This field won't be visible on the Form, but include default values, saved along with the Form submission, for reporting or internal tagging purposes.
- **Hidden** - This field won't be visible on the Form, but include default values, saved along with the Form submission, for reporting or internal tagging purposes. [A PHP parseable BNF-like string](https://www.php.net/manual/en/datetime.formats.php) can be used to set a dynamic/relative to now default value for this field. Unlike **Date** or **Date/time**, a **Hidden** field's default value must end with `|date` for dynamic date parsing to work (e.g., `now|date`).

Check failure on line 106 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'parseable'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'parseable'?", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 106, "column": 177}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'BNF', if it's unfamiliar to the audience.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 106, "column": 187}}}, "severity": "INFO"}

Check warning on line 106 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 used').

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

Check failure on line 106 in docs/components/forms.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.,'.

Raw Output:
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/components/forms.rst", "range": {"start": {"line": 106, "column": 456}}}, "severity": "ERROR"}

- **List - Country** - This populates Mautic's default, non-editable country list. To use a custom list you should make use of the Select field type and manually enter the countries you would like to include.

Expand Down Expand Up @@ -527,4 +527,4 @@
:width: 600
:alt: Screenshot showing domain blocking used in a Mautic Form

It's advised to provide a helpful message to display if the visitor tries to use an Email address from a blocked domain, to help them understand what the problem is.
It's advised to provide a helpful message to display if the visitor tries to use an Email address from a blocked domain, to help them understand what the problem is.
Loading