diff options
| author | dizzy <diosmosis@users.noreply.github.com> | 2021-02-10 08:37:26 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-10 08:37:26 +0300 |
| commit | bc1d57f6dc43e843d26cbb5e484539201f518cf9 (patch) | |
| tree | 124d9ba0bb2f0a860fdaa9e39c059944dc94af4e | |
| parent | f3782b96ad41d9ec52e759e7ca47bceba570bc35 (diff) | |
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>
69 files changed, 1062 insertions, 36 deletions
diff --git a/core/Category/Category.php b/core/Category/Category.php index 6bcc1ba35c..5a8c07244a 100644 --- a/core/Category/Category.php +++ b/core/Category/Category.php @@ -79,7 +79,7 @@ class Category $subcategoryId = $subcategory->getId(); if ($this->hasSubcategory($subcategoryId)) { - throw new \Exception(sprintf('Subcategory %s already exists', $subcategoryId)); + throw new \Exception(sprintf('Subcategory %s already exists for category %s', $subcategoryId, $this->getId())); } $this->subcategories[$subcategoryId] = $subcategory; @@ -121,4 +121,12 @@ class Category return $this->icon; } + /** + * Get the help text (if any) for this category. + * @return null + */ + public function getHelp() + { + return null; + } } diff --git a/core/Category/Subcategory.php b/core/Category/Subcategory.php index 9605c6b792..a939d8d9ea 100644 --- a/core/Category/Subcategory.php +++ b/core/Category/Subcategory.php @@ -143,4 +143,13 @@ class Subcategory { return $this->order; } + + /** + * Get the help text (if any) for this category. + * @return null + */ + public function getHelp() + { + return null; + } } diff --git a/plugins/API/WidgetMetadata.php b/plugins/API/WidgetMetadata.php index 1ea420ea80..ccbd914f05 100644 --- a/plugins/API/WidgetMetadata.php +++ b/plugins/API/WidgetMetadata.php @@ -191,6 +191,7 @@ class WidgetMetadata 'name' => $category->getDisplayName(), 'order' => $category->getOrder(), 'icon' => $category->getIcon(), + 'help' => Piwik::translate($category->getHelp()), ); } @@ -208,6 +209,7 @@ class WidgetMetadata 'id' => (string) $subcategory->getId(), 'name' => Piwik::translate($subcategory->getName()), 'order' => $subcategory->getOrder(), + 'help' => Piwik::translate($subcategory->getHelp()), ); } diff --git a/plugins/API/tests/Unit/WidgetMetadataTest.php b/plugins/API/tests/Unit/WidgetMetadataTest.php index b94442b167..99563b6312 100644 --- a/plugins/API/tests/Unit/WidgetMetadataTest.php +++ b/plugins/API/tests/Unit/WidgetMetadataTest.php @@ -49,12 +49,14 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'id' => 'CategoryId', 'name' => 'CategoryId', 'order' => 99, - 'icon' => '' + 'icon' => '', + 'help' => '', ), 'subcategory' => array( 'id' => 'SubcategoryId', 'name' => 'SubcategoryIdName', 'order' => 99, + 'help' => '', ), 'module' => 'CoreHome', 'action' => 'render', @@ -89,6 +91,7 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'name' => 'CategoryId', 'order' => 99, 'icon' => '', + 'help' => '', ), $metadata['category']); $this->assertNull($metadata['subcategory']); } @@ -141,12 +144,14 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'id' => 'NestedCategory1', 'name' => 'NestedCategory1', 'order' => 99, - 'icon' => '' + 'icon' => '', + 'help' => '', ), 'subcategory' => array ( 'id' => 'NestedSubcategory1', 'name' => 'NestedSubcategory1', - 'order' => 99 + 'order' => 99, + 'help' => '', ), 'module' => 'CoreHome', 'action' => 'render', @@ -164,12 +169,14 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'id' => 'NestedCategory2', 'name' => 'NestedCategory2', 'order' => 99, - 'icon' => '' + 'icon' => '', + 'help' => '', ), 'subcategory' => array ( 'id' => 'NestedSubcategory2', 'name' => 'NestedSubcategory2', - 'order' => 99 + 'order' => 99, + 'help' => '', ), 'module' => 'CoreHome', 'action' => 'render', @@ -204,11 +211,13 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'name' => 'Category2', 'order' => 99, 'icon' => '', + 'help' => '', ], 'subcategory' => [ 'id' => 'Subcategory2', 'name' => 'Subcategory2Name', 'order' => 99, + 'help' => '', ], 'module' => 'CoreHome', 'action' => 'render', @@ -244,11 +253,13 @@ class WidgetMetadataTest extends \PHPUnit\Framework\TestCase 'name' => 'NestedCategory1', 'order' => 99, 'icon' => '', + 'help' => '', ), 'subcategory' => array ( 'id' => 'NestedSubcategory1', 'name' => 'NestedSubcategory1Name', 'order' => 99, + 'help' => '', ), 'widgets' => array ( 0 => array ( // widgets should not have category / subcategory again, it's already present above 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 &lt;title&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 diff --git a/plugins/Contents/Categories/ContentsSubcategory.php b/plugins/Contents/Categories/ContentsSubcategory.php index 93adfe0eb7..702c0621cf 100644 --- a/plugins/Contents/Categories/ContentsSubcategory.php +++ b/plugins/Contents/Categories/ContentsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Contents\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class ContentsSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class ContentsSubcategory extends Subcategory protected $id = 'Contents_Contents'; protected $order = 45; + public function getHelp() + { + return '<p>' . Piwik::translate('Contents_ContentsSubcategoryHelp1') . '</p>' + . '<p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">' . Piwik::translate('Contents_ContentsSubcategoryHelp2') . '</a></p>'; + } } diff --git a/plugins/Contents/lang/en.json b/plugins/Contents/lang/en.json index 5dd2ed0038..5c63a2fa92 100644 --- a/plugins/Contents/lang/en.json +++ b/plugins/Contents/lang/en.json @@ -17,6 +17,8 @@ "Contents": "Contents", "InteractionsMetricDocumentation": "The number of times a content block was interacted with (eg, a 'click' on a banner or ad).", "ImpressionsMetricDocumentation": "The number of times a content block, such as a banner or an ad, was displayed on a page.", - "InteractionRateMetricDocumentation": "The ratio of content impressions to interactions." + "InteractionRateMetricDocumentation": "The ratio of content impressions to interactions.", + "ContentsSubcategoryHelp1": "Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.", + "ContentsSubcategoryHelp2": "Learn more in the Content Tracking guide." } }
\ No newline at end of file diff --git a/plugins/CoreHome/Categories/DevicesSubcategory.php b/plugins/CoreHome/Categories/DevicesSubcategory.php index 2d2e6193c6..f212d9568f 100644 --- a/plugins/CoreHome/Categories/DevicesSubcategory.php +++ b/plugins/CoreHome/Categories/DevicesSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\CoreHome\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class DevicesSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class DevicesSubcategory extends Subcategory protected $id = 'DevicesDetection_Devices'; protected $order = 15; + public function getHelp() + { + return '<p>' . Piwik::translate('CoreHome_DevicesSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/CoreHome/Categories/EngagementSubcategory.php b/plugins/CoreHome/Categories/EngagementSubcategory.php index 4e840bf2d8..2e016d06ba 100644 --- a/plugins/CoreHome/Categories/EngagementSubcategory.php +++ b/plugins/CoreHome/Categories/EngagementSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\CoreHome\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class EngagementSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class EngagementSubcategory extends Subcategory protected $id = 'VisitorInterest_Engagement'; protected $order = 46; + public function getHelp() + { + return '<p>' . Piwik::translate('CoreHome_EngagementSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('CoreHome_EngagementSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/CoreHome/Categories/SoftwareSubcategory.php b/plugins/CoreHome/Categories/SoftwareSubcategory.php index 5f7cabf6b1..5672adb559 100644 --- a/plugins/CoreHome/Categories/SoftwareSubcategory.php +++ b/plugins/CoreHome/Categories/SoftwareSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\CoreHome\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class SoftwareSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class SoftwareSubcategory extends Subcategory protected $id = 'DevicesDetection_Software'; protected $order = 20; + public function getHelp() + { + return '<p>' . Piwik::translate('CoreHome_SoftwareSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/CoreHome/Categories/VisitorsCategory.php b/plugins/CoreHome/Categories/VisitorsCategory.php index 3541c7818f..8cbbbb9033 100644 --- a/plugins/CoreHome/Categories/VisitorsCategory.php +++ b/plugins/CoreHome/Categories/VisitorsCategory.php @@ -9,10 +9,22 @@ namespace Piwik\Plugins\CoreHome\Categories; use Piwik\Category\Category; +use Piwik\Piwik; +use Piwik\Url; class VisitorsCategory extends Category { protected $id = 'General_Visitors'; protected $order = 5; protected $icon = 'icon-reporting-visitors'; + + public function getHelp() + { + $visitsLogUrl = '<a href="#" onclick="this.href=broadcast.buildReportingUrl(\'category=General_Visitors&subcategory=Live_VisitorLog\')">'; + + $helpText = '<p>' . Piwik::translate('CoreHome_VisitorsCategoryHelp1') . '</p>'; + $helpText .= '<p>' . Piwik::translate('CoreHome_VisitorsCategoryHelp2', [$visitsLogUrl, '</a>']) . '</p>'; + + return $helpText; + } } diff --git a/plugins/CoreHome/Categories/VisitorsOverviewSubcategory.php b/plugins/CoreHome/Categories/VisitorsOverviewSubcategory.php index abb84ff0ab..4e3747f048 100644 --- a/plugins/CoreHome/Categories/VisitorsOverviewSubcategory.php +++ b/plugins/CoreHome/Categories/VisitorsOverviewSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\CoreHome\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class VisitorsOverviewSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class VisitorsOverviewSubcategory extends Subcategory protected $id = 'General_Overview'; protected $order = 2; + public function getHelp() + { + return '<p>' . Piwik::translate('CoreHome_VisitorsOverviewHelp') . '</p>'; + } } diff --git a/plugins/CoreHome/CoreHome.php b/plugins/CoreHome/CoreHome.php index cb3f102141..8b4459b99d 100644 --- a/plugins/CoreHome/CoreHome.php +++ b/plugins/CoreHome/CoreHome.php @@ -488,5 +488,6 @@ class CoreHome extends \Piwik\Plugin $translationKeys[] = 'General_Custom'; $translationKeys[] = 'General_PreviousPeriod'; $translationKeys[] = 'General_PreviousYear'; + $translationKeys[] = 'CoreHome_ReportingCategoryHelpPrefix'; } } diff --git a/plugins/CoreHome/angularjs/enrichedheadline/enrichedheadline.directive.less b/plugins/CoreHome/angularjs/enrichedheadline/enrichedheadline.directive.less index 7d1af035a6..cb3c1c4ad8 100644 --- a/plugins/CoreHome/angularjs/enrichedheadline/enrichedheadline.directive.less +++ b/plugins/CoreHome/angularjs/enrichedheadline/enrichedheadline.directive.less @@ -55,8 +55,9 @@ margin: 0 0 -1px 4px; opacity: 0.3; font-size: 15px; - color: @theme-color-text-light; + color: @theme-color-text-light !important; &:hover, &.active { + color: @theme-color-help-background-color !important; opacity: 0.9; text-decoration: none; } diff --git a/plugins/CoreHome/angularjs/notification/notification.directive.less b/plugins/CoreHome/angularjs/notification/notification.directive.less index 4b27802a5a..ae372d74b6 100644 --- a/plugins/CoreHome/angularjs/notification/notification.directive.less +++ b/plugins/CoreHome/angularjs/notification/notification.directive.less @@ -4,6 +4,10 @@ box-shadow: 0 2px 5px 0 rgba(0,0,0,0.16), 0 2px 10px 0 rgba(0,0,0,0.12); border: 0 !important; + p:not(:first-child) { + margin-top: 1em; + } + // We have to use !important because the default button style is crazy .close { position: relative; @@ -54,4 +58,12 @@ color: #f3feff; } } -}
\ No newline at end of file + + .help-notification &.notification-info { + background-color: @theme-color-help-background-color; + + &:before { + content: "\e61f"; + } + } +} diff --git a/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.controller.js b/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.controller.js index 533e38fcfe..e99d92809f 100644 --- a/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.controller.js +++ b/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.controller.js @@ -11,6 +11,8 @@ function ReportingMenuController($scope, piwik, $location, $timeout, menuModel, $rootScope, piwikUrl) { + $scope.helpShownCategory = null; + var idSite = piwikUrl.getSearchParam('idSite'); var period = piwikUrl.getSearchParam('period'); var date = piwikUrl.getSearchParam('date'); @@ -20,6 +22,11 @@ var compareDates = piwikUrl.getSearchParam('compareDates'); var compareSegments = piwikUrl.getSearchParam('compareSegments'); + var showSubcategoryHelpOnLoad = null; + + $scope.currentCategory = piwikUrl.getSearchParam('category'); + $scope.currentSubcategory = piwikUrl.getSearchParam('subcategory'); + function markAllCategoriesAsInactive() { angular.forEach(menuModel.menu, function (cat) { @@ -61,6 +68,41 @@ subcategory.name = subsubcategory.name; subsubcategory.active = true; } + } + + $scope.showHelp = function (category, subcategory, $event) { + if (( $scope.currentCategory !== category.id + || $scope.currentSubcategory !== subcategory.id ) + && $event + ) { + showSubcategoryHelpOnLoad = { category: category, subcategory: subcategory }; + window.location.href = '#?' + $scope.makeUrl(category, subcategory); + return; + } + + var UI = require('piwik/UI'); + var notification = new UI.Notification(); + + if (subcategory === $scope.helpShownCategory) { + notification.remove('reportingmenu-help'); + $scope.helpShownCategory = null; + return; + } + + var prefix = '<strong>' + _pk_translate('CoreHome_ReportingCategoryHelpPrefix', [category.name, subcategory.name]) + '</strong><br/>'; + + var options = { context: 'info', id: 'reportingmenu-help', type: 'persistent', noclear: true }; + options['class'] = 'help-notification'; + + notification.show(prefix + subcategory.help, options); + $scope.helpShownCategory = subcategory; + + // move help notification so it is always the first one shown + $('[notification-id=reportingmenu-help]').prependTo($('#notificationContainer')); + }; + + $scope.isNotificationShown = function () { + return !! $('#reportingmenu-help').length; }; $scope.makeUrl = function (category, subcategory) { @@ -97,6 +139,8 @@ } if (category.active && category.subcategories && category.subcategories.length === 1) { + $scope.helpShownCategory = null; + var subcategory = category.subcategories[0]; if (subcategory.active) { @@ -111,7 +155,12 @@ }; $scope.loadSubcategory = function (category, subcategory) { + var UI = require('piwik/UI'); + UI.Notification.prototype.remove('reportingmenu-help'); + if (subcategory && subcategory.active) { + $scope.helpShownCategory = null; + // this menu item is already active, a location change success would not be triggered, // instead trigger an event $rootScope.$emit('loadPage', category.id, subcategory.id); @@ -168,5 +217,15 @@ enterSubcategory(found.category, found.subcategory, found.subsubcategory); }); + $rootScope.$on('piwikPageChange', function (event) { + $scope.helpShownCategory = null; + $scope.currentCategory = piwikUrl.getSearchParam('category'); + $scope.currentSubcategory = piwikUrl.getSearchParam('subcategory'); + + if (showSubcategoryHelpOnLoad) { + $scope.showHelp(showSubcategoryHelpOnLoad.category, showSubcategoryHelpOnLoad.subcategory); + showSubcategoryHelpOnLoad = null; + } + }); } })(); diff --git a/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.directive.html b/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.directive.html index c8f8e12759..ff3a549061 100644 --- a/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.directive.html +++ b/plugins/CoreHome/angularjs/reporting-menu/reportingmenu.directive.html @@ -1,4 +1,4 @@ -<div><ul class="navbar hide-on-med-and-down" role="menu" aria-label="{{ 'CoreHome_MainNavigation'|translate }}"> +<div class="reportingMenu"><ul class="navbar hide-on-med-and-down" role="menu" aria-label="{{ 'CoreHome_MainNavigation'|translate }}"> <li ng-repeat="category in menuModel.menu" class="menuTab" role="menuitem" @@ -11,6 +11,7 @@ {{ 'CoreHome_Menu'|translate }} </span> </a> + <ul role="menu"> <li ng-repeat="subcategory in category.subcategories" role="menuitem" @@ -32,6 +33,15 @@ ng-click='loadSubcategory(category, subcategory)'> {{ subcategory.name }} </a> + + <a class="item-help-icon" + tabindex="5" href="javascript:" + ng-if="subcategory.help" + ng-click="showHelp(category, subcategory, $event)" + ng-class="{'active': helpShownCategory == subcategory && subcategory.help}" + > + <span class="icon-help"></span> + </a> </li> </ul> </li> diff --git a/plugins/CoreHome/lang/en.json b/plugins/CoreHome/lang/en.json index fac30632ed..d7f1157f7a 100644 --- a/plugins/CoreHome/lang/en.json +++ b/plugins/CoreHome/lang/en.json @@ -113,6 +113,14 @@ "SeeAvailableVersions": "See Available Versions", "QuickLinks": "Quick Links", "Profilable": "Profilable", - "SearchOnMatomo": "Search '%1$s' on Matomo.org" + "SearchOnMatomo": "Search '%1$s' on Matomo.org", + "ReportingCategoryHelpPrefix": "How does the \"%1$s > %2$s\" reporting page help me?", + "VisitorsCategoryHelp1": "The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.", + "VisitorsCategoryHelp2": "In addition to general information about your visitors, you can also use the %1$sVisits Log%2$s to see what occurred in every individual visit.", + "VisitorsOverviewHelp": "The Visitors Overview helps you understand the popularity of your site. It does this by providing charts that show how many visits your site is receiving over a selected period and the average level of engagement for key features, such as searches and downloads.", + "DevicesSubcategoryHelp": "The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.", + "SoftwareSubcategoryHelp": "The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..", + "EngagementSubcategoryHelp1": "The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.", + "EngagementSubcategoryHelp2": "This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach." } } diff --git a/plugins/CoreHome/stylesheets/layout.less b/plugins/CoreHome/stylesheets/layout.less index ab5b45ec25..aaeb07635a 100644 --- a/plugins/CoreHome/stylesheets/layout.less +++ b/plugins/CoreHome/stylesheets/layout.less @@ -199,22 +199,56 @@ nav { .border-radius(0px); border: 0; background: none; + position: relative; .item { - display: inline-block; width: 100%; - .font-default(13px, 21px); padding: 12px 21px 12px 19px; - color: @theme-color-menu-contrast-text; - decoration: none !important; word-wrap: break-word; word-break: break-word; + } - &:hover, &:focus { - decoration: none !important; + .item,.item-help-icon { + display: inline-block; + .font-default(13px, 21px); + color: @theme-color-menu-contrast-text; + } + + .item-help-icon { + display:none; + opacity: 0.2; + position: absolute; + right: 21px; + top: 0px; + line-height: 13px; + padding-left: 16px; + padding-right: 16px; + height: calc(100%); + + > span { + position: relative; + top: 12px; } } + &.menuTab li:hover { + .item-help-icon:not(.active) { + display:inline-block; + color: @color-black-piwik; + + &:hover { + color: @theme-color-help-background-color; + opacity: 0.75; + } + } + } + + .item-help-icon.active { + display: inline-block; + color: @theme-color-help-background-color; + opacity: 0.75; + } + > .item { cursor: default; font-weight: bold; @@ -224,8 +258,10 @@ nav { } > ul { + position: relative; li { + position: relative; .item { .font-default(13px, 16px); padding: 11px 22px 11px 45px; @@ -250,6 +286,9 @@ nav { } } + .menuTab > .item-help-icon { + top: 14px; + } .menuDropdown { width: 100%; diff --git a/plugins/CustomVariables b/plugins/CustomVariables -Subproject eae0b21cb3ef6ea4ce1c5f70466daef6d8dca5d +Subproject ceb058de28952be0909ecec3c4c286e12deb271 diff --git a/plugins/Dashboard/Categories/DashboardCategory.php b/plugins/Dashboard/Categories/DashboardCategory.php index 6a7ca4bcc5..746d4e2ca7 100644 --- a/plugins/Dashboard/Categories/DashboardCategory.php +++ b/plugins/Dashboard/Categories/DashboardCategory.php @@ -9,10 +9,16 @@ namespace Piwik\Plugins\Dashboard\Categories; use Piwik\Category\Category; +use Piwik\Piwik; class DashboardCategory extends Category { protected $id = 'Dashboard_Dashboard'; protected $order = 0; protected $icon = 'icon-reporting-dashboard'; + + public function getHelp() + { + return '<p>' . Piwik::translate('Dashboard_DashboardCategoryHelp', ['<strong>', '</strong>']) . '</p>'; + } } diff --git a/plugins/Dashboard/lang/en.json b/plugins/Dashboard/lang/en.json index 68bfd22c8e..522408467b 100644 --- a/plugins/Dashboard/lang/en.json +++ b/plugins/Dashboard/lang/en.json @@ -32,6 +32,7 @@ "SetAsDefaultWidgetsConfirmHelp": "This widgets selection and dashboard columns layout will be used when any user creates a new dashboard, or when \"%s\" feature is used.", "TopLinkTooltip": "View Web Analytics reports for %s.", "WidgetNotFound": "Widget not found", - "WidgetPreview": "Widget preview" + "WidgetPreview": "Widget preview", + "DashboardCategoryHelp": "This is a dashboard page. Dashboards are a collection of Matomo's widgets that you add yourself to suit your specific needs. Mix and match any of Matomo's widgets to get the data %1$s*you*%2$s need at a glance." } }
\ No newline at end of file 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 diff --git a/plugins/Events/Categories/EventsSubcategory.php b/plugins/Events/Categories/EventsSubcategory.php index 6c25ea66b4..f6abe87ee4 100644 --- a/plugins/Events/Categories/EventsSubcategory.php +++ b/plugins/Events/Categories/EventsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Events\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class EventsSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class EventsSubcategory extends Subcategory protected $id = 'Events_Events'; protected $order = 40; + public function getHelp() + { + return '<p>' . Piwik::translate('Events_EventsSubcategoryHelp1') . '</p>' + . '<p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">' . Piwik::translate('Events_EventsSubcategoryHelp2') . '</a></p>'; + } } diff --git a/plugins/Events/lang/en.json b/plugins/Events/lang/en.json index fdbcdbb6e6..9f8c3b0b53 100644 --- a/plugins/Events/lang/en.json +++ b/plugins/Events/lang/en.json @@ -33,6 +33,8 @@ "TotalEventsDocumentation": "Total number of events", "TotalValue": "Event value", "TotalValueDocumentation": "The sum of event values", - "ViewEvents": "View Events" + "ViewEvents": "View Events", + "EventsSubcategoryHelp1": "The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.", + "EventsSubcategoryHelp2": "Learn more about event tracking here." } } diff --git a/plugins/Goals/Categories/GoalsOverviewSubcategory.php b/plugins/Goals/Categories/GoalsOverviewSubcategory.php index 5d513b3e66..e36954f6a3 100644 --- a/plugins/Goals/Categories/GoalsOverviewSubcategory.php +++ b/plugins/Goals/Categories/GoalsOverviewSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Goals\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class GoalsOverviewSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class GoalsOverviewSubcategory extends Subcategory protected $id = 'General_Overview'; protected $order = 2; + public function getHelp() + { + return '<p>' . Piwik::translate('Goals_GoalsOverviewSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('Goals_GoalsOverviewSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/Goals/Categories/ManageGoalsSubcategory.php b/plugins/Goals/Categories/ManageGoalsSubcategory.php index 62a5395db2..8ff2deb9e6 100644 --- a/plugins/Goals/Categories/ManageGoalsSubcategory.php +++ b/plugins/Goals/Categories/ManageGoalsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Goals\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class ManageGoalsSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class ManageGoalsSubcategory extends Subcategory protected $id = 'Goals_ManageGoals'; protected $order = 9999; + public function getHelp() + { + return '<p>' . Piwik::translate('Goals_ManageGoalsSubcategoryHelp1') . '</p>' + . '<p><a href="https://matomo.org/docs/tracking-goals-web-analytics/" rel="noreferrer noopener" target="_blank">' . Piwik::translate('Goals_ManageGoalsSubcategoryHelp2') . '</a></p>'; + } } diff --git a/plugins/Goals/lang/en.json b/plugins/Goals/lang/en.json index b772c0ba32..2cb882317a 100644 --- a/plugins/Goals/lang/en.json +++ b/plugins/Goals/lang/en.json @@ -124,6 +124,10 @@ "AtLeastMinutes": "at least %1$s minutes. Use decimals to match seconds, for example, %2$s to match 30 seconds.", "TimeInMinutes": "Time in Minutes", "ClickToViewThisGoal": "Click to view this goal.", - "OverviewReportDocumentation": "This report gives an overview of how well your visitors convert a specific goal." + "OverviewReportDocumentation": "This report gives an overview of how well your visitors convert a specific goal.", + "GoalsOverviewSubcategoryHelp1": "The Goals Overview reports on the performance of the goals defined for your website. You can access your goal’s conversion percentages, amount of revenue generated and full reports for each.", + "GoalsOverviewSubcategoryHelp2": "Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.", + "ManageGoalsSubcategoryHelp1": "This section allows you to create and edit Goals for specific actions which visitors take on your site, such as visiting a certain page or submitting a specific form. Goal reports vary but can help you track your website performance against business objectives such as lead generation, online sales and increased brand exposure.", + "ManageGoalsSubcategoryHelp2": "Learn more in our Goals guide here." } } diff --git a/plugins/Live/Categories/RealTimeVisitorsSubcategory.php b/plugins/Live/Categories/RealTimeVisitorsSubcategory.php index 822d1bf268..0527f60ee0 100644 --- a/plugins/Live/Categories/RealTimeVisitorsSubcategory.php +++ b/plugins/Live/Categories/RealTimeVisitorsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Live\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class RealTimeVisitorsSubcategory extends Subcategory { @@ -16,4 +17,10 @@ class RealTimeVisitorsSubcategory extends Subcategory protected $id = 'General_RealTime'; protected $order = 7; + public function getHelp() + { + $result = '<p>' . Piwik::translate('Live_RealTimeHelp1') . '</p>'; + $result .= '<p>' . Piwik::translate('Live_RealTimeHelp2') . '</p>'; + return $result; + } } diff --git a/plugins/Live/Categories/VisitorLogSubcategory.php b/plugins/Live/Categories/VisitorLogSubcategory.php index 0fcd02223d..cba1e00af5 100644 --- a/plugins/Live/Categories/VisitorLogSubcategory.php +++ b/plugins/Live/Categories/VisitorLogSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Live\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class VisitorLogSubcategory extends Subcategory { @@ -16,4 +17,11 @@ class VisitorLogSubcategory extends Subcategory protected $id = 'Live_VisitorLog'; protected $order = 5; + public function getHelp() + { + $help = '<p>' . Piwik::translate('Live_VisitorLogSubcategoryHelp1') . '</p>'; + $help .= '<p>' . Piwik::translate('Live_VisitorLogSubcategoryHelp2') . '</p>'; + $help .= '<p><a href="https://matomo.org/docs/real-time/" target="_blank" rel="noreferrer noopener">' . Piwik::translate('Live_VisitorLogSubcategoryHelp3') . '</a></p>'; + return $help; + } } diff --git a/plugins/Live/lang/en.json b/plugins/Live/lang/en.json index 929354f578..0f20313ac7 100644 --- a/plugins/Live/lang/en.json +++ b/plugins/Live/lang/en.json @@ -59,6 +59,11 @@ "SegmentedVisitorLogTitle": "Visits Log showing visits where %1$s is \"%2$s\"", "OnClickPause": "%s is started. Click to pause.", "OnClickStart": "%s is stopped. Click to start.", - "ClickToSeeAllContents": "Click to see each content interaction/impression" + "ClickToSeeAllContents": "Click to see each content interaction/impression", + "VisitorLogSubcategoryHelp1": "The Visits Log shows you every visit your website receives in detail. You can see what actions each visitor has taken, how they got to your site, a bit about who they are, and more (while still complying with your local privacy regulations).", + "VisitorLogSubcategoryHelp2": "While other reports in Matomo show how your visitors behave at an aggregate level, the Visits Log provides granular detail. You can also use segments to narrow it down to specific types of visits to understand your visitors better.", + "VisitorLogSubcategoryHelp3": "Learn more in the Visits Log guide.", + "RealTimeHelp1": "The Visits in Real-time report shows the real-time flow of visits to your website. It includes a real-time counter of your visits and page views in the last 24 hours and the previous 30 minutes.", + "RealTimeHelp2": "This report refreshes every 5 seconds and displays new visits (or existing visitors that view a new page) at the top of the list with a fade-in effect." } } diff --git a/plugins/Morpheus/stylesheets/base/colors.less b/plugins/Morpheus/stylesheets/base/colors.less index 9a8150c330..8faf4069bc 100644 --- a/plugins/Morpheus/stylesheets/base/colors.less +++ b/plugins/Morpheus/stylesheets/base/colors.less @@ -74,6 +74,8 @@ @default-box-shade: 0 2px 3px 0 rgba(0,0,0,0.16), 0 0px 3px 0 rgba(0,0,0,0.12); +@theme-color-help-background-color: #6200ea; + /* Qualitative data color series inspired from colorbrewer2.org/ next ones could be: #cab2d6 #ffff99 # #b2df8a diff --git a/plugins/PagePerformance/Categories/PerformanceSubcategory.php b/plugins/PagePerformance/Categories/PerformanceSubcategory.php index e8f21cd27e..9644ed68b0 100644 --- a/plugins/PagePerformance/Categories/PerformanceSubcategory.php +++ b/plugins/PagePerformance/Categories/PerformanceSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\PagePerformance\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class PerformanceSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class PerformanceSubcategory extends Subcategory protected $id = 'PagePerformance_Performance'; protected $order = 47; + public function getHelp() + { + return '<p>' . Piwik::translate('PagePerformance_PerformanceSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('PagePerformance_PerformanceSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/PagePerformance/lang/en.json b/plugins/PagePerformance/lang/en.json index 0292ab6c94..d93b48e78a 100644 --- a/plugins/PagePerformance/lang/en.json +++ b/plugins/PagePerformance/lang/en.json @@ -36,6 +36,8 @@ "HelpNote": "Some of those metrics might not always be available. You can find more information in our %1$sonline guide%2$s.", "RowActionTitle": "Open page performance report", "RowActionDescription": "Show page performance report for this row", - "PagePerformanceTitle": "Page performance for page with %1$s \"%2$s\"" + "PagePerformanceTitle": "Page performance for page with %1$s \"%2$s\"", + "PerformanceSubcategoryHelp1": "The Performance section can help you analyse how fast your website or app is performing on the whole and help discover whether you have specific pages that significantly deviate from your averages.", + "PerformanceSubcategoryHelp2": "You can also find reports showing exactly how long each page of your website takes to load and what is contributing to their loading time." } } diff --git a/plugins/Referrers/Categories/AllReferrersSubcategory.php b/plugins/Referrers/Categories/AllReferrersSubcategory.php index 8f7f91b2b3..094b0b6ef7 100644 --- a/plugins/Referrers/Categories/AllReferrersSubcategory.php +++ b/plugins/Referrers/Categories/AllReferrersSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class AllReferrersSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class AllReferrersSubcategory extends Subcategory protected $id = 'Referrers_WidgetGetAll'; protected $order = 5; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_AllReferrersSubcategory1') . '</p>' + . '<p>' . Piwik::translate('Referrers_AllReferrersSubcategory2') . '</p>';; + } } diff --git a/plugins/Referrers/Categories/CampaignUrlBuilderSubcategory.php b/plugins/Referrers/Categories/CampaignUrlBuilderSubcategory.php index 271b820ad3..cfc9cc2aa5 100644 --- a/plugins/Referrers/Categories/CampaignUrlBuilderSubcategory.php +++ b/plugins/Referrers/Categories/CampaignUrlBuilderSubcategory.php @@ -15,5 +15,4 @@ class CampaignUrlBuilderSubcategory extends Subcategory protected $categoryId = 'Referrers_Referrers'; protected $id = 'Referrers_URLCampaignBuilder'; protected $order = 21; - } diff --git a/plugins/Referrers/Categories/CampaignsSubcategory.php b/plugins/Referrers/Categories/CampaignsSubcategory.php index 13ae8a73d7..77d4c20459 100644 --- a/plugins/Referrers/Categories/CampaignsSubcategory.php +++ b/plugins/Referrers/Categories/CampaignsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class CampaignsSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class CampaignsSubcategory extends Subcategory protected $id = 'Referrers_Campaigns'; protected $order = 20; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_CampaignsSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/Referrers/Categories/ReferrersOverviewSubcategory.php b/plugins/Referrers/Categories/ReferrersOverviewSubcategory.php index 0228fc5f01..bb9794e4bf 100644 --- a/plugins/Referrers/Categories/ReferrersOverviewSubcategory.php +++ b/plugins/Referrers/Categories/ReferrersOverviewSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class ReferrersOverviewSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class ReferrersOverviewSubcategory extends Subcategory protected $id = 'General_Overview'; protected $order = 2; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_ReferrersOverviewSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('Referrers_ReferrersOverviewSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/Referrers/Categories/SearchEnginesSubcategory.php b/plugins/Referrers/Categories/SearchEnginesSubcategory.php index 3a932bb01b..241e23ced8 100644 --- a/plugins/Referrers/Categories/SearchEnginesSubcategory.php +++ b/plugins/Referrers/Categories/SearchEnginesSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class SearchEnginesSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class SearchEnginesSubcategory extends Subcategory protected $id = 'Referrers_SubmenuSearchEngines'; protected $order = 10; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_SearchEnginesSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('Referrers_SearchEnginesSubcategoryHelp2', ['<a href="https://matomo.org/matomo-cloud/" rel="noreferrer noopener" target="_blank">', '</a>', '<a href="https://plugins.matomo.org/SearchEngineKeywordsPerformance" rel="noreferrer noopener" target="_blank">', '</a>']) . '</p>'; + } } diff --git a/plugins/Referrers/Categories/SocialsSubcategory.php b/plugins/Referrers/Categories/SocialsSubcategory.php index 329e4e27b4..4a205b15c7 100644 --- a/plugins/Referrers/Categories/SocialsSubcategory.php +++ b/plugins/Referrers/Categories/SocialsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class SocialsSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class SocialsSubcategory extends Subcategory protected $id = 'Referrers_Socials'; protected $order = 16; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_SocialsSubcategoryHelp') . '</p>' + . '<p>' . Piwik::translate('Referrers_WebsitesSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/Referrers/Categories/WebsitesSubcategory.php b/plugins/Referrers/Categories/WebsitesSubcategory.php index 552bab1b4a..a3e869cdc6 100644 --- a/plugins/Referrers/Categories/WebsitesSubcategory.php +++ b/plugins/Referrers/Categories/WebsitesSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Referrers\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class WebsitesSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class WebsitesSubcategory extends Subcategory protected $id = 'Referrers_SubmenuWebsitesOnly'; protected $order = 15; + public function getHelp() + { + return '<p>' . Piwik::translate('Referrers_WebsitesSubcategoryHelp1') . '</p>' + . '<p>' . Piwik::translate('Referrers_WebsitesSubcategoryHelp2') . '</p>'; + } } diff --git a/plugins/Referrers/lang/en.json b/plugins/Referrers/lang/en.json index 87e375b838..cbea210e78 100644 --- a/plugins/Referrers/lang/en.json +++ b/plugins/Referrers/lang/en.json @@ -82,6 +82,19 @@ "VisitorsFromSocialNetworks": "Visitors from Social Networks", "VisitorsFromDirectEntry": "Visitors from Direct Entry", "VisitorsFromWebsites": "Visitors from Websites", - "VisitorsFromCampaigns": "Visitors from Campaigns" + "VisitorsFromCampaigns": "Visitors from Campaigns", + "ReferrersOverviewSubcategoryHelp1": "The Acquisition Overview shows you the percentage of your traffic from all sources over a selected date range.", + "ReferrersOverviewSubcategoryHelp2": "You can also click on a specific channel type to display it within the evolution graph. This can help you discover which channels contribute the most traffic to your site as well as any potential patterns over time. For example, a certain channel may perform better on weekends.", + "AllReferrersSubcategory1": "This section shows you the number of visits that arrive from different channel types and referrers. Click on the plus or minus buttons to view the referrers within each type.", + "AllReferrersSubcategory2": "You can also analyse the number of actions performed by each of your traffic sources by enabling the table with Visitor engagement metrics view.", + "SearchEnginesSubcategoryHelp1": "This section helps you analyse your search engine optimisation and performance. You can analyse your most popular keywords with the combined keyword reports or see which keywords perform well on specific search engines for more targeted analysis and optimisation.", + "SearchEnginesSubcategoryHelp2": "%1$sMatomo Cloud%2$s and %3$sSearch Engine Keywords Performance%4$s plugin users will receive the best results from this report.", + "WebsitesSubcategoryHelp1": "In this table, you can see which websites referred visitors to your site.", + "WebsitesSubcategoryHelp2": "By clicking on a row in the table, you can see which URLs the links to your website were on.", + "SocialsSubcategoryHelp": "In this table, you can see which websites referred visitors to your site.", + "CampaignsSubcategoryHelp": "The Campaign Tracking section allows you to analyse the visits associated with the various tracking values that have been linked to your digital campaigns. It can reveal things like, how much traffic your campaigns are bringing in, which creatives are performing best, how engaged campaign visitors are, and whether the campaign is resulting in sales or not.", + "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." } } diff --git a/plugins/SegmentEditor/templates/_unprocessedSegmentMessage.twig b/plugins/SegmentEditor/templates/_unprocessedSegmentMessage.twig index 4c8891dfde..320590e787 100644 --- a/plugins/SegmentEditor/templates/_unprocessedSegmentMessage.twig +++ b/plugins/SegmentEditor/templates/_unprocessedSegmentMessage.twig @@ -10,7 +10,6 @@ {{ 'SegmentEditor_CustomUnprocessedSegmentNoData'|translate }} </p> {% endif %} -<p> </p> <p> {{ 'SegmentEditor_UnprocessedSegmentInVisitorLog1'|translate(visitorLogLinkHtml, '</a>')|raw }} {{ 'SegmentEditor_UnprocessedSegmentInVisitorLog2'|translate }} diff --git a/plugins/Transitions/Categories/TransitionsSubcategory.php b/plugins/Transitions/Categories/TransitionsSubcategory.php index d801ab1ba3..e58c992d1d 100644 --- a/plugins/Transitions/Categories/TransitionsSubcategory.php +++ b/plugins/Transitions/Categories/TransitionsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\Transitions\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class TransitionsSubcategory extends Subcategory { @@ -16,4 +17,9 @@ class TransitionsSubcategory extends Subcategory protected $id = 'Transitions_Transitions'; protected $order = 46; + public function getHelp() + { + return '<p>' . Piwik::translate('Transitions_TransitionsSubcategoryHelp1') . '</p>' + . '<p><a href="https://matomo.org/docs/transitions/" rel="noreferrer noopener" target="_blank">' . Piwik::translate('Transitions_TransitionsSubcategoryHelp2') . '</a></p>'; + } } diff --git a/plugins/Transitions/lang/en.json b/plugins/Transitions/lang/en.json index 3fece8c57e..321557d613 100644 --- a/plugins/Transitions/lang/en.json +++ b/plugins/Transitions/lang/en.json @@ -33,6 +33,8 @@ "ToFollowingSiteSearchesInline": "%s internal searches", "XOfAllPageviews": "%s of all views of this page", "XOutOfYVisits": "%1$s (out of %2$s)", - "PageURLTransitions": "Page URL Transitions" + "PageURLTransitions": "Page URL Transitions", + "TransitionsSubcategoryHelp1": "Transitions gives you a report that shows the things your visitors did directly before and after viewing a certain page. This page will explain how to access, understand, and use the powerful Transitions report.", + "TransitionsSubcategoryHelp2": "More Details" } }
\ No newline at end of file diff --git a/plugins/UserCountry/Categories/LocationsSubcategory.php b/plugins/UserCountry/Categories/LocationsSubcategory.php index b0572cdeaa..c58943dc75 100644 --- a/plugins/UserCountry/Categories/LocationsSubcategory.php +++ b/plugins/UserCountry/Categories/LocationsSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\UserCountry\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class LocationsSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class LocationsSubcategory extends Subcategory protected $id = 'UserCountry_SubmenuLocations'; protected $order = 10; + public function getHelp() + { + return '<p>' . Piwik::translate('UserCountry_LocationsSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/UserCountry/lang/en.json b/plugins/UserCountry/lang/en.json index d645375bec..2c52d95574 100644 --- a/plugins/UserCountry/lang/en.json +++ b/plugins/UserCountry/lang/en.json @@ -44,6 +44,7 @@ "ToGeolocateOldVisits": "To get location data for your old visits, use the script described %1$shere%2$s.", "WidgetLocation": "Visitor Location", "GeoIpDbIpAccuracyNote": "Note: the DBIP databases are free and can be downloaded automatically, but geolocation results (specifically city results) are not as accurate as MaxMind's. MaxMind, however, requires that you create an account even for the free database. If you want to use MaxMind's geolocation database, you can start the process %1$shere%2$s", - "MaxMindLinkExplanation": "If you are using MaxMind's geolocation databases and you do not already know how to generate your download URL, %1$sclick here to learn how%2$s." + "MaxMindLinkExplanation": "If you are using MaxMind's geolocation databases and you do not already know how to generate your download URL, %1$sclick here to learn how%2$s.", + "LocationsSubcategoryHelp": "The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations." } }
\ No newline at end of file diff --git a/plugins/UserCountryMap/Categories/RealTimeMapSubcategory.php b/plugins/UserCountryMap/Categories/RealTimeMapSubcategory.php index 00d02729a2..6fcde56f94 100644 --- a/plugins/UserCountryMap/Categories/RealTimeMapSubcategory.php +++ b/plugins/UserCountryMap/Categories/RealTimeMapSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\UserCountryMap\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class RealTimeMapSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class RealTimeMapSubcategory extends Subcategory protected $id = 'UserCountryMap_RealTimeMap'; protected $order = 9; + public function getHelp() + { + return '<p>' . Piwik::translate('UserCountryMap_RealTimeMapHelp') . '</p>'; + } } diff --git a/plugins/UserCountryMap/lang/en.json b/plugins/UserCountryMap/lang/en.json index a4e98e6331..985e1aa41f 100644 --- a/plugins/UserCountryMap/lang/en.json +++ b/plugins/UserCountryMap/lang/en.json @@ -22,6 +22,7 @@ "WithUnknownRegion": "%s with unknown region", "WithUnknownCity": "%s with unknown city", "NoVisitsInfo": "There are no visits displayed currently, because no visit for this period has the correct geolocation information (latitude & longitude).", - "NoVisitsInfo2": "To resolve this issue, make sure you are using a GeoIP geolocation provider with a GeoIP city database. If this does not resolve your issue, then it is possible (though unlikely) that your visits have IP addresses that just cannot be geolocated." + "NoVisitsInfo2": "To resolve this issue, make sure you are using a GeoIP geolocation provider with a GeoIP city database. If this does not resolve your issue, then it is possible (though unlikely) that your visits have IP addresses that just cannot be geolocated.", + "RealTimeMapHelp": "The Real-time Map shows the location of visitors on your site within the last 30 minutes. Large orange bubbles represent more recent visits, while smaller grey bubbles represent older visits. This data refreshes every five seconds, and new visitors appear with a flashing effect." } }
\ No newline at end of file diff --git a/plugins/UserId/Categories/VisitorsUserSubcategory.php b/plugins/UserId/Categories/VisitorsUserSubcategory.php index cfb391b597..cf524ed728 100644 --- a/plugins/UserId/Categories/VisitorsUserSubcategory.php +++ b/plugins/UserId/Categories/VisitorsUserSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\UserId\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class VisitorsUserSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class VisitorsUserSubcategory extends Subcategory protected $id = 'UserId_UserReportTitle'; protected $order = 40; + public function getHelp() + { + return '<p>' . Piwik::translate('UserId_VisitorsUserSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/UserId/lang/en.json b/plugins/UserId/lang/en.json index 4fccd61bd4..0603567b0f 100644 --- a/plugins/UserId/lang/en.json +++ b/plugins/UserId/lang/en.json @@ -3,6 +3,7 @@ "UserId": "UserId", "UserReportTitle": "User IDs", "UserReportDocumentation": "This report shows visits and other general metrics for every individual User ID.", - "PluginDescription": "Shows user reports" + "PluginDescription": "Shows user reports", + "VisitorsUserSubcategoryHelp": "The User IDs report shows visits associated with all of your registered and logged in users. You can use this section to understand website usage by specific users and identify who your most and least active users are." } }
\ No newline at end of file diff --git a/plugins/VisitTime/Categories/TimesSubcategory.php b/plugins/VisitTime/Categories/TimesSubcategory.php index 701a5d6ec3..af28e252ba 100644 --- a/plugins/VisitTime/Categories/TimesSubcategory.php +++ b/plugins/VisitTime/Categories/TimesSubcategory.php @@ -9,6 +9,7 @@ namespace Piwik\Plugins\VisitTime\Categories; use Piwik\Category\Subcategory; +use Piwik\Piwik; class TimesSubcategory extends Subcategory { @@ -16,4 +17,8 @@ class TimesSubcategory extends Subcategory protected $id = 'VisitTime_SubmenuTimes'; protected $order = 35; + public function getHelp() + { + return '<p>' . Piwik::translate('VisitTime_TimesSubcategoryHelp') . '</p>'; + } } diff --git a/plugins/VisitTime/lang/en.json b/plugins/VisitTime/lang/en.json index 6ab07b2c31..d3674802b9 100644 --- a/plugins/VisitTime/lang/en.json +++ b/plugins/VisitTime/lang/en.json @@ -30,6 +30,7 @@ "WidgetLocalTime": "Visits by Local Time", "WidgetLocalTimeDocumentation": "This graph shows what time it was in the %1$s visitors' time zones %2$s during their visits.", "WidgetServerTime": "Visits by Server Time", - "WidgetServerTimeDocumentation": "This graph shows what time it was in the %1$s server's time zone %2$s during the visits." + "WidgetServerTimeDocumentation": "This graph shows what time it was in the %1$s server's time zone %2$s during the visits.", + "TimesSubcategoryHelp": "The Times section shows you when people are visiting your site. You can see the most popular local times your users visit at, so you can understand where your site fits into their life. Additionally, it shows the most popular server times, which can reveal demands on your technology stack." } }
\ No newline at end of file diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportPagesMetadata.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportPagesMetadata.xml index 82650e37a9..654401e52e 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportPagesMetadata.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportPagesMetadata.xml @@ -7,11 +7,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <widgets> <row> @@ -111,11 +113,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Transitions_Transitions</id> <name>Transitions</name> <order>46</order> + <help><p>Transitions gives you a report that shows the things your visitors did directly before and after viewing a certain page. This page will explain how to access, understand, and use the powerful Transitions report.</p><p><a href="https://matomo.org/docs/transitions/" rel="noreferrer noopener" target="_blank">More Details</a></p></help> </subcategory> <widgets> <row> @@ -139,11 +143,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Downloads</id> <name>Downloads</name> <order>35</order> + <help><p>In this report, you can see which files your visitors have downloaded.</p><p>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.</p></help> </subcategory> <widgets> <row> @@ -169,11 +175,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesEntry</id> <name>Entry pages</name> <order>10</order> + <help><p>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.</p><p>The entry URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <widgets> <row> @@ -213,11 +221,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesExit</id> <name>Exit pages</name> <order>15</order> + <help><p>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.</p><p>The exit URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <widgets> <row> @@ -257,11 +267,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Outlinks</id> <name>Outlinks</name> <order>30</order> + <help><p>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).</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <widgets> <row> @@ -287,11 +299,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPageTitles</id> <name>Page titles</name> <order>20</order> + <help><p>This report contains information about the titles of the pages that have been visited.</p><p>The page title is the HTML &lt;title&gt; Tag that most browsers show in their window title.</p></help> </subcategory> <widgets> <row> @@ -317,11 +331,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Pages</id> <name>Pages</name> <order>5</order> + <help><p>This report contains information about the page URLs that have been visited.</p><p>The table is organized hierarchically, the URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <widgets> <row> @@ -347,11 +363,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <widgets> <row> @@ -433,11 +451,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <widgets> <row> @@ -462,11 +482,13 @@ <name>Actions</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>99</order> + <help /> </subcategory> <module>Events</module> <action>getCategory</action> @@ -488,11 +510,13 @@ <name>Actions</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>99</order> + <help /> </subcategory> <module>Events</module> <action>getAction</action> @@ -514,11 +538,13 @@ <name>Actions</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>99</order> + <help /> </subcategory> <module>Events</module> <action>getName</action> @@ -544,11 +570,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>45</order> + <help><p>Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.</p><p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">Learn more in the Content Tracking guide.</a></p></help> </subcategory> <widgets> <row> @@ -573,11 +601,13 @@ <name>Actions</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>99</order> + <help /> </subcategory> <module>Contents</module> <action>getContentNames</action> @@ -598,11 +628,13 @@ <name>Actions</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>99</order> + <help /> </subcategory> <module>Contents</module> <action>getContentPieces</action> @@ -627,11 +659,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>PagePerformance_Performance</id> <name>Performance</name> <order>47</order> + <help><p>The Performance section can help you analyse how fast your website or app is performing on the whole and help discover whether you have specific pages that significantly deviate from your averages.</p><p>You can also find reports showing exactly how long each page of your website takes to load and what is contributing to their loading time.</p></help> </subcategory> <widgets> <row> @@ -709,11 +743,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Devices</id> <name>Devices</name> <order>15</order> + <help><p>The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.</p></help> </subcategory> <widgets> <row> @@ -781,11 +817,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <widgets> <row> @@ -895,11 +933,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Visitors Overview helps you understand the popularity of your site. It does this by providing charts that show how many visits your site is receiving over a selected period and the average level of engagement for key features, such as searches and downloads.</p></help> </subcategory> <widgets> <row> @@ -943,11 +983,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <widgets> <row> @@ -998,11 +1040,13 @@ <name>Visitors</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -1023,11 +1067,13 @@ <name>Visitors</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getDistinctCountries</action> @@ -1108,11 +1154,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>VisitTime_SubmenuTimes</id> <name>Times</name> <order>35</order> + <help><p>The Times section shows you when people are visiting your site. You can see the most popular local times your users visit at, so you can understand where your site fits into their life. Additionally, it shows the most popular server times, which can reveal demands on your technology stack.</p></help> </subcategory> <widgets> <row> @@ -1166,11 +1214,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountryMap_RealTimeMap</id> <name>Real-time Map</name> <order>9</order> + <help><p>The Real-time Map shows the location of visitors on your site within the last 30 minutes. Large orange bubbles represent more recent visits, while smaller grey bubbles represent older visits. This data refreshes every five seconds, and new visitors appear with a flashing effect.</p></help> </subcategory> <widgets> <row> @@ -1194,11 +1244,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>General_RealTime</id> <name>Real-time</name> <order>7</order> + <help><p>The Visits in Real-time report shows the real-time flow of visits to your website. It includes a real-time counter of your visits and page views in the last 24 hours and the previous 30 minutes.</p><p>This report refreshes every 5 seconds and displays new visits (or existing visitors that view a new page) at the top of the list with a fade-in effect.</p></help> </subcategory> <widgets> <row> @@ -1222,11 +1274,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>Live_VisitorLog</id> <name>Visits Log</name> <order>5</order> + <help><p>The Visits Log shows you every visit your website receives in detail. You can see what actions each visitor has taken, how they got to your site, a bit about who they are, and more (while still complying with your local privacy regulations).</p><p>While other reports in Matomo show how your visitors behave at an aggregate level, the Visits Log provides granular detail. You can also use segments to narrow it down to specific types of visits to understand your visitors better.</p><p><a href="https://matomo.org/docs/real-time/" target="_blank" rel="noreferrer noopener">Learn more in the Visits Log guide.</a></p></help> </subcategory> <widgets> <row> @@ -1255,11 +1309,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserId_UserReportTitle</id> <name>User IDs</name> <order>40</order> + <help><p>The User IDs report shows visits associated with all of your registered and logged in users. You can use this section to understand website usage by specific users and identify who your most and least active users are.</p></help> </subcategory> <widgets> <row> @@ -1285,11 +1341,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>CustomVariables_CustomVariables</id> <name>Custom Variables</name> <order>45</order> + <help><p>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.</p><p><a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank">Read more about this topic in the online guide.</a></p></help> </subcategory> <widgets> <row> @@ -1315,11 +1373,13 @@ <name>Dashboard</name> <order>0</order> <icon>icon-reporting-dashboard</icon> + <help><p>This is a dashboard page. Dashboards are a collection of Matomo's widgets that you add yourself to suit your specific needs. Mix and match any of Matomo's widgets to get the data <strong>*you*</strong> need at a glance.</p></help> </category> <subcategory> <id>1</id> <name>Dashboard</name> <order>0</order> + <help /> </subcategory> <widgets> <row> @@ -1344,11 +1404,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_WidgetGetAll</id> <name>All Channels</name> <order>5</order> + <help><p>This section shows you the number of visits that arrive from different channel types and referrers. Click on the plus or minus buttons to view the referrers within each type.</p><p>You can also analyse the number of actions performed by each of your traffic sources by enabling the table with Visitor engagement metrics view.</p></help> </subcategory> <widgets> <row> @@ -1388,11 +1450,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_URLCampaignBuilder</id> <name>Campaign URL Builder</name> <order>21</order> + <help /> </subcategory> <widgets> <row> @@ -1416,11 +1480,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_Campaigns</id> <name>Campaigns</name> <order>20</order> + <help><p>The Campaign Tracking section allows you to analyse the visits associated with the various tracking values that have been linked to your digital campaigns. It can reveal things like, how much traffic your campaigns are bringing in, which creatives are performing best, how engaged campaign visitors are, and whether the campaign is resulting in sales or not.</p></help> </subcategory> <widgets> <row> @@ -1446,11 +1512,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Acquisition Overview shows you the percentage of your traffic from all sources over a selected date range.</p><p>You can also click on a specific channel type to display it within the evolution graph. This can help you discover which channels contribute the most traffic to your site as well as any potential patterns over time. For example, a certain channel may perform better on weekends.</p></help> </subcategory> <widgets> <row> @@ -1497,11 +1565,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_SubmenuSearchEngines</id> <name>Search Engines & Keywords</name> <order>10</order> + <help><p>This section helps you analyse your search engine optimisation and performance. You can analyse your most popular keywords with the combined keyword reports or see which keywords perform well on specific search engines for more targeted analysis and optimisation.</p><p><a href="https://matomo.org/matomo-cloud/" rel="noreferrer noopener" target="_blank">Matomo Cloud</a> and <a href="https://plugins.matomo.org/SearchEngineKeywordsPerformance" rel="noreferrer noopener" target="_blank">Search Engine Keywords Performance</a> plugin users will receive the best results from this report.</p></help> </subcategory> <widgets> <row> @@ -1541,11 +1611,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_Socials</id> <name>Social Networks</name> <order>16</order> + <help><p>In this table, you can see which websites referred visitors to your site.</p><p>By clicking on a row in the table, you can see which URLs the links to your website were on.</p></help> </subcategory> <widgets> <row> @@ -1571,11 +1643,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_SubmenuWebsitesOnly</id> <name>Websites</name> <order>15</order> + <help><p>In this table, you can see which websites referred visitors to your site.</p><p>By clicking on a row in the table, you can see which URLs the links to your website were on.</p></help> </subcategory> <widgets> <row> @@ -1601,11 +1675,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>1</id> <name>Goal 1 - Thank you</name> <order>900</order> + <help /> </subcategory> <widgets> <row> @@ -1630,11 +1706,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -1658,11 +1736,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -1687,11 +1767,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -1740,11 +1822,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -1769,11 +1853,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -1798,11 +1884,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -1827,11 +1915,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -1856,11 +1946,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -1885,11 +1977,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -1914,11 +2008,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -1943,11 +2039,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -1972,11 +2070,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -2001,11 +2101,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -2030,11 +2132,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -2059,11 +2163,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -2088,11 +2194,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -2117,11 +2225,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -2146,11 +2256,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -2175,11 +2287,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -2204,11 +2318,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -2237,11 +2353,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>2</id> <name>Goal 2 - Hello</name> <order>901</order> + <help /> </subcategory> <widgets> <row> @@ -2266,11 +2384,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -2294,11 +2414,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2323,11 +2445,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -2376,11 +2500,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -2405,11 +2531,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -2434,11 +2562,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -2463,11 +2593,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -2492,11 +2624,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -2521,11 +2655,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -2550,11 +2686,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -2579,11 +2717,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -2608,11 +2748,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -2637,11 +2779,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -2666,11 +2810,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -2695,11 +2841,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -2724,11 +2872,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -2753,11 +2903,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -2782,11 +2934,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -2811,11 +2965,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -2840,11 +2996,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -2873,11 +3031,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>3</id> <name>triggered js</name> <order>902</order> + <help /> </subcategory> <widgets> <row> @@ -2902,11 +3062,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -2930,11 +3092,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2959,11 +3123,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -3012,11 +3178,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -3041,11 +3209,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -3070,11 +3240,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -3099,11 +3271,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -3128,11 +3302,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -3157,11 +3333,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -3186,11 +3364,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -3215,11 +3395,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -3244,11 +3426,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -3273,11 +3457,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -3302,11 +3488,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -3331,11 +3519,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -3360,11 +3550,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -3389,11 +3581,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -3418,11 +3612,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -3447,11 +3643,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -3476,11 +3674,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -3509,11 +3709,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Goals Overview reports on the performance of the goals defined for your website. You can access your goal’s conversion percentages, amount of revenue generated and full reports for each.</p><p>Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.</p></help> </subcategory> <widgets> <row> @@ -3538,11 +3740,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -3565,11 +3769,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -3592,11 +3798,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -3622,11 +3830,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -3652,11 +3862,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -3703,11 +3915,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -3732,11 +3946,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -3761,11 +3977,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -3790,11 +4008,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -3819,11 +4039,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -3848,11 +4070,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -3877,11 +4101,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -3906,11 +4132,13 @@ <name>Goals by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User location</id> <name>Goals by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -3935,11 +4163,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -3964,11 +4194,13 @@ <name>Goals by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by User attribute</id> <name>Goals by User attribute</name> <order>99</order> + <help /> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -3993,11 +4225,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -4022,11 +4256,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -4051,11 +4287,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -4080,11 +4318,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -4109,11 +4349,13 @@ <name>Goals by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals by Referrers</id> <name>Goals by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -4138,11 +4380,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -4167,11 +4411,13 @@ <name>Goals engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals engagement</id> <name>Goals engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -4200,11 +4446,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>Goals_ManageGoals</id> <name>Manage Goals</name> <order>9999</order> + <help><p>This section allows you to create and edit Goals for specific actions which visitors take on your site, such as visiting a certain page or submitting a specific form. Goal reports vary but can help you track your website performance against business objectives such as lead generation, online sales and increased brand exposure.</p><p><a href="https://matomo.org/docs/tracking-goals-web-analytics/" rel="noreferrer noopener" target="_blank">Learn more in our Goals guide here.</a></p></help> </subcategory> <widgets> <row> @@ -4228,11 +4476,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_EcommerceLog</id> <name>Ecommerce Log</name> <order>5</order> + <help><p>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.</p><p>Data on this page is updated in real-time.</p></help> </subcategory> <widgets> <row> @@ -4256,11 +4506,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>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.</p><p>Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.</p></help> </subcategory> <widgets> <row> @@ -4285,11 +4537,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -4313,11 +4567,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Ecommerce</module> <action>getSparklines</action> @@ -4341,11 +4597,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>ecommerceOrder</id> <name>ecommerceOrder</name> <order>99</order> + <help /> </subcategory> <module>Ecommerce</module> <action>getConversionsOverview</action> @@ -4376,11 +4634,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <widgets> <row> @@ -4405,11 +4665,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getItemsName</action> @@ -4430,11 +4692,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getItemsSku</action> @@ -4455,11 +4719,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getItemsCategory</action> @@ -4484,11 +4750,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <widgets> <row> @@ -4514,11 +4782,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -4544,11 +4814,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -4574,11 +4846,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -4604,11 +4878,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -4634,11 +4910,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -4664,11 +4942,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -4694,11 +4974,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -4724,11 +5006,13 @@ <name>Sales by User location</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User location</id> <name>Sales by User location</name> <order>99</order> + <help /> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -4754,11 +5038,13 @@ <name>Sales by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User attribute</id> <name>Sales by User attribute</name> <order>99</order> + <help /> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -4784,11 +5070,13 @@ <name>Sales by User attribute</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by User attribute</id> <name>Sales by User attribute</name> <order>99</order> + <help /> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -4814,11 +5102,13 @@ <name>Sales by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by Referrers</id> <name>Sales by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -4844,11 +5134,13 @@ <name>Sales by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by Referrers</id> <name>Sales by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -4874,11 +5166,13 @@ <name>Sales by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by Referrers</id> <name>Sales by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -4904,11 +5198,13 @@ <name>Sales by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by Referrers</id> <name>Sales by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -4934,11 +5230,13 @@ <name>Sales by Referrers</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales by Referrers</id> <name>Sales by Referrers</name> <order>99</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -4964,11 +5262,13 @@ <name>Sales engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales engagement</id> <name>Sales engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -4994,11 +5294,13 @@ <name>Sales engagement</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>Sales engagement</id> <name>Sales engagement</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -5028,11 +5330,13 @@ <name>Marketplace</name> <order>200</order> <icon> icon-open-source</icon> + <help /> </category> <subcategory> <id>Marketplace_Browse</id> <name>Browse</name> <order>5</order> + <help /> </subcategory> <widgets> <row> @@ -5057,11 +5361,13 @@ <name>Marketplace</name> <order>200</order> <icon> icon-open-source</icon> + <help /> </category> <subcategory> <id>Marketplace_PaidPlugins</id> <name>Premium Features</name> <order>10</order> + <help /> </subcategory> <widgets> <row> @@ -5085,11 +5391,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>ExampleUI_GetTemperaturesDataTable</id> <name>Data tables</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5115,11 +5423,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Bar graph</id> <name>Bar graph</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5147,11 +5457,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Treemap</id> <name>Treemap</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5179,11 +5491,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Sparklines</id> <name>Sparklines</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5211,11 +5525,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Evolution Graph</id> <name>Evolution Graph</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5247,11 +5563,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Pie graph</id> <name>Pie graph</name> <order>99</order> + <help /> </subcategory> <widgets> <row> @@ -5277,11 +5595,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Tag clouds</id> <name>Tag clouds</name> <order>99</order> + <help /> </subcategory> <widgets> <row> diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getWidgetMetadata.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getWidgetMetadata.xml index a4b88dcc80..bc2542cb78 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getWidgetMetadata.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getWidgetMetadata.xml @@ -7,6 +7,7 @@ <name>KPI Metric</name> <order>1</order> <icon /> + <help /> </category> <subcategory /> <module>CoreVisualizations</module> @@ -27,6 +28,7 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory /> <module>Live</module> @@ -48,6 +50,7 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory /> <module>Live</module> @@ -67,6 +70,7 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory /> <module>CoreHome</module> @@ -89,11 +93,13 @@ <name>Visitors</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>VisitsSummary</module> <action>getEvolutionGraph</action> @@ -116,11 +122,13 @@ <name>Visitors</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>VisitsSummary</module> <action>get</action> @@ -145,11 +153,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Visitors Overview helps you understand the popularity of your site. It does this by providing charts that show how many visits your site is receiving over a selected period and the average level of engagement for key features, such as searches and downloads.</p></help> </subcategory> <module>VisitsSummary</module> <action>getEvolutionGraph</action> @@ -172,11 +182,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Visitors Overview helps you understand the popularity of your site. It does this by providing charts that show how many visits your site is receiving over a selected period and the average level of engagement for key features, such as searches and downloads.</p></help> </subcategory> <module>VisitsSummary</module> <action>get</action> @@ -199,11 +211,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>Live_VisitorLog</id> <name>Visits Log</name> <order>5</order> + <help><p>The Visits Log shows you every visit your website receives in detail. You can see what actions each visitor has taken, how they got to your site, a bit about who they are, and more (while still complying with your local privacy regulations).</p><p>While other reports in Matomo show how your visitors behave at an aggregate level, the Visits Log provides granular detail. You can also use segments to narrow it down to specific types of visits to understand your visitors better.</p><p><a href="https://matomo.org/docs/real-time/" target="_blank" rel="noreferrer noopener">Learn more in the Visits Log guide.</a></p></help> </subcategory> <module>Live</module> <action>getLastVisitsDetails</action> @@ -227,11 +241,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>General_RealTime</id> <name>Real-time</name> <order>7</order> + <help><p>The Visits in Real-time report shows the real-time flow of visits to your website. It includes a real-time counter of your visits and page views in the last 24 hours and the previous 30 minutes.</p><p>This report refreshes every 5 seconds and displays new visits (or existing visitors that view a new page) at the top of the list with a fade-in effect.</p></help> </subcategory> <module>Live</module> <action>widget</action> @@ -250,11 +266,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountryMap_RealTimeMap</id> <name>Real-time Map</name> <order>9</order> + <help><p>The Real-time Map shows the location of visitors on your site within the last 30 minutes. Large orange bubbles represent more recent visits, while smaller grey bubbles represent older visits. This data refreshes every five seconds, and new visitors appear with a flashing effect.</p></help> </subcategory> <module>UserCountryMap</module> <action>realtimeMap</action> @@ -273,11 +291,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserCountryMap</module> <action>visitorMap</action> @@ -296,11 +316,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -321,11 +343,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -346,11 +370,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -371,11 +397,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -396,11 +424,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserLanguage</module> <action>getLanguage</action> @@ -421,11 +451,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserCountry_SubmenuLocations</id> <name>Locations</name> <order>10</order> + <help><p>The Locations section is the best way to find out where people are when they visit your site. It reveals the countries, continents, regions, cities that you visitors come from, in tables and map form. Additionally, you can see what language their browser is set to, helping identify international visitors in alternative locations.</p></help> </subcategory> <module>UserLanguage</module> <action>getLanguageCode</action> @@ -446,11 +478,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Devices</id> <name>Devices</name> <order>15</order> + <help><p>The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -471,11 +505,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Devices</id> <name>Devices</name> <order>15</order> + <help><p>The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.</p></help> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -496,11 +532,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Devices</id> <name>Devices</name> <order>15</order> + <help><p>The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.</p></help> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -521,11 +559,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Devices</id> <name>Devices</name> <order>15</order> + <help><p>The Devices section helps you understand the technology that your visitors are using to access your site. You will see reports on the type of device and specific models to enable you to optimise your site for the most popular devices.</p></help> </subcategory> <module>Resolution</module> <action>getResolution</action> @@ -546,11 +586,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicePlugins</module> <action>getPlugin</action> @@ -571,11 +613,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrowserEngines</action> @@ -596,11 +640,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrowserVersions</action> @@ -621,11 +667,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -646,11 +694,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicesDetection</module> <action>getOsFamilies</action> @@ -671,11 +721,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>DevicesDetection</module> <action>getOsVersions</action> @@ -696,11 +748,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>DevicesDetection_Software</id> <name>Software</name> <order>20</order> + <help><p>The Software section shows the operating systems, browsers and plugins that your visitors are using to access the site so that you can optimise your site to ensure it is fully compatible with the most popular configurations..</p></help> </subcategory> <module>Resolution</module> <action>getConfiguration</action> @@ -721,11 +775,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>VisitTime_SubmenuTimes</id> <name>Times</name> <order>35</order> + <help><p>The Times section shows you when people are visiting your site. You can see the most popular local times your users visit at, so you can understand where your site fits into their life. Additionally, it shows the most popular server times, which can reveal demands on your technology stack.</p></help> </subcategory> <module>VisitTime</module> <action>getByDayOfWeek</action> @@ -746,11 +802,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>VisitTime_SubmenuTimes</id> <name>Times</name> <order>35</order> + <help><p>The Times section shows you when people are visiting your site. You can see the most popular local times your users visit at, so you can understand where your site fits into their life. Additionally, it shows the most popular server times, which can reveal demands on your technology stack.</p></help> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerLocalTime</action> @@ -771,11 +829,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>VisitTime_SubmenuTimes</id> <name>Times</name> <order>35</order> + <help><p>The Times section shows you when people are visiting your site. You can see the most popular local times your users visit at, so you can understand where your site fits into their life. Additionally, it shows the most popular server times, which can reveal demands on your technology stack.</p></help> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -796,11 +856,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>UserId_UserReportTitle</id> <name>User IDs</name> <order>40</order> + <help><p>The User IDs report shows visits associated with all of your registered and logged in users. You can use this section to understand website usage by specific users and identify who your most and least active users are.</p></help> </subcategory> <module>UserId</module> <action>getUsers</action> @@ -821,11 +883,13 @@ <name>Visitors</name> <order>5</order> <icon>icon-reporting-visitors</icon> + <help><p>The Visitors pages tell you things about who your visitors are. Things like where your visitors came from, what devices and browsers they're using and when they generally visit your website. Understand, in the aggregate, who your audience is, and look for outliers to see how your audience could grow.</p><p>In addition to general information about your visitors, you can also use the <a href="#" onclick="this.href=broadcast.buildReportingUrl('category=General_Visitors&subcategory=Live_VisitorLog')">Visits Log</a> to see what occurred in every individual visit.</p></help> </category> <subcategory> <id>CustomVariables_CustomVariables</id> <name>Custom Variables</name> <order>45</order> + <help><p>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.</p><p><a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank">Read more about this topic in the online guide.</a></p></help> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -846,11 +910,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Pages</id> <name>Pages</name> <order>5</order> + <help><p>This report contains information about the page URLs that have been visited.</p><p>The table is organized hierarchically, the URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getPageUrls</action> @@ -871,11 +937,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesEntry</id> <name>Entry pages</name> <order>10</order> + <help><p>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.</p><p>The entry URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getEntryPageTitles</action> @@ -896,11 +964,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesEntry</id> <name>Entry pages</name> <order>10</order> + <help><p>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.</p><p>The entry URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getEntryPageUrls</action> @@ -921,11 +991,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesExit</id> <name>Exit pages</name> <order>15</order> + <help><p>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.</p><p>The exit URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getExitPageTitles</action> @@ -946,11 +1018,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPagesExit</id> <name>Exit pages</name> <order>15</order> + <help><p>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.</p><p>The exit URLs are displayed as a folder structure.</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getExitPageUrls</action> @@ -971,11 +1045,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuPageTitles</id> <name>Page titles</name> <order>20</order> + <help><p>This report contains information about the titles of the pages that have been visited.</p><p>The page title is the HTML &lt;title&gt; Tag that most browsers show in their window title.</p></help> </subcategory> <module>Actions</module> <action>getPageTitles</action> @@ -996,11 +1072,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <module>Actions</module> <action>getPageTitlesFollowingSiteSearch</action> @@ -1021,11 +1099,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <module>Actions</module> <action>getPageUrlsFollowingSiteSearch</action> @@ -1046,11 +1126,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <module>Actions</module> <action>getSiteSearchCategories</action> @@ -1071,11 +1153,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <module>Actions</module> <action>getSiteSearchKeywords</action> @@ -1096,11 +1180,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Actions_SubmenuSitesearch</id> <name>Site Search</name> <order>25</order> + <help><p>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.</p><p>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.</p><p><a href="https://matomo.org/docs/site-search/" rel="noreferrer noopener" target="_blank">Learn more in the Site Search guide.</a></p></help> </subcategory> <module>Actions</module> <action>getSiteSearchNoResultKeywords</action> @@ -1121,11 +1207,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Outlinks</id> <name>Outlinks</name> <order>30</order> + <help><p>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).</p><p>Use the plus and minus icons on the left to navigate.</p></help> </subcategory> <module>Actions</module> <action>getOutlinks</action> @@ -1146,11 +1234,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>General_Downloads</id> <name>Downloads</name> <order>35</order> + <help><p>In this report, you can see which files your visitors have downloaded.</p><p>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.</p></help> </subcategory> <module>Actions</module> <action>getDownloads</action> @@ -1171,11 +1261,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getAction</action> @@ -1197,11 +1289,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getAction</action> @@ -1223,11 +1317,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getCategory</action> @@ -1249,11 +1345,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getCategory</action> @@ -1275,11 +1373,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getName</action> @@ -1301,11 +1401,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Events_Events</id> <name>Events</name> <order>40</order> + <help><p>The Events section offers reports on the custom events associated with your site. Events typically require custom configuration. Once configured you can review reports broken down by category, action and name.</p><p><a href="https://matomo.org/docs/event-tracking/" rel="noreferrer noopener" target="_blank">Learn more about event tracking here.</a></p></help> </subcategory> <module>Events</module> <action>getName</action> @@ -1327,11 +1429,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>45</order> + <help><p>Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.</p><p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">Learn more in the Content Tracking guide.</a></p></help> </subcategory> <module>Contents</module> <action>getContentNames</action> @@ -1352,11 +1456,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>45</order> + <help><p>Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.</p><p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">Learn more in the Content Tracking guide.</a></p></help> </subcategory> <module>Contents</module> <action>getContentNames</action> @@ -1377,11 +1483,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>45</order> + <help><p>Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.</p><p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">Learn more in the Content Tracking guide.</a></p></help> </subcategory> <module>Contents</module> <action>getContentPieces</action> @@ -1402,11 +1510,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Contents_Contents</id> <name>Contents</name> <order>45</order> + <help><p>Content tracking helps you determine the popularity of specific pieces of content on any page of your website or app. This section reports the number of impressions and interactions the various pieces of content on your site receive.</p><p><a href="https://matomo.org/docs/content-tracking/" rel="noreferrer noopener" target="_blank">Learn more in the Content Tracking guide.</a></p></help> </subcategory> <module>Contents</module> <action>getContentPieces</action> @@ -1427,11 +1537,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>Transitions_Transitions</id> <name>Transitions</name> <order>46</order> + <help><p>Transitions gives you a report that shows the things your visitors did directly before and after viewing a certain page. This page will explain how to access, understand, and use the powerful Transitions report.</p><p><a href="https://matomo.org/docs/transitions/" rel="noreferrer noopener" target="_blank">More Details</a></p></help> </subcategory> <module>Transitions</module> <action>getTransitions</action> @@ -1450,11 +1562,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitFrequency</module> <action>getEvolutionGraph</action> @@ -1477,11 +1591,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitFrequency</module> <action>get</action> @@ -1504,11 +1620,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitorInterest</module> <action>getNumberOfVisitsByDaysSinceLast</action> @@ -1529,11 +1647,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitorInterest</module> <action>getNumberOfVisitsByVisitCount</action> @@ -1554,11 +1674,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitorInterest</module> <action>getNumberOfVisitsPerPage</action> @@ -1579,11 +1701,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>VisitorInterest_Engagement</id> <name>Engagement</name> <order>46</order> + <help><p>The Engagement section provides reports that help to quantify how many new and returning visitors you get. You can also review reports that break down the average time and number of pages per visit, as well as the number of times a visitor has been to your site and the most common number of days between visits.</p><p>This can help you to optimise for frequency and high-interaction visits in addition to maximising your reach.</p></help> </subcategory> <module>VisitorInterest</module> <action>getNumberOfVisitsPerVisitDuration</action> @@ -1604,11 +1728,13 @@ <name>Behaviour</name> <order>10</order> <icon>icon-reporting-actions</icon> + <help /> </category> <subcategory> <id>PagePerformance_Performance</id> <name>Performance</name> <order>47</order> + <help><p>The Performance section can help you analyse how fast your website or app is performing on the whole and help discover whether you have specific pages that significantly deviate from your averages.</p><p>You can also find reports showing exactly how long each page of your website takes to load and what is contributing to their loading time.</p></help> </subcategory> <module>PagePerformance</module> <action>getEvolutionGraph</action> @@ -1631,11 +1757,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_WidgetGetAll</id> <name>All Channels</name> <order>5</order> + <help><p>This section shows you the number of visits that arrive from different channel types and referrers. Click on the plus or minus buttons to view the referrers within each type.</p><p>You can also analyse the number of actions performed by each of your traffic sources by enabling the table with Visitor engagement metrics view.</p></help> </subcategory> <module>Referrers</module> <action>getAll</action> @@ -1656,11 +1784,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_WidgetGetAll</id> <name>All Channels</name> <order>5</order> + <help><p>This section shows you the number of visits that arrive from different channel types and referrers. Click on the plus or minus buttons to view the referrers within each type.</p><p>You can also analyse the number of actions performed by each of your traffic sources by enabling the table with Visitor engagement metrics view.</p></help> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -1681,11 +1811,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_SubmenuSearchEngines</id> <name>Search Engines & Keywords</name> <order>10</order> + <help><p>This section helps you analyse your search engine optimisation and performance. You can analyse your most popular keywords with the combined keyword reports or see which keywords perform well on specific search engines for more targeted analysis and optimisation.</p><p><a href="https://matomo.org/matomo-cloud/" rel="noreferrer noopener" target="_blank">Matomo Cloud</a> and <a href="https://plugins.matomo.org/SearchEngineKeywordsPerformance" rel="noreferrer noopener" target="_blank">Search Engine Keywords Performance</a> plugin users will receive the best results from this report.</p></help> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -1706,11 +1838,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_SubmenuSearchEngines</id> <name>Search Engines & Keywords</name> <order>10</order> + <help><p>This section helps you analyse your search engine optimisation and performance. You can analyse your most popular keywords with the combined keyword reports or see which keywords perform well on specific search engines for more targeted analysis and optimisation.</p><p><a href="https://matomo.org/matomo-cloud/" rel="noreferrer noopener" target="_blank">Matomo Cloud</a> and <a href="https://plugins.matomo.org/SearchEngineKeywordsPerformance" rel="noreferrer noopener" target="_blank">Search Engine Keywords Performance</a> plugin users will receive the best results from this report.</p></help> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -1731,11 +1865,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_SubmenuWebsitesOnly</id> <name>Websites</name> <order>15</order> + <help><p>In this table, you can see which websites referred visitors to your site.</p><p>By clicking on a row in the table, you can see which URLs the links to your website were on.</p></help> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -1756,11 +1892,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_Socials</id> <name>Social Networks</name> <order>16</order> + <help><p>In this table, you can see which websites referred visitors to your site.</p><p>By clicking on a row in the table, you can see which URLs the links to your website were on.</p></help> </subcategory> <module>Referrers</module> <action>getSocials</action> @@ -1781,11 +1919,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_Campaigns</id> <name>Campaigns</name> <order>20</order> + <help><p>The Campaign Tracking section allows you to analyse the visits associated with the various tracking values that have been linked to your digital campaigns. It can reveal things like, how much traffic your campaigns are bringing in, which creatives are performing best, how engaged campaign visitors are, and whether the campaign is resulting in sales or not.</p></help> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -1806,11 +1946,13 @@ <name>Acquisition</name> <order>15</order> <icon>icon-reporting-referer</icon> + <help /> </category> <subcategory> <id>Referrers_URLCampaignBuilder</id> <name>Campaign URL Builder</name> <order>21</order> + <help /> </subcategory> <module>Referrers</module> <action>getCampaignUrlBuilder</action> @@ -1829,11 +1971,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>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.</p><p>Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.</p></help> </subcategory> <module>CoreHome</module> <action>renderWidgetContainer</action> @@ -1855,11 +1999,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -1883,11 +2029,13 @@ <name>Ecommerce</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Ecommerce</module> <action>getSparklines</action> @@ -1911,11 +2059,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>ecommerceOrder</id> <name>ecommerceOrder</name> <order>99</order> + <help /> </subcategory> <module>Ecommerce</module> <action>getConversionsOverview</action> @@ -1944,11 +2094,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_EcommerceLog</id> <name>Ecommerce Log</name> <order>5</order> + <help><p>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.</p><p>Data on this page is updated in real-time.</p></help> </subcategory> <module>Ecommerce</module> <action>getEcommerceLog</action> @@ -1967,11 +2119,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsCategory</action> @@ -1992,11 +2146,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsCategory</action> @@ -2017,11 +2173,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsName</action> @@ -2042,11 +2200,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsName</action> @@ -2067,11 +2227,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsSku</action> @@ -2092,11 +2254,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Goals_Products</id> <name>Products</name> <order>10</order> + <help><p>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.</p></help> </subcategory> <module>Goals</module> <action>getItemsSku</action> @@ -2117,11 +2281,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>CustomVariables</module> <action>getCustomVariables</action> @@ -2147,11 +2313,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrand</action> @@ -2177,11 +2345,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>DevicesDetection</module> <action>getBrowsers</action> @@ -2207,11 +2377,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>DevicesDetection</module> <action>getModel</action> @@ -2237,11 +2409,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>DevicesDetection</module> <action>getType</action> @@ -2267,11 +2441,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Goals</module> <action>getDaysToConversion</action> @@ -2297,11 +2473,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Goals</module> <action>getVisitsUntilConversion</action> @@ -2327,11 +2505,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Referrers</module> <action>getCampaigns</action> @@ -2357,11 +2537,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Referrers</module> <action>getKeywords</action> @@ -2387,11 +2569,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Referrers</module> <action>getReferrerType</action> @@ -2417,11 +2601,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Referrers</module> <action>getSearchEngines</action> @@ -2447,11 +2633,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>Referrers</module> <action>getWebsites</action> @@ -2477,11 +2665,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>UserCountry</module> <action>getCity</action> @@ -2507,11 +2697,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>UserCountry</module> <action>getContinent</action> @@ -2537,11 +2729,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>UserCountry</module> <action>getCountry</action> @@ -2567,11 +2761,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>UserCountry</module> <action>getRegion</action> @@ -2597,11 +2793,13 @@ <name>Ecommerce</name> <order>20</order> <icon>icon-reporting-ecommerce</icon> + <help /> </category> <subcategory> <id>Ecommerce_Sales</id> <name>Sales</name> <order>15</order> + <help><p>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.</p><p>You can also learn exactly how revenue is associated with each dimension, such as specific traffic types or tracked campaigns.</p></help> </subcategory> <module>VisitTime</module> <action>getVisitInformationPerServerTime</action> @@ -2627,11 +2825,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>2</order> + <help><p>The Goals Overview reports on the performance of the goals defined for your website. You can access your goal’s conversion percentages, amount of revenue generated and full reports for each.</p><p>Click on an individual metric within the sparkline chart to focus on it within the full-sized evolution graph.</p></help> </subcategory> <module>CoreHome</module> <action>renderWidgetContainer</action> @@ -2653,11 +2853,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -2680,11 +2882,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2707,11 +2911,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2737,11 +2943,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2767,11 +2975,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>General_Overview</id> <name>Overview</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2799,11 +3009,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>1</id> <name>Goal 1 - Thank you</name> <order>900</order> + <help /> </subcategory> <module>CoreHome</module> <action>renderWidgetContainer</action> @@ -2825,11 +3037,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -2853,11 +3067,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2882,11 +3098,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>1</id> <name>1</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -2915,11 +3133,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>2</id> <name>Goal 2 - Hello</name> <order>901</order> + <help /> </subcategory> <module>CoreHome</module> <action>renderWidgetContainer</action> @@ -2941,11 +3161,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -2969,11 +3191,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -2998,11 +3222,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>2</id> <name>2</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -3031,11 +3257,13 @@ <name>Goals</name> <order>25</order> <icon>icon-reporting-goal</icon> + <help /> </category> <subcategory> <id>3</id> <name>triggered js</name> <order>902</order> + <help /> </subcategory> <module>CoreHome</module> <action>renderWidgetContainer</action> @@ -3057,11 +3285,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>getEvolutionGraph</action> @@ -3085,11 +3315,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>get</action> @@ -3114,11 +3346,13 @@ <name>Goals</name> <order>99</order> <icon /> + <help /> </category> <subcategory> <id>3</id> <name>3</name> <order>99</order> + <help /> </subcategory> <module>Goals</module> <action>goalConversionsOverview</action> @@ -3147,11 +3381,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Pie graph</id> <name>Pie graph</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getPlanetRatios</action> @@ -3172,11 +3408,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Tag clouds</id> <name>Tag clouds</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getPlanetRatiosWithLogos</action> @@ -3197,11 +3435,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Tag clouds</id> <name>Tag clouds</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getPlanetRatios</action> @@ -3224,11 +3464,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>ExampleUI_GetTemperaturesDataTable</id> <name>Data tables</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getTemperatures</action> @@ -3249,11 +3491,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Evolution Graph</id> <name>Evolution Graph</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getTemperaturesEvolution</action> @@ -3280,11 +3524,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Sparklines</id> <name>Sparklines</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getTemperaturesEvolution</action> @@ -3307,11 +3553,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Bar graph</id> <name>Bar graph</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getTemperatures</action> @@ -3334,11 +3582,13 @@ <name>UI Framework</name> <order>90</order> <icon /> + <help /> </category> <subcategory> <id>Treemap</id> <name>Treemap</name> <order>99</order> + <help /> </subcategory> <module>ExampleUI</module> <action>getTemperatures</action> @@ -3361,6 +3611,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>CoreAdminHome</module> @@ -3380,6 +3631,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>CoreHome</module> @@ -3399,6 +3651,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>CoreHome</module> @@ -3418,6 +3671,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>CoreHome</module> @@ -3437,6 +3691,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>CoreHome</module> @@ -3456,6 +3711,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>ExamplePlugin</module> @@ -3475,6 +3731,7 @@ <name>Insights</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>Insights</module> @@ -3494,6 +3751,7 @@ <name>Insights</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>Insights</module> @@ -3513,6 +3771,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>Installation</module> @@ -3532,6 +3791,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>ProfessionalServices</module> @@ -3551,6 +3811,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>RssWidget</module> @@ -3570,6 +3831,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>RssWidget</module> @@ -3589,6 +3851,7 @@ <name>SEO</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>SEO</module> @@ -3608,6 +3871,7 @@ <name>About Matomo</name> <order>99</order> <icon /> + <help /> </category> <subcategory /> <module>Tour</module> @@ -3627,6 +3891,7 @@ <name>Marketplace</name> <order>200</order> <icon> icon-open-source</icon> + <help /> </category> <subcategory /> <module>Marketplace</module> @@ -3646,11 +3911,13 @@ <name>Marketplace</name> <order>200</order> <icon> icon-open-source</icon> + <help /> </category> <subcategory> <id>Marketplace_PaidPlugins</id> <name>Premium Features</name> <order>10</order> + <help /> </subcategory> <module>Marketplace</module> <action>getPremiumFeatures</action> diff --git a/tests/UI/expected-screenshots/Menus_mainmenu_lower_clicked.png b/tests/UI/expected-screenshots/Menus_mainmenu_lower_clicked.png index 6d98a52dac..5e2d3af8b9 100644 --- a/tests/UI/expected-screenshots/Menus_mainmenu_lower_clicked.png +++ b/tests/UI/expected-screenshots/Menus_mainmenu_lower_clicked.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:83944de86141ed69d015f357f8db606d94502bba21e3078ad895925ff64b059c -size 26077 +oid sha256:aab3f2e873ee336c96899a5983f0242cabe79e1973302a8cf29bcf96534355be +size 26370 diff --git a/tests/UI/expected-screenshots/UIIntegrationTest_actions_pages_tooltip_help.png b/tests/UI/expected-screenshots/UIIntegrationTest_actions_pages_tooltip_help.png index 9784b8fbc5..f3f2f9c391 100644 --- a/tests/UI/expected-screenshots/UIIntegrationTest_actions_pages_tooltip_help.png +++ b/tests/UI/expected-screenshots/UIIntegrationTest_actions_pages_tooltip_help.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:83e3e6fadc266ff3889086ab1d98c01b3395e98d89419280922f19e5c777392e -size 349790 +oid sha256:ff916bdb0df286e11815cfd6083e567e069c64e4df023a2ce256a280d53e3117 +size 349814 diff --git a/tests/UI/specs/UIIntegration_spec.js b/tests/UI/specs/UIIntegration_spec.js index c2bde5f9dc..9bf8d7a329 100644 --- a/tests/UI/specs/UIIntegration_spec.js +++ b/tests/UI/specs/UIIntegration_spec.js @@ -139,6 +139,14 @@ describe("UIIntegrationTest", function () { // TODO: Rename to Piwik? expect(await modal.screenshot()).to.matchImage('shortcuts'); }); + it('should show category help correctly', async function () { + await page.goto("?" + urlBase + "#?" + generalParams + "&category=General_Visitors&subcategory=General_Overview"); + await page.waitFor('.dataTable'); + await (await page.jQuery('#secondNavBar li[role=menuitem]:contains(Overview)')).hover(); + await (await page.jQuery('#secondNavBar li[role=menuitem]:contains(Overview) .item-help-icon')).click(); + expect(await page.screenshotSelector('#secondNavBar,#notificationContainer')).to.matchImage('category_help'); + }); + // one page w/ segment it('should load the visitors > overview page correctly when a segment is specified', async function () { testEnvironment.overrideConfig('General', { |
