Skip to content

Commit

Permalink
Merge branch '5.x' into UX-Reorder-administration-panel
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley authored Jun 18, 2024
2 parents fc1f52b + 0bd7670 commit c3a72cb
Show file tree
Hide file tree
Showing 21 changed files with 137 additions and 100 deletions.
6 changes: 5 additions & 1 deletion .github/styles/Mautic/FeatureList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ swap:
point groups: Point Groups
plugin: Plugin
plugins: Plugins
publish: Activate or Turn On
published: Active or Available
report: Report
reports: Reports
role: Role
Expand All @@ -59,7 +61,9 @@ swap:
stages: Stages
theme: Theme
themes: Themes
unpublish: Deactivate or Turn Off
unpublished: Unavailable or Deactivated
user: User
users: Users
webhook: Webhook
webhooks: Webhooks
webhooks: Webhooks
4 changes: 2 additions & 2 deletions docs/campaigns/creating_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Creating Campaigns

.. vale on
Creating Campaigns is a central part of the marketing automation process. When you create a new Campaign, you perform the basic administrative tasks such as choosing a name for the Campaign, creating a description, assigning a Category and defining publishing information for the Campaign.
Creating Campaigns is a central part of the marketing automation process. When you create a new Campaign, you perform the basic administrative tasks such as choosing a name for the Campaign, creating a description, assigning a Category and defining activating information for the Campaign.

At the heart of any marketing automation Campaign is the Campaign Builder. This allows you to specify how Contacts enter the Campaign, and what happens at every point after they enter the workflow.

Expand Down Expand Up @@ -51,7 +51,7 @@ To begin creating Campaigns, perform the following steps:

- **Category** - Choose a Category to assign your Campaign to. Categories help you organize your Campaigns. To learn more about creating and managing Categories, see :doc:`/categories/categories-overview`.
- **Allow Contacts to restart the Campaign** - Click the toggle switch to allow Contacts to restart the Campaign if you're building a Campaign for a recurring message - for example birthdays, subscriptions - or transactional operations - for example activity notifications, updating data. Enabling this option allows Contacts to go through the same Campaign multiple times.
- **Published** - Click the toggle switch to publish or un-publish the Campaign. Ensure that you don't publish a Campaign until you're actually ready for it to go live. You can also schedule to publish or un-publish a Campaign at a future date by selecting a time and date.
- **Active** - Click the toggle switch to turn the Campaign on or off. Ensure that you don't activate a Campaign until you're actually ready for it to go live. You can also schedule to activate or deactivate a Campaign at a future date by selecting a time and date.

#. Click **Launch Campaign Builder** to start building your Campaign, and add at least one event. For information about how to use the
Campaign Builder, see :doc:`/campaigns/creating_campaigns`.
Expand Down
2 changes: 1 addition & 1 deletion docs/campaigns/managing_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following image shows a sample Campaign overview with its highlighted panels
:width: 600
:alt: Screenshot showing the Campaign overview

The **Details** drop-down menu gives a quick overview of the most important information about your Campaign. This information includes the name of the User who created the Campaign, Category of the Campaign, creation date and time, publishing date and time, Contact Segments in your Campaign and more.
The **Details** drop-down menu gives a quick overview of the most important information about your Campaign. This information includes the name of the User who created the Campaign, Category of the Campaign, creation date and time, activating date and time, Contact Segments in your Campaign and more.

The **Campaign Statistics** panel shows the number of Contacts added to the Campaign over the specified period of time in graphical format. To specify the time period, use the From and To date selectors, and click Apply.

Expand Down
8 changes: 4 additions & 4 deletions docs/channels/focus_items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,13 +154,13 @@ When creating a new Focus Item, you can set the following fields:

**Category** - Assign a Category to help you organize your Focus Items.

**Published** - Whether the Focus Item is available for use - published - or not available - unpublished
**Active** - Whether the Focus Item is available for use - active - or not available - inactive.

.. 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
**Activate 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.
**Deactivate 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.

.. vale on
Expand Down Expand Up @@ -195,7 +195,7 @@ You can use the menu on the sidebar to configure the Focus Item to your liking.
Using Focus Items
*****************

Once you have created your Focus Item, you're ready to publish it to your website. If you're not quite ready for the Focus Item to go live but you need to get it set up on your website, you can set the Focus Item to Unpublished.
Once you have created your Focus Item, you're ready to activate it to your website. If you're not quite ready for the Focus Item to go live but you need to get it set up on your website, set the Focus Item to inactive.

Deploying to a website
======================
Expand Down
12 changes: 6 additions & 6 deletions docs/channels/social_monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ When selecting the Twitter Mention monitoring method, the following fields are a

There are also the standard Mautic fields available:

**Published** - This allows you to set the published status of the Social Monitor. Unpublished Social Monitors won't collect new Contacts.
**Active** - This allows you to set the activation status of the Social Monitor. Deactivated Social Monitors won't collect new Contacts.

.. vale off
**Publish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. You might use this to coincide with an event, for example.
**Activate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. You might use this to coincide with an event, for example.

**Unpublish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts.
**Deactivate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts.

.. vale on
Expand All @@ -69,13 +69,13 @@ When selecting the Twitter Hashtags monitoring method, the following fields are

There are also the standard Mautic fields available:

**Published** - This allows you to set the published status of the Social Monitor. Unpublished Social Monitors won't collect new Contacts.
**Active** - This allows you to set the activation status of the Social Monitor. Deactivated Social Monitors won't collect new Contacts.

.. vale off
**Publish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. This might be used to coincide with an event, for example.
**Activate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. This might be used to coincide with an event, for example.

**Unpublish at (date/time)** - This allows you to define the date and time at which this Social Monitor ceases to monitor for new Contacts.
**Deactivate at (date/time)** - This allows you to define the date and time at which this Social Monitor ceases to monitor for new Contacts.

