diff options
| author | Lukas Winkler <git@lw1.at> | 2020-09-13 23:50:09 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-13 23:50:09 +0300 |
| commit | 9f9d777ad37591dbdf2a62026aaf4cf822164c76 (patch) | |
| tree | ddd8d2eabae3d2d9c2757558c5deb94f7998cdde /plugins | |
| parent | 02a5d5c6fa153015b055ccf661c4a0f1aac7c92b (diff) | |
add documentation to the GetLanguage and GetLanguageCode reports (#16420)
Diffstat (limited to 'plugins')
4 files changed, 9 insertions, 5 deletions
diff --git a/plugins/CustomDimensions/tests/System/expected/test___API.getReportMetadata_day.xml b/plugins/CustomDimensions/tests/System/expected/test___API.getReportMetadata_day.xml index a2c6db5c41..d18499602f 100644 --- a/plugins/CustomDimensions/tests/System/expected/test___API.getReportMetadata_day.xml +++ b/plugins/CustomDimensions/tests/System/expected/test___API.getReportMetadata_day.xml @@ -256,6 +256,7 @@ <module>UserLanguage</module> <action>getLanguage</action> <dimension>Language</dimension> + <documentation>This report shows which language the visitor's browsers are using. (e.g. "English")</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -334,6 +335,7 @@ <module>UserLanguage</module> <action>getLanguageCode</action> <dimension>Language</dimension> + <documentation>This report shows which exact language code the visitor's browsers is set to. (e.g. "German - Austria (de-at)")</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -2573,4 +2575,4 @@ <imageGraphEvolutionUrl>index.php?module=API&method=ImageGraph.get&idSite=1&apiModule=API&apiAction=get&period=day&date=2012-12-25,2013-01-23</imageGraphEvolutionUrl> <uniqueId>API_get</uniqueId> </row> -</result>
\ No newline at end of file +</result> diff --git a/plugins/UserLanguage/Reports/GetLanguage.php b/plugins/UserLanguage/Reports/GetLanguage.php index adc2ac8ea2..ae3b92c223 100644 --- a/plugins/UserLanguage/Reports/GetLanguage.php +++ b/plugins/UserLanguage/Reports/GetLanguage.php @@ -20,7 +20,7 @@ class GetLanguage extends Base parent::init(); $this->dimension = new Language(); $this->name = Piwik::translate('UserLanguage_BrowserLanguage'); - $this->documentation = ''; // TODO + $this->documentation = Piwik::translate('UserLanguage_getLanguageDocumentation'); $this->order = 8; } diff --git a/plugins/UserLanguage/Reports/GetLanguageCode.php b/plugins/UserLanguage/Reports/GetLanguageCode.php index 0c1f56ba3e..85866b830f 100644 --- a/plugins/UserLanguage/Reports/GetLanguageCode.php +++ b/plugins/UserLanguage/Reports/GetLanguageCode.php @@ -19,7 +19,7 @@ class GetLanguageCode extends GetLanguage parent::init(); $this->dimension = new Language(); $this->name = Piwik::translate('UserLanguage_LanguageCode'); - $this->documentation = ''; + $this->documentation = Piwik::translate('UserLanguage_getLanguageCodeDocumentation'); $this->order = 11; } diff --git a/plugins/UserLanguage/lang/en.json b/plugins/UserLanguage/lang/en.json index ffbf336048..545a90ce54 100644 --- a/plugins/UserLanguage/lang/en.json +++ b/plugins/UserLanguage/lang/en.json @@ -2,6 +2,8 @@ "UserLanguage": { "BrowserLanguage": "Browser language", "LanguageCode": "Language code", - "PluginDescription": "Reports the language used by your visitors' browsers." + "PluginDescription": "Reports the language used by your visitors' browsers.", + "getLanguageDocumentation": "This report shows which language the visitor's browsers are using. (e.g. \"English\")", + "getLanguageCodeDocumentation": "This report shows which exact language code the visitor's browsers is set to. (e.g. \"German - Austria (de-at)\")" } -}
\ No newline at end of file +} |