function yandex_metrics_reports_help in Yandex.Metrics 8.3

Same name and namespace in other branches

1. 8.2 yandex_metrics_reports/yandex_metrics_reports.module \yandex_metrics_reports_help()
2. 6.2 yandex_metrics_reports/yandex_metrics_reports.module \yandex_metrics_reports_help()
3. 7.3 yandex_metrics_reports/yandex_metrics_reports.module \yandex_metrics_reports_help()
4. 7.2 yandex_metrics_reports/yandex_metrics_reports.module \yandex_metrics_reports_help()

Implements hook_help().

File

yandex_metrics_reports/yandex_metrics_reports.module, line 524

The main code of Yandex.Metrics Reports module.

Code

function yandex_metrics_reports_help($path, $arg) {
  $output = '';
  switch ($path) {
    case 'admin/help#yandex_metrics_reports':
      $output = '';
      $output .= '<h3>' . t('About the module') . '</h3>';
      $output .= '<p>' . t('The <a href="@yandex_metrika" target="_blank">Yandex.Metrica</a> service is European alternative of Google Analytics. This is a free tool that helps you to increase the conversion rate of your site.', array(
        '@yandex_metrika' => 'http://metrika.yandex.ru/',
      )) . '</p>';
      $output .= '<p>' . t('The Yandex.Metrics Reports module allows to view basic reports by key effectiveness indicators.') . '</p>';
      $output .= '<h3>' . t('Usage') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Authorizing site') . '</dt>';
      $output .= '<dd>' . t('Register Yandex application and authorize your site following <a href="!yandex_services_oauth">the documentation of Yandex Services Authorization API module</a>.', array(
        '!yandex_services_oauth' => url('admin/help/yandex_services_auth'),
      )) . '</dd>';
      $output .= '<dt>' . t('Configuring reports') . '</dt>';
      $output .= '<dd>' . t('You can choose necessary reports <a href="@report-setting-page">here</a> to display on <a href="@summary-report-page">Yandex.Metrics Summary Report</a> page.', array(
        '@summary-report-page' => url('admin/reports/yandex_metrics_summary'),
        '@report-setting-page' => url('admin/config/system/yandex_metrics/reports'),
      )) . '</dd>';
      $output .= '<dt>' . t('Reports API') . '</dt>';
      $output .= '<dd>' . t('The module has API for developers which allows you to implement new reports in own modules. Please read module README.txt file for more information.') . '</dd>';
      $output .= '</dl>';
      break;
    case 'admin/config/system/yandex_metrics/reports':
      $output = '<p>' . t('You can choose necessary reports to display on <a href="@summary-report-page">Yandex.Metrics Summary Report</a> page.', array(
        '@summary-report-page' => url('admin/reports/yandex_metrics_summary'),
      )) . '</p>';
      break;
  }
  return $output;
}