Display help icons for categories/subcategories (#17062)

* show help icons in left and display help messages on click

* pointless commit

* more fixes for when to show icon persistent

* More docs & more fixes.

* some fixes, more styling changes + UI test

* remove line breaks

* fix link

* update SecurityInfo plugin to latest

* apply more review feedback

* Adding help text + tweak to notification title bar.

* fix issues after review and make exception clearer

* update submodules

* Update CustomVariables submodule.

* fixing tests

* fix test

Co-authored-by: sgiehl <stefan@matomo.org>

5 files changed, 31 insertions, 1 deletions

diff --git a/plugins/Ecommerce/Categories/EcommerceLogSubcategory.php b/plugins/Ecommerce/Categories/EcommerceLogSubcategory.php
index e9e2db737f..fc0f0468b0 100644
--- a/plugins/Ecommerce/Categories/EcommerceLogSubcategory.php
+++ b/plugins/Ecommerce/Categories/EcommerceLogSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Ecommerce\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class EcommerceLogSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class EcommerceLogSubcategory extends Subcategory
     protected $id = 'Goals_EcommerceLog';
     protected $order = 5;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Ecommerce_EcommerceLogSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Ecommerce_EcommerceLogSubcategoryHelp2') . '</p>';
+    }
 }
diff --git a/plugins/Ecommerce/Categories/EcommerceOverviewSubcategory.php b/plugins/Ecommerce/Categories/EcommerceOverviewSubcategory.php
index 3226287e3f..42806a01b1 100644
--- a/plugins/Ecommerce/Categories/EcommerceOverviewSubcategory.php
+++ b/plugins/Ecommerce/Categories/EcommerceOverviewSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Ecommerce\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class EcommerceOverviewSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class EcommerceOverviewSubcategory extends Subcategory
     protected $id = 'General_Overview';
     protected $order = 2;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Ecommerce_EcommerceOverviewSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Ecommerce_EcommerceOverviewSubcategoryHelp2') . '</p>';
+    }
 }
diff --git a/plugins/Ecommerce/Categories/ProductSubcategory.php b/plugins/Ecommerce/Categories/ProductSubcategory.php
index 595f25a61d..8da3f23c3e 100644
--- a/plugins/Ecommerce/Categories/ProductSubcategory.php
+++ b/plugins/Ecommerce/Categories/ProductSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Ecommerce\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class ProductSubcategory extends Subcategory
 {
@@ -16,4 +17,8 @@ class ProductSubcategory extends Subcategory
     protected $id = 'Goals_Products';
     protected $order = 10;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Ecommerce_ProductSubcategoryHelp') . '</p>';
+    }
 }
diff --git a/plugins/Ecommerce/Categories/SalesSubcategory.php b/plugins/Ecommerce/Categories/SalesSubcategory.php
index 8345950b2c..4cf0a6fafb 100644
--- a/plugins/Ecommerce/Categories/SalesSubcategory.php
+++ b/plugins/Ecommerce/Categories/SalesSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Ecommerce\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class SalesSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class SalesSubcategory extends Subcategory
     protected $id = 'Ecommerce_Sales';
     protected $order = 15;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Ecommerce_SalesSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Ecommerce_SalesSubcategoryHelp2') . '</p>';
+    }
 }
diff --git a/plugins/Ecommerce/lang/en.json b/plugins/Ecommerce/lang/en.json
index e8cfa5ec1d..0dbc527612 100644
--- a/plugins/Ecommerce/lang/en.json
+++ b/plugins/Ecommerce/lang/en.json
@@ -17,6 +17,13 @@
         "LifeTimeValueDescription": "Total Ecommerce revenue attributed to this customer across all visits: the sum of revenue of all Ecommerce orders for Visitor ID %s.",
         "VisitorProfileLTV": "Generated a Life Time Revenue of %1$s.",
         "VisitorProfileItemsAndOrders": "Purchased %1$s items in %2$s ecommerce orders.",
-        "VisitorProfileAbandonedCartSummary": "Abandoned %1$s carts including %2$s items worth a total of %3$s."
+        "VisitorProfileAbandonedCartSummary": "Abandoned %1$s carts including %2$s items worth a total of %3$s.",
+        "EcommerceOverviewSubcategoryHelp1": "The Ecommerce Overview section is the best place to get a high-level view of your online store’s performance. At a glance, you can see how many sales you’re making, how much revenue you are generating, and your website’s conversion rate.",
+        "EcommerceOverviewSubcategoryHelp2": "Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.",
+        "SalesSubcategoryHelp1": "This section contains an extensive collection of reports to help you analyse the different conditions that most commonly lead to sales, such as the traffic and campaign sources, user time and location and devices used to access them.",
+        "SalesSubcategoryHelp2": "You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.",
+        "EcommerceLogSubcategoryHelp1": "The Ecommerce log provides granular session-level data so you can look at the full session for each user that either made a purchase or abandoned their cart. This can help you understand what users do before and after purchasing to reveal optimisation opportunities.",
+        "EcommerceLogSubcategoryHelp2": "Data on this page is updated in real-time.",
+        "ProductSubcategoryHelp": "The Products view can help you identify products and categories that are over-performing or under-performing to reveal trends and opportunities related to your product selection and store pages."
     }
 }
\ No newline at end of file