From ca8b82b4cacabf09f06d7f1c18dc6e7412c128e9 Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Mon, 23 Nov 2009 01:33:45 +0000 Subject: #633812 by batigolix, arianek, and jhodgdon: Update Statistics module to new help documentation standard. --- modules/statistics/statistics.module | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) (limited to 'modules') diff --git a/modules/statistics/statistics.module b/modules/statistics/statistics.module index 611c650b7..050456cd8 100644 --- a/modules/statistics/statistics.module +++ b/modules/statistics/statistics.module @@ -12,19 +12,24 @@ function statistics_help($path, $arg) { switch ($path) { case 'admin/help#statistics': - $output = '

' . t('The statistics module keeps track of numerous site usage statistics, including the number of times, and from where, each of your posts is viewed. These statistics are useful in determining how users are interacting with each other and with your site, and are required for the display of some Drupal blocks.') . '

'; - $output .= '

' . t('The statistics module provides:') . '

'; - $output .= ''; - $output .= '

' . t('Configuring the statistics module') . '

'; - $output .= ''; - $output .= '

' . t('For more information, see the online handbook entry for Statistics module.', array('@statistics' => 'http://drupal.org/handbook/modules/statistics/')) . '

'; + $output = ''; + $output .= '

' . t('About') . '

'; + $output .= '

' . t('The Statistics module shows you how often a given page is viewed, who viewed it, the previous page the user visited (referrer URL), and when it was viewed. These statistics are useful in determining how users are visiting and navigating your site. For more information, see the online handbook entry for the Statistics module.', array('@statistics' => url('http://drupal.org/handbook/modules/statistics/'))) . '

'; + $output .= '

' . t('Uses') . '

'; + $output .= '
'; + $output .= '
' . t('Managing logs') . '
'; + $output .= '
' . t('To enable collection of statistics, the Enable access log checkbox on the Statistics settings page must be checked. The Discard access logs older than setting on the settings page specifies the length of time entries are kept in the log before they are deleted. This setting requires a correctly configured cron maintenance task to run.', array('@statistics-settings' => url('admin/config/system/statistics'), '@cron' => url('admin/reports/status'))) . '
'; + $output .= '
' . t('Viewing site usage') . '
'; + $output .= '
' . t('The Statistics module can help you break down details about your users and how they are using the site. The module offers four reports:'); + $output .= '
  • ' . t('Recent hits displays information about the latest activity on your site, including the URL and title of the page that was accessed, the user name (if available) and the IP address of the viewer.', array('@recent-hits' => url('admin/reports/hits'))) . '
    • '; + $output .= '
  • ' . t('Top referrers displays where visitors came from (referrer URL).', array('@top-referrers' => url('admin/reports/referrers'))) . '
    • '; + $output .= '
  • ' . t('Top pages displays a list of pages ordered by how often they were viewed.', array('@top-pages' => url('admin/reports/pages'))) . '
    • '; + $output .= '
  • ' . t('Top visitors shows you the most active visitors for your site and allows you to ban abusive visitors.', array('@top-visitors' => url('admin/reports/visitors'))) . '
'; + $output .= '
' . t('Displaying popular content') . '
'; + $output .= '
' . t('The module includes a popular content block that displays the most viewed pages today and for all time, and the last content viewed. You can enable and configure the block on the blocks administration page.', array('@blocks' => url('admin/structure/block'))) . '
'; + $output .= '
' . t('Page view counter') . '
'; + $output .= '
' . t('The Statistics module includes a counter for each page that increases whenever the page is viewed. To use the counter, enable Count content views on the statistics settings page, and set the necessary permissions so that the counter is visible to the users.', array('@statistics-settings' => url('admin/config/system/statistics'), '@permissions' => url('admin/config/people/permissions'))) . '
'; + $output .= '
'; return $output; case 'admin/config/system/statistics': return '

' . t('Settings for the statistical information that Drupal will keep about the site. See site statistics for the actual information.', array('@statistics' => url('admin/reports/hits'))) . '

'; @@ -37,6 +42,7 @@ function statistics_help($path, $arg) { } } + /** * Implement hook_exit(). * -- cgit v1.2.3