.. vale on
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/command_line_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ These are the commands you may need to use in relation to your Mautic instance.
- Rebuild Campaigns based on Contact Segments.
- ``mautic:campaigns:update``
* - ``mautic:campaigns:trigger``
- Trigger timed events for published Campaigns.
- Trigger timed events for active Campaigns.
-
* - ``mautic:campaigns:validate``
- Validate if a Contact has been inactive for a decision and execute events if so.
Expand Down
19 changes: 0 additions & 19 deletions docs/configuration/cron_jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,22 +377,3 @@ Example output
If you have SSH access, try to run the command directly to Select for errors. If there is nothing printed from either in a SSH session or in the cron output, verify in the server's logs. If you see similar errors to ``'Warning: Invalid argument supplied for foreach()' in /vendor/symfony/console/Symfony/Component/Console/Input/ArgvInput.php:287``, you either need to use ``php-cli`` instead of ``php`` or try using ``php -d register_argc_argv=On``. `

Tracking script
###############

After installation and setup of the :doc:`/configuration/cron_jobs` you're ready to begin tracking Contacts. You need to add a piece of JavaScript to the websites for each site you wish to track through Mautic.

This is straightforward process, you can add this tracking script to your website template file, or install a Mautic Integration for the more common Content Management System platforms.

Here is an example of the tracking JavaScript which you can access by clicking on **Tracking Settings** in the Global Configuration.


.. code-block:: javascript
(function(w,d,t,u,n,a,m){w['MauticTrackingObject']=n;
w[n]=w[n]||function(){(w[n].q=w[n].q||[]).push(arguments)},a=d.createElement(t),
m=d.getElementsByTagName(t)[0];a.async=1;a.src=u;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://example.com/mautic/mtc.js','mt');
mt('send', 'pageview');
You should replace the site URL, ``example.com/mautic`` with the URL to your Mautic instance in the example provided, but it's recommended to copy the whole code block from the tracking settings in your Mautic instance.
6 changes: 3 additions & 3 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ Unsubscribe settings

* **Show Contact preference settings** - Select **Yes** to direct the unsubscribe link to your configured Preference enter. If you haven't created a Preference Center, Mautic creates a default page based on the next 5 settings. The created page uses the default Theme for styling.

* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center page. Segments won't display on the Preference Center page if they aren't published and public.
* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center. Segments won't display on the Preference Center if they aren't active and public.

* **Show Contact frequency preferences** - Select **Yes** to allow an individual to limit the number of Marketing Messages they receive on each Channel from the Preference Center.

Expand Down Expand Up @@ -620,9 +620,9 @@ Notification settings
:width: 600
:alt: Screenshot showing Webhook Notification Settings Configuration in Mautic

If a Campaign or Webhook is automatically unpublished because of a high volume of errors, Mautic sends a notification alerting Users.
If a Campaign or Webhook is automatically deactivated because of a high volume of errors, Mautic sends a notification alerting Users.

* **Send notification to author** - Set this field to Yes to send an Email notification to the User who created the unpublished Campaign or Webhook. Deleted Users don't receive notifications.
* **Send notification to author** - Set this field to Yes to send an Email notification to the User who created the deactivated Campaign or Webhook. Deleted Users don't receive notifications.

.. vale off
Expand Down
23 changes: 23 additions & 0 deletions docs/configuration/tracking_script.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. vale off
Tracking script
###############

.. vale on
After installation and setup of the :doc:`/configuration/cron_jobs` you're ready to begin tracking Contacts. You need to add a piece of JavaScript to the websites for each site you wish to track through Mautic.

This is straightforward process, you can add this tracking script to your website template file, or install a Mautic Integration for the more common Content Management System platforms.

Here is an example of the tracking JavaScript which you can access by clicking on **Tracking Settings** in the Global Configuration.


.. code-block:: javascript
(function(w,d,t,u,n,a,m){w['MauticTrackingObject']=n;
w[n]=w[n]||function(){(w[n].q=w[n].q||[]).push(arguments)},a=d.createElement(t),
m=d.getElementsByTagName(t)[0];a.async=1;a.src=u;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://example.com/mautic/mtc.js','mt');
mt('send', 'pageview');
You should replace the site URL, ``example.com/mautic`` with the URL to your Mautic instance in the example provided, but it's recommended to copy the whole code block from the tracking settings in your Mautic instance.
6 changes: 3 additions & 3 deletions docs/contacts/import_contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,13 @@ How to stop a background import

2. In the top right corner of the Contacts page, open the sub menu of actions and select the :ref:`Import History<import job list>` option.

3. Unpublish the import job you want to stop. The import changes :ref:`status<import job status>` to Stopped. It finishes importing the current batch and then stops.
3. Deactivate the import job you want to stop. The import changes :ref:`status<import job status>` to Stopped. It finishes importing the current batch and then stops.

4. To start the import again, publish it, and the background job continues with the next :doc:`cron job execution</configuration/cron_jobs>`.
4. To start the import again, activate it, and the background job continues with the next :doc:`cron job execution</configuration/cron_jobs>`.

.. image:: images/import-publish.png
:align: center
:alt: Screenshot of Import publish
:alt: Screenshot of Import activation

|
Expand Down
2 changes: 1 addition & 1 deletion docs/contacts/manage_contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Add new Contact

|
This opens the new Contact screen, where you can enter all the information you have about the Contact. It also displays all published Contact fields when creating a new Contact.
This opens the new Contact screen, where you can enter all the information you have about the Contact. It also displays all available Contact fields when creating a new Contact.

Use the tabs at the top to populate existing Custom Fields and social network profiles.

Expand Down
Loading

0 comments on commit c3a72cb

Please sign in to comment.