function statistics_help in Drupal 4

Same name and namespace in other branches

1. 8 core/modules/statistics/statistics.module \statistics_help()
2. 5 modules/statistics/statistics.module \statistics_help()
3. 6 modules/statistics/statistics.module \statistics_help()
4. 7 modules/statistics/statistics.module \statistics_help()
5. 9 core/modules/statistics/statistics.module \statistics_help()

Implementation of hook_help().

File

modules/statistics.module, line 11

Logs access statistics for your site.

Code

function statistics_help($section) {
  switch ($section) {
    case 'admin/help#statistics':
      $output = '<p>' . t('The statistics module keeps track of numerous statistics of site usage. It counts how many times, and from where each of your posts is viewed. The statistics module can be used to learn many useful things about how users are interacting with each other and with your site.') . '</p>';
      $output .= t('<p>Statistics module features</p>
<ul>
<li>Logs show statistics for how many times your site and specific content on your site has been accessed.</li>
<li>Referrers tells you from where visitors came from (referrer URL).</li>
<li>Top pages shows you what\'s hot, what is the most popular content on your site.</li>
<li>Top users shows you the most active users for your site.</li>
<li>Recent hits displays information about the latest activity on your site.</li>
<li>Node count displays the number of times a node has been accessed in the node\'s link section next to <em># comments</em>.</li>
<li>Popular content block creates a block that can display the day\'s top viewed content, the all time top viewed content, and the last content viewed.</li>
</ul>
');
      $output .= t('<p>Configuring the statistics module</p>
<ul>
<li>Enable access log allows you to turn the access log on and off. This log is used to store data about every page accessed, such as the remote host\'s IP address, where they came from (referrer), what node they\'ve viewed, and their user name. Enabling the log adds one database call per page displayed by Drupal.</li>
<li>Discard access logs older than allows you to configure how long an access log entry is saved, after which time it is deleted from the database table. To use this you need to run <em>cron.php</em></li>
<li>Enable node view counter allows you to turn on and off the node-counting functionality of this module. If it is turned on, an extra database query is added for each node displayed, which increments a counter.</li>
</ul>
');
      $output .= t('<p>You can</p>
<ul>
<li>administer statistics <a href="%admin-settings-statistics">administer &gt;&gt; settings &gt;&gt; statistics</a>.</li>
<li>access statistics logs <a href="%admin-logs">administer &gt;&gt; logs</a>.</li>
<li>view recent hits <a href="%admin-logs-hits">administer &gt;&gt; logs &gt;&gt; recent hits</a>.</li>
<li>enable \'popular content\' block in block administration <a href="%admin-block">administer &gt;&gt; blocks </a> but only after you have enabled \'Count content views\' in settings.</li>
</ul>
', array(
        '%admin-settings-statistics' => url('admin/settings/statistics'),
        '%admin-logs' => url('admin/logs'),
        '%admin-logs-hits' => url('admin/logs/hits'),
        '%admin-block' => url('admin/block'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%statistics">Statistics page</a>.', array(
        '%statistics' => 'http://drupal.org/handbook/modules/statistics/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Logs access statistics for your site.');
    case 'admin/settings/statistics':
      return t('<p>Settings for the statistical information that Drupal will keep about the site. See <a href="%statistics">site statistics</a> for the actual information.</p>', array(
        '%statistics' => url('admin/logs/hits'),
      ));
    case 'admin/logs/hits':
      return t('<p>This page shows you the most recent hits.</p>');
    case 'admin/logs/referrers':
      return t('<p>This page shows you all external referrers. These are links pointing to your web site from outside your web site.</p>');
    case 'admin/logs/visitors':
      return t('<p>When you ban a visitor, you prevent his IP address from accessing your site. Unlike blocking a user, banning a visitor works even for anonymous users. The most common use for this is to block bots/web crawlers that are consuming too many resources.</p>');
  }
}