From 8d2b1238b4d8ebd57848fde665b7f93c3a03cd90 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Thu, 29 May 2003 09:15:00 +0000
Subject: - Michael Frankowski's excellent help text improvements!

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

(limited to 'modules/watchdog.module')

diff --git a/modules/watchdog.module b/modules/watchdog.module
index 9337d4bbf..601363e0e 100644
--- a/modules/watchdog.module
+++ b/modules/watchdog.module
@@ -2,14 +2,15 @@
 // $Id$
 
 function watchdog_help() {
- ?>
-  <p>The watchdog module monitors your website, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains 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>
-  <p>To ease administration, the watchdog will automatically discard old log entries.</p>
- <?php
+
+  $output .= "<p>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 ". l("check the Watchdog report", "admin/watchdog") ." on a regular basis as it is often the only way to tell what is going on.</p>";
+  $output .= "<p>To ease administration, the watchdog will automatically discard old log entries, ". l("as configured", "admin/system/modules/watchdog") .". Needs \"cron.php\" to discard the entries.</p>";
+  return t($output);
 }
 
 function watchdog_system($field){
   $system["description"] = t("Logs and records system events.");
+  $system["admin_help"] = t("Watchdog logs your system events. Too see these logs go to <a href=\"%watchdog\">Site monitoring</a>. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log.<br />Note:<ul><li>To discard entries as set below you must run \"cron.php\" regularly.</li></ul>", array("%watchdog" => url("admin/watchdog")));
   return $system[$field];
 }
 
@@ -19,16 +20,22 @@ function watchdog_perm() {
 
 function watchdog_link($type) {
   if ($type == "admin" && user_access("administer watchdog")) {
-    $help = "The watchdog module monitors your website, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains 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.";
-
-    menu("admin/watchdog", "site monitoring", "watchdog_admin", $help, 6);
-    menu("admin/watchdog/user", "user messages", "watchdog_admin", $help);
-    menu("admin/watchdog/regular", "regular messages", "watchdog_admin", $help);
-    menu("admin/watchdog/special", "special messages", "watchdog_admin", $help);
-    menu("admin/watchdog/warning", "warning messages", "watchdog_admin", $help);
-    menu("admin/watchdog/error", "error messages", "watchdog_admin", $help);
-    menu("admin/watchdog/httpd", "httpd messages", "watchdog_admin", $help);
-    menu("admin/watchdog/view", "view details", "watchdog_admin", $help, 0, 1); // hidden menu
+-    $help["general"] = t("The watchdog module monitors your web site, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains 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.");
+-    $help["user"] = t("Watchdog events that have to do with users. Most of these come from the user.module.");
+-    $help["regular"] = t("Watchdog events that are \"normal\" and have no other classification.");
+-    $help["httpd"] = t("Watchdog events that are from the web server.<br />Note: At this time this logging level is <b>not</b> used.");
+-    $help["special"] = t("Watchdog events about adding, changing, and moderating nodes and comments.");
+-    $help["error"] = t("Watchdog general error events, such as invalid login, permission denied, and database errors.");
+-    $help["warning"] = t("Watchdog warning events. These events don't stop Drupal from running, but are things you should no to correct.");
+
+    menu("admin/watchdog", "site monitoring", "watchdog_admin", $help["general"], 6);
+    menu("admin/watchdog/user", "user messages", "watchdog_admin", $help["user"]);
+    menu("admin/watchdog/regular", "regular messages", "watchdog_admin", $help["regular"]);
+    menu("admin/watchdog/special", "special messages", "watchdog_admin", $help["special"]);
+    menu("admin/watchdog/warning", "warning messages", "watchdog_admin", $help["warning"]);
+    menu("admin/watchdog/error", "error messages", "watchdog_admin", $help["error"]);
+    menu("admin/watchdog/httpd", "httpd messages", "watchdog_admin", $help["http"]);
+    menu("admin/watchdog/view", "view details", "watchdog_admin", $help["general"], 0, 1); // hidden menu
   }
 }
 
-- 
cgit v1.2.3