Difference between revisions of "Frontends:Diatheke"

Revision as of 16:58, 3 March 2017

What is diatheke?

Diatheke is a very simple command line interface (CLI) front-end to the SWORD Project's Bible software library. Essentially, "diatheke" is the stuff contained within the file "corediatheke.cpp" in the apps/console/diatheke directory of the SWORD source tree. Corediatheke.cpp contains only one function that is intended to be called from any program using diatheke, and that function performs exactly one lookup in the SWORD library per call. Examples of calls would be a query for a verse (or verse list/range), a search, a request for a list of modules, etc.

Where's the name 'diatheke' come from?

Diatheke means 'testament' or 'commandment'. And diatheke (the program) was originally a command line application. commandment... command line app... It's a pun.

How is diatheke useful to me?

Probably it isn't, but there are a number of front-ends to diatheke (yes, front-ends to a front-end) that are of use. These include:

• diatheke/TCL: a BibleBot for eggdrop that interfaces with diatheke/CLI
• diatheke/CGI: a Perl/CGI interface to diatheke/CLI
• HANDiatheke: a Palm PQA interface to diatheke/CGI
• ActiveDiatheke: an ActiveX control (.OCX) interface to SWORD

The above four are no longer under active development and may even be no longer available.

Release history

This section needs expanding.

• Version 4.6 was released during 2013.
• Version 4.7 was released on Aug 30 2015.

How do I get diatheke?

This section needs updating.

To get the very latest version, grab the SWORD source tree from our SVN repository using the URL: https://crosswire.org/svn/sword/trunk

e.g.

   $ svn checkout https://crosswire.org/svn/sword/trunk sword

If you don't want to use SVN, you can try grabbing a recent release from ftp://ftp.crosswire.org/pub/sword/source/

The Sword utilities for Windows are also installed when Xiphos is installed. These include a copy of diatheke.exe

For diatheke/CLI and diatheke/CGI you can download version 4.0 from:

• ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-win32.zip (Windows binary)
• ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-src.zip (source)

For diatheke/TCL and HANDiatheke you can download version 2.0 from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-2.0.tar.gz.

For ActiveDiatheke you can download a preliminary version from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/ActiveDiatheke.zip.

Diatheke option filters

Valid (output) option_filters values are:

a (Greek Accents),
b (Bi-Directional Reordering),
c (Hebrew Cantillation),
e (Word Enumerations),
f (Footnotes),
g (Glosses/Ruby),
h (Section Headings),
l (Lemmas),
m (Morphology),
n (Strong's numbers),
p (Arabic Vowels),
r (Arabic Shaping),
s (Scripture Crossrefs),
t (Algorithmic Transliterations via ICU),
v (Hebrew Vowels),
w (Red Words of Christ),
x (Encoded Transliterations)

How do I use diatheke/CLI?

Calling diatheke without any parameters will result in the command line syntax help being output to stderr.

The query_key (-k) must be the last argument because all further arguments are added to the key.

Examples

The following are a few examples of calling diatheke from the command line: (booknames can be abbreviated, providing this avoids ambiguity)

Diatheke output

The plain text output of diatheke marks any OSIS highlight elements (e.g. <hi type="italic">n</hi>) by wrapping the highlighted text between asterisks (e.g. *n*). It does this whatever the value of the type attribute.

Output formats

Valid output_format values are: CGI, GBF, HTML, HTMLHREF, LaTeX^[1], OSIS, RTF, ThML, XHTML, and plain^[2] text (default).

Output encodings

Valid output_encoding values are: Latin1, UTF8 (default), UTF16, HTML, and RTF.

Notes:

1. ↑ Only after diatheke version 4.7
2. ↑ The word plain here is merely a handle to distinguish the default from the other output formats.
   It does not imply that the output encoding is restricted in any way.

Known weaknesses

Both editions (Linux & Windows)

Currently, diatheke does not output:

• Any canonical Psalm titles even with the option filter -o h for section headings.
• Any pilcrow symbols in the KJV Bible or similar modules where these are encoded as a marker attribute in the OSIS milestone element.
• Any quotation marks in modules where these are encoded as a marker attribute in the OSIS q element.
• Any footnote text with the option filter -o f for footnotes; only a pair of brackets [] is output at the location of each note tag.

Currently, diatheke does not distinguish different highlight types in the OSIS hi element. It treats all such styles as if they were bold by wrapping the text between two asterisks.

Windows edition

The utility diatheke.exe is among the Sword utilities compiled for Win32.

Under the Windows command shell (cmd.exe), diatheke does not correctly handle non-ASCII characters in the query key. Thus, for example, the following command that works OK in Linux will fail in Windows:

diatheke -b KJV -s phrase -k Æneas

In Windows, the non-ASCII character "Æ" gets changed to U+00E3 LATIN SMALL LETTER A WITH TILDE.

The response in Windows is then:

Verses containing "ãneas"-- none (KJV)

The root cause is that Windows shell assumes text is encoded as UTF-16 LE whereas SWORD requires all text to be encoded as UTF-8. This problem mainly affects using the search options in diatheke, where a query key is more likely to contain non-ANSI characters. Even so, for any locale in which some Bible book names contain non-ANSI characters, the problem would also affect diatheke when the query key is a reference that contains such a character.

Tools that use Diatheke

AutoKey script for The SWORD Project

Ryan (Adyeth) has developed a script for the AutoKey 0.6x utility to do paste Bible text given a reference. It works with OpenOffice, plain text editors, or any other Linux program where you might need to paste scripture passages. It requires Diatheke in order to function. You can download it from his website.

• AutoKey script for The SWORD Project