From a8b218827a400cf5ced7db133be0a0f9e2180875 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Tue, 1 Nov 2005 10:17:34 +0000
Subject: - Patch #26139 by webchick / Kieran / documentation team: improved
 admin help of core modules! /

---
 modules/watchdog.module | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

(limited to 'modules/watchdog.module')

diff --git a/modules/watchdog.module b/modules/watchdog.module
index 7531f6c13..b22839ba8 100644
--- a/modules/watchdog.module
+++ b/modules/watchdog.module
@@ -15,12 +15,23 @@
 /**
  * Implementation of hook_help().
  */
-function watchdog_help($section = 'admin/help#watchdog') {
+function watchdog_help($section) {
   switch ($section) {
-    case 'admin/logs':
-      return t('<p>The watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information.  It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.</p>');
+    case 'admin/help#watchdog':
+      $output = '<p>'. t('The watchdog module monitors your system, capturing system events in a log to be reviewed by an authorized individual at a later time.  This is useful for site administrators who want a quick overview of activities on their site. The logs also record the sequence of events, so it can be useful for debugging site errors.') .'</p>';
+      $output .= '<p>'. t('The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. Administrators should check the watchdog report on a regular basis to ensure their site is working properly.') .'</p>';
+      $output .= t('<p>You can</p>
+<ul>
+<li>view watchdog logs at <a href="%admin-watchdog">administer &gt;&gt; watchdog</a>.</li>
+<li>view watchdog event logs at <a href="%admin-watchdog-events">administer &gt;&gt; watchdog &gt;&gt; events</a>.</li>
+</ul>
+', array('%admin-watchdog' => url('admin/watchdog'), '%admin-watchdog-events' => url('admin/watchdog/events')));
+      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%watchdog">Watchdog page</a>.', array('%watchdog' => 'http://www.drupal.org/handbook/modules/watchdog/')) .'</p>';
+      return $output;
     case 'admin/modules#description':
       return t('Logs and records system events.');
+    case 'admin/logs':
+      return t('<p>The watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information.  It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.</p>');
   }
 }
 
-- 
cgit v1.2.3