diff options
author | Stefan Giehl <stefan@matomo.org> | 2021-01-05 03:41:51 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-05 03:41:51 +0300 |
commit | da9c6159702a228c1d50b65b87dd416730c092b0 (patch) | |
tree | 668f98c9bdba618df86556fa0afc014a8591e244 /plugins/Events | |
parent | 6f60a5ebfa306e66055cf76d0f98d1b5f2f127be (diff) |
Adds missing report documentations (#16878)
* Fix report documentation not shown when switching between related reports
* Adds report documentation for DevicesDetection reports
* Adds some more report documentations
* Adds documentation to Event reports
* Adds documentation to Content reports
* Adds documentation to VisitorFrequency report
* Adds documentation to Goals reports
* Adds documentation to VisitsSummary report
* fixes & test updates
* fix typo
Co-authored-by: Lukas Winkler <git@lw1.at>
* small tweaks to some docs
* revising some of the report documentation
* fix translation file
* updates expected test files
Co-authored-by: Lukas Winkler <git@lw1.at>
Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
Diffstat (limited to 'plugins/Events')
-rw-r--r-- | plugins/Events/Reports/GetAction.php | 2 | ||||
-rw-r--r-- | plugins/Events/Reports/GetCategory.php | 2 | ||||
-rw-r--r-- | plugins/Events/Reports/GetName.php | 2 | ||||
-rw-r--r-- | plugins/Events/lang/en.json | 3 |
4 files changed, 6 insertions, 3 deletions
diff --git a/plugins/Events/Reports/GetAction.php b/plugins/Events/Reports/GetAction.php index aac77c196e..e459c35478 100644 --- a/plugins/Events/Reports/GetAction.php +++ b/plugins/Events/Reports/GetAction.php @@ -19,7 +19,7 @@ class GetAction extends Base parent::init(); $this->dimension = new EventAction(); $this->name = Piwik::translate('Events_EventActions'); - $this->documentation = ''; // TODO + $this->documentation = Piwik::translate('Events_EventActionsReportDocumentation'); $this->metrics = array('nb_events', 'sum_event_value', 'min_event_value', 'max_event_value', 'nb_events_with_value'); if (Common::getRequestVar('secondaryDimension', false) == 'eventCategory') { $this->actionToLoadSubTables = 'getCategoryFromNameId'; diff --git a/plugins/Events/Reports/GetCategory.php b/plugins/Events/Reports/GetCategory.php index 520bf16962..1052ea5a3b 100644 --- a/plugins/Events/Reports/GetCategory.php +++ b/plugins/Events/Reports/GetCategory.php @@ -19,7 +19,7 @@ class GetCategory extends Base parent::init(); $this->dimension = new EventCategory(); $this->name = Piwik::translate('Events_EventCategories'); - $this->documentation = ''; // TODO + $this->documentation = Piwik::translate('Events_EventCategoriesReportDocumentation'); $this->metrics = array('nb_events', 'sum_event_value', 'min_event_value', 'max_event_value', 'nb_events_with_value'); if (Common::getRequestVar('secondaryDimension', false) == 'eventName') { $this->actionToLoadSubTables = 'getNameFromCategoryId'; diff --git a/plugins/Events/Reports/GetName.php b/plugins/Events/Reports/GetName.php index 9c009743f6..2d9fafc1f0 100644 --- a/plugins/Events/Reports/GetName.php +++ b/plugins/Events/Reports/GetName.php @@ -19,7 +19,7 @@ class GetName extends Base parent::init(); $this->dimension = new EventName(); $this->name = Piwik::translate('Events_EventNames'); - $this->documentation = ''; // TODO + $this->documentation = Piwik::translate('Events_EventNamesReportDocumentation'); $this->metrics = array('nb_events', 'sum_event_value', 'min_event_value', 'max_event_value', 'nb_events_with_value'); if (Common::getRequestVar('secondaryDimension', false) == 'eventCategory') { $this->actionToLoadSubTables = 'getCategoryFromNameId'; diff --git a/plugins/Events/lang/en.json b/plugins/Events/lang/en.json index 9cc8e7f0bf..fdbcdbb6e6 100644 --- a/plugins/Events/lang/en.json +++ b/plugins/Events/lang/en.json @@ -8,10 +8,13 @@ "Event": "Event", "EventAction": "Event Action", "EventActions": "Event Actions", + "EventActionsReportDocumentation": "This report shows you the number of times each event action occurred. You can view the event categories and names that were tracked along with each event action in the row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.", "EventCategories": "Event Categories", + "EventCategoriesReportDocumentation": "This report shows the categories of each tracked event and how many times they occurred. You can view the event actions and names that were tracked along with each event category in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.", "EventCategory": "Event Category", "EventName": "Event Name", "EventNames": "Event Names", + "EventNamesReportDocumentation": "This report shows you the names associated with each tracked event and how many times they occurred. You can view the event actions and categories that were tracked along with each event name in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.", "EventUrl": "Event URL", "EventUrls": "Event URLs", "Events": "Events", |