From e2e195aecd545bc64e7b547cad5877d8c856f3fd Mon Sep 17 00:00:00 2001 From: andersonjeccel <116097999+andersonjeccel@users.noreply.github.com> Date: Tue, 5 Mar 2024 14:37:36 -0300 Subject: [PATCH 1/8] Update custom_fields.rst --- docs/contacts/custom_fields.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contacts/custom_fields.rst b/docs/contacts/custom_fields.rst index 06d4bf98..50290c10 100644 --- a/docs/contacts/custom_fields.rst +++ b/docs/contacts/custom_fields.rst @@ -65,10 +65,10 @@ It's important to note that from Mautic 5, you won't be able to edit the default * City -Published fields +Available fields ***************** -There is a toggle switch which shows before each label title. You can find this type of switch throughout the Mautic UI for publishing and unpublishing items. +Each label title is preceded by a toggle switch, commonly found across the Mautic UI, to toggle item availability. .. only:: html @@ -100,7 +100,7 @@ There is a way around this when you configure the processing of field creation i Since :xref:`Mautic 3` there is an option you can set in your ``app/config/local.php`` file: ``'create_custom_field_in_background' => true``,. -If you configure this option, the new Custom Field becomes visible in the list of Custom Fields. The Custom Field remains unpublished until you run the command ``bin/console mautic:custom-field:create-column``. This command creates the actual column in the table and publishes the field metadata. +If you configure this option, the new Custom Field becomes visible in the list of Custom Fields. The Custom Field remains unavailable for use until you run the command ``bin/console mautic:custom-field:create-column``. This command creates the actual column in the table and the field metadata. This configuration helps prevent **http** request timeouts because it handles the long-running SQL query to create the new table column as a background task. From 1f09c469733fb602a887292e77d05130255248e5 Mon Sep 17 00:00:00 2001 From: andersonjeccel <116097999+andersonjeccel@users.noreply.github.com> Date: Wed, 8 May 2024 18:21:27 -0300 Subject: [PATCH 2/8] available --- docs/categories/categories-overview.rst | 2 +- docs/channels/sms.rst | 8 ++++---- docs/components/assets.rst | 10 +++++----- docs/components/dynamic_web_content.rst | 6 +++--- docs/components/forms.rst | 8 ++++---- docs/configuration/cron_jobs.rst | 2 +- docs/reports/reports.rst | 2 +- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/categories/categories-overview.rst b/docs/categories/categories-overview.rst index 4f570a59..1ff8c433 100644 --- a/docs/categories/categories-overview.rst +++ b/docs/categories/categories-overview.rst @@ -25,7 +25,7 @@ To create new Categories, go to settings menu in the top right corner of Mautic. .. vale off -When creating a new Category you can select type, title, description, alias, color and published status. The color will be helpful to quickly find Mautic elements by their appropriate Category when viewing things like the Calendar or other areas within Mautic. +When creating a new Category you can select type, title, description, alias, color and available status. The color will be helpful to quickly find Mautic elements by their appropriate Category when viewing things like the Calendar or other areas within Mautic. Using Categories for Contacts ****************************** diff --git a/docs/channels/sms.rst b/docs/channels/sms.rst index ed45b415..fc41f785 100644 --- a/docs/channels/sms.rst +++ b/docs/channels/sms.rst @@ -77,7 +77,7 @@ The following fields are available: **Language** - This allows you to set the language of this Text Message. -**Published** - This allows you to set the published status of the Text Message. Unpublished Text Messages aren't sent. +**Available** - This allows you to set the availability status of the Text Message. Unavailable Text Messages aren't sent. .. vale off @@ -104,15 +104,15 @@ The following fields are available: **Language** - This allows you to set the language of this Text Message. -**Published** - This allows you to set the published status of the Text Message. Unpublished Text Messages aren't sent. +**Available** - This allows you to set the availability status of the Text Message. Unavailable Text Messages aren't sent. **Contact Segment** - This allows you to define the Segment/s who should receive the Text Message. .. vale off -**Publish at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts +**Enable at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts -**Unpublish at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts. +**Disable at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts. Creating Text Messages from Campaign Builder ============================================ diff --git a/docs/components/assets.rst b/docs/components/assets.rst index 56691901..30352bff 100644 --- a/docs/components/assets.rst +++ b/docs/components/assets.rst @@ -22,7 +22,7 @@ Working with Assets .. vale on -Before creating an Asset, first establish and publish any Categories required. It's not possible to assign Assets to unpublished Categories. If you wish to use an Integration such as the Amazon S3 Plugin to host your files, set this up before creating an Asset. +Before creating an Asset, first establish and create any Categories required. It's not possible to assign Assets to unavailable Categories. If you wish to use an Integration such as the Amazon S3 Plugin to host your files, set this up before creating an Asset. .. vale off @@ -77,13 +77,13 @@ The following fields are available: - **Description** - an internally used description to inform other Mautic Users what the Asset is and/or where it's used. - **Category** - used to organize resources - see :doc:`/categories/categories-overview` for more information - **Language** - the language of this Asset - can be helpful in multilingual marketing Campaigns and for reporting purposes -- **Published** - Whether the Asset is available for use - published - or not available - unpublished +- **Available** - Whether the Asset is available for use or not available .. vale off -**Publish at (date/time)** - This allows you to define the date and time at which this Asset is available +**Enable at (date/time)** - This allows you to define the date and time at which this Asset is available -**Unpublish at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available +**Disable at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available .. vale on @@ -141,7 +141,7 @@ Deleting an Asset It's possible to delete an Asset by clicking on the 'delete' button while viewing the Asset, or by selecting the arrow next to the checkbox for the Asset, and selecting 'delete'. Mautic displays a confirmation screen, prompting confirmation that you wish to delete the Asset. .. warning:: - Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to unpublish Assets which are no longer in use - in future there may be an archive feature. + Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to disable Assets which are no longer in use - in future there may be an archive feature. Display Assets directly in the browser ============================ diff --git a/docs/components/dynamic_web_content.rst b/docs/components/dynamic_web_content.rst index 4307b08c..47b591dc 100644 --- a/docs/components/dynamic_web_content.rst +++ b/docs/components/dynamic_web_content.rst @@ -81,7 +81,7 @@ The following values are available: - **Is a translation of** - If you're creating a slot in a second language translation - for example to use on a multilingual website - select the original base language Dynamic Web Content item which you're translating. The same slot displays the appropriate language based on the Campaign or filters set, but Mautic shows the translated content if a visitor is viewing the page in a different browser language. -- **Published** - Whether the Dynamic Web Content item is available for use - published - or not available - unpublished +- **Available** - Whether the Dynamic Web Content item is available for use or not available - **Is Campaign based** - if set to Yes, Mautic pushes this Dynamic Web Content to Contacts through a Campaign. When set to No, you can specify filters for visitors to see the content. @@ -89,9 +89,9 @@ The following values are available: .. vale off -**Publish at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts +**Enable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts -**Unpublish at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item ceases to be available for displaying to Contacts. +**Disable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item ceases to be available for displaying to Contacts. .. vale on diff --git a/docs/components/forms.rst b/docs/components/forms.rst index 8d472376..8ca5348a 100644 --- a/docs/components/forms.rst +++ b/docs/components/forms.rst @@ -24,13 +24,13 @@ The following fields are available: - **Category** - Assign a Category to help you organize your Forms. -- **Published** - Whether the Form is available for use - published - or not available - unpublished. Unpublished Forms won't be visible when you've added the Form using JavaScript. If you used the manual method to copy and paste the Form HTML, the Form remains visible but visitors **won't** be able to submit it - an error message prevents them from submitting if they try to submit an unpublished Form. +- **Available** - Whether the Form is available for use or not available. Unavailable Forms won't be visible when you've added the Form using JavaScript. If you used the manual method to copy and paste the Form HTML, the Form remains visible but visitors **won't** be able to submit it - an error message prevents them from submitting if they try to submit an unavailable Form. .. vale off -- **Publish at (date/time)** - This allows you to define the date and time at which this Form is available for submissions. +- **Enable at (date/time)** - This allows you to define the date and time at which this Form is available for submissions. -- **Unpublish at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions. +- **Disable at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions. .. vale on @@ -320,7 +320,7 @@ Typically you would use a Form action to populate static Segments - Segments whi .. vale on -- **Download an Asset**: this option triggers an immediate download of the selected file when the Contact submits the Form. If you use Categories to organize your Assets, you can elect to have them download the most recently published Asset in a selected Category. If you prefer, you can link to a specific Asset. +- **Download an Asset**: this option triggers an immediate download of the selected file when the Contact submits the Form. If you use Categories to organize your Assets, you can elect to have them download the most recently enabled Asset in a selected Category. If you prefer, you can link to a specific Asset. .. image:: images/forms/download_an_asset.png :width: 600 diff --git a/docs/configuration/cron_jobs.rst b/docs/configuration/cron_jobs.rst index 433d6f21..0819af5d 100644 --- a/docs/configuration/cron_jobs.rst +++ b/docs/configuration/cron_jobs.rst @@ -228,7 +228,7 @@ Send scheduled broadcasts (Segment Emails) cron job Starting with Mautic 2.2.0, it's now possible to use cron to send scheduled broadcasts for Channel communications. The current only implementation of this is for Segment Emails. Instead of requiring a manual send and wait with the browser window open while AJAX batches over the send, it's possible to use a command to initiate the process. -The caveat for this is that the Email must have a published up date and be currently published - this is to help prevent any unintentional Email broadcasts. Just as it was with the manual/AJAX process the message is only sent to Contacts who haven't already received the specific communication. This command sends messages to Contacts added to the source Segments later, so if you don't want this to happen, set an unpublish date. +The caveat for this is that the Email must have an enable date and be currently available - this is to help prevent any unintentional Email broadcasts. Just as it was with the manual/AJAX process the message is only sent to Contacts who haven't already received the specific communication. This command sends messages to Contacts added to the source Segments later, so if you don't want this to happen, set a disable date. .. code-block:: php diff --git a/docs/reports/reports.rst b/docs/reports/reports.rst index a3f9057f..f7966c43 100644 --- a/docs/reports/reports.rst +++ b/docs/reports/reports.rst @@ -86,7 +86,7 @@ The parent data source provides a high-level summary of the data while the child * **Description - optional** - Add detailed information about the Report, helping you and other Users better understand what the Report is for. You may want to include more information about filters, people, or departments. -* **Published** - Select **Yes** to ensure that the Report is active, ready to send when scheduled in the Report options. +* **Available** - Select **Yes** to ensure that the Report is active, ready to send when scheduled in the Report options. * **System Report** - Select **Yes** so that all Users can access the Report. If set to No, only the owner of the Report and Users with permission to view others' Reports can see the Report. From 1021252ae4b79be89f84593c5fbe4784662fcea5 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:09:44 -0300 Subject: [PATCH 3/8] Update docs/categories/categories-overview.rst Co-authored-by: Ruth Cheesley --- docs/categories/categories-overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/categories/categories-overview.rst b/docs/categories/categories-overview.rst index 1ff8c433..3e1b32ad 100644 --- a/docs/categories/categories-overview.rst +++ b/docs/categories/categories-overview.rst @@ -25,7 +25,7 @@ To create new Categories, go to settings menu in the top right corner of Mautic. .. vale off -When creating a new Category you can select type, title, description, alias, color and available status. The color will be helpful to quickly find Mautic elements by their appropriate Category when viewing things like the Calendar or other areas within Mautic. +When creating a new Category you can select type, title, description, alias, color and availability status. The color will be helpful to quickly find Mautic elements by their appropriate Category when viewing things like the Calendar or other areas within Mautic. Using Categories for Contacts ****************************** From d861fae5ad2aaffec9a9507f5b9421d923248f9a Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:09:52 -0300 Subject: [PATCH 4/8] Update docs/components/assets.rst Co-authored-by: Ruth Cheesley --- docs/components/assets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/assets.rst b/docs/components/assets.rst index 30352bff..0a34300f 100644 --- a/docs/components/assets.rst +++ b/docs/components/assets.rst @@ -141,7 +141,7 @@ Deleting an Asset It's possible to delete an Asset by clicking on the 'delete' button while viewing the Asset, or by selecting the arrow next to the checkbox for the Asset, and selecting 'delete'. Mautic displays a confirmation screen, prompting confirmation that you wish to delete the Asset. .. warning:: - Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to disable Assets which are no longer in use - in future there may be an archive feature. + Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to deactivate Assets which are no longer in use - in future there may be an archive feature. Display Assets directly in the browser ============================ From 1d0f1aecd6e711afb5e44f627842bc30bc2fd922 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:10:00 -0300 Subject: [PATCH 5/8] Update docs/components/assets.rst Co-authored-by: Ruth Cheesley --- docs/components/assets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/assets.rst b/docs/components/assets.rst index 0a34300f..aec94094 100644 --- a/docs/components/assets.rst +++ b/docs/components/assets.rst @@ -81,7 +81,7 @@ The following fields are available: .. vale off -**Enable at (date/time)** - This allows you to define the date and time at which this Asset is available +**Activate at (date/time)** - This allows you to define the date and time at which this Asset is available **Disable at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available From 03aa03d6d3061383e182bf188c563a6a7c9618cd Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:10:40 -0300 Subject: [PATCH 6/8] Update docs/components/assets.rst Co-authored-by: Ruth Cheesley --- docs/components/assets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/assets.rst b/docs/components/assets.rst index aec94094..0daf37dc 100644 --- a/docs/components/assets.rst +++ b/docs/components/assets.rst @@ -83,7 +83,7 @@ The following fields are available: **Activate at (date/time)** - This allows you to define the date and time at which this Asset is available -**Disable at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available +**Deactivate at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available .. vale on From 8a10a6902a92352a342145c69ff9410eddd3d0d9 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:11:02 -0300 Subject: [PATCH 7/8] Update docs/components/forms.rst Co-authored-by: Ruth Cheesley --- docs/components/forms.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/forms.rst b/docs/components/forms.rst index 8ca5348a..821aa491 100644 --- a/docs/components/forms.rst +++ b/docs/components/forms.rst @@ -28,7 +28,7 @@ The following fields are available: .. vale off -- **Enable at (date/time)** - This allows you to define the date and time at which this Form is available for submissions. +- **Activate at (date/time)** - This allows you to define the date and time at which this Form is available for submissions. - **Disable at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions. From 62f0dfd59f8bfe9007ca67bbde8a0299f83a6948 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 14 Jun 2024 08:11:42 -0300 Subject: [PATCH 8/8] Update docs/components/forms.rst Co-authored-by: Ruth Cheesley --- docs/components/forms.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/forms.rst b/docs/components/forms.rst index 821aa491..7e473993 100644 --- a/docs/components/forms.rst +++ b/docs/components/forms.rst @@ -30,7 +30,7 @@ The following fields are available: - **Activate at (date/time)** - This allows you to define the date and time at which this Form is available for submissions. -- **Disable at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions. +- **Deactivate at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions. .. vale on