Alternate Versification

From CrossWire Bible Society
Revision as of 01:59, 9 September 2009 by Osk (Talk | contribs)

Jump to: navigation, search

Disclaimer: Alternate versification support, though preliminarily implemented, is not yet complete in Sword. The contents of this page will in some cases be incomplete or speculative. This page is under ongoing improvement while alternate versification support is improved in Sword itself.

Introduction

Alternate versification is also known as dynamic versification and has been abbreviated as v11n, av11n and dv11n.

In these three numeronyms, there are 11 letters between v and n in the word "versification".

  • Canon pertains to what is included in a version of the Bible.
  • Versification deals with the naming and order of books, and the numbering of chapters and verses in a canon.

As of SWORD 1.5.11, there was only one supported canon and versification: The KJV Old and New Testaments. This is represented in canon.h as a fixed, hard-coded system.

Alternate versifications mean ultimately to allow Bible texts with arbitrary canon or versification schemes to coexist peacefully on the same SWORD installation and (ultimately) to map cleanly between each other via cross references or parallel display.

There are technically 2 routes to support this under development:

  1. ripping out the hardcoded KJV canon.h offsets and replacing them with VerseMgr, which allows registration of canon.h-like v11n systems.
  2. genbook Bibles

Both these routes have been under development and 2 requires 1.

  1. is nearly completed and included in Sword 1.6.0.
  2. is not supported by Sword 1.6.0.

Overview

Up until 1.5.11, the canon and the versification were hard coded into the engine in the form of the file canon.h, which offered book names and chapter + verse offsets to the engine. The new approach is that:

  1. Each Bible module will carry a .conf entry identifying its versification from an supported list of versification systems. Without this identification, the versification system will default to "KJV" for backward compatibility.
  2. The engine will have, for each major canon and versification variety, a new header file similar to the previous canon.h.
  3. On system start, the engine will load, for each open KJV-divergent module, the relevant data presented in the relevant canon_{Versification].h into a table held in memory.
  4. Subsequently, the relevant module will be accessible via the usual methods - which have not changed from 1.5.11.
  5. What does not work anymore is to assume that a book or chapter has a set (fixed) number of verses. Instead, 1.6.0 introduces new methods VerseKey::getChapterMax() and VerseKey::getVerseMax() to provide the relevant information for a given module--replacing VerseKey::books[testament][book].chapmax and .versemax members.
  6. Similarly VerseKey::getBookName() and VerseKey::getBookAbbrev() replace the previous const char *name and const char *prefAbbrev respectively.
  7. At a later stage (>1.6.0) the engine will allow for GenBook Bibles to automatically create arbitrary versification tables on the fly.
  8. The final step (in >1.6.0) will be to allow mappings between versification schemes to allow cross-referencing and parallel display of corresponding passages.

Canon Header Files

GenBook Bibles

GenBook Bibles are Bibles stored in GenBook format. They are accessed via VerseKey, which in turn calls TreeKey.

The role of GenBook Bibles will mainly be to allow alternative versifications and canons over and above those provided by alternative canon header files.

SWORD Versification Tools

The primary versification tools are:

  • v11nsys.pl – Converts a v11n spec into a SWORD canon header file.
  • osis2mod – The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.
  • imp2vs – The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.

Note: These are under development and may not work as expected until v11n is fully implemented.

API Changes

Frontend Problems

How to Create Modules with Alternative Versifications

  1. Set the relevant entries in the configuration file Configuration file
  2. If your module uses a versification or canon not yet present in SWORD you might have to create a canon header file. Sword tools contains relevant scripts. Please be aware that we will not hard code every versification under the sun but only select and important ones. If your scheme is not one of those you will need to go down the route of a GenBook Bible. Discuss on sword-devel what you are planning to do and you will get appropriate advice.
  3. The importers will work as usual. You'll specify a versification for the text to the import utility (imp2vs or osis2mod). It will pass the v11n value to the SWText constructor, which will instruct it to use the specified v11n.
  4. Append will also work as usual. Append pertains to whether a text is overwritten or appended to, so its use can affect the stored order of verses, but won't affect where the engine thinks they belong for access/display purposes.
  5. Each v11n will specify a book order, so different traditions that vary with respect to book order would have to be represented by different v11n definitions.

Resources

  • Books of the Bible – a side-by-side comparison of Jewish, Catholic, Orthodox and Protestant canons. The scope of this article is the book order - it does not dive down to chapter and verse level.
  • Psalms – this article includes a handy table showing how the organization and numbering of the Psalms differs slightly between the (Masoretic) Hebrew and the (Septuagint) Greek manuscripts.