summaryrefslogtreecommitdiff
path: root/utilities/diatheke/README
blob: df39d8624de66fdb2b818d45e2a961f14db04e7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
Diatheke Suite
by Chris Little <chrislit@crosswire.org>

This suite is intended for use with libraries and modules from
the SWORD Project, available at http://www.crosswire.org/

The latest versions of this suite and its components are available
at http://www.crosswire.org/sword/diatheke

This suite consists of the following components:

Diatheke - a command line utility, good for lots of stuff
Diatheke/CGI - a PERL CGI module interface to Diatheke 4.0

--------------------------------------------------------------------
INSTALLING Diatheke/CGI

To install Diatheke/CGI, first install PERL and a webserver such as
Apache that is capable of running PERL CGIs.  Installing mod_perl is
recommended for a speed improvement, but is by no means necessary.

Then copy the two .pl files from the ./cgi directory of this
distribution into your cgi-bin directory.  Modify the top of
diatheke.pl to reflect the correct location of your your diatheke
command line utility binary and the default font if necessary. The
CGI is now installed and ready for access.

diatheke.pl is the main lookup script.  dia-def.pl is a supplemental
script used to set a default Bible translation (saved on the 
user's computer as a cookie).

Two sample HTML files are included as sample interfaces for an
general Web-Bible gateway.  index-public.html includes all currently
available free texts while index-private.html includes all currently
available texts, including those which are encrypted because
of copyright and distribution restrictions.  In any case, you should
only use these as a guide, adding and subtracting modules depending
on which modules you have installed and have permission to publish
on the internet or your intranet.  The bottom section of each file
includes an example call to the dia-def.pl script to set a default
Bible version.

You may also direct users directly to your perl script since it will
present a page with all of your modules.  Or you may wish to use this
default page to create a custom index.html for your users.

----------------------------------------------------------------------
VERSION HISTORY

4.7	

4.6     July 16, 2013
	Updated for Sword 1.7.0.

4.5

4.0	July 8, 2001
	Updated to Sword 1.5.2 with innumerable bug fixes.
	Now builds properly for Win32 using VC++.
	Diatheke/Tcl and HANDiatheke were omitted, for the moment
	from this release, but are still available in the CVS.

3.0	March 31, 2001
	Self-generating HTML page for the lazy (Diatheke/CGI).
	Localization support. (Diatheke and Diatheke/CGI).

2.5	December 10, 2000
	Now supports ThML.  Numerous bugfixes.
	Includes Diatheke 3.0, Diatheke/CGI 3.0, Diatheke/Tcl 3.0,
	and HANDiatheke 3.0 (initial version, but version-synced)

2.0	October 23, 1999.
	First public release, including Diatheke 2.0, Diatheke/CGI
	2.0, and Diatheke/Tcl 2.5.

-----------------------------------------------------------------------
COPYRIGHT

The Diatheke Suite and its components, Diatheke, Diatheke/CGI, and
Diatheke/Tcl are Copyright 1999-2014 by CrossWire Bible Society.
HANDiatheke is Copyright 2000-2001 by CrossWire Bible Society.
The Diatheke Suite and all of its components are licensed through
the GNU General Public License and are intended for free distribution.
See http://www.gnu.org/copyleft/gpl.html for details.