From 86990faa25413c7226b73ba57e6b9b8f5c911042 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Tue, 16 Apr 2024 12:05:57 +0000 Subject: [PATCH 1/4] Added Stop Engaging After Focus --- docs/channels/focus_items.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/channels/focus_items.rst b/docs/channels/focus_items.rst index 64e64d24..70a38e89 100644 --- a/docs/channels/focus_items.rst +++ b/docs/channels/focus_items.rst @@ -1,7 +1,7 @@ Focus Items ########### -Focus items allow you to engage Users on your site through bars, modals, notifications, popups, and light boxes. It's possible to initiate Focus Items at different times and with different actions such as exit intent. +Focus Items allow you to engage Users on your site through bars, modals, notifications, popups, and light boxes. It's possible to initiate Focus Items at different times and with different actions such as exit intent. You can find Focus Items listed under the Channels menu. @@ -49,6 +49,7 @@ For each type of Focus Item, there are settings to configure which control the t - **Once per hour** - Show the Focus Item once every hour that the visitor is on your website - **Once per day** - Show the Focus Item once per day that the visitor is on your website - **Stop engaging after a conversion** - This option is only available for the types which track a conversion (Collect Data and Emphasize a Link). If set to Yes, the Focus Item no longer displays if the visitor has either submitted the Form (Collect Data type) or clicked on the link (Emphasize a Link type). +- **Stop Engaging After Focus** - This option is available for focus items and is based on cookies. If set to Yes, the focus item will no longer be displayed to the visitor after they have interacted with it, until they clear their cookies. .. vale on @@ -93,7 +94,7 @@ Visitors can choose to close this type of Focus Item with the *X* button in the Full page ~~~~~~~~~ -The full page Focus Item completely takes over the whole page, hiding the rest of the page content until the visitor clicks the *X* button in the top right hand corner of the Focus Item. +The full page Focus Item completely takes over the whole page, hiding the page content until the visitor clicks the *X* button in the top right hand corner of the Focus Item. There are no additional configuration options for this style of Focus Item. @@ -127,7 +128,7 @@ This editor mode allows a simplified experience with a few fields - depending on - **Select the Form to insert** - This option is only available for Collect Data Focus Item types. It allows you to select an existing Mautic Form to use with the Focus Item. For styling and formatting reasons, you may want to create a Form specifically for the Focus Item, adding styling attributes to the Attributes tab on the Form fields. - **Link text** - This option is only available for Emphasize a Link Focus Item types. It allows you to specify the text used on the Focus Item's button. - **Link URL** - This option is only available for Emphasize a Link Focus Item types. It allows you to specify the URL where you'd like to drive visitors with the Focus Item. -- **Open in a new window** - This option is only available for Emphasize a Link Focus Item types. If set to Yes, this ensures that the link is opened in a new window. If set to No, the link opens in the current tab. +- **Open in a new window** - This option is only available for Emphasize a Link Focus Item types. If set to Yes, this ensures that the link opens in a new window. If set to No, the link opens in the current tab. Editor ~~~~~~ @@ -167,7 +168,7 @@ When creating a new Focus Item, you can set the following fields: .. vale on -**Google Analytics UTM tags** - Mautic supports UTM tagging in Emails, Focus Items, and Landing Pages. Any UTM tags with values populated are automatically appended to the end of any links used in the focus item. See :doc:`/channels/utm_tags` for more information. +**Google Analytics UTM tags** - Mautic supports UTM tagging in Emails, Focus Items, and Landing Pages. Any UTM tags with values populated are automatically appended to the end of any links used in the Focus Item. See :doc:`/channels/utm_tags` for more information. .. image:: images/focus_items/focus_item_create.png :width: 400 @@ -180,7 +181,7 @@ Using the Focus Item builder .. vale on -After you specify the general information for the Focus Item, click the builder option in the top right corner. If you've specified a URL in the Website field on the details page, the system displays a preview. If you don't see a preview, the website might block iframe previews. Hence, you may need to add the focus item to a development or staging environment without these security restrictions - if available - to see the preview. +After you specify the general information for the Focus Item, click the builder option in the top right corner. If you've specified a URL in the Website field on the details page, the system displays a preview. If you don't see a preview, the website might block iframe previews. Hence, you may need to add the Focus Item to a development or staging environment without these security restrictions - if available - to see the preview. .. note:: The preview of the website doesn't appear until you select a style from the options on the Focus Item Builder. @@ -203,11 +204,11 @@ Once you have created your Focus Item, you're ready to publish it to your websit Deploying to a website ====================== -When you save the Focus Item, the code snippet required to display it on your website is shown in a green box on the Focus Item overview. +When you save the Focus Item, Mautic shows the code snippet required to display it on your website in a green box on the Focus Item overview. .. image:: images/focus_items/focus_item_embed.png :width: 400 - :alt: Screenshot showing the Focus Item code to be embedded within a website. + :alt: Screenshot showing the Focus Item code to embed within a website. .. note:: You may need assistance from your web development team to implement the Focus Item tracking code on your website. @@ -233,6 +234,6 @@ Measuring success When using the Emphasize a Link type, Mautic displays the link on the Focus Item overview where you can view the number of unique clicks. -If you change the link in a Focus Item after deployment, all links are listed in the overview. +If you change the link in a Focus Item after deployment, Mautic lists all links in the overview. Additionally, Mautic applies UTM tags on Focus Items to both Form submissions and link clicks. If you are using a Focus Item to submit a Form, it's recommended that you have a Submit Action on the Form to record the UTM tags. \ No newline at end of file From 3ced37ff65047697f1801d426c2d0ae3c3b379ec Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Tue, 16 Apr 2024 12:08:20 +0000 Subject: [PATCH 2/4] fix caps --- docs/channels/focus_items.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/channels/focus_items.rst b/docs/channels/focus_items.rst index 70a38e89..1a04f7ff 100644 --- a/docs/channels/focus_items.rst +++ b/docs/channels/focus_items.rst @@ -49,7 +49,7 @@ For each type of Focus Item, there are settings to configure which control the t - **Once per hour** - Show the Focus Item once every hour that the visitor is on your website - **Once per day** - Show the Focus Item once per day that the visitor is on your website - **Stop engaging after a conversion** - This option is only available for the types which track a conversion (Collect Data and Emphasize a Link). If set to Yes, the Focus Item no longer displays if the visitor has either submitted the Form (Collect Data type) or clicked on the link (Emphasize a Link type). -- **Stop Engaging After Focus** - This option is available for focus items and is based on cookies. If set to Yes, the focus item will no longer be displayed to the visitor after they have interacted with it, until they clear their cookies. +- **Stop engaging after Focus** - This option is available for focus items and is based on cookies. If set to Yes, the focus item will no longer be displayed to the visitor after they have interacted with it, until they clear their cookies. .. vale on From 5be8a1fa93c36192dc6bf2879ddeb7b2861222b0 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Tue, 16 Apr 2024 12:29:09 +0000 Subject: [PATCH 3/4] remove vale off and fix comment --- docs/channels/focus_items.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/channels/focus_items.rst b/docs/channels/focus_items.rst index 1a04f7ff..f3182a88 100644 --- a/docs/channels/focus_items.rst +++ b/docs/channels/focus_items.rst @@ -31,8 +31,6 @@ For each type of Focus Item, there are settings to configure which control the t :width: 400 :alt: Screenshot showing the engagement settings for Focus Items. -.. vale off - - **Animate** - When set to Yes, this applies a slide-in animation to the Focus Item. When set to No, the item appears without any kind of sliding motion. - **When to engage** - This setting controls the Focus Item shows. There are several options: - **Upon arrival** - As soon as a visitor lands on the page @@ -49,9 +47,7 @@ For each type of Focus Item, there are settings to configure which control the t - **Once per hour** - Show the Focus Item once every hour that the visitor is on your website - **Once per day** - Show the Focus Item once per day that the visitor is on your website - **Stop engaging after a conversion** - This option is only available for the types which track a conversion (Collect Data and Emphasize a Link). If set to Yes, the Focus Item no longer displays if the visitor has either submitted the Form (Collect Data type) or clicked on the link (Emphasize a Link type). -- **Stop engaging after Focus** - This option is available for focus items and is based on cookies. If set to Yes, the focus item will no longer be displayed to the visitor after they have interacted with it, until they clear their cookies. - -.. vale on +- **Stop engaging after Focus** - This option is available for Focus items and uses cookies. If set to Yes, the focus item no longer displays to the visitor after they have interacted with it, until they clear their cookies. Styles ====== From 8703ab590d4346b267a55cde05f6e02720b6c608 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Tue, 16 Apr 2024 14:17:39 +0000 Subject: [PATCH 4/4] fix comment --- docs/channels/focus_items.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/channels/focus_items.rst b/docs/channels/focus_items.rst index f3182a88..34cdb5fd 100644 --- a/docs/channels/focus_items.rst +++ b/docs/channels/focus_items.rst @@ -47,7 +47,7 @@ For each type of Focus Item, there are settings to configure which control the t - **Once per hour** - Show the Focus Item once every hour that the visitor is on your website - **Once per day** - Show the Focus Item once per day that the visitor is on your website - **Stop engaging after a conversion** - This option is only available for the types which track a conversion (Collect Data and Emphasize a Link). If set to Yes, the Focus Item no longer displays if the visitor has either submitted the Form (Collect Data type) or clicked on the link (Emphasize a Link type). -- **Stop engaging after Focus** - This option is available for Focus items and uses cookies. If set to Yes, the focus item no longer displays to the visitor after they have interacted with it, until they clear their cookies. +- **Stop engaging after closing Focus** - This option is available for Focus Items and uses cookies. If set to Yes, the Focus Item no longer displays to the visitor after they have interacted with it, until they clear their cookies. Styles ======