[sword-svn] r2423 - trunk/utilities/diatheke/tcl

[chrislit at crosswire.org]

Author: chrislit
Date: 2009-06-03 21:57:53 -0700 (Wed, 03 Jun 2009)
New Revision: 2423

Added:
   trunk/utilities/diatheke/tcl/README
   trunk/utilities/diatheke/tcl/biblebot-diatheke-books.tcl
   trunk/utilities/diatheke/tcl/makebooklist.pl
Modified:
   trunk/utilities/diatheke/tcl/biblebot-diatheke.tcl
Log:
bumped version number
extracted installation instructions to README
added placeholder biblebot-diatheke-books.tcl and makebooklist.pl


Added: trunk/utilities/diatheke/tcl/README
===================================================================
--- trunk/utilities/diatheke/tcl/README	                        (rev 0)
+++ trunk/utilities/diatheke/tcl/README	2009-06-04 04:57:53 UTC (rev 2423)
@@ -0,0 +1,45 @@
+Diatheke/Tcl by Chris Little <chrislit at crosswire.org>
+Based on code schema of <cking at acy.digex.net>
+
+#######################################################################
+Copyright 1999-2009 CrossWire Bible Society (http://www.crosswire.org)
+	CrossWire Bible Society
+	P. O. Box 2528
+	Tempe, AZ  85280-2528
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation version 2.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+#######################################################################
+
+This script is intended for use with libraries and modules from
+The SWORD Project, available at http://www.crosswire.org/
+
+This script requires the Diatheke command line front end to The SWORD
+Project. You should really install this first, including all optional
+components: zlib, CLucene, ICU (preferrably icu-sword), and cURL. Then
+install any modules you want to make available to users. Finally, run
+the Perl script makebooklist.pl, which will create/overwrite the file
+biblebot-diatheke-books.tcl. This includes all books installed on
+the system, so remove any entries you want to hide from users, as
+necessary.
+
+To install Diatheke/Tcl, install an eggdrop IRC bot, copy the
+Diatheke/Tcl .tcl files (biblebot-diatheke.tcl and 
+biblebot-diatheke-books.tcl) to your eggdrop scripts directory, and
+add a line to the end of your bot startup script to load the
+Diatheke/Tcl script (e.g. 
+"source /usr/share/eggdrop/scripts/biblebot-diatheke.tcl").  This
+script has been tested with eggdrop 1.3.23 & 1.6.19, but should
+function fine in later versions.
+
+When you get the script loaded, type !biblehelp in a channel where
+the bot is present and it will give you a full list of commands.
+More commands will appear to you depending upon which mode the bot is
+in and whether you are an op on the bot or voiced in the channel.

Modified: trunk/utilities/diatheke/tcl/biblebot-diatheke.tcl
===================================================================
--- trunk/utilities/diatheke/tcl/biblebot-diatheke.tcl	2009-06-04 04:24:22 UTC (rev 2422)
+++ trunk/utilities/diatheke/tcl/biblebot-diatheke.tcl	2009-06-04 04:57:53 UTC (rev 2423)
@@ -1,4 +1,4 @@
-# Diatheke/Tcl 3.0 by Chris Little <chrislit at gotjesus.org>
+# Diatheke/Tcl 5.0 by Chris Little <chrislit at crosswire.org>
 # Based on code schema of <cking at acy.digex.net>
 
 # *
@@ -17,33 +17,8 @@
 # * General Public License for more details.
 # *
 
+set diaver 5.0
 
-# This script is intended for use with libraries and modules from
-# the SWORD Project, available at http://www.crosswire.org/
-#
-# To install Diatheke/Tcl, install an eggdrop IRC bot, copy the
-# Diatheke/Tcl .tcl file to your eggdrop scripts directory, and
-# add a line to the end of your bot startup script to load the
-# Diatheke/Tcl script.  This script has been tested with eggdrop 1.3.23
-# but should function fine in later versions.
-#
-# This is script assumes you have every single SWORD module installed
-# that was available at the time of release.  Since you probably do not,
-# remove all modules listed in the pub_books function that you do not
-# have installed to hide them from end-users.
-#
-# The !history command only works if you have LOGGING turned on in
-# diatheke (the command line C program).  This command is commented out
-# of the help function and must be uncommented to make it show up for
-# end-users.
-#
-# When you get the script loaded, type !biblehelp in a channel where
-# the bot is present and it will give you a full list of commands.
-# More commands will appear to you depending upon which mode the bot is
-# in and whether you are an op on the bot or voiced in the channel.
-
-set diaver 4.0
-
 #modify this to reflect actual location of diatheke and dict binaries
 set diatheke "/usr/bin/diatheke"
 set dict "/usr/bin/dict"