Explorar o código

Update docs a little

Fred Gilham hai 8 meses
pai
achega
5556abd5f4
Modificáronse 3 ficheiros con 61 adicións e 18 borrados
  1. 26 13
      README.md
  2. 14 1
      README.org
  3. 21 4
      bible-mode.el

+ 26 - 13
README.md

@@ -1,30 +1,43 @@
 
 # Table of Contents
 
-1.  [Description](#org4d2cba9)
-2.  [Dependencies](#org77bc155)
-3.  [Usage](#org026821a)
-    1.  [Keybindings](#org9988a00)
-4.  [Features](#org546c1aa)
-5.  [Example](#org6434223)
+1.  [Description](#org3fd18a4)
+2.  [Dependencies](#orgbde065f)
+3.  [Usage](#org8bb4448)
+    1.  [Keybindings](#org067a501)
+4.  [Features](#orgb536b6b)
+5.  [Example](#org76c8290)
 
 
 
-<a id="org4d2cba9"></a>
+<a id="org3fd18a4"></a>
 
 # Description
 
 An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command line program.
 
 
-<a id="org77bc155"></a>
+<a id="orgbde065f"></a>
 
 # Dependencies
 
-`diatheke` and a Biblical Text module (uses KJV by default)
+`diatheke` and a Biblical Text module (uses KJV by default). Also,
+Strong's lexicons and morphological databases should be installed:
 
+-   StrongsRealGreek
+-   StrongsRealHebrew
+-   Robinson
+-   Packard
+-   OSHM
 
-<a id="org026821a"></a>
+The utility \`installmgr' can be used to install text modules and
+lexical and morphological databases.
+
+The program \`mkfastmod' should be used to generate indexes so the
+lexical search method will work.
+
+
+<a id="org8bb4448"></a>
 
 # Usage
 
@@ -33,7 +46,7 @@ An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command
     -   emacs -g =150x25 -fn \\"Ezra SIL-14\\" -f bible-open
 
 
-<a id="org9988a00"></a>
+<a id="org067a501"></a>
 
 ## Keybindings
 
@@ -49,7 +62,7 @@ An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command
 -   x - Split display
 
 
-<a id="org546c1aa"></a>
+<a id="orgb536b6b"></a>
 
 # Features
 
@@ -65,7 +78,7 @@ An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command
 -   Searching
 
 
-<a id="org6434223"></a>
+<a id="org76c8290"></a>
 
 # Example
 

+ 14 - 1
README.org

@@ -3,7 +3,20 @@
 * Description
 An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command line program.
 * Dependencies
-~diatheke~ and a Biblical Text module (uses KJV by default)
+~diatheke~ and a Biblical Text module (uses KJV by default). Also,
+Strong's lexicons and morphological databases should be installed:
+- StrongsRealGreek
+- StrongsRealHebrew
+- Robinson
+- Packard
+- OSHM
+
+The utility `installmgr' can be used to install text modules and
+lexical and morphological databases.
+
+The program `mkfastmod' should be used to generate indexes so the
+lexical search method will work.
+  
 * Usage
 - M-x ~bible-open~
 - Invoke from command line as follows (requires installing Ezra SIL font):

+ 21 - 4
bible-mode.el

@@ -1,11 +1,22 @@
 ;;;; -*- mode: EMACS-LISP; lexical-binding: t -*-
-;;
+
+;; Copyright (C) 2024  Zacalot
+;; Modifications Copyright (C) Fred Gilham
+
+;; Time-stamp: <2024-05-15 08:37:24 fred>
+
+;; This 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.
+
+;; See LICENSE file for copying conditions.
+
 ;; bible-mode.el --- A browsing interface for the SWORD Project's Diatheke CLI
-;; Time-stamp: <2024-05-14 11:32:24 fred>
 
 ;; Author: Zacalot
 ;; Fixes and modifications by Fred Gilham
-;; Url: https://github.com/fmgilham/bible-mode
+;; Url: http://gitbot.homedns.org/fred/bible-mode
 ;; Forked from
 ;; Url: https://github.com/Zacalot/bible-mode
 ;; Version: 1.0.0
@@ -21,7 +32,7 @@
 ;;; Usage:
 
 ;; First install `diatheke'.  On Debian/Ubuntu it's in the `diatheke'
-;; package. In other distributions it might be in the sword package.
+;; package. In other distributions it might be in a `sword' package.
 
 ;; For Windows I found that you can simply install the Xiphos package.
 ;; It includes the Sword library and its utilities including diatheke,
@@ -56,6 +67,12 @@
 ;; with lexical information will display that informatio in a "term"
 ;; buffer.
 
+;; If lexical and morphological tags are available, the mode line will
+;; indicate which are present. In this version no visible tags are
+;; used so that the display is not cluttered by irrelevant details.
+
+;; If word study is enabled and lemmas are present, these will be
+;; displayed.
 
 ;;;
 ;;; bm- is used as shorthand (see Local Variables) for bible-mode-