[project @ 2005-06-29 17:35:54 by unknown_lamer]

Minor documentation edits

diff --git a/ChangeLog b/ChangeLog
index 0715d83..6793d6c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
+2005-06-29  Clinton Ebadi  <clinton@unknownlamer.org>
+
+       * bobot++.texinfo (Configuration): Swapped order of config file
+       placement and config files
+
 2005-06-28  Clinton Ebadi  <clinton@unknownlamer.org>
 
+       * bobot++.texinfo: @vskip Opt... => @vskip 0pt...
+
        * source/Main.C (namespace): Added debug-scripts option
 
        * source/Parser.C (parseCTCP): Hook::ACTION is now passed

diff --git a/NEWS b/NEWS
index dd5257f..1f413ec 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -37,7 +37,8 @@ Version 2.1.8:
     * New command line option: --debug-scripts enabled the debugging
       evaluator while running everything else normally
     * Merged error handling patch from Dale Smith. This adds detailed
-      errors and backtraces when --debug is passed to Bobot++.
+      errors and backtraces when --debug/--debug-scripts is passed to
+      Bobot++.
 - Documentation
   + Merged documentation patch from Dale Smith (thanks)
 - Misc

diff --git a/bobot++.texinfo b/bobot++.texinfo
index 75a2611..3fd0aeb 100644 (file)
--- a/bobot++.texinfo
+++ b/bobot++.texinfo
@@ -24,7 +24,7 @@ Texts.
 @author Clinton Ebadi
 
 @page
-@vskip Opt plus 1filll
+@vskip 0pt plus 1filll
 Copyright @copyright{} 2002,2004,2005 Clinton Ebadi
 
 Permission is granted to copy, distribute and/or modify this document
@@ -68,8 +68,8 @@ Texts.
 
 Configuration
 
-* Configuration Files::         
 * Configuration File Placement::  
+* Configuration Files::         
 
 Configuration Files
 
@@ -123,11 +123,20 @@ Bobot++ is easy to configure. See the @file{examples} directory for an
 example configuration.
 
 @menu
-* Configuration Files::         
 * Configuration File Placement::  
+* Configuration Files::         
 @end menu
 
-@node Configuration Files, Configuration File Placement, Configuration, Configuration
+@node Configuration File Placement, Configuration Files, Configuration, Configuration
+@section Configuration File Placement
+
+Bobot++ will look in @file{/etc/bobotpp/default/} for its default
+config if none is specified on the command line. Put the configuration
+files you want to be loaded by default in this directory. If you are
+not root or you want to have your own personal configuration, put it
+in @file{~/.bobotpp/config/default/}.
+
+@node Configuration Files,  , Configuration File Placement, Configuration
 @section Configuration Files
 
 @menu
@@ -248,21 +257,6 @@ given operator priviliges on channel entry (@ref{Automatic Op}).
 
 @end itemize
 
-@node Configuration File Placement,  , Configuration Files, Configuration
-@section Configuration File Placement
-
-@quotation
-[ I kinda think this should go before the detailed description of the
-config file.  I was didn't see it at first and was very frustrated
-trying to find out @emph{where} to edit all this wonderful stuff. ]
-@end quotation
-
-Bobot++ will look in @file{/etc/bobotpp/default/} for its default
-config if none is specified on the command line. Put the configuration
-files you want to be loaded by default in this directory. If you are
-not root or you want to have your own personal configuration, put it
-in @file{~/.bobotpp/config/default/}.
-
 @node Using the Bot, Scripting, Configuration, Top
 @chapter Using Bobot++
 
@@ -646,21 +640,11 @@ regexps for the log function all be @code{".*"} and set their names to
 @subsection Hook Types
 
 Here is a list of the various hooks funtions and notes on each
-one. The general format of each hook description is as if it was was
+one. The general format of each hook description is as if it were a
 function to be defined, but these describe the function to be passwd
 to @code{bot:add-hook}.  Do @emph{not} name your functions these
 names.
 
-@quotation
-[ Boy, that's clumsy.  I want to say that the hook/xx functions that
-are documented below are not funtions that you call.  They are the
-functions that needs to be passed to bot:addhook for that kind of
-hook.
-
-Still clumsy.  Oh well. ]
-@end quotation
-
-
 That said, here is the list of available hooks functions.
 FIXME: write docs