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>

8 files changed, 62 insertions, 1 deletions

diff --git a/plugins/Actions/Categories/DownloadsSubcategory.php b/plugins/Actions/Categories/DownloadsSubcategory.php
index 32943800b0..eb6aa01da4 100644
--- a/plugins/Actions/Categories/DownloadsSubcategory.php
+++ b/plugins/Actions/Categories/DownloadsSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class DownloadsSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class DownloadsSubcategory extends Subcategory
     protected $id = 'General_Downloads';
     protected $order = 35;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_DownloadsSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_DownloadsSubcategoryHelp2') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/EntryPagesSubcategory.php b/plugins/Actions/Categories/EntryPagesSubcategory.php
index 45609ae6db..8717173b5a 100644
--- a/plugins/Actions/Categories/EntryPagesSubcategory.php
+++ b/plugins/Actions/Categories/EntryPagesSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class EntryPagesSubcategory extends Subcategory
 {
@@ -16,4 +17,10 @@ class EntryPagesSubcategory extends Subcategory
     protected $id = 'Actions_SubmenuPagesEntry';
     protected $order = 10;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_EntryPagesSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_EntryPagesSubcategoryHelp2') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp3') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/ExitPagesSubcategory.php b/plugins/Actions/Categories/ExitPagesSubcategory.php
index 303a608102..594258cca4 100644
--- a/plugins/Actions/Categories/ExitPagesSubcategory.php
+++ b/plugins/Actions/Categories/ExitPagesSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class ExitPagesSubcategory extends Subcategory
 {
@@ -16,4 +17,10 @@ class ExitPagesSubcategory extends Subcategory
     protected $id = 'Actions_SubmenuPagesExit';
     protected $order = 15;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_ExitPagesSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_ExitPagesSubcategoryHelp2') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp3') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/OutlinksSubcategory.php b/plugins/Actions/Categories/OutlinksSubcategory.php
index 8cf2fb568b..d27cbe3a5a 100644
--- a/plugins/Actions/Categories/OutlinksSubcategory.php
+++ b/plugins/Actions/Categories/OutlinksSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class OutlinksSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class OutlinksSubcategory extends Subcategory
     protected $id = 'General_Outlinks';
     protected $order = 30;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_OutlinksSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp3') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/PageTitlesSubcategory.php b/plugins/Actions/Categories/PageTitlesSubcategory.php
index b52cc10508..8d3c480605 100644
--- a/plugins/Actions/Categories/PageTitlesSubcategory.php
+++ b/plugins/Actions/Categories/PageTitlesSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class PageTitlesSubcategory extends Subcategory
 {
@@ -16,4 +17,9 @@ class PageTitlesSubcategory extends Subcategory
     protected $id = 'Actions_SubmenuPageTitles';
     protected $order = 20;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_PageTitlesSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PageTitlesSubcategoryHelp2') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/PagesSubcategory.php b/plugins/Actions/Categories/PagesSubcategory.php
index bff399f7e6..31f948a184 100644
--- a/plugins/Actions/Categories/PagesSubcategory.php
+++ b/plugins/Actions/Categories/PagesSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class PagesSubcategory extends Subcategory
 {
@@ -16,4 +17,10 @@ class PagesSubcategory extends Subcategory
     protected $id = 'General_Pages';
     protected $order = 5;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp2') . '</p>'
+            . '<p>' . Piwik::translate('Actions_PagesSubcategoryHelp3') . '</p>';
+    }
 }
diff --git a/plugins/Actions/Categories/SiteSearchSubcategory.php b/plugins/Actions/Categories/SiteSearchSubcategory.php
index 8469b0c5bf..69e97c615f 100644
--- a/plugins/Actions/Categories/SiteSearchSubcategory.php
+++ b/plugins/Actions/Categories/SiteSearchSubcategory.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\Actions\Categories;
 
 use Piwik\Category\Subcategory;
+use Piwik\Piwik;
 
 class SiteSearchSubcategory extends Subcategory
 {
@@ -16,4 +17,10 @@ class SiteSearchSubcategory extends Subcategory
     protected $id = 'Actions_SubmenuSitesearch';
     protected $order = 25;
 
+    public function getHelp()
+    {
+        return '<p>' . Piwik::translate('Actions_SiteSearchSubcategoryHelp1') . '</p>'
+            . '<p>' . Piwik::translate('Actions_SiteSearchSubcategoryHelp2') . '</p>'
+            . '<p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">' . Piwik::translate('Actions_SiteSearchSubcategoryHelp3') . '</a></p>';
+    }
 }
diff --git a/plugins/Actions/lang/en.json b/plugins/Actions/lang/en.json
index 2616af09ba..76c4b496a3 100644
--- a/plugins/Actions/lang/en.json
+++ b/plugins/Actions/lang/en.json
@@ -80,6 +80,21 @@
         "ActionType": "Action Type",
         "ActionTypes": "Action Types",
         "Behaviour": "Behaviour",
-        "TimeSpentInReferringAction": "Time Spent in Referring Action"
+        "TimeSpentInReferringAction": "Time Spent in Referring Action",
+        "PagesSubcategoryHelp1": "This report contains information about the page URLs that have been visited.",
+        "PagesSubcategoryHelp2": "The table is organized hierarchically, the URLs are displayed as a folder structure.",
+        "PagesSubcategoryHelp3": "Use the plus and minus icons on the left to navigate.",
+        "EntryPagesSubcategoryHelp1": "This report contains information about the entry pages that were used during the specified period. An entry page is the first page that a user views during their visit.",
+        "EntryPagesSubcategoryHelp2": "The entry URLs are displayed as a folder structure.",
+        "ExitPagesSubcategoryHelp1": "This report contains information about the exit pages that occurred during the specified period. An exit page is the last page that a user views during their visit.",
+        "ExitPagesSubcategoryHelp2": "The exit URLs are displayed as a folder structure.",
+        "PageTitlesSubcategoryHelp1": "This report contains information about the titles of the pages that have been visited.",
+        "PageTitlesSubcategoryHelp2": "The page title is the HTML &amp;lt;title&amp;gt; Tag that most browsers show in their window title.",
+        "SiteSearchSubcategoryHelp1": "The Site Search section shows which keywords visitors use when searching your website. It also displays which pages users view after performing a search and which on-site search keywords return no results at all.",
+        "SiteSearchSubcategoryHelp2": "These reports can give you ideas about missing content on your site, insight into what your visitors are looking for but can’t find easily, and more.",
+        "SiteSearchSubcategoryHelp3": "Learn more in the Site Search guide.",
+        "OutlinksSubcategoryHelp1": "This report shows a hierarchical list of outlink URLs that were clicked by your visitors. An outlink is a link that leads the visitor away from your website (to another domain).",
+        "DownloadsSubcategoryHelp1": "In this report, you can see which files your visitors have downloaded.",
+        "DownloadsSubcategoryHelp2": "What Matomo counts as a download is the click on a download link. Whether the download was completed or not isn't known to Matomo."
     }
 }
\ No newline at end of